mirror/CumulusNetworks-ifupdown2
1
0
Fork 0
mirror of https://github.com/CumulusNetworks/ifupdown2.git synced 2024-05-06 15:54:50 +00:00
Code
CumulusNetworks-ifupdown2/ifupdownaddons/dhclient.py

104 lines
3.8 KiB
Python
Raw Normal View History

Move ifupdown2addons into ifupdown2 pacakge Ticket: CM-3864 Reviewed By: Testing Done: Tested build and install open item: - cleanup stale ifupdown2-addons package files
2014-10-09 16:02:46 -07:00
#!/usr/bin/python
#
# Copyright 2014 Cumulus Networks, Inc. All rights reserved.
# Author: Roopa Prabhu, roopa@cumulusnetworks.com
#
performance fix: better handling fd to allow subprocess.close_fds=False and code re-organisation Ticket: None Reviewed By: CCR-4692 Testing Done: smoke + scale tests If called with close_fds=True the subprocess module will try to close every fd from 3 to MAXFD before executing the specified command. This is done in Python not even with a C-implementation which truly affecting performances. This patch aims to better handle the file descriptor used by ifupdown2. Either by closing them after use or by setting the close-on-exec flag for the file descriptor, which causes the file descriptor to be automatically (and atomically) closed when any of the exec-family functions succeed. With the actual patch all tests are passing, I can't think of any future issue but if any a possible future modification might be to use the parameter 'preexec_fn', which allows us to set function which will be executed in the child process before executing the command line. We can always manually close any remaining open file descriptors with something like: >>> os.listdir('/proc/self/fd/') ['0', '1', '2', ‘3’, etc..] >>> for fd in os.listdir('/proc/self/fd/') >>> if int(fd) > 2: >>> os.close(fd) This patch is also totally re-organising the use of subprocesses. By removing all subprocess code redundancy.
2016-05-13 19:52:57 +02:00
from ifupdown.utils import utils
Move ifupdown2addons into ifupdown2 pacakge Ticket: CM-3864 Reviewed By: Testing Done: Tested build and install open item: - cleanup stale ifupdown2-addons package files
2014-10-09 16:02:46 -07:00
from utilsbase import *
import os
class dhclient(utilsBase):
""" This class contains helper methods to interact with the dhclient
utility """
def _pid_exists(self, pidfilename):
if os.path.exists(pidfilename):
pid = self.read_file_oneline(pidfilename)
if not os.path.exists('/proc/%s' %pid):
return False
else:
return False
return True
def is_running(self, ifacename):
return self._pid_exists('/run/dhclient.%s.pid' %ifacename)
def is_running6(self, ifacename):
return self._pid_exists('/run/dhclient6.%s.pid' %ifacename)
addons: dhcp: add vrf awareness Ticket: CM-10292, CM-10282 Reviewed By: dsa, nikhil, julien Testing Done: Tested dhcp config on an vrf slave - Add support for policy module_globals variable "vrf-exec-cmd-prefix". It is read into per module self.vrf_exec_cmd_prefix variable - If self.vrf_exec_cmd_prefix is present and interface is a vrf slave, use ifupdown2 will call such command in vrf context using: "%s %s %s" %(<vrf-exec-cmd-prefix>, <vrfname>, <cmd>) - This also fixes calling of dhcp refresh when a dhcp slave is removed from a vrf Signed-off-by: Roopa Prabhu <roopa@cumulusnetworks.com>
2016-04-05 16:11:41 -07:00
def _run_dhclient_cmd(self, cmd, cmd_prefix=None):
if not cmd_prefix:
cmd_aslist = []
else:
cmd_aslist = cmd_prefix.split()
if cmd_aslist:
cmd_aslist.extend(cmd)
else:
cmd_aslist = cmd
performance fix: better handling fd to allow subprocess.close_fds=False and code re-organisation Ticket: None Reviewed By: CCR-4692 Testing Done: smoke + scale tests If called with close_fds=True the subprocess module will try to close every fd from 3 to MAXFD before executing the specified command. This is done in Python not even with a C-implementation which truly affecting performances. This patch aims to better handle the file descriptor used by ifupdown2. Either by closing them after use or by setting the close-on-exec flag for the file descriptor, which causes the file descriptor to be automatically (and atomically) closed when any of the exec-family functions succeed. With the actual patch all tests are passing, I can't think of any future issue but if any a possible future modification might be to use the parameter 'preexec_fn', which allows us to set function which will be executed in the child process before executing the command line. We can always manually close any remaining open file descriptors with something like: >>> os.listdir('/proc/self/fd/') ['0', '1', '2', ‘3’, etc..] >>> for fd in os.listdir('/proc/self/fd/') >>> if int(fd) > 2: >>> os.close(fd) This patch is also totally re-organising the use of subprocesses. By removing all subprocess code redundancy.
2016-05-13 19:52:57 +02:00
utils.exec_commandl(cmd_aslist, stdout=None, stderr=None)
addons: dhcp: add vrf awareness Ticket: CM-10292, CM-10282 Reviewed By: dsa, nikhil, julien Testing Done: Tested dhcp config on an vrf slave - Add support for policy module_globals variable "vrf-exec-cmd-prefix". It is read into per module self.vrf_exec_cmd_prefix variable - If self.vrf_exec_cmd_prefix is present and interface is a vrf slave, use ifupdown2 will call such command in vrf context using: "%s %s %s" %(<vrf-exec-cmd-prefix>, <vrfname>, <cmd>) - This also fixes calling of dhcp refresh when a dhcp slave is removed from a vrf Signed-off-by: Roopa Prabhu <roopa@cumulusnetworks.com>
2016-04-05 16:11:41 -07:00
def stop(self, ifacename, cmd_prefix=None):
Move ifupdown2addons into ifupdown2 pacakge Ticket: CM-3864 Reviewed By: Testing Done: Tested build and install open item: - cleanup stale ifupdown2-addons package files
2014-10-09 16:02:46 -07:00
if os.path.exists('/sbin/dhclient3'):
cmd = ['/sbin/dhclient3', '-x', '-pf',
'/run/dhclient.%s.pid' %ifacename, '-lf',
'/var/lib/dhcp3/dhclient.%s.leases' %ifacename,
'%s' %ifacename]
else:
cmd = ['/sbin/dhclient', '-x', '-pf',
'/run/dhclient.%s.pid' %ifacename,
'-lf', '/var/lib/dhcp/dhclient.%s.leases' %ifacename,
'%s' %ifacename]
addons: dhcp: add vrf awareness Ticket: CM-10292, CM-10282 Reviewed By: dsa, nikhil, julien Testing Done: Tested dhcp config on an vrf slave - Add support for policy module_globals variable "vrf-exec-cmd-prefix". It is read into per module self.vrf_exec_cmd_prefix variable - If self.vrf_exec_cmd_prefix is present and interface is a vrf slave, use ifupdown2 will call such command in vrf context using: "%s %s %s" %(<vrf-exec-cmd-prefix>, <vrfname>, <cmd>) - This also fixes calling of dhcp refresh when a dhcp slave is removed from a vrf Signed-off-by: Roopa Prabhu <roopa@cumulusnetworks.com>
2016-04-05 16:11:41 -07:00
self._run_dhclient_cmd(cmd, cmd_prefix)
Move ifupdown2addons into ifupdown2 pacakge Ticket: CM-3864 Reviewed By: Testing Done: Tested build and install open item: - cleanup stale ifupdown2-addons package files
2014-10-09 16:02:46 -07:00
addons: dhcp: add vrf awareness Ticket: CM-10292, CM-10282 Reviewed By: dsa, nikhil, julien Testing Done: Tested dhcp config on an vrf slave - Add support for policy module_globals variable "vrf-exec-cmd-prefix". It is read into per module self.vrf_exec_cmd_prefix variable - If self.vrf_exec_cmd_prefix is present and interface is a vrf slave, use ifupdown2 will call such command in vrf context using: "%s %s %s" %(<vrf-exec-cmd-prefix>, <vrfname>, <cmd>) - This also fixes calling of dhcp refresh when a dhcp slave is removed from a vrf Signed-off-by: Roopa Prabhu <roopa@cumulusnetworks.com>
2016-04-05 16:11:41 -07:00
def start(self, ifacename, wait=True, cmd_prefix=None):
Move ifupdown2addons into ifupdown2 pacakge Ticket: CM-3864 Reviewed By: Testing Done: Tested build and install open item: - cleanup stale ifupdown2-addons package files
2014-10-09 16:02:46 -07:00
if os.path.exists('/sbin/dhclient3'):
cmd = ['/sbin/dhclient3', '-pf',
'/run/dhclient.%s.pid' %ifacename,
'-lf', '/var/lib/dhcp3/dhclient.%s.leases' %ifacename,
'%s' %ifacename]
else:
addons: dhcp: add vrf awareness Ticket: CM-10292, CM-10282 Reviewed By: dsa, nikhil, julien Testing Done: Tested dhcp config on an vrf slave - Add support for policy module_globals variable "vrf-exec-cmd-prefix". It is read into per module self.vrf_exec_cmd_prefix variable - If self.vrf_exec_cmd_prefix is present and interface is a vrf slave, use ifupdown2 will call such command in vrf context using: "%s %s %s" %(<vrf-exec-cmd-prefix>, <vrfname>, <cmd>) - This also fixes calling of dhcp refresh when a dhcp slave is removed from a vrf Signed-off-by: Roopa Prabhu <roopa@cumulusnetworks.com>
2016-04-05 16:11:41 -07:00
cmd = ['/sbin/dhclient', '-pf',
'/run/dhclient.%s.pid' %ifacename, '-lf',
'/var/lib/dhcp/dhclient.%s.leases' %ifacename,
Move ifupdown2addons into ifupdown2 pacakge Ticket: CM-3864 Reviewed By: Testing Done: Tested build and install open item: - cleanup stale ifupdown2-addons package files
2014-10-09 16:02:46 -07:00
'%s' %ifacename]
ifupdown2: Modify implementation of nowait option Ticket: None Reviewed By: CCR-4058 Testing Done: ifup'd interface with both dhcp-wait: "no" and dhcp-wait: "yes" and not specified at all. A previous patch implemented the nowait option for DHCP. This patch changes the name of the option to "dhcp-wait" and makes the default, if nothing is specified in the policy files, to be "yes", which means dhclient will be called without the "-nw" option, causing it to wait for up to a minute for a response from the DHCP server before continuing. The format of the JSON in the policy file for this option was also changed so that it conforms to the other ifupdown2 policy options. This format is now: { "dhcp": { "defaults": { "dhcp-wait": "no" } } } Also, the documented argument values are "yes" and "no". Any other values, will be interpreted as "yes". A subsequent patch in cl-basefiles will be made to include this fragment in /var/lib/ifupdown2/policy.d/dhcp.json so that Cumulus Linux will default to not waiting for DHCP to complete.
2016-02-03 16:38:18 -08:00
if not wait:
ifupdown2: Add nowait attribute for dhcp addon Ticket: None Reviewed By: CCR-4058 Testing Done: ifup'd interface with both nowait=0 and nowait=1 and not specified at all. The Mellanox platform, as well as some others probably, has two management interfaces: eth0 and eth1. The customer may plug a cable into either one of these interfaces, and very rarely both of them. If only one cable is plugged in and we don't know which one, then /etc/network/interfaces must be configured by default to automatically bring up both interfaces using DHCP. But when an interface does not have link, it stalls the boot process for 60 seconds while dhclient times out. This patch changes the default dhclient behavior to not wait for DHCP to complete, by using the "-nw" option when calling dhclient. This means that dhclient will immediately return and DHCP will complete in the background. A module attribute has been added for the DHCP addon called "nowait", which defaults to 1. If this attribute is set to 0, then dhclient will revert to its previous behavior and delay up to a minute while DHCP completes. This attribute can be specified in a policy file, e.g. /etc/network/ifupdown2/policy.d/dhcp.json, with contents such as: { "dhcp" : { "nowait" : 0 } }
2016-02-01 16:42:14 -08:00
cmd.append('-nw')
addons: dhcp: add vrf awareness Ticket: CM-10292, CM-10282 Reviewed By: dsa, nikhil, julien Testing Done: Tested dhcp config on an vrf slave - Add support for policy module_globals variable "vrf-exec-cmd-prefix". It is read into per module self.vrf_exec_cmd_prefix variable - If self.vrf_exec_cmd_prefix is present and interface is a vrf slave, use ifupdown2 will call such command in vrf context using: "%s %s %s" %(<vrf-exec-cmd-prefix>, <vrfname>, <cmd>) - This also fixes calling of dhcp refresh when a dhcp slave is removed from a vrf Signed-off-by: Roopa Prabhu <roopa@cumulusnetworks.com>
2016-04-05 16:11:41 -07:00
self._run_dhclient_cmd(cmd, cmd_prefix)
Move ifupdown2addons into ifupdown2 pacakge Ticket: CM-3864 Reviewed By: Testing Done: Tested build and install open item: - cleanup stale ifupdown2-addons package files
2014-10-09 16:02:46 -07:00
addons: dhcp: add vrf awareness Ticket: CM-10292, CM-10282 Reviewed By: dsa, nikhil, julien Testing Done: Tested dhcp config on an vrf slave - Add support for policy module_globals variable "vrf-exec-cmd-prefix". It is read into per module self.vrf_exec_cmd_prefix variable - If self.vrf_exec_cmd_prefix is present and interface is a vrf slave, use ifupdown2 will call such command in vrf context using: "%s %s %s" %(<vrf-exec-cmd-prefix>, <vrfname>, <cmd>) - This also fixes calling of dhcp refresh when a dhcp slave is removed from a vrf Signed-off-by: Roopa Prabhu <roopa@cumulusnetworks.com>
2016-04-05 16:11:41 -07:00
def release(self, ifacename, cmd_prefix=None):
Move ifupdown2addons into ifupdown2 pacakge Ticket: CM-3864 Reviewed By: Testing Done: Tested build and install open item: - cleanup stale ifupdown2-addons package files
2014-10-09 16:02:46 -07:00
if os.path.exists('/sbin/dhclient3'):
cmd = ['/sbin/dhclient3', '-r', '-pf',
'/run/dhclient.%s.pid' %ifacename, '-lf',
'/var/lib/dhcp3/dhclient.%s.leases' %ifacename,
'%s' %ifacename]
else:
cmd = ['/sbin/dhclient', '-r', '-pf',
'/run/dhclient.%s.pid' %ifacename,
'-lf', '/var/lib/dhcp/dhclient.%s.leases' %ifacename,
'%s' %ifacename]
addons: dhcp: add vrf awareness Ticket: CM-10292, CM-10282 Reviewed By: dsa, nikhil, julien Testing Done: Tested dhcp config on an vrf slave - Add support for policy module_globals variable "vrf-exec-cmd-prefix". It is read into per module self.vrf_exec_cmd_prefix variable - If self.vrf_exec_cmd_prefix is present and interface is a vrf slave, use ifupdown2 will call such command in vrf context using: "%s %s %s" %(<vrf-exec-cmd-prefix>, <vrfname>, <cmd>) - This also fixes calling of dhcp refresh when a dhcp slave is removed from a vrf Signed-off-by: Roopa Prabhu <roopa@cumulusnetworks.com>
2016-04-05 16:11:41 -07:00
self._run_dhclient_cmd(cmd, cmd_prefix)
Move ifupdown2addons into ifupdown2 pacakge Ticket: CM-3864 Reviewed By: Testing Done: Tested build and install open item: - cleanup stale ifupdown2-addons package files
2014-10-09 16:02:46 -07:00
addons: dhcp: add vrf awareness Ticket: CM-10292, CM-10282 Reviewed By: dsa, nikhil, julien Testing Done: Tested dhcp config on an vrf slave - Add support for policy module_globals variable "vrf-exec-cmd-prefix". It is read into per module self.vrf_exec_cmd_prefix variable - If self.vrf_exec_cmd_prefix is present and interface is a vrf slave, use ifupdown2 will call such command in vrf context using: "%s %s %s" %(<vrf-exec-cmd-prefix>, <vrfname>, <cmd>) - This also fixes calling of dhcp refresh when a dhcp slave is removed from a vrf Signed-off-by: Roopa Prabhu <roopa@cumulusnetworks.com>
2016-04-05 16:11:41 -07:00
def start6(self, ifacename, wait=True, cmd_prefix=None):
cmd = ['/sbin/dhclient', '-6', '-pf',
Move ifupdown2addons into ifupdown2 pacakge Ticket: CM-3864 Reviewed By: Testing Done: Tested build and install open item: - cleanup stale ifupdown2-addons package files
2014-10-09 16:02:46 -07:00
'/run/dhclient6.%s.pid' %ifacename, '-lf',
'/var/lib/dhcp/dhclient.%s.leases ' %ifacename,
ifupdown2: Add nowait attribute for dhcp addon Ticket: None Reviewed By: CCR-4058 Testing Done: ifup'd interface with both nowait=0 and nowait=1 and not specified at all. The Mellanox platform, as well as some others probably, has two management interfaces: eth0 and eth1. The customer may plug a cable into either one of these interfaces, and very rarely both of them. If only one cable is plugged in and we don't know which one, then /etc/network/interfaces must be configured by default to automatically bring up both interfaces using DHCP. But when an interface does not have link, it stalls the boot process for 60 seconds while dhclient times out. This patch changes the default dhclient behavior to not wait for DHCP to complete, by using the "-nw" option when calling dhclient. This means that dhclient will immediately return and DHCP will complete in the background. A module attribute has been added for the DHCP addon called "nowait", which defaults to 1. If this attribute is set to 0, then dhclient will revert to its previous behavior and delay up to a minute while DHCP completes. This attribute can be specified in a policy file, e.g. /etc/network/ifupdown2/policy.d/dhcp.json, with contents such as: { "dhcp" : { "nowait" : 0 } }
2016-02-01 16:42:14 -08:00
'%s' %ifacename]
ifupdown2: Modify implementation of nowait option Ticket: None Reviewed By: CCR-4058 Testing Done: ifup'd interface with both dhcp-wait: "no" and dhcp-wait: "yes" and not specified at all. A previous patch implemented the nowait option for DHCP. This patch changes the name of the option to "dhcp-wait" and makes the default, if nothing is specified in the policy files, to be "yes", which means dhclient will be called without the "-nw" option, causing it to wait for up to a minute for a response from the DHCP server before continuing. The format of the JSON in the policy file for this option was also changed so that it conforms to the other ifupdown2 policy options. This format is now: { "dhcp": { "defaults": { "dhcp-wait": "no" } } } Also, the documented argument values are "yes" and "no". Any other values, will be interpreted as "yes". A subsequent patch in cl-basefiles will be made to include this fragment in /var/lib/ifupdown2/policy.d/dhcp.json so that Cumulus Linux will default to not waiting for DHCP to complete.
2016-02-03 16:38:18 -08:00
if not wait:
ifupdown2: Add nowait attribute for dhcp addon Ticket: None Reviewed By: CCR-4058 Testing Done: ifup'd interface with both nowait=0 and nowait=1 and not specified at all. The Mellanox platform, as well as some others probably, has two management interfaces: eth0 and eth1. The customer may plug a cable into either one of these interfaces, and very rarely both of them. If only one cable is plugged in and we don't know which one, then /etc/network/interfaces must be configured by default to automatically bring up both interfaces using DHCP. But when an interface does not have link, it stalls the boot process for 60 seconds while dhclient times out. This patch changes the default dhclient behavior to not wait for DHCP to complete, by using the "-nw" option when calling dhclient. This means that dhclient will immediately return and DHCP will complete in the background. A module attribute has been added for the DHCP addon called "nowait", which defaults to 1. If this attribute is set to 0, then dhclient will revert to its previous behavior and delay up to a minute while DHCP completes. This attribute can be specified in a policy file, e.g. /etc/network/ifupdown2/policy.d/dhcp.json, with contents such as: { "dhcp" : { "nowait" : 0 } }
2016-02-01 16:42:14 -08:00
cmd.append('-nw')
addons: dhcp: add vrf awareness Ticket: CM-10292, CM-10282 Reviewed By: dsa, nikhil, julien Testing Done: Tested dhcp config on an vrf slave - Add support for policy module_globals variable "vrf-exec-cmd-prefix". It is read into per module self.vrf_exec_cmd_prefix variable - If self.vrf_exec_cmd_prefix is present and interface is a vrf slave, use ifupdown2 will call such command in vrf context using: "%s %s %s" %(<vrf-exec-cmd-prefix>, <vrfname>, <cmd>) - This also fixes calling of dhcp refresh when a dhcp slave is removed from a vrf Signed-off-by: Roopa Prabhu <roopa@cumulusnetworks.com>
2016-04-05 16:11:41 -07:00
self._run_dhclient_cmd(cmd, cmd_prefix)
Move ifupdown2addons into ifupdown2 pacakge Ticket: CM-3864 Reviewed By: Testing Done: Tested build and install open item: - cleanup stale ifupdown2-addons package files
2014-10-09 16:02:46 -07:00
addons: dhcp: add vrf awareness Ticket: CM-10292, CM-10282 Reviewed By: dsa, nikhil, julien Testing Done: Tested dhcp config on an vrf slave - Add support for policy module_globals variable "vrf-exec-cmd-prefix". It is read into per module self.vrf_exec_cmd_prefix variable - If self.vrf_exec_cmd_prefix is present and interface is a vrf slave, use ifupdown2 will call such command in vrf context using: "%s %s %s" %(<vrf-exec-cmd-prefix>, <vrfname>, <cmd>) - This also fixes calling of dhcp refresh when a dhcp slave is removed from a vrf Signed-off-by: Roopa Prabhu <roopa@cumulusnetworks.com>
2016-04-05 16:11:41 -07:00
def stop6(self, ifacename, cmd_prefix=None):
cmd = ['/sbin/dhclient', '-6', '-x', '-pf',
'/run/dhclient.%s.pid' %ifacename, '-lf',
'/var/lib/dhcp/dhclient.%s.leases ' %ifacename,
'%s' %ifacename]
self._run_dhclient_cmd(cmd, cmd_prefix)
Move ifupdown2addons into ifupdown2 pacakge Ticket: CM-3864 Reviewed By: Testing Done: Tested build and install open item: - cleanup stale ifupdown2-addons package files
2014-10-09 16:02:46 -07:00
addons: dhcp: add vrf awareness Ticket: CM-10292, CM-10282 Reviewed By: dsa, nikhil, julien Testing Done: Tested dhcp config on an vrf slave - Add support for policy module_globals variable "vrf-exec-cmd-prefix". It is read into per module self.vrf_exec_cmd_prefix variable - If self.vrf_exec_cmd_prefix is present and interface is a vrf slave, use ifupdown2 will call such command in vrf context using: "%s %s %s" %(<vrf-exec-cmd-prefix>, <vrfname>, <cmd>) - This also fixes calling of dhcp refresh when a dhcp slave is removed from a vrf Signed-off-by: Roopa Prabhu <roopa@cumulusnetworks.com>
2016-04-05 16:11:41 -07:00
def release6(self, ifacename, cmd_prefix=None):
cmd = ['/sbin/dhclient', '-6', '-r', '-pf',
addons: dhcp: stop IPv6 dhclient on ifdown and add delay before starting dhclient Ticket: CM-11043 Reviewed By: roopa Testing Done: used the config mentioned in bug This patch adds a delay before starting IPv6 dhclient to make sure the configured interface/link in up. Also, ifdown on a IPv6 interface, this patch makes sure that the link in up before dhcp release. Dhcp release is done using a default lease file. Signed-off-by: Nikhil <nikhil@cumulusnetworks.com>
2016-07-15 14:21:23 -07:00
'/run/dhclient6.%s.pid' %ifacename,
addons: dhcp: add vrf awareness Ticket: CM-10292, CM-10282 Reviewed By: dsa, nikhil, julien Testing Done: Tested dhcp config on an vrf slave - Add support for policy module_globals variable "vrf-exec-cmd-prefix". It is read into per module self.vrf_exec_cmd_prefix variable - If self.vrf_exec_cmd_prefix is present and interface is a vrf slave, use ifupdown2 will call such command in vrf context using: "%s %s %s" %(<vrf-exec-cmd-prefix>, <vrfname>, <cmd>) - This also fixes calling of dhcp refresh when a dhcp slave is removed from a vrf Signed-off-by: Roopa Prabhu <roopa@cumulusnetworks.com>
2016-04-05 16:11:41 -07:00
'%s' %ifacename]
self._run_dhclient_cmd(cmd, cmd_prefix)
Copy Permalink