1 // SPDX-License-Identifier: GPL-2.0-only
3 * IEEE 802.1D Generic Attribute Registration Protocol (GARP)
7 #include <linux/kernel.h>
8 #include <linux/timer.h>
9 #include <linux/skbuff.h>
10 #include <linux/netdevice.h>
11 #include <linux/etherdevice.h>
12 #include <linux/rtnetlink.h>
13 #include <linux/llc.h>
14 #include <linux/slab.h>
15 #include <linux/module.h>
17 #include <net/llc_pdu.h>
19 #include <asm/unaligned.h>
21 static unsigned int garp_join_time __read_mostly = 200;
22 module_param(garp_join_time, uint, 0644);
23 MODULE_PARM_DESC(garp_join_time, "Join time in ms (default 200ms)");
24 MODULE_LICENSE("GPL");
26 static const struct garp_state_trans {
29 } garp_applicant_state_table[GARP_APPLICANT_MAX + 1][GARP_EVENT_MAX + 1] = {
30 [GARP_APPLICANT_VA] = {
31 [GARP_EVENT_TRANSMIT_PDU] = { .state = GARP_APPLICANT_AA,
32 .action = GARP_ACTION_S_JOIN_IN },
33 [GARP_EVENT_R_JOIN_IN] = { .state = GARP_APPLICANT_AA },
34 [GARP_EVENT_R_JOIN_EMPTY] = { .state = GARP_APPLICANT_VA },
35 [GARP_EVENT_R_EMPTY] = { .state = GARP_APPLICANT_VA },
36 [GARP_EVENT_R_LEAVE_IN] = { .state = GARP_APPLICANT_VA },
37 [GARP_EVENT_R_LEAVE_EMPTY] = { .state = GARP_APPLICANT_VP },
38 [GARP_EVENT_REQ_JOIN] = { .state = GARP_APPLICANT_INVALID },
39 [GARP_EVENT_REQ_LEAVE] = { .state = GARP_APPLICANT_LA },
41 [GARP_APPLICANT_AA] = {
42 [GARP_EVENT_TRANSMIT_PDU] = { .state = GARP_APPLICANT_QA,
43 .action = GARP_ACTION_S_JOIN_IN },
44 [GARP_EVENT_R_JOIN_IN] = { .state = GARP_APPLICANT_QA },
45 [GARP_EVENT_R_JOIN_EMPTY] = { .state = GARP_APPLICANT_VA },
46 [GARP_EVENT_R_EMPTY] = { .state = GARP_APPLICANT_VA },
47 [GARP_EVENT_R_LEAVE_IN] = { .state = GARP_APPLICANT_VA },
48 [GARP_EVENT_R_LEAVE_EMPTY] = { .state = GARP_APPLICANT_VP },
49 [GARP_EVENT_REQ_JOIN] = { .state = GARP_APPLICANT_INVALID },
50 [GARP_EVENT_REQ_LEAVE] = { .state = GARP_APPLICANT_LA },
52 [GARP_APPLICANT_QA] = {
53 [GARP_EVENT_TRANSMIT_PDU] = { .state = GARP_APPLICANT_INVALID },
54 [GARP_EVENT_R_JOIN_IN] = { .state = GARP_APPLICANT_QA },
55 [GARP_EVENT_R_JOIN_EMPTY] = { .state = GARP_APPLICANT_VA },
56 [GARP_EVENT_R_EMPTY] = { .state = GARP_APPLICANT_VA },
57 [GARP_EVENT_R_LEAVE_IN] = { .state = GARP_APPLICANT_VP },
58 [GARP_EVENT_R_LEAVE_EMPTY] = { .state = GARP_APPLICANT_VP },
59 [GARP_EVENT_REQ_JOIN] = { .state = GARP_APPLICANT_INVALID },
60 [GARP_EVENT_REQ_LEAVE] = { .state = GARP_APPLICANT_LA },
62 [GARP_APPLICANT_LA] = {
63 [GARP_EVENT_TRANSMIT_PDU] = { .state = GARP_APPLICANT_VO,
64 .action = GARP_ACTION_S_LEAVE_EMPTY },
65 [GARP_EVENT_R_JOIN_IN] = { .state = GARP_APPLICANT_LA },
66 [GARP_EVENT_R_JOIN_EMPTY] = { .state = GARP_APPLICANT_VO },
67 [GARP_EVENT_R_EMPTY] = { .state = GARP_APPLICANT_LA },
68 [GARP_EVENT_R_LEAVE_IN] = { .state = GARP_APPLICANT_LA },
69 [GARP_EVENT_R_LEAVE_EMPTY] = { .state = GARP_APPLICANT_VO },
70 [GARP_EVENT_REQ_JOIN] = { .state = GARP_APPLICANT_VA },
71 [GARP_EVENT_REQ_LEAVE] = { .state = GARP_APPLICANT_INVALID },
73 [GARP_APPLICANT_VP] = {
74 [GARP_EVENT_TRANSMIT_PDU] = { .state = GARP_APPLICANT_AA,
75 .action = GARP_ACTION_S_JOIN_IN },
76 [GARP_EVENT_R_JOIN_IN] = { .state = GARP_APPLICANT_AP },
77 [GARP_EVENT_R_JOIN_EMPTY] = { .state = GARP_APPLICANT_VP },
78 [GARP_EVENT_R_EMPTY] = { .state = GARP_APPLICANT_VP },
79 [GARP_EVENT_R_LEAVE_IN] = { .state = GARP_APPLICANT_VP },
80 [GARP_EVENT_R_LEAVE_EMPTY] = { .state = GARP_APPLICANT_VP },
81 [GARP_EVENT_REQ_JOIN] = { .state = GARP_APPLICANT_INVALID },
82 [GARP_EVENT_REQ_LEAVE] = { .state = GARP_APPLICANT_VO },
84 [GARP_APPLICANT_AP] = {
85 [GARP_EVENT_TRANSMIT_PDU] = { .state = GARP_APPLICANT_QA,
86 .action = GARP_ACTION_S_JOIN_IN },
87 [GARP_EVENT_R_JOIN_IN] = { .state = GARP_APPLICANT_QP },
88 [GARP_EVENT_R_JOIN_EMPTY] = { .state = GARP_APPLICANT_VP },
89 [GARP_EVENT_R_EMPTY] = { .state = GARP_APPLICANT_VP },
90 [GARP_EVENT_R_LEAVE_IN] = { .state = GARP_APPLICANT_VP },
91 [GARP_EVENT_R_LEAVE_EMPTY] = { .state = GARP_APPLICANT_VP },
92 [GARP_EVENT_REQ_JOIN] = { .state = GARP_APPLICANT_INVALID },
93 [GARP_EVENT_REQ_LEAVE] = { .state = GARP_APPLICANT_AO },
95 [GARP_APPLICANT_QP] = {
96 [GARP_EVENT_TRANSMIT_PDU] = { .state = GARP_APPLICANT_INVALID },
97 [GARP_EVENT_R_JOIN_IN] = { .state = GARP_APPLICANT_QP },
98 [GARP_EVENT_R_JOIN_EMPTY] = { .state = GARP_APPLICANT_VP },
99 [GARP_EVENT_R_EMPTY] = { .state = GARP_APPLICANT_VP },
100 [GARP_EVENT_R_LEAVE_IN] = { .state = GARP_APPLICANT_VP },
101 [GARP_EVENT_R_LEAVE_EMPTY] = { .state = GARP_APPLICANT_VP },
102 [GARP_EVENT_REQ_JOIN] = { .state = GARP_APPLICANT_INVALID },
103 [GARP_EVENT_REQ_LEAVE] = { .state = GARP_APPLICANT_QO },
105 [GARP_APPLICANT_VO] = {
106 [GARP_EVENT_TRANSMIT_PDU] = { .state = GARP_APPLICANT_INVALID },
107 [GARP_EVENT_R_JOIN_IN] = { .state = GARP_APPLICANT_AO },
108 [GARP_EVENT_R_JOIN_EMPTY] = { .state = GARP_APPLICANT_VO },
109 [GARP_EVENT_R_EMPTY] = { .state = GARP_APPLICANT_VO },
110 [GARP_EVENT_R_LEAVE_IN] = { .state = GARP_APPLICANT_VO },
111 [GARP_EVENT_R_LEAVE_EMPTY] = { .state = GARP_APPLICANT_VO },
112 [GARP_EVENT_REQ_JOIN] = { .state = GARP_APPLICANT_VP },
113 [GARP_EVENT_REQ_LEAVE] = { .state = GARP_APPLICANT_INVALID },
115 [GARP_APPLICANT_AO] = {
116 [GARP_EVENT_TRANSMIT_PDU] = { .state = GARP_APPLICANT_INVALID },
117 [GARP_EVENT_R_JOIN_IN] = { .state = GARP_APPLICANT_QO },
118 [GARP_EVENT_R_JOIN_EMPTY] = { .state = GARP_APPLICANT_VO },
119 [GARP_EVENT_R_EMPTY] = { .state = GARP_APPLICANT_VO },
120 [GARP_EVENT_R_LEAVE_IN] = { .state = GARP_APPLICANT_VO },
121 [GARP_EVENT_R_LEAVE_EMPTY] = { .state = GARP_APPLICANT_VO },
122 [GARP_EVENT_REQ_JOIN] = { .state = GARP_APPLICANT_AP },
123 [GARP_EVENT_REQ_LEAVE] = { .state = GARP_APPLICANT_INVALID },
125 [GARP_APPLICANT_QO] = {
126 [GARP_EVENT_TRANSMIT_PDU] = { .state = GARP_APPLICANT_INVALID },
127 [GARP_EVENT_R_JOIN_IN] = { .state = GARP_APPLICANT_QO },
128 [GARP_EVENT_R_JOIN_EMPTY] = { .state = GARP_APPLICANT_VO },
129 [GARP_EVENT_R_EMPTY] = { .state = GARP_APPLICANT_VO },
130 [GARP_EVENT_R_LEAVE_IN] = { .state = GARP_APPLICANT_VO },
131 [GARP_EVENT_R_LEAVE_EMPTY] = { .state = GARP_APPLICANT_VO },
132 [GARP_EVENT_REQ_JOIN] = { .state = GARP_APPLICANT_QP },
133 [GARP_EVENT_REQ_LEAVE] = { .state = GARP_APPLICANT_INVALID },
137 static int garp_attr_cmp(const struct garp_attr *attr,
138 const void *data, u8 len, u8 type)
140 if (attr->type != type)
141 return attr->type - type;
142 if (attr->dlen != len)
143 return attr->dlen - len;
144 return memcmp(attr->data, data, len);
147 static struct garp_attr *garp_attr_lookup(const struct garp_applicant *app,
148 const void *data, u8 len, u8 type)
150 struct rb_node *parent = app->gid.rb_node;
151 struct garp_attr *attr;
155 attr = rb_entry(parent, struct garp_attr, node);
156 d = garp_attr_cmp(attr, data, len, type);
158 parent = parent->rb_left;
160 parent = parent->rb_right;
167 static struct garp_attr *garp_attr_create(struct garp_applicant *app,
168 const void *data, u8 len, u8 type)
170 struct rb_node *parent = NULL, **p = &app->gid.rb_node;
171 struct garp_attr *attr;
176 attr = rb_entry(parent, struct garp_attr, node);
177 d = garp_attr_cmp(attr, data, len, type);
179 p = &parent->rb_left;
181 p = &parent->rb_right;
183 /* The attribute already exists; re-use it. */
187 attr = kmalloc(sizeof(*attr) + len, GFP_ATOMIC);
190 attr->state = GARP_APPLICANT_VO;
193 memcpy(attr->data, data, len);
195 rb_link_node(&attr->node, parent, p);
196 rb_insert_color(&attr->node, &app->gid);
200 static void garp_attr_destroy(struct garp_applicant *app, struct garp_attr *attr)
202 rb_erase(&attr->node, &app->gid);
206 static int garp_pdu_init(struct garp_applicant *app)
209 struct garp_pdu_hdr *gp;
211 #define LLC_RESERVE sizeof(struct llc_pdu_un)
212 skb = alloc_skb(app->dev->mtu + LL_RESERVED_SPACE(app->dev),
218 skb->protocol = htons(ETH_P_802_2);
219 skb_reserve(skb, LL_RESERVED_SPACE(app->dev) + LLC_RESERVE);
221 gp = __skb_put(skb, sizeof(*gp));
222 put_unaligned(htons(GARP_PROTOCOL_ID), &gp->protocol);
228 static int garp_pdu_append_end_mark(struct garp_applicant *app)
230 if (skb_tailroom(app->pdu) < sizeof(u8))
232 __skb_put_u8(app->pdu, GARP_END_MARK);
236 static void garp_pdu_queue(struct garp_applicant *app)
241 garp_pdu_append_end_mark(app);
242 garp_pdu_append_end_mark(app);
244 llc_pdu_header_init(app->pdu, LLC_PDU_TYPE_U, LLC_SAP_BSPAN,
245 LLC_SAP_BSPAN, LLC_PDU_CMD);
246 llc_pdu_init_as_ui_cmd(app->pdu);
247 llc_mac_hdr_init(app->pdu, app->dev->dev_addr,
248 app->app->proto.group_address);
250 skb_queue_tail(&app->queue, app->pdu);
254 static void garp_queue_xmit(struct garp_applicant *app)
258 while ((skb = skb_dequeue(&app->queue)))
262 static int garp_pdu_append_msg(struct garp_applicant *app, u8 attrtype)
264 struct garp_msg_hdr *gm;
266 if (skb_tailroom(app->pdu) < sizeof(*gm))
268 gm = __skb_put(app->pdu, sizeof(*gm));
269 gm->attrtype = attrtype;
270 garp_cb(app->pdu)->cur_type = attrtype;
274 static int garp_pdu_append_attr(struct garp_applicant *app,
275 const struct garp_attr *attr,
276 enum garp_attr_event event)
278 struct garp_attr_hdr *ga;
283 err = garp_pdu_init(app);
288 if (garp_cb(app->pdu)->cur_type != attr->type) {
289 if (garp_cb(app->pdu)->cur_type &&
290 garp_pdu_append_end_mark(app) < 0)
292 if (garp_pdu_append_msg(app, attr->type) < 0)
296 len = sizeof(*ga) + attr->dlen;
297 if (skb_tailroom(app->pdu) < len)
299 ga = __skb_put(app->pdu, len);
302 memcpy(ga->data, attr->data, attr->dlen);
310 static void garp_attr_event(struct garp_applicant *app,
311 struct garp_attr *attr, enum garp_event event)
313 enum garp_applicant_state state;
315 state = garp_applicant_state_table[attr->state][event].state;
316 if (state == GARP_APPLICANT_INVALID)
319 switch (garp_applicant_state_table[attr->state][event].action) {
320 case GARP_ACTION_NONE:
322 case GARP_ACTION_S_JOIN_IN:
323 /* When appending the attribute fails, don't update state in
324 * order to retry on next TRANSMIT_PDU event. */
325 if (garp_pdu_append_attr(app, attr, GARP_JOIN_IN) < 0)
328 case GARP_ACTION_S_LEAVE_EMPTY:
329 garp_pdu_append_attr(app, attr, GARP_LEAVE_EMPTY);
330 /* As a pure applicant, sending a leave message implies that
331 * the attribute was unregistered and can be destroyed. */
332 garp_attr_destroy(app, attr);
341 int garp_request_join(const struct net_device *dev,
342 const struct garp_application *appl,
343 const void *data, u8 len, u8 type)
345 struct garp_port *port = rtnl_dereference(dev->garp_port);
346 struct garp_applicant *app = rtnl_dereference(port->applicants[appl->type]);
347 struct garp_attr *attr;
349 spin_lock_bh(&app->lock);
350 attr = garp_attr_create(app, data, len, type);
352 spin_unlock_bh(&app->lock);
355 garp_attr_event(app, attr, GARP_EVENT_REQ_JOIN);
356 spin_unlock_bh(&app->lock);
359 EXPORT_SYMBOL_GPL(garp_request_join);
361 void garp_request_leave(const struct net_device *dev,
362 const struct garp_application *appl,
363 const void *data, u8 len, u8 type)
365 struct garp_port *port = rtnl_dereference(dev->garp_port);
366 struct garp_applicant *app = rtnl_dereference(port->applicants[appl->type]);
367 struct garp_attr *attr;
369 spin_lock_bh(&app->lock);
370 attr = garp_attr_lookup(app, data, len, type);
372 spin_unlock_bh(&app->lock);
375 garp_attr_event(app, attr, GARP_EVENT_REQ_LEAVE);
376 spin_unlock_bh(&app->lock);
378 EXPORT_SYMBOL_GPL(garp_request_leave);
380 static void garp_gid_event(struct garp_applicant *app, enum garp_event event)
382 struct rb_node *node, *next;
383 struct garp_attr *attr;
385 for (node = rb_first(&app->gid);
386 next = node ? rb_next(node) : NULL, node != NULL;
388 attr = rb_entry(node, struct garp_attr, node);
389 garp_attr_event(app, attr, event);
393 static void garp_join_timer_arm(struct garp_applicant *app)
397 delay = (u64)msecs_to_jiffies(garp_join_time) * prandom_u32() >> 32;
398 mod_timer(&app->join_timer, jiffies + delay);
401 static void garp_join_timer(struct timer_list *t)
403 struct garp_applicant *app = from_timer(app, t, join_timer);
405 spin_lock(&app->lock);
406 garp_gid_event(app, GARP_EVENT_TRANSMIT_PDU);
408 spin_unlock(&app->lock);
410 garp_queue_xmit(app);
411 garp_join_timer_arm(app);
414 static int garp_pdu_parse_end_mark(struct sk_buff *skb)
416 if (!pskb_may_pull(skb, sizeof(u8)))
418 if (*skb->data == GARP_END_MARK) {
419 skb_pull(skb, sizeof(u8));
425 static int garp_pdu_parse_attr(struct garp_applicant *app, struct sk_buff *skb,
428 const struct garp_attr_hdr *ga;
429 struct garp_attr *attr;
430 enum garp_event event;
433 if (!pskb_may_pull(skb, sizeof(*ga)))
435 ga = (struct garp_attr_hdr *)skb->data;
436 if (ga->len < sizeof(*ga))
439 if (!pskb_may_pull(skb, ga->len))
441 skb_pull(skb, ga->len);
442 dlen = sizeof(*ga) - ga->len;
444 if (attrtype > app->app->maxattr)
451 garp_gid_event(app, GARP_EVENT_R_LEAVE_EMPTY);
453 case GARP_JOIN_EMPTY:
454 event = GARP_EVENT_R_JOIN_EMPTY;
457 event = GARP_EVENT_R_JOIN_IN;
459 case GARP_LEAVE_EMPTY:
460 event = GARP_EVENT_R_LEAVE_EMPTY;
463 event = GARP_EVENT_R_EMPTY;
471 attr = garp_attr_lookup(app, ga->data, dlen, attrtype);
474 garp_attr_event(app, attr, event);
478 static int garp_pdu_parse_msg(struct garp_applicant *app, struct sk_buff *skb)
480 const struct garp_msg_hdr *gm;
482 if (!pskb_may_pull(skb, sizeof(*gm)))
484 gm = (struct garp_msg_hdr *)skb->data;
485 if (gm->attrtype == 0)
487 skb_pull(skb, sizeof(*gm));
489 while (skb->len > 0) {
490 if (garp_pdu_parse_attr(app, skb, gm->attrtype) < 0)
492 if (garp_pdu_parse_end_mark(skb) < 0)
498 static void garp_pdu_rcv(const struct stp_proto *proto, struct sk_buff *skb,
499 struct net_device *dev)
501 struct garp_application *appl = proto->data;
502 struct garp_port *port;
503 struct garp_applicant *app;
504 const struct garp_pdu_hdr *gp;
506 port = rcu_dereference(dev->garp_port);
509 app = rcu_dereference(port->applicants[appl->type]);
513 if (!pskb_may_pull(skb, sizeof(*gp)))
515 gp = (struct garp_pdu_hdr *)skb->data;
516 if (get_unaligned(&gp->protocol) != htons(GARP_PROTOCOL_ID))
518 skb_pull(skb, sizeof(*gp));
520 spin_lock(&app->lock);
521 while (skb->len > 0) {
522 if (garp_pdu_parse_msg(app, skb) < 0)
524 if (garp_pdu_parse_end_mark(skb) < 0)
527 spin_unlock(&app->lock);
532 static int garp_init_port(struct net_device *dev)
534 struct garp_port *port;
536 port = kzalloc(sizeof(*port), GFP_KERNEL);
539 rcu_assign_pointer(dev->garp_port, port);
543 static void garp_release_port(struct net_device *dev)
545 struct garp_port *port = rtnl_dereference(dev->garp_port);
548 for (i = 0; i <= GARP_APPLICATION_MAX; i++) {
549 if (rtnl_dereference(port->applicants[i]))
552 RCU_INIT_POINTER(dev->garp_port, NULL);
553 kfree_rcu(port, rcu);
556 int garp_init_applicant(struct net_device *dev, struct garp_application *appl)
558 struct garp_applicant *app;
563 if (!rtnl_dereference(dev->garp_port)) {
564 err = garp_init_port(dev);
570 app = kzalloc(sizeof(*app), GFP_KERNEL);
574 err = dev_mc_add(dev, appl->proto.group_address);
581 spin_lock_init(&app->lock);
582 skb_queue_head_init(&app->queue);
583 rcu_assign_pointer(dev->garp_port->applicants[appl->type], app);
584 timer_setup(&app->join_timer, garp_join_timer, 0);
585 garp_join_timer_arm(app);
591 garp_release_port(dev);
595 EXPORT_SYMBOL_GPL(garp_init_applicant);
597 void garp_uninit_applicant(struct net_device *dev, struct garp_application *appl)
599 struct garp_port *port = rtnl_dereference(dev->garp_port);
600 struct garp_applicant *app = rtnl_dereference(port->applicants[appl->type]);
604 RCU_INIT_POINTER(port->applicants[appl->type], NULL);
606 /* Delete timer and generate a final TRANSMIT_PDU event to flush out
607 * all pending messages before the applicant is gone. */
608 del_timer_sync(&app->join_timer);
610 spin_lock_bh(&app->lock);
611 garp_gid_event(app, GARP_EVENT_TRANSMIT_PDU);
613 spin_unlock_bh(&app->lock);
615 garp_queue_xmit(app);
617 dev_mc_del(dev, appl->proto.group_address);
619 garp_release_port(dev);
621 EXPORT_SYMBOL_GPL(garp_uninit_applicant);
623 int garp_register_application(struct garp_application *appl)
625 appl->proto.rcv = garp_pdu_rcv;
626 appl->proto.data = appl;
627 return stp_proto_register(&appl->proto);
629 EXPORT_SYMBOL_GPL(garp_register_application);
631 void garp_unregister_application(struct garp_application *appl)
633 stp_proto_unregister(&appl->proto);
635 EXPORT_SYMBOL_GPL(garp_unregister_application);