summaryrefslogtreecommitdiff
path: root/libnm-core/nm-setting-vlan.h
blob: 9fb202a2fb6c4800646195145cad35866475c5f6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
// SPDX-License-Identifier: LGPL-2.1+
/*
 * Copyright (C) 2011 - 2014 Red Hat, Inc.
 */

#ifndef __NM_SETTING_VLAN_H__
#define __NM_SETTING_VLAN_H__

#if !defined(__NETWORKMANAGER_H_INSIDE__) && !defined(NETWORKMANAGER_COMPILATION)
    #error "Only <NetworkManager.h> can be included directly."
#endif

#include "nm-setting.h"
#include <linux/if_vlan.h>

G_BEGIN_DECLS

#define NM_TYPE_SETTING_VLAN (nm_setting_vlan_get_type())
#define NM_SETTING_VLAN(obj) \
    (G_TYPE_CHECK_INSTANCE_CAST((obj), NM_TYPE_SETTING_VLAN, NMSettingVlan))
#define NM_SETTING_VLAN_CLASS(klass) \
    (G_TYPE_CHECK_CLASS_CAST((klass), NM_TYPE_SETTING_VLANCONFIG, NMSettingVlanClass))
#define NM_IS_SETTING_VLAN(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj), NM_TYPE_SETTING_VLAN))
#define NM_IS_SETTING_VLAN_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), NM_TYPE_SETTING_VLAN))
#define NM_SETTING_VLAN_GET_CLASS(obj) \
    (G_TYPE_INSTANCE_GET_CLASS((obj), NM_TYPE_SETTING_VLAN, NMSettingVlanClass))

#define NM_SETTING_VLAN_SETTING_NAME "vlan"

#define NM_SETTING_VLAN_PARENT               "parent"
#define NM_SETTING_VLAN_ID                   "id"
#define NM_SETTING_VLAN_FLAGS                "flags"
#define NM_SETTING_VLAN_INGRESS_PRIORITY_MAP "ingress-priority-map"
#define NM_SETTING_VLAN_EGRESS_PRIORITY_MAP  "egress-priority-map"

/**
 * NMSettingVlan:
 *
 * VLAN Settings
 */
struct _NMSettingVlan {
    NMSetting parent;
};

typedef struct {
    NMSettingClass parent;

    /*< private >*/
    gpointer padding[4];
} NMSettingVlanClass;

/**
 * NMVlanPriorityMap:
 * @NM_VLAN_INGRESS_MAP: map for incoming data
 * @NM_VLAN_EGRESS_MAP: map for outgoing data
 *
 * A selector for traffic priority maps; these map Linux SKB priorities
 * to 802.1p priorities used in VLANs.
 **/
// clang-format off
typedef enum {
    NM_VLAN_INGRESS_MAP,
    NM_VLAN_EGRESS_MAP
} NMVlanPriorityMap;
// clang-format on

/**
 * NMVlanFlags:
 * @NM_VLAN_FLAG_REORDER_HEADERS: indicates that this interface should reorder
 *  outgoing packet headers to look more like a non-VLAN Ethernet interface
 * @NM_VLAN_FLAG_GVRP: indicates that this interface should use GVRP to register
 *  itself with its switch
 * @NM_VLAN_FLAG_LOOSE_BINDING: indicates that this interface's operating
 *  state is tied to the underlying network interface but other details
 *  (like routing) are not.
 * @NM_VLAN_FLAG_MVRP: indicates that this interface should use MVRP to register
 *  itself with its switch
 *
 * #NMVlanFlags values control the behavior of the VLAN interface.
 **/
typedef enum { /*< flags >*/
               NM_VLAN_FLAG_REORDER_HEADERS = 0x1,
               NM_VLAN_FLAG_GVRP            = 0x2,
               NM_VLAN_FLAG_LOOSE_BINDING   = 0x4,
               NM_VLAN_FLAG_MVRP            = 0x8,

               /* NOTE: if adding flags update nm-setting-vlan.c::verify() */

               /* NOTE: these flags must correspond to the value from the kernel
     * header files. */
} NMVlanFlags;

#define NM_VLAN_FLAGS_ALL                                                          \
    (NM_VLAN_FLAG_REORDER_HEADERS | NM_VLAN_FLAG_GVRP | NM_VLAN_FLAG_LOOSE_BINDING \
     | NM_VLAN_FLAG_MVRP)

GType      nm_setting_vlan_get_type(void);
NMSetting *nm_setting_vlan_new(void);

const char *nm_setting_vlan_get_parent(NMSettingVlan *setting);
guint32     nm_setting_vlan_get_id(NMSettingVlan *setting);
guint32     nm_setting_vlan_get_flags(NMSettingVlan *setting);

gint32 nm_setting_vlan_get_num_priorities(NMSettingVlan *setting, NMVlanPriorityMap map);

gboolean nm_setting_vlan_get_priority(NMSettingVlan *   setting,
                                      NMVlanPriorityMap map,
                                      guint32           idx,
                                      guint32 *         out_from,
                                      guint32 *         out_to);

gboolean nm_setting_vlan_add_priority(NMSettingVlan *   setting,
                                      NMVlanPriorityMap map,
                                      guint32           from,
                                      guint32           to);

void nm_setting_vlan_remove_priority(NMSettingVlan *setting, NMVlanPriorityMap map, guint32 idx);

gboolean nm_setting_vlan_remove_priority_by_value(NMSettingVlan *   setting,
                                                  NMVlanPriorityMap map,
                                                  guint32           from,
                                                  guint32           to);

gboolean nm_setting_vlan_remove_priority_str_by_value(NMSettingVlan *   setting,
                                                      NMVlanPriorityMap map,
                                                      const char *      str);

void nm_setting_vlan_clear_priorities(NMSettingVlan *setting, NMVlanPriorityMap map);

gboolean
nm_setting_vlan_add_priority_str(NMSettingVlan *setting, NMVlanPriorityMap map, const char *str);

G_END_DECLS

#endif /* __NM_SETTING_VLAN_H__ */