[B.A.T.M.A.N.] [PATCHv3 5/9] batman-adv: add bat_metric_is_equiv_or_better API function

Antonio Quartulli
2013-08-13T06:43:48Z

From: Antonio Quartulli <antonio@open-mesh.com>

Each routing protocol has its own metric semantic and
therefore is the protocol itself the only component able to
compare two metrics to check similarity similarity.

This new API allows each routing protocol to implement its
own logic and make the external code protocol agnostic.

Signed-off-by: Antonio Quartulli <antonio@open-mesh.com>
---
bat_iv_ogm.c | 6 ++++++
main.c | 3 ++-
main.h | 6 ++++++
types.h | 4 ++++
4 files changed, 18 insertions(+), 1 deletion(-)

diff --git a/bat_iv_ogm.c b/bat_iv_ogm.c
index 6865ccf..12a9686 100644
--- a/bat_iv_ogm.c
+++ b/bat_iv_ogm.c
@@ -1465,6 +1465,11 @@ static uint32_t batadv_iv_ogm_metric_get(struct batadv_neigh_node *neigh_node)
return neigh_node->bat_iv.tq_avg;
}

+static bool batadv_iv_ogm_metric_is_eob(uint32_t metric, uint32_t new_metric)
+{
+ return (metric - new_metric < BATADV_TQ_SIMILARITY_THRESHOLD);
+}
+
static struct batadv_algo_ops batadv_batman_iv __read_mostly = {
.name = "BATMAN_IV",
.bat_iface_enable = batadv_iv_ogm_iface_enable,
@@ -1474,6 +1479,7 @@ static struct batadv_algo_ops batadv_batman_iv __read_mostly = {
.bat_ogm_schedule = batadv_iv_ogm_schedule,
.bat_ogm_emit = batadv_iv_ogm_emit,
.bat_metric_get = batadv_iv_ogm_metric_get,
+ .bat_metric_is_equiv_or_better = batadv_iv_ogm_metric_is_eob,
.bat_orig_print = batadv_iv_ogm_orig_print,
};

diff --git a/main.c b/main.c
index 975973f..bf6ece1 100644
--- a/main.c
+++ b/main.c
@@ -503,7 +503,8 @@ int batadv_algo_register(struct batadv_algo_ops *bat_algo_ops)
!bat_algo_ops->bat_primary_iface_set ||
!bat_algo_ops->bat_ogm_schedule ||
!bat_algo_ops->bat_ogm_emit ||
- !bat_algo_ops->bat_metric_get) {
+ !bat_algo_ops->bat_metric_get ||
+ !bat_algo_ops->bat_metric_is_equiv_or_better) {
pr_info("Routing algo '%s' does not implement required ops\n",
bat_algo_ops->name);
ret = -EINVAL;
diff --git a/main.h b/main.h
index e860f1e..ebdfad8 100644
--- a/main.h
+++ b/main.h
@@ -86,6 +86,12 @@
/* numbers of originator to contact for any PUT/GET DHT operation */
#define BATADV_DAT_CANDIDATES_NUM 3

+/**
+ * BATADV_TQ_SIMILARITY_THRESHOLD - TQ points that a secondary metric can differ
+ * at most from the primary one in order to be still considered acceptable
+ */
+#define BATADV_TQ_SIMILARITY_THRESHOLD 50
+
/* how much worse secondary interfaces may be to be considered as bonding
* candidates
*/
diff --git a/types.h b/types.h
index 2b5b1c1..7a12eef 100644
--- a/types.h
+++ b/types.h
@@ -991,6 +991,8 @@ struct batadv_forw_packet {
* @bat_primary_iface_set: called when primary interface is selected / changed
* @bat_ogm_schedule: prepare a new outgoing OGM for the send queue
* @bat_ogm_emit: send scheduled OGM
+ * @bat_metric_is_equiv_or_better: check if new_metric is good enough to be
+ * comparable with metric
* @bat_orig_print: print the originator table
*/
struct batadv_algo_ops {
@@ -1003,6 +1005,8 @@ struct batadv_algo_ops {
void (*bat_ogm_schedule)(struct batadv_hard_iface *hard_iface);
void (*bat_ogm_emit)(struct batadv_forw_packet *forw_packet);
uint32_t (*bat_metric_get)(struct batadv_neigh_node *neigh_node);
+ bool (*bat_metric_is_equiv_or_better)(uint32_t metric,
+ uint32_t new_metric);
/* orig_node handling API */
void (*bat_orig_print)(struct batadv_priv *priv, struct seq_file *seq);
};
--
1.8.1.5