share/man/man4/bridge.4

   1 .\"
   2 .\" $FreeBSD: src/share/man/man4/bridge.4,v 1.6.2.11 2002/02/18 02:00:21 luigi Exp $
   3 .\" $DragonFly: src/share/man/man4/bridge.4,v 1.2 2003/06/17 04:36:58 dillon Exp $
   4 .\"
   5 .Dd February 15, 2002
   6 .Dt BRIDGE 4
   7 .Os
   8 .Sh NAME
   9 .Nm bridge
  10 .Nd bridging support
  11 .Sh SYNOPSIS
  12 .Cd "options BRIDGE"
  13 .Cd kldload /modules/bridge.ko
  14 .Sh DESCRIPTION
  15 .Fx
  16 supports bridging on Ethernet-type interfaces, including VLANs.
  17 Bridging support can be either compiled into the kernel, or loaded
  18 at runtime as a kernel module.
  19 .Pp
  20 A single
  21 .Fx
  22 host can do bridging on independent sets of interfaces,
  23 which are called
  24 .Ar clusters .
  25 Each cluster connects a set of interfaces, and is
  26 identified by a "cluster-id" which is a number in the range 1..65535.
  27 A cluster in fact is very similar to what commercial switches call
  28 a "VLAN". Note however that there is no relation whatsoever
  29 between the cluster-id and the IEEE 802.1q VLAN-id which appears
  30 in the header of packets transmitted on the wire.
  31 In fact, in most cases there is no relation between the
  32 so-called "VLAN identifier" used in most commercial switches, and
  33 the IEEE 802.1q VLAN-id.
  34 .Pp
  35 By putting both physical and logical (vlanX) interfaces
  36 in the same cluster, a FreeBSD box can also implement what in
  37 commercial terms is called a "trunk" interface. This means packets
  38 coming from one of the interfaces in the cluster,
  39 will appear
  40 on the wire on the "parent" interfaces of any vlan
  41 interface belonging to the cluster, with the
  42 proper VLAN tag. Similarly, packets coming from a
  43 parent interface, will have the VLAN tag stripped and
  44 will be forwarded to other interfaces on the same cluster.
  45 See the
  46 .Sx EXAMPLES
  47 section for more details.
  48 .Pp
  49 Runtime operation of the
  50 .Nm
  51 is controlled by several
  52 .Xr sysctl 8
  53 variables, as follows.
  54 .Pp
  55 .Bl -tag -width indent
  56 .It Va net.link.ether.bridge
  57 set to
  58 .Li 1
  59 to enable bridging, set to
  60 .Li 0
  61 to disable it.
  62 .Pp
  63 .It Va net.link.ether.bridge_ipfw
  64 set to
  65 .Li 1
  66 to enable
  67 .Xr ipfw 8
  68 filtering on bridged packets.
  69 Note that
  70 .Xr ipfw 8
  71 rules only apply
  72 to IP packets.
  73 Non-IP packets are accepted by default.
  74 See the
  75 .Sx BUGS
  76 section and the
  77 .Xr ipfw 8
  78 manpage for more details on the interaction of bridging
  79 and the firewall.
  80 .Pp
  81 .It Va net.link.ether.bridge_cfg
  82 contains a list of interfaces on which bridging is to be performed.
  83 Interfaces are separated by spaces, commas or tabs. Each interface
  84 can be optionally followed by a colon and an integer indicating the
  85 cluster it belongs to (defaults to 1 if the cluster-id is missing), e.g.
  86 .Pp
  87 .Ar dc0:1,dc1,vlan0:3 dc2:3
  88 .Pp
  89 will put dc0 and dc1 in cluster number 1, and vlan0 and dc2 in cluster
  90 number 3.
  91 See the
  92 .Sx EXAMPLES
  93 section for more examples.
  94 .Pp
  95 The list of interfaces is rescanned every time the list is
  96 modified, bridging is enabled, or new interfaces are created or
  97 destroyed. Interfaces that are in the list but cannot be used
  98 for bridging (because they are non-existing, or not Ethernet or VLAN)
  99 are not used and a warning message is generated.
 100 .Pp
 101 .El
 102 .Pp
 103 Bridging requires interfaces to be put in promiscuous mode,
 104 and transmit packets with Ethernet source addresses.
 105 Some interfaces (e.g.
 106 .Xr wi 4 )
 107 do not support this functionality.
 108 Also, bridging is not compatible with interfaces which
 109 use hardware loopback, because there is no way to tell locally
 110 generated packets from externally generated ones.
 111 .Pp
 112 .Sh EXAMPLES
 113 A simple bridge configuration with three interfaces in the same
 114 cluster can be set as follows. No cluster-id is specified here, which
 115 will cause the interfaces to appear as part of cluster #1.
 116 .Pp
 117 .Dl sysctl net.link.ether.bridge_cfg=dc0,dc1,fxp1
 118 .Pp
 119 If you do not know what actual interfaces will be present on
 120 your system, you can just put all existing interfaces in the
 121 configuration, as follows:
 122 .Pp
 123 .Dl sysctl net.link.ether.bridge_cfg="`ifconfig -l`"
 124 .Pp
 125 This will result in a space-separated list of interfaces.
 126 Out of the list, only Ethernet or VLAN interfaces will be
 127 used for bridging, whereas for others the kernel will produce
 128 a warning message.
 129 .Pp
 130 More complex configurations can be used to create multiple
 131 clusters, e.g.
 132 .Pp
 133 .Dl sysctl net.link.ether.bridge_cfg=dc0:3,dc1:3,fxp0:4,fxp1:4
 134 .Pp
 135 will create two completely independent clusters.
 136 .Pp
 137 Finally, interesting configurations involve vlans and parent interfaces.
 138 As an example, the following configuration will use interface dc0
 139 as a "trunk" interface, and pass packets
 140 for 802.1q vlans 10 and 20 to physical interfaces dc1 and dc2:
 141 .Pp
 142 .Dl sysctl net.link.ether.bridge_cfg=vlan0:34,dc1:34,vlan1:56,dc2:56
 143 .Dl ifconfig vlan0 vlan 10 vlandev dc0
 144 .Dl ifconfig vlan1 vlan 20 vlandev dc0
 145 .Pp
 146 Note how there is no relation between the 802.1q vlan identifiers
 147 (10 and 20) and the cluster-id's (34 and 56) used in
 148 the bridge_cfg variable.
 149 .Pp
 150 Note also that the trunk interface
 151 does not even appear in the bridge_cfg, as vlan tag insertion/removal
 152 is performed by the
 153 .Xr vlan 4
 154 devices.
 155 When using vlan devices, care must be taken by not creating loops
 156 between these devices and their parent interfaces.
 157 .Pp
 158 .Sh BUGS
 159 Care must be taken not to construct loops in the
 160 .Nm
 161 topology.
 162 The kernel supports only a primitive form of loop detection, by disabling
 163 some interfaces when a loop is detected.
 164 No support for a daemon running the
 165 spanning tree algorithm is currently provided.
 166 .Pp
 167 With bridging active, interfaces are in promiscuous mode,
 168 thus causing some load on the system to receive and filter
 169 out undesired traffic.
 170 .Pp
 171 When passing bridged packets to
 172 .Xr ipfw 8 ,
 173 remember that only IP packets are passed to the firewall, while
 174 other packets are silently accepted.
 175 Also remember that bridged packets are accepted after the
 176 first pass through the firewall irrespective of the setting
 177 of the sysctl variable
 178 .Nm net.inet.ip.fw.one_pass ,
 179 and that some
 180 .Nm ipfw
 181 actions such as
 182 .Nm divert
 183 do not apply to bridged packets.
 184 It might be useful to have a rule of the form
 185 .Pp
 186 .Dl skipto 20000 ip from any to any bridged
 187 .Pp
 188 near the beginning of your ruleset to implement specific rulesets
 189 for bridged packets.
 190 .Sh SEE ALSO
 191 .Xr ip 4 ,
 192 .Xr ng_bridge 4 ,
 193 .Xr vlan 4 ,
 194 .Xr ipfw 8 ,
 195 .Xr sysctl 8
 196 .Sh HISTORY
 197 Bridging was introduced in
 198 .Fx 2.2.8
 199 by
 200 .An Luigi Rizzo Aq luigi@iet.unipi.it .