^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) /* SPDX-License-Identifier: GPL-2.0 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /* Copyright (C) 2007-2020 B.A.T.M.A.N. contributors:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) * Marek Lindner, Simon Wunderlich
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) #ifndef _NET_BATMAN_ADV_MAIN_H_
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) #define _NET_BATMAN_ADV_MAIN_H_
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) #define BATADV_DRIVER_AUTHOR "Marek Lindner <mareklindner@neomailbox.ch>, " \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) "Simon Wunderlich <sw@simonwunderlich.de>"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) #define BATADV_DRIVER_DESC "B.A.T.M.A.N. advanced"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) #define BATADV_DRIVER_DEVICE "batman-adv"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) #ifndef BATADV_SOURCE_VERSION
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) #define BATADV_SOURCE_VERSION "2020.4"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) #endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) /* B.A.T.M.A.N. parameters */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) #define BATADV_TQ_MAX_VALUE 255
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) #define BATADV_THROUGHPUT_MAX_VALUE 0xFFFFFFFF
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) #define BATADV_JITTER 20
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) /* Time To Live of broadcast messages */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) #define BATADV_TTL 50
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) /* maximum sequence number age of broadcast messages */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) #define BATADV_BCAST_MAX_AGE 64
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) /* purge originators after time in seconds if no valid packet comes in
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) * -> TODO: check influence on BATADV_TQ_LOCAL_WINDOW_SIZE
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) #define BATADV_PURGE_TIMEOUT 200000 /* 200 seconds */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) #define BATADV_TT_LOCAL_TIMEOUT 600000 /* in milliseconds */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) #define BATADV_TT_CLIENT_ROAM_TIMEOUT 600000 /* in milliseconds */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) #define BATADV_TT_CLIENT_TEMP_TIMEOUT 600000 /* in milliseconds */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) #define BATADV_TT_WORK_PERIOD 5000 /* 5 seconds */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) #define BATADV_ORIG_WORK_PERIOD 1000 /* 1 second */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) #define BATADV_MCAST_WORK_PERIOD 500 /* 0.5 seconds */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) #define BATADV_DAT_ENTRY_TIMEOUT (5 * 60000) /* 5 mins in milliseconds */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) /* sliding packet range of received originator messages in sequence numbers
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) * (should be a multiple of our word size)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) #define BATADV_TQ_LOCAL_WINDOW_SIZE 64
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) /* milliseconds we have to keep pending tt_req */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) #define BATADV_TT_REQUEST_TIMEOUT 3000
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) #define BATADV_TQ_GLOBAL_WINDOW_SIZE 5
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) #define BATADV_TQ_LOCAL_BIDRECT_SEND_MINIMUM 1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) #define BATADV_TQ_LOCAL_BIDRECT_RECV_MINIMUM 1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) #define BATADV_TQ_TOTAL_BIDRECT_LIMIT 1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) /* B.A.T.M.A.N. V */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) #define BATADV_THROUGHPUT_DEFAULT_VALUE 10 /* 1 Mbps */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) #define BATADV_ELP_PROBES_PER_NODE 2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) #define BATADV_ELP_MIN_PROBE_SIZE 200 /* bytes */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) #define BATADV_ELP_PROBE_MAX_TX_DIFF 100 /* milliseconds */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) #define BATADV_ELP_MAX_AGE 64
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) #define BATADV_OGM_MAX_ORIGDIFF 5
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) #define BATADV_OGM_MAX_AGE 64
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) /* number of OGMs sent with the last tt diff */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) #define BATADV_TT_OGM_APPEND_MAX 3
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) /* Time in which a client can roam at most ROAMING_MAX_COUNT times in
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) * milliseconds
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) #define BATADV_ROAMING_MAX_TIME 20000
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) #define BATADV_ROAMING_MAX_COUNT 5
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) #define BATADV_NO_FLAGS 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) #define BATADV_NULL_IFINDEX 0 /* dummy ifindex used to avoid iface checks */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) #define BATADV_NO_MARK 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) /* default interface for multi interface operation. The default interface is
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) * used for communication which originated locally (i.e. is not forwarded)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) * or where special forwarding is not desired/necessary.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) #define BATADV_IF_DEFAULT ((struct batadv_hard_iface *)NULL)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) #define BATADV_NUM_WORDS BITS_TO_LONGS(BATADV_TQ_LOCAL_WINDOW_SIZE)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) #define BATADV_LOG_BUF_LEN 8192 /* has to be a power of 2 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) /* number of packets to send for broadcasts on different interface types */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) #define BATADV_NUM_BCASTS_DEFAULT 1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) #define BATADV_NUM_BCASTS_WIRELESS 3
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) #define BATADV_NUM_BCASTS_MAX 3
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) /* length of the single packet used by the TP meter */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) #define BATADV_TP_PACKET_LEN ETH_DATA_LEN
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) /* msecs after which an ARP_REQUEST is sent in broadcast as fallback */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) #define ARP_REQ_DELAY 250
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) /* numbers of originator to contact for any PUT/GET DHT operation */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) #define BATADV_DAT_CANDIDATES_NUM 3
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) /* BATADV_TQ_SIMILARITY_THRESHOLD - TQ points that a secondary metric can differ
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) * at most from the primary one in order to be still considered acceptable
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) #define BATADV_TQ_SIMILARITY_THRESHOLD 50
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) /* should not be bigger than 512 bytes or change the size of
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) * forw_packet->direct_link_flags
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) #define BATADV_MAX_AGGREGATION_BYTES 512
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) #define BATADV_MAX_AGGREGATION_MS 100
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) #define BATADV_BLA_PERIOD_LENGTH 10000 /* 10 seconds */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) #define BATADV_BLA_BACKBONE_TIMEOUT (BATADV_BLA_PERIOD_LENGTH * 6)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) #define BATADV_BLA_CLAIM_TIMEOUT (BATADV_BLA_PERIOD_LENGTH * 10)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) #define BATADV_BLA_WAIT_PERIODS 3
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) #define BATADV_BLA_LOOPDETECT_PERIODS 6
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) #define BATADV_BLA_LOOPDETECT_TIMEOUT 3000 /* 3 seconds */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) #define BATADV_DUPLIST_SIZE 16
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) #define BATADV_DUPLIST_TIMEOUT 500 /* 500 ms */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) /* don't reset again within 30 seconds */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) #define BATADV_RESET_PROTECTION_MS 30000
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) #define BATADV_EXPECTED_SEQNO_RANGE 65536
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) #define BATADV_NC_NODE_TIMEOUT 10000 /* Milliseconds */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) * BATADV_TP_MAX_NUM - maximum number of simultaneously active tp sessions
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) #define BATADV_TP_MAX_NUM 5
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) * enum batadv_mesh_state - State of a soft interface
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) enum batadv_mesh_state {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) /** @BATADV_MESH_INACTIVE: soft interface is not yet running */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) BATADV_MESH_INACTIVE,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) /** @BATADV_MESH_ACTIVE: interface is up and running */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) BATADV_MESH_ACTIVE,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) /** @BATADV_MESH_DEACTIVATING: interface is getting shut down */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) BATADV_MESH_DEACTIVATING,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) #define BATADV_BCAST_QUEUE_LEN 256
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) #define BATADV_BATMAN_QUEUE_LEN 256
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) * enum batadv_uev_action - action type of uevent
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) enum batadv_uev_action {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) /** @BATADV_UEV_ADD: gateway was selected (after none was selected) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) BATADV_UEV_ADD = 0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) * @BATADV_UEV_DEL: selected gateway was removed and none is selected
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) * anymore
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) BATADV_UEV_DEL,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163) * @BATADV_UEV_CHANGE: a different gateway was selected as based gateway
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165) BATADV_UEV_CHANGE,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168) * @BATADV_UEV_LOOPDETECT: loop was detected which cannot be handled by
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169) * bridge loop avoidance
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171) BATADV_UEV_LOOPDETECT,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175) * enum batadv_uev_type - Type of uevent
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177) enum batadv_uev_type {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178) /** @BATADV_UEV_GW: selected gateway was modified */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179) BATADV_UEV_GW = 0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 180)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 181) /** @BATADV_UEV_BLA: bridge loop avoidance event */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 182) BATADV_UEV_BLA,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 183) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 184)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 185) #define BATADV_GW_THRESHOLD 50
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 186)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 187) /* Number of fragment chains for each orig_node */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 188) #define BATADV_FRAG_BUFFER_COUNT 8
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 189) /* Maximum number of fragments for one packet */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 190) #define BATADV_FRAG_MAX_FRAGMENTS 16
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 191) /* Maxumim size of each fragment */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 192) #define BATADV_FRAG_MAX_FRAG_SIZE 1280
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 193) /* Time to keep fragments while waiting for rest of the fragments */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 194) #define BATADV_FRAG_TIMEOUT 10000
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 195)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 196) #define BATADV_DAT_CANDIDATE_NOT_FOUND 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 197) #define BATADV_DAT_CANDIDATE_ORIG 1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 198)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 199) /* Debug Messages */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 200) #ifdef pr_fmt
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 201) #undef pr_fmt
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 202) #endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 203) /* Append 'batman-adv: ' before kernel messages */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 204) #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 205)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 206) /* Kernel headers */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 207)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 208) #include <linux/atomic.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 209) #include <linux/compiler.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 210) #include <linux/etherdevice.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 211) #include <linux/if_vlan.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 212) #include <linux/jiffies.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 213) #include <linux/netdevice.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 214) #include <linux/percpu.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 215) #include <linux/seq_file.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 216) #include <linux/skbuff.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 217) #include <linux/types.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 218) #include <uapi/linux/batadv_packet.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 219)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 220) #include "types.h"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 221) #include "main.h"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 222)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 223) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 224) * batadv_print_vid() - return printable version of vid information
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 225) * @vid: the VLAN identifier
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 226) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 227) * Return: -1 when no VLAN is used, VLAN id otherwise
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 228) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 229) static inline int batadv_print_vid(unsigned short vid)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 230) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 231) if (vid & BATADV_VLAN_HAS_TAG)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 232) return (int)(vid & VLAN_VID_MASK);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 233) else
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 234) return -1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 235) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 236)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 237) extern struct list_head batadv_hardif_list;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 238) extern unsigned int batadv_hardif_generation;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 239)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 240) extern unsigned char batadv_broadcast_addr[];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 241) extern struct workqueue_struct *batadv_event_workqueue;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 242)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 243) int batadv_mesh_init(struct net_device *soft_iface);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 244) void batadv_mesh_free(struct net_device *soft_iface);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 245) bool batadv_is_my_mac(struct batadv_priv *bat_priv, const u8 *addr);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 246) struct batadv_hard_iface *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 247) batadv_seq_print_text_primary_if_get(struct seq_file *seq);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 248) int batadv_max_header_len(void);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 249) void batadv_skb_set_priority(struct sk_buff *skb, int offset);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 250) int batadv_batman_skb_recv(struct sk_buff *skb, struct net_device *dev,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 251) struct packet_type *ptype,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 252) struct net_device *orig_dev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 253) int
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 254) batadv_recv_handler_register(u8 packet_type,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 255) int (*recv_handler)(struct sk_buff *,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 256) struct batadv_hard_iface *));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 257) void batadv_recv_handler_unregister(u8 packet_type);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 258) __be32 batadv_skb_crc32(struct sk_buff *skb, u8 *payload_ptr);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 259)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 260) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 261) * batadv_compare_eth() - Compare two not u16 aligned Ethernet addresses
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 262) * @data1: Pointer to a six-byte array containing the Ethernet address
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 263) * @data2: Pointer other six-byte array containing the Ethernet address
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 264) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 265) * note: can't use ether_addr_equal() as it requires aligned memory
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 266) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 267) * Return: true if they are the same ethernet addr
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 268) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 269) static inline bool batadv_compare_eth(const void *data1, const void *data2)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 270) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 271) return ether_addr_equal_unaligned(data1, data2);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 272) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 273)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 274) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 275) * batadv_has_timed_out() - compares current time (jiffies) and timestamp +
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 276) * timeout
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 277) * @timestamp: base value to compare with (in jiffies)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 278) * @timeout: added to base value before comparing (in milliseconds)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 279) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 280) * Return: true if current time is after timestamp + timeout
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 281) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 282) static inline bool batadv_has_timed_out(unsigned long timestamp,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 283) unsigned int timeout)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 284) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 285) return time_is_before_jiffies(timestamp + msecs_to_jiffies(timeout));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 286) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 287)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 288) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 289) * batadv_atomic_dec_not_zero() - Decrease unless the number is 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 290) * @v: pointer of type atomic_t
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 291) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 292) * Return: non-zero if v was not 0, and zero otherwise.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 293) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 294) #define batadv_atomic_dec_not_zero(v) atomic_add_unless((v), -1, 0)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 295)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 296) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 297) * batadv_smallest_signed_int() - Returns the smallest signed integer in two's
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 298) * complement with the sizeof x
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 299) * @x: type of integer
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 300) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 301) * Return: smallest signed integer of type
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 302) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 303) #define batadv_smallest_signed_int(x) (1u << (7u + 8u * (sizeof(x) - 1u)))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 304)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 305) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 306) * batadv_seq_before() - Checks if a sequence number x is a predecessor of y
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 307) * @x: potential predecessor of @y
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 308) * @y: value to compare @x against
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 309) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 310) * It handles overflows/underflows and can correctly check for a predecessor
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 311) * unless the variable sequence number has grown by more than
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 312) * 2**(bitwidth(x)-1)-1.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 313) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 314) * This means that for a u8 with the maximum value 255, it would think:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 315) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 316) * * when adding nothing - it is neither a predecessor nor a successor
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 317) * * before adding more than 127 to the starting value - it is a predecessor,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 318) * * when adding 128 - it is neither a predecessor nor a successor,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 319) * * after adding more than 127 to the starting value - it is a successor
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 320) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 321) * Return: true when x is a predecessor of y, false otherwise
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 322) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 323) #define batadv_seq_before(x, y) ({ \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 324) typeof(x)_d1 = (x); \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 325) typeof(y)_d2 = (y); \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 326) typeof(x)_dummy = (_d1 - _d2); \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 327) (void)(&_d1 == &_d2); \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 328) _dummy > batadv_smallest_signed_int(_dummy); \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 329) })
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 330)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 331) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 332) * batadv_seq_after() - Checks if a sequence number x is a successor of y
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 333) * @x: potential successor of @y
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 334) * @y: value to compare @x against
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 335) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 336) * It handles overflows/underflows and can correctly check for a successor
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 337) * unless the variable sequence number has grown by more than
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 338) * 2**(bitwidth(x)-1)-1.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 339) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 340) * This means that for a u8 with the maximum value 255, it would think:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 341) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 342) * * when adding nothing - it is neither a predecessor nor a successor
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 343) * * before adding more than 127 to the starting value - it is a predecessor,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 344) * * when adding 128 - it is neither a predecessor nor a successor,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 345) * * after adding more than 127 to the starting value - it is a successor
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 346) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 347) * Return: true when x is a successor of y, false otherwise
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 348) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 349) #define batadv_seq_after(x, y) batadv_seq_before(y, x)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 350)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 351) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 352) * batadv_add_counter() - Add to per cpu statistics counter of soft interface
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 353) * @bat_priv: the bat priv with all the soft interface information
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 354) * @idx: counter index which should be modified
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 355) * @count: value to increase counter by
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 356) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 357) * Stop preemption on local cpu while incrementing the counter
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 358) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 359) static inline void batadv_add_counter(struct batadv_priv *bat_priv, size_t idx,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 360) size_t count)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 361) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 362) this_cpu_add(bat_priv->bat_counters[idx], count);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 363) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 364)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 365) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 366) * batadv_inc_counter() - Increase per cpu statistics counter of soft interface
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 367) * @b: the bat priv with all the soft interface information
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 368) * @i: counter index which should be modified
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 369) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 370) #define batadv_inc_counter(b, i) batadv_add_counter(b, i, 1)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 371)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 372) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 373) * BATADV_SKB_CB() - Get batadv_skb_cb from skb control buffer
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 374) * @__skb: skb holding the control buffer
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 375) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 376) * The members of the control buffer are defined in struct batadv_skb_cb in
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 377) * types.h. The macro is inspired by the similar macro TCP_SKB_CB() in tcp.h.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 378) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 379) * Return: pointer to the batadv_skb_cb of the skb
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 380) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 381) #define BATADV_SKB_CB(__skb) ((struct batadv_skb_cb *)&((__skb)->cb[0]))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 382)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 383) unsigned short batadv_get_vid(struct sk_buff *skb, size_t header_len);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 384) bool batadv_vlan_ap_isola_get(struct batadv_priv *bat_priv, unsigned short vid);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 385) int batadv_throw_uevent(struct batadv_priv *bat_priv, enum batadv_uev_type type,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 386) enum batadv_uev_action action, const char *data);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 387)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 388) #endif /* _NET_BATMAN_ADV_MAIN_H_ */