src/networkd/port.h

   1 /*#############################################################################
   2 #                                                                             #
   3 # IPFire.org - A linux based firewall                                         #
   4 # Copyright (C) 2023 IPFire Network Development Team                          #
   5 #                                                                             #
   6 # This program is free software: you can redistribute it and/or modify        #
   7 # it under the terms of the GNU General Public License as published by        #
   8 # the Free Software Foundation, either version 3 of the License, or           #
   9 # (at your option) any later version.                                         #
  10 #                                                                             #
  11 # This program is distributed in the hope that it will be useful,             #
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of              #
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               #
  14 # GNU General Public License for more details.                                #
  15 #                                                                             #
  16 # You should have received a copy of the GNU General Public License           #
  17 # along with this program.  If not, see <http://www.gnu.org/licenses/>.       #
  18 #                                                                             #
  19 #############################################################################*/
  20
  21 #ifndef NETWORKD_PORT_H
  22 #define NETWORKD_PORT_H
  23
  24 #include <json.h>
  25
  26 #include <systemd/sd-netlink.h>
  27
  28 #ifndef IF_NAMESIZE
  29 #define IF_NAMESIZE 16
  30 #endif
  31
  32 #define PORT_CONFIG_DIR                 CONFIG_DIR "/ports"
  33
  34 typedef struct nw_port nw_port;
  35
  36 typedef enum nw_port_type_id {
  37         NW_PORT_BONDING,
  38         NW_PORT_DUMMY,
  39         NW_PORT_VLAN,
  40 } nw_port_type_id_t;
  41
  42 typedef struct nw_port_type {
  43         // Type ID
  44         nw_port_type_id_t id;
  45
  46         // IFLA_INFO_KIND/IFLA_INFO_DATA
  47         const char* kind;
  48
  49         // Configuration
  50         int (*setup)(nw_port* port);
  51
  52         // Get Parent Port
  53         nw_port* (*get_parent_port)(nw_port* port);
  54
  55         // Link
  56         int (*create_link)(nw_port* port, sd_netlink_message* message);
  57         int (*destroy_link)(nw_port* port);
  58
  59         // JSON
  60         int (*to_json)(nw_port* port, struct json_object* object);
  61 } nw_port_type_t;
  62
  63 #include "address.h"
  64 #include "config.h"
  65 #include "daemon.h"
  66 #include "json.h"
  67 #include "port-bonding.h"
  68 #include "port-vlan.h"
  69
  70 #define NW_PORT_TYPE(port) (port->type)
  71
  72 struct nw_port {
  73         nw_daemon* daemon;
  74         int nrefs;
  75
  76         // Link
  77         nw_link* link;
  78
  79         const nw_port_type_t* type;
  80         char name[IF_NAMESIZE];
  81
  82         // Configuration
  83         nw_config *config;
  84
  85         // Common attributes
  86         nw_address_t address;
  87
  88         // Bonding Settings
  89         struct nw_port_bonding bonding;
  90
  91         // VLAN settings
  92         struct nw_port_vlan vlan;
  93 };
  94
  95 int nw_port_create(nw_port** port, nw_daemon* daemon,
  96         const nw_port_type_id_t type, const char* name, nw_config* config);
  97 int nw_port_create_from_config(nw_port** port, nw_daemon* daemon,
  98         const char* name, const char* path);
  99
 100 nw_port* nw_port_ref(nw_port* port);
 101 nw_port* nw_port_unref(nw_port* port);
 102
 103 int nw_port_destroy(nw_port* port);
 104 int __nw_port_drop_port(nw_daemon* daemon, nw_port* port, void* data);
 105
 106 int nw_port_save(nw_port* port);
 107
 108 const char* nw_port_name(nw_port* port);
 109
 110 char* nw_port_bus_path(nw_port* port);
 111
 112 int __nw_port_set_link(nw_daemon* daemon, nw_port* port, void* data);
 113 int __nw_port_drop_link(nw_daemon* daemon, nw_port* port, void* data);
 114
 115 const nw_address_t* nw_port_get_address(nw_port* port);
 116
 117 nw_port* nw_port_get_parent_port(nw_port* port);
 118
 119 int nw_port_reconfigure(nw_port* port);
 120
 121 int nw_port_has_carrier(nw_port* port);
 122
 123 int nw_port_check_type(nw_port* port, const nw_port_type_id_t type);
 124
 125 // Stats
 126 const struct rtnl_link_stats64* nw_port_get_stats64(nw_port* port);
 127 int __nw_port_update_stats(nw_daemon* daemon, nw_port* port, void* data);
 128 int nw_port_update_stats(nw_port* port);
 129
 130 // JSON
 131 int nw_port_to_json(nw_port* port, struct json_object** object);
 132
 133 #endif /* NETWORKD_PORT_H */