Remove owi(4) (old wi) driver and adjust related bits.
[dragonfly.git] / share / man / man4 / oldbridge.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/Attic/oldbridge.4,v 1.3 2006/03/26 22:56:57 swildner Exp $
4 .\"
5 .Dd February 15, 2002
6 .Dt OLDBRIDGE 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 .Dx
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 .Dx
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
37 .Dx
38 box can also implement what in
39 commercial terms is called a "trunk" interface. This means packets
40 coming from one of the interfaces in the cluster,
41 will appear
42 on the wire on the "parent" interfaces of any vlan
43 interface belonging to the cluster, with the
44 proper VLAN tag. Similarly, packets coming from a
45 parent interface, will have the VLAN tag stripped and
46 will be forwarded to other interfaces on the same cluster.
47 See the
48 .Sx EXAMPLES
49 section for more details.
50 .Pp
51 Runtime operation of the
52 .Nm
53 is controlled by several
54 .Xr sysctl 8
55 variables, as follows.
56 .Pp
57 .Bl -tag -width indent
58 .It Va net.link.ether.bridge
59 set to
60 .Li 1
61 to enable bridging, set to
62 .Li 0
63 to disable it.
64 .Pp
65 .It Va net.link.ether.bridge_ipfw
66 set to
67 .Li 1
68 to enable
69 .Xr ipfw 8
70 filtering on bridged packets.
71 Note that
72 .Xr ipfw 8
73 rules only apply
74 to IP packets.
75 Non-IP packets are accepted by default.
76 See the
77 .Sx BUGS
78 section and the
79 .Xr ipfw 8
80 manpage for more details on the interaction of bridging
81 and the firewall.
82 .Pp
83 .It Va net.link.ether.bridge_cfg
84 contains a list of interfaces on which bridging is to be performed.
85 Interfaces are separated by spaces, commas or tabs. Each interface
86 can be optionally followed by a colon and an integer indicating the
87 cluster it belongs to (defaults to 1 if the cluster-id is missing), e.g.
88 .Pp
89 .Ar dc0:1,dc1,vlan0:3 dc2:3
90 .Pp
91 will put dc0 and dc1 in cluster number 1, and vlan0 and dc2 in cluster
92 number 3.
93 See the
94 .Sx EXAMPLES
95 section for more examples.
96 .Pp
97 The list of interfaces is rescanned every time the list is
98 modified, bridging is enabled, or new interfaces are created or
99 destroyed. Interfaces that are in the list but cannot be used
100 for bridging (because they are non-existing, or not Ethernet or VLAN)
101 are not used and a warning message is generated.
102 .El
103 .Pp
104 Bridging requires interfaces to be put in promiscuous mode,
105 and transmit packets with Ethernet source addresses.
106 Some interfaces (e.g.
107 .Xr wi 4 )
108 do not support this functionality.
109 Also, bridging is not compatible with interfaces which
110 use hardware loopback, because there is no way to tell locally
111 generated packets from externally generated ones.
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 .Sh SEE ALSO
158 .Xr ip 4 ,
159 .Xr ng_bridge 4 ,
160 .Xr vlan 4 ,
161 .Xr ipfw 8 ,
162 .Xr sysctl 8
163 .Sh HISTORY
164 Bridging was introduced in
165 .Fx 2.2.8
166 by
167 .An Luigi Rizzo Aq luigi@iet.unipi.it .
168 .Sh BUGS
169 Care must be taken not to construct loops in the
170 .Nm
171 topology.
172 The kernel supports only a primitive form of loop detection, by disabling
173 some interfaces when a loop is detected.
174 No support for a daemon running the
175 spanning tree algorithm is currently provided.
176 .Pp
177 With bridging active, interfaces are in promiscuous mode,
178 thus causing some load on the system to receive and filter
179 out undesired traffic.
180 .Pp
181 When passing bridged packets to
182 .Xr ipfw 8 ,
183 remember that only IP packets are passed to the firewall, while
184 other packets are silently accepted.
185 Also remember that bridged packets are accepted after the
186 first pass through the firewall irrespective of the setting
187 of the sysctl variable
188 .Nm net.inet.ip.fw.one_pass ,
189 and that some
190 .Nm ipfw
191 actions such as
192 .Nm divert
193 do not apply to bridged packets.
194 It might be useful to have a rule of the form
195 .Pp
196 .Dl skipto 20000 ip from any to any bridged
197 .Pp
198 near the beginning of your ruleset to implement specific rulesets
199 for bridged packets.