src/PVE/Network/SDN/Zones/Plugin.pm

   1 package PVE::Network::SDN::Zones::Plugin;
   2
   3 use strict;
   4 use warnings;
   5
   6 use PVE::Tools qw(run_command);
   7 use PVE::JSONSchema;
   8 use PVE::Cluster;
   9 use PVE::Network;
  10
  11 use PVE::JSONSchema qw(get_standard_option);
  12 use base qw(PVE::SectionConfig);
  13
  14 PVE::Cluster::cfs_register_file(
  15     'sdn/zones.cfg',
  16     sub { __PACKAGE__->parse_config(@_); },
  17     sub { __PACKAGE__->write_config(@_); },
  18 );
  19
  20 PVE::JSONSchema::register_standard_option('pve-sdn-zone-id', {
  21     description => "The SDN zone object identifier.",
  22     type => 'string', format => 'pve-sdn-zone-id',
  23 });
  24
  25 PVE::JSONSchema::register_format('pve-sdn-zone-id', \&parse_sdn_zone_id);
  26 sub parse_sdn_zone_id {
  27     my ($id, $noerr) = @_;
  28
  29     if ($id !~ m/^[a-z][a-z0-9]*[a-z0-9]$/i) {
  30         return undef if $noerr;
  31         die "zone ID '$id' contains illegal characters\n";
  32     }
  33     die "zone ID '$id' can't be more length than 8 characters\n" if length($id) > 8;
  34     return $id;
  35 }
  36
  37 my $defaultData = {
  38
  39     propertyList => {
  40         type => {
  41             description => "Plugin type.",
  42             type => 'string', format => 'pve-configid',
  43             type => 'string',
  44         },
  45         nodes => get_standard_option('pve-node-list', { optional => 1 }),
  46         zone => get_standard_option('pve-sdn-zone-id', {
  47             completion => \&PVE::Network::SDN::Zones::complete_sdn_zone,
  48         }),
  49         ipam => {
  50             type => 'string',
  51             description => "use a specific ipam",
  52             optional => 1,
  53         },
  54     },
  55 };
  56
  57 sub private {
  58     return $defaultData;
  59 }
  60
  61 sub parse_section_header {
  62     my ($class, $line) = @_;
  63
  64     if ($line =~ m/^(\S+):\s*(\S+)\s*$/) {
  65         my ($type, $id) = (lc($1), $2);
  66         my $errmsg = undef; # set if you want to skip whole section
  67         eval { PVE::JSONSchema::pve_verify_configid($type); };
  68         $errmsg = $@ if $@;
  69         my $config = {}; # to return additional attributes
  70         return ($type, $id, $errmsg, $config);
  71     }
  72     return undef;
  73 }
  74
  75 sub decode_value {
  76     my ($class, $type, $key, $value) = @_;
  77
  78     if ($key eq 'nodes' || $key eq 'exitnodes') {
  79         my $res = {};
  80
  81         foreach my $node (PVE::Tools::split_list($value)) {
  82             if (PVE::JSONSchema::pve_verify_node_name($node)) {
  83                 $res->{$node} = 1;
  84             }
  85         }
  86
  87         return $res;
  88     }
  89
  90     return $value;
  91 }
  92
  93 sub encode_value {
  94     my ($class, $type, $key, $value) = @_;
  95
  96     if ($key eq 'nodes' || $key eq 'exitnodes') {
  97         return join(',', keys(%$value));
  98     }
  99
 100     return $value;
 101 }
 102
 103 sub generate_sdn_config {
 104     my ($class, $plugin_config, $zoneid, $vnetid, $vnet, $controller, $controller_cfg, $subnet_cfg, $interfaces_config, $config) = @_;
 105
 106     die "please implement inside plugin";
 107 }
 108
 109 sub generate_controller_config {
 110     my ($class, $plugin_config, $controller, $id, $uplinks, $config) = @_;
 111
 112     die "please implement inside plugin";
 113 }
 114
 115 sub generate_controller_vnet_config {
 116     my ($class, $plugin_config, $controller, $zoneid, $vnetid, $config) = @_;
 117
 118 }
 119
 120 sub write_controller_config {
 121     my ($class, $plugin_config, $config) = @_;
 122
 123     die "please implement inside plugin";
 124 }
 125
 126 sub controller_reload {
 127     my ($class) = @_;
 128
 129     die "please implement inside plugin";
 130 }
 131
 132 sub on_delete_hook {
 133     my ($class, $zoneid, $vnet_cfg) = @_;
 134
 135     # verify that no vnet are associated to this zone
 136     foreach my $id (keys %{$vnet_cfg->{ids}}) {
 137         my $vnet = $vnet_cfg->{ids}->{$id};
 138         die "zone $zoneid is used by vnet $id"
 139             if ($vnet->{type} eq 'vnet' && defined($vnet->{zone}) && $vnet->{zone} eq $zoneid);
 140     }
 141 }
 142
 143 sub on_update_hook {
 144     my ($class, $zoneid, $zone_cfg, $controller_cfg) = @_;
 145
 146     # do nothing by default
 147 }
 148
 149 sub vnet_update_hook {
 150     my ($class, $vnet_cfg, $vnetid, $zone_cfg) = @_;
 151
 152     # do nothing by default
 153 }
 154
 155 #helpers
 156 sub parse_tag_number_or_range {
 157     my ($str, $max, $tag) = @_;
 158
 159     my @elements = split(/,/, $str);
 160     my $count = 0;
 161     my $allowed = undef;
 162
 163     die "extraneous commas in list\n" if $str ne join(',', @elements);
 164     foreach my $item (@elements) {
 165         if ($item =~ m/^([0-9]+)-([0-9]+)$/) {
 166             $count += 2;
 167             my ($port1, $port2) = ($1, $2);
 168             die "invalid port '$port1'\n" if $port1 > $max;
 169             die "invalid port '$port2'\n" if $port2 > $max;
 170             die "backwards range '$port1:$port2' not allowed, did you mean '$port2:$port1'?\n" if $port1 > $port2;
 171
 172             if ($tag && $tag >= $port1 && $tag <= $port2){
 173                 $allowed = 1;
 174                 last;
 175             }
 176
 177         } elsif ($item =~ m/^([0-9]+)$/) {
 178             $count += 1;
 179             my $port = $1;
 180             die "invalid port '$port'\n" if $port > $max;
 181
 182             if ($tag && $tag == $port){
 183                 $allowed = 1;
 184                 last;
 185             }
 186         }
 187     }
 188     die "tag $tag is not allowed" if $tag && !$allowed;
 189
 190     return (scalar(@elements) > 1);
 191 }
 192
 193 sub generate_status_message {
 194     my ($class, $vnetid, $status, $ifaces) = @_;
 195
 196     my $err_msg = [];
 197
 198     return ["vnet is not generated. Please check you reload network task log."] if !$status->{$vnetid}->{status};
 199
 200     foreach my $iface (@{$ifaces}) {
 201         if (!$status->{$iface}->{status}) {
 202             push @$err_msg, "missing $iface";
 203         } elsif ($status->{$iface}->{status} ne 'pass') {
 204             push @$err_msg, "error $iface";
 205         }
 206     }
 207
 208     return $err_msg;
 209 }
 210
 211 sub status {
 212     my ($class, $plugin_config, $zone, $vnetid, $vnet, $status) = @_;
 213
 214     my $err_msg = $class->generate_status_message($vnetid, $status);
 215     return $err_msg;
 216
 217 }
 218
 219
 220 sub tap_create {
 221     my ($class, $plugin_config, $vnet, $iface, $vnetid) = @_;
 222
 223     PVE::Network::tap_create($iface, $vnetid);
 224 }
 225
 226 sub veth_create {
 227     my ($class, $plugin_config, $vnet, $veth, $vethpeer, $vnetid, $hwaddr) = @_;
 228
 229     PVE::Network::veth_create($veth, $vethpeer, $vnetid, $hwaddr);
 230 }
 231
 232 sub tap_plug {
 233     my ($class, $plugin_config, $vnet, $tag, $iface, $vnetid, $firewall, $trunks, $rate) = @_;
 234
 235     my $vlan_aware = PVE::Tools::file_read_firstline("/sys/class/net/$vnetid/bridge/vlan_filtering");
 236     die "vm vlans are not allowed on vnet $vnetid" if !$vlan_aware && ($tag || $trunks);
 237
 238     my $opts = {};
 239     $opts->{learning} = 0 if $plugin_config->{'bridge-disable-mac-learning'};
 240     PVE::Network::tap_plug($iface, $vnetid, $tag, $firewall, $trunks, $rate, $opts);
 241 }
 242
 243 #helper
 244
 245 sub get_uplink_iface {
 246     my ($interfaces_config, $uplink) = @_;
 247
 248     my $iface = undef;
 249     foreach my $id (keys %{$interfaces_config->{ifaces}}) {
 250         my $interface = $interfaces_config->{ifaces}->{$id};
 251         if (my $iface_uplink = $interface->{'uplink-id'}) {
 252             next if $iface_uplink ne $uplink;
 253             if($interface->{type} ne 'eth' && $interface->{type} ne 'bond') {
 254                 warn "uplink $uplink is not a physical or bond interface";
 255                 next;
 256             }
 257             $iface = $id;
 258         }
 259     }
 260
 261     #create a dummy uplink interface if no uplink found
 262     if(!$iface) {
 263         warn "can't find uplink $uplink in physical interface";
 264         $iface = "uplink${uplink}";
 265     }
 266
 267     return $iface;
 268 }
 269
 270 sub get_local_route_ip {
 271     my ($targetip) = @_;
 272
 273     my $ip = undef;
 274     my $interface = undef;
 275
 276     run_command(['/sbin/ip', 'route', 'get', $targetip], outfunc => sub {
 277         if ($_[0] =~ m/src ($PVE::Tools::IPRE)/) {
 278             $ip = $1;
 279         }
 280         if ($_[0] =~ m/dev (\S+)/) {
 281             $interface = $1;
 282         }
 283
 284     });
 285     return ($ip, $interface);
 286 }
 287
 288
 289 sub find_local_ip_interface_peers {
 290     my ($peers, $iface) = @_;
 291
 292     my $network_config = PVE::INotify::read_file('interfaces');
 293     my $ifaces = $network_config->{ifaces};
 294
 295     #if iface is defined, return ip if exist (if not,try to find it on other ifaces)
 296     if ($iface) {
 297         my $ip = $ifaces->{$iface}->{address};
 298         return ($ip,$iface) if $ip;
 299     }
 300
 301     #is a local ip member of peers list ?
 302     foreach my $address (@{$peers}) {
 303         while (my $interface = each %$ifaces) {
 304             my $ip = $ifaces->{$interface}->{address};
 305             if ($ip && $ip eq $address) {
 306                 return ($ip, $interface);
 307             }
 308         }
 309     }
 310
 311     #if peer is remote, find source with ip route
 312     foreach my $address (@{$peers}) {
 313         my ($ip, $interface) = get_local_route_ip($address);
 314         return ($ip, $interface);
 315     }
 316 }
 317
 318 sub find_bridge {
 319     my ($bridge) = @_;
 320
 321     die "can't find bridge $bridge" if !-d "/sys/class/net/$bridge";
 322 }
 323
 324 sub is_vlanaware {
 325     my ($bridge) = @_;
 326
 327     return PVE::Tools::file_read_firstline("/sys/class/net/$bridge/bridge/vlan_filtering");
 328 }
 329
 330 sub is_ovs {
 331     my ($bridge) = @_;
 332
 333     my $is_ovs = !-d "/sys/class/net/$bridge/brif";
 334     return $is_ovs;
 335 }
 336
 337 sub get_bridge_ifaces {
 338     my ($bridge) = @_;
 339
 340     my @bridge_ifaces = ();
 341     my $dir = "/sys/class/net/$bridge/brif";
 342     PVE::Tools::dir_glob_foreach($dir, '(((eth|bond)\d+|en[^.]+)(\.\d+)?)', sub {
 343         push @bridge_ifaces, $_[0];
 344     });
 345
 346     return @bridge_ifaces;
 347 }
 348 1;