Documentation/networking/operstates.rst

   1 .. SPDX-License-Identifier: GPL-2.0
   2
   3 ==================
   4 Operational States
   5 ==================
   6
   7
   8 1. Introduction
   9 ===============
  10
  11 Linux distinguishes between administrative and operational state of an
  12 interface. Administrative state is the result of "ip link set dev
  13 <dev> up or down" and reflects whether the administrator wants to use
  14 the device for traffic.
  15
  16 However, an interface is not usable just because the admin enabled it
  17 - ethernet requires to be plugged into the switch and, depending on
  18 a site's networking policy and configuration, an 802.1X authentication
  19 to be performed before user data can be transferred. Operational state
  20 shows the ability of an interface to transmit this user data.
  21
  22 Thanks to 802.1X, userspace must be granted the possibility to
  23 influence operational state. To accommodate this, operational state is
  24 split into two parts: Two flags that can be set by the driver only, and
  25 a RFC2863 compatible state that is derived from these flags, a policy,
  26 and changeable from userspace under certain rules.
  27
  28
  29 2. Querying from userspace
  30 ==========================
  31
  32 Both admin and operational state can be queried via the netlink
  33 operation RTM_GETLINK. It is also possible to subscribe to RTNLGRP_LINK
  34 to be notified of updates while the interface is admin up. This is
  35 important for setting from userspace.
  36
  37 These values contain interface state:
  38
  39 ifinfomsg::if_flags & IFF_UP:
  40  Interface is admin up
  41
  42 ifinfomsg::if_flags & IFF_RUNNING:
  43  Interface is in RFC2863 operational state UP or UNKNOWN. This is for
  44  backward compatibility, routing daemons, dhcp clients can use this
  45  flag to determine whether they should use the interface.
  46
  47 ifinfomsg::if_flags & IFF_LOWER_UP:
  48  Driver has signaled netif_carrier_on()
  49
  50 ifinfomsg::if_flags & IFF_DORMANT:
  51  Driver has signaled netif_dormant_on()
  52
  53 TLV IFLA_OPERSTATE
  54 ------------------
  55
  56 contains RFC2863 state of the interface in numeric representation:
  57
  58 IF_OPER_UNKNOWN (0):
  59  Interface is in unknown state, neither driver nor userspace has set
  60  operational state. Interface must be considered for user data as
  61  setting operational state has not been implemented in every driver.
  62
  63 IF_OPER_NOTPRESENT (1):
  64  Unused in current kernel (notpresent interfaces normally disappear),
  65  just a numerical placeholder.
  66
  67 IF_OPER_DOWN (2):
  68  Interface is unable to transfer data on L1, f.e. ethernet is not
  69  plugged or interface is ADMIN down.
  70
  71 IF_OPER_LOWERLAYERDOWN (3):
  72  Interfaces stacked on an interface that is IF_OPER_DOWN show this
  73  state (f.e. VLAN).
  74
  75 IF_OPER_TESTING (4):
  76  Unused in current kernel.
  77
  78 IF_OPER_DORMANT (5):
  79  Interface is L1 up, but waiting for an external event, f.e. for a
  80  protocol to establish. (802.1X)
  81
  82 IF_OPER_UP (6):
  83  Interface is operational up and can be used.
  84
  85 This TLV can also be queried via sysfs.
  86
  87 TLV IFLA_LINKMODE
  88 -----------------
  89
  90 contains link policy. This is needed for userspace interaction
  91 described below.
  92
  93 This TLV can also be queried via sysfs.
  94
  95
  96 3. Kernel driver API
  97 ====================
  98
  99 Kernel drivers have access to two flags that map to IFF_LOWER_UP and
 100 IFF_DORMANT. These flags can be set from everywhere, even from
 101 interrupts. It is guaranteed that only the driver has write access,
 102 however, if different layers of the driver manipulate the same flag,
 103 the driver has to provide the synchronisation needed.
 104
 105 __LINK_STATE_NOCARRIER, maps to !IFF_LOWER_UP:
 106
 107 The driver uses netif_carrier_on() to clear and netif_carrier_off() to
 108 set this flag. On netif_carrier_off(), the scheduler stops sending
 109 packets. The name 'carrier' and the inversion are historical, think of
 110 it as lower layer.
 111
 112 Note that for certain kind of soft-devices, which are not managing any
 113 real hardware, it is possible to set this bit from userspace.  One
 114 should use TVL IFLA_CARRIER to do so.
 115
 116 netif_carrier_ok() can be used to query that bit.
 117
 118 __LINK_STATE_DORMANT, maps to IFF_DORMANT:
 119
 120 Set by the driver to express that the device cannot yet be used
 121 because some driver controlled protocol establishment has to
 122 complete. Corresponding functions are netif_dormant_on() to set the
 123 flag, netif_dormant_off() to clear it and netif_dormant() to query.
 124
 125 On device allocation, both flags __LINK_STATE_NOCARRIER and
 126 __LINK_STATE_DORMANT are cleared, so the effective state is equivalent
 127 to netif_carrier_ok() and !netif_dormant().
 128
 129
 130 Whenever the driver CHANGES one of these flags, a workqueue event is
 131 scheduled to translate the flag combination to IFLA_OPERSTATE as
 132 follows:
 133
 134 !netif_carrier_ok():
 135  IF_OPER_LOWERLAYERDOWN if the interface is stacked, IF_OPER_DOWN
 136  otherwise. Kernel can recognise stacked interfaces because their
 137  ifindex != iflink.
 138
 139 netif_carrier_ok() && netif_dormant():
 140  IF_OPER_DORMANT
 141
 142 netif_carrier_ok() && !netif_dormant():
 143  IF_OPER_UP if userspace interaction is disabled. Otherwise
 144  IF_OPER_DORMANT with the possibility for userspace to initiate the
 145  IF_OPER_UP transition afterwards.
 146
 147
 148 4. Setting from userspace
 149 =========================
 150
 151 Applications have to use the netlink interface to influence the
 152 RFC2863 operational state of an interface. Setting IFLA_LINKMODE to 1
 153 via RTM_SETLINK instructs the kernel that an interface should go to
 154 IF_OPER_DORMANT instead of IF_OPER_UP when the combination
 155 netif_carrier_ok() && !netif_dormant() is set by the
 156 driver. Afterwards, the userspace application can set IFLA_OPERSTATE
 157 to IF_OPER_DORMANT or IF_OPER_UP as long as the driver does not set
 158 netif_carrier_off() or netif_dormant_on(). Changes made by userspace
 159 are multicasted on the netlink group RTNLGRP_LINK.
 160
 161 So basically a 802.1X supplicant interacts with the kernel like this:
 162
 163 - subscribe to RTNLGRP_LINK
 164 - set IFLA_LINKMODE to 1 via RTM_SETLINK
 165 - query RTM_GETLINK once to get initial state
 166 - if initial flags are not (IFF_LOWER_UP && !IFF_DORMANT), wait until
 167   netlink multicast signals this state
 168 - do 802.1X, eventually abort if flags go down again
 169 - send RTM_SETLINK to set operstate to IF_OPER_UP if authentication
 170   succeeds, IF_OPER_DORMANT otherwise
 171 - see how operstate and IFF_RUNNING is echoed via netlink multicast
 172 - set interface back to IF_OPER_DORMANT if 802.1X reauthentication
 173   fails
 174 - restart if kernel changes IFF_LOWER_UP or IFF_DORMANT flag
 175
 176 if supplicant goes down, bring back IFLA_LINKMODE to 0 and
 177 IFLA_OPERSTATE to a sane value.
 178
 179 A routing daemon or dhcp client just needs to care for IFF_RUNNING or
 180 waiting for operstate to go IF_OPER_UP/IF_OPER_UNKNOWN before
 181 considering the interface / querying a DHCP address.
 182
 183
 184 For technical questions and/or comments please e-mail to Stefan Rompf
 185 (stefan at loplof.de).