mirror of
https://github.com/CumulusNetworks/ifupdown2.git
synced 2024-05-06 15:54:50 +00:00
a4cf844858
Ticket: CM-14122 Reviewed By: Roopa, Daniel W, Nikhil G Signed-off-by: Julien Fortin <julien@cumulusnetworks.com>
374 lines
17 KiB
Python
374 lines
17 KiB
Python
#!/usr/bin/python
|
|
#
|
|
# Copyright 2014 Cumulus Networks, Inc. All rights reserved.
|
|
# Author: Roopa Prabhu, roopa@cumulusnetworks.com
|
|
#
|
|
import json
|
|
import ifupdown.policymanager as policymanager
|
|
|
|
try:
|
|
import os
|
|
from ipaddr import IPNetwork
|
|
from sets import Set
|
|
from ifupdown.iface import *
|
|
from ifupdown.exceptions import moduleNotSupported
|
|
from ifupdown.utils import utils
|
|
from ifupdownaddons.utilsbase import *
|
|
from ifupdownaddons.modulebase import moduleBase, NotSupported
|
|
from ifupdownaddons.iproute2 import iproute2
|
|
import ifupdown.ifupdownflags as ifupdownflags
|
|
except ImportError, e:
|
|
raise ImportError (str(e) + "- required module not found")
|
|
|
|
class ethtool(moduleBase,utilsBase):
|
|
""" ifupdown2 addon module to configure ethtool attributes """
|
|
|
|
_modinfo = {'mhelp' : 'ethtool configuration module for interfaces',
|
|
'attrs': {
|
|
'link-speed' :
|
|
{'help' : 'set link speed',
|
|
'validvals' : ['100',
|
|
'1000',
|
|
'10000',
|
|
'25000',
|
|
'40000',
|
|
'50000',
|
|
'100000'],
|
|
'example' : ['link-speed 1000'],
|
|
'default' : 'varies by platform and port'},
|
|
'link-duplex' :
|
|
{'help': 'set link duplex',
|
|
'example' : ['link-duplex full'],
|
|
'validvals' : ['half', 'full'],
|
|
'default' : 'full'},
|
|
'link-autoneg' :
|
|
{'help': 'set autonegotiation',
|
|
'example' : ['link-autoneg on'],
|
|
'validvals' : ['yes', 'no', 'on', 'off'],
|
|
'default' : 'varies by platform and port'},
|
|
'link-fec' :
|
|
{'help': 'set forward error correction mode',
|
|
'example' : ['link-fec rs'],
|
|
'validvals' : ['rs', 'baser', 'on', 'off'],
|
|
'default' : 'varies by platform and port'}}}
|
|
|
|
def __init__(self, *args, **kargs):
|
|
moduleBase.__init__(self, *args, **kargs)
|
|
if not os.path.exists('/sbin/ethtool'):
|
|
raise moduleNotSupported('module init failed: no /sbin/ethtool found')
|
|
self.ipcmd = None
|
|
# keep a list of iface objects who have modified link attributes
|
|
self.ifaceobjs_modified_configs = []
|
|
|
|
def _post_up(self, ifaceobj, operation='post_up'):
|
|
"""
|
|
_post_up and _pre_down will reset the layer 2 attributes to default policy
|
|
settings.
|
|
"""
|
|
if not self.ipcmd.link_exists(ifaceobj.name):
|
|
return
|
|
cmd = ''
|
|
feccmd = ''
|
|
for attr in ['speed', 'duplex', 'autoneg', 'fec']:
|
|
# attribute existed before but we must reset to default
|
|
config_val = ifaceobj.get_attr_value_first('link-%s'%attr)
|
|
default_val = policymanager.policymanager_api.get_iface_default(
|
|
module_name='ethtool',
|
|
ifname=ifaceobj.name,
|
|
attr='link-%s'%attr)
|
|
|
|
if not default_val and not config_val:
|
|
# there is no point in checking the running config
|
|
# if we have no default and the user did not have settings
|
|
continue
|
|
# check running values
|
|
running_val = self.get_running_attr(attr, ifaceobj)
|
|
|
|
if attr == 'autoneg':
|
|
config_val = utils.get_onoff_bool(config_val)
|
|
|
|
# we need to track if an interface has a configured value
|
|
# this will be used if there are duplicate iface stanza and
|
|
# the configured interface will always take precedence.
|
|
# so even if we do not change the settings because they match
|
|
# what is configured, we need to append it here so that later duplicate
|
|
# ifaces will see that we had a configured iface and not change things.
|
|
if config_val and config_val == running_val:
|
|
# running value is what is configured, do nothing
|
|
# this prevents unconfigured ifaces from resetting to default
|
|
self.ifaceobjs_modified_configs.append(ifaceobj.name)
|
|
continue
|
|
|
|
if not config_val and default_val and default_val == running_val:
|
|
# nothing configured but the default is running
|
|
continue
|
|
# if we are the oldest sibling, we have to reset to defaults
|
|
# unless a previous sibling had link attr configured and made changes
|
|
if ((ifaceobj.flags & iface.HAS_SIBLINGS) and
|
|
(ifaceobj.flags & iface.OLDEST_SIBLING) and
|
|
(ifaceobj.name in self.ifaceobjs_modified_configs)):
|
|
continue
|
|
|
|
# If we have siblings AND are not the oldest AND we have no configs,
|
|
# do not change anything. The only way a non-oldest sibling would
|
|
# change values is if it had configured settings. iface stanzas may
|
|
# not be squashed if addr_config_squash is not set so we still need this.
|
|
if ((ifaceobj.flags & iface.HAS_SIBLINGS) and
|
|
not (ifaceobj.flags & iface.OLDEST_SIBLING) and
|
|
not config_val):
|
|
continue
|
|
|
|
if attr == 'fec':
|
|
# if we got this far, we need to change it
|
|
if config_val and (config_val != running_val):
|
|
# if the configured value is not set, set it
|
|
feccmd = ' %s %s' % ("encoding", config_val)
|
|
elif default_val and (default_val != running_val):
|
|
# or if it has a default not equal to running value, set it
|
|
feccmd = ' %s %s' % ("encoding", default_val)
|
|
else:
|
|
# no value set nor default, leave it alone
|
|
pass
|
|
else:
|
|
# if we got this far, we need to change it
|
|
if config_val and (config_val != running_val):
|
|
# if the configured value is not set, set it
|
|
cmd += ' %s %s' % (attr, config_val)
|
|
elif default_val and (default_val != running_val):
|
|
# or if it has a default not equal to running value, set it
|
|
cmd += ' %s %s' % (attr, default_val)
|
|
else:
|
|
# no value set nor default, leave it alone
|
|
pass
|
|
|
|
if cmd:
|
|
try:
|
|
# we should only be calling ethtool if there
|
|
# is a speed set or we can find a default speed
|
|
# because we should only be calling ethtool on swp ports
|
|
# we also need to set this here in case we changed
|
|
# something. this prevents unconfigured ifaces from resetting to default
|
|
self.ifaceobjs_modified_configs.append(ifaceobj.name)
|
|
cmd = 'ethtool -s %s %s' %(ifaceobj.name, cmd)
|
|
utils.exec_command(cmd)
|
|
except Exception, e:
|
|
self.log_error('%s: %s' %(ifaceobj.name, str(e)), ifaceobj)
|
|
else:
|
|
pass
|
|
|
|
if feccmd:
|
|
try:
|
|
# we should only be calling ethtool if there
|
|
# is a speed set or we can find a default speed
|
|
# because we should only be calling ethtool on swp ports
|
|
# we also need to set this here in case we changed
|
|
# something. this prevents unconfigured ifaces from resetting to default
|
|
self.ifaceobjs_modified_configs.append(ifaceobj.name)
|
|
feccmd = 'ethtool --set-fec %s %s' %(ifaceobj.name, feccmd)
|
|
utils.exec_command(feccmd)
|
|
except Exception, e:
|
|
self.log_error('%s: %s' %(ifaceobj.name, str(e)), ifaceobj)
|
|
else:
|
|
pass
|
|
|
|
def _pre_down(self, ifaceobj):
|
|
pass #self._post_up(ifaceobj,operation="_pre_down")
|
|
|
|
def _query_check(self, ifaceobj, ifaceobjcurr):
|
|
"""
|
|
_query_check() needs to compare the configured (or running)
|
|
attribute with the running attribute.
|
|
|
|
If there is nothing configured, we compare the default attribute with
|
|
the running attribute and FAIL if they are different.
|
|
This is because a reboot will lose their running attribute
|
|
(the default will get set).
|
|
"""
|
|
for attr in ['speed', 'duplex', 'autoneg', 'fec']:
|
|
configured = ifaceobj.get_attr_value_first('link-%s'%attr)
|
|
# if there is nothing configured, do not check
|
|
if not configured:
|
|
if not ifupdownflags.flags.WITHDEFAULTS:
|
|
continue
|
|
default = policymanager.policymanager_api.get_iface_default(
|
|
module_name='ethtool',
|
|
ifname=ifaceobj.name,
|
|
attr='link-%s'%attr)
|
|
# if we have no default, do not bother checking
|
|
# this avoids ethtool calls on virtual interfaces
|
|
if not default:
|
|
continue
|
|
# autoneg comes from ethtool whereas speed and duplex from /sys/class
|
|
running_attr = self.get_running_attr(attr, ifaceobj)
|
|
if not running_attr:
|
|
if not configured:
|
|
continue
|
|
ifaceobjcurr.update_config_with_status('link-%s' % attr,
|
|
'unknown', 1)
|
|
continue
|
|
|
|
if attr == 'autoneg':
|
|
if configured == 'yes' and running_attr == 'on':
|
|
running_attr = 'yes'
|
|
elif configured == 'no' and running_attr == 'off':
|
|
running_attr = 'no'
|
|
|
|
# we make sure we can get a running value first
|
|
if (running_attr and configured and running_attr == configured):
|
|
# PASS since running is what is configured
|
|
ifaceobjcurr.update_config_with_status('link-%s'%attr,
|
|
running_attr, 0)
|
|
elif (running_attr and configured and running_attr != configured):
|
|
# We show a FAIL since it is not the configured or default
|
|
ifaceobjcurr.update_config_with_status('link-%s'%attr,
|
|
running_attr, 1)
|
|
elif (running_attr and default and running_attr == default):
|
|
# PASS since running is default
|
|
ifaceobjcurr.update_config_with_status('link-%s'%attr,
|
|
running_attr, 0)
|
|
elif (default or configured):
|
|
# We show a FAIL since it is not the configured or default
|
|
ifaceobjcurr.update_config_with_status('link-%s'%attr,
|
|
running_attr, 1)
|
|
return
|
|
|
|
def get_autoneg(self,ethtool_output=None):
|
|
"""
|
|
get_autoneg simply calls the ethtool command and parses out
|
|
the autoneg value.
|
|
"""
|
|
ethtool_attrs = ethtool_output.split()
|
|
if ('Auto-negotiation:' in ethtool_attrs):
|
|
return(ethtool_attrs[ethtool_attrs.index('Auto-negotiation:')+1])
|
|
else:
|
|
return(None)
|
|
|
|
def get_fec_encoding(self,ethtool_output=None):
|
|
"""
|
|
get_fec_encoding simply calls the ethtool show-fec command and parses out
|
|
the fec encoding value.
|
|
"""
|
|
try:
|
|
for attr in ethtool_output.splitlines():
|
|
if attr.startswith('FEC encodings'):
|
|
fec_attrs = attr.split()
|
|
return(fec_attrs[fec_attrs.index(':')+1])
|
|
except Exception as e:
|
|
self.logger.debug('ethtool: problems in ethtool set-fec output'
|
|
' %s: %s' %(ethtool_output.splitlines(), str(e)))
|
|
|
|
return(None)
|
|
|
|
def get_running_attr(self,attr='',ifaceobj=None):
|
|
if not ifaceobj or not attr:
|
|
return
|
|
running_attr = None
|
|
try:
|
|
if attr == 'autoneg':
|
|
output = utils.exec_commandl(['ethtool', ifaceobj.name])
|
|
running_attr = self.get_autoneg(ethtool_output=output)
|
|
elif attr == 'fec':
|
|
output = utils.exec_command('ethtool --show-fec %s'%(ifaceobj.name))
|
|
running_attr = self.get_fec_encoding(ethtool_output=output)
|
|
else:
|
|
running_attr = self.read_file_oneline('/sys/class/net/%s/%s' % \
|
|
(ifaceobj.name, attr))
|
|
except Exception as e:
|
|
# for nonexistent interfaces, we get an error (rc = 256 or 19200)
|
|
self.logger.debug('ethtool: problems calling ethtool or reading'
|
|
' /sys/class on iface %s for attr %s: %s' %
|
|
(ifaceobj.name, attr, str(e)))
|
|
return running_attr
|
|
|
|
|
|
def _query_running(self, ifaceobj, ifaceobj_getfunc=None):
|
|
"""
|
|
_query_running looks at the speed and duplex from /sys/class
|
|
and retreives autoneg from ethtool. We do not report autoneg
|
|
if speed is not available because this usually means the link is
|
|
down and the autoneg value is not reliable when the link is down.
|
|
"""
|
|
# do not bother showing swp ifaces that are not up for the speed
|
|
# duplex and autoneg are not reliable.
|
|
if not self.ipcmd.is_link_up(ifaceobj.name):
|
|
return
|
|
for attr in ['speed', 'duplex', 'autoneg']:
|
|
default_val = policymanager.policymanager_api.get_iface_default(
|
|
module_name='ethtool',
|
|
ifname=ifaceobj.name,
|
|
attr='link-%s'%attr)
|
|
# do not continue if we have no defaults
|
|
# this avoids ethtool calls on virtual interfaces
|
|
if not default_val:
|
|
continue
|
|
running_attr = self.get_running_attr(attr, ifaceobj)
|
|
|
|
# Only show the link attributes if they differ from defaults
|
|
# to see the defaults, we should implement another flag (--with-defaults)
|
|
if default_val == running_attr:
|
|
continue
|
|
|
|
# do not proceed if speed = 0
|
|
if attr == 'speed' and running_attr and running_attr == '0':
|
|
return
|
|
if running_attr:
|
|
ifaceobj.update_config('link-%s'%attr, running_attr)
|
|
|
|
return
|
|
|
|
def _query(self, ifaceobj, **kwargs):
|
|
""" add default policy attributes supported by the module """
|
|
for attr in ['speed', 'duplex', 'autoneg', 'fec']:
|
|
if ifaceobj.get_attr_value_first('link-%s'%attr):
|
|
continue
|
|
default = policymanager.policymanager_api.get_iface_default(
|
|
module_name='ethtool',
|
|
ifname=ifaceobj.name,
|
|
attr='link-%s' %attr)
|
|
if not default:
|
|
continue
|
|
ifaceobj.update_config('link-%s' %attr, default)
|
|
|
|
_run_ops = {'pre-down' : _pre_down,
|
|
'post-up' : _post_up,
|
|
'query-checkcurr' : _query_check,
|
|
'query-running' : _query_running,
|
|
'query' : _query}
|
|
|
|
def get_ops(self):
|
|
""" returns list of ops supported by this module """
|
|
return self._run_ops.keys()
|
|
|
|
def _init_command_handlers(self):
|
|
if not self.ipcmd:
|
|
self.ipcmd = iproute2()
|
|
|
|
def run(self, ifaceobj, operation, query_ifaceobj=None, **extra_args):
|
|
""" run ethtool configuration on the interface object passed as
|
|
argument
|
|
|
|
Args:
|
|
**ifaceobj** (object): iface object
|
|
|
|
**operation** (str): any of 'post-up', 'query-checkcurr',
|
|
'query-running'
|
|
Kwargs:
|
|
**query_ifaceobj** (object): query check ifaceobject. This is only
|
|
valid when op is 'query-checkcurr'. It is an object same as
|
|
ifaceobj, but contains running attribute values and its config
|
|
status. The modules can use it to return queried running state
|
|
of interfaces. status is success if the running state is same
|
|
as user required state in ifaceobj. error otherwise.
|
|
"""
|
|
if (ifaceobj.link_kind or
|
|
ifaceobj.link_privflags & ifaceLinkPrivFlags.LOOPBACK):
|
|
return
|
|
op_handler = self._run_ops.get(operation)
|
|
if not op_handler:
|
|
return
|
|
self._init_command_handlers()
|
|
if operation == 'query-checkcurr':
|
|
op_handler(self, ifaceobj, query_ifaceobj)
|
|
else:
|
|
op_handler(self, ifaceobj)
|