net/8021q/vlan.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef __BEN_VLAN_802_1Q_INC__
   3 #define __BEN_VLAN_802_1Q_INC__
   4
   5 #include <linux/if_vlan.h>
   6 #include <linux/u64_stats_sync.h>
   7 #include <linux/list.h>
   8
   9 /* if this changes, algorithm will have to be reworked because this
  10  * depends on completely exhausting the VLAN identifier space.  Thus
  11  * it gives constant time look-up, but in many cases it wastes memory.
  12  */
  13 #define VLAN_GROUP_ARRAY_SPLIT_PARTS  8
  14 #define VLAN_GROUP_ARRAY_PART_LEN     (VLAN_N_VID/VLAN_GROUP_ARRAY_SPLIT_PARTS)
  15
  16 enum vlan_protos {
  17         VLAN_PROTO_8021Q        = 0,
  18         VLAN_PROTO_8021AD,
  19         VLAN_PROTO_NUM,
  20 };
  21
  22 struct vlan_group {
  23         unsigned int            nr_vlan_devs;
  24         struct hlist_node       hlist;  /* linked list */
  25         struct net_device **vlan_devices_arrays[VLAN_PROTO_NUM]
  26                                                [VLAN_GROUP_ARRAY_SPLIT_PARTS];
  27 };
  28
  29 struct vlan_info {
  30         struct net_device       *real_dev; /* The ethernet(like) device
  31                                             * the vlan is attached to.
  32                                             */
  33         struct vlan_group       grp;
  34         struct list_head        vid_list;
  35         unsigned int            nr_vids;
  36         struct rcu_head         rcu;
  37 };
  38
  39 static inline unsigned int vlan_proto_idx(__be16 proto)
  40 {
  41         switch (proto) {
  42         case htons(ETH_P_8021Q):
  43                 return VLAN_PROTO_8021Q;
  44         case htons(ETH_P_8021AD):
  45                 return VLAN_PROTO_8021AD;
  46         default:
  47                 BUG();
  48                 return 0;
  49         }
  50 }
  51
  52 static inline struct net_device *__vlan_group_get_device(struct vlan_group *vg,
  53                                                          unsigned int pidx,
  54                                                          u16 vlan_id)
  55 {
  56         struct net_device **array;
  57
  58         array = vg->vlan_devices_arrays[pidx]
  59                                        [vlan_id / VLAN_GROUP_ARRAY_PART_LEN];
  60         return array ? array[vlan_id % VLAN_GROUP_ARRAY_PART_LEN] : NULL;
  61 }
  62
  63 static inline struct net_device *vlan_group_get_device(struct vlan_group *vg,
  64                                                        __be16 vlan_proto,
  65                                                        u16 vlan_id)
  66 {
  67         return __vlan_group_get_device(vg, vlan_proto_idx(vlan_proto), vlan_id);
  68 }
  69
  70 static inline void vlan_group_set_device(struct vlan_group *vg,
  71                                          __be16 vlan_proto, u16 vlan_id,
  72                                          struct net_device *dev)
  73 {
  74         struct net_device **array;
  75         if (!vg)
  76                 return;
  77         array = vg->vlan_devices_arrays[vlan_proto_idx(vlan_proto)]
  78                                        [vlan_id / VLAN_GROUP_ARRAY_PART_LEN];
  79         array[vlan_id % VLAN_GROUP_ARRAY_PART_LEN] = dev;
  80 }
  81
  82 /* Must be invoked with rcu_read_lock or with RTNL. */
  83 static inline struct net_device *vlan_find_dev(struct net_device *real_dev,
  84                                                __be16 vlan_proto, u16 vlan_id)
  85 {
  86         struct vlan_info *vlan_info = rcu_dereference_rtnl(real_dev->vlan_info);
  87
  88         if (vlan_info)
  89                 return vlan_group_get_device(&vlan_info->grp,
  90                                              vlan_proto, vlan_id);
  91
  92         return NULL;
  93 }
  94
  95 #define vlan_group_for_each_dev(grp, i, dev) \
  96         for ((i) = 0; i < VLAN_PROTO_NUM * VLAN_N_VID; i++) \
  97                 if (((dev) = __vlan_group_get_device((grp), (i) / VLAN_N_VID, \
  98                                                             (i) % VLAN_N_VID)))
  99
 100 int vlan_filter_push_vids(struct vlan_info *vlan_info, __be16 proto);
 101 void vlan_filter_drop_vids(struct vlan_info *vlan_info, __be16 proto);
 102
 103 /* found in vlan_dev.c */
 104 void vlan_dev_set_ingress_priority(const struct net_device *dev,
 105                                    u32 skb_prio, u16 vlan_prio);
 106 int vlan_dev_set_egress_priority(const struct net_device *dev,
 107                                  u32 skb_prio, u16 vlan_prio);
 108 int vlan_dev_change_flags(const struct net_device *dev, u32 flag, u32 mask);
 109 void vlan_dev_get_realdev_name(const struct net_device *dev, char *result);
 110
 111 int vlan_check_real_dev(struct net_device *real_dev,
 112                         __be16 protocol, u16 vlan_id);
 113 void vlan_setup(struct net_device *dev);
 114 int register_vlan_dev(struct net_device *dev, struct netlink_ext_ack *extack);
 115 void unregister_vlan_dev(struct net_device *dev, struct list_head *head);
 116 bool vlan_dev_inherit_address(struct net_device *dev,
 117                               struct net_device *real_dev);
 118
 119 static inline u32 vlan_get_ingress_priority(struct net_device *dev,
 120                                             u16 vlan_tci)
 121 {
 122         struct vlan_dev_priv *vip = vlan_dev_priv(dev);
 123
 124         return vip->ingress_priority_map[(vlan_tci >> VLAN_PRIO_SHIFT) & 0x7];
 125 }
 126
 127 #ifdef CONFIG_VLAN_8021Q_GVRP
 128 int vlan_gvrp_request_join(const struct net_device *dev);
 129 void vlan_gvrp_request_leave(const struct net_device *dev);
 130 int vlan_gvrp_init_applicant(struct net_device *dev);
 131 void vlan_gvrp_uninit_applicant(struct net_device *dev);
 132 int vlan_gvrp_init(void);
 133 void vlan_gvrp_uninit(void);
 134 #else
 135 static inline int vlan_gvrp_request_join(const struct net_device *dev) { return 0; }
 136 static inline void vlan_gvrp_request_leave(const struct net_device *dev) {}
 137 static inline int vlan_gvrp_init_applicant(struct net_device *dev) { return 0; }
 138 static inline void vlan_gvrp_uninit_applicant(struct net_device *dev) {}
 139 static inline int vlan_gvrp_init(void) { return 0; }
 140 static inline void vlan_gvrp_uninit(void) {}
 141 #endif
 142
 143 #ifdef CONFIG_VLAN_8021Q_MVRP
 144 int vlan_mvrp_request_join(const struct net_device *dev);
 145 void vlan_mvrp_request_leave(const struct net_device *dev);
 146 int vlan_mvrp_init_applicant(struct net_device *dev);
 147 void vlan_mvrp_uninit_applicant(struct net_device *dev);
 148 int vlan_mvrp_init(void);
 149 void vlan_mvrp_uninit(void);
 150 #else
 151 static inline int vlan_mvrp_request_join(const struct net_device *dev) { return 0; }
 152 static inline void vlan_mvrp_request_leave(const struct net_device *dev) {}
 153 static inline int vlan_mvrp_init_applicant(struct net_device *dev) { return 0; }
 154 static inline void vlan_mvrp_uninit_applicant(struct net_device *dev) {}
 155 static inline int vlan_mvrp_init(void) { return 0; }
 156 static inline void vlan_mvrp_uninit(void) {}
 157 #endif
 158
 159 extern const char vlan_fullname[];
 160 extern const char vlan_version[];
 161 int vlan_netlink_init(void);
 162 void vlan_netlink_fini(void);
 163
 164 extern struct rtnl_link_ops vlan_link_ops;
 165
 166 extern unsigned int vlan_net_id;
 167
 168 struct proc_dir_entry;
 169
 170 struct vlan_net {
 171         /* /proc/net/vlan */
 172         struct proc_dir_entry *proc_vlan_dir;
 173         /* /proc/net/vlan/config */
 174         struct proc_dir_entry *proc_vlan_conf;
 175         /* Determines interface naming scheme. */
 176         unsigned short name_type;
 177 };
 178
 179 #endif /* !(__BEN_VLAN_802_1Q_INC__) */