path: root/lib/Vyatta/Interface.pm

# Author: Stephen Hemminger <shemminger@vyatta.com>
# Date: 2009
# Description: vyatta interface management

# **** License ****
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 as
# published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# This code was originally developed by Vyatta, Inc.
# Portions created by Vyatta are Copyright (C) 2008 Vyatta, Inc.
# All Rights Reserved.
# **** End License ****

package Vyatta::Interface;

use strict;
use warnings;
use Vyatta::Config;
use Vyatta::Misc;
use base 'Exporter';
our @EXPORT = qw(IFF_UP IFF_BROADCAST IFF_DEBUG IFF_LOOPBACK
	          IFF_POINTOPOINT IFF_RUNNING IFF_NOARP
		  IFF_PROMISC IFF_MULTICAST);


use constant {
    IFF_UP		=> 0x1,		# interface is up
    IFF_BROADCAST	=> 0x2,		# broadcast address valid
    IFF_DEBUG		=> 0x4,		# turn on debugging
    IFF_LOOPBACK	=> 0x8,		# is a loopback net
    IFF_POINTOPOINT	=> 0x10,	# interface is has p-p link
    IFF_NOTRAILERS	=> 0x20,	# avoid use of trailers
    IFF_RUNNING		=> 0x40,	# interface RFC2863 OPER_UP
    IFF_NOARP		=> 0x80,	# no ARP protocol
    IFF_PROMISC		=> 0x100,	# receive all packets
    IFF_ALLMULTI	=> 0x200,	# receive all multicast packets
    IFF_MASTER		=> 0x400,	# master of a load balancer
    IFF_SLAVE		=> 0x800,	# slave of a load balancer
    IFF_MULTICAST	=> 0x1000,	# Supports multicast
    IFF_PORTSEL		=> 0x2000,      # can set media type
    IFF_AUTOMEDIA	=> 0x4000,	# auto media select active
    IFF_DYNAMIC		=> 0x8000,	# dialup device with changing addresses
    IFF_LOWER_UP	=> 0x10000,	# driver signals L1 up
    IFF_DORMANT		=> 0x20000,	# driver signals dormant
    IFF_ECHO		=> 0x40000,	# echo sent packets
};

#
# Mapping from name to attributes
#   path: configuration level below interfaces
#   vif:  places to look for vif (if any)
my %net_prefix = (
    '^adsl[\d]+$'  => { path => 'adsl',
		      vif => 'vif',    },
    '^bond[\d]+$'  => { path => 'bonding',
		      vif => 'vif', },
    '^bond[\d]+v[\d]+$' => { path => 'vrrp' },
    '^br[\d]+$'    => { path => 'bridge',
		      vif => 'vif' },
    '^eth[\d]+$'   => { path => 'ethernet',
		      vif => 'vif', },
    '^eth[\d]+v[\d]+$' => { path => 'vrrp' },
    '^eth[\d]+.[\d]+v[\d]+$' => { path => 'vrrp' },
    '^lo$'         => { path => 'loopback' },
    '^ml[\d]+$'    => { path => 'multilink',
		      vif => 'vif', },
    '^vtun[\d]+$'  => { path => 'openvpn' },
    '^wan[\d]+$'   => { path => 'serial',
		      vif  => ( 'cisco-hdlc vif', 'ppp vif',
				'frame-relay vif' ), },
    '^tun[\d]+$'   => { path => 'tunnel' },
    '^wlm[\d]+$'   => { path => 'wireless-modem' },
    '^peth[\d]+$'  => { path => 'pseudo-ethernet',
		      vif => 'vif', },
    '^wlan[\d]+$'  => { path => 'wireless', vif => 'vif' },
    '^ifb[\d]+$'   => { path => 'input' },
);

sub get_net_prefix {
  return %net_prefix;
}

# get list of interface types (only used in usage function)
sub interface_types {
    my @types = map { $net_prefix{$_}{path} } keys %net_prefix;
    return @types;
}

# check to see if an address is unique in the working configuration
sub is_uniq_address {
  my $ip = pop(@_);
  my @cfgifs = get_all_cfg_interfaces();
  my $config = new Vyatta::Config;
  my %addr_hash = (); 
  foreach my $intf ( @cfgifs ) { 
    my $addrs = [ ];
    my $path = "$intf->{'path'}";
    if ($path =~ /openvpn/) {
      $addrs = [$config->listNodes("$path local-address")]; 
    } else {
      $addrs = [$config->returnValues("$path address")];
    }
    foreach my $addr ( @{$addrs} ){
      if (not exists $addr_hash{$addr}){
        $addr_hash{$addr} = { _intf => [ $intf->{name} ] };
      } else { 
        $addr_hash{$addr}->{_intf} = 
           [ @{$addr_hash{$addr}->{_intf}}, $intf->{name} ];
      }   
    }
  }
  return ((scalar @{$addr_hash{$ip}->{_intf}}) <= 1);
}

# get all configured interfaces (in active or working configuration)
sub get_all_cfg_interfaces {
  my ($in_active) = @_;
  my $vfunc = ($in_active ? 'listOrigNodes' : 'listNodes');

  my $cfg = new Vyatta::Config;
  my @ret_ifs = ();
  for my $pfx (keys %net_prefix) {
    my ($type, $vif) = ($net_prefix{$pfx}->{path}, $net_prefix{$pfx}->{vif});
    my @vifs = (defined($vif)
                ? ((ref($vif) eq 'ARRAY') ? @{$vif}
                                            : ($vif))
                  : ());
    for my $tif ($cfg->$vfunc("interfaces $type")) {
      push @ret_ifs, { 'name' => $tif, 'path' => "interfaces $type $tif" };
      for my $vpath (@vifs) {
        for my $vnum ($cfg->$vfunc("interfaces $type $tif $vpath")) {
          push @ret_ifs, { 'name' => "$tif.$vnum",
                           'path' => "interfaces $type $tif $vpath $vnum" };
        }
      }
    }
  }
  # special case for vrrp
  for my $eth ($cfg->$vfunc('interfaces ethernet')) {
    for my $vrid ($cfg->$vfunc("interfaces ethernet $eth vrrp vrrp-group")) {
      push @ret_ifs, { 'name' => $eth."v".$vrid,
                       'path' => "interfaces ethernet $eth vrrp vrrp-group $vrid interface" };
    }
    for my $vif ($cfg->$vfunc("interfaces ethernet $eth vif")) {
      for my $vrid ($cfg->$vfunc("interfaces ethernet $eth vif $vif vrrp vrrp-group")) {
        push @ret_ifs, { 'name' => $eth.".".$vif."v".$vrid,
                         'path' => "interfaces ethernet $eth vif $vif vrrp vrrp-group $vrid interface" };
      }
    }
  }
  for my $bond ($cfg->$vfunc('interfaces bonding')) {
    for my $vrid ($cfg->$vfunc("interfaces bonding $bond vrrp vrrp-group")) {
      push @ret_ifs, { 'name' => $bond."v".$vrid,
                       'path' => "interfaces bonding $bond vrrp vrrp-group $vrid interface" };
    }
    for my $vif ($cfg->$vfunc("interfaces bonding $bond vif")) {
      for my $vrid ($cfg->$vfunc("interfaces bonding $bond vif $vif vrrp vrrp-group")) {
        push @ret_ifs, { 'name' => $bond.".".$vif."v".$vrid,
                         'path' => "interfaces bonding $bond vif $vif vrrp vrrp-group $vrid interface" };
      }
    }
  }
  
  # now special cases for pppo*/adsl
  for my $eth ($cfg->$vfunc('interfaces ethernet')) {
    for my $ep ($cfg->$vfunc("interfaces ethernet $eth pppoe")) {
      push @ret_ifs, { 'name' => "pppoe$ep",
                       'path' => "interfaces ethernet $eth pppoe $ep" };
    }
  }
  for my $a ($cfg->$vfunc('interfaces adsl')) {
    for my $p ($cfg->$vfunc("interfaces adsl $a pvc")) {
      for my $t ($cfg->$vfunc("interfaces adsl $a pvc $p")) {
        if ($t eq 'classical-ipoa' or $t eq 'bridged-ethernet') {
          # classical-ipoa or bridged-ethernet
          push @ret_ifs,
            { 'name' => $a,
              'path' => "interfaces adsl $a pvc $p $t" };
          next;
        }
        # pppo[ea]
        for my $i ($cfg->$vfunc("interfaces adsl $a pvc $p $t")) {
          push @ret_ifs,
            { 'name' => "$t$i",
              'path' => "interfaces adsl $a pvc $p $t $i" };
        }
      }
    }
  }

  return @ret_ifs;
}

# Read ppp config to fine associated interface for ppp device
sub _ppp_intf {
    my $dev = shift;
    my $intf;

    open (my $ppp, '<', "/etc/ppp/peers/$dev")
	or return;	# no such device

    while (<$ppp>) {
	chomp;
	# looking for line like:
	# pty "/usr/sbin/pppoe -m 1412 -I eth1"
	next unless /^pty\s.*-I\s*(\w+)"/;
	$intf = $1;
	last;
    }
    close $ppp;

    return $intf;
}

# Go path hunting to find ppp device
sub ppp_path {
    my $self = shift;

    return unless ($self->{name} =~ /^(pppo[ae])(\d+)/);
    my $type = $1;
    my $id = $2;

    my $intf = _ppp_intf($self->{name});
    return unless $intf;

    my $config = new Vyatta::Config;
    if ($type eq 'pppoe') {
       my $path = "interfaces ethernet $intf pppoe $id";
       return $path if $config->exists($path);
    }

    my $adsl = "interfaces adsl $intf pvc";
    foreach my $pvc ($config->listNodes($adsl)) {
       my $path = "$adsl $pvc $type $id";
       return $path if $config->exists($path);
    }

    return;
}

# new interface description object
sub new {
    my $that  = shift;
    my $name  = pop;
    my $class = ref($that) || $that;
    my ($dev, $vif, $vrid);

    # need argument to constructor
    return unless $name;

    # Special case for ppp devices
    if ($name =~ /^(pppo[ae])(\d+)/) {
	my $type = $1;

	my $self = {
	    name   => $name,
	    type   => $type,
	    dev    => $name,
	};
	bless $self, $class;
	return $self;
    }

    if ( $name =~ m/(\w+)\.(\d+)v(\d+)/ ){
        $dev = $1;
        $vif = $2; 
        $vrid = $3;
    } elsif ( $name =~ m/(\w+)v(\d+)/ ) {
        $dev = $1;
        $vrid = $2;
    # Strip off vif from name
    } elsif ( $name =~ m/(\w+)\.(\d+)/ ) {
        $dev = $1;
        $vif = $2;
    } else {
        $dev = $name;
    }

    foreach my $prefix (keys %net_prefix) {
        next unless $dev =~ /$prefix/;
        my $type    = $net_prefix{$prefix}{path};
        my $vifpath = $net_prefix{$prefix}{vif};

        # Interface name has vif, but this type doesn't support vif!
        return if ( $vif && !$vifpath && !$vrid);

        # Check path if given
        return if ( $#_ >= 0 && join( ' ', @_ ) ne $type );

        my $path = "interfaces $type $dev";
        $path .= " $vifpath $vif" if $vif;
        $path .= " vrrp vrrp-group $vrid interface" if $vrid;
        $type = 'vrrp' if $vrid;

	my $self = {
	    name => $name,
	    type => $type,
	    path => $path,
	    dev  => $dev,
	    vif  => $vif,
            vrid => $vrid
	};

        bless $self, $class;
        return $self;
    }

    return; # nothing
}

## Field accessors
sub name {
    my $self = shift;
    return $self->{name};
}

sub path {
    my $self = shift;
    my $path = $self->{path};

    return $path if defined($path);

    # Go path hunting to find ppp device
    return ppp_path($self);
}

sub vif {
    my $self = shift;
    return $self->{vif};
}

sub vrid {
    my $self = shift;
    return $self->{vrid};
}

sub physicalDevice {
    my $self = shift;
    return $self->{dev};
}

sub type {
    my $self = shift;
    return $self->{type};
}

## Configuration checks

sub configured {
    my $self   = shift;
    my $config = new Vyatta::Config;

    return $config->exists( $self->{path} );
}

sub disabled {
    my $self   = shift;
    my $config = new Vyatta::Config;

    $config->setLevel( $self->{path} );
    return $config->exists("disable");
}

sub mtu {
    my $self  = shift;
    my $config = new Vyatta::Config;

    $config->setLevel( $self->{path} );
    return $config->returnValue("mtu");
}

sub using_dhcp {
    my $self   = shift;
    my $config = new Vyatta::Config;
    $config->setLevel( $self->{path} );

    my @addr = grep { $_ eq 'dhcp' } $config->returnOrigValues('address');

    return if ($#addr < 0);
    return $addr[0];
}

sub bridge_grp {
    my $self  = shift;
    my $config = new Vyatta::Config;

    $config->setLevel( $self->{path} );
    return $config->returnValue("bridge-group bridge");
}

## System checks

# return array of current addresses (on system)
sub address {
    my ($self, $type) = @_;

    return Vyatta::Misc::getIP($self->{name}, $type);
}

sub exists {
    my $self = shift;

    return ( -d "/sys/class/net/$self->{name}" );
}

sub flags {
    my $self = shift;

    open my $flags, '<', "/sys/class/net/$self->{name}/flags"
	or return;

    my $val = <$flags>;
    chomp $val;
    close $flags;
    return hex($val);
}

sub carrier {
    my $self = shift;
    open my $carrier, '<', "/sys/class/net/$self->{name}/carrier"
	or return;

    my $val = <$carrier>;
    $val = 0 if ! defined $val;  # proc entry not readable on down interface
    chomp $val;
    close $carrier;
    return $val;
}

sub hw_address {
    my $self = shift;

    open my $addrf, '<', "/sys/class/net/$self->{name}/address"
	or return;
    my $address = <$addrf>;
    close $addrf;

    chomp $address if $address;
    return $address;
}

sub is_broadcast {
    my $self = shift;
    return $self->flags() & IFF_BROADCAST;
}

sub is_multicast {
    my $self = shift;
    return $self->flags() & IFF_MULTICAST;
}

sub is_pointtopoint {
    my $self = shift;
    return $self->flags() & IFF_POINTOPOINT;
}

sub is_loopback {
    my $self = shift;
    return $self->flags() & IFF_LOOPBACK;
}

# device exists and is online
sub up {
    my $self  = shift;
    my $flags = $self->flags();

    return $flags && ( $flags & IFF_UP );
}

# device exists and is running (ie carrier present)
sub running {
    my $self  = shift;
    my $flags = $self->flags();

    return $flags && ( $flags & IFF_RUNNING );
}

# device description information in kernel (future use)
sub description {
    my $self = shift;

    return interface_description($self->{name});
}

1;