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