Merge branch 'vendor/DIFFUTILS'
[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 struct accept_filter;
60
61 /*
62  * Signaling socket buffers contain additional elements for locking
63  * and signaling conditions.  These are used primarily by sockets.
64  *
65  * WARNING: See partial clearing of fields in kern/uipc_socket.c
66  *          sorflush() and sowflush().
67  */
68 struct signalsockbuf {
69         struct sockbuf sb;
70         struct kqinfo ssb_kq;   /* process selecting read/write */
71         uint32_t ssb_flags;     /* flags, see below (use atomic ops) */
72         short   ssb_timeo;      /* timeout for read/write */
73         short   ssb_unused01;
74         long    ssb_lowat;      /* low water mark */
75         u_long  ssb_hiwat;      /* high water mark / max actual char count */
76         u_long  ssb_mbmax;      /* max chars of mbufs to use */
77         struct lwkt_token ssb_token; /* frontend/backend serializer */
78 };
79
80 #define ssb_cc          sb.sb_cc        /* commonly used fields */
81 #define ssb_mb          sb.sb_mb        /* commonly used fields */
82 #define ssb_mbcnt       sb.sb_mbcnt     /* commonly used fields */
83
84 #define SSB_LOCK        0x0001          /* lock on data queue */
85 #define SSB_WANT        0x0002          /* someone is waiting to lock */
86 #define SSB_WAIT        0x0004          /* someone is waiting for data/space */
87 #define SSB_ASYNC       0x0010          /* ASYNC I/O, need signals */
88 #define SSB_UPCALL      0x0020          /* someone wants an upcall */
89 #define SSB_NOINTR      0x0040          /* operations not interruptible */
90 /*#define SSB_AIO       0x0080*/        /* AIO operations queued */
91 #define SSB_KNOTE       0x0100          /* kernel note attached */
92 #define SSB_MEVENT      0x0200          /* need message event notification */
93 #define SSB_STOP        0x0400          /* backpressure indicator */
94 #define SSB_AUTOSIZE    0x0800          /* automatically size socket buffer */
95 #define SSB_AUTOLOWAT   0x1000          /* automatically scale lowat */
96 #define SSB_WAKEUP      0x2000          /* wakeup event race */
97
98 #define SSB_CLEAR_MASK  (SSB_ASYNC | SSB_UPCALL | SSB_STOP | \
99                          SSB_AUTOSIZE | SSB_AUTOLOWAT)
100
101 #define SSB_NOTIFY_MASK (SSB_WAIT | SSB_ASYNC | SSB_UPCALL | \
102                          SSB_KNOTE | SSB_MEVENT)
103
104 /*
105  * Per-socket kernel structure.  Contains universal send and receive queues,
106  * protocol control handle, and error information.
107  */
108 struct socket {
109         short   so_type;                /* generic type, see socket.h */
110         short   so_options;             /* from socket call, see socket.h */
111         short   so_linger;              /* time to linger while closing */
112         short   so_state;               /* internal state flags SS_*, below */
113         void    *so_pcb;                /* protocol control block */
114         struct  protosw *so_proto;      /* protocol handle */
115         struct  socket *so_head;        /* back pointer to accept socket */
116         lwkt_port_t so_port;            /* message port */
117
118         /*
119          * These fields are used to manage sockets capable of accepting
120          * new connections.
121          */
122         TAILQ_HEAD(, socket) so_incomp; /* in-progress, incomplete */
123         TAILQ_HEAD(, socket) so_comp;   /* completed but not yet accepted */
124         TAILQ_ENTRY(socket) so_list;    /* list of unaccepted connections */
125         short   so_qlen;                /* so_comp count */
126         short   so_incqlen;             /* so_incomp count */
127         short   so_qlimit;              /* max number queued connections */
128
129         /*
130          * Misc socket support
131          */
132         short   so_timeo;               /* connection timeout */
133         u_short so_error;               /* error affecting connection */
134         struct  sigio *so_sigio;        /* information for async I/O or
135                                            out of band data (SIGURG) */
136         u_long  so_oobmark;             /* chars to oob mark */
137         TAILQ_HEAD(, aiocblist) so_aiojobq; /* AIO ops waiting on socket */
138         struct signalsockbuf so_rcv;
139         struct signalsockbuf so_snd;
140
141         void    (*so_upcall) (struct socket *, void *, int);
142         void    *so_upcallarg;
143         struct  ucred *so_cred;         /* user credentials */
144         /* NB: generation count must not be first; easiest to make it last. */
145         void    *so_emuldata;           /* private data for emulators */
146         int     so_refs;                /* shutdown refs */
147         struct  so_accf { 
148                 struct  accept_filter *so_accept_filter;
149                 void    *so_accept_filter_arg;  /* saved filter args */
150                 char    *so_accept_filter_str;  /* saved user args */
151         } *so_accf;
152 };
153
154 #endif
155
156 /*
157  * Socket state bits.
158  *
159  * NOTE: The following states are interlocked with so_refs:
160  *
161  *      SS_NOFDREF      so_refs while not set
162  *      (so_pcb)        so_refs while set
163  */
164 #define SS_NOFDREF              0x0001  /* no file table ref any more */
165 #define SS_ISCONNECTED          0x0002  /* socket connected to a peer */
166 #define SS_ISCONNECTING         0x0004  /* in process of connecting to peer */
167 #define SS_ISDISCONNECTING      0x0008  /* in process of disconnecting */
168 #define SS_CANTSENDMORE         0x0010  /* can't send more data to peer */
169 #define SS_CANTRCVMORE          0x0020  /* can't receive more data from peer */
170 #define SS_RCVATMARK            0x0040  /* at mark on input */
171
172 #define SS_ASSERTINPROG         0x0100  /* sonewconn race debugging */
173 #define SS_ASYNC                0x0200  /* async i/o notify */
174 #define SS_ISCONFIRMING         0x0400  /* deciding to accept connection req */
175
176 #define SS_INCOMP               0x0800  /* unaccepted, incomplete connection */
177 #define SS_COMP                 0x1000  /* unaccepted, complete connection */
178 #define SS_ISDISCONNECTED       0x2000  /* socket disconnected from peer */
179
180 /*
181  * Externalized form of struct socket used by the sysctl(3) interface.
182  */
183 struct  xsocket {
184         size_t  xso_len;        /* length of this structure */
185         struct  socket *xso_so; /* makes a convenient handle sometimes */
186         short   so_type;
187         short   so_options;
188         short   so_linger;
189         short   so_state;
190         void    *so_pcb;                /* another convenient handle */
191         int     xso_protocol;
192         int     xso_family;
193         short   so_qlen;
194         short   so_incqlen;
195         short   so_qlimit;
196         short   so_timeo;
197         u_short so_error;
198         pid_t   so_pgid;
199         u_long  so_oobmark;
200         struct  xsockbuf {
201                 u_long  sb_cc;
202                 u_long  sb_hiwat;
203                 u_long  sb_mbcnt;
204                 u_long  sb_mbmax;
205                 long    sb_lowat;
206                 short   sb_flags;
207                 short   sb_timeo;
208         } so_rcv, so_snd;
209         uid_t   so_uid;         /* XXX */
210 };
211
212 /*
213  * Macros for sockets and socket buffering.
214  */
215
216 #define sosendallatonce(so) \
217     ((so)->so_proto->pr_flags & PR_ATOMIC)
218
219 /* can we read something from so? */
220 #define soreadable(so) \
221     ((so)->so_rcv.ssb_cc >= (so)->so_rcv.ssb_lowat || \
222         ((so)->so_state & SS_CANTRCVMORE) || \
223         !TAILQ_EMPTY(&(so)->so_comp) || (so)->so_error)
224
225 /* can we write something to so? */
226 #define sowriteable(so) \
227     ((ssb_space(&(so)->so_snd) >= (so)->so_snd.ssb_lowat && \
228         (((so)->so_state&SS_ISCONNECTED) || \
229           ((so)->so_proto->pr_flags&PR_CONNREQUIRED)==0)) || \
230      ((so)->so_state & SS_CANTSENDMORE) || \
231      (so)->so_error)
232
233 /*
234  * Do we need to notify the other side when I/O is possible?
235  *
236  * NOTE: Interlock for ssb_wait/wakeup.  The protocol side will set
237  *       SSB_WAKEUP asynchronously and this can race, so if it isn't
238  *       set we have to go through the full-on notification check.
239  *       If it is set but no waiting ever takes place it simply
240  *       remains set.
241  */
242 #define ssb_notify(ssb)                                 \
243             (((ssb)->ssb_flags & SSB_NOTIFY_MASK) ||    \
244              ((ssb)->ssb_flags & SSB_WAKEUP) == 0)
245
246 /* do we have to send all at once on a socket? */
247
248 #ifdef _KERNEL
249
250 /*
251  * How much space is there in a socket buffer (so->so_snd or so->so_rcv)?
252  * This is problematical if the fields are unsigned, as the space might
253  * still be negative (cc > hiwat or mbcnt > mbmax).  Should detect
254  * overflow and return 0.
255  *
256  * SSB_STOP ignores cc/hiwat and returns 0.  This is used by unix domain
257  * stream sockets to signal backpressure.
258  */
259 static __inline
260 long
261 ssb_space(struct signalsockbuf *ssb)
262 {
263         long bleft;
264         long mleft;
265
266         if (ssb->ssb_flags & SSB_STOP)
267                 return(0);
268         bleft = ssb->ssb_hiwat - ssb->ssb_cc;
269         mleft = ssb->ssb_mbmax - ssb->ssb_mbcnt;
270         return((bleft < mleft) ? bleft : mleft);
271 }
272
273 #endif
274
275 #define ssb_append(ssb, m)                                              \
276         sbappend(&(ssb)->sb, m)
277
278 #define ssb_appendstream(ssb, m)                                        \
279         sbappendstream(&(ssb)->sb, m)
280
281 #define ssb_appendrecord(ssb, m)                                        \
282         sbappendrecord(&(ssb)->sb, m)
283
284 #define ssb_appendaddr(ssb, src, m, control)                            \
285         ((ssb_space(ssb) <= 0) ? 0 : sbappendaddr(&(ssb)->sb, src, m, control))
286
287 #define ssb_appendcontrol(ssb, m, control)                              \
288         ((ssb_space(ssb) <= 0) ? 0 : sbappendcontrol(&(ssb)->sb, m, control))
289
290 #define ssb_insert_knote(ssb, kn) {                                     \
291         knote_insert(&(ssb)->ssb_kq.ki_note, kn);                       \
292         atomic_set_int(&(ssb)->ssb_flags, SSB_KNOTE);                   \
293 }
294
295 #define ssb_remove_knote(ssb, kn) {                                     \
296         knote_remove(&(ssb)->ssb_kq.ki_note, kn);                       \
297         if (SLIST_EMPTY(&(ssb)->ssb_kq.ki_note))                        \
298                 atomic_clear_int(&(ssb)->ssb_flags, SSB_KNOTE);         \
299 }
300
301 #define sorwakeup(so)                                           \
302         do {                                                    \
303                 if (ssb_notify(&(so)->so_rcv))                  \
304                         sowakeup((so), &(so)->so_rcv);          \
305         } while (0)
306
307 #define sowwakeup(so)                                           \
308         do {                                                    \
309                 if (ssb_notify(&(so)->so_snd))                  \
310                         sowakeup((so), &(so)->so_snd);          \
311         } while (0)
312
313 #ifdef _KERNEL
314
315 /*
316  * Argument structure for sosetopt et seq.  This is in the KERNEL
317  * section because it will never be visible to user code.
318  */
319 enum sopt_dir { SOPT_GET, SOPT_SET };
320 struct sockopt {
321         enum    sopt_dir sopt_dir; /* is this a get or a set? */
322         int     sopt_level;     /* second arg of [gs]etsockopt */
323         int     sopt_name;      /* third arg of [gs]etsockopt */
324         void   *sopt_val;       /* fourth arg of [gs]etsockopt */
325         size_t  sopt_valsize;   /* (almost) fifth arg of [gs]etsockopt */
326         struct  thread *sopt_td; /* calling thread or null if kernel */
327 };
328
329 struct accept_filter {
330         char    accf_name[16];
331         void    (*accf_callback)
332                 (struct socket *so, void *arg, int waitflag);
333         void *  (*accf_create)
334                 (struct socket *so, char *arg);
335         void    (*accf_destroy)
336                 (struct socket *so);
337         SLIST_ENTRY(accept_filter) accf_next;   /* next on the list */
338 };
339
340 #ifdef MALLOC_DECLARE
341 MALLOC_DECLARE(M_PCB);
342 MALLOC_DECLARE(M_SONAME);
343 MALLOC_DECLARE(M_ACCF);
344 #endif
345
346 extern int      maxsockets;
347 extern u_long   sb_max;         /* nominal limit */
348 extern u_long   sb_max_adj;     /* actual limit used by sbreserve() */
349
350 struct file;
351 struct filedesc;
352 struct mbuf;
353 struct rlimit;
354 struct sockaddr;
355 struct stat;
356 struct ucred;
357 struct uio;
358 struct knote;
359 struct sysmsg;
360
361 /*
362  * File operations on sockets.
363  */
364 int     soo_read (struct file *fp, struct uio *uio, struct ucred *cred,
365                         int flags);
366 int     soo_write (struct file *fp, struct uio *uio, struct ucred *cred,
367                         int flags);
368 int     soo_close (struct file *fp);
369 int     soo_shutdown (struct file *fp, int how);
370 int     soo_ioctl (struct file *fp, u_long cmd, caddr_t data,
371                         struct ucred *cred, struct sysmsg *msg);
372 int     soo_stat (struct file *fp, struct stat *ub, struct ucred *cred);
373 int     sokqfilter (struct file *fp, struct knote *kn);
374
375 /*
376  * From uipc_socket and friends
377  */
378 struct  sockaddr *dup_sockaddr (const struct sockaddr *sa);
379 int     getsockaddr (struct sockaddr **namp, caddr_t uaddr, size_t len);
380
381 void    ssb_release (struct signalsockbuf *ssb, struct socket *so);
382 int     ssb_reserve (struct signalsockbuf *ssb, u_long cc, struct socket *so,
383                    struct rlimit *rl);
384 void    ssbtoxsockbuf (struct signalsockbuf *sb, struct xsockbuf *xsb);
385 int     ssb_wait (struct signalsockbuf *sb);
386 int     _ssb_lock (struct signalsockbuf *sb);
387
388 void    soabort (struct socket *so);
389 void    soaborta (struct socket *so);
390 void    soabort_oncpu (struct socket *so);
391 int     soaccept (struct socket *so, struct sockaddr **nam);
392 struct  socket *soalloc (int waitok);
393 int     sobind (struct socket *so, struct sockaddr *nam, struct thread *td);
394 void    socantrcvmore (struct socket *so);
395 void    socantsendmore (struct socket *so);
396 int     socket_wait (struct socket *so, struct timespec *ts, int *res);
397 int     soclose (struct socket *so, int fflags);
398 int     soconnect (struct socket *so, struct sockaddr *nam, struct thread *td);
399 int     soconnect2 (struct socket *so1, struct socket *so2);
400 int     socreate (int dom, struct socket **aso, int type, int proto,
401             struct thread *td);
402 int     sodisconnect (struct socket *so);
403 void    sofree (struct socket *so);
404 int     sogetopt (struct socket *so, struct sockopt *sopt);
405 void    sohasoutofband (struct socket *so);
406 void    soisconnected (struct socket *so);
407 void    soisconnecting (struct socket *so);
408 void    soisdisconnected (struct socket *so);
409 void    soisdisconnecting (struct socket *so);
410 void    soisreconnected (struct socket *so);
411 void    soisreconnecting (struct socket *so);
412 void    sosetport (struct socket *so, struct lwkt_port *port);
413 int     solisten (struct socket *so, int backlog, struct thread *td);
414 struct socket *sonewconn (struct socket *head, int connstatus);
415 int     sooptcopyin (struct sockopt *sopt, void *buf, size_t len,
416                          size_t minlen);
417 int     soopt_to_kbuf (struct sockopt *sopt, void *buf, size_t len,
418                          size_t minlen);
419 int     sooptcopyout (struct sockopt *sopt, const void *buf, size_t len);
420 void    soopt_from_kbuf (struct sockopt *sopt, const void *buf, size_t len);
421
422 /* XXX; prepare mbuf for (__FreeBSD__ < 3) routines. */
423 int     soopt_getm (struct sockopt *sopt, struct mbuf **mp);
424 int     soopt_mcopyin (struct sockopt *sopt, struct mbuf *m);
425 void    soopt_to_mbuf (struct sockopt *sopt, struct mbuf *m);
426 int     soopt_mcopyout (struct sockopt *sopt, struct mbuf *m);
427 int     soopt_from_mbuf (struct sockopt *sopt, struct mbuf *m);
428
429 int     soreceive (struct socket *so, struct sockaddr **paddr,
430                        struct uio *uio, struct sockbuf *sio,
431                        struct mbuf **controlp, int *flagsp);
432 int     soreserve (struct socket *so, u_long sndcc, u_long rcvcc,
433                    struct rlimit *rl);
434 void    sorflush (struct socket *so);
435 int     sosend (struct socket *so, struct sockaddr *addr, struct uio *uio,
436                     struct mbuf *top, struct mbuf *control, int flags,
437                     struct thread *td);
438 int     sosendudp (struct socket *so, struct sockaddr *addr, struct uio *uio,
439                     struct mbuf *top, struct mbuf *control, int flags,
440                     struct thread *td);
441 int     sosetopt (struct socket *so, struct sockopt *sopt);
442 int     soshutdown (struct socket *so, int how);
443 void    sotoxsocket (struct socket *so, struct xsocket *xso);
444 void    sowakeup (struct socket *so, struct signalsockbuf *sb);
445
446 /* accept filter functions */
447 int     accept_filt_add (struct accept_filter *filt);
448 int     accept_filt_del (char *name);
449 struct accept_filter *  accept_filt_get (char *name);
450 #ifdef ACCEPT_FILTER_MOD
451 int accept_filt_generic_mod_event (module_t mod, int event, void *data);
452 SYSCTL_DECL(_net_inet_accf);
453 #endif /* ACCEPT_FILTER_MOD */
454
455 #endif /* _KERNEL */
456
457 #endif /* !_SYS_SOCKETVAR_H_ */