![[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
111 /*
112 * Not all are volatile, but some are, so we
113 * might as well say they all are.
114 */
115 volatile char inuse,
116 dead,
117 urginline,
118 intr,
119 blog,
120 done,
121 reuse,
122 keepopen,
123 linger,
124 delay_acks,
125 destroy,
126 ack_timed,
127 no_check,
128 zapped, /* In ax25 & ipx means not linked */
129 broadcast,
130 nonagle,
131 bsdism;
132 unsigned long lingertime;
133 int proc;
134 struct sock *next;
135 struct sock *prev; /* Doubly linked chain.. */
136 struct sock *pair;
137 struct sk_buff * volatile send_head;
138 struct sk_buff * volatile send_tail;
139 struct sk_buff_head back_log;
140 struct sk_buff *partial;
141 struct timer_list partial_timer;
142 long retransmits;
143 struct sk_buff_head write_queue,
144 receive_queue;
145 struct proto *prot;
146 struct wait_queue **sleep;
147 __u32 daddr;
148 __u32 saddr; /* Sending source */
149 __u32 rcv_saddr; /* Bound address */
150 unsigned short max_unacked;
151 unsigned short window;
152 __u32 lastwin_seq; /* sequence number when we last updated the window we offer */
153 volatile unsigned long ato; /* ack timeout */
154 volatile unsigned long lrcvtime; /* jiffies at last rcv */
155 unsigned short bytes_rcv;
156 /*
157 * mss is min(mtu, max_window)
158 */
159 unsigned short mtu; /* mss negotiated in the syn's */
160 volatile unsigned short mss; /* current eff. mss - can change */
161 volatile unsigned short user_mss; /* mss requested by user in ioctl */
162 volatile unsigned short max_window;
163 unsigned long window_clamp;
164 unsigned short num;
165 volatile unsigned short cong_window;
166 volatile unsigned short cong_count;
167 volatile unsigned short ssthresh;
168 volatile unsigned short packets_out;
169 volatile unsigned short shutdown;
170 volatile unsigned long rtt;
171 volatile unsigned long mdev;
172 volatile unsigned long rto;
173
174 /*
175 * currently backoff isn't used, but I'm maintaining it in case
176 * we want to go back to a backoff formula that needs it
177 */
178
179 volatile unsigned short backoff;
180 volatile int err, err_soft; /* Soft holds errors that don't
181 cause failure but are the cause
182 of a persistent failure not just
183 'timed out' */
184 unsigned char protocol;
185 volatile unsigned char state;
186 volatile unsigned char ack_backlog;
187 unsigned char max_ack_backlog;
188 unsigned char priority;
189 unsigned char debug;
190 unsigned short rcvbuf;
191 unsigned short sndbuf;
192 unsigned short type;
193 unsigned char localroute; /* Route locally only */
194 #ifdef CONFIG_IPX
195 /*
196 * Once the IPX ncpd patches are in these are going into protinfo
197 */
198 ipx_address ipx_dest_addr;
199 ipx_interface *ipx_intrfc;
200 unsigned short ipx_port;
201 #ifdef CONFIG_IPX_INTERN
202 unsigned char ipx_node[IPX_NODE_LEN];
203 #endif
204 unsigned short ipx_type;
205 #endif
206 #ifdef CONFIG_AX25
207 ax25_cb *ax25;
208 #ifdef CONFIG_NETROM
209 nr_cb *nr;
210 #endif
211 #endif
212
213 /*
214 * This is where all the private (optional) areas that don't
215 * overlap will eventually live.
216 */
217
218 union
219 {
220 struct unix_opt af_unix;
221 #ifdef CONFIG_ATALK
222 struct atalk_sock af_at;
223 #endif
224 #ifdef CONFIG_INET
225 struct inet_packet_opt af_packet;
226 #endif
227 } protinfo;
228
229 /*
230 * IP 'private area' or will be eventually
231 */
232 int ip_ttl; /* TTL setting */
233 int ip_tos; /* TOS */
234 struct tcphdr dummy_th;
235 struct timer_list keepalive_timer; /* TCP keepalive hack */
236 struct timer_list retransmit_timer; /* TCP retransmit timer */
237 struct timer_list ack_timer; /* TCP delayed ack timer */
238 int ip_xmit_timeout; /* Why the timeout is running */
239 struct rtable *ip_route_cache; /* Cached output route */
240 unsigned char ip_hdrincl; /* Include headers ? */
241 #ifdef CONFIG_IP_MULTICAST
242 int ip_mc_ttl; /* Multicasting TTL */
243 int ip_mc_loop; /* Loopback */
244 char ip_mc_name[MAX_ADDR_LEN];/* Multicast device name */
245 struct ip_mc_socklist *ip_mc_list; /* Group array */
246 #endif
247
248 /*
249 * This part is used for the timeout functions (timer.c).
250 */
251
252 int timeout; /* What are we waiting for? */
253 struct timer_list timer; /* This is the TIME_WAIT/receive timer
254 * when we are doing IP
255 */
256 struct timeval stamp;
257
258 /*
259 * Identd
260 */
261
262 struct socket *socket;
263
264 /*
265 * Callbacks
266 */
267
268 void (*state_change)(struct sock *sk);
269 void (*data_ready)(struct sock *sk,int bytes);
270 void (*write_space)(struct sock *sk);
271 void (*error_report)(struct sock *sk);
272
273 };
274
275 /*
276 * IP protocol blocks we attach to sockets.
277 */
278
279 struct proto
280 {
281 void (*close)(struct sock *sk, int timeout);
282 int (*build_header)(struct sk_buff *skb,
283 __u32 saddr,
284 __u32 daddr,
285 struct device **dev, int type,
286 struct options *opt, int len,
287 int tos, int ttl, struct rtable ** rp);
288 int (*connect)(struct sock *sk,
289 struct sockaddr_in *usin, int addr_len);
290 struct sock * (*accept) (struct sock *sk, int flags);
291 void (*queue_xmit)(struct sock *sk,
292 struct device *dev, struct sk_buff *skb,
293 int free);
294 void (*retransmit)(struct sock *sk, int all);
295 void (*write_wakeup)(struct sock *sk);
296 void (*read_wakeup)(struct sock *sk);
297 int (*rcv)(struct sk_buff *buff, struct device *dev,
298 struct options *opt, __u32 daddr,
299 unsigned short len, __u32 saddr,
300 int redo, struct inet_protocol *protocol);
301 int (*select)(struct sock *sk, int which,
302 select_table *wait);
303 int (*ioctl)(struct sock *sk, int cmd,
304 unsigned long arg);
305 int (*init)(struct sock *sk);
306 void (*shutdown)(struct sock *sk, int how);
307 int (*setsockopt)(struct sock *sk, int level, int optname,
308 char *optval, int optlen);
309 int (*getsockopt)(struct sock *sk, int level, int optname,
310 char *optval, int *option);
311 int (*sendmsg)(struct sock *sk, struct msghdr *msg, int len,
312 int noblock, int flags);
313 int (*recvmsg)(struct sock *sk, struct msghdr *msg, int len,
314 int noblock, int flags, int *addr_len);
315 int (*bind)(struct sock *sk, struct sockaddr *uaddr, int addr_len);
316 unsigned short max_header;
317 unsigned long retransmits;
318 char name[32];
319 int inuse, highestinuse;
320 struct sock * sock_array[SOCK_ARRAY_SIZE];
321 };
322
323 #define TIME_WRITE 1
324 #define TIME_CLOSE 2
325 #define TIME_KEEPOPEN 3
326 #define TIME_DESTROY 4
327 #define TIME_DONE 5 /* Used to absorb those last few packets */
328 #define TIME_PROBE0 6
329 /*
330 * About 10 seconds
331 */
332 #define SOCK_DESTROY_TIME (10*HZ)
333
334
335 /*
336 * Sockets 0-1023 can't be bound too unless you are superuser
337 */
338
339 #define PROT_SOCK 1024
340
341
342 #define SHUTDOWN_MASK 3
343 #define RCV_SHUTDOWN 1
344 #define SEND_SHUTDOWN 2
345
346
347 extern void destroy_sock(struct sock *sk);
348 extern unsigned short get_new_socknum(struct proto *,
349 unsigned short);
350 extern void put_sock(unsigned short, struct sock *);
351 extern void release_sock(struct sock *sk);
352 extern struct sock *get_sock(struct proto *, unsigned short,
353 unsigned long, unsigned short,
354 unsigned long);
355 extern struct sock *get_sock_mcast(struct sock *, unsigned short,
356 unsigned long, unsigned short,
357 unsigned long);
358 extern struct sock *get_sock_raw(struct sock *, unsigned short,
359 unsigned long, unsigned long);
360
361 extern struct sk_buff *sock_wmalloc(struct sock *sk,
362 unsigned long size, int force,
363 int priority);
364 extern struct sk_buff *sock_rmalloc(struct sock *sk,
365 unsigned long size, int force,
366 int priority);
367 extern void sock_wfree(struct sock *sk,
368 struct sk_buff *skb);
369 extern void sock_rfree(struct sock *sk,
370 struct sk_buff *skb);
371 extern unsigned long sock_rspace(struct sock *sk);
372 extern unsigned long sock_wspace(struct sock *sk);
373
374 extern int sock_setsockopt(struct sock *sk, int level,
375 int op, char *optval,
376 int optlen);
377
378 extern int sock_getsockopt(struct sock *sk, int level,
379 int op, char *optval,
380 int *optlen);
381 extern struct sk_buff *sock_alloc_send_skb(struct sock *skb,
382 unsigned long size,
383 unsigned long fallback,
384 int noblock,
385 int *errcode);
386
387 /*
388 * Queue a received datagram if it will fit. Stream and sequenced
389 * protocols can't normally use this as they need to fit buffers in
390 * and play with them.
391 *
392 * Inlined as its very short and called for pretty much every
393 * packet ever received.
394 */
395
396 extern __inline__ int sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb)
/* ![[next]](../icons/right.png)
![[first]](../icons/n_first.png)
![[top]](../icons/top.png)
*/
397 {
398 unsigned long flags;
399 if(sk->rmem_alloc + skb->truesize >= sk->rcvbuf)
400 return -ENOMEM;
401 save_flags(flags);
402 cli();
403 sk->rmem_alloc+=skb->truesize;
404 skb->sk=sk;
405 restore_flags(flags);
406 skb_queue_tail(&sk->receive_queue,skb);
407 if(!sk->dead)
408 sk->data_ready(sk,skb->len);
409 return 0;
410 }
411
412 /*
413 * Recover an error report and clear atomically
414 */
415
416 extern __inline__ int sock_error(struct sock *sk)
/* ![[previous]](../icons/left.png)
![[last]](../icons/n_last.png)
*/
417 {
418 int err=xchg(&sk->err,0);
419 return -err;
420 }
421
422 /*
423 * Declarations from timer.c
424 */
425
426 extern struct sock *timer_base;
427
428 extern void delete_timer (struct sock *);
429 extern void reset_timer (struct sock *, int, unsigned long);
430 extern void net_timer (unsigned long);
431
432
433 /*
434 * Enable debug/info messages
435 */
436
437 #define NETDEBUG(x) x
438
439 #endif /* _SOCK_H */
![[bottom]](../icons/n_bottom.png){kind=icon}
*/