net/batman-adv/hard-interface.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /* Copyright (C) 2007-2018  B.A.T.M.A.N. contributors:
   3  *
   4  * Marek Lindner, Simon Wunderlich
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of version 2 of the GNU General Public
   8  * License as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #ifndef _NET_BATMAN_ADV_HARD_INTERFACE_H_
  20 #define _NET_BATMAN_ADV_HARD_INTERFACE_H_
  21
  22 #include "main.h"
  23
  24 #include <linux/compiler.h>
  25 #include <linux/kref.h>
  26 #include <linux/notifier.h>
  27 #include <linux/rcupdate.h>
  28 #include <linux/stddef.h>
  29 #include <linux/types.h>
  30
  31 struct net_device;
  32 struct net;
  33
  34 /**
  35  * enum batadv_hard_if_state - State of a hard interface
  36  */
  37 enum batadv_hard_if_state {
  38         /**
  39          * @BATADV_IF_NOT_IN_USE: interface is not used as slave interface of a
  40          * batman-adv soft interface
  41          */
  42         BATADV_IF_NOT_IN_USE,
  43
  44         /**
  45          * @BATADV_IF_TO_BE_REMOVED: interface will be removed from soft
  46          * interface
  47          */
  48         BATADV_IF_TO_BE_REMOVED,
  49
  50         /** @BATADV_IF_INACTIVE: interface is deactivated */
  51         BATADV_IF_INACTIVE,
  52
  53         /** @BATADV_IF_ACTIVE: interface is used */
  54         BATADV_IF_ACTIVE,
  55
  56         /** @BATADV_IF_TO_BE_ACTIVATED: interface is getting activated */
  57         BATADV_IF_TO_BE_ACTIVATED,
  58
  59         /**
  60          * @BATADV_IF_I_WANT_YOU: interface is queued up (using sysfs) for being
  61          * added as slave interface of a batman-adv soft interface
  62          */
  63         BATADV_IF_I_WANT_YOU,
  64 };
  65
  66 /**
  67  * enum batadv_hard_if_bcast - broadcast avoidance options
  68  */
  69 enum batadv_hard_if_bcast {
  70         /** @BATADV_HARDIF_BCAST_OK: Do broadcast on according hard interface */
  71         BATADV_HARDIF_BCAST_OK = 0,
  72
  73         /**
  74          * @BATADV_HARDIF_BCAST_NORECIPIENT: Broadcast not needed, there is no
  75          *  recipient
  76          */
  77         BATADV_HARDIF_BCAST_NORECIPIENT,
  78
  79         /**
  80          * @BATADV_HARDIF_BCAST_DUPFWD: There is just the neighbor we got it
  81          *  from
  82          */
  83         BATADV_HARDIF_BCAST_DUPFWD,
  84
  85         /** @BATADV_HARDIF_BCAST_DUPORIG: There is just the originator */
  86         BATADV_HARDIF_BCAST_DUPORIG,
  87 };
  88
  89 /**
  90  * enum batadv_hard_if_cleanup - Cleanup modi for soft_iface after slave removal
  91  */
  92 enum batadv_hard_if_cleanup {
  93         /**
  94          * @BATADV_IF_CLEANUP_KEEP: Don't automatically delete soft-interface
  95          */
  96         BATADV_IF_CLEANUP_KEEP,
  97
  98         /**
  99          * @BATADV_IF_CLEANUP_AUTO: Delete soft-interface after last slave was
 100          *  removed
 101          */
 102         BATADV_IF_CLEANUP_AUTO,
 103 };
 104
 105 extern struct notifier_block batadv_hard_if_notifier;
 106
 107 struct net_device *batadv_get_real_netdev(struct net_device *net_device);
 108 bool batadv_is_cfg80211_hardif(struct batadv_hard_iface *hard_iface);
 109 bool batadv_is_wifi_hardif(struct batadv_hard_iface *hard_iface);
 110 struct batadv_hard_iface*
 111 batadv_hardif_get_by_netdev(const struct net_device *net_dev);
 112 int batadv_hardif_enable_interface(struct batadv_hard_iface *hard_iface,
 113                                    struct net *net, const char *iface_name);
 114 void batadv_hardif_disable_interface(struct batadv_hard_iface *hard_iface,
 115                                      enum batadv_hard_if_cleanup autodel);
 116 void batadv_hardif_remove_interfaces(void);
 117 int batadv_hardif_min_mtu(struct net_device *soft_iface);
 118 void batadv_update_min_mtu(struct net_device *soft_iface);
 119 void batadv_hardif_release(struct kref *ref);
 120 int batadv_hardif_no_broadcast(struct batadv_hard_iface *if_outgoing,
 121                                u8 *orig_addr, u8 *orig_neigh);
 122
 123 /**
 124  * batadv_hardif_put() - decrement the hard interface refcounter and possibly
 125  *  release it
 126  * @hard_iface: the hard interface to free
 127  */
 128 static inline void batadv_hardif_put(struct batadv_hard_iface *hard_iface)
 129 {
 130         kref_put(&hard_iface->refcount, batadv_hardif_release);
 131 }
 132
 133 /**
 134  * batadv_primary_if_get_selected() - Get reference to primary interface
 135  * @bat_priv: the bat priv with all the soft interface information
 136  *
 137  * Return: primary interface (with increased refcnt), otherwise NULL
 138  */
 139 static inline struct batadv_hard_iface *
 140 batadv_primary_if_get_selected(struct batadv_priv *bat_priv)
 141 {
 142         struct batadv_hard_iface *hard_iface;
 143
 144         rcu_read_lock();
 145         hard_iface = rcu_dereference(bat_priv->primary_if);
 146         if (!hard_iface)
 147                 goto out;
 148
 149         if (!kref_get_unless_zero(&hard_iface->refcount))
 150                 hard_iface = NULL;
 151
 152 out:
 153         rcu_read_unlock();
 154         return hard_iface;
 155 }
 156
 157 #endif /* _NET_BATMAN_ADV_HARD_INTERFACE_H_ */