Documentation/admin-guide/sysctl/net.rst

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