1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
|
# Copyright 2015-2016 Intel Corporation.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Automation of system configuration for DPDK use.
Parts of this based on ``tools/dpdk_nic_bind.py`` script from Intel(R)
DPDK.
"""
from sys import platform as _platform
import os
import subprocess
import logging
import locale
from tools import tasks
from conf import settings
from tools.module_manager import ModuleManager
_LOGGER = logging.getLogger(__name__)
RTE_PCI_TOOL = os.path.join(
settings.getValue('RTE_SDK'), 'tools', 'dpdk_nic_bind.py')
_DPDK_MODULE_MANAGER = ModuleManager()
#
# system management
#
def init():
"""Setup system for DPDK.
"""
if not _is_linux():
_LOGGER.error('Not running on a compatible Linux version. Exiting...')
return
_insert_modules()
_remove_vhost_net()
_bind_nics()
def cleanup():
"""Setup system for DPDK.
"""
if not _is_linux():
_LOGGER.error('Not running on a compatible Linux version. Exiting...')
return
_unbind_nics()
_remove_modules()
_vhost_user_cleanup()
#
# basic compatibility test
#
def _is_linux():
"""Check if running on Linux.
Many of the functions in this file rely on features commonly found
only on Linux (i.e. ``/proc`` is not present on FreeBSD). Hence, this
check is important to ensure someone doesn't run this on an incompatible
OS or distro.
"""
return _platform.startswith('linux') and os.path.isdir('/proc')
#
# module management
#
def _insert_modules():
"""Ensure required modules are inserted on system.
"""
_DPDK_MODULE_MANAGER.insert_modules(settings.getValue('SYS_MODULES'))
mod_path_prefix = settings.getValue('OVS_DIR')
_DPDK_MODULE_MANAGER.insert_module_group(settings.getValue('OVS_MODULES'),
mod_path_prefix)
if 'vfio-pci' not in settings.getValue('DPDK_MODULES'):
mod_path_prefix = os.path.join(settings.getValue('RTE_SDK'),
settings.getValue('RTE_TARGET'))
_DPDK_MODULE_MANAGER.insert_module_group(settings.getValue('DPDK_MODULES'),
mod_path_prefix)
else:
_DPDK_MODULE_MANAGER.insert_modules(settings.getValue('DPDK_MODULES'))
def _remove_modules():
"""Ensure required modules are removed from system.
"""
_DPDK_MODULE_MANAGER.remove_modules()
#
# vhost specific modules management
#
def insert_vhost_modules():
"""Inserts VHOST related kernel modules
"""
mod_path_prefix = os.path.join(settings.getValue('RTE_SDK'),
'lib',
'librte_vhost')
_DPDK_MODULE_MANAGER.insert_module_group('VHOST_MODULE', mod_path_prefix)
def remove_vhost_modules():
"""Removes all VHOST related kernel modules
"""
_DPDK_MODULE_MANAGER.remove_module_group(settings.getValue('VHOST_MODULE'))
#
# 'vhost-net' module cleanup
#
def _remove_vhost_net():
"""Remove vhost-net driver and file.
"""
_DPDK_MODULE_MANAGER.remove_module('vhost-net')
try:
tasks.run_task(['sudo', 'rm', '-f', '/dev/vhost-net'], _LOGGER,
'Removing \'/dev/vhost-net\' directory...', True)
except subprocess.CalledProcessError:
_LOGGER.error('Unable to remove directory \'/dev/vhost-net\'.')
#
# Vhost-user cleanup
#
def _vhost_user_cleanup():
"""Remove files created by vhost-user tests.
"""
for sock in settings.getValue('VHOST_USER_SOCKS'):
if os.path.exists(sock):
try:
tasks.run_task(['sudo', 'rm', sock],
_LOGGER,
'Deleting vhost-user socket \'%s\'...' %
sock,
True)
except subprocess.CalledProcessError:
_LOGGER.error('Unable to delete vhost-user socket \'%s\'.',
sock)
continue
#
# NIC management
#
def _bind_nics():
"""Bind NICs using the Intel DPDK ``dpdk_nic_bind.py`` tool.
"""
try:
_driver = 'igb_uio'
if 'vfio-pci' in settings.getValue('DPDK_MODULES'):
_driver = 'vfio-pci'
tasks.run_task(['sudo', 'chmod', 'a+x', '/dev/vfio'],
_LOGGER, 'Setting VFIO permissions .. a+x',
True)
tasks.run_task(['sudo', 'chmod', '-R', '666', '/dev/vfio/'],
_LOGGER, 'Setting VFIO permissions .. 0666',
True)
tasks.run_task(['sudo', RTE_PCI_TOOL, '--bind=' + _driver] +
settings.getValue('WHITELIST_NICS'), _LOGGER,
'Binding NICs %s...' %
settings.getValue('WHITELIST_NICS'),
True)
except subprocess.CalledProcessError:
_LOGGER.error('Unable to bind NICs %s',
str(settings.getValue('WHITELIST_NICS')))
def _unbind_nics_get_driver():
"""Check what driver the NICs should be bound to
after unbinding them from DPDK.
"""
_driver_list = []
_output = subprocess.check_output([os.path.expanduser(RTE_PCI_TOOL), '--status'])
_my_encoding = locale.getdefaultlocale()[1]
for line in _output.decode(_my_encoding).split('\n'):
for nic in settings.getValue('WHITELIST_NICS'):
if nic in line:
_driver_list.append((line.split("unused=", 1)[1]))
return _driver_list
def _unbind_nics():
"""Unbind NICs using the Intel DPDK ``dpdk_nic_bind.py`` tool.
"""
nic_drivers = _unbind_nics_get_driver()
try:
tasks.run_task(['sudo', RTE_PCI_TOOL, '--unbind'] +
settings.getValue('WHITELIST_NICS'), _LOGGER,
'Unbinding NICs %s...' %
str(settings.getValue('WHITELIST_NICS')),
True)
except subprocess.CalledProcessError:
_LOGGER.error('Unable to unbind NICs %s',
str(settings.getValue('WHITELIST_NICS')))
# Rebind NICs to their original drivers
# using the Intel DPDK ``dpdk_nic_bind.py`` tool.
for i, nic in enumerate(settings.getValue('WHITELIST_NICS')):
try:
if nic_drivers[i] != '':
tasks.run_task(['sudo', RTE_PCI_TOOL, '--bind',
nic_drivers[i], nic],
_LOGGER, 'Binding NIC %s...' %
nic,
True)
except subprocess.CalledProcessError:
_LOGGER.error('Unable to bind NICs %s to drivers %s',
str(settings.getValue('WHITELIST_NICS')),
nic_drivers)
class Dpdk(object):
"""A context manager for the system init/cleanup.
"""
def __enter__(self):
_LOGGER.info('Setting up DPDK')
init()
return self
def __exit__(self, type_, value, traceback):
_LOGGER.info('Cleaning up DPDK')
cleanup()
|
