net/batman-adv/hard-interface.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /* Copyright (C) 2007-2017  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 enum batadv_hard_if_state {
  35         BATADV_IF_NOT_IN_USE,
  36         BATADV_IF_TO_BE_REMOVED,
  37         BATADV_IF_INACTIVE,
  38         BATADV_IF_ACTIVE,
  39         BATADV_IF_TO_BE_ACTIVATED,
  40         BATADV_IF_I_WANT_YOU,
  41 };
  42
  43 /**
  44  * enum batadv_hard_if_bcast - broadcast avoidance options
  45  * @BATADV_HARDIF_BCAST_OK: Do broadcast on according hard interface
  46  * @BATADV_HARDIF_BCAST_NORECIPIENT: Broadcast not needed, there is no recipient
  47  * @BATADV_HARDIF_BCAST_DUPFWD: There is just the neighbor we got it from
  48  * @BATADV_HARDIF_BCAST_DUPORIG: There is just the originator
  49  */
  50 enum batadv_hard_if_bcast {
  51         BATADV_HARDIF_BCAST_OK = 0,
  52         BATADV_HARDIF_BCAST_NORECIPIENT,
  53         BATADV_HARDIF_BCAST_DUPFWD,
  54         BATADV_HARDIF_BCAST_DUPORIG,
  55 };
  56
  57 /**
  58  * enum batadv_hard_if_cleanup - Cleanup modi for soft_iface after slave removal
  59  * @BATADV_IF_CLEANUP_KEEP: Don't automatically delete soft-interface
  60  * @BATADV_IF_CLEANUP_AUTO: Delete soft-interface after last slave was removed
  61  */
  62 enum batadv_hard_if_cleanup {
  63         BATADV_IF_CLEANUP_KEEP,
  64         BATADV_IF_CLEANUP_AUTO,
  65 };
  66
  67 extern struct notifier_block batadv_hard_if_notifier;
  68
  69 struct net_device *batadv_get_real_netdev(struct net_device *net_device);
  70 bool batadv_is_cfg80211_hardif(struct batadv_hard_iface *hard_iface);
  71 bool batadv_is_wifi_hardif(struct batadv_hard_iface *hard_iface);
  72 struct batadv_hard_iface*
  73 batadv_hardif_get_by_netdev(const struct net_device *net_dev);
  74 int batadv_hardif_enable_interface(struct batadv_hard_iface *hard_iface,
  75                                    struct net *net, const char *iface_name);
  76 void batadv_hardif_disable_interface(struct batadv_hard_iface *hard_iface,
  77                                      enum batadv_hard_if_cleanup autodel);
  78 void batadv_hardif_remove_interfaces(void);
  79 int batadv_hardif_min_mtu(struct net_device *soft_iface);
  80 void batadv_update_min_mtu(struct net_device *soft_iface);
  81 void batadv_hardif_release(struct kref *ref);
  82 int batadv_hardif_no_broadcast(struct batadv_hard_iface *if_outgoing,
  83                                u8 *orig_addr, u8 *orig_neigh);
  84
  85 /**
  86  * batadv_hardif_put - decrement the hard interface refcounter and possibly
  87  *  release it
  88  * @hard_iface: the hard interface to free
  89  */
  90 static inline void batadv_hardif_put(struct batadv_hard_iface *hard_iface)
  91 {
  92         kref_put(&hard_iface->refcount, batadv_hardif_release);
  93 }
  94
  95 static inline struct batadv_hard_iface *
  96 batadv_primary_if_get_selected(struct batadv_priv *bat_priv)
  97 {
  98         struct batadv_hard_iface *hard_iface;
  99
 100         rcu_read_lock();
 101         hard_iface = rcu_dereference(bat_priv->primary_if);
 102         if (!hard_iface)
 103                 goto out;
 104
 105         if (!kref_get_unless_zero(&hard_iface->refcount))
 106                 hard_iface = NULL;
 107
 108 out:
 109         rcu_read_unlock();
 110         return hard_iface;
 111 }
 112
 113 #endif /* _NET_BATMAN_ADV_HARD_INTERFACE_H_ */