[TCP] net/ipv4/tcp_input.c: trivial annotations
[linux-2.6] / net / ipv4 / proc.c
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  *              This file implements the various access functions for the
7  *              PROC file system.  It is mainly used for debugging and
8  *              statistics.
9  *
10  * Version:     $Id: proc.c,v 1.45 2001/05/16 16:45:35 davem Exp $
11  *
12  * Authors:     Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
13  *              Gerald J. Heim, <heim@peanuts.informatik.uni-tuebingen.de>
14  *              Fred Baumgarten, <dc6iq@insu1.etec.uni-karlsruhe.de>
15  *              Erik Schoenfelder, <schoenfr@ibr.cs.tu-bs.de>
16  *
17  * Fixes:
18  *              Alan Cox        :       UDP sockets show the rxqueue/txqueue
19  *                                      using hint flag for the netinfo.
20  *      Pauline Middelink       :       identd support
21  *              Alan Cox        :       Make /proc safer.
22  *      Erik Schoenfelder       :       /proc/net/snmp
23  *              Alan Cox        :       Handle dead sockets properly.
24  *      Gerhard Koerting        :       Show both timers
25  *              Alan Cox        :       Allow inode to be NULL (kernel socket)
26  *      Andi Kleen              :       Add support for open_requests and
27  *                                      split functions for more readibility.
28  *      Andi Kleen              :       Add support for /proc/net/netstat
29  *      Arnaldo C. Melo         :       Convert to seq_file
30  *
31  *              This program is free software; you can redistribute it and/or
32  *              modify it under the terms of the GNU General Public License
33  *              as published by the Free Software Foundation; either version
34  *              2 of the License, or (at your option) any later version.
35  */
36 #include <linux/types.h>
37 #include <net/icmp.h>
38 #include <net/protocol.h>
39 #include <net/tcp.h>
40 #include <net/udp.h>
41 #include <linux/inetdevice.h>
42 #include <linux/proc_fs.h>
43 #include <linux/seq_file.h>
44 #include <net/sock.h>
45 #include <net/raw.h>
46
47 static int fold_prot_inuse(struct proto *proto)
48 {
49         int res = 0;
50         int cpu;
51
52         for_each_possible_cpu(cpu)
53                 res += proto->stats[cpu].inuse;
54
55         return res;
56 }
57
58 /*
59  *      Report socket allocation statistics [mea@utu.fi]
60  */
61 static int sockstat_seq_show(struct seq_file *seq, void *v)
62 {
63         socket_seq_show(seq);
64         seq_printf(seq, "TCP: inuse %d orphan %d tw %d alloc %d mem %d\n",
65                    fold_prot_inuse(&tcp_prot), atomic_read(&tcp_orphan_count),
66                    tcp_death_row.tw_count, atomic_read(&tcp_sockets_allocated),
67                    atomic_read(&tcp_memory_allocated));
68         seq_printf(seq, "UDP: inuse %d\n", fold_prot_inuse(&udp_prot));
69         seq_printf(seq, "RAW: inuse %d\n", fold_prot_inuse(&raw_prot));
70         seq_printf(seq,  "FRAG: inuse %d memory %d\n", ip_frag_nqueues,
71                    atomic_read(&ip_frag_mem));
72         return 0;
73 }
74
75 static int sockstat_seq_open(struct inode *inode, struct file *file)
76 {
77         return single_open(file, sockstat_seq_show, NULL);
78 }
79
80 static struct file_operations sockstat_seq_fops = {
81         .owner   = THIS_MODULE,
82         .open    = sockstat_seq_open,
83         .read    = seq_read,
84         .llseek  = seq_lseek,
85         .release = single_release,
86 };
87
88 static unsigned long
89 fold_field(void *mib[], int offt)
90 {
91         unsigned long res = 0;
92         int i;
93
94         for_each_possible_cpu(i) {
95                 res += *(((unsigned long *) per_cpu_ptr(mib[0], i)) + offt);
96                 res += *(((unsigned long *) per_cpu_ptr(mib[1], i)) + offt);
97         }
98         return res;
99 }
100
101 /* snmp items */
102 static const struct snmp_mib snmp4_ipstats_list[] = {
103         SNMP_MIB_ITEM("InReceives", IPSTATS_MIB_INRECEIVES),
104         SNMP_MIB_ITEM("InHdrErrors", IPSTATS_MIB_INHDRERRORS),
105         SNMP_MIB_ITEM("InAddrErrors", IPSTATS_MIB_INADDRERRORS),
106         SNMP_MIB_ITEM("ForwDatagrams", IPSTATS_MIB_OUTFORWDATAGRAMS),
107         SNMP_MIB_ITEM("InUnknownProtos", IPSTATS_MIB_INUNKNOWNPROTOS),
108         SNMP_MIB_ITEM("InDiscards", IPSTATS_MIB_INDISCARDS),
109         SNMP_MIB_ITEM("InDelivers", IPSTATS_MIB_INDELIVERS),
110         SNMP_MIB_ITEM("OutRequests", IPSTATS_MIB_OUTREQUESTS),
111         SNMP_MIB_ITEM("OutDiscards", IPSTATS_MIB_OUTDISCARDS),
112         SNMP_MIB_ITEM("OutNoRoutes", IPSTATS_MIB_OUTNOROUTES),
113         SNMP_MIB_ITEM("ReasmTimeout", IPSTATS_MIB_REASMTIMEOUT),
114         SNMP_MIB_ITEM("ReasmReqds", IPSTATS_MIB_REASMREQDS),
115         SNMP_MIB_ITEM("ReasmOKs", IPSTATS_MIB_REASMOKS),
116         SNMP_MIB_ITEM("ReasmFails", IPSTATS_MIB_REASMFAILS),
117         SNMP_MIB_ITEM("FragOKs", IPSTATS_MIB_FRAGOKS),
118         SNMP_MIB_ITEM("FragFails", IPSTATS_MIB_FRAGFAILS),
119         SNMP_MIB_ITEM("FragCreates", IPSTATS_MIB_FRAGCREATES),
120         SNMP_MIB_SENTINEL
121 };
122
123 static const struct snmp_mib snmp4_icmp_list[] = {
124         SNMP_MIB_ITEM("InMsgs", ICMP_MIB_INMSGS),
125         SNMP_MIB_ITEM("InErrors", ICMP_MIB_INERRORS),
126         SNMP_MIB_ITEM("InDestUnreachs", ICMP_MIB_INDESTUNREACHS),
127         SNMP_MIB_ITEM("InTimeExcds", ICMP_MIB_INTIMEEXCDS),
128         SNMP_MIB_ITEM("InParmProbs", ICMP_MIB_INPARMPROBS),
129         SNMP_MIB_ITEM("InSrcQuenchs", ICMP_MIB_INSRCQUENCHS),
130         SNMP_MIB_ITEM("InRedirects", ICMP_MIB_INREDIRECTS),
131         SNMP_MIB_ITEM("InEchos", ICMP_MIB_INECHOS),
132         SNMP_MIB_ITEM("InEchoReps", ICMP_MIB_INECHOREPS),
133         SNMP_MIB_ITEM("InTimestamps", ICMP_MIB_INTIMESTAMPS),
134         SNMP_MIB_ITEM("InTimestampReps", ICMP_MIB_INTIMESTAMPREPS),
135         SNMP_MIB_ITEM("InAddrMasks", ICMP_MIB_INADDRMASKS),
136         SNMP_MIB_ITEM("InAddrMaskReps", ICMP_MIB_INADDRMASKREPS),
137         SNMP_MIB_ITEM("OutMsgs", ICMP_MIB_OUTMSGS),
138         SNMP_MIB_ITEM("OutErrors", ICMP_MIB_OUTERRORS),
139         SNMP_MIB_ITEM("OutDestUnreachs", ICMP_MIB_OUTDESTUNREACHS),
140         SNMP_MIB_ITEM("OutTimeExcds", ICMP_MIB_OUTTIMEEXCDS),
141         SNMP_MIB_ITEM("OutParmProbs", ICMP_MIB_OUTPARMPROBS),
142         SNMP_MIB_ITEM("OutSrcQuenchs", ICMP_MIB_OUTSRCQUENCHS),
143         SNMP_MIB_ITEM("OutRedirects", ICMP_MIB_OUTREDIRECTS),
144         SNMP_MIB_ITEM("OutEchos", ICMP_MIB_OUTECHOS),
145         SNMP_MIB_ITEM("OutEchoReps", ICMP_MIB_OUTECHOREPS),
146         SNMP_MIB_ITEM("OutTimestamps", ICMP_MIB_OUTTIMESTAMPS),
147         SNMP_MIB_ITEM("OutTimestampReps", ICMP_MIB_OUTTIMESTAMPREPS),
148         SNMP_MIB_ITEM("OutAddrMasks", ICMP_MIB_OUTADDRMASKS),
149         SNMP_MIB_ITEM("OutAddrMaskReps", ICMP_MIB_OUTADDRMASKREPS),
150         SNMP_MIB_SENTINEL
151 };
152
153 static const struct snmp_mib snmp4_tcp_list[] = {
154         SNMP_MIB_ITEM("RtoAlgorithm", TCP_MIB_RTOALGORITHM),
155         SNMP_MIB_ITEM("RtoMin", TCP_MIB_RTOMIN),
156         SNMP_MIB_ITEM("RtoMax", TCP_MIB_RTOMAX),
157         SNMP_MIB_ITEM("MaxConn", TCP_MIB_MAXCONN),
158         SNMP_MIB_ITEM("ActiveOpens", TCP_MIB_ACTIVEOPENS),
159         SNMP_MIB_ITEM("PassiveOpens", TCP_MIB_PASSIVEOPENS),
160         SNMP_MIB_ITEM("AttemptFails", TCP_MIB_ATTEMPTFAILS),
161         SNMP_MIB_ITEM("EstabResets", TCP_MIB_ESTABRESETS),
162         SNMP_MIB_ITEM("CurrEstab", TCP_MIB_CURRESTAB),
163         SNMP_MIB_ITEM("InSegs", TCP_MIB_INSEGS),
164         SNMP_MIB_ITEM("OutSegs", TCP_MIB_OUTSEGS),
165         SNMP_MIB_ITEM("RetransSegs", TCP_MIB_RETRANSSEGS),
166         SNMP_MIB_ITEM("InErrs", TCP_MIB_INERRS),
167         SNMP_MIB_ITEM("OutRsts", TCP_MIB_OUTRSTS),
168         SNMP_MIB_SENTINEL
169 };
170
171 static const struct snmp_mib snmp4_udp_list[] = {
172         SNMP_MIB_ITEM("InDatagrams", UDP_MIB_INDATAGRAMS),
173         SNMP_MIB_ITEM("NoPorts", UDP_MIB_NOPORTS),
174         SNMP_MIB_ITEM("InErrors", UDP_MIB_INERRORS),
175         SNMP_MIB_ITEM("OutDatagrams", UDP_MIB_OUTDATAGRAMS),
176         SNMP_MIB_ITEM("RcvbufErrors", UDP_MIB_RCVBUFERRORS),
177         SNMP_MIB_ITEM("SndbufErrors", UDP_MIB_SNDBUFERRORS),
178         SNMP_MIB_SENTINEL
179 };
180
181 static const struct snmp_mib snmp4_net_list[] = {
182         SNMP_MIB_ITEM("SyncookiesSent", LINUX_MIB_SYNCOOKIESSENT),
183         SNMP_MIB_ITEM("SyncookiesRecv", LINUX_MIB_SYNCOOKIESRECV),
184         SNMP_MIB_ITEM("SyncookiesFailed", LINUX_MIB_SYNCOOKIESFAILED),
185         SNMP_MIB_ITEM("EmbryonicRsts", LINUX_MIB_EMBRYONICRSTS),
186         SNMP_MIB_ITEM("PruneCalled", LINUX_MIB_PRUNECALLED),
187         SNMP_MIB_ITEM("RcvPruned", LINUX_MIB_RCVPRUNED),
188         SNMP_MIB_ITEM("OfoPruned", LINUX_MIB_OFOPRUNED),
189         SNMP_MIB_ITEM("OutOfWindowIcmps", LINUX_MIB_OUTOFWINDOWICMPS),
190         SNMP_MIB_ITEM("LockDroppedIcmps", LINUX_MIB_LOCKDROPPEDICMPS),
191         SNMP_MIB_ITEM("ArpFilter", LINUX_MIB_ARPFILTER),
192         SNMP_MIB_ITEM("TW", LINUX_MIB_TIMEWAITED),
193         SNMP_MIB_ITEM("TWRecycled", LINUX_MIB_TIMEWAITRECYCLED),
194         SNMP_MIB_ITEM("TWKilled", LINUX_MIB_TIMEWAITKILLED),
195         SNMP_MIB_ITEM("PAWSPassive", LINUX_MIB_PAWSPASSIVEREJECTED),
196         SNMP_MIB_ITEM("PAWSActive", LINUX_MIB_PAWSACTIVEREJECTED),
197         SNMP_MIB_ITEM("PAWSEstab", LINUX_MIB_PAWSESTABREJECTED),
198         SNMP_MIB_ITEM("DelayedACKs", LINUX_MIB_DELAYEDACKS),
199         SNMP_MIB_ITEM("DelayedACKLocked", LINUX_MIB_DELAYEDACKLOCKED),
200         SNMP_MIB_ITEM("DelayedACKLost", LINUX_MIB_DELAYEDACKLOST),
201         SNMP_MIB_ITEM("ListenOverflows", LINUX_MIB_LISTENOVERFLOWS),
202         SNMP_MIB_ITEM("ListenDrops", LINUX_MIB_LISTENDROPS),
203         SNMP_MIB_ITEM("TCPPrequeued", LINUX_MIB_TCPPREQUEUED),
204         SNMP_MIB_ITEM("TCPDirectCopyFromBacklog", LINUX_MIB_TCPDIRECTCOPYFROMBACKLOG),
205         SNMP_MIB_ITEM("TCPDirectCopyFromPrequeue", LINUX_MIB_TCPDIRECTCOPYFROMPREQUEUE),
206         SNMP_MIB_ITEM("TCPPrequeueDropped", LINUX_MIB_TCPPREQUEUEDROPPED),
207         SNMP_MIB_ITEM("TCPHPHits", LINUX_MIB_TCPHPHITS),
208         SNMP_MIB_ITEM("TCPHPHitsToUser", LINUX_MIB_TCPHPHITSTOUSER),
209         SNMP_MIB_ITEM("TCPPureAcks", LINUX_MIB_TCPPUREACKS),
210         SNMP_MIB_ITEM("TCPHPAcks", LINUX_MIB_TCPHPACKS),
211         SNMP_MIB_ITEM("TCPRenoRecovery", LINUX_MIB_TCPRENORECOVERY),
212         SNMP_MIB_ITEM("TCPSackRecovery", LINUX_MIB_TCPSACKRECOVERY),
213         SNMP_MIB_ITEM("TCPSACKReneging", LINUX_MIB_TCPSACKRENEGING),
214         SNMP_MIB_ITEM("TCPFACKReorder", LINUX_MIB_TCPFACKREORDER),
215         SNMP_MIB_ITEM("TCPSACKReorder", LINUX_MIB_TCPSACKREORDER),
216         SNMP_MIB_ITEM("TCPRenoReorder", LINUX_MIB_TCPRENOREORDER),
217         SNMP_MIB_ITEM("TCPTSReorder", LINUX_MIB_TCPTSREORDER),
218         SNMP_MIB_ITEM("TCPFullUndo", LINUX_MIB_TCPFULLUNDO),
219         SNMP_MIB_ITEM("TCPPartialUndo", LINUX_MIB_TCPPARTIALUNDO),
220         SNMP_MIB_ITEM("TCPDSACKUndo", LINUX_MIB_TCPDSACKUNDO),
221         SNMP_MIB_ITEM("TCPLossUndo", LINUX_MIB_TCPLOSSUNDO),
222         SNMP_MIB_ITEM("TCPLoss", LINUX_MIB_TCPLOSS),
223         SNMP_MIB_ITEM("TCPLostRetransmit", LINUX_MIB_TCPLOSTRETRANSMIT),
224         SNMP_MIB_ITEM("TCPRenoFailures", LINUX_MIB_TCPRENOFAILURES),
225         SNMP_MIB_ITEM("TCPSackFailures", LINUX_MIB_TCPSACKFAILURES),
226         SNMP_MIB_ITEM("TCPLossFailures", LINUX_MIB_TCPLOSSFAILURES),
227         SNMP_MIB_ITEM("TCPFastRetrans", LINUX_MIB_TCPFASTRETRANS),
228         SNMP_MIB_ITEM("TCPForwardRetrans", LINUX_MIB_TCPFORWARDRETRANS),
229         SNMP_MIB_ITEM("TCPSlowStartRetrans", LINUX_MIB_TCPSLOWSTARTRETRANS),
230         SNMP_MIB_ITEM("TCPTimeouts", LINUX_MIB_TCPTIMEOUTS),
231         SNMP_MIB_ITEM("TCPRenoRecoveryFail", LINUX_MIB_TCPRENORECOVERYFAIL),
232         SNMP_MIB_ITEM("TCPSackRecoveryFail", LINUX_MIB_TCPSACKRECOVERYFAIL),
233         SNMP_MIB_ITEM("TCPSchedulerFailed", LINUX_MIB_TCPSCHEDULERFAILED),
234         SNMP_MIB_ITEM("TCPRcvCollapsed", LINUX_MIB_TCPRCVCOLLAPSED),
235         SNMP_MIB_ITEM("TCPDSACKOldSent", LINUX_MIB_TCPDSACKOLDSENT),
236         SNMP_MIB_ITEM("TCPDSACKOfoSent", LINUX_MIB_TCPDSACKOFOSENT),
237         SNMP_MIB_ITEM("TCPDSACKRecv", LINUX_MIB_TCPDSACKRECV),
238         SNMP_MIB_ITEM("TCPDSACKOfoRecv", LINUX_MIB_TCPDSACKOFORECV),
239         SNMP_MIB_ITEM("TCPAbortOnSyn", LINUX_MIB_TCPABORTONSYN),
240         SNMP_MIB_ITEM("TCPAbortOnData", LINUX_MIB_TCPABORTONDATA),
241         SNMP_MIB_ITEM("TCPAbortOnClose", LINUX_MIB_TCPABORTONCLOSE),
242         SNMP_MIB_ITEM("TCPAbortOnMemory", LINUX_MIB_TCPABORTONMEMORY),
243         SNMP_MIB_ITEM("TCPAbortOnTimeout", LINUX_MIB_TCPABORTONTIMEOUT),
244         SNMP_MIB_ITEM("TCPAbortOnLinger", LINUX_MIB_TCPABORTONLINGER),
245         SNMP_MIB_ITEM("TCPAbortFailed", LINUX_MIB_TCPABORTFAILED),
246         SNMP_MIB_ITEM("TCPMemoryPressures", LINUX_MIB_TCPMEMORYPRESSURES),
247         SNMP_MIB_SENTINEL
248 };
249
250 /*
251  *      Called from the PROCfs module. This outputs /proc/net/snmp.
252  */
253 static int snmp_seq_show(struct seq_file *seq, void *v)
254 {
255         int i;
256
257         seq_puts(seq, "Ip: Forwarding DefaultTTL");
258
259         for (i = 0; snmp4_ipstats_list[i].name != NULL; i++)
260                 seq_printf(seq, " %s", snmp4_ipstats_list[i].name);
261
262         seq_printf(seq, "\nIp: %d %d",
263                         ipv4_devconf.forwarding ? 1 : 2, sysctl_ip_default_ttl);
264
265         for (i = 0; snmp4_ipstats_list[i].name != NULL; i++)
266                 seq_printf(seq, " %lu",
267                            fold_field((void **) ip_statistics, 
268                                       snmp4_ipstats_list[i].entry));
269
270         seq_puts(seq, "\nIcmp:");
271         for (i = 0; snmp4_icmp_list[i].name != NULL; i++)
272                 seq_printf(seq, " %s", snmp4_icmp_list[i].name);
273
274         seq_puts(seq, "\nIcmp:");
275         for (i = 0; snmp4_icmp_list[i].name != NULL; i++)
276                 seq_printf(seq, " %lu",
277                            fold_field((void **) icmp_statistics, 
278                                       snmp4_icmp_list[i].entry));
279
280         seq_puts(seq, "\nTcp:");
281         for (i = 0; snmp4_tcp_list[i].name != NULL; i++)
282                 seq_printf(seq, " %s", snmp4_tcp_list[i].name);
283
284         seq_puts(seq, "\nTcp:");
285         for (i = 0; snmp4_tcp_list[i].name != NULL; i++) {
286                 /* MaxConn field is signed, RFC 2012 */
287                 if (snmp4_tcp_list[i].entry == TCP_MIB_MAXCONN)
288                         seq_printf(seq, " %ld",
289                                    fold_field((void **) tcp_statistics, 
290                                               snmp4_tcp_list[i].entry));
291                 else
292                         seq_printf(seq, " %lu",
293                                    fold_field((void **) tcp_statistics,
294                                               snmp4_tcp_list[i].entry));
295         }
296
297         seq_puts(seq, "\nUdp:");
298         for (i = 0; snmp4_udp_list[i].name != NULL; i++)
299                 seq_printf(seq, " %s", snmp4_udp_list[i].name);
300
301         seq_puts(seq, "\nUdp:");
302         for (i = 0; snmp4_udp_list[i].name != NULL; i++)
303                 seq_printf(seq, " %lu",
304                            fold_field((void **) udp_statistics, 
305                                       snmp4_udp_list[i].entry));
306
307         seq_putc(seq, '\n');
308         return 0;
309 }
310
311 static int snmp_seq_open(struct inode *inode, struct file *file)
312 {
313         return single_open(file, snmp_seq_show, NULL);
314 }
315
316 static struct file_operations snmp_seq_fops = {
317         .owner   = THIS_MODULE,
318         .open    = snmp_seq_open,
319         .read    = seq_read,
320         .llseek  = seq_lseek,
321         .release = single_release,
322 };
323
324 /*
325  *      Output /proc/net/netstat
326  */
327 static int netstat_seq_show(struct seq_file *seq, void *v)
328 {
329         int i;
330
331         seq_puts(seq, "TcpExt:");
332         for (i = 0; snmp4_net_list[i].name != NULL; i++)
333                 seq_printf(seq, " %s", snmp4_net_list[i].name);
334
335         seq_puts(seq, "\nTcpExt:");
336         for (i = 0; snmp4_net_list[i].name != NULL; i++)
337                 seq_printf(seq, " %lu",
338                            fold_field((void **) net_statistics, 
339                                       snmp4_net_list[i].entry));
340
341         seq_putc(seq, '\n');
342         return 0;
343 }
344
345 static int netstat_seq_open(struct inode *inode, struct file *file)
346 {
347         return single_open(file, netstat_seq_show, NULL);
348 }
349
350 static struct file_operations netstat_seq_fops = {
351         .owner   = THIS_MODULE,
352         .open    = netstat_seq_open,
353         .read    = seq_read,
354         .llseek  = seq_lseek,
355         .release = single_release,
356 };
357
358 int __init ip_misc_proc_init(void)
359 {
360         int rc = 0;
361
362         if (!proc_net_fops_create("netstat", S_IRUGO, &netstat_seq_fops))
363                 goto out_netstat;
364
365         if (!proc_net_fops_create("snmp", S_IRUGO, &snmp_seq_fops))
366                 goto out_snmp;
367
368         if (!proc_net_fops_create("sockstat", S_IRUGO, &sockstat_seq_fops))
369                 goto out_sockstat;
370 out:
371         return rc;
372 out_sockstat:
373         proc_net_remove("snmp");
374 out_snmp:
375         proc_net_remove("netstat");
376 out_netstat:
377         rc = -ENOMEM;
378         goto out;
379 }
380