Basic socket stubs and functionalities.
[akaros.git] / kern / include / socket.h
1 #ifndef ROS_SOCKET_H
2 #define ROS_SOCKET_H
3
4 #include <ros/common.h>
5 #include <sys/queue.h>
6 #include <atomic.h>
7 #include <net/pbuf.h>
8 #include <kthread.h>
9 #include <net/ip.h>
10 #include <vfs.h>
11 // Just a couple of AF types that we might support
12 #define AF_UNSPEC       0
13 #define AF_UNIX         1       /* Unix domain sockets          */
14 #define AF_LOCAL        1       /* POSIX name for AF_UNIX       */
15 #define AF_INET         2       /* Internet IP Protocol         */
16
17 #define PF_UNSPEC       AF_UNSPEC
18 #define PF_UNIX         AF_UNIX
19 #define PF_LOCAL        AF_LOCAL
20 #define PF_INET         AF_INET
21
22 #define SS_NOFDREF              0x0001  /* no file table ref any more */
23 #define SS_ISCONNECTED          0x0002  /* socket connected to a peer */
24 #define SS_ISCONNECTING         0x0004  /* in process of connecting to peer */
25 #define SS_ISDISCONNECTING      0x0008  /* in process of disconnecting */
26 #define SS_NBIO                 0x0100  /* non-blocking ops */
27 #define SS_ASYNC                0x0200  /* async i/o notify */
28 #define SS_ISCONFIRMING         0x0400  /* deciding to accept connection req */
29 #define SS_ISDISCONNECTED       0x2000  /* socket disconnected from peer */
30
31 /* Define an range for automatic port assignment */
32 #define SOCKET_PORT_START 4096
33 #define SOCKET_PORT_END  0x7fff
34
35 struct socket;
36 struct proc;
37 // These are probably defined elsewhere too..
38 #ifndef socklen_t
39 typedef int socklen_t;
40 typedef int sa_family_t;
41 #endif
42 #define inet_addr_to_ipaddr_p(target_ipaddr_p, source_inaddr)   ((target_ipaddr_p) = (ip_addr_t*)&((source_inaddr)->s_addr))
43 enum sock_type {
44     SOCK_STREAM = 1,
45     SOCK_DGRAM  = 2,
46     SOCK_RAW    = 3,
47     SOCK_RDM    = 4,
48     SOCK_SEQPACKET  = 5,
49     SOCK_DCCP   = 6,
50     SOCK_PACKET = 10,
51 };
52
53 struct socket{
54   //int so_count;       /* (b) reference count */
55   short   so_type;        /* (a) generic type, see socket.h */
56         short   so_family;
57         int     so_protocol;
58   short   so_options;     /* from socket call, see socket.h */
59   //short   so_linger;      /* time to linger while closing */
60   short   so_state;       /* (b) internal state flags SS_* */
61         //int so_qstate;      /* (e) internal state flags SQ_* */
62         void    *so_pcb;        /* protocol control block */
63         struct pbuf_head recv_buff;
64         struct pbuf_head send_buff;
65         struct semaphore sem;
66         spinlock_t waiter_lock;
67         struct semaphore_list waiters;   /* semaphone to for a process to sleep on */
68         
69         //struct  vnet *so_vnet;      /* network stack instance */
70         //struct  protosw *so_proto;  /* (a) protocol handle */
71 };
72
73
74 /* members are in network byte order */
75 struct sockaddr_in {
76     // uint8_t sin_len; -- bsd only field
77     uint8_t sin_family;
78     uint16_t sin_port;
79     struct in_addr sin_addr;
80     char sin_zero[8];
81 };
82
83
84 struct sockaddr {
85         unsigned char   sa_len;         /* bsd only total length */
86         sa_family_t     sa_family;      /* address family */
87         char            sa_data[14];    /* actually longer; address value */
88 };
89
90 /*
91  * Message header for recvmsg and sendmsg calls.
92  * Used value-result for recvmsg, value only for sendmsg.
93  */ 
94 struct msghdr {
95     void        *msg_name;      /* optional address */
96     socklen_t    msg_namelen;       /* size of address */
97     struct iovec    *msg_iov;       /* scatter/gather array */
98     int      msg_iovlen;        /* # elements in msg_iov */
99     void        *msg_control;       /* ancillary data, see below */
100     socklen_t    msg_controllen;    /* ancillary data buffer len */
101     int      msg_flags;     /* flags on received message */
102 };
103
104
105 /* Socket-level options for `getsockopt' and `setsockopt'.  */
106 enum
107   {
108     SO_DEBUG = 0x0001,          /* Record debugging information.  */
109 #define SO_DEBUG SO_DEBUG
110     SO_ACCEPTCONN = 0x0002,     /* Accept connections on socket.  */
111 #define SO_ACCEPTCONN SO_ACCEPTCONN
112     SO_REUSEADDR = 0x0004,      /* Allow reuse of local addresses.  */
113 #define SO_REUSEADDR SO_REUSEADDR
114     SO_KEEPALIVE = 0x0008,      /* Keep connections alive and send
115                                    SIGPIPE when they die.  */
116 #define SO_KEEPALIVE SO_KEEPALIVE
117     SO_DONTROUTE = 0x0010,      /* Don't do local routing.  */
118 #define SO_DONTROUTE SO_DONTROUTE
119     SO_BROADCAST = 0x0020,      /* Allow transmission of
120                                    broadcast messages.  */
121 #define SO_BROADCAST SO_BROADCAST
122     SO_USELOOPBACK = 0x0040,    /* Use the software loopback to avoid
123                                    hardware use when possible.  */
124 #define SO_USELOOPBACK SO_USELOOPBACK
125     SO_LINGER = 0x0080,         /* Block on close of a reliable
126                                    socket to transmit pending data.  */
127 #define SO_LINGER SO_LINGER
128     SO_OOBINLINE = 0x0100,      /* Receive out-of-band data in-band.  */
129 #define SO_OOBINLINE SO_OOBINLINE
130     SO_REUSEPORT = 0x0200,      /* Allow local address and port reuse.  */
131 #define SO_REUSEPORT SO_REUSEPORT
132     SO_SNDBUF = 0x1001,         /* Send buffer size.  */
133 #define SO_SNDBUF SO_SNDBUF
134     SO_RCVBUF = 0x1002,         /* Receive buffer.  */
135 #define SO_RCVBUF SO_RCVBUF
136     SO_SNDLOWAT = 0x1003,       /* Send low-water mark.  */
137 #define SO_SNDLOWAT SO_SNDLOWAT
138     SO_RCVLOWAT = 0x1004,       /* Receive low-water mark.  */
139 #define SO_RCVLOWAT SO_RCVLOWAT
140     SO_SNDTIMEO = 0x1005,       /* Send timeout.  */
141 #define SO_SNDTIMEO SO_SNDTIMEO
142     SO_RCVTIMEO = 0x1006,       /* Receive timeout.  */
143 #define SO_RCVTIMEO SO_RCVTIMEO
144     SO_ERROR = 0x1007,          /* Get and clear error status.  */
145 #define SO_ERROR SO_ERROR
146     SO_STYLE = 0x1008,          /* Get socket connection style.  */
147 #define SO_STYLE SO_STYLE
148     SO_TYPE = SO_STYLE          /* Compatible name for SO_STYLE.  */
149 #define SO_TYPE SO_TYPE
150   };
151 #define SO_INHERITED   (SO_REUSEADDR|SO_KEEPALIVE|SO_LINGER)
152
153 extern struct kmem_cache *sock_kcache;
154 extern struct kmem_cache *mbuf_kcache;
155 extern struct kmem_cache *udp_pcb_kcache;
156 extern struct kmem_cache *tcp_pcb_kcache;
157 extern struct kmem_cache *tcp_pcb_listen_kcache;
158 extern struct kmem_cache *tcp_segment_kcache;
159
160
161 void socket_init();
162 intreg_t send_iov(struct socket* sock, struct iovec* iov, int flags);
163 int send_datagram(struct socket* sock, struct iovec* iov, int flags);
164
165 intreg_t sys_socket(struct proc *p, int socket_family, int socket_type, int protocol);
166 intreg_t sys_sendto(struct proc *p, int socket, const void *buffer, size_t length, int flags, const struct sockaddr *dest_addr, socklen_t dest_len);
167 intreg_t sys_recvfrom(struct proc *p, int socket, void *restrict buffer, size_t length, int flags, struct sockaddr *restrict address, socklen_t *restrict address_len);
168 intreg_t sys_select(struct proc *p, int nfds, fd_set *readfds, fd_set *writefds,
169                                 fd_set *exceptfds, struct timeval *timeout);
170 intreg_t sys_connect(struct proc *p, int sockfd, const struct sockaddr *addr, socklen_t addrlen);
171 intreg_t sys_send(struct proc *p, int sockfd, const void *buf, size_t len, int flags);
172 intreg_t sys_recv(struct proc *p, int sockfd, void *buf, size_t len, int flags);
173 intreg_t sys_bind(struct proc* p, int sockfd, const struct sockaddr *addr, socklen_t addrlen);
174 intreg_t sys_accept(struct proc *p, int sockfd, struct sockaddr *addr, socklen_t *addrlen);
175 intreg_t sys_listen(struct proc *p, int sockfd, int backlog);
176
177
178 #endif /* ROS_SOCKET_H */
179