WebSVN – HelenOS – Diff – /branches/network/uspace/srv/net/il/ip/ip.h


/*
 * Copyright (c) 2009 Lukas Mejdrech
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
/** @addtogroup ip
 *  @{
 */
 
/** @file
 *  IP module.
 */
 
#ifndef __NET_IP_H__
#define __NET_IP_H__
 
#include <fibril_sync.h>
 
#include <ipc/ipc.h>
#include <ipc/services.h>
 
#include "../../include/device.h"
#include "../../include/inet.h"
#include "../../include/ip_interface.h"
 
#include "../../structures/int_map.h"
#include "../../structures/generic_field.h"
#include "../../structures/module_map.h"
 
/** Type definition of the IP global data.
 *  @see ip_globals
 */
typedef struct ip_globals   ip_globals_t;
 
/** Type definition of the IP network interface specific data.
 *  @see ip_netif
 */
typedef struct ip_netif ip_netif_t;
 
/** Type definition of the IP network interface specific data pointer.
 *  @see ip_netif
 */
typedef ip_netif_t *    ip_netif_ref;
 
/** Type definition of the IP protocol specific data.
 *  @see ip_proto
 */
typedef struct ip_proto ip_proto_t;
 
/** Type definition of the IP protocol specific data pointer.
 *  @see ip_proto
 */
typedef ip_proto_t *    ip_proto_ref;
 
/** Type definition of the IP route specific data.
 *  @see ip_route
 */
typedef struct ip_route ip_route_t;
 
/** Type definition of the IP route specific data pointer.
 *  @see ip_route
 */
typedef ip_route_t *    ip_route_ref;
 
/** IP network interfaces.
 *  Maps devices to the IP network interface specific data.
 *  @see device.h
 */
DEVICE_MAP_DECLARE( ip_netifs, ip_netif_t )
 
/** IP registered protocols.
 *  Maps protocols to the IP protocol specific data.
 *  @see int_map.h
 */
INT_MAP_DECLARE( ip_protos, ip_proto_t )
 
/** IP routing table.
 *  @see generic_field.h
 */
GENERIC_FIELD_DECLARE( ip_routes, ip_route_t )
 
/** IP network interface specific data.
 */
struct  ip_netif{
    /** Device identifier.
     */
    device_id_t device_id;
    /** Netif module service.
     */
    services_t  service;
    /** Netif module phone.
     */
    int         phone;
    /** ARP module.
     *  Assigned if using ARP.
     */
    module_ref  arp;
    /** IP version.
     */
    int         ipv;
    /** Indicates whether using DHCP.
     */
    int         dhcp;
    /** Indicates whether IP routing is enabled.
     */
    int         routing;
    /** Device state.
     */
    device_state_t  state;
    /** Broadcast address.
     */
    in_addr_t   broadcast;
 
 
 
 
 
 
    /** Routing table.
     */
    ip_routes_t routes;
    /** Reserved packet prefix length.
     */
    size_t              prefix;
    /** Maximal packet content length.
     */
    size_t              content;
    /** Reserved packet suffix length.
     */
    size_t              suffix;
    /** Packet address length.
     *  The hardware address length is used.
     */
    size_t              addr_len;
};
 
/** IP protocol specific data.
 */
struct ip_proto{
    /** Protocol number.
     */
    int protocol;
    /** Protocol module service.
     */
    services_t service;
    /** Protocol module phone.
     */
    int phone;
    /** Protocol packet receiving function.
     */
    tl_received_msg_t received_msg;
};
 
/** IP route specific data.
 */
struct ip_route{
    /** Target address.
     */
    in_addr_t       address;
    /** Target network mask.
     */
    in_addr_t       netmask;
    /** Gateway.
     */
    in_addr_t       gateway;
    /** Parent netif.
     */
    ip_netif_ref    netif;
};
 
/** IP global data.
 */
struct  ip_globals{
    /** Networking module phone.
     */
    int         net_phone;
    /** Registered network interfaces.
     */
    ip_netifs_t netifs;
    /** Netifs safeyt lock.
     */
    fibril_rwlock_t netifs_lock;
    /** Registered protocols.
     */
    ip_protos_t protos;
    /** Protocols safety lock.
     */
    fibril_rwlock_t protos_lock;
    /** Default gateway.
     */
    ip_route_t  gateway;
    /** Known support modules.
     */
    modules_t   modules;
    /** Default client connection function for support modules.
     */
    async_client_conn_t client_connection;
    /** Packet counter.
     */
    uint16_t    packet_counter;
    /** Safety lock.
     */
    fibril_rwlock_t lock;
};
 
#endif
 
/** @}
 */
 

Rev 4704	Rev 4743
1	/*	1	/*
2	* Copyright (c) 2009 Lukas Mejdrech	2	* Copyright (c) 2009 Lukas Mejdrech
3	* All rights reserved.	3	* All rights reserved.
4	*	4	*
5	* Redistribution and use in source and binary forms, with or without	5	* Redistribution and use in source and binary forms, with or without
6	* modification, are permitted provided that the following conditions	6	* modification, are permitted provided that the following conditions
7	* are met:	7	* are met:
8	*	8	*
9	* - Redistributions of source code must retain the above copyright	9	* - Redistributions of source code must retain the above copyright
10	* notice, this list of conditions and the following disclaimer.	10	* notice, this list of conditions and the following disclaimer.
11	* - Redistributions in binary form must reproduce the above copyright	11	* - Redistributions in binary form must reproduce the above copyright
12	* notice, this list of conditions and the following disclaimer in the	12	* notice, this list of conditions and the following disclaimer in the
13	* documentation and/or other materials provided with the distribution.	13	* documentation and/or other materials provided with the distribution.
14	* - The name of the author may not be used to endorse or promote products	14	* - The name of the author may not be used to endorse or promote products
15	* derived from this software without specific prior written permission.	15	* derived from this software without specific prior written permission.
16	*	16	*
17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR	17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES	18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.	19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,	20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT	21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,	22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY	23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT	24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF	25	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.	26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27	*/	27	*/
28		28
29	/** @addtogroup ip	29	/** @addtogroup ip
30	* @{	30	* @{
31	*/	31	*/
32		32
33	/** @file	33	/** @file
34	* IP module.	34	* IP module.
35	*/	35	*/
36		36
37	#ifndef __NET_IP_H__	37	#ifndef __NET_IP_H__
38	#define __NET_IP_H__	38	#define __NET_IP_H__
39		39
40	#include <fibril_sync.h>	40	#include <fibril_sync.h>
41		41
42	#include <ipc/ipc.h>	42	#include <ipc/ipc.h>
43	#include <ipc/services.h>	43	#include <ipc/services.h>
44		44
45	#include "../../include/device.h"	45	#include "../../include/device.h"
46	#include "../../include/inet.h"	46	#include "../../include/inet.h"
47	#include "../../include/ip_interface.h"	47	#include "../../include/ip_interface.h"
48		48
49	#include "../../structures/int_map.h"	49	#include "../../structures/int_map.h"
50	#include "../../structures/generic_field.h"	50	#include "../../structures/generic_field.h"
51	#include "../../structures/module_map.h"	51	#include "../../structures/module_map.h"
52		52
53	/** Type definition of the IP global data.	53	/** Type definition of the IP global data.
54	* @see ip_globals	54	* @see ip_globals
55	*/	55	*/
56	typedef struct ip_globals ip_globals_t;	56	typedef struct ip_globals ip_globals_t;
57		57
58	/** Type definition of the IP network interface specific data.	58	/** Type definition of the IP network interface specific data.
59	* @see ip_netif	59	* @see ip_netif
60	*/	60	*/
61	typedef struct ip_netif ip_netif_t;	61	typedef struct ip_netif ip_netif_t;
62		62
63	/** Type definition of the IP network interface specific data pointer.	63	/** Type definition of the IP network interface specific data pointer.
64	* @see ip_netif	64	* @see ip_netif
65	*/	65	*/
66	typedef ip_netif_t * ip_netif_ref;	66	typedef ip_netif_t * ip_netif_ref;
67		67
68	/** Type definition of the IP protocol specific data.	68	/** Type definition of the IP protocol specific data.
69	* @see ip_proto	69	* @see ip_proto
70	*/	70	*/
71	typedef struct ip_proto ip_proto_t;	71	typedef struct ip_proto ip_proto_t;
72		72
73	/** Type definition of the IP protocol specific data pointer.	73	/** Type definition of the IP protocol specific data pointer.
74	* @see ip_proto	74	* @see ip_proto
75	*/	75	*/
76	typedef ip_proto_t * ip_proto_ref;	76	typedef ip_proto_t * ip_proto_ref;
77		77
78	/** Type definition of the IP route specific data.	78	/** Type definition of the IP route specific data.
79	* @see ip_route	79	* @see ip_route
80	*/	80	*/
81	typedef struct ip_route ip_route_t;	81	typedef struct ip_route ip_route_t;
82		82
83	/** Type definition of the IP route specific data pointer.	83	/** Type definition of the IP route specific data pointer.
84	* @see ip_route	84	* @see ip_route
85	*/	85	*/
86	typedef ip_route_t * ip_route_ref;	86	typedef ip_route_t * ip_route_ref;
87		87
88	/** IP network interfaces.	88	/** IP network interfaces.
89	* Maps devices to the IP network interface specific data.	89	* Maps devices to the IP network interface specific data.
90	* @see device.h	90	* @see device.h
91	*/	91	*/
92	DEVICE_MAP_DECLARE( ip_netifs, ip_netif_t )	92	DEVICE_MAP_DECLARE( ip_netifs, ip_netif_t )
93		93
94	/** IP registered protocols.	94	/** IP registered protocols.
95	* Maps protocols to the IP protocol specific data.	95	* Maps protocols to the IP protocol specific data.
96	* @see int_map.h	96	* @see int_map.h
97	*/	97	*/
98	INT_MAP_DECLARE( ip_protos, ip_proto_t )	98	INT_MAP_DECLARE( ip_protos, ip_proto_t )
99		99
100	/** IP routing table.	100	/** IP routing table.
101	* @see generic_field.h	101	* @see generic_field.h
102	*/	102	*/
103	GENERIC_FIELD_DECLARE( ip_routes, ip_route_t )	103	GENERIC_FIELD_DECLARE( ip_routes, ip_route_t )
104		104
105	/** IP network interface specific data.	105	/** IP network interface specific data.
106	*/	106	*/
107	struct ip_netif{	107	struct ip_netif{
108	/** Device identifier.	108	/** Device identifier.
109	*/	109	*/
110	device_id_t device_id;	110	device_id_t device_id;
111	/** Netif module service.	111	/** Netif module service.
112	*/	112	*/
113	services_t service;	113	services_t service;
114	/** Netif module phone.	114	/** Netif module phone.
115	*/	115	*/
116	int phone;	116	int phone;
117	/** ARP module.	117	/** ARP module.
118	* Assigned if using ARP.	118	* Assigned if using ARP.
119	*/	119	*/
120	module_ref arp;	120	module_ref arp;
121	/** IP version.	121	/** IP version.
122	*/	122	*/
123	int ipv;	123	int ipv;
124	/** Indicates whether using DHCP.	124	/** Indicates whether using DHCP.
125	*/	125	*/
126	int dhcp;	126	int dhcp;
127	/** Indicates whether IP routing is enabled.	127	/** Indicates whether IP routing is enabled.
128	*/	128	*/
129	int routing;	129	int routing;
130	/** Device state.	130	/** Device state.
131	*/	131	*/
132	device_state_t state;	132	device_state_t state;
133	/** Broadcast address.	133	/** Broadcast address.
134	*/	134	*/
135	in_addr_t broadcast;	135	in_addr_t broadcast;
136	/** First DNS address.	-
137	*/	-
138	in_addr_t dns1;	-
139	/** Second DNS address.	-
140	*/	-
141	in_addr_t dns2;	-
142	/** Routing table.	136	/** Routing table.
143	*/	137	*/
144	ip_routes_t routes;	138	ip_routes_t routes;
145	/** Reserved packet prefix length.	139	/** Reserved packet prefix length.
146	*/	140	*/
147	size_t prefix;	141	size_t prefix;
148	/** Maximal packet content length.	142	/** Maximal packet content length.
149	*/	143	*/
150	size_t content;	144	size_t content;
151	/** Reserved packet suffix length.	145	/** Reserved packet suffix length.
152	*/	146	*/
153	size_t suffix;	147	size_t suffix;
154	/** Packet address length.	148	/** Packet address length.
155	* The hardware address length is used.	149	* The hardware address length is used.
156	*/	150	*/
157	size_t addr_len;	151	size_t addr_len;
158	};	152	};
159		153
160	/** IP protocol specific data.	154	/** IP protocol specific data.
161	*/	155	*/
162	struct ip_proto{	156	struct ip_proto{
163	/** Protocol number.	157	/** Protocol number.
164	*/	158	*/
165	int protocol;	159	int protocol;
166	/** Protocol module service.	160	/** Protocol module service.
167	*/	161	*/
168	services_t service;	162	services_t service;
169	/** Protocol module phone.	163	/** Protocol module phone.
170	*/	164	*/
171	int phone;	165	int phone;
172	/** Protocol packet receiving function.	166	/** Protocol packet receiving function.
173	*/	167	*/
174	tl_received_msg_t received_msg;	168	tl_received_msg_t received_msg;
175	};	169	};
176		170
177	/** IP route specific data.	171	/** IP route specific data.
178	*/	172	*/
179	struct ip_route{	173	struct ip_route{
180	/** Target address.	174	/** Target address.
181	*/	175	*/
182	in_addr_t address;	176	in_addr_t address;
183	/** Target network mask.	177	/** Target network mask.
184	*/	178	*/
185	in_addr_t netmask;	179	in_addr_t netmask;
186	/** Gateway.	180	/** Gateway.
187	*/	181	*/
188	in_addr_t gateway;	182	in_addr_t gateway;
189	/** Parent netif.	183	/** Parent netif.
190	*/	184	*/
191	ip_netif_ref netif;	185	ip_netif_ref netif;
192	};	186	};
193		187
194	/** IP global data.	188	/** IP global data.
195	*/	189	*/
196	struct ip_globals{	190	struct ip_globals{
197	/** Networking module phone.	191	/** Networking module phone.
198	*/	192	*/
199	int net_phone;	193	int net_phone;
200	/** Registered network interfaces.	194	/** Registered network interfaces.
201	*/	195	*/
202	ip_netifs_t netifs;	196	ip_netifs_t netifs;
203	/** Netifs safeyt lock.	197	/** Netifs safeyt lock.
204	*/	198	*/
205	fibril_rwlock_t netifs_lock;	199	fibril_rwlock_t netifs_lock;
206	/** Registered protocols.	200	/** Registered protocols.
207	*/	201	*/
208	ip_protos_t protos;	202	ip_protos_t protos;
209	/** Protocols safety lock.	203	/** Protocols safety lock.
210	*/	204	*/
211	fibril_rwlock_t protos_lock;	205	fibril_rwlock_t protos_lock;
212	/** Default gateway.	206	/** Default gateway.
213	*/	207	*/
214	ip_route_t gateway;	208	ip_route_t gateway;
215	/** Known support modules.	209	/** Known support modules.
216	*/	210	*/
217	modules_t modules;	211	modules_t modules;
218	/** Default client connection function for support modules.	212	/** Default client connection function for support modules.
219	*/	213	*/
220	async_client_conn_t client_connection;	214	async_client_conn_t client_connection;
221	/** Packet counter.	215	/** Packet counter.
222	*/	216	*/
223	uint16_t packet_counter;	217	uint16_t packet_counter;
224	/** Safety lock.	218	/** Safety lock.
225	*/	219	*/
226	fibril_rwlock_t lock;	220	fibril_rwlock_t lock;
227	};	221	};
228		222
229	#endif	223	#endif
230		224
231	/** @}	225	/** @}
232	*/	226	*/
233		227

Subversion Repositories HelenOS

(root)/branches/network/uspace/srv/net/il/ip/ip.h @ 3886 – Rev 4704 → 4743