83cbd279 |
1 | /** @file\r |
2 | \r |
3 | Copyright (c) 2005 - 2006, Intel Corporation\r |
4 | All rights reserved. This program and the accompanying materials\r |
5 | are licensed and made available under the terms and conditions of the BSD License\r |
6 | which accompanies this distribution. The full text of the license may be found at\r |
7 | http://opensource.org/licenses/bsd-license.php\r |
8 | \r |
9 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r |
10 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r |
11 | \r |
12 | Module Name:\r |
13 | \r |
14 | Socket.h\r |
15 | \r |
16 | Abstract:\r |
17 | \r |
18 | \r |
19 | **/\r |
20 | \r |
21 | #ifndef _SOCKET_H_\r |
22 | #define _SOCKET_H_\r |
23 | \r |
8a67d61d |
24 | #include <PiDxe.h>\r |
25 | \r |
eaf343ff |
26 | #include <Protocol/Ip4.h>\r |
83cbd279 |
27 | #include <Protocol/Tcp4.h>\r |
8a67d61d |
28 | #include <Protocol/Udp4.h>\r |
83cbd279 |
29 | \r |
8a67d61d |
30 | #include <Library/NetLib.h>\r |
31 | #include <Library/DebugLib.h>\r |
32 | #include <Library/UefiRuntimeServicesTableLib.h>\r |
33 | #include <Library/UefiDriverEntryPoint.h>\r |
34 | #include <Library/UefiBootServicesTableLib.h>\r |
35 | #include <Library/BaseLib.h>\r |
83cbd279 |
36 | #include <Library/UefiLib.h>\r |
37 | #include <Library/MemoryAllocationLib.h>\r |
38 | #include <Library/BaseMemoryLib.h>\r |
39 | \r |
40 | #define SOCK_SND_BUF 0\r |
41 | #define SOCK_RCV_BUF 1\r |
42 | \r |
43 | #define SOCK_BUFF_LOW_WATER 2 * 1024\r |
44 | #define SOCK_RCV_BUFF_SIZE 8 * 1024\r |
45 | #define SOCK_SND_BUFF_SIZE 8 * 1024\r |
46 | #define SOCK_BACKLOG 5\r |
47 | \r |
48 | #define PROTO_RESERVED_LEN 20\r |
49 | \r |
50 | #define SO_NO_MORE_DATA 0x0001\r |
51 | \r |
52 | //\r |
53 | //\r |
54 | //\r |
55 | // When a socket is created it enters into SO_UNCONFIGURED,\r |
56 | // no actions can be taken on this socket, only after calling\r |
57 | // SockConfigure. The state transition diagram of socket is\r |
58 | // as following:\r |
59 | //\r |
60 | // SO_UNCONFIGURED --- SO_CONFIGURED --- SO_CONNECTING\r |
61 | // ^ | |\r |
62 | // | ---> SO_LISTENING |\r |
63 | // | |\r |
64 | // |------------------SO_DISCONNECTING<-- SO_CONNECTED\r |
65 | //\r |
66 | // A passive socket can only go into SO_LISTENING and\r |
67 | // SO_UNCONFIGURED state. SO_XXXING state is a middle state\r |
68 | // when a socket is undergoing a protocol procedure such\r |
69 | // as requesting a TCP connection.\r |
70 | //\r |
71 | //\r |
72 | //\r |
73 | typedef enum {\r |
74 | SO_CLOSED = 0,\r |
75 | SO_LISTENING,\r |
76 | SO_CONNECTING,\r |
77 | SO_CONNECTED,\r |
78 | SO_DISCONNECTING\r |
79 | } SOCK_STATE;\r |
80 | \r |
81 | typedef enum {\r |
82 | SO_UNCONFIGURED = 0,\r |
83 | SO_CONFIGURED_ACTIVE,\r |
84 | SO_CONFIGURED_PASSIVE,\r |
85 | SO_NO_MAPPING\r |
86 | } SOCK_CONFIGURE_STATE;\r |
87 | \r |
88 | #define SOCK_NO_MORE_DATA(Sock) ((Sock)->Flag |= SO_NO_MORE_DATA)\r |
89 | \r |
90 | #define SOCK_IS_UNCONFIGURED(Sock) ((Sock)->ConfigureState == SO_UNCONFIGURED)\r |
91 | \r |
92 | #define SOCK_IS_CONFIGURED(Sock) \\r |
93 | (((Sock)->ConfigureState == SO_CONFIGURED_ACTIVE) || \\r |
94 | ((Sock)->ConfigureState == SO_CONFIGURED_PASSIVE))\r |
95 | \r |
96 | #define SOCK_IS_CONFIGURED_ACTIVE(Sock) \\r |
97 | ((Sock)->ConfigureState == SO_CONFIGURED_ACTIVE)\r |
98 | \r |
99 | #define SOCK_IS_CONNECTED_PASSIVE(Sock) \\r |
100 | ((Sock)->ConfigureState == SO_CONFIGURED_PASSIVE)\r |
101 | \r |
102 | #define SOCK_IS_NO_MAPPING(Sock) \\r |
103 | ((Sock)->ConfigureState == SO_NO_MAPPING)\r |
104 | \r |
105 | #define SOCK_IS_CLOSED(Sock) ((Sock)->State == SO_CLOSED)\r |
106 | \r |
107 | #define SOCK_IS_LISTENING(Sock) ((Sock)->State == SO_LISTENING)\r |
108 | \r |
109 | #define SOCK_IS_CONNECTING(Sock) ((Sock)->State == SO_CONNECTING)\r |
110 | \r |
111 | #define SOCK_IS_CONNECTED(Sock) ((Sock)->State == SO_CONNECTED)\r |
112 | \r |
113 | #define SOCK_IS_DISCONNECTING(Sock) ((Sock)->State == SO_DISCONNECTING)\r |
114 | \r |
115 | #define SOCK_IS_NO_MORE_DATA(Sock) (0 != ((Sock)->Flag & SO_NO_MORE_DATA))\r |
116 | \r |
117 | #define SOCK_SIGNATURE EFI_SIGNATURE_32 ('S', 'O', 'C', 'K')\r |
118 | \r |
119 | #define SOCK_FROM_THIS(a) CR ((a), SOCKET, NetProtocol, SOCK_SIGNATURE)\r |
120 | \r |
121 | #define SET_RCV_BUFFSIZE(Sock, Size) ((Sock)->RcvBuffer.HighWater = (Size))\r |
122 | \r |
123 | #define GET_RCV_BUFFSIZE(Sock) ((Sock)->RcvBuffer.HighWater)\r |
124 | \r |
125 | #define GET_RCV_DATASIZE(Sock) (((Sock)->RcvBuffer.DataQueue)->BufSize)\r |
126 | \r |
127 | #define SET_SND_BUFFSIZE(Sock, Size) ((Sock)->SndBuffer.HighWater = (Size))\r |
128 | \r |
129 | #define GET_SND_BUFFSIZE(Sock) ((Sock)->SndBuffer.HighWater)\r |
130 | \r |
131 | #define GET_SND_DATASIZE(Sock) (((Sock)->SndBuffer.DataQueue)->BufSize)\r |
132 | \r |
133 | #define SET_BACKLOG(Sock, Value) ((Sock)->BackLog = (Value))\r |
134 | \r |
135 | #define GET_BACKLOG(Sock) ((Sock)->BackLog)\r |
136 | \r |
137 | #define SOCK_ERROR(Sock, Error) ((Sock)->SockError = (Error))\r |
138 | \r |
139 | #define SND_BUF_HDR_LEN(Sock) \\r |
140 | ((SockBufFirst (&((Sock)->SndBuffer)))->TotalSize)\r |
141 | \r |
142 | #define RCV_BUF_HDR_LEN(Sock) \\r |
143 | ((SockBufFirst (&((Sock)->RcvBuffer)))->TotalSize)\r |
144 | \r |
145 | #define SOCK_FROM_TOKEN(Token) (((SOCK_TOKEN *) (Token))->Sock)\r |
146 | \r |
147 | #define PROTO_TOKEN_FORM_SOCK(SockToken, Type) \\r |
148 | ((Type *) (((SOCK_TOKEN *) (SockToken))->Token))\r |
149 | \r |
150 | typedef struct _SOCKET SOCKET;\r |
151 | \r |
152 | typedef struct _SOCK_COMPLETION_TOKEN {\r |
153 | EFI_EVENT Event;\r |
154 | EFI_STATUS Status;\r |
155 | } SOCK_COMPLETION_TOKEN;\r |
156 | \r |
157 | typedef struct _SOCK_IO_TOKEN {\r |
158 | SOCK_COMPLETION_TOKEN Token;\r |
159 | union {\r |
160 | VOID *RxData;\r |
161 | VOID *TxData;\r |
162 | } Packet;\r |
163 | } SOCK_IO_TOKEN;\r |
164 | \r |
165 | //\r |
166 | // the request issued from socket layer to protocol layer\r |
167 | //\r |
168 | typedef enum {\r |
169 | SOCK_ATTACH, // attach current socket to a new PCB\r |
170 | SOCK_DETACH, // detach current socket from the PCB\r |
171 | SOCK_CONFIGURE, // configure attached PCB\r |
172 | SOCK_FLUSH, // flush attached PCB\r |
173 | SOCK_SND, // need protocol to send something\r |
174 | SOCK_SNDPUSH, // need protocol to send pushed data\r |
175 | SOCK_SNDURG, // need protocol to send urgent data\r |
176 | SOCK_CONSUMED, // application has retrieved data from socket\r |
177 | SOCK_CONNECT, // need to connect to a peer\r |
178 | SOCK_CLOSE, // need to close the protocol process\r |
179 | SOCK_ABORT, // need to reset the protocol process\r |
180 | SOCK_POLL, // need to poll to the protocol layer\r |
181 | SOCK_ROUTE, // need to add a route information\r |
182 | SOCK_MODE, // need to get the mode data of the protocol\r |
183 | SOCK_GROUP // need to join a mcast group\r |
184 | } SOCK_REQUEST;\r |
185 | \r |
186 | //\r |
187 | // the socket type\r |
188 | //\r |
189 | typedef enum {\r |
190 | SOCK_DGRAM, // this socket providing datagram service\r |
191 | SOCK_STREAM // this socket providing stream service\r |
192 | } SOCK_TYPE;\r |
193 | \r |
194 | //\r |
195 | // the handler of protocol for request from socket\r |
196 | //\r |
197 | typedef\r |
198 | EFI_STATUS\r |
199 | (*SOCK_PROTO_HANDLER) (\r |
200 | IN SOCKET * Socket, // the socket issuing the request to protocol\r |
201 | IN SOCK_REQUEST Request, // the request issued by socket\r |
202 | IN VOID *RequestData // the request related data\r |
203 | );\r |
204 | \r |
205 | //\r |
206 | // the buffer structure of rcvd data and send data used by socket\r |
207 | //\r |
208 | typedef struct _SOCK_BUFFER {\r |
209 | UINT32 HighWater; // the buffersize upper limit of sock_buffer\r |
210 | UINT32 LowWater; // the low warter mark of sock_buffer\r |
211 | NET_BUF_QUEUE *DataQueue; // the queue to buffer data\r |
212 | } SOCK_BUFFER;\r |
213 | \r |
83cbd279 |
214 | \r |
215 | //\r |
216 | // socket provided oprerations for low layer protocol\r |
217 | //\r |
218 | \r |
219 | //\r |
220 | // socket provided operations for user interface\r |
221 | //\r |
222 | VOID\r |
223 | SockSetState (\r |
224 | IN SOCKET *Sock,\r |
225 | IN SOCK_STATE State\r |
226 | );\r |
227 | \r |
228 | //\r |
229 | // when the connection establishment process for a Sock\r |
230 | // is finished low layer protocol calling this function\r |
231 | // to notify socket layer\r |
232 | //\r |
233 | VOID\r |
234 | SockConnEstablished (\r |
235 | IN SOCKET *Sock\r |
236 | );\r |
237 | \r |
238 | VOID\r |
239 | SockConnClosed (\r |
240 | IN SOCKET *Sock\r |
241 | );\r |
242 | \r |
243 | //\r |
244 | // called by low layer protocol to trim send buffer of\r |
245 | // Sock, when Count data is sent out completely\r |
246 | //\r |
247 | VOID\r |
248 | SockDataSent (\r |
249 | IN SOCKET *Sock,\r |
250 | IN UINT32 Count\r |
251 | );\r |
252 | \r |
253 | //\r |
254 | // called by low layer protocol to get Len of data from\r |
255 | // socket to send and copy it in Dest\r |
256 | //\r |
257 | UINT32\r |
258 | SockGetDataToSend (\r |
259 | IN SOCKET *Sock,\r |
260 | IN UINT32 Offset,\r |
261 | IN UINT32 Len,\r |
262 | IN UINT8 *Dest\r |
263 | );\r |
264 | \r |
265 | //\r |
266 | // called by low layer protocol to notify socket no more data can be\r |
267 | // received\r |
268 | //\r |
269 | VOID\r |
270 | SockNoMoreData (\r |
271 | IN SOCKET *Sock\r |
272 | );\r |
273 | \r |
274 | //\r |
275 | // called by low layer protocol to append a NetBuffer\r |
276 | // to rcv buffer of sock\r |
277 | //\r |
278 | VOID\r |
279 | SockDataRcvd (\r |
280 | IN SOCKET *Sock,\r |
281 | IN NET_BUF *NetBuffer,\r |
282 | IN UINT32 UrgLen\r |
283 | );\r |
284 | \r |
285 | UINT32\r |
286 | SockGetFreeSpace (\r |
287 | IN SOCKET *Sock,\r |
288 | IN UINT32 Which\r |
289 | );\r |
290 | \r |
291 | SOCKET *\r |
292 | SockClone (\r |
293 | IN SOCKET *Sock\r |
294 | );\r |
295 | \r |
296 | VOID\r |
297 | SockRcvdErr (\r |
298 | IN SOCKET *Sock,\r |
299 | IN EFI_STATUS Error\r |
300 | );\r |
301 | \r |
4f6e31e4 |
302 | typedef\r |
303 | EFI_STATUS\r |
304 | (*SOCK_CREATE_CALLBACK) (\r |
305 | IN SOCKET *This,\r |
306 | IN VOID *Context\r |
307 | );\r |
308 | \r |
309 | typedef\r |
310 | VOID\r |
311 | (*SOCK_DESTROY_CALLBACK) (\r |
312 | IN SOCKET *This,\r |
313 | IN VOID *Context\r |
314 | );\r |
315 | \r |
316 | //\r |
317 | // the initialize data for create a new socket\r |
318 | //\r |
319 | typedef struct _SOCK_INIT_DATA {\r |
320 | SOCK_TYPE Type;\r |
321 | SOCK_STATE State;\r |
322 | \r |
323 | SOCKET *Parent; // the parent of this socket\r |
324 | UINT32 BackLog; // the connection limit for listening socket\r |
325 | UINT32 SndBufferSize; // the high warter mark of send buffer\r |
326 | UINT32 RcvBufferSize; // the high warter mark of receive buffer\r |
327 | VOID *Protocol; // the pointer to protocol function template\r |
328 | // wanted to install on socket\r |
329 | \r |
330 | //\r |
331 | // Callbacks after socket is created and before socket is to be destroyed.\r |
332 | //\r |
333 | SOCK_CREATE_CALLBACK CreateCallback;\r |
334 | SOCK_DESTROY_CALLBACK DestroyCallback;\r |
335 | VOID *Context;\r |
336 | \r |
337 | //\r |
338 | // Opaque protocol data.\r |
339 | //\r |
340 | VOID *ProtoData;\r |
341 | UINT32 DataSize;\r |
342 | \r |
343 | SOCK_PROTO_HANDLER ProtoHandler;\r |
344 | \r |
345 | EFI_HANDLE DriverBinding; // the driver binding handle\r |
346 | } SOCK_INIT_DATA;\r |
85511ddf |
347 | \r |
348 | //\r |
349 | //the union type of TCP and UDP protocol\r |
350 | //\r |
351 | typedef union {\r |
352 | EFI_TCP4_PROTOCOL TcpProtocol;\r |
353 | EFI_UDP4_PROTOCOL UdpProtocol;\r |
354 | } NET_PROTOCOL;\r |
83cbd279 |
355 | //\r |
356 | // the socket structure representing a network service access point\r |
357 | //\r |
358 | struct _SOCKET {\r |
359 | \r |
360 | //\r |
361 | // socket description information\r |
362 | //\r |
363 | UINT32 Signature;\r |
364 | EFI_HANDLE SockHandle; // the virtual handle of the socket\r |
365 | EFI_HANDLE DriverBinding; // socket't driver binding protocol\r |
366 | EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath;\r |
367 | EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r |
e48e37fc |
368 | LIST_ENTRY Link; \r |
83cbd279 |
369 | SOCK_CONFIGURE_STATE ConfigureState;\r |
370 | SOCK_TYPE Type;\r |
371 | SOCK_STATE State;\r |
372 | UINT16 Flag;\r |
e48e37fc |
373 | EFI_LOCK Lock; // the lock of socket\r |
83cbd279 |
374 | SOCK_BUFFER SndBuffer; // send buffer of application's data\r |
375 | SOCK_BUFFER RcvBuffer; // receive buffer of received data\r |
376 | EFI_STATUS SockError; // the error returned by low layer protocol\r |
377 | BOOLEAN IsDestroyed;\r |
378 | \r |
379 | //\r |
380 | // fields used to manage the connection request\r |
381 | //\r |
382 | UINT32 BackLog; // the limit of connection to this socket\r |
383 | UINT32 ConnCnt; // the current count of connections to it\r |
384 | SOCKET *Parent; // listening parent that accept the connection\r |
e48e37fc |
385 | LIST_ENTRY ConnectionList; // the connections maintained by this socket\r |
83cbd279 |
386 | //\r |
387 | // the queue to buffer application's asynchronous token\r |
388 | //\r |
e48e37fc |
389 | LIST_ENTRY ListenTokenList;\r |
390 | LIST_ENTRY RcvTokenList;\r |
391 | LIST_ENTRY SndTokenList;\r |
392 | LIST_ENTRY ProcessingSndTokenList;\r |
83cbd279 |
393 | \r |
394 | SOCK_COMPLETION_TOKEN *ConnectionToken; // app's token to signal if connected\r |
395 | SOCK_COMPLETION_TOKEN *CloseToken; // app's token to signal if closed\r |
396 | \r |
397 | //\r |
398 | // interface for low level protocol\r |
399 | //\r |
400 | SOCK_PROTO_HANDLER ProtoHandler; // the request handler of protocol\r |
401 | UINT8 ProtoReserved[PROTO_RESERVED_LEN]; // Data fields reserved for protocol\r |
85511ddf |
402 | NET_PROTOCOL NetProtocol;\r |
4f6e31e4 |
403 | \r |
404 | //\r |
405 | // Callbacks.\r |
406 | //\r |
407 | SOCK_CREATE_CALLBACK CreateCallback;\r |
408 | SOCK_DESTROY_CALLBACK DestroyCallback;\r |
409 | VOID *Context;\r |
83cbd279 |
410 | };\r |
411 | \r |
412 | //\r |
413 | // the token structure buffered in socket layer\r |
414 | //\r |
415 | typedef struct _SOCK_TOKEN {\r |
e48e37fc |
416 | LIST_ENTRY TokenList; // the entry to add in the token list\r |
83cbd279 |
417 | SOCK_COMPLETION_TOKEN *Token; // The application's token\r |
418 | UINT32 RemainDataLen; // unprocessed data length\r |
419 | SOCKET *Sock; // the poninter to the socket this token\r |
420 | // belongs to\r |
421 | } SOCK_TOKEN;\r |
422 | \r |
423 | //\r |
424 | // reserved data to access the NET_BUF delivered by UDP driver\r |
425 | //\r |
426 | typedef struct _UDP_RSV_DATA {\r |
427 | EFI_TIME TimeStamp;\r |
428 | EFI_UDP4_SESSION_DATA Session;\r |
429 | } UDP_RSV_DATA;\r |
430 | \r |
431 | //\r |
432 | // reserved data to access the NET_BUF delivered by TCP driver\r |
433 | //\r |
434 | typedef struct _TCP_RSV_DATA {\r |
435 | UINT32 UrgLen;\r |
436 | } TCP_RSV_DATA;\r |
437 | \r |
438 | //\r |
439 | // call it to creat a socket and attach it to a PCB\r |
440 | //\r |
441 | SOCKET *\r |
442 | SockCreateChild (\r |
4f6e31e4 |
443 | IN SOCK_INIT_DATA *SockInitData\r |
83cbd279 |
444 | );\r |
445 | \r |
446 | //\r |
447 | // call it to destroy a socket and its related PCB\r |
448 | //\r |
449 | EFI_STATUS\r |
450 | SockDestroyChild (\r |
451 | IN SOCKET *Sock\r |
452 | );\r |
453 | \r |
454 | //\r |
455 | // call it to configure a socket and its related PCB\r |
456 | //\r |
457 | EFI_STATUS\r |
458 | SockConfigure (\r |
459 | IN SOCKET *Sock,\r |
460 | IN VOID *ConfigData\r |
461 | );\r |
462 | \r |
463 | //\r |
464 | // call it to connect a socket to the peer\r |
465 | //\r |
466 | EFI_STATUS\r |
467 | SockConnect (\r |
468 | IN SOCKET *Sock,\r |
469 | IN VOID *Token\r |
470 | );\r |
471 | \r |
472 | //\r |
473 | // call it to issue an asynchronous listen token to the socket\r |
474 | //\r |
475 | EFI_STATUS\r |
476 | SockAccept (\r |
477 | IN SOCKET *Sock,\r |
478 | IN VOID *Token\r |
479 | );\r |
480 | \r |
481 | //\r |
482 | // Call it to send data using this socket\r |
483 | //\r |
484 | EFI_STATUS\r |
485 | SockSend (\r |
486 | IN SOCKET *Sock,\r |
487 | IN VOID *Token\r |
488 | );\r |
489 | \r |
490 | //\r |
491 | // Call it to receive data from this socket\r |
492 | //\r |
493 | EFI_STATUS\r |
494 | SockRcv (\r |
495 | IN SOCKET *Sock,\r |
496 | IN VOID *Token\r |
497 | );\r |
498 | \r |
499 | //\r |
500 | // Call it to flush a socket\r |
501 | //\r |
502 | EFI_STATUS\r |
503 | SockFlush (\r |
504 | IN SOCKET *Sock\r |
505 | );\r |
506 | \r |
507 | //\r |
508 | // Call it to close a socket in the light of policy in Token\r |
509 | //\r |
510 | EFI_STATUS\r |
511 | SockClose (\r |
512 | IN SOCKET *Sock,\r |
513 | IN VOID *Token,\r |
514 | IN BOOLEAN OnAbort\r |
515 | );\r |
516 | \r |
517 | //\r |
518 | // Call it to get the mode data of low layer protocol\r |
519 | //\r |
520 | EFI_STATUS\r |
521 | SockGetMode (\r |
522 | IN SOCKET *Sock,\r |
523 | IN VOID *Mode\r |
524 | );\r |
525 | \r |
526 | //\r |
527 | // call it to add this socket instance into a group\r |
528 | //\r |
529 | EFI_STATUS\r |
530 | SockGroup (\r |
531 | IN SOCKET *Sock,\r |
532 | IN VOID *GroupInfo\r |
533 | );\r |
534 | \r |
535 | //\r |
536 | // call it to add a route entry for this socket instance\r |
537 | //\r |
538 | EFI_STATUS\r |
539 | SockRoute (\r |
540 | IN SOCKET *Sock,\r |
541 | IN VOID *RouteInfo\r |
542 | );\r |
543 | \r |
544 | //\r |
545 | // Supporting function to operate on socket buffer\r |
546 | //\r |
547 | NET_BUF *\r |
548 | SockBufFirst (\r |
549 | IN SOCK_BUFFER *Sockbuf\r |
550 | );\r |
551 | \r |
552 | NET_BUF *\r |
553 | SockBufNext (\r |
554 | IN SOCK_BUFFER *Sockbuf,\r |
555 | IN NET_BUF *SockEntry\r |
556 | );\r |
557 | \r |
558 | #endif\r |