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