1 // SPDX-License-Identifier: GPL-2.0-only
3 * IEEE 802.1D Generic Attribute Registration Protocol (GARP)
5 * Copyright (c) 2008 Patrick McHardy <kaber@trash.net>
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 void garp_attr_destroy_all(struct garp_applicant *app)
208 struct rb_node *node, *next;
209 struct garp_attr *attr;
211 for (node = rb_first(&app->gid);
212 next = node ? rb_next(node) : NULL, node != NULL;
214 attr = rb_entry(node, struct garp_attr, node);
215 garp_attr_destroy(app, attr);
219 static int garp_pdu_init(struct garp_applicant *app)
222 struct garp_pdu_hdr *gp;
224 #define LLC_RESERVE sizeof(struct llc_pdu_un)
225 skb = alloc_skb(app->dev->mtu + LL_RESERVED_SPACE(app->dev),
231 skb->protocol = htons(ETH_P_802_2);
232 skb_reserve(skb, LL_RESERVED_SPACE(app->dev) + LLC_RESERVE);
234 gp = __skb_put(skb, sizeof(*gp));
235 put_unaligned(htons(GARP_PROTOCOL_ID), &gp->protocol);
241 static int garp_pdu_append_end_mark(struct garp_applicant *app)
243 if (skb_tailroom(app->pdu) < sizeof(u8))
245 __skb_put_u8(app->pdu, GARP_END_MARK);
249 static void garp_pdu_queue(struct garp_applicant *app)
254 garp_pdu_append_end_mark(app);
255 garp_pdu_append_end_mark(app);
257 llc_pdu_header_init(app->pdu, LLC_PDU_TYPE_U, LLC_SAP_BSPAN,
258 LLC_SAP_BSPAN, LLC_PDU_CMD);
259 llc_pdu_init_as_ui_cmd(app->pdu);
260 llc_mac_hdr_init(app->pdu, app->dev->dev_addr,
261 app->app->proto.group_address);
263 skb_queue_tail(&app->queue, app->pdu);
267 static void garp_queue_xmit(struct garp_applicant *app)
271 while ((skb = skb_dequeue(&app->queue)))
275 static int garp_pdu_append_msg(struct garp_applicant *app, u8 attrtype)
277 struct garp_msg_hdr *gm;
279 if (skb_tailroom(app->pdu) < sizeof(*gm))
281 gm = __skb_put(app->pdu, sizeof(*gm));
282 gm->attrtype = attrtype;
283 garp_cb(app->pdu)->cur_type = attrtype;
287 static int garp_pdu_append_attr(struct garp_applicant *app,
288 const struct garp_attr *attr,
289 enum garp_attr_event event)
291 struct garp_attr_hdr *ga;
296 err = garp_pdu_init(app);
301 if (garp_cb(app->pdu)->cur_type != attr->type) {
302 if (garp_cb(app->pdu)->cur_type &&
303 garp_pdu_append_end_mark(app) < 0)
305 if (garp_pdu_append_msg(app, attr->type) < 0)
309 len = sizeof(*ga) + attr->dlen;
310 if (skb_tailroom(app->pdu) < len)
312 ga = __skb_put(app->pdu, len);
315 memcpy(ga->data, attr->data, attr->dlen);
323 static void garp_attr_event(struct garp_applicant *app,
324 struct garp_attr *attr, enum garp_event event)
326 enum garp_applicant_state state;
328 state = garp_applicant_state_table[attr->state][event].state;
329 if (state == GARP_APPLICANT_INVALID)
332 switch (garp_applicant_state_table[attr->state][event].action) {
333 case GARP_ACTION_NONE:
335 case GARP_ACTION_S_JOIN_IN:
336 /* When appending the attribute fails, don't update state in
337 * order to retry on next TRANSMIT_PDU event. */
338 if (garp_pdu_append_attr(app, attr, GARP_JOIN_IN) < 0)
341 case GARP_ACTION_S_LEAVE_EMPTY:
342 garp_pdu_append_attr(app, attr, GARP_LEAVE_EMPTY);
343 /* As a pure applicant, sending a leave message implies that
344 * the attribute was unregistered and can be destroyed. */
345 garp_attr_destroy(app, attr);
354 int garp_request_join(const struct net_device *dev,
355 const struct garp_application *appl,
356 const void *data, u8 len, u8 type)
358 struct garp_port *port = rtnl_dereference(dev->garp_port);
359 struct garp_applicant *app = rtnl_dereference(port->applicants[appl->type]);
360 struct garp_attr *attr;
362 spin_lock_bh(&app->lock);
363 attr = garp_attr_create(app, data, len, type);
365 spin_unlock_bh(&app->lock);
368 garp_attr_event(app, attr, GARP_EVENT_REQ_JOIN);
369 spin_unlock_bh(&app->lock);
372 EXPORT_SYMBOL_GPL(garp_request_join);
374 void garp_request_leave(const struct net_device *dev,
375 const struct garp_application *appl,
376 const void *data, u8 len, u8 type)
378 struct garp_port *port = rtnl_dereference(dev->garp_port);
379 struct garp_applicant *app = rtnl_dereference(port->applicants[appl->type]);
380 struct garp_attr *attr;
382 spin_lock_bh(&app->lock);
383 attr = garp_attr_lookup(app, data, len, type);
385 spin_unlock_bh(&app->lock);
388 garp_attr_event(app, attr, GARP_EVENT_REQ_LEAVE);
389 spin_unlock_bh(&app->lock);
391 EXPORT_SYMBOL_GPL(garp_request_leave);
393 static void garp_gid_event(struct garp_applicant *app, enum garp_event event)
395 struct rb_node *node, *next;
396 struct garp_attr *attr;
398 for (node = rb_first(&app->gid);
399 next = node ? rb_next(node) : NULL, node != NULL;
401 attr = rb_entry(node, struct garp_attr, node);
402 garp_attr_event(app, attr, event);
406 static void garp_join_timer_arm(struct garp_applicant *app)
410 delay = (u64)msecs_to_jiffies(garp_join_time) * prandom_u32() >> 32;
411 mod_timer(&app->join_timer, jiffies + delay);
414 static void garp_join_timer(struct timer_list *t)
416 struct garp_applicant *app = from_timer(app, t, join_timer);
418 spin_lock(&app->lock);
419 garp_gid_event(app, GARP_EVENT_TRANSMIT_PDU);
421 spin_unlock(&app->lock);
423 garp_queue_xmit(app);
424 garp_join_timer_arm(app);
427 static int garp_pdu_parse_end_mark(struct sk_buff *skb)
429 if (!pskb_may_pull(skb, sizeof(u8)))
431 if (*skb->data == GARP_END_MARK) {
432 skb_pull(skb, sizeof(u8));
438 static int garp_pdu_parse_attr(struct garp_applicant *app, struct sk_buff *skb,
441 const struct garp_attr_hdr *ga;
442 struct garp_attr *attr;
443 enum garp_event event;
446 if (!pskb_may_pull(skb, sizeof(*ga)))
448 ga = (struct garp_attr_hdr *)skb->data;
449 if (ga->len < sizeof(*ga))
452 if (!pskb_may_pull(skb, ga->len))
454 skb_pull(skb, ga->len);
455 dlen = sizeof(*ga) - ga->len;
457 if (attrtype > app->app->maxattr)
464 garp_gid_event(app, GARP_EVENT_R_LEAVE_EMPTY);
466 case GARP_JOIN_EMPTY:
467 event = GARP_EVENT_R_JOIN_EMPTY;
470 event = GARP_EVENT_R_JOIN_IN;
472 case GARP_LEAVE_EMPTY:
473 event = GARP_EVENT_R_LEAVE_EMPTY;
476 event = GARP_EVENT_R_EMPTY;
484 attr = garp_attr_lookup(app, ga->data, dlen, attrtype);
487 garp_attr_event(app, attr, event);
491 static int garp_pdu_parse_msg(struct garp_applicant *app, struct sk_buff *skb)
493 const struct garp_msg_hdr *gm;
495 if (!pskb_may_pull(skb, sizeof(*gm)))
497 gm = (struct garp_msg_hdr *)skb->data;
498 if (gm->attrtype == 0)
500 skb_pull(skb, sizeof(*gm));
502 while (skb->len > 0) {
503 if (garp_pdu_parse_attr(app, skb, gm->attrtype) < 0)
505 if (garp_pdu_parse_end_mark(skb) < 0)
511 static void garp_pdu_rcv(const struct stp_proto *proto, struct sk_buff *skb,
512 struct net_device *dev)
514 struct garp_application *appl = proto->data;
515 struct garp_port *port;
516 struct garp_applicant *app;
517 const struct garp_pdu_hdr *gp;
519 port = rcu_dereference(dev->garp_port);
522 app = rcu_dereference(port->applicants[appl->type]);
526 if (!pskb_may_pull(skb, sizeof(*gp)))
528 gp = (struct garp_pdu_hdr *)skb->data;
529 if (get_unaligned(&gp->protocol) != htons(GARP_PROTOCOL_ID))
531 skb_pull(skb, sizeof(*gp));
533 spin_lock(&app->lock);
534 while (skb->len > 0) {
535 if (garp_pdu_parse_msg(app, skb) < 0)
537 if (garp_pdu_parse_end_mark(skb) < 0)
540 spin_unlock(&app->lock);
545 static int garp_init_port(struct net_device *dev)
547 struct garp_port *port;
549 port = kzalloc(sizeof(*port), GFP_KERNEL);
552 rcu_assign_pointer(dev->garp_port, port);
556 static void garp_release_port(struct net_device *dev)
558 struct garp_port *port = rtnl_dereference(dev->garp_port);
561 for (i = 0; i <= GARP_APPLICATION_MAX; i++) {
562 if (rtnl_dereference(port->applicants[i]))
565 RCU_INIT_POINTER(dev->garp_port, NULL);
566 kfree_rcu(port, rcu);
569 int garp_init_applicant(struct net_device *dev, struct garp_application *appl)
571 struct garp_applicant *app;
576 if (!rtnl_dereference(dev->garp_port)) {
577 err = garp_init_port(dev);
583 app = kzalloc(sizeof(*app), GFP_KERNEL);
587 err = dev_mc_add(dev, appl->proto.group_address);
594 spin_lock_init(&app->lock);
595 skb_queue_head_init(&app->queue);
596 rcu_assign_pointer(dev->garp_port->applicants[appl->type], app);
597 timer_setup(&app->join_timer, garp_join_timer, 0);
598 garp_join_timer_arm(app);
604 garp_release_port(dev);
608 EXPORT_SYMBOL_GPL(garp_init_applicant);
610 void garp_uninit_applicant(struct net_device *dev, struct garp_application *appl)
612 struct garp_port *port = rtnl_dereference(dev->garp_port);
613 struct garp_applicant *app = rtnl_dereference(port->applicants[appl->type]);
617 RCU_INIT_POINTER(port->applicants[appl->type], NULL);
619 /* Delete timer and generate a final TRANSMIT_PDU event to flush out
620 * all pending messages before the applicant is gone. */
621 del_timer_sync(&app->join_timer);
623 spin_lock_bh(&app->lock);
624 garp_gid_event(app, GARP_EVENT_TRANSMIT_PDU);
625 garp_attr_destroy_all(app);
627 spin_unlock_bh(&app->lock);
629 garp_queue_xmit(app);
631 dev_mc_del(dev, appl->proto.group_address);
633 garp_release_port(dev);
635 EXPORT_SYMBOL_GPL(garp_uninit_applicant);
637 int garp_register_application(struct garp_application *appl)
639 appl->proto.rcv = garp_pdu_rcv;
640 appl->proto.data = appl;
641 return stp_proto_register(&appl->proto);
643 EXPORT_SYMBOL_GPL(garp_register_application);
645 void garp_unregister_application(struct garp_application *appl)
647 stp_proto_unregister(&appl->proto);
649 EXPORT_SYMBOL_GPL(garp_unregister_application);