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 #define PORT_CONFIG_DIR                 CONFIG_DIR "/ports"
  25
  26 typedef enum nw_port_type {
  27         NW_PORT_UNKNOWN = 0,
  28         NW_PORT_DUMMY,
  29         NW_PORT_VLAN,
  30 } nw_port_type_t;
  31
  32 // VLAN
  33 #define NW_VLAN_ID_INVALID              0
  34 #define NW_VLAN_ID_MIN                  1
  35 #define NW_VLAN_ID_MAX                  4096
  36
  37 typedef struct nw_port nw_port;
  38
  39 #include "address.h"
  40 #include "config.h"
  41 #include "daemon.h"
  42
  43 typedef struct nw_port_ops {
  44         // Configuration
  45         int (*config_read)(nw_port* port, nw_config* config);
  46         int (*config_write)(nw_port* port, nw_config* config);
  47 } nw_port_ops_t;
  48
  49 int nw_port_create(nw_port** port, nw_daemon* daemon,
  50         nw_port_type_t type, const char* name);
  51 int nw_port_create_from_config(nw_port** port, nw_daemon* daemon,
  52         const char* name, const char* path);
  53
  54 nw_port* nw_port_ref(nw_port* port);
  55 nw_port* nw_port_unref(nw_port* port);
  56
  57 int nw_port_destroy(nw_port* port);
  58 int __nw_port_drop_port(nw_daemon* daemon, nw_port* port, void* data);
  59
  60 int nw_port_save(nw_port* port);
  61
  62 const char* nw_port_name(nw_port* port);
  63
  64 char* nw_port_bus_path(nw_port* port);
  65
  66 int __nw_port_set_link(nw_daemon* daemon, nw_port* port, void* data);
  67 int __nw_port_drop_link(nw_daemon* daemon, nw_port* port, void* data);
  68
  69 const nw_address_t* nw_port_get_address(nw_port* port);
  70
  71 int nw_port_reconfigure(nw_port* port);
  72
  73 int nw_port_has_carrier(nw_port* port);
  74
  75 // Stats
  76 const struct rtnl_link_stats64* nw_port_get_stats64(nw_port* port);
  77 int __nw_port_update_stats(nw_daemon* daemon, nw_port* port, void* data);
  78 int nw_port_update_stats(nw_port* port);
  79
  80 // VLAN
  81 int nw_port_get_vlan_id(nw_port* port);
  82 int nw_port_set_vlan_id(nw_port* port, int id);
  83
  84 nw_port* nw_port_get_vlan_parent(nw_port* port);
  85 int nw_port_set_vlan_parent(nw_port* port, nw_port* parent);
  86
  87 #endif /* NETWORKD_PORT_H */