1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* Copyright (C) B.A.T.M.A.N. contributors: 3 * 4 * Marek Lindner, Simon Wunderlich 5 */ 6 7 #ifndef _NET_BATMAN_ADV_ORIGINATOR_H_ 8 #define _NET_BATMAN_ADV_ORIGINATOR_H_ 9 10 #include "main.h" 11 12 #include <linux/compiler.h> 13 #include <linux/if_ether.h> 14 #include <linux/jhash.h> 15 #include <linux/kref.h> 16 #include <linux/netlink.h> 17 #include <linux/skbuff.h> 18 #include <linux/types.h> 19 20 bool batadv_compare_orig(const struct hlist_node *node, const void *data2); 21 int batadv_originator_init(struct batadv_priv *bat_priv); 22 void batadv_originator_free(struct batadv_priv *bat_priv); 23 void batadv_purge_orig_ref(struct batadv_priv *bat_priv); 24 void batadv_orig_node_release(struct kref *ref); 25 struct batadv_orig_node *batadv_orig_node_new(struct batadv_priv *bat_priv, 26 const u8 *addr); 27 struct batadv_hardif_neigh_node * 28 batadv_hardif_neigh_get(const struct batadv_hard_iface *hard_iface, 29 const u8 *neigh_addr); 30 void batadv_hardif_neigh_release(struct kref *ref); 31 struct batadv_neigh_node * 32 batadv_neigh_node_get_or_create(struct batadv_orig_node *orig_node, 33 struct batadv_hard_iface *hard_iface, 34 const u8 *neigh_addr); 35 void batadv_neigh_node_release(struct kref *ref); 36 struct batadv_neigh_node * 37 batadv_orig_router_get(struct batadv_orig_node *orig_node, 38 const struct batadv_hard_iface *if_outgoing); 39 struct batadv_neigh_ifinfo * 40 batadv_neigh_ifinfo_new(struct batadv_neigh_node *neigh, 41 struct batadv_hard_iface *if_outgoing); 42 struct batadv_neigh_ifinfo * 43 batadv_neigh_ifinfo_get(struct batadv_neigh_node *neigh, 44 struct batadv_hard_iface *if_outgoing); 45 void batadv_neigh_ifinfo_release(struct kref *ref); 46 47 int batadv_hardif_neigh_dump(struct sk_buff *msg, struct netlink_callback *cb); 48 49 struct batadv_orig_ifinfo * 50 batadv_orig_ifinfo_get(struct batadv_orig_node *orig_node, 51 struct batadv_hard_iface *if_outgoing); 52 struct batadv_orig_ifinfo * 53 batadv_orig_ifinfo_new(struct batadv_orig_node *orig_node, 54 struct batadv_hard_iface *if_outgoing); 55 void batadv_orig_ifinfo_release(struct kref *ref); 56 57 int batadv_orig_dump(struct sk_buff *msg, struct netlink_callback *cb); 58 struct batadv_orig_node_vlan * 59 batadv_orig_node_vlan_new(struct batadv_orig_node *orig_node, 60 unsigned short vid); 61 struct batadv_orig_node_vlan * 62 batadv_orig_node_vlan_get(struct batadv_orig_node *orig_node, 63 unsigned short vid); 64 void batadv_orig_node_vlan_release(struct kref *ref); 65 66 /** 67 * batadv_choose_orig() - Return the index of the orig entry in the hash table 68 * @data: mac address of the originator node 69 * @size: the size of the hash table 70 * 71 * Return: the hash index where the object represented by @data should be 72 * stored at. 73 */ 74 static inline u32 batadv_choose_orig(const void *data, u32 size) 75 { 76 u32 hash = 0; 77 78 hash = jhash(data, ETH_ALEN, hash); 79 return hash % size; 80 } 81 82 struct batadv_orig_node * 83 batadv_orig_hash_find(struct batadv_priv *bat_priv, const void *data); 84 85 /** 86 * batadv_orig_node_vlan_put() - decrement the refcounter and possibly release 87 * the originator-vlan object 88 * @orig_vlan: the originator-vlan object to release 89 */ 90 static inline void 91 batadv_orig_node_vlan_put(struct batadv_orig_node_vlan *orig_vlan) 92 { 93 if (!orig_vlan) 94 return; 95 96 kref_put(&orig_vlan->refcount, batadv_orig_node_vlan_release); 97 } 98 99 /** 100 * batadv_neigh_ifinfo_put() - decrement the refcounter and possibly release 101 * the neigh_ifinfo 102 * @neigh_ifinfo: the neigh_ifinfo object to release 103 */ 104 static inline void 105 batadv_neigh_ifinfo_put(struct batadv_neigh_ifinfo *neigh_ifinfo) 106 { 107 if (!neigh_ifinfo) 108 return; 109 110 kref_put(&neigh_ifinfo->refcount, batadv_neigh_ifinfo_release); 111 } 112 113 /** 114 * batadv_hardif_neigh_put() - decrement the hardif neighbors refcounter 115 * and possibly release it 116 * @hardif_neigh: hardif neigh neighbor to free 117 */ 118 static inline void 119 batadv_hardif_neigh_put(struct batadv_hardif_neigh_node *hardif_neigh) 120 { 121 if (!hardif_neigh) 122 return; 123 124 kref_put(&hardif_neigh->refcount, batadv_hardif_neigh_release); 125 } 126 127 /** 128 * batadv_neigh_node_put() - decrement the neighbors refcounter and possibly 129 * release it 130 * @neigh_node: neigh neighbor to free 131 */ 132 static inline void batadv_neigh_node_put(struct batadv_neigh_node *neigh_node) 133 { 134 if (!neigh_node) 135 return; 136 137 kref_put(&neigh_node->refcount, batadv_neigh_node_release); 138 } 139 140 /** 141 * batadv_orig_ifinfo_put() - decrement the refcounter and possibly release 142 * the orig_ifinfo 143 * @orig_ifinfo: the orig_ifinfo object to release 144 */ 145 static inline void 146 batadv_orig_ifinfo_put(struct batadv_orig_ifinfo *orig_ifinfo) 147 { 148 if (!orig_ifinfo) 149 return; 150 151 kref_put(&orig_ifinfo->refcount, batadv_orig_ifinfo_release); 152 } 153 154 /** 155 * batadv_orig_node_put() - decrement the orig node refcounter and possibly 156 * release it 157 * @orig_node: the orig node to free 158 */ 159 static inline void batadv_orig_node_put(struct batadv_orig_node *orig_node) 160 { 161 if (!orig_node) 162 return; 163 164 kref_put(&orig_node->refcount, batadv_orig_node_release); 165 } 166 167 #endif /* _NET_BATMAN_ADV_ORIGINATOR_H_ */ 168