types.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416
  1. /* Copyright (C) 2007-2012 B.A.T.M.A.N. contributors:
  2. *
  3. * Marek Lindner, Simon Wunderlich
  4. *
  5. * This program is free software; you can redistribute it and/or
  6. * modify it under the terms of version 2 of the GNU General Public
  7. * License as published by the Free Software Foundation.
  8. *
  9. * This program is distributed in the hope that it will be useful, but
  10. * WITHOUT ANY WARRANTY; without even the implied warranty of
  11. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  12. * General Public License for more details.
  13. *
  14. * You should have received a copy of the GNU General Public License
  15. * along with this program; if not, write to the Free Software
  16. * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  17. * 02110-1301, USA
  18. */
  19. #ifndef _NET_BATMAN_ADV_TYPES_H_
  20. #define _NET_BATMAN_ADV_TYPES_H_
  21. #include "packet.h"
  22. #include "bitarray.h"
  23. #include <linux/kernel.h>
  24. #define BATADV_HEADER_LEN \
  25. (ETH_HLEN + max(sizeof(struct batadv_unicast_packet), \
  26. sizeof(struct batadv_bcast_packet)))
  27. struct batadv_hard_iface {
  28. struct list_head list;
  29. int16_t if_num;
  30. char if_status;
  31. struct net_device *net_dev;
  32. atomic_t seqno;
  33. atomic_t frag_seqno;
  34. unsigned char *packet_buff;
  35. int packet_len;
  36. struct kobject *hardif_obj;
  37. atomic_t refcount;
  38. struct packet_type batman_adv_ptype;
  39. struct net_device *soft_iface;
  40. struct rcu_head rcu;
  41. };
  42. /**
  43. * struct batadv_orig_node - structure for orig_list maintaining nodes of mesh
  44. * @primary_addr: hosts primary interface address
  45. * @last_seen: when last packet from this node was received
  46. * @bcast_seqno_reset: time when the broadcast seqno window was reset
  47. * @batman_seqno_reset: time when the batman seqno window was reset
  48. * @gw_flags: flags related to gateway class
  49. * @flags: for now only VIS_SERVER flag
  50. * @last_real_seqno: last and best known sequence number
  51. * @last_ttl: ttl of last received packet
  52. * @last_bcast_seqno: last broadcast sequence number received by this host
  53. *
  54. * @candidates: how many candidates are available
  55. * @selected: next bonding candidate
  56. */
  57. struct batadv_orig_node {
  58. uint8_t orig[ETH_ALEN];
  59. uint8_t primary_addr[ETH_ALEN];
  60. struct batadv_neigh_node __rcu *router; /* rcu protected pointer */
  61. unsigned long *bcast_own;
  62. uint8_t *bcast_own_sum;
  63. unsigned long last_seen;
  64. unsigned long bcast_seqno_reset;
  65. unsigned long batman_seqno_reset;
  66. uint8_t gw_flags;
  67. uint8_t flags;
  68. atomic_t last_ttvn; /* last seen translation table version number */
  69. uint16_t tt_crc;
  70. unsigned char *tt_buff;
  71. int16_t tt_buff_len;
  72. spinlock_t tt_buff_lock; /* protects tt_buff */
  73. atomic_t tt_size;
  74. bool tt_initialised;
  75. /* The tt_poss_change flag is used to detect an ongoing roaming phase.
  76. * If true, then I sent a Roaming_adv to this orig_node and I have to
  77. * inspect every packet directed to it to check whether it is still
  78. * the true destination or not. This flag will be reset to false as
  79. * soon as I receive a new TTVN from this orig_node
  80. */
  81. bool tt_poss_change;
  82. uint32_t last_real_seqno;
  83. uint8_t last_ttl;
  84. DECLARE_BITMAP(bcast_bits, BATADV_TQ_LOCAL_WINDOW_SIZE);
  85. uint32_t last_bcast_seqno;
  86. struct hlist_head neigh_list;
  87. struct list_head frag_list;
  88. spinlock_t neigh_list_lock; /* protects neigh_list and router */
  89. atomic_t refcount;
  90. struct rcu_head rcu;
  91. struct hlist_node hash_entry;
  92. struct batadv_priv *bat_priv;
  93. unsigned long last_frag_packet;
  94. /* ogm_cnt_lock protects: bcast_own, bcast_own_sum,
  95. * neigh_node->real_bits, neigh_node->real_packet_count
  96. */
  97. spinlock_t ogm_cnt_lock;
  98. /* bcast_seqno_lock protects bcast_bits, last_bcast_seqno */
  99. spinlock_t bcast_seqno_lock;
  100. spinlock_t tt_list_lock; /* protects tt_list */
  101. atomic_t bond_candidates;
  102. struct list_head bond_list;
  103. };
  104. struct batadv_gw_node {
  105. struct hlist_node list;
  106. struct batadv_orig_node *orig_node;
  107. unsigned long deleted;
  108. atomic_t refcount;
  109. struct rcu_head rcu;
  110. };
  111. /* batadv_neigh_node
  112. * @last_seen: when last packet via this neighbor was received
  113. */
  114. struct batadv_neigh_node {
  115. struct hlist_node list;
  116. uint8_t addr[ETH_ALEN];
  117. uint8_t real_packet_count;
  118. uint8_t tq_recv[BATADV_TQ_GLOBAL_WINDOW_SIZE];
  119. uint8_t tq_index;
  120. uint8_t tq_avg;
  121. uint8_t last_ttl;
  122. struct list_head bonding_list;
  123. unsigned long last_seen;
  124. DECLARE_BITMAP(real_bits, BATADV_TQ_LOCAL_WINDOW_SIZE);
  125. atomic_t refcount;
  126. struct rcu_head rcu;
  127. struct batadv_orig_node *orig_node;
  128. struct batadv_hard_iface *if_incoming;
  129. spinlock_t lq_update_lock; /* protects: tq_recv, tq_index */
  130. };
  131. #ifdef CONFIG_BATMAN_ADV_BLA
  132. struct batadv_bcast_duplist_entry {
  133. uint8_t orig[ETH_ALEN];
  134. uint16_t crc;
  135. unsigned long entrytime;
  136. };
  137. #endif
  138. enum batadv_counters {
  139. BATADV_CNT_TX,
  140. BATADV_CNT_TX_BYTES,
  141. BATADV_CNT_TX_DROPPED,
  142. BATADV_CNT_RX,
  143. BATADV_CNT_RX_BYTES,
  144. BATADV_CNT_FORWARD,
  145. BATADV_CNT_FORWARD_BYTES,
  146. BATADV_CNT_MGMT_TX,
  147. BATADV_CNT_MGMT_TX_BYTES,
  148. BATADV_CNT_MGMT_RX,
  149. BATADV_CNT_MGMT_RX_BYTES,
  150. BATADV_CNT_TT_REQUEST_TX,
  151. BATADV_CNT_TT_REQUEST_RX,
  152. BATADV_CNT_TT_RESPONSE_TX,
  153. BATADV_CNT_TT_RESPONSE_RX,
  154. BATADV_CNT_TT_ROAM_ADV_TX,
  155. BATADV_CNT_TT_ROAM_ADV_RX,
  156. BATADV_CNT_NUM,
  157. };
  158. struct batadv_priv {
  159. atomic_t mesh_state;
  160. struct net_device_stats stats;
  161. uint64_t __percpu *bat_counters; /* Per cpu counters */
  162. atomic_t aggregated_ogms; /* boolean */
  163. atomic_t bonding; /* boolean */
  164. atomic_t fragmentation; /* boolean */
  165. atomic_t ap_isolation; /* boolean */
  166. atomic_t bridge_loop_avoidance; /* boolean */
  167. atomic_t vis_mode; /* VIS_TYPE_* */
  168. atomic_t gw_mode; /* GW_MODE_* */
  169. atomic_t gw_sel_class; /* uint */
  170. atomic_t gw_bandwidth; /* gw bandwidth */
  171. atomic_t orig_interval; /* uint */
  172. atomic_t hop_penalty; /* uint */
  173. atomic_t log_level; /* uint */
  174. atomic_t bcast_seqno;
  175. atomic_t bcast_queue_left;
  176. atomic_t batman_queue_left;
  177. atomic_t ttvn; /* translation table version number */
  178. atomic_t tt_ogm_append_cnt;
  179. atomic_t tt_local_changes; /* changes registered in a OGM interval */
  180. atomic_t bla_num_requests; /* number of bla requests in flight */
  181. /* The tt_poss_change flag is used to detect an ongoing roaming phase.
  182. * If true, then I received a Roaming_adv and I have to inspect every
  183. * packet directed to me to check whether I am still the true
  184. * destination or not. This flag will be reset to false as soon as I
  185. * increase my TTVN
  186. */
  187. bool tt_poss_change;
  188. char num_ifaces;
  189. struct batadv_debug_log *debug_log;
  190. struct kobject *mesh_obj;
  191. struct dentry *debug_dir;
  192. struct hlist_head forw_bat_list;
  193. struct hlist_head forw_bcast_list;
  194. struct hlist_head gw_list;
  195. struct list_head tt_changes_list; /* tracks changes in a OGM int */
  196. struct list_head vis_send_list;
  197. struct batadv_hashtable *orig_hash;
  198. struct batadv_hashtable *tt_local_hash;
  199. struct batadv_hashtable *tt_global_hash;
  200. #ifdef CONFIG_BATMAN_ADV_BLA
  201. struct batadv_hashtable *claim_hash;
  202. struct batadv_hashtable *backbone_hash;
  203. #endif
  204. struct list_head tt_req_list; /* list of pending tt_requests */
  205. struct list_head tt_roam_list;
  206. struct batadv_hashtable *vis_hash;
  207. #ifdef CONFIG_BATMAN_ADV_BLA
  208. struct batadv_bcast_duplist_entry bcast_duplist[BATADV_DUPLIST_SIZE];
  209. int bcast_duplist_curr;
  210. struct batadv_bla_claim_dst claim_dest;
  211. #endif
  212. spinlock_t forw_bat_list_lock; /* protects forw_bat_list */
  213. spinlock_t forw_bcast_list_lock; /* protects */
  214. spinlock_t tt_changes_list_lock; /* protects tt_changes */
  215. spinlock_t tt_req_list_lock; /* protects tt_req_list */
  216. spinlock_t tt_roam_list_lock; /* protects tt_roam_list */
  217. spinlock_t gw_list_lock; /* protects gw_list and curr_gw */
  218. spinlock_t vis_hash_lock; /* protects vis_hash */
  219. spinlock_t vis_list_lock; /* protects vis_info::recv_list */
  220. atomic_t num_local_tt;
  221. /* Checksum of the local table, recomputed before sending a new OGM */
  222. uint16_t tt_crc;
  223. unsigned char *tt_buff;
  224. int16_t tt_buff_len;
  225. spinlock_t tt_buff_lock; /* protects tt_buff */
  226. struct delayed_work tt_work;
  227. struct delayed_work orig_work;
  228. struct delayed_work vis_work;
  229. struct delayed_work bla_work;
  230. struct batadv_gw_node __rcu *curr_gw; /* rcu protected pointer */
  231. atomic_t gw_reselect;
  232. struct batadv_hard_iface __rcu *primary_if; /* rcu protected pointer */
  233. struct batadv_vis_info *my_vis_info;
  234. struct batadv_algo_ops *bat_algo_ops;
  235. };
  236. struct batadv_socket_client {
  237. struct list_head queue_list;
  238. unsigned int queue_len;
  239. unsigned char index;
  240. spinlock_t lock; /* protects queue_list, queue_len, index */
  241. wait_queue_head_t queue_wait;
  242. struct batadv_priv *bat_priv;
  243. };
  244. struct batadv_socket_packet {
  245. struct list_head list;
  246. size_t icmp_len;
  247. struct batadv_icmp_packet_rr icmp_packet;
  248. };
  249. struct batadv_tt_common_entry {
  250. uint8_t addr[ETH_ALEN];
  251. struct hlist_node hash_entry;
  252. uint16_t flags;
  253. atomic_t refcount;
  254. struct rcu_head rcu;
  255. };
  256. struct batadv_tt_local_entry {
  257. struct batadv_tt_common_entry common;
  258. unsigned long last_seen;
  259. };
  260. struct batadv_tt_global_entry {
  261. struct batadv_tt_common_entry common;
  262. struct hlist_head orig_list;
  263. spinlock_t list_lock; /* protects the list */
  264. unsigned long roam_at; /* time at which TT_GLOBAL_ROAM was set */
  265. };
  266. struct batadv_tt_orig_list_entry {
  267. struct batadv_orig_node *orig_node;
  268. uint8_t ttvn;
  269. atomic_t refcount;
  270. struct rcu_head rcu;
  271. struct hlist_node list;
  272. };
  273. #ifdef CONFIG_BATMAN_ADV_BLA
  274. struct batadv_backbone_gw {
  275. uint8_t orig[ETH_ALEN];
  276. short vid; /* used VLAN ID */
  277. struct hlist_node hash_entry;
  278. struct batadv_priv *bat_priv;
  279. unsigned long lasttime; /* last time we heard of this backbone gw */
  280. atomic_t request_sent;
  281. atomic_t refcount;
  282. struct rcu_head rcu;
  283. uint16_t crc; /* crc checksum over all claims */
  284. };
  285. struct batadv_claim {
  286. uint8_t addr[ETH_ALEN];
  287. short vid;
  288. struct batadv_backbone_gw *backbone_gw;
  289. unsigned long lasttime; /* last time we heard of claim (locals only) */
  290. struct rcu_head rcu;
  291. atomic_t refcount;
  292. struct hlist_node hash_entry;
  293. };
  294. #endif
  295. struct batadv_tt_change_node {
  296. struct list_head list;
  297. struct batadv_tt_change change;
  298. };
  299. struct batadv_tt_req_node {
  300. uint8_t addr[ETH_ALEN];
  301. unsigned long issued_at;
  302. struct list_head list;
  303. };
  304. struct batadv_tt_roam_node {
  305. uint8_t addr[ETH_ALEN];
  306. atomic_t counter;
  307. unsigned long first_time;
  308. struct list_head list;
  309. };
  310. /* forw_packet - structure for forw_list maintaining packets to be
  311. * send/forwarded
  312. */
  313. struct batadv_forw_packet {
  314. struct hlist_node list;
  315. unsigned long send_time;
  316. uint8_t own;
  317. struct sk_buff *skb;
  318. uint16_t packet_len;
  319. uint32_t direct_link_flags;
  320. uint8_t num_packets;
  321. struct delayed_work delayed_work;
  322. struct batadv_hard_iface *if_incoming;
  323. };
  324. /* While scanning for vis-entries of a particular vis-originator
  325. * this list collects its interfaces to create a subgraph/cluster
  326. * out of them later
  327. */
  328. struct batadv_if_list_entry {
  329. uint8_t addr[ETH_ALEN];
  330. bool primary;
  331. struct hlist_node list;
  332. };
  333. struct batadv_debug_log {
  334. char log_buff[BATADV_LOG_BUF_LEN];
  335. unsigned long log_start;
  336. unsigned long log_end;
  337. spinlock_t lock; /* protects log_buff, log_start and log_end */
  338. wait_queue_head_t queue_wait;
  339. };
  340. struct batadv_frag_packet_list_entry {
  341. struct list_head list;
  342. uint16_t seqno;
  343. struct sk_buff *skb;
  344. };
  345. struct batadv_vis_info {
  346. unsigned long first_seen;
  347. /* list of server-neighbors we received a vis-packet
  348. * from. we should not reply to them.
  349. */
  350. struct list_head recv_list;
  351. struct list_head send_list;
  352. struct kref refcount;
  353. struct hlist_node hash_entry;
  354. struct batadv_priv *bat_priv;
  355. /* this packet might be part of the vis send queue. */
  356. struct sk_buff *skb_packet;
  357. /* vis_info may follow here */
  358. } __packed;
  359. struct batadv_vis_info_entry {
  360. uint8_t src[ETH_ALEN];
  361. uint8_t dest[ETH_ALEN];
  362. uint8_t quality; /* quality = 0 client */
  363. } __packed;
  364. struct batadv_recvlist_node {
  365. struct list_head list;
  366. uint8_t mac[ETH_ALEN];
  367. };
  368. struct batadv_algo_ops {
  369. struct hlist_node list;
  370. char *name;
  371. /* init routing info when hard-interface is enabled */
  372. int (*bat_iface_enable)(struct batadv_hard_iface *hard_iface);
  373. /* de-init routing info when hard-interface is disabled */
  374. void (*bat_iface_disable)(struct batadv_hard_iface *hard_iface);
  375. /* (re-)init mac addresses of the protocol information
  376. * belonging to this hard-interface
  377. */
  378. void (*bat_iface_update_mac)(struct batadv_hard_iface *hard_iface);
  379. /* called when primary interface is selected / changed */
  380. void (*bat_primary_iface_set)(struct batadv_hard_iface *hard_iface);
  381. /* prepare a new outgoing OGM for the send queue */
  382. void (*bat_ogm_schedule)(struct batadv_hard_iface *hard_iface);
  383. /* send scheduled OGM */
  384. void (*bat_ogm_emit)(struct batadv_forw_packet *forw_packet);
  385. };
  386. #endif /* _NET_BATMAN_ADV_TYPES_H_ */