![[first]](../icons/first.png){kind=icon}
![[previous]](../icons/n_left.png){kind=icon}
![[next]](../icons/n_right.png){kind=icon}
![[last]](../icons/last.png){kind=icon}
![[top]](../icons/n_top.png){kind=icon}
![[bottom]](../icons/bottom.png){kind=icon}
![[index]](../icons/index.png){kind=icon}
![[help]](../icons/help.png){kind=icon}
*/
1 /*
2 * INET An implementation of the TCP/IP protocol suite for the LINUX
3 * operating system. INET is implemented using the BSD Socket
4 * interface as the means of communication with the user level.
5 *
6 * Definitions for the AF_INET socket handler.
7 *
8 * Version: @(#)sock.h 1.0.4 05/13/93
9 *
10 * Authors: Ross Biro, <bir7@leland.Stanford.Edu>
11 * Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
12 * Corey Minyard <wf-rch!minyard@relay.EU.net>
13 * Florian La Roche <flla@stud.uni-sb.de>
14 *
15 * Fixes:
16 * Alan Cox : Volatiles in skbuff pointers. See
17 * skbuff comments. May be overdone,
18 * better to prove they can be removed
19 * than the reverse.
20 * Alan Cox : Added a zapped field for tcp to note
21 * a socket is reset and must stay shut up
22 * Alan Cox : New fields for options
23 * Pauline Middelink : identd support
24 * Alan Cox : Eliminate low level recv/recvfrom
25 *
26 * This program is free software; you can redistribute it and/or
27 * modify it under the terms of the GNU General Public License
28 * as published by the Free Software Foundation; either version
29 * 2 of the License, or (at your option) any later version.
30 */
31 #ifndef _SOCK_H
32 #define _SOCK_H
33
34 #include <linux/timer.h>
35 #include <linux/ip.h> /* struct options */
36 #include <linux/in.h> /* struct sockaddr_in */
37 #include <linux/tcp.h> /* struct tcphdr */
38 #include <linux/config.h>
39
40 #include <linux/netdevice.h>
41 #include <linux/skbuff.h> /* struct sk_buff */
42 #include <net/protocol.h> /* struct inet_protocol */
43 #ifdef CONFIG_AX25
44 #include <net/ax25.h>
45 #ifdef CONFIG_NETROM
46 #include <net/netrom.h>
47 #endif
48 #endif
49 #ifdef CONFIG_IPX
50 #include <net/ipx.h>
51 #endif
52 #ifdef CONFIG_ATALK
53 #include <linux/atalk.h>
54 #endif
55
56 #include <linux/igmp.h>
57
58 /* Think big (also on some systems a byte is faster) */
59 #define SOCK_ARRAY_SIZE 256
60
61
62 /*
63 * The AF_UNIX specific socket options
64 */
65
66 struct unix_opt
67 {
68 int family;
69 char * name;
70 int locks;
71 struct inode * inode;
72 struct semaphore readsem;
73 struct sock * other;
74 };
75
76 /*
77 * IP packet socket options
78 */
79
80 struct inet_packet_opt
81 {
82 struct notifier_block notifier; /* Used when bound */
83 struct device *bound_dev;
84 unsigned long dev_stamp;
85 struct packet_type *prot_hook;
86 char device_name[15];
87 };
88
89
90 /*
91 * This structure really needs to be cleaned up.
92 * Most of it is for TCP, and not used by any of
93 * the other protocols.
94 */
95 struct sock
96 {
97 struct options *opt;
98 volatile unsigned long wmem_alloc;
99 volatile unsigned long rmem_alloc;
100 unsigned long allocation; /* Allocation mode */
101 __u32 write_seq;
102 __u32 sent_seq;
103 __u32 acked_seq;
104 __u32 copied_seq;
105 __u32 rcv_ack_seq;
106 __u32 window_seq;
107 __u32 fin_seq;
108 __u32 urg_seq;
109 __u32 urg_data;
110 int users; /* user count */
111 /*
112 * Not all are volatile, but some are, so we
113 * might as well say they all are.
114 */
115 volatile char dead,
116 urginline,
117 intr,
118 blog,
119 done,
120 reuse,
121 keepopen,
122 linger,
123 delay_acks,
124 destroy,
125 ack_timed,
126 no_check,
127 zapped, /* In ax25 & ipx means not linked */
128 broadcast,
129 nonagle,
130 bsdism;
131 unsigned long lingertime;
132 int proc;
133 struct sock *next;
134 struct sock *prev; /* Doubly linked chain.. */
135 struct sock *pair;
136 struct sk_buff * volatile send_head;
137 struct sk_buff * volatile send_tail;
138 struct sk_buff_head back_log;
139 struct sk_buff *partial;
140 struct timer_list partial_timer;
141 long retransmits;
142 struct sk_buff_head write_queue,
143 receive_queue;
144 struct proto *prot;
145 struct wait_queue **sleep;
146 __u32 daddr;
147 __u32 saddr; /* Sending source */
148 __u32 rcv_saddr; /* Bound address */
149 unsigned short max_unacked;
150 unsigned short window;
151 __u32 lastwin_seq; /* sequence number when we last updated the window we offer */
152 volatile unsigned long ato; /* ack timeout */
153 volatile unsigned long lrcvtime; /* jiffies at last rcv */
154 unsigned short bytes_rcv;
155 /*
156 * mss is min(mtu, max_window)
157 */
158 unsigned short mtu; /* mss negotiated in the syn's */
159 volatile unsigned short mss; /* current eff. mss - can change */
160 volatile unsigned short user_mss; /* mss requested by user in ioctl */
161 volatile unsigned short max_window;
162 unsigned long window_clamp;
163 unsigned short num;
164 volatile unsigned short cong_window;
165 volatile unsigned short cong_count;
166 volatile unsigned short ssthresh;
167 volatile unsigned short packets_out;
168 volatile unsigned short shutdown;
169 volatile unsigned long rtt;
170 volatile unsigned long mdev;
171 volatile unsigned long rto;
172
173 /*
174 * currently backoff isn't used, but I'm maintaining it in case
175 * we want to go back to a backoff formula that needs it
176 */
177
178 volatile unsigned short backoff;
179 volatile int err, err_soft; /* Soft holds errors that don't
180 cause failure but are the cause
181 of a persistent failure not just
182 'timed out' */
183 unsigned char protocol;
184 volatile unsigned char state;
185 volatile unsigned char ack_backlog;
186 unsigned char max_ack_backlog;
187 unsigned char priority;
188 unsigned char debug;
189 unsigned short rcvbuf;
190 unsigned short sndbuf;
191 unsigned short type;
192 unsigned char localroute; /* Route locally only */
193 #ifdef CONFIG_IPX
194 /*
195 * Once the IPX ncpd patches are in these are going into protinfo
196 */
197 ipx_address ipx_dest_addr;
198 ipx_interface *ipx_intrfc;
199 unsigned short ipx_port;
200 #ifdef CONFIG_IPX_INTERN
201 unsigned char ipx_node[IPX_NODE_LEN];
202 #endif
203 unsigned short ipx_type;
204 #endif
205 #ifdef CONFIG_AX25
206 ax25_cb *ax25;
207 #ifdef CONFIG_NETROM
208 nr_cb *nr;
209 #endif
210 #endif
211
212 /*
213 * This is where all the private (optional) areas that don't
214 * overlap will eventually live.
215 */
216
217 union
218 {
219 struct unix_opt af_unix;
220 #ifdef CONFIG_ATALK
221 struct atalk_sock af_at;
222 #endif
223 #ifdef CONFIG_INET
224 struct inet_packet_opt af_packet;
225 #endif
226 } protinfo;
227
228 /*
229 * IP 'private area' or will be eventually
230 */
231 int ip_ttl; /* TTL setting */
232 int ip_tos; /* TOS */
233 struct tcphdr dummy_th;
234 struct timer_list keepalive_timer; /* TCP keepalive hack */
235 struct timer_list retransmit_timer; /* TCP retransmit timer */
236 struct timer_list ack_timer; /* TCP delayed ack timer */
237 int ip_xmit_timeout; /* Why the timeout is running */
238 struct rtable *ip_route_cache; /* Cached output route */
239 unsigned char ip_hdrincl; /* Include headers ? */
240 #ifdef CONFIG_IP_MULTICAST
241 int ip_mc_ttl; /* Multicasting TTL */
242 int ip_mc_loop; /* Loopback */
243 char ip_mc_name[MAX_ADDR_LEN];/* Multicast device name */
244 struct ip_mc_socklist *ip_mc_list; /* Group array */
245 #endif
246
247 /*
248 * This part is used for the timeout functions (timer.c).
249 */
250
251 int timeout; /* What are we waiting for? */
252 struct timer_list timer; /* This is the TIME_WAIT/receive timer
253 * when we are doing IP
254 */
255 struct timeval stamp;
256
257 /*
258 * Identd
259 */
260
261 struct socket *socket;
262
263 /*
264 * Callbacks
265 */
266
267 void (*state_change)(struct sock *sk);
268 void (*data_ready)(struct sock *sk,int bytes);
269 void (*write_space)(struct sock *sk);
270 void (*error_report)(struct sock *sk);
271
272 };
273
274 /*
275 * IP protocol blocks we attach to sockets.
276 */
277
278 struct proto
279 {
280 void (*close)(struct sock *sk, int timeout);
281 int (*build_header)(struct sk_buff *skb,
282 __u32 saddr,
283 __u32 daddr,
284 struct device **dev, int type,
285 struct options *opt, int len,
286 int tos, int ttl, struct rtable ** rp);
287 int (*connect)(struct sock *sk,
288 struct sockaddr_in *usin, int addr_len);
289 struct sock * (*accept) (struct sock *sk, int flags);
290 void (*queue_xmit)(struct sock *sk,
291 struct device *dev, struct sk_buff *skb,
292 int free);
293 void (*retransmit)(struct sock *sk, int all);
294 void (*write_wakeup)(struct sock *sk);
295 void (*read_wakeup)(struct sock *sk);
296 int (*rcv)(struct sk_buff *buff, struct device *dev,
297 struct options *opt, __u32 daddr,
298 unsigned short len, __u32 saddr,
299 int redo, struct inet_protocol *protocol);
300 int (*select)(struct sock *sk, int which,
301 select_table *wait);
302 int (*ioctl)(struct sock *sk, int cmd,
303 unsigned long arg);
304 int (*init)(struct sock *sk);
305 void (*shutdown)(struct sock *sk, int how);
306 int (*setsockopt)(struct sock *sk, int level, int optname,
307 char *optval, int optlen);
308 int (*getsockopt)(struct sock *sk, int level, int optname,
309 char *optval, int *option);
310 int (*sendmsg)(struct sock *sk, struct msghdr *msg, int len,
311 int noblock, int flags);
312 int (*recvmsg)(struct sock *sk, struct msghdr *msg, int len,
313 int noblock, int flags, int *addr_len);
314 int (*bind)(struct sock *sk, struct sockaddr *uaddr, int addr_len);
315 unsigned short max_header;
316 unsigned long retransmits;
317 char name[32];
318 int inuse, highestinuse;
319 struct sock * sock_array[SOCK_ARRAY_SIZE];
320 };
321
322 #define TIME_WRITE 1
323 #define TIME_CLOSE 2
324 #define TIME_KEEPOPEN 3
325 #define TIME_DESTROY 4
326 #define TIME_DONE 5 /* Used to absorb those last few packets */
327 #define TIME_PROBE0 6
328 /*
329 * About 10 seconds
330 */
331 #define SOCK_DESTROY_TIME (10*HZ)
332
333
334 /*
335 * Sockets 0-1023 can't be bound too unless you are superuser
336 */
337
338 #define PROT_SOCK 1024
339
340
341 #define SHUTDOWN_MASK 3
342 #define RCV_SHUTDOWN 1
343 #define SEND_SHUTDOWN 2
344
345 /*
346 * Used by processes to "lock" a socket state, so that
347 * interrupts and bottom half handlers won't change it
348 * from under us. It essentially blocks any incoming
349 * packets, so that we won't get any new data or any
350 * packets that change the state of the socket.
351 *
352 * Note the 'barrier()' calls: gcc may not move a lock
353 * "downwards" or a unlock "upwards" when optimizing.
354 */
355 extern void __release_sock(struct sock *sk);
356
357 static inline void lock_sock(struct sock *sk)
/* ![[next]](../icons/right.png)
![[first]](../icons/n_first.png)
![[top]](../icons/top.png)
*/
358 {
359 #if 1
360 /* debugging code: the test isn't even 100% correct, but it can catch bugs */
361 /* Note that a double lock is ok in theory - it's just _usually_ a bug */
362 if (sk->users) {
363 __label__ here;
364 printk("double lock on socket at %p\n", &&here);
365 here:
366 }
367 #endif
368 sk->users++;
369 barrier();
370 }
371
372 static inline void release_sock(struct sock *sk)
/* ![[previous]](../icons/left.png)
*/
373 {
374 barrier();
375 #if 1
376 /* debugging code: remove me when ok */
377 if (sk->users == 0) {
378 __label__ here;
379 sk->users = 1;
380 printk("trying to unlock unlocked socket at %p\n", &&here);
381 here:
382 }
383 #endif
384 if (!--sk->users)
385 __release_sock(sk);
386 }
387
388
389 extern void destroy_sock(struct sock *sk);
390 extern unsigned short get_new_socknum(struct proto *,
391 unsigned short);
392 extern void put_sock(unsigned short, struct sock *);
393 extern struct sock *get_sock(struct proto *, unsigned short,
394 unsigned long, unsigned short,
395 unsigned long);
396 extern struct sock *get_sock_mcast(struct sock *, unsigned short,
397 unsigned long, unsigned short,
398 unsigned long);
399 extern struct sock *get_sock_raw(struct sock *, unsigned short,
400 unsigned long, unsigned long);
401
402 extern struct sk_buff *sock_wmalloc(struct sock *sk,
403 unsigned long size, int force,
404 int priority);
405 extern struct sk_buff *sock_rmalloc(struct sock *sk,
406 unsigned long size, int force,
407 int priority);
408 extern void sock_wfree(struct sock *sk,
409 struct sk_buff *skb);
410 extern void sock_rfree(struct sock *sk,
411 struct sk_buff *skb);
412 extern unsigned long sock_rspace(struct sock *sk);
413 extern unsigned long sock_wspace(struct sock *sk);
414
415 extern int sock_setsockopt(struct sock *sk, int level,
416 int op, char *optval,
417 int optlen);
418
419 extern int sock_getsockopt(struct sock *sk, int level,
420 int op, char *optval,
421 int *optlen);
422 extern struct sk_buff *sock_alloc_send_skb(struct sock *skb,
423 unsigned long size,
424 unsigned long fallback,
425 int noblock,
426 int *errcode);
427
428 /*
429 * Queue a received datagram if it will fit. Stream and sequenced
430 * protocols can't normally use this as they need to fit buffers in
431 * and play with them.
432 *
433 * Inlined as its very short and called for pretty much every
434 * packet ever received.
435 */
436
437 extern __inline__ int sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb)
/* */
438 {
439 unsigned long flags;
440 if(sk->rmem_alloc + skb->truesize >= sk->rcvbuf)
441 return -ENOMEM;
442 save_flags(flags);
443 cli();
444 sk->rmem_alloc+=skb->truesize;
445 skb->sk=sk;
446 restore_flags(flags);
447 skb_queue_tail(&sk->receive_queue,skb);
448 if(!sk->dead)
449 sk->data_ready(sk,skb->len);
450 return 0;
451 }
452
453 /*
454 * Recover an error report and clear atomically
455 */
456
457 extern __inline__ int sock_error(struct sock *sk)
/* ![[last]](../icons/n_last.png)
*/
458 {
459 int err=xchg(&sk->err,0);
460 return -err;
461 }
462
463 /*
464 * Declarations from timer.c
465 */
466
467 extern struct sock *timer_base;
468
469 extern void delete_timer (struct sock *);
470 extern void reset_timer (struct sock *, int, unsigned long);
471 extern void net_timer (unsigned long);
472
473
474 /*
475 * Enable debug/info messages
476 */
477
478 #define NETDEBUG(x) x
479
480 #endif /* _SOCK_H */
![[bottom]](../icons/n_bottom.png){kind=icon}
*/