aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/sysctl/net.txt
diff options
context:
space:
mode:
authorShen Feng <shen@cn.fujitsu.com>2009-04-02 19:57:20 -0400
committerLinus Torvalds <torvalds@linux-foundation.org>2009-04-02 22:04:53 -0400
commit760df93ecdd59fc1c213a491b5adee79f53606da (patch)
tree305a4e0fae43549eb24a3ebcf9bcc15a16ef2138 /Documentation/sysctl/net.txt
parent70eed8d06601ca3810a0e56035eae6496d57856b (diff)
documentation: update Documentation/filesystem/proc.txt and Documentation/sysctls
Now /proc/sys is described in many places and much information is redundant. This patch updates the proc.txt and move the /proc/sys desciption out to the files in Documentation/sysctls. Details are: merge - 2.1 /proc/sys/fs - File system data - 2.11 /proc/sys/fs/mqueue - POSIX message queues filesystem - 2.17 /proc/sys/fs/epoll - Configuration options for the epoll interface with Documentation/sysctls/fs.txt. remove - 2.2 /proc/sys/fs/binfmt_misc - Miscellaneous binary formats since it's not better then the Documentation/binfmt_misc.txt. merge - 2.3 /proc/sys/kernel - general kernel parameters with Documentation/sysctls/kernel.txt remove - 2.5 /proc/sys/dev - Device specific parameters since it's obsolete the sysfs is used now. remove - 2.6 /proc/sys/sunrpc - Remote procedure calls since it's not better then the Documentation/sysctls/sunrpc.txt move - 2.7 /proc/sys/net - Networking stuff - 2.9 Appletalk - 2.10 IPX to newly created Documentation/sysctls/net.txt. remove - 2.8 /proc/sys/net/ipv4 - IPV4 settings since it's not better then the Documentation/networking/ip-sysctl.txt. add - Chapter 3 Per-Process Parameters to descibe /proc/<pid>/xxx parameters. Signed-off-by: Shen Feng <shen@cn.fujitsu.com> Cc: Randy Dunlap <randy.dunlap@oracle.com> Cc: "David S. Miller" <davem@davemloft.net> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Diffstat (limited to 'Documentation/sysctl/net.txt')
-rw-r--r--Documentation/sysctl/net.txt174
1 files changed, 174 insertions, 0 deletions
diff --git a/Documentation/sysctl/net.txt b/Documentation/sysctl/net.txt
new file mode 100644
index 000000000000..995c2257b3e7
--- /dev/null
+++ b/Documentation/sysctl/net.txt
@@ -0,0 +1,174 @@
1Documentation for /proc/sys/net/* kernel version 2.4.0-test11-pre4
2 (c) 1999 Terrehon Bowden <terrehon@pacbell.net>
3 Bodo Bauer <bb@ricochet.net>
4 (c) 2000 Jorge Nerin <comandante@zaralinux.com>
5 (c) 2009 Shen Feng <shen@cn.fujitsu.com>
6
7For general info and legal blurb, please look in README.
8
9==============================================================
10
11This file contains the documentation for the sysctl files in
12/proc/sys/net and is valid for Linux kernel version 2.4.0-test11-pre4.
13
14The interface to the networking parts of the kernel is located in
15/proc/sys/net. The following table shows all possible subdirectories.You may
16see only some of them, depending on your kernel's configuration.
17
18
19Table : Subdirectories in /proc/sys/net
20..............................................................................
21 Directory Content Directory Content
22 core General parameter appletalk Appletalk protocol
23 unix Unix domain sockets netrom NET/ROM
24 802 E802 protocol ax25 AX25
25 ethernet Ethernet protocol rose X.25 PLP layer
26 ipv4 IP version 4 x25 X.25 protocol
27 ipx IPX token-ring IBM token ring
28 bridge Bridging decnet DEC net
29 ipv6 IP version 6
30..............................................................................
31
321. /proc/sys/net/core - Network core options
33-------------------------------------------------------
34
35rmem_default
36------------
37
38The default setting of the socket receive buffer in bytes.
39
40rmem_max
41--------
42
43The maximum receive socket buffer size in bytes.
44
45wmem_default
46------------
47
48The default setting (in bytes) of the socket send buffer.
49
50wmem_max
51--------
52
53The maximum send socket buffer size in bytes.
54
55message_burst and message_cost
56------------------------------
57
58These parameters are used to limit the warning messages written to the kernel
59log from the networking code. They enforce a rate limit to make a
60denial-of-service attack impossible. A higher message_cost factor, results in
61fewer messages that will be written. Message_burst controls when messages will
62be dropped. The default settings limit warning messages to one every five
63seconds.
64
65warnings
66--------
67
68This controls console messages from the networking stack that can occur because
69of problems on the network like duplicate address or bad checksums. Normally,
70this should be enabled, but if the problem persists the messages can be
71disabled.
72
73netdev_budget
74-------------
75
76Maximum number of packets taken from all interfaces in one polling cycle (NAPI
77poll). In one polling cycle interfaces which are registered to polling are
78probed in a round-robin manner. The limit of packets in one such probe can be
79set per-device via sysfs class/net/<device>/weight .
80
81netdev_max_backlog
82------------------
83
84Maximum number of packets, queued on the INPUT side, when the interface
85receives packets faster than kernel can process them.
86
87optmem_max
88----------
89
90Maximum ancillary buffer size allowed per socket. Ancillary data is a sequence
91of struct cmsghdr structures with appended data.
92
932. /proc/sys/net/unix - Parameters for Unix domain sockets
94-------------------------------------------------------
95
96There are only two files in this subdirectory. They control the delays for
97deleting and destroying socket descriptors.
98
99
1003. /proc/sys/net/ipv4 - IPV4 settings
101-------------------------------------------------------
102Please see: Documentation/networking/ip-sysctl.txt and ipvs-sysctl.txt for
103descriptions of these entries.
104
105
1064. Appletalk
107-------------------------------------------------------
108
109The /proc/sys/net/appletalk directory holds the Appletalk configuration data
110when Appletalk is loaded. The configurable parameters are:
111
112aarp-expiry-time
113----------------
114
115The amount of time we keep an ARP entry before expiring it. Used to age out
116old hosts.
117
118aarp-resolve-time
119-----------------
120
121The amount of time we will spend trying to resolve an Appletalk address.
122
123aarp-retransmit-limit
124---------------------
125
126The number of times we will retransmit a query before giving up.
127
128aarp-tick-time
129--------------
130
131Controls the rate at which expires are checked.
132
133The directory /proc/net/appletalk holds the list of active Appletalk sockets
134on a machine.
135
136The fields indicate the DDP type, the local address (in network:node format)
137the remote address, the size of the transmit pending queue, the size of the
138received queue (bytes waiting for applications to read) the state and the uid
139owning the socket.
140
141/proc/net/atalk_iface lists all the interfaces configured for appletalk.It
142shows the name of the interface, its Appletalk address, the network range on
143that address (or network number for phase 1 networks), and the status of the
144interface.
145
146/proc/net/atalk_route lists each known network route. It lists the target
147(network) that the route leads to, the router (may be directly connected), the
148route flags, and the device the route is using.
149
150
1515. IPX
152-------------------------------------------------------
153
154The IPX protocol has no tunable values in proc/sys/net.
155
156The IPX protocol does, however, provide proc/net/ipx. This lists each IPX
157socket giving the local and remote addresses in Novell format (that is
158network:node:port). In accordance with the strange Novell tradition,
159everything but the port is in hex. Not_Connected is displayed for sockets that
160are not tied to a specific remote address. The Tx and Rx queue sizes indicate
161the number of bytes pending for transmission and reception. The state
162indicates the state the socket is in and the uid is the owning uid of the
163socket.
164
165The /proc/net/ipx_interface file lists all IPX interfaces. For each interface
166it gives the network number, the node number, and indicates if the network is
167the primary network. It also indicates which device it is bound to (or
168Internal for internal networks) and the Frame Type if appropriate. Linux
169supports 802.3, 802.2, 802.2 SNAP and DIX (Blue Book) ethernet framing for
170IPX.
171
172The /proc/net/ipx_route table holds a list of IPX routes. For each route it
173gives the destination network, the router node (or Directly) and the network
174address of the router (or Connected) for internal networks.