8061f3a14719fcb6dd68139edf3a5acee4d12fee
[reactos.git] / reactos / drivers / net / tcpip / include / ip.h
1 /*
2 * COPYRIGHT: See COPYING in the top level directory
3 * PROJECT: ReactOS TCP/IP protocol driver
4 * FILE: include/ip.h
5 * PURPOSE: Internet Protocol related definitions
6 */
7 #ifndef __IP_H
8 #define __IP_H
9
10 typedef VOID (*OBJECT_FREE_ROUTINE)(PVOID Object);
11
12 #define FOURCC(a,b,c,d) (((a)<<24)|((b)<<16)|((c)<<8)|(d))
13
14 /* Raw IPv4 style address */
15 typedef ULONG IPv4_RAW_ADDRESS;
16 typedef IPv4_RAW_ADDRESS *PIPv4_RAW_ADDRESS;
17
18 /* Raw IPv6 style address */
19 typedef USHORT IPv6_RAW_ADDRESS[8];
20 typedef IPv6_RAW_ADDRESS *PIPv6_RAW_ADDRESS;
21
22 /* IP style address */
23 typedef struct IP_ADDRESS {
24 DEFINE_TAG
25 UCHAR Type; /* Type of IP address */
26 union {
27 IPv4_RAW_ADDRESS IPv4Address;/* IPv4 address (in network byte order) */
28 IPv6_RAW_ADDRESS IPv6Address;/* IPv6 address (in network byte order) */
29 } Address;
30 } IP_ADDRESS, *PIP_ADDRESS;
31
32 /* IP type constants */
33 #define IP_ADDRESS_V4 0x04 /* IPv4 style address */
34 #define IP_ADDRESS_V6 0x06 /* IPv6 style address */
35
36
37 /* IPv4 header format */
38 typedef struct IPv4_HEADER {
39 UCHAR VerIHL; /* 4-bit version, 4-bit Internet Header Length */
40 UCHAR Tos; /* Type of Service */
41 USHORT TotalLength; /* Total Length */
42 USHORT Id; /* Identification */
43 USHORT FlagsFragOfs; /* 3-bit Flags, 13-bit Fragment Offset */
44 UCHAR Ttl; /* Time to Live */
45 UCHAR Protocol; /* Protocol */
46 USHORT Checksum; /* Header Checksum */
47 IPv4_RAW_ADDRESS SrcAddr; /* Source Address */
48 IPv4_RAW_ADDRESS DstAddr; /* Destination Address */
49 } IPv4_HEADER, *PIPv4_HEADER;
50
51 /* IPv6 header format */
52 typedef struct IPv6_HEADER {
53 ULONG VTF; /* Version, Traffic Class, Flow Label */
54 USHORT PayloadLength;
55 UCHAR NextHeader; /* Same as Protocol in IPv4 */
56 UCHAR HopLimit; /* Same as Ttl in IPv4 */
57 IPv6_RAW_ADDRESS SrcAddr;
58 IPv6_RAW_ADDRESS DstAddr;
59 } IPv6_HEADER, *PIPv6_HEADER;
60
61 typedef union _IP_HEADER {
62 IPv4_HEADER v4;
63 IPv6_HEADER v6;
64 } IP_HEADER, *PIP_HEADER;
65
66 #define IPv4_FRAGOFS_MASK 0x1FFF /* Fragment offset mask (host byte order) */
67 #define IPv4_MF_MASK 0x2000 /* More fragments (host byte order) */
68 #define IPv4_DF_MASK 0x4000 /* Don't fragment (host byte order) */
69 #define IPv4_MAX_HEADER_SIZE 60
70
71 /* Packet completion handler prototype */
72 typedef VOID (*PACKET_COMPLETION_ROUTINE)(
73 PVOID Context,
74 PNDIS_PACKET NdisPacket,
75 NDIS_STATUS NdisStatus);
76
77 /* Structure for an IP packet */
78 typedef struct _IP_PACKET {
79 DEFINE_TAG
80 OBJECT_FREE_ROUTINE Free; /* Routine used to free resources for the object */
81 UCHAR Type; /* Type of IP packet (see IP_ADDRESS_xx above) */
82 UCHAR Flags; /* Flags for packet (see IP_PACKET_FLAG_xx below)*/
83 PVOID Header; /* Pointer to IP header for this packet */
84 UINT HeaderSize; /* Size of IP header */
85 PVOID Data; /* Current pointer into packet data */
86 UINT TotalSize; /* Total amount of data in packet (IP header and data) */
87 UINT ContigSize; /* Number of contiguous bytes left in current buffer */
88 UINT Position; /* Current logical offset into packet */
89 PNDIS_PACKET NdisPacket; /* Pointer to NDIS packet */
90 IP_ADDRESS SrcAddr; /* Source address */
91 IP_ADDRESS DstAddr; /* Destination address */
92 } IP_PACKET, *PIP_PACKET;
93
94 #define IP_PACKET_FLAG_RAW 0x01 /* Raw IP packet */
95
96
97 /* Packet context */
98 typedef struct _PACKET_CONTEXT {
99 PACKET_COMPLETION_ROUTINE DLComplete; /* Data link level completion handler
100 * Also used to link to next packet
101 * in a queue */
102 PVOID Context; /* Context information for handler */
103 UINT PacketType; /* Type of packet */
104 } PACKET_CONTEXT, *PPACKET_CONTEXT;
105
106 /* The ProtocolReserved field is structured as a PACKET_CONTEXT */
107 #define PC(Packet) ((PPACKET_CONTEXT)(&Packet->ProtocolReserved))
108
109 /* Values for address type -- also the interface flags */
110 /* These values are mean to overlap meaningfully with the BSD ones */
111 #define ADE_UNICAST 0x01
112 #define ADE_BROADCAST 0x02
113 #define ADE_ADDRMASK 0x04
114 #define ADE_POINTOPOINT 0x10
115 #define ADE_MULTICAST 0x8000
116
117 /* There is one NTE for each source (unicast) address assigned to an interface */
118 /* Link layer transmit prototype */
119 typedef VOID (*LL_TRANSMIT_ROUTINE)(
120 PVOID Context,
121 PNDIS_PACKET NdisPacket,
122 UINT Offset,
123 PVOID LinkAddress,
124 USHORT Type);
125
126 /* Link layer to IP binding information */
127 typedef struct _LLIP_BIND_INFO {
128 PVOID Context; /* Pointer to link layer context information */
129 UINT HeaderSize; /* Size of link level header */
130 UINT MinFrameSize; /* Minimum frame size in bytes */
131 UINT MTU; /* Maximum transmission unit */
132 PUCHAR Address; /* Pointer to interface address */
133 UINT AddressLength; /* Length of address in bytes */
134 LL_TRANSMIT_ROUTINE Transmit; /* Transmit function for this interface */
135 } LLIP_BIND_INFO, *PLLIP_BIND_INFO;
136
137
138 /* Information about an IP interface */
139 typedef struct _IP_INTERFACE {
140 DEFINE_TAG
141 LIST_ENTRY ListEntry; /* Entry on list */
142 OBJECT_FREE_ROUTINE Free; /* Routine used to free resources used by the object */
143 KSPIN_LOCK Lock; /* Spin lock for this object */
144 PVOID Context; /* Pointer to link layer context information */
145 UINT HeaderSize; /* Size of link level header */
146 UINT MinFrameSize; /* Minimum frame size in bytes */
147 UINT MTU; /* Maximum transmission unit */
148 UINT Speed; /* Link speed */
149 IP_ADDRESS Unicast; /* Unicast address */
150 IP_ADDRESS PointToPoint; /* Point to point address */
151 IP_ADDRESS Netmask; /* Netmask */
152 IP_ADDRESS Broadcast; /* Broadcast */
153 UNICODE_STRING Name; /* Adapter name */
154 PUCHAR Address; /* Pointer to interface address */
155 UINT AddressLength; /* Length of address in bytes */
156 UINT Index; /* Index of adapter (used to add ip addr) */
157 LL_TRANSMIT_ROUTINE Transmit; /* Pointer to transmit function */
158 PVOID TCPContext; /* TCP Content for this interface */
159 } IP_INTERFACE, *PIP_INTERFACE;
160
161 typedef struct _IP_SET_ADDRESS {
162 ULONG NteIndex;
163 IPv4_RAW_ADDRESS Address;
164 IPv4_RAW_ADDRESS Netmask;
165 } IP_SET_ADDRESS, *PIP_SET_ADDRESS;
166
167 #define IP_PROTOCOL_TABLE_SIZE 0x100
168
169 typedef VOID (*IP_PROTOCOL_HANDLER)(
170 PIP_INTERFACE Interface,
171 PIP_PACKET IPPacket);
172
173 /* Loopback adapter address information (network byte order) */
174 #define LOOPBACK_ADDRESS_IPv4 ((IPv4_RAW_ADDRESS)DH2N(0x7F000001))
175 #define LOOPBACK_BCASTADDR_IPv4 ((IPv4_RAW_ADDRESS)DH2N(0x7F0000FF))
176 #define LOOPBACK_ADDRMASK_IPv4 ((IPv4_RAW_ADDRESS)DH2N(0xFFFFFF00))
177
178 /* Protocol definitions */
179 #ifndef IPPROTO_RAW
180 #define IPPROTO_RAW 0 /* Raw IP */
181 #endif
182 #define IPPROTO_ICMP 1 /* Internet Control Message Protocol */
183 #define IPPROTO_IGMP 2 /* Internet Group Management Protocol */
184 #define IPPROTO_TCP 6 /* Transmission Control Protocol */
185 #define IPPROTO_UDP 17 /* User Datagram Protocol */
186
187 /* Timeout timer constants */
188 #define IP_TICKS_SECOND 2 /* Two ticks per second */
189 #define IP_TIMEOUT (1000 / IP_TICKS_SECOND) /* Timeout in milliseconds */
190 #define IP_DEFAULT_LINK_SPEED 10000
191
192 extern LIST_ENTRY InterfaceListHead;
193 extern KSPIN_LOCK InterfaceListLock;
194 extern LIST_ENTRY NetTableListHead;
195 extern KSPIN_LOCK NetTableListLock;
196 extern UINT MaxLLHeaderSize;
197 extern UINT MinLLFrameSize;
198 extern BOOLEAN IpWorkItemQueued;
199
200 PIP_PACKET IPCreatePacket(
201 ULONG Type);
202
203 PIP_PACKET IPInitializePacket(
204 PIP_PACKET IPPacket,
205 ULONG Type);
206
207 PIP_INTERFACE IPCreateInterface(
208 PLLIP_BIND_INFO BindInfo);
209
210 VOID IPAddInterfaceRoute(
211 PIP_INTERFACE IF);
212
213 VOID IPRemoveInterfaceRoute(
214 PIP_INTERFACE IF);
215
216 VOID IPDestroyInterface(
217 PIP_INTERFACE IF);
218
219 BOOLEAN IPRegisterInterface(
220 PIP_INTERFACE IF);
221
222 VOID IPUnregisterInterface(
223 PIP_INTERFACE IF);
224
225 VOID STDCALL IPTimeout( PVOID Context );
226
227 VOID IPDispatchProtocol(
228 PIP_INTERFACE Interface,
229 PIP_PACKET IPPacket);
230
231 VOID IPRegisterProtocol(
232 UINT ProtocolNumber,
233 IP_PROTOCOL_HANDLER Handler);
234
235 NTSTATUS IPStartup(PUNICODE_STRING RegistryPath);
236
237 NTSTATUS IPShutdown(VOID);
238
239
240
241 #endif /* __IP_H */
242
243 /* EOF */