VNFs/DPPD-PROX/helper-scripts/rapid/rapid_machine.py

   1 #!/usr/bin/python
   2
   3 ##
   4 ## Copyright (c) 2020 Intel Corporation
   5 ##
   6 ## Licensed under the Apache License, Version 2.0 (the "License");
   7 ## you may not use this file except in compliance with the License.
   8 ## You may obtain a copy of the License at
   9 ##
  10 ##     http://www.apache.org/licenses/LICENSE-2.0
  11 ##
  12 ## Unless required by applicable law or agreed to in writing, software
  13 ## distributed under the License is distributed on an "AS IS" BASIS,
  14 ## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15 ## See the License for the specific language governing permissions and
  16 ## limitations under the License.
  17 ##
  18
  19 from rapid_log import RapidLog
  20 from prox_ctrl import prox_ctrl
  21 import os
  22 import re
  23
  24 class RapidMachine(object):
  25     """
  26     Class to deal with a PROX instance (VM, bare metal, container)
  27     """
  28     def __init__(self, key, user, password, vim, rundir, resultsdir,
  29             machine_params, configonly):
  30         self.name = machine_params['name']
  31         self.ip = machine_params['admin_ip']
  32         self.key = key
  33         self.user = user
  34         self.password = password
  35         self.rundir = rundir
  36         self.resultsdir = resultsdir
  37         self.dp_ports = []
  38         self.dpdk_port_index = []
  39         self.configonly = configonly
  40         index = 1
  41         while True:
  42             ip_key = 'dp_ip{}'.format(index)
  43             mac_key = 'dp_mac{}'.format(index)
  44             if ip_key in machine_params.keys():
  45                 if mac_key in machine_params.keys():
  46                     dp_port = {'ip': machine_params[ip_key], 'mac' : machine_params[mac_key]}
  47                 else:
  48                     dp_port = {'ip': machine_params[ip_key], 'mac' : None}
  49                 self.dp_ports.append(dict(dp_port))
  50                 self.dpdk_port_index.append(index - 1)
  51                 index += 1
  52             else:
  53                 break
  54         self.machine_params = machine_params
  55         self.vim = vim
  56         self.cpu_mapping = None
  57         if 'config_file' in self.machine_params.keys():
  58             PROXConfigfile =  open (self.machine_params['config_file'], 'r')
  59             PROXConfig = PROXConfigfile.read()
  60             PROXConfigfile.close()
  61             self.all_tasks_for_this_cfg = set(re.findall("task\s*=\s*(\d+)",PROXConfig))
  62
  63     def get_cores(self):
  64         return (self.machine_params['cores'])
  65
  66     def expand_list_format(self, list):
  67         """Expand cpuset list format provided as comma-separated list of
  68         numbers and ranges of numbers. For more information please see
  69         https://man7.org/linux/man-pages/man7/cpuset.7.html
  70         """
  71         list_expanded = []
  72         for num in list.split(','):
  73             if '-' in num:
  74                 num_range = num.split('-')
  75                 list_expanded += range(int(num_range[0]), int(num_range[1]) + 1)
  76             else:
  77                 list_expanded.append(int(num))
  78         return list_expanded
  79
  80     def read_cpuset(self):
  81         """Read list of cpus on which we allowed to execute
  82         """
  83         cpu_set_file = '/sys/fs/cgroup/cpuset.cpus'
  84         cmd = 'test -e {0} && echo exists'.format(cpu_set_file)
  85         if (self._client.run_cmd(cmd).decode().rstrip()):
  86             cmd = 'cat {}'.format(cpu_set_file)
  87         else:
  88             cpu_set_file = '/sys/fs/cgroup/cpuset/cpuset.cpus'
  89             cmd = 'test -e {0} && echo exists'.format(cpu_set_file)
  90             if (self._client.run_cmd(cmd).decode().rstrip()):
  91                 cmd = 'cat {}'.format(cpu_set_file)
  92             else:
  93                 RapidLog.critical('{Cannot determine cpuset')
  94         cpuset_cpus = self._client.run_cmd(cmd).decode().rstrip()
  95         RapidLog.debug('{} ({}): Allocated cpuset: {}'.format(self.name, self.ip, cpuset_cpus))
  96         self.cpu_mapping = self.expand_list_format(cpuset_cpus)
  97         RapidLog.debug('{} ({}): Expanded cpuset: {}'.format(self.name, self.ip, self.cpu_mapping))
  98
  99         # Log CPU core mapping for user information
 100         cpu_mapping_str = ''
 101         for i in range(len(self.cpu_mapping)):
 102             cpu_mapping_str = cpu_mapping_str + '[' + str(i) + '->' + str(self.cpu_mapping[i]) + '], '
 103         cpu_mapping_str = cpu_mapping_str[:-2]
 104         RapidLog.debug('{} ({}): CPU mapping: {}'.format(self.name, self.ip, cpu_mapping_str))
 105
 106     def remap_cpus(self, cpus):
 107         """Convert relative cpu ids provided as function parameter to match
 108         cpu ids from allocated list
 109         """
 110         cpus_remapped = []
 111         for cpu in cpus:
 112             cpus_remapped.append(self.cpu_mapping[cpu])
 113         return cpus_remapped
 114
 115     def remap_all_cpus(self):
 116         """Convert relative cpu ids for different parameters (mcore, cores)
 117         """
 118         if self.cpu_mapping is None:
 119             RapidLog.debug('{} ({}): cpu mapping is not defined! Please check the configuration!'.format(self.name, self.ip))
 120             return
 121
 122         if 'mcore' in self.machine_params.keys():
 123             cpus_remapped = self.remap_cpus(self.machine_params['mcore'])
 124             RapidLog.debug('{} ({}): mcore {} remapped to {}'.format(self.name, self.ip, self.machine_params['mcore'], cpus_remapped))
 125             self.machine_params['mcore'] = cpus_remapped
 126
 127         if 'cores' in self.machine_params.keys():
 128             cpus_remapped = self.remap_cpus(self.machine_params['cores'])
 129             RapidLog.debug('{} ({}): cores {} remapped to {}'.format(self.name, self.ip, self.machine_params['cores'], cpus_remapped))
 130             self.machine_params['cores'] = cpus_remapped
 131
 132     def devbind(self):
 133         # Script to bind the right network interface to the poll mode driver
 134         for index, dp_port in enumerate(self.dp_ports, start = 1):
 135             DevBindFileName = self.rundir + '/devbind-{}-port{}.sh'.format(self.ip, index)
 136             self._client.scp_put('./devbind.sh', DevBindFileName)
 137             cmd =  'sed -i \'s/MACADDRESS/' + dp_port['mac'] + '/\' ' + DevBindFileName
 138             result = self._client.run_cmd(cmd)
 139             RapidLog.debug('devbind.sh MAC updated for port {} on {} {}'.format(index, self.name, result))
 140             if ((not self.configonly) and self.machine_params['prox_launch_exit']):
 141                 result = self._client.run_cmd(DevBindFileName)
 142                 RapidLog.debug('devbind.sh running for port {} on {} {}'.format(index, self.name, result))
 143
 144     def generate_lua(self, appendix = ''):
 145         self.LuaFileName = 'parameters-{}.lua'.format(self.ip)
 146         with open(self.LuaFileName, "w") as LuaFile:
 147             LuaFile.write('require "helper"\n')
 148             LuaFile.write('name="%s"\n'% self.name)
 149             for index, dp_port in enumerate(self.dp_ports, start = 1):
 150                 LuaFile.write('local_ip{}="{}"\n'.format(index, dp_port['ip']))
 151                 LuaFile.write('local_hex_ip{}=convertIPToHex(local_ip{})\n'.format(index, index))
 152             if self.vim in ['kubernetes']:
 153                 cmd = 'cat /opt/rapid/dpdk_version'
 154                 dpdk_version = self._client.run_cmd(cmd).decode().rstrip()
 155                 if (dpdk_version >= '20.11.0'):
 156                     allow_parameter = 'allow'
 157                 else:
 158                     allow_parameter = 'pci-whitelist'
 159                 eal_line = 'eal=\"--file-prefix {} --{} {}\"\n'.format(
 160                         self.name, allow_parameter,
 161                         self.machine_params['dp_pci_dev'])
 162                 LuaFile.write(eal_line)
 163             else:
 164                 LuaFile.write("eal=\"\"\n")
 165             if 'mcore' in self.machine_params.keys():
 166                 LuaFile.write('mcore="%s"\n'% ','.join(map(str,
 167                     self.machine_params['mcore'])))
 168             if 'cores' in self.machine_params.keys():
 169                 LuaFile.write('cores="%s"\n'% ','.join(map(str,
 170                     self.machine_params['cores'])))
 171             if 'ports' in self.machine_params.keys():
 172                 LuaFile.write('ports="%s"\n'% ','.join(map(str,
 173                     self.machine_params['ports'])))
 174             if 'dest_ports' in self.machine_params.keys():
 175                 for index, dest_port in enumerate(self.machine_params['dest_ports'], start = 1):
 176                     LuaFile.write('dest_ip{}="{}"\n'.format(index, dest_port['ip']))
 177                     LuaFile.write('dest_hex_ip{}=convertIPToHex(dest_ip{})\n'.format(index, index))
 178                     if dest_port['mac']:
 179                         LuaFile.write('dest_hex_mac{}="{}"\n'.format(index ,
 180                             dest_port['mac'].replace(':',' ')))
 181             if 'gw_vm' in self.machine_params.keys():
 182                 for index, gw_ip in enumerate(self.machine_params['gw_ips'],
 183                         start = 1):
 184                     LuaFile.write('gw_ip{}="{}"\n'.format(index, gw_ip))
 185                     LuaFile.write('gw_hex_ip{}=convertIPToHex(gw_ip{})\n'.
 186                             format(index, index))
 187             LuaFile.write(appendix)
 188         self._client.scp_put(self.LuaFileName, self.rundir + '/parameters.lua')
 189         self._client.scp_put('helper.lua', self.rundir + '/helper.lua')
 190
 191     def start_prox(self, autostart=''):
 192         if self.machine_params['prox_socket']:
 193             self._client = prox_ctrl(self.ip, self.key, self.user,
 194                     self.password)
 195             self._client.test_connection()
 196             if self.vim in ['OpenStack']:
 197                 self.devbind()
 198             if self.vim in ['kubernetes']:
 199                 self.read_cpuset()
 200                 self.remap_all_cpus()
 201             _, prox_config_file_name = os.path.split(self.
 202                     machine_params['config_file'])
 203             if self.machine_params['prox_launch_exit']:
 204                 self.generate_lua()
 205                 self._client.scp_put(self.machine_params['config_file'], '{}/{}'.
 206                         format(self.rundir, prox_config_file_name))
 207                 if not self.configonly:
 208                     cmd = 'sudo {}/prox {} -t -o cli -f {}/{}'.format(self.rundir,
 209                             autostart, self.rundir, prox_config_file_name)
 210                     RapidLog.debug("Starting PROX on {}: {}".format(self.name,
 211                         cmd))
 212                     result = self._client.run_cmd(cmd)
 213                     RapidLog.debug("Finished PROX on {}: {}".format(self.name,
 214                         cmd))
 215
 216     def close_prox(self):
 217         if (not self.configonly) and self.machine_params[
 218                 'prox_socket'] and self.machine_params['prox_launch_exit']:
 219             self.socket.quit_prox()
 220             self._client.scp_get('/prox.log', '{}/{}.prox.log'.format(
 221                 self.resultsdir, self.name))
 222
 223     def connect_prox(self):
 224         if self.machine_params['prox_socket']:
 225            self.socket = self._client.connect_socket()
 226
 227     def start(self):
 228         self.socket.start(self.get_cores())
 229
 230     def stop(self):
 231         self.socket.stop(self.get_cores())
 232
 233     def reset_stats(self):
 234         self.socket.reset_stats()
 235
 236     def core_stats(self):
 237         return (self.socket.core_stats(self.get_cores(), self.all_tasks_for_this_cfg))
 238
 239     def multi_port_stats(self):
 240         return (self.socket.multi_port_stats(self.dpdk_port_index))