Remove so_gencnt and so_gen_t. The generation counter is not used any more.
[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.23 2006/05/20 17:41:42 dillon Exp $
36  */
37
38 #ifndef _SYS_SOCKETVAR_H_
39 #define _SYS_SOCKETVAR_H_
40
41 #include <sys/queue.h>                  /* for TAILQ macros */
42 #include <sys/select.h>                 /* for struct selinfo */
43
44 /*
45  * Kernel structure per socket.
46  * Contains send and receive buffer queues,
47  * handle on protocol and pointer to protocol
48  * private data and error information.
49  */
50
51 struct accept_filter;
52
53 struct socket {
54         short   so_type;                /* generic type, see socket.h */
55         short   so_options;             /* from socket call, see socket.h */
56         short   so_linger;              /* time to linger while closing */
57         short   so_state;               /* internal state flags SS_*, below */
58         void    *so_pcb;                /* protocol control block */
59         struct  protosw *so_proto;      /* protocol handle */
60 /*
61  * Variables for connection queuing.
62  * Socket where accepts occur is so_head in all subsidiary sockets.
63  * If so_head is 0, socket is not related to an accept.
64  * For head socket so_incomp queues partially completed connections,
65  * while so_comp is a queue of connections ready to be accepted.
66  * If a connection is aborted and it has so_head set, then
67  * it has to be pulled out of either so_incomp or so_comp.
68  * We allow connections to queue up based on current queue lengths
69  * and limit on number of queued connections for this socket.
70  */
71         struct  socket *so_head;        /* back pointer to accept socket */
72         TAILQ_HEAD(, socket) so_incomp; /* queue of partial unaccepted connections */
73         TAILQ_HEAD(, socket) so_comp;   /* queue of complete unaccepted connections */
74         TAILQ_ENTRY(socket) so_list;    /* list of unaccepted connections */
75         short   so_qlen;                /* number of unaccepted connections */
76         short   so_incqlen;             /* number of unaccepted incomplete
77                                            connections */
78         short   so_qlimit;              /* max number queued connections */
79         short   so_timeo;               /* connection timeout */
80         u_short so_error;               /* error affecting connection */
81         struct  sigio *so_sigio;        /* information for async I/O or
82                                            out of band data (SIGURG) */
83         u_long  so_oobmark;             /* chars to oob mark */
84         TAILQ_HEAD(, aiocblist) so_aiojobq; /* AIO ops waiting on socket */
85 /*
86  * Variables for socket buffering.
87  */
88         struct  sockbuf {
89                 u_long  sb_cc;          /* actual chars in buffer */
90                 u_long  sb_hiwat;       /* max actual char count */
91                 u_long  sb_mbcnt;       /* chars of mbufs used */
92                 u_long  sb_mbmax;       /* max chars of mbufs to use */
93                 long    sb_lowat;       /* low water mark */
94                 struct  mbuf *sb_mb;    /* the mbuf chain */
95                 struct  mbuf *sb_lastmbuf;      /* last mbuf in sb_mb */
96                 struct  mbuf *sb_lastrecord;    /* last record in sb_mb
97                                                  * valid <=> sb_mb non-NULL */
98                 struct  selinfo sb_sel; /* process selecting read/write */
99                 short   sb_flags;       /* flags, see below */
100                 short   sb_timeo;       /* timeout for read/write */
101         } so_rcv, so_snd;
102 #define SB_MAX          (256*1024)      /* default for max chars in sockbuf */
103 #define SB_LOCK         0x01            /* lock on data queue */
104 #define SB_WANT         0x02            /* someone is waiting to lock */
105 #define SB_WAIT         0x04            /* someone is waiting for data/space */
106 #define SB_SEL          0x08            /* someone is selecting */
107 #define SB_ASYNC        0x10            /* ASYNC I/O, need signals */
108 #define SB_UPCALL       0x20            /* someone wants an upcall */
109 #define SB_NOINTR       0x40            /* operations not interruptible */
110 #define SB_AIO          0x80            /* AIO operations queued */
111 #define SB_KNOTE        0x100           /* kernel note attached */
112 #define SB_MEVENT       0x200           /* need message event notification */
113
114         void    (*so_upcall) (struct socket *, void *, int);
115         void    *so_upcallarg;
116         struct  ucred *so_cred;         /* user credentials */
117         /* NB: generation count must not be first; easiest to make it last. */
118         void    *so_emuldata;           /* private data for emulators */
119         struct  so_accf { 
120                 struct  accept_filter *so_accept_filter;
121                 void    *so_accept_filter_arg;  /* saved filter args */
122                 char    *so_accept_filter_str;  /* saved user args */
123         } *so_accf;
124 };
125
126 /*
127  * Socket state bits.
128  */
129 #define SS_NOFDREF              0x0001  /* no file table ref any more */
130 #define SS_ISCONNECTED          0x0002  /* socket connected to a peer */
131 #define SS_ISCONNECTING         0x0004  /* in process of connecting to peer */
132 #define SS_ISDISCONNECTING      0x0008  /* in process of disconnecting */
133 #define SS_CANTSENDMORE         0x0010  /* can't send more data to peer */
134 #define SS_CANTRCVMORE          0x0020  /* can't receive more data from peer */
135 #define SS_RCVATMARK            0x0040  /* at mark on input */
136
137 #define SS_NBIO                 0x0100  /* non-blocking ops */
138 #define SS_ASYNC                0x0200  /* async i/o notify */
139 #define SS_ISCONFIRMING         0x0400  /* deciding to accept connection req */
140
141 #define SS_INCOMP               0x0800  /* unaccepted, incomplete connection */
142 #define SS_COMP                 0x1000  /* unaccepted, complete connection */
143 #define SS_ISDISCONNECTED       0x2000  /* socket disconnected from peer */
144
145 /*
146  * Externalized form of struct socket used by the sysctl(3) interface.
147  */
148 struct  xsocket {
149         size_t  xso_len;        /* length of this structure */
150         struct  socket *xso_so; /* makes a convenient handle sometimes */
151         short   so_type;
152         short   so_options;
153         short   so_linger;
154         short   so_state;
155         void    *so_pcb;                /* another convenient handle */
156         int     xso_protocol;
157         int     xso_family;
158         short   so_qlen;
159         short   so_incqlen;
160         short   so_qlimit;
161         short   so_timeo;
162         u_short so_error;
163         pid_t   so_pgid;
164         u_long  so_oobmark;
165         struct  xsockbuf {
166                 u_long  sb_cc;
167                 u_long  sb_hiwat;
168                 u_long  sb_mbcnt;
169                 u_long  sb_mbmax;
170                 long    sb_lowat;
171                 short   sb_flags;
172                 short   sb_timeo;
173         } so_rcv, so_snd;
174         uid_t   so_uid;         /* XXX */
175 };
176
177 /*
178  * Macros for sockets and socket buffering.
179  */
180
181 #ifdef SOCKBUF_DEBUG
182 #define sbcheck(sb)     _sbcheck(sb)
183 #else
184 #define sbcheck(sb)
185 #endif
186
187 /*
188  * Do we need to notify the other side when I/O is possible?
189  */
190 #define sb_notify(sb)                                           \
191 (((sb)->sb_flags &                                              \
192  (SB_WAIT | SB_SEL | SB_ASYNC | SB_UPCALL | SB_AIO | SB_KNOTE | SB_MEVENT)))
193
194 /*
195  * How much space is there in a socket buffer (so->so_snd or so->so_rcv)?
196  * This is problematical if the fields are unsigned, as the space might
197  * still be negative (cc > hiwat or mbcnt > mbmax).  Should detect
198  * overflow and return 0.  Should use "lmin" but it doesn't exist now.
199  */
200 #define sbspace(sb) \
201     ((long) imin((int)((sb)->sb_hiwat - (sb)->sb_cc), \
202          (int)((sb)->sb_mbmax - (sb)->sb_mbcnt)))
203
204 /* do we have to send all at once on a socket? */
205 #define sosendallatonce(so) \
206     ((so)->so_proto->pr_flags & PR_ATOMIC)
207
208 /* can we read something from so? */
209 #define soreadable(so) \
210     ((so)->so_rcv.sb_cc >= (so)->so_rcv.sb_lowat || \
211         ((so)->so_state & SS_CANTRCVMORE) || \
212         !TAILQ_EMPTY(&(so)->so_comp) || (so)->so_error)
213
214 /* can we write something to so? */
215 #define sowriteable(so) \
216     ((sbspace(&(so)->so_snd) >= (so)->so_snd.sb_lowat && \
217         (((so)->so_state&SS_ISCONNECTED) || \
218           ((so)->so_proto->pr_flags&PR_CONNREQUIRED)==0)) || \
219      ((so)->so_state & SS_CANTSENDMORE) || \
220      (so)->so_error)
221
222 /* adjust counters in sb reflecting allocation of m */
223 #define sballoc(sb, m) { \
224         (sb)->sb_cc += (m)->m_len; \
225         (sb)->sb_mbcnt += MSIZE; \
226         if ((m)->m_flags & M_EXT) \
227                 (sb)->sb_mbcnt += (m)->m_ext.ext_size; \
228 }
229
230 /* adjust counters in sb reflecting freeing of m */
231 #define sbfree(sb, m) { \
232         (sb)->sb_cc -= (m)->m_len; \
233         (sb)->sb_mbcnt -= MSIZE; \
234         if ((m)->m_flags & M_EXT) \
235                 (sb)->sb_mbcnt -= (m)->m_ext.ext_size; \
236 }
237
238 /*
239  * Set lock on sockbuf sb; sleep if lock is already held.
240  * Unless SB_NOINTR is set on sockbuf, sleep is interruptible.
241  * Returns error without lock if sleep is interrupted.
242  */
243 #define sblock(sb, wf) ((sb)->sb_flags & SB_LOCK ? \
244                 (((wf) == M_WAITOK) ? sb_lock(sb) : EWOULDBLOCK) : \
245                 ((sb)->sb_flags |= SB_LOCK), 0)
246
247 /* release lock on sockbuf sb */
248 #define sbunlock(sb) { \
249         (sb)->sb_flags &= ~SB_LOCK; \
250         if ((sb)->sb_flags & SB_WANT) { \
251                 (sb)->sb_flags &= ~SB_WANT; \
252                 wakeup((caddr_t)&(sb)->sb_flags); \
253         } \
254 }
255
256 #define sorwakeup(so)   do { \
257                           if (sb_notify(&(so)->so_rcv)) \
258                             sowakeup((so), &(so)->so_rcv); \
259                         } while (0)
260
261 #define sowwakeup(so)   do { \
262                           if (sb_notify(&(so)->so_snd)) \
263                             sowakeup((so), &(so)->so_snd); \
264                         } while (0)
265
266 #ifdef _KERNEL
267
268 /*
269  * Argument structure for sosetopt et seq.  This is in the KERNEL
270  * section because it will never be visible to user code.
271  */
272 enum sopt_dir { SOPT_GET, SOPT_SET };
273 struct sockopt {
274         enum    sopt_dir sopt_dir; /* is this a get or a set? */
275         int     sopt_level;     /* second arg of [gs]etsockopt */
276         int     sopt_name;      /* third arg of [gs]etsockopt */
277         void   *sopt_val;       /* fourth arg of [gs]etsockopt */
278         size_t  sopt_valsize;   /* (almost) fifth arg of [gs]etsockopt */
279         struct  thread *sopt_td; /* calling thread or null if kernel */
280 };
281
282 struct accept_filter {
283         char    accf_name[16];
284         void    (*accf_callback)
285                 (struct socket *so, void *arg, int waitflag);
286         void *  (*accf_create)
287                 (struct socket *so, char *arg);
288         void    (*accf_destroy)
289                 (struct socket *so);
290         SLIST_ENTRY(accept_filter) accf_next;   /* next on the list */
291 };
292
293 #ifdef MALLOC_DECLARE
294 MALLOC_DECLARE(M_PCB);
295 MALLOC_DECLARE(M_SONAME);
296 MALLOC_DECLARE(M_ACCF);
297 #endif
298
299 extern int      maxsockets;
300 extern u_long   sb_max;         /* nominal limit */
301 extern u_long   sb_max_adj;     /* actual limit used by sbreserve() */
302 extern struct   vm_zone *socket_zone;
303
304 struct file;
305 struct filedesc;
306 struct mbuf;
307 struct rlimit;
308 struct sockaddr;
309 struct stat;
310 struct ucred;
311 struct uio;
312 struct knote;
313
314 /*
315  * File operations on sockets.
316  */
317 int     soo_read (struct file *fp, struct uio *uio, struct ucred *cred,
318             int flags);
319 int     soo_write (struct file *fp, struct uio *uio, struct ucred *cred,
320             int flags);
321 int     soo_close (struct file *fp);
322 int     soo_shutdown (struct file *fp, int how);
323 int     soo_ioctl (struct file *fp, u_long cmd, caddr_t data,
324             struct ucred *cred);
325 int     soo_poll (struct file *fp, int events, struct ucred *cred);
326 int     soo_stat (struct file *fp, struct stat *ub, struct ucred *cred);
327 int     sokqfilter (struct file *fp, struct knote *kn);
328
329 /*
330  * From uipc_socket and friends
331  */
332 struct  sockaddr *dup_sockaddr (const struct sockaddr *sa);
333 int     getsockaddr (struct sockaddr **namp, caddr_t uaddr, size_t len);
334 void    sbappend (struct sockbuf *sb, struct mbuf *m);
335 int     sbappendaddr (struct sockbuf *sb, const struct sockaddr *asa,
336             struct mbuf *m0, struct mbuf *control);
337 int     sbappendcontrol (struct sockbuf *sb, struct mbuf *m0,
338             struct mbuf *control);
339 void    sbappendrecord (struct sockbuf *sb, struct mbuf *m0);
340 void    sbappendstream (struct sockbuf *sb, struct mbuf *m);
341 void    _sbcheck (struct sockbuf *sb);
342 void    sbcompress (struct sockbuf *sb, struct mbuf *m, struct mbuf *n);
343 struct mbuf *
344         sbcreatecontrol (caddr_t p, int size, int type, int level);
345 void    sbdrop (struct sockbuf *sb, int len);
346 void    sbdroprecord (struct sockbuf *sb);
347 struct mbuf *
348         sbunlinkmbuf (struct sockbuf *, struct mbuf *, struct mbuf **);
349 void    sbflush (struct sockbuf *sb);
350 void    sbinsertoob (struct sockbuf *sb, struct mbuf *m0);
351 void    sbrelease (struct sockbuf *sb, struct socket *so);
352 int     sbreserve (struct sockbuf *sb, u_long cc, struct socket *so,
353                    struct rlimit *rl);
354 void    sbtoxsockbuf (struct sockbuf *sb, struct xsockbuf *xsb);
355 int     sbwait (struct sockbuf *sb);
356 int     sb_lock (struct sockbuf *sb);
357 int     soabort (struct socket *so);
358 int     soaccept (struct socket *so, struct sockaddr **nam);
359 struct  socket *soalloc (int waitok);
360 int     sobind (struct socket *so, struct sockaddr *nam, struct thread *td);
361 void    socantrcvmore (struct socket *so);
362 void    socantsendmore (struct socket *so);
363 int     soclose (struct socket *so);
364 int     soconnect (struct socket *so, struct sockaddr *nam, struct thread *td);
365 int     soconnect2 (struct socket *so1, struct socket *so2);
366 int     socreate (int dom, struct socket **aso, int type, int proto,
367             struct thread *td);
368 void    sodealloc (struct socket *so);
369 int     sodisconnect (struct socket *so);
370 void    sofree (struct socket *so);
371 int     sogetopt (struct socket *so, struct sockopt *sopt);
372 void    sohasoutofband (struct socket *so);
373 void    soisconnected (struct socket *so);
374 void    soisconnecting (struct socket *so);
375 void    soisdisconnected (struct socket *so);
376 void    soisdisconnecting (struct socket *so);
377 int     solisten (struct socket *so, int backlog, struct thread *td);
378 struct socket *sonewconn (struct socket *head, int connstatus);
379 int     sooptcopyin (struct sockopt *sopt, void *buf, size_t len,
380                          size_t minlen);
381 int     sooptcopyout (struct sockopt *sopt, const void *buf, size_t len);
382
383 /* XXX; prepare mbuf for (__FreeBSD__ < 3) routines. */
384 int     soopt_getm (struct sockopt *sopt, struct mbuf **mp);
385 int     soopt_mcopyin (struct sockopt *sopt, struct mbuf *m);
386 int     soopt_mcopyout (struct sockopt *sopt, struct mbuf *m);
387
388 int     sopoll (struct socket *so, int events, struct ucred *cred,
389                     struct thread *td);
390 int     soreceive (struct socket *so, struct sockaddr **paddr,
391                        struct uio *uio, struct mbuf **mp0,
392                        struct mbuf **controlp, int *flagsp);
393 int     soreserve (struct socket *so, u_long sndcc, u_long rcvcc,
394                    struct rlimit *rl);
395 void    sorflush (struct socket *so);
396 int     sosend (struct socket *so, struct sockaddr *addr, struct uio *uio,
397                     struct mbuf *top, struct mbuf *control, int flags,
398                     struct thread *td);
399 int     sosendudp (struct socket *so, struct sockaddr *addr, struct uio *uio,
400                     struct mbuf *top, struct mbuf *control, int flags,
401                     struct thread *td);
402 int     sosetopt (struct socket *so, struct sockopt *sopt);
403 int     soshutdown (struct socket *so, int how);
404 void    sotoxsocket (struct socket *so, struct xsocket *xso);
405 void    sowakeup (struct socket *so, struct sockbuf *sb);
406
407 /* accept filter functions */
408 int     accept_filt_add (struct accept_filter *filt);
409 int     accept_filt_del (char *name);
410 struct accept_filter *  accept_filt_get (char *name);
411 #ifdef ACCEPT_FILTER_MOD
412 int accept_filt_generic_mod_event (module_t mod, int event, void *data);
413 SYSCTL_DECL(_net_inet_accf);
414 #endif /* ACCEPT_FILTER_MOD */
415
416 #endif /* _KERNEL */
417
418 #endif /* !_SYS_SOCKETVAR_H_ */