tcp: Implement asynchronized pru_rcvd
[dragonfly.git] / sys / sys / socketvar.h
1 /*-
2  * Copyright (c) 1982, 1986, 1990, 1993
3  *      The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *      This product includes software developed by the University of
16  *      California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *      @(#)socketvar.h 8.3 (Berkeley) 2/19/95
34  * $FreeBSD: src/sys/sys/socketvar.h,v 1.46.2.10 2003/08/24 08:24:39 hsu Exp $
35  * $DragonFly: src/sys/sys/socketvar.h,v 1.35 2008/08/28 23:15:45 dillon Exp $
36  */
37
38 #ifndef _SYS_SOCKETVAR_H_
39 #define _SYS_SOCKETVAR_H_
40
41 #ifndef _SYS_TYPES_H_
42 #include <sys/types.h>
43 #endif
44 #ifndef _SYS_QUEUE_H_
45 #include <sys/queue.h>                  /* for TAILQ macros */
46 #endif
47 #ifndef _SYS_EVENT_H_
48 #include <sys/event.h>                  /* for struct kqinfo */
49 #endif
50 #ifndef _SYS_THREAD_H_
51 #include <sys/thread.h>                 /* for struct lwkt_token */
52 #endif
53 #ifndef _SYS_SOCKBUF_H_
54 #include <sys/sockbuf.h>
55 #endif
56
57 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
58
59 #ifndef _NET_NETMSG_H_
60 #include <net/netmsg.h>
61 #endif
62
63 #ifndef _SYS_SPINLOCK_H_
64 #include <sys/spinlock.h>
65 #endif
66
67 struct accept_filter;
68
69 /*
70  * Signaling socket buffers contain additional elements for locking
71  * and signaling conditions.  These are used primarily by sockets.
72  *
73  * WARNING: See partial clearing of fields in kern/uipc_socket.c
74  *          sorflush() and sowflush().
75  */
76 struct signalsockbuf {
77         struct sockbuf sb;
78         struct kqinfo ssb_kq;   /* process selecting read/write */
79         uint32_t ssb_flags;     /* flags, see below (use atomic ops) */
80         u_int   ssb_timeo;      /* timeout for read/write */
81         long    ssb_lowat;      /* low water mark */
82         u_long  ssb_hiwat;      /* high water mark / max actual char count */
83         u_long  ssb_mbmax;      /* max chars of mbufs to use */
84         struct lwkt_token ssb_token; /* frontend/backend serializer */
85 };
86
87 #define ssb_cc          sb.sb_cc        /* commonly used fields */
88 #define ssb_mb          sb.sb_mb        /* commonly used fields */
89 #define ssb_mbcnt       sb.sb_mbcnt     /* commonly used fields */
90 #define ssb_cc_prealloc sb.sb_cc_prealloc
91 #define ssb_mbcnt_prealloc sb.sb_mbcnt_prealloc
92
93 #define SSB_LOCK        0x0001          /* lock on data queue */
94 #define SSB_WANT        0x0002          /* someone is waiting to lock */
95 #define SSB_WAIT        0x0004          /* someone is waiting for data/space */
96 #define SSB_ASYNC       0x0010          /* ASYNC I/O, need signals */
97 #define SSB_UPCALL      0x0020          /* someone wants an upcall */
98 #define SSB_NOINTR      0x0040          /* operations not interruptible */
99 /*#define SSB_AIO       0x0080*/        /* AIO operations queued */
100 #define SSB_KNOTE       0x0100          /* kernel note attached */
101 #define SSB_MEVENT      0x0200          /* need message event notification */
102 #define SSB_STOP        0x0400          /* backpressure indicator */
103 #define SSB_AUTOSIZE    0x0800          /* automatically size socket buffer */
104 #define SSB_AUTOLOWAT   0x1000          /* automatically scale lowat */
105 #define SSB_WAKEUP      0x2000          /* wakeup event race */
106
107 #define SSB_CLEAR_MASK  (SSB_ASYNC | SSB_UPCALL | SSB_STOP | \
108                          SSB_AUTOSIZE | SSB_AUTOLOWAT)
109
110 #define SSB_NOTIFY_MASK (SSB_WAIT | SSB_ASYNC | SSB_UPCALL | \
111                          SSB_KNOTE | SSB_MEVENT)
112
113 /*
114  * Per-socket kernel structure.  Contains universal send and receive queues,
115  * protocol control handle, and error information.
116  */
117 struct socket {
118         short   so_type;                /* generic type, see socket.h */
119         short   so_options;             /* from socket call, see socket.h */
120         short   so_linger;              /* time to linger while closing */
121         short   so_state;               /* internal state flags SS_*, below */
122         void    *so_pcb;                /* protocol control block */
123         struct  protosw *so_proto;      /* protocol handle */
124         struct  socket *so_head;        /* back pointer to accept socket */
125         lwkt_port_t so_port;            /* message port */
126
127         /*
128          * These fields are used to manage sockets capable of accepting
129          * new connections.
130          */
131         TAILQ_HEAD(, socket) so_incomp; /* in-progress, incomplete */
132         TAILQ_HEAD(, socket) so_comp;   /* completed but not yet accepted */
133         TAILQ_ENTRY(socket) so_list;    /* list of unaccepted connections */
134         short   so_qlen;                /* so_comp count */
135         short   so_incqlen;             /* so_incomp count */
136         short   so_qlimit;              /* max number queued connections */
137
138         /*
139          * Misc socket support
140          */
141         short   so_timeo;               /* connection timeout */
142         u_short so_error;               /* error affecting connection */
143         struct  sigio *so_sigio;        /* information for async I/O or
144                                            out of band data (SIGURG) */
145         u_long  so_oobmark;             /* chars to oob mark */
146         TAILQ_HEAD(, aiocblist) so_aiojobq; /* AIO ops waiting on socket */
147         struct signalsockbuf so_rcv;
148         struct signalsockbuf so_snd;
149
150         void    (*so_upcall) (struct socket *, void *, int);
151         void    *so_upcallarg;
152         struct  ucred *so_cred;         /* user credentials */
153         /* NB: generation count must not be first; easiest to make it last. */
154         void    *so_emuldata;           /* private data for emulators */
155         int     so_refs;                /* shutdown refs */
156         struct  so_accf { 
157                 struct  accept_filter *so_accept_filter;
158                 void    *so_accept_filter_arg;  /* saved filter args */
159                 char    *so_accept_filter_str;  /* saved user args */
160         } *so_accf;
161
162         struct netmsg_base so_clomsg;
163         struct sockaddr *so_faddr;
164
165         struct spinlock so_rcvd_spin;
166         struct netmsg_pru_rcvd so_rcvd_msg;
167 };
168
169 #endif
170
171 /*
172  * Socket state bits.
173  *
174  * NOTE: The following states are interlocked with so_refs:
175  *
176  *      SS_NOFDREF      so_refs while not set
177  *      (so_pcb)        so_refs while set
178  */
179 #define SS_NOFDREF              0x0001  /* no file table ref any more */
180 #define SS_ISCONNECTED          0x0002  /* socket connected to a peer */
181 #define SS_ISCONNECTING         0x0004  /* in process of connecting to peer */
182 #define SS_ISDISCONNECTING      0x0008  /* in process of disconnecting */
183 #define SS_CANTSENDMORE         0x0010  /* can't send more data to peer */
184 #define SS_CANTRCVMORE          0x0020  /* can't receive more data from peer */
185 #define SS_RCVATMARK            0x0040  /* at mark on input */
186
187 #define SS_ASSERTINPROG         0x0100  /* sonewconn race debugging */
188 #define SS_ASYNC                0x0200  /* async i/o notify */
189 #define SS_ISCONFIRMING         0x0400  /* deciding to accept connection req */
190
191 #define SS_INCOMP               0x0800  /* unaccepted, incomplete connection */
192 #define SS_COMP                 0x1000  /* unaccepted, complete connection */
193 #define SS_ISDISCONNECTED       0x2000  /* socket disconnected from peer */
194
195 /*
196  * Externalized form of struct socket used by the sysctl(3) interface.
197  */
198 struct  xsocket {
199         size_t  xso_len;        /* length of this structure */
200         struct  socket *xso_so; /* makes a convenient handle sometimes */
201         short   so_type;
202         short   so_options;
203         short   so_linger;
204         short   so_state;
205         void    *so_pcb;                /* another convenient handle */
206         int     xso_protocol;
207         int     xso_family;
208         short   so_qlen;
209         short   so_incqlen;
210         short   so_qlimit;
211         short   so_timeo;
212         u_short so_error;
213         pid_t   so_pgid;
214         u_long  so_oobmark;
215         struct  xsockbuf {
216                 u_long  sb_cc;
217                 u_long  sb_hiwat;
218                 u_long  sb_mbcnt;
219                 u_long  sb_mbmax;
220                 long    sb_lowat;
221                 u_int   sb_timeo;
222                 short   sb_flags;
223         } so_rcv, so_snd;
224         uid_t   so_uid;         /* XXX */
225 };
226
227 /*
228  * Macros for sockets and socket buffering.
229  */
230
231 #define sosendallatonce(so) \
232     ((so)->so_proto->pr_flags & PR_ATOMIC)
233
234 /* can we read something from so? */
235 #define soreadable(so) \
236     ((so)->so_rcv.ssb_cc >= (so)->so_rcv.ssb_lowat || \
237         ((so)->so_state & SS_CANTRCVMORE) || \
238         !TAILQ_EMPTY(&(so)->so_comp) || (so)->so_error)
239
240 /* can we write something to so? */
241 #define sowriteable(so) \
242     ((ssb_space(&(so)->so_snd) >= (so)->so_snd.ssb_lowat && \
243         (((so)->so_state&SS_ISCONNECTED) || \
244           ((so)->so_proto->pr_flags&PR_CONNREQUIRED)==0)) || \
245      ((so)->so_state & SS_CANTSENDMORE) || \
246      (so)->so_error)
247
248 /*
249  * Do we need to notify the other side when I/O is possible?
250  *
251  * NOTE: Interlock for ssb_wait/wakeup.  The protocol side will set
252  *       SSB_WAKEUP asynchronously and this can race, so if it isn't
253  *       set we have to go through the full-on notification check.
254  *       If it is set but no waiting ever takes place it simply
255  *       remains set.
256  */
257 #define ssb_notify(ssb)                                 \
258             (((ssb)->ssb_flags & SSB_NOTIFY_MASK) ||    \
259              ((ssb)->ssb_flags & SSB_WAKEUP) == 0)
260
261 /* do we have to send all at once on a socket? */
262
263 #ifdef _KERNEL
264
265 /*
266  * How much space is there in a socket buffer (so->so_snd or so->so_rcv)?
267  * This is problematical if the fields are unsigned, as the space might
268  * still be negative (cc > hiwat or mbcnt > mbmax).  Should detect
269  * overflow and return 0.
270  *
271  * SSB_STOP ignores cc/hiwat and returns 0.  This is used by unix domain
272  * stream sockets to signal backpressure.
273  */
274 static __inline
275 long
276 ssb_space(struct signalsockbuf *ssb)
277 {
278         long bleft;
279         long mleft;
280
281         if (ssb->ssb_flags & SSB_STOP)
282                 return(0);
283         bleft = ssb->ssb_hiwat - ssb->ssb_cc;
284         mleft = ssb->ssb_mbmax - ssb->ssb_mbcnt;
285         return((bleft < mleft) ? bleft : mleft);
286 }
287
288 static __inline long
289 ssb_space_prealloc(struct signalsockbuf *ssb)
290 {
291         long bleft, bleft_prealloc;
292         long mleft, mleft_prealloc;
293
294         if (ssb->ssb_flags & SSB_STOP)
295                 return(0);
296
297         bleft = ssb->ssb_hiwat - ssb->ssb_cc;
298         bleft_prealloc = ssb->ssb_hiwat - ssb->ssb_cc_prealloc;
299         if (bleft_prealloc < bleft)
300                 bleft = bleft_prealloc;
301
302         mleft = ssb->ssb_mbmax - ssb->ssb_mbcnt;
303         mleft_prealloc = ssb->ssb_mbmax - ssb->ssb_mbcnt_prealloc;
304         if (mleft_prealloc < mleft)
305                 mleft = mleft_prealloc;
306
307         return((bleft < mleft) ? bleft : mleft);
308 }
309
310 /*
311  * NOTE: Only works w/ later ssb_appendstream() on m
312  */
313 static __inline void
314 ssb_preallocstream(struct signalsockbuf *ssb, struct mbuf *m)
315 {
316         if (m->m_len == 0)
317                 return;
318         sbprealloc(&ssb->sb, m);
319 }
320
321 #endif
322
323 #define ssb_append(ssb, m)                                              \
324         sbappend(&(ssb)->sb, m)
325
326 #define ssb_appendstream(ssb, m)                                        \
327         sbappendstream(&(ssb)->sb, m)
328
329 #define ssb_appendrecord(ssb, m)                                        \
330         sbappendrecord(&(ssb)->sb, m)
331
332 #define ssb_appendaddr(ssb, src, m, control)                            \
333         ((ssb_space(ssb) <= 0) ? 0 : sbappendaddr(&(ssb)->sb, src, m, control))
334
335 #define ssb_appendcontrol(ssb, m, control)                              \
336         ((ssb_space(ssb) <= 0) ? 0 : sbappendcontrol(&(ssb)->sb, m, control))
337
338 #define ssb_insert_knote(ssb, kn) {                                     \
339         knote_insert(&(ssb)->ssb_kq.ki_note, kn);                       \
340         atomic_set_int(&(ssb)->ssb_flags, SSB_KNOTE);                   \
341 }
342
343 #define ssb_remove_knote(ssb, kn) {                                     \
344         knote_remove(&(ssb)->ssb_kq.ki_note, kn);                       \
345         if (SLIST_EMPTY(&(ssb)->ssb_kq.ki_note))                        \
346                 atomic_clear_int(&(ssb)->ssb_flags, SSB_KNOTE);         \
347 }
348
349 #define sorwakeup(so)                                           \
350         do {                                                    \
351                 if (ssb_notify(&(so)->so_rcv))                  \
352                         sowakeup((so), &(so)->so_rcv);          \
353         } while (0)
354
355 #define sowwakeup(so)                                           \
356         do {                                                    \
357                 if (ssb_notify(&(so)->so_snd))                  \
358                         sowakeup((so), &(so)->so_snd);          \
359         } while (0)
360
361 #ifdef _KERNEL
362
363 /*
364  * Argument structure for sosetopt et seq.  This is in the KERNEL
365  * section because it will never be visible to user code.
366  */
367 enum sopt_dir { SOPT_GET, SOPT_SET };
368 struct sockopt {
369         enum    sopt_dir sopt_dir; /* is this a get or a set? */
370         int     sopt_level;     /* second arg of [gs]etsockopt */
371         int     sopt_name;      /* third arg of [gs]etsockopt */
372         void   *sopt_val;       /* fourth arg of [gs]etsockopt */
373         size_t  sopt_valsize;   /* (almost) fifth arg of [gs]etsockopt */
374         struct  thread *sopt_td; /* calling thread or null if kernel */
375 };
376
377 struct accept_filter {
378         char    accf_name[16];
379         void    (*accf_callback)
380                 (struct socket *so, void *arg, int waitflag);
381         void *  (*accf_create)
382                 (struct socket *so, char *arg);
383         void    (*accf_destroy)
384                 (struct socket *so);
385         SLIST_ENTRY(accept_filter) accf_next;   /* next on the list */
386 };
387
388 #ifdef MALLOC_DECLARE
389 MALLOC_DECLARE(M_PCB);
390 MALLOC_DECLARE(M_SONAME);
391 MALLOC_DECLARE(M_ACCF);
392 #endif
393
394 extern int      maxsockets;
395 extern u_long   sb_max;         /* nominal limit */
396 extern u_long   sb_max_adj;     /* actual limit used by sbreserve() */
397
398 struct file;
399 struct filedesc;
400 struct mbuf;
401 struct rlimit;
402 struct sockaddr;
403 struct stat;
404 struct ucred;
405 struct uio;
406 struct knote;
407 struct sysmsg;
408
409 /*
410  * File operations on sockets.
411  */
412 int     soo_read (struct file *fp, struct uio *uio, struct ucred *cred,
413                         int flags);
414 int     soo_write (struct file *fp, struct uio *uio, struct ucred *cred,
415                         int flags);
416 int     soo_close (struct file *fp);
417 int     soo_shutdown (struct file *fp, int how);
418 int     soo_ioctl (struct file *fp, u_long cmd, caddr_t data,
419                         struct ucred *cred, struct sysmsg *msg);
420 int     soo_stat (struct file *fp, struct stat *ub, struct ucred *cred);
421 int     sokqfilter (struct file *fp, struct knote *kn);
422
423 /*
424  * From uipc_socket and friends
425  */
426 struct  sockaddr *dup_sockaddr (const struct sockaddr *sa);
427 int     getsockaddr (struct sockaddr **namp, caddr_t uaddr, size_t len);
428
429 void    ssb_release (struct signalsockbuf *ssb, struct socket *so);
430 int     ssb_reserve (struct signalsockbuf *ssb, u_long cc, struct socket *so,
431                    struct rlimit *rl);
432 void    ssbtoxsockbuf (struct signalsockbuf *sb, struct xsockbuf *xsb);
433 int     ssb_wait (struct signalsockbuf *sb);
434 int     _ssb_lock (struct signalsockbuf *sb);
435
436 void    soabort (struct socket *so);
437 void    soaborta (struct socket *so);
438 void    soabort_oncpu (struct socket *so);
439 int     soaccept (struct socket *so, struct sockaddr **nam);
440 void    soaccept_generic (struct socket *so);
441 struct  socket *soalloc (int waitok, struct protosw *);
442 int     sobind (struct socket *so, struct sockaddr *nam, struct thread *td);
443 void    socantrcvmore (struct socket *so);
444 void    socantsendmore (struct socket *so);
445 int     socket_wait (struct socket *so, struct timespec *ts, int *res);
446 int     soclose (struct socket *so, int fflags);
447 int     soconnect (struct socket *so, struct sockaddr *nam, struct thread *td);
448 int     soconnect2 (struct socket *so1, struct socket *so2);
449 int     socreate (int dom, struct socket **aso, int type, int proto,
450             struct thread *td);
451 int     sodisconnect (struct socket *so);
452 void    sofree (struct socket *so);
453 int     sogetopt (struct socket *so, struct sockopt *sopt);
454 void    sohasoutofband (struct socket *so);
455 void    soisconnected (struct socket *so);
456 void    soisconnecting (struct socket *so);
457 void    soisdisconnected (struct socket *so);
458 void    soisdisconnecting (struct socket *so);
459 void    soisreconnected (struct socket *so);
460 void    soisreconnecting (struct socket *so);
461 void    sosetport (struct socket *so, struct lwkt_port *port);
462 int     solisten (struct socket *so, int backlog, struct thread *td);
463 struct socket *sonewconn (struct socket *head, int connstatus);
464 struct socket *sonewconn_faddr (struct socket *head, int connstatus,
465             const struct sockaddr *faddr);
466 int     sooptcopyin (struct sockopt *sopt, void *buf, size_t len,
467                          size_t minlen);
468 int     soopt_to_kbuf (struct sockopt *sopt, void *buf, size_t len,
469                          size_t minlen);
470 int     sooptcopyout (struct sockopt *sopt, const void *buf, size_t len);
471 void    soopt_from_kbuf (struct sockopt *sopt, const void *buf, size_t len);
472
473 /* XXX; prepare mbuf for (__FreeBSD__ < 3) routines. */
474 int     soopt_getm (struct sockopt *sopt, struct mbuf **mp);
475 int     soopt_mcopyin (struct sockopt *sopt, struct mbuf *m);
476 void    soopt_to_mbuf (struct sockopt *sopt, struct mbuf *m);
477 int     soopt_mcopyout (struct sockopt *sopt, struct mbuf *m);
478 int     soopt_from_mbuf (struct sockopt *sopt, struct mbuf *m);
479
480 int     soreceive (struct socket *so, struct sockaddr **paddr,
481                        struct uio *uio, struct sockbuf *sio,
482                        struct mbuf **controlp, int *flagsp);
483 int     sorecvtcp (struct socket *so, struct sockaddr **paddr,
484                        struct uio *uio, struct sockbuf *sio,
485                        struct mbuf **controlp, int *flagsp);
486 int     soreserve (struct socket *so, u_long sndcc, u_long rcvcc,
487                    struct rlimit *rl);
488 void    sorflush (struct socket *so);
489 int     sosend (struct socket *so, struct sockaddr *addr, struct uio *uio,
490                     struct mbuf *top, struct mbuf *control, int flags,
491                     struct thread *td);
492 int     sosendudp (struct socket *so, struct sockaddr *addr, struct uio *uio,
493                     struct mbuf *top, struct mbuf *control, int flags,
494                     struct thread *td);
495 int     sosendtcp (struct socket *so, struct sockaddr *addr, struct uio *uio,
496                     struct mbuf *top, struct mbuf *control, int flags,
497                     struct thread *td);
498 int     sosetopt (struct socket *so, struct sockopt *sopt);
499 int     soshutdown (struct socket *so, int how);
500 void    sotoxsocket (struct socket *so, struct xsocket *xso);
501 void    sowakeup (struct socket *so, struct signalsockbuf *sb);
502
503 /* accept filter functions */
504 int     accept_filt_add (struct accept_filter *filt);
505 int     accept_filt_del (char *name);
506 struct accept_filter *  accept_filt_get (char *name);
507 #ifdef ACCEPT_FILTER_MOD
508 int accept_filt_generic_mod_event (module_t mod, int event, void *data);
509 SYSCTL_DECL(_net_inet_accf);
510 #endif /* ACCEPT_FILTER_MOD */
511
512 #endif /* _KERNEL */
513
514 #endif /* !_SYS_SOCKETVAR_H_ */