Documentation/sysctl/net.txt

   1 Documentation for /proc/sys/net/*
   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
   7 For general info and legal blurb, please look in README.
   8
   9 ==============================================================
  10
  11 This file contains the documentation for the sysctl files in
  12 /proc/sys/net
  13
  14 The interface  to  the  networking  parts  of  the  kernel  is  located  in
  15 /proc/sys/net. The following table shows all possible subdirectories.  You may
  16 see only some of them, depending on your kernel's configuration.
  17
  18
  19 Table : 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        tipc       TIPC
  30 ..............................................................................
  31
  32 1. /proc/sys/net/core - Network core options
  33 -------------------------------------------------------
  34
  35 bpf_jit_enable
  36 --------------
  37
  38 This enables the BPF Just in Time (JIT) compiler. BPF is a flexible
  39 and efficient infrastructure allowing to execute bytecode at various
  40 hook points. It is used in a number of Linux kernel subsystems such
  41 as networking (e.g. XDP, tc), tracing (e.g. kprobes, uprobes, tracepoints)
  42 and security (e.g. seccomp). LLVM has a BPF back end that can compile
  43 restricted C into a sequence of BPF instructions. After program load
  44 through bpf(2) and passing a verifier in the kernel, a JIT will then
  45 translate these BPF proglets into native CPU instructions. There are
  46 two flavors of JITs, the newer eBPF JIT currently supported on:
  47   - x86_64
  48   - x86_32
  49   - arm64
  50   - arm32
  51   - ppc64
  52   - sparc64
  53   - mips64
  54   - s390x
  55   - riscv
  56
  57 And the older cBPF JIT supported on the following archs:
  58   - mips
  59   - ppc
  60   - sparc
  61
  62 eBPF JITs are a superset of cBPF JITs, meaning the kernel will
  63 migrate cBPF instructions into eBPF instructions and then JIT
  64 compile them transparently. Older cBPF JITs can only translate
  65 tcpdump filters, seccomp rules, etc, but not mentioned eBPF
  66 programs loaded through bpf(2).
  67
  68 Values :
  69         0 - disable the JIT (default value)
  70         1 - enable the JIT
  71         2 - enable the JIT and ask the compiler to emit traces on kernel log.
  72
  73 bpf_jit_harden
  74 --------------
  75
  76 This enables hardening for the BPF JIT compiler. Supported are eBPF
  77 JIT backends. Enabling hardening trades off performance, but can
  78 mitigate JIT spraying.
  79 Values :
  80         0 - disable JIT hardening (default value)
  81         1 - enable JIT hardening for unprivileged users only
  82         2 - enable JIT hardening for all users
  83
  84 bpf_jit_kallsyms
  85 ----------------
  86
  87 When BPF JIT compiler is enabled, then compiled images are unknown
  88 addresses to the kernel, meaning they neither show up in traces nor
  89 in /proc/kallsyms. This enables export of these addresses, which can
  90 be used for debugging/tracing. If bpf_jit_harden is enabled, this
  91 feature is disabled.
  92 Values :
  93         0 - disable JIT kallsyms export (default value)
  94         1 - enable JIT kallsyms export for privileged users only
  95
  96 bpf_jit_limit
  97 -------------
  98
  99 This enforces a global limit for memory allocations to the BPF JIT
 100 compiler in order to reject unprivileged JIT requests once it has
 101 been surpassed. bpf_jit_limit contains the value of the global limit
 102 in bytes.
 103
 104 dev_weight
 105 --------------
 106
 107 The maximum number of packets that kernel can handle on a NAPI interrupt,
 108 it's a Per-CPU variable. For drivers that support LRO or GRO_HW, a hardware
 109 aggregated packet is counted as one packet in this context.
 110
 111 Default: 64
 112
 113 dev_weight_rx_bias
 114 --------------
 115
 116 RPS (e.g. RFS, aRFS) processing is competing with the registered NAPI poll function
 117 of the driver for the per softirq cycle netdev_budget. This parameter influences
 118 the proportion of the configured netdev_budget that is spent on RPS based packet
 119 processing during RX softirq cycles. It is further meant for making current
 120 dev_weight adaptable for asymmetric CPU needs on RX/TX side of the network stack.
 121 (see dev_weight_tx_bias) It is effective on a per CPU basis. Determination is based
 122 on dev_weight and is calculated multiplicative (dev_weight * dev_weight_rx_bias).
 123 Default: 1
 124
 125 dev_weight_tx_bias
 126 --------------
 127
 128 Scales the maximum number of packets that can be processed during a TX softirq cycle.
 129 Effective on a per CPU basis. Allows scaling of current dev_weight for asymmetric
 130 net stack processing needs. Be careful to avoid making TX softirq processing a CPU hog.
 131 Calculation is based on dev_weight (dev_weight * dev_weight_tx_bias).
 132 Default: 1
 133
 134 default_qdisc
 135 --------------
 136
 137 The default queuing discipline to use for network devices. This allows
 138 overriding the default of pfifo_fast with an alternative. Since the default
 139 queuing discipline is created without additional parameters so is best suited
 140 to queuing disciplines that work well without configuration like stochastic
 141 fair queue (sfq), CoDel (codel) or fair queue CoDel (fq_codel). Don't use
 142 queuing disciplines like Hierarchical Token Bucket or Deficit Round Robin
 143 which require setting up classes and bandwidths. Note that physical multiqueue
 144 interfaces still use mq as root qdisc, which in turn uses this default for its
 145 leaves. Virtual devices (like e.g. lo or veth) ignore this setting and instead
 146 default to noqueue.
 147 Default: pfifo_fast
 148
 149 busy_read
 150 ----------------
 151 Low latency busy poll timeout for socket reads. (needs CONFIG_NET_RX_BUSY_POLL)
 152 Approximate time in us to busy loop waiting for packets on the device queue.
 153 This sets the default value of the SO_BUSY_POLL socket option.
 154 Can be set or overridden per socket by setting socket option SO_BUSY_POLL,
 155 which is the preferred method of enabling. If you need to enable the feature
 156 globally via sysctl, a value of 50 is recommended.
 157 Will increase power usage.
 158 Default: 0 (off)
 159
 160 busy_poll
 161 ----------------
 162 Low latency busy poll timeout for poll and select. (needs CONFIG_NET_RX_BUSY_POLL)
 163 Approximate time in us to busy loop waiting for events.
 164 Recommended value depends on the number of sockets you poll on.
 165 For several sockets 50, for several hundreds 100.
 166 For more than that you probably want to use epoll.
 167 Note that only sockets with SO_BUSY_POLL set will be busy polled,
 168 so you want to either selectively set SO_BUSY_POLL on those sockets or set
 169 sysctl.net.busy_read globally.
 170 Will increase power usage.
 171 Default: 0 (off)
 172
 173 rmem_default
 174 ------------
 175
 176 The default setting of the socket receive buffer in bytes.
 177
 178 rmem_max
 179 --------
 180
 181 The maximum receive socket buffer size in bytes.
 182
 183 tstamp_allow_data
 184 -----------------
 185 Allow processes to receive tx timestamps looped together with the original
 186 packet contents. If disabled, transmit timestamp requests from unprivileged
 187 processes are dropped unless socket option SOF_TIMESTAMPING_OPT_TSONLY is set.
 188 Default: 1 (on)
 189
 190
 191 wmem_default
 192 ------------
 193
 194 The default setting (in bytes) of the socket send buffer.
 195
 196 wmem_max
 197 --------
 198
 199 The maximum send socket buffer size in bytes.
 200
 201 message_burst and message_cost
 202 ------------------------------
 203
 204 These parameters  are used to limit the warning messages written to the kernel
 205 log from  the  networking  code.  They  enforce  a  rate  limit  to  make  a
 206 denial-of-service attack  impossible. A higher message_cost factor, results in
 207 fewer messages that will be written. Message_burst controls when messages will
 208 be dropped.  The  default  settings  limit  warning messages to one every five
 209 seconds.
 210
 211 warnings
 212 --------
 213
 214 This sysctl is now unused.
 215
 216 This was used to control console messages from the networking stack that
 217 occur because of problems on the network like duplicate address or bad
 218 checksums.
 219
 220 These messages are now emitted at KERN_DEBUG and can generally be enabled
 221 and controlled by the dynamic_debug facility.
 222
 223 netdev_budget
 224 -------------
 225
 226 Maximum number of packets taken from all interfaces in one polling cycle (NAPI
 227 poll). In one polling cycle interfaces which are registered to polling are
 228 probed in a round-robin manner. Also, a polling cycle may not exceed
 229 netdev_budget_usecs microseconds, even if netdev_budget has not been
 230 exhausted.
 231
 232 netdev_budget_usecs
 233 ---------------------
 234
 235 Maximum number of microseconds in one NAPI polling cycle. Polling
 236 will exit when either netdev_budget_usecs have elapsed during the
 237 poll cycle or the number of packets processed reaches netdev_budget.
 238
 239 netdev_max_backlog
 240 ------------------
 241
 242 Maximum number  of  packets,  queued  on  the  INPUT  side, when the interface
 243 receives packets faster than kernel can process them.
 244
 245 netdev_rss_key
 246 --------------
 247
 248 RSS (Receive Side Scaling) enabled drivers use a 40 bytes host key that is
 249 randomly generated.
 250 Some user space might need to gather its content even if drivers do not
 251 provide ethtool -x support yet.
 252
 253 myhost:~# cat /proc/sys/net/core/netdev_rss_key
 254 84:50:f4:00:a8:15:d1:a7:e9:7f:1d:60:35:c7:47:25:42:97:74:ca:56:bb:b6:a1:d8: ... (52 bytes total)
 255
 256 File contains nul bytes if no driver ever called netdev_rss_key_fill() function.
 257 Note:
 258 /proc/sys/net/core/netdev_rss_key contains 52 bytes of key,
 259 but most drivers only use 40 bytes of it.
 260
 261 myhost:~# ethtool -x eth0
 262 RX flow hash indirection table for eth0 with 8 RX ring(s):
 263     0:    0     1     2     3     4     5     6     7
 264 RSS hash key:
 265 84:50:f4:00:a8:15:d1:a7:e9:7f:1d:60:35:c7:47:25:42:97:74:ca:56:bb:b6:a1:d8:43:e3:c9:0c:fd:17:55:c2:3a:4d:69:ed:f1:42:89
 266
 267 netdev_tstamp_prequeue
 268 ----------------------
 269
 270 If set to 0, RX packet timestamps can be sampled after RPS processing, when
 271 the target CPU processes packets. It might give some delay on timestamps, but
 272 permit to distribute the load on several cpus.
 273
 274 If set to 1 (default), timestamps are sampled as soon as possible, before
 275 queueing.
 276
 277 optmem_max
 278 ----------
 279
 280 Maximum ancillary buffer size allowed per socket. Ancillary data is a sequence
 281 of struct cmsghdr structures with appended data.
 282
 283 fb_tunnels_only_for_init_net
 284 ----------------------------
 285
 286 Controls if fallback tunnels (like tunl0, gre0, gretap0, erspan0,
 287 sit0, ip6tnl0, ip6gre0) are automatically created when a new
 288 network namespace is created, if corresponding tunnel is present
 289 in initial network namespace.
 290 If set to 1, these devices are not automatically created, and
 291 user space is responsible for creating them if needed.
 292
 293 Default : 0  (for compatibility reasons)
 294
 295 devconf_inherit_init_net
 296 ----------------------------
 297
 298 Controls if a new network namespace should inherit all current
 299 settings under /proc/sys/net/{ipv4,ipv6}/conf/{all,default}/. By
 300 default, we keep the current behavior: for IPv4 we inherit all current
 301 settings from init_net and for IPv6 we reset all settings to default.
 302
 303 If set to 1, both IPv4 and IPv6 settings are forced to inherit from
 304 current ones in init_net. If set to 2, both IPv4 and IPv6 settings are
 305 forced to reset to their default values.
 306
 307 Default : 0  (for compatibility reasons)
 308
 309 2. /proc/sys/net/unix - Parameters for Unix domain sockets
 310 -------------------------------------------------------
 311
 312 There is only one file in this directory.
 313 unix_dgram_qlen limits the max number of datagrams queued in Unix domain
 314 socket's buffer. It will not take effect unless PF_UNIX flag is specified.
 315
 316
 317 3. /proc/sys/net/ipv4 - IPV4 settings
 318 -------------------------------------------------------
 319 Please see: Documentation/networking/ip-sysctl.txt and ipvs-sysctl.txt for
 320 descriptions of these entries.
 321
 322
 323 4. Appletalk
 324 -------------------------------------------------------
 325
 326 The /proc/sys/net/appletalk  directory  holds the Appletalk configuration data
 327 when Appletalk is loaded. The configurable parameters are:
 328
 329 aarp-expiry-time
 330 ----------------
 331
 332 The amount  of  time  we keep an ARP entry before expiring it. Used to age out
 333 old hosts.
 334
 335 aarp-resolve-time
 336 -----------------
 337
 338 The amount of time we will spend trying to resolve an Appletalk address.
 339
 340 aarp-retransmit-limit
 341 ---------------------
 342
 343 The number of times we will retransmit a query before giving up.
 344
 345 aarp-tick-time
 346 --------------
 347
 348 Controls the rate at which expires are checked.
 349
 350 The directory  /proc/net/appletalk  holds the list of active Appletalk sockets
 351 on a machine.
 352
 353 The fields  indicate  the DDP type, the local address (in network:node format)
 354 the remote  address,  the  size of the transmit pending queue, the size of the
 355 received queue  (bytes waiting for applications to read) the state and the uid
 356 owning the socket.
 357
 358 /proc/net/atalk_iface lists  all  the  interfaces  configured for appletalk.It
 359 shows the  name  of the interface, its Appletalk address, the network range on
 360 that address  (or  network number for phase 1 networks), and the status of the
 361 interface.
 362
 363 /proc/net/atalk_route lists  each  known  network  route.  It lists the target
 364 (network) that the route leads to, the router (may be directly connected), the
 365 route flags, and the device the route is using.
 366
 367
 368 5. IPX
 369 -------------------------------------------------------
 370
 371 The IPX protocol has no tunable values in proc/sys/net.
 372
 373 The IPX  protocol  does,  however,  provide  proc/net/ipx. This lists each IPX
 374 socket giving  the  local  and  remote  addresses  in  Novell  format (that is
 375 network:node:port). In  accordance  with  the  strange  Novell  tradition,
 376 everything but the port is in hex. Not_Connected is displayed for sockets that
 377 are not  tied to a specific remote address. The Tx and Rx queue sizes indicate
 378 the number  of  bytes  pending  for  transmission  and  reception.  The  state
 379 indicates the  state  the  socket  is  in and the uid is the owning uid of the
 380 socket.
 381
 382 The /proc/net/ipx_interface  file lists all IPX interfaces. For each interface
 383 it gives  the network number, the node number, and indicates if the network is
 384 the primary  network.  It  also  indicates  which  device  it  is bound to (or
 385 Internal for  internal  networks)  and  the  Frame  Type if appropriate. Linux
 386 supports 802.3,  802.2,  802.2  SNAP  and DIX (Blue Book) ethernet framing for
 387 IPX.
 388
 389 The /proc/net/ipx_route  table  holds  a list of IPX routes. For each route it
 390 gives the  destination  network, the router node (or Directly) and the network
 391 address of the router (or Connected) for internal networks.
 392
 393 6. TIPC
 394 -------------------------------------------------------
 395
 396 tipc_rmem
 397 ----------
 398
 399 The TIPC protocol now has a tunable for the receive memory, similar to the
 400 tcp_rmem - i.e. a vector of 3 INTEGERs: (min, default, max)
 401
 402     # cat /proc/sys/net/tipc/tipc_rmem
 403     4252725 34021800        68043600
 404     #
 405
 406 The max value is set to CONN_OVERLOAD_LIMIT, and the default and min values
 407 are scaled (shifted) versions of that same value.  Note that the min value
 408 is not at this point in time used in any meaningful way, but the triplet is
 409 preserved in order to be consistent with things like tcp_rmem.
 410
 411 named_timeout
 412 --------------
 413
 414 TIPC name table updates are distributed asynchronously in a cluster, without
 415 any form of transaction handling. This means that different race scenarios are
 416 possible. One such is that a name withdrawal sent out by one node and received
 417 by another node may arrive after a second, overlapping name publication already
 418 has been accepted from a third node, although the conflicting updates
 419 originally may have been issued in the correct sequential order.
 420 If named_timeout is nonzero, failed topology updates will be placed on a defer
 421 queue until another event arrives that clears the error, or until the timeout
 422 expires. Value is in milliseconds.