Socket.h

Go to the documentation of this file.

 
#ifndef _SOCKET_H_
#define _SOCKET_H_
 
#include <Uefi.h>
 
#include <Protocol/Tcp4.h>
#include <Protocol/Tcp6.h>
 
#include <Library/NetLib.h>
#include <Library/DebugLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/UefiRuntimeServicesTableLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiLib.h>
#include <Library/DpcLib.h>
 
#define SOCK_SND_BUF  0
#define SOCK_RCV_BUF  1
 
#define SOCK_BUFF_LOW_WATER  (2 * 1024)
#define SOCK_RCV_BUFF_SIZE   (8 * 1024)
#define SOCK_SND_BUFF_SIZE   (8 * 1024)
#define SOCK_BACKLOG         5
 
#define PROTO_RESERVED_LEN  20
 
#define SO_NO_MORE_DATA  0x0001
 
//
//
//
// When a socket is created it enters into SO_UNCONFIGURED,
// no actions can be taken on this socket, only after calling
// SockConfigure. The state transition diagram of socket is
// as following:
//
// SO_UNCONFIGURED --- SO_CONFIGURED --- SO_CONNECTING
//  ^      |                                    |
//  |      --->  SO_LISTENING                   |
//  |                                           |
//  |------------------SO_DISCONNECTING<-- SO_CONNECTED
//
// A passive socket can only go into SO_LISTENING and
// SO_UNCONFIGURED state. SO_XXXING state is a middle state
// when a socket is undergoing a protocol procedure such
// as requesting a TCP connection.
//
//
//
 
#define SO_CLOSED         0
#define SO_LISTENING      1
#define SO_CONNECTING     2
#define SO_CONNECTED      3
#define SO_DISCONNECTING  4
 
#define SO_UNCONFIGURED        0
#define SO_CONFIGURED_ACTIVE   1
#define SO_CONFIGURED_PASSIVE  2
#define SO_NO_MAPPING          3
 
#define SOCK_ATTACH     0    
#define SOCK_DETACH     1    
#define SOCK_CONFIGURE  2    
#define SOCK_FLUSH      3    
#define SOCK_SND        4    
#define SOCK_SNDPUSH    5    
#define SOCK_SNDURG     6    
#define SOCK_CONSUMED   7    
#define SOCK_CONNECT    8    
#define SOCK_CLOSE      9    
#define SOCK_ABORT      10   
#define SOCK_POLL       11   
#define SOCK_ROUTE      12   
#define SOCK_MODE       13   
#define SOCK_GROUP      14   
 
#define SOCK_NO_MORE_DATA(Sock)  ((Sock)->Flag |= SO_NO_MORE_DATA)
 
#define SOCK_IS_UNCONFIGURED(Sock)  ((Sock)->ConfigureState == SO_UNCONFIGURED)
 
#define SOCK_IS_CONFIGURED(Sock) \
    (((Sock)->ConfigureState == SO_CONFIGURED_ACTIVE) || \
    ((Sock)->ConfigureState == SO_CONFIGURED_PASSIVE))
 
#define SOCK_IS_CONFIGURED_ACTIVE(Sock)  ((Sock)->ConfigureState == SO_CONFIGURED_ACTIVE)
 
#define SOCK_IS_CONNECTED_PASSIVE(Sock)  ((Sock)->ConfigureState == SO_CONFIGURED_PASSIVE)
 
#define SOCK_IS_NO_MAPPING(Sock)  ((Sock)->ConfigureState == SO_NO_MAPPING)
 
#define SOCK_IS_CLOSED(Sock)  ((Sock)->State == SO_CLOSED)
 
#define SOCK_IS_LISTENING(Sock)  ((Sock)->State == SO_LISTENING)
 
#define SOCK_IS_CONNECTING(Sock)  ((Sock)->State == SO_CONNECTING)
 
#define SOCK_IS_CONNECTED(Sock)  ((Sock)->State == SO_CONNECTED)
 
#define SOCK_IS_DISCONNECTING(Sock)  ((Sock)->State == SO_DISCONNECTING)
 
#define SOCK_IS_NO_MORE_DATA(Sock)  (0 != ((Sock)->Flag & SO_NO_MORE_DATA))
 
#define SET_RCV_BUFFSIZE(Sock, Size)  ((Sock)->RcvBuffer.HighWater = (Size))
 
#define GET_RCV_BUFFSIZE(Sock)  ((Sock)->RcvBuffer.HighWater)
 
#define GET_RCV_DATASIZE(Sock)  (((Sock)->RcvBuffer.DataQueue)->BufSize)
 
#define SET_SND_BUFFSIZE(Sock, Size)  ((Sock)->SndBuffer.HighWater = (Size))
 
#define GET_SND_BUFFSIZE(Sock)  ((Sock)->SndBuffer.HighWater)
 
#define GET_SND_DATASIZE(Sock)  (((Sock)->SndBuffer.DataQueue)->BufSize)
 
#define SET_BACKLOG(Sock, Value)  ((Sock)->BackLog = (Value))
 
#define GET_BACKLOG(Sock)  ((Sock)->BackLog)
 
#define SOCK_ERROR(Sock, Error)  ((Sock)->SockError = (Error))
 
#define SOCK_SIGNATURE  SIGNATURE_32 ('S', 'O', 'C', 'K')
 
#define SOCK_FROM_THIS(a)  CR ((a), SOCKET, NetProtocol, SOCK_SIGNATURE)
 
#define SOCK_FROM_TOKEN(Token)  (((SOCK_TOKEN *) (Token))->Sock)
 
#define PROTO_TOKEN_FORM_SOCK(SockToken, Type)  ((Type *) (((SOCK_TOKEN *) (SockToken))->Token))
 
typedef struct _TCP_SOCKET SOCKET;
 
typedef struct _SOCK_COMPLETION_TOKEN {
  EFI_EVENT     Event;          
  EFI_STATUS    Status;         
} SOCK_COMPLETION_TOKEN;
 
typedef union {
  VOID    *RxData;
  VOID    *TxData;
} SOCK_IO_DATA;
 
typedef struct _SOCK_IO_TOKEN {
  SOCK_COMPLETION_TOKEN    Token;
  SOCK_IO_DATA             Packet;
} SOCK_IO_TOKEN;
 
typedef enum {
  SockDgram, 
  SockStream 
} SOCK_TYPE;
 
typedef struct _SOCK_BUFFER {
  UINT32           HighWater;  
  UINT32           LowWater;   
  NET_BUF_QUEUE    *DataQueue; 
} SOCK_BUFFER;
 
typedef
EFI_STATUS
(*SOCK_PROTO_HANDLER) (
  IN SOCKET  *Socket,
  IN UINT8   Request,
  IN VOID    *RequestData
  );
 
typedef
EFI_STATUS
(*SOCK_CREATE_CALLBACK) (
  IN SOCKET  *This,
  IN VOID    *Context
  );
 
typedef
VOID
(*SOCK_DESTROY_CALLBACK) (
  IN SOCKET  *This,
  IN VOID    *Context
  );
 
typedef struct _SOCK_INIT_DATA {
  SOCK_TYPE                Type;
  UINT8                    State;
 
  SOCKET                   *Parent;       
  UINT32                   BackLog;       
  UINT32                   SndBufferSize; 
  UINT32                   RcvBufferSize; 
  UINT8                    IpVersion;
  VOID                     *Protocol;    
 
  //
  // Callbacks after socket is created and before socket is to be destroyed.
  //
  SOCK_CREATE_CALLBACK     CreateCallback;  
  SOCK_DESTROY_CALLBACK    DestroyCallback; 
  VOID                     *Context;        
 
  //
  // Opaque protocol data.
  //
  VOID                     *ProtoData;
  UINT32                   DataSize;
 
  SOCK_PROTO_HANDLER       ProtoHandler;  
 
  EFI_HANDLE               DriverBinding; 
} SOCK_INIT_DATA;
 
typedef union _NET_PROTOCOL {
  EFI_TCP4_PROTOCOL    Tcp4Protocol;      
  EFI_TCP6_PROTOCOL    Tcp6Protocol;      
} NET_PROTOCOL;
struct _TCP_SOCKET {
  //
  // Socket description information
  //
  UINT32                      Signature;     
  EFI_HANDLE                  SockHandle;    
  EFI_HANDLE                  DriverBinding; 
  EFI_DEVICE_PATH_PROTOCOL    *ParentDevicePath;
  EFI_DEVICE_PATH_PROTOCOL    *DevicePath;
  LIST_ENTRY                  Link;
  UINT8                       ConfigureState;
  SOCK_TYPE                   Type;
  UINT8                       State;
  UINT16                      Flag;
  EFI_LOCK                    Lock;         
  SOCK_BUFFER                 SndBuffer;    
  SOCK_BUFFER                 RcvBuffer;    
  EFI_STATUS                  SockError;    
  BOOLEAN                     InDestroy;
 
  //
  // Fields used to manage the connection request
  //
  UINT32                      BackLog;        
  UINT32                      ConnCnt;        
  SOCKET                      *Parent;        
  LIST_ENTRY                  ConnectionList; 
  //
  // The queue to buffer application's asynchronous token
  //
  LIST_ENTRY                  ListenTokenList;
  LIST_ENTRY                  RcvTokenList;
  LIST_ENTRY                  SndTokenList;
  LIST_ENTRY                  ProcessingSndTokenList;
 
  SOCK_COMPLETION_TOKEN       *ConnectionToken; 
  SOCK_COMPLETION_TOKEN       *CloseToken;      
  //
  // Interface for low level protocol
  //
  SOCK_PROTO_HANDLER          ProtoHandler;                      
  UINT8                       ProtoReserved[PROTO_RESERVED_LEN]; 
  UINT8                       IpVersion;
  NET_PROTOCOL                NetProtocol;                      
  //
  // Callbacks after socket is created and before socket is to be destroyed.
  //
  SOCK_CREATE_CALLBACK        CreateCallback;  
  SOCK_DESTROY_CALLBACK       DestroyCallback; 
  VOID                        *Context;        
};
 
typedef struct _SOCK_TOKEN {
  LIST_ENTRY               TokenList;     
  SOCK_COMPLETION_TOKEN    *Token;        
  UINT32                   RemainDataLen; 
  SOCKET                   *Sock;         
} SOCK_TOKEN;
 
typedef struct _TCP_RSV_DATA {
  UINT32    UrgLen;
} TCP_RSV_DATA;
 
//
// Socket provided operations for low layer protocol implemented in SockImpl.c
//
 
VOID
SockSetState (
  IN OUT SOCKET  *Sock,
  IN     UINT8   State
  );
 
SOCKET *
SockClone (
  IN SOCKET  *Sock
  );
 
VOID
SockConnEstablished (
  IN OUT SOCKET  *Sock
  );
 
VOID
SockConnClosed (
  IN OUT SOCKET  *Sock
  );
 
VOID
SockDataSent (
  IN OUT SOCKET  *Sock,
  IN     UINT32  Count
  );
 
UINT32
SockGetDataToSend (
  IN  SOCKET  *Sock,
  IN  UINT32  Offset,
  IN  UINT32  Len,
  OUT UINT8   *Dest
  );
 
VOID
SockDataRcvd (
  IN OUT SOCKET   *Sock,
  IN OUT NET_BUF  *NetBuffer,
  IN     UINT32   UrgLen
  );
 
UINT32
SockGetFreeSpace (
  IN SOCKET  *Sock,
  IN UINT32  Which
  );
 
VOID
SockNoMoreData (
  IN OUT SOCKET  *Sock
  );
 
//
// Socket provided operations for user interface implemented in SockInterface.c
//
 
SOCKET *
SockCreateChild (
  IN SOCK_INIT_DATA  *SockInitData
  );
 
EFI_STATUS
SockDestroyChild (
  IN OUT SOCKET  *Sock
  );
 
EFI_STATUS
SockConfigure (
  IN SOCKET  *Sock,
  IN VOID    *ConfigData
  );
 
EFI_STATUS
SockConnect (
  IN SOCKET  *Sock,
  IN VOID    *Token
  );
 
EFI_STATUS
SockAccept (
  IN SOCKET  *Sock,
  IN VOID    *Token
  );
 
EFI_STATUS
SockSend (
  IN SOCKET  *Sock,
  IN VOID    *Token
  );
 
EFI_STATUS
SockRcv (
  IN SOCKET  *Sock,
  IN VOID    *Token
  );
 
EFI_STATUS
SockFlush (
  IN OUT SOCKET  *Sock
  );
 
EFI_STATUS
SockClose (
  IN OUT SOCKET   *Sock,
  IN     VOID     *Token,
  IN     BOOLEAN  OnAbort
  );
 
EFI_STATUS
SockCancel (
  IN OUT SOCKET  *Sock,
  IN     VOID    *Token
  );
 
EFI_STATUS
SockGetMode (
  IN     SOCKET  *Sock,
  IN OUT VOID    *Mode
  );
 
EFI_STATUS
SockRoute (
  IN SOCKET  *Sock,
  IN VOID    *RouteInfo
  );
 
#endif