437386d81d165900c65c6245ffe9d021bbe0f60b
[csit.git] / resources / libraries / python / VppConfigGenerator.py
1 # Copyright (c) 2020 Cisco and/or its affiliates.
2 # Licensed under the Apache License, Version 2.0 (the "License");
3 # you may not use this file except in compliance with the License.
4 # You may obtain a copy of the License at:
5 #
6 #     http://www.apache.org/licenses/LICENSE-2.0
7 #
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS,
10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 # See the License for the specific language governing permissions and
12 # limitations under the License.
13
14 """VPP Configuration File Generator library.
15
16 TODO: Support initialization with default values,
17 so that we do not need to have block of 6 "Add Unix" commands
18 in 7 various places of CSIT code.
19 """
20
21 import re
22
23 from resources.libraries.python.Constants import Constants
24 from resources.libraries.python.ssh import exec_cmd_no_error
25 from resources.libraries.python.topology import NodeType
26 from resources.libraries.python.topology import Topology
27 from resources.libraries.python.VPPUtil import VPPUtil
28
29 __all__ = [u"VppConfigGenerator"]
30
31
32 def pci_dev_check(pci_dev):
33     """Check if provided PCI address is in correct format.
34
35     :param pci_dev: PCI address (expected format: xxxx:xx:xx.x).
36     :type pci_dev: str
37     :returns: True if PCI address is in correct format.
38     :rtype: bool
39     :raises ValueError: If PCI address is in incorrect format.
40     """
41     pattern = re.compile(
42         r"^[0-9A-Fa-f]{4}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}\.[0-9A-Fa-f]$"
43     )
44     if not re.match(pattern, pci_dev):
45         raise ValueError(
46             f"PCI address {pci_dev} is not in valid format xxxx:xx:xx.x"
47         )
48     return True
49
50
51 class VppConfigGenerator:
52     """VPP Configuration File Generator."""
53
54     def __init__(self):
55         """Initialize library."""
56         # VPP Node to apply configuration on
57         self._node = u""
58         # Topology node key
59         self._node_key = u""
60         # VPP Configuration
61         self._nodeconfig = dict()
62         # Serialized VPP Configuration
63         self._vpp_config = u""
64         # VPP Service name
65         self._vpp_service_name = u"vpp"
66         # VPP Logfile location
67         self._vpp_logfile = u"/tmp/vpe.log"
68         # VPP Startup config location
69         self._vpp_startup_conf = u"/etc/vpp/startup.conf"
70         # VPP Startup config backup location
71         self._vpp_startup_conf_backup = None
72
73     def set_node(self, node, node_key=None):
74         """Set DUT node.
75
76         :param node: Node to store configuration on.
77         :param node_key: Topology node key.
78         :type node: dict
79         :type node_key: str
80         :raises RuntimeError: If Node type is not DUT.
81         """
82         if node[u"type"] != NodeType.DUT:
83             raise RuntimeError(
84                 u"Startup config can only be applied to DUTnode."
85             )
86         self._node = node
87         self._node_key = node_key
88
89     def set_vpp_logfile(self, logfile):
90         """Set VPP logfile location.
91
92         :param logfile: VPP logfile location.
93         :type logfile: str
94         """
95         self._vpp_logfile = logfile
96
97     def set_vpp_startup_conf_backup(self, backup=u"/etc/vpp/startup.backup"):
98         """Set VPP startup configuration backup.
99
100         :param backup: VPP logfile location.
101         :type backup: str
102         """
103         self._vpp_startup_conf_backup = backup
104
105     def get_config_str(self):
106         """Get dumped startup configuration in VPP config format.
107
108         :returns: Startup configuration in VPP config format.
109         :rtype: str
110         """
111         self.dump_config(self._nodeconfig)
112         return self._vpp_config
113
114     def add_config_item(self, config, value, path):
115         """Add startup configuration item.
116
117         :param config: Startup configuration of node.
118         :param value: Value to insert.
119         :param path: Path where to insert item.
120         :type config: dict
121         :type value: str
122         :type path: list
123         """
124         if len(path) == 1:
125             config[path[0]] = value
126             return
127         if path[0] not in config:
128             config[path[0]] = dict()
129         elif isinstance(config[path[0]], str):
130             config[path[0]] = dict() if config[path[0]] == u"" \
131                 else {config[path[0]]: u""}
132         self.add_config_item(config[path[0]], value, path[1:])
133
134     def dump_config(self, obj, level=-1):
135         """Dump the startup configuration in VPP config format.
136
137         :param obj: Python Object to print.
138         :param level: Nested level for indentation.
139         :type obj: Obj
140         :type level: int
141         :returns: nothing
142         """
143         indent = u"  "
144         if level >= 0:
145             self._vpp_config += f"{level * indent}{{\n"
146         if isinstance(obj, dict):
147             for key, val in obj.items():
148                 if hasattr(val, u"__iter__") and not isinstance(val, str):
149                     self._vpp_config += f"{(level + 1) * indent}{key}\n"
150                     self.dump_config(val, level + 1)
151                 else:
152                     self._vpp_config += f"{(level + 1) * indent}{key} {val}\n"
153         else:
154             for val in obj:
155                 self._vpp_config += f"{(level + 1) * indent}{val}\n"
156         if level >= 0:
157             self._vpp_config += f"{level * indent}}}\n"
158
159     def add_unix_log(self, value=None):
160         """Add UNIX log configuration.
161
162         :param value: Log file.
163         :type value: str
164         """
165         path = [u"unix", u"log"]
166         if value is None:
167             value = self._vpp_logfile
168         self.add_config_item(self._nodeconfig, value, path)
169
170     def add_unix_cli_listen(self, value=u"/run/vpp/cli.sock"):
171         """Add UNIX cli-listen configuration.
172
173         :param value: CLI listen address and port or path to CLI socket.
174         :type value: str
175         """
176         path = [u"unix", u"cli-listen"]
177         self.add_config_item(self._nodeconfig, value, path)
178
179     def add_unix_gid(self, value=u"vpp"):
180         """Add UNIX gid configuration.
181
182         :param value: Gid.
183         :type value: str
184         """
185         path = [u"unix", u"gid"]
186         self.add_config_item(self._nodeconfig, value, path)
187
188     def add_unix_nodaemon(self):
189         """Add UNIX nodaemon configuration."""
190         path = [u"unix", u"nodaemon"]
191         self.add_config_item(self._nodeconfig, u"", path)
192
193     def add_unix_coredump(self):
194         """Add UNIX full-coredump configuration."""
195         path = [u"unix", u"full-coredump"]
196         self.add_config_item(self._nodeconfig, u"", path)
197
198     def add_unix_exec(self, value):
199         """Add UNIX exec configuration."""
200         path = [u"unix", u"exec"]
201         self.add_config_item(self._nodeconfig, value, path)
202
203     def add_socksvr(self, socket=Constants.SOCKSVR_PATH):
204         """Add socksvr configuration."""
205         path = [u"socksvr", u"socket-name"]
206         self.add_config_item(self._nodeconfig, socket, path)
207
208     def add_graph_node_variant(self, variant=Constants.GRAPH_NODE_VARIANT):
209         """Add default graph node variant.
210
211         :param value: Graph node variant default value.
212         :type value: str
213         """
214         if variant == u"":
215             return
216         variant_list = [u"hsw", u"skx", u"icl"]
217         if variant not in variant_list:
218             raise ValueError("Invalid graph node variant value")
219         path = [u"node", u"default", u"variant"]
220         self.add_config_item(self._nodeconfig, variant, path)
221
222     def add_api_segment_gid(self, value=u"vpp"):
223         """Add API-SEGMENT gid configuration.
224
225         :param value: Gid.
226         :type value: str
227         """
228         path = [u"api-segment", u"gid"]
229         self.add_config_item(self._nodeconfig, value, path)
230
231     def add_api_segment_global_size(self, value):
232         """Add API-SEGMENT global-size configuration.
233
234         :param value: Global size.
235         :type value: str
236         """
237         path = [u"api-segment", u"global-size"]
238         self.add_config_item(self._nodeconfig, value, path)
239
240     def add_api_segment_api_size(self, value):
241         """Add API-SEGMENT api-size configuration.
242
243         :param value: API size.
244         :type value: str
245         """
246         path = [u"api-segment", u"api-size"]
247         self.add_config_item(self._nodeconfig, value, path)
248
249     def add_buffers_per_numa(self, value):
250         """Increase number of buffers allocated.
251
252         :param value: Number of buffers allocated.
253         :type value: int
254         """
255         path = [u"buffers", u"buffers-per-numa"]
256         self.add_config_item(self._nodeconfig, value, path)
257
258     def add_buffers_default_data_size(self, value):
259         """Increase buffers data-size allocated.
260
261         :param value: Buffers data-size allocated.
262         :type value: int
263         """
264         path = [u"buffers", u"default data-size"]
265         self.add_config_item(self._nodeconfig, value, path)
266
267     def add_dpdk_dev(self, *devices):
268         """Add DPDK PCI device configuration.
269
270         :param devices: PCI device(s) (format xxxx:xx:xx.x)
271         :type devices: tuple
272         """
273         for device in devices:
274             if pci_dev_check(device):
275                 path = [u"dpdk", f"dev {device}"]
276                 self.add_config_item(self._nodeconfig, u"", path)
277
278     def add_dpdk_dev_parameter(self, device, parameter, value):
279         """Add parameter for DPDK device.
280
281         :param device: PCI device (format xxxx:xx:xx.x).
282         :param parameter: Parameter name.
283         :param value: Parameter value.
284         :type device: str
285         :type parameter: str
286         :type value: str
287         """
288         if pci_dev_check(device):
289             path = [u"dpdk", f"dev {device}", parameter]
290             self.add_config_item(self._nodeconfig, value, path)
291
292     def add_dpdk_cryptodev(self, count):
293         """Add DPDK Crypto PCI device configuration.
294
295         :param count: Number of HW crypto devices to add.
296         :type count: int
297         """
298         cryptodev = Topology.get_cryptodev(self._node)
299         for i in range(count):
300             cryptodev_config = re.sub(r"\d.\d$", f"1.{str(i)}", cryptodev)
301             path = [u"dpdk", f"dev {cryptodev_config}"]
302             self.add_config_item(self._nodeconfig, u"", path)
303         self.add_dpdk_uio_driver(u"vfio-pci")
304
305     def add_dpdk_sw_cryptodev(self, sw_pmd_type, socket_id, count):
306         """Add DPDK SW Crypto device configuration.
307
308         :param sw_pmd_type: Type of SW crypto device PMD to add.
309         :param socket_id: Socket ID.
310         :param count: Number of SW crypto devices to add.
311         :type sw_pmd_type: str
312         :type socket_id: int
313         :type count: int
314         """
315         for _ in range(count):
316             cryptodev_config = f"vdev cryptodev_{sw_pmd_type}_pmd," \
317                 f"socket_id={str(socket_id)}"
318             path = [u"dpdk", cryptodev_config]
319             self.add_config_item(self._nodeconfig, u"", path)
320
321     def add_dpdk_dev_default_rxq(self, value):
322         """Add DPDK dev default rxq configuration.
323
324         :param value: Default number of rxqs.
325         :type value: str
326         """
327         path = [u"dpdk", u"dev default", u"num-rx-queues"]
328         self.add_config_item(self._nodeconfig, value, path)
329
330     def add_dpdk_dev_default_txq(self, value):
331         """Add DPDK dev default txq configuration.
332
333         :param value: Default number of txqs.
334         :type value: str
335         """
336         path = [u"dpdk", u"dev default", u"num-tx-queues"]
337         self.add_config_item(self._nodeconfig, value, path)
338
339     def add_dpdk_dev_default_rxd(self, value):
340         """Add DPDK dev default rxd configuration.
341
342         :param value: Default number of rxds.
343         :type value: str
344         """
345         path = [u"dpdk", u"dev default", u"num-rx-desc"]
346         self.add_config_item(self._nodeconfig, value, path)
347
348     def add_dpdk_dev_default_txd(self, value):
349         """Add DPDK dev default txd configuration.
350
351         :param value: Default number of txds.
352         :type value: str
353         """
354         path = [u"dpdk", u"dev default", u"num-tx-desc"]
355         self.add_config_item(self._nodeconfig, value, path)
356
357     def add_dpdk_log_level(self, value):
358         """Add DPDK log-level configuration.
359
360         :param value: Log level.
361         :type value: str
362         """
363         path = [u"dpdk", u"log-level"]
364         self.add_config_item(self._nodeconfig, value, path)
365
366     def add_dpdk_no_pci(self):
367         """Add DPDK no-pci."""
368         path = [u"dpdk", u"no-pci"]
369         self.add_config_item(self._nodeconfig, u"", path)
370
371     def add_dpdk_uio_driver(self, value=None):
372         """Add DPDK uio-driver configuration.
373
374         :param value: DPDK uio-driver configuration. By default, driver will be
375             loaded automatically from Topology file, still leaving option
376             to manually override by parameter.
377         :type value: str
378         """
379         if value is None:
380             value = Topology.get_uio_driver(self._node)
381         path = [u"dpdk", u"uio-driver"]
382         self.add_config_item(self._nodeconfig, value, path)
383
384     def add_cpu_main_core(self, value):
385         """Add CPU main core configuration.
386
387         :param value: Main core option.
388         :type value: str
389         """
390         path = [u"cpu", u"main-core"]
391         self.add_config_item(self._nodeconfig, value, path)
392
393     def add_cpu_corelist_workers(self, value):
394         """Add CPU corelist-workers configuration.
395
396         :param value: Corelist-workers option.
397         :type value: str
398         """
399         path = [u"cpu", u"corelist-workers"]
400         self.add_config_item(self._nodeconfig, value, path)
401
402     def add_main_heap_size(self, value):
403         """Add Main Heap Size configuration.
404
405         :param value: Amount of heap.
406         :type value: str
407         """
408         path = [u"memory", u"main-heap-size"]
409         self.add_config_item(self._nodeconfig, value, path)
410
411     def add_main_heap_page_size(self, value):
412         """Add Main Heap Page Size configuration.
413
414         :param value: Heap page size.
415         :type value: str
416         """
417         path = [u"memory", u"main-heap-page-size"]
418         self.add_config_item(self._nodeconfig, value, path)
419
420     def add_api_trace(self):
421         """Add API trace configuration."""
422         path = [u"api-trace", u"on"]
423         self.add_config_item(self._nodeconfig, u"", path)
424
425     def add_ip6_hash_buckets(self, value):
426         """Add IP6 hash buckets configuration.
427
428         :param value: Number of IP6 hash buckets.
429         :type value: str
430         """
431         path = [u"ip6", u"hash-buckets"]
432         self.add_config_item(self._nodeconfig, value, path)
433
434     def add_ip6_heap_size(self, value):
435         """Add IP6 heap-size configuration.
436
437         :param value: IP6 Heapsize amount.
438         :type value: str
439         """
440         path = [u"ip6", u"heap-size"]
441         self.add_config_item(self._nodeconfig, value, path)
442
443     def add_statseg_size(self, value):
444         """Add Stats Heap Size configuration.
445
446         :param value: Stats heapsize amount.
447         :type value: str
448         """
449         path = [u"statseg", u"size"]
450         self.add_config_item(self._nodeconfig, value, path)
451
452     def add_statseg_page_size(self, value):
453         """Add Stats Heap Page Size configuration.
454
455         :param value: Stats heapsize amount.
456         :type value: str
457         """
458         path = [u"statseg", u"page-size"]
459         self.add_config_item(self._nodeconfig, value, path)
460
461     def add_statseg_per_node_counters(self, value):
462         """Add stats per-node-counters configuration.
463
464         :param value: "on" to switch the counters on.
465         :type value: str
466         """
467         path = [u"statseg", u"per-node-counters"]
468         self.add_config_item(self._nodeconfig, value, path)
469
470     def add_plugin(self, state, *plugins):
471         """Add plugin section for specific plugin(s).
472
473         :param state: State of plugin [enable|disable].
474         :param plugins: Plugin(s) to disable.
475         :type state: str
476         :type plugins: list
477         """
478         for plugin in plugins:
479             path = [u"plugins", f"plugin {plugin}", state]
480             self.add_config_item(self._nodeconfig, u" ", path)
481
482     def add_dpdk_no_multi_seg(self):
483         """Add DPDK no-multi-seg configuration."""
484         path = [u"dpdk", u"no-multi-seg"]
485         self.add_config_item(self._nodeconfig, u"", path)
486
487     def add_dpdk_no_tx_checksum_offload(self):
488         """Add DPDK no-tx-checksum-offload configuration."""
489         path = [u"dpdk", u"no-tx-checksum-offload"]
490         self.add_config_item(self._nodeconfig, u"", path)
491
492     def add_nat(self, value=u"deterministic"):
493         """Add NAT mode configuration.
494
495         :param value: NAT mode.
496         :type value: str
497         """
498         path = [u"nat", value]
499         self.add_config_item(self._nodeconfig, u"", path)
500
501     def add_nat_max_translations_per_thread(self, value):
502         """Add NAT max. translations per thread number configuration.
503
504         :param value: NAT mode.
505         :type value: str
506         """
507         path = [u"nat", u"max translations per thread"]
508         self.add_config_item(self._nodeconfig, value, path)
509
510     def add_nsim_poll_main_thread(self):
511         """Add NSIM poll-main-thread configuration."""
512         path = [u"nsim", u"poll-main-thread"]
513         self.add_config_item(self._nodeconfig, u"", path)
514
515     def add_tcp_congestion_control_algorithm(self, value=u"cubic"):
516         """Add TCP congestion control algorithm.
517
518         :param value: The congestion control algorithm to use. Example: cubic
519         :type value: str
520         """
521         path = [u"tcp", u"cc-algo"]
522         self.add_config_item(self._nodeconfig, value, path)
523
524     def add_tcp_preallocated_connections(self, value):
525         """Add TCP pre-allocated connections.
526
527         :param value: The number of pre-allocated connections.
528         :type value: int
529         """
530         path = [u"tcp", u"preallocated-connections"]
531         self.add_config_item(self._nodeconfig, value, path)
532
533     def add_tcp_preallocated_half_open_connections(self, value):
534         """Add TCP pre-allocated half open connections.
535
536         :param value: The number of pre-allocated half open connections.
537         :type value: int
538         """
539         path = [u"tcp", u"preallocated-half-open-connections"]
540         self.add_config_item(self._nodeconfig, value, path)
541
542     def add_session_enable(self):
543         """Add session enable."""
544         path = [u"session", u"enable"]
545         self.add_config_item(self._nodeconfig, u"", path)
546
547     def add_session_event_queues_memfd_segment(self):
548         """Add session event queue memfd segment."""
549         path = [u"session", u"evt_qs_memfd_seg"]
550         self.add_config_item(self._nodeconfig, u"", path)
551
552     def add_session_event_queue_length(self, value):
553         """Add session event queue length.
554
555         :param value: Session event queue length.
556         :type value: int
557         """
558         path = [u"session", u"event-queue-length"]
559         self.add_config_item(self._nodeconfig, value, path)
560
561     def add_session_event_queues_segment_size(self, value):
562         """Add session event queue length.
563
564         :param value: Session event queue segment size.
565         :type value: str
566         """
567         path = [u"session", u"evt_qs_seg_size"]
568         self.add_config_item(self._nodeconfig, value, path)
569
570     def add_session_preallocated_sessions(self, value):
571         """Add the number of pre-allocated sessions.
572
573         :param value: Number of pre-allocated sessions.
574         :type value: int
575         """
576         path = [u"session", u"preallocated-sessions"]
577         self.add_config_item(self._nodeconfig, value, path)
578
579     def add_session_v4_session_table_buckets(self, value):
580         """Add number of v4 session table buckets to the config.
581
582         :param value: Number of v4 session table buckets.
583         :type value: int
584         """
585         path = [u"session", u"v4-session-table-buckets"]
586         self.add_config_item(self._nodeconfig, value, path)
587
588     def add_session_v4_session_table_memory(self, value):
589         """Add the size of v4 session table memory.
590
591         :param value: Size of v4 session table memory.
592         :type value: str
593         """
594         path = [u"session", u"v4-session-table-memory"]
595         self.add_config_item(self._nodeconfig, value, path)
596
597     def add_session_v4_halfopen_table_buckets(self, value):
598         """Add the number of v4 halfopen table buckets.
599
600         :param value: Number of v4 halfopen table buckets.
601         :type value: int
602         """
603         path = [u"session", u"v4-halfopen-table-buckets"]
604         self.add_config_item(self._nodeconfig, value, path)
605
606     def add_session_v4_halfopen_table_memory(self, value):
607         """Add the size of v4 halfopen table memory.
608
609         :param value: Size of v4 halfopen table memory.
610         :type value: str
611         """
612         path = [u"session", u"v4-halfopen-table-memory"]
613         self.add_config_item(self._nodeconfig, value, path)
614
615     def add_session_local_endpoints_table_buckets(self, value):
616         """Add the number of local endpoints table buckets.
617
618         :param value: Number of local endpoints table buckets.
619         :type value: int
620         """
621         path = [u"session", u"local-endpoints-table-buckets"]
622         self.add_config_item(self._nodeconfig, value, path)
623
624     def add_session_local_endpoints_table_memory(self, value):
625         """Add the size of local endpoints table memory.
626
627         :param value: Size of local endpoints table memory.
628         :type value: str
629         """
630         path = [u"session", u"local-endpoints-table-memory"]
631         self.add_config_item(self._nodeconfig, value, path)
632
633     def write_config(self, filename=None):
634         """Generate and write VPP startup configuration to file.
635
636         Use data from calls to this class to form a startup.conf file and
637         replace /etc/vpp/startup.conf with it on topology node.
638
639         :param filename: Startup configuration file name.
640         :type filename: str
641         """
642         self.dump_config(self._nodeconfig)
643
644         if filename is None:
645             filename = self._vpp_startup_conf
646
647         if self._vpp_startup_conf_backup is not None:
648             cmd = f"cp {self._vpp_startup_conf} {self._vpp_startup_conf_backup}"
649             exec_cmd_no_error(
650                 self._node, cmd, sudo=True, message=u"Copy config file failed!"
651             )
652
653         cmd = f"echo \"{self._vpp_config}\" | sudo tee {filename}"
654         exec_cmd_no_error(
655             self._node, cmd, message=u"Writing config file failed!"
656         )
657
658     def apply_config(self, filename=None, verify_vpp=True):
659         """Generate and write VPP startup configuration to file and restart VPP.
660
661         Use data from calls to this class to form a startup.conf file and
662         replace /etc/vpp/startup.conf with it on topology node.
663
664         :param filename: Startup configuration file name.
665         :param verify_vpp: Verify VPP is running after restart.
666         :type filename: str
667         :type verify_vpp: bool
668         """
669         self.write_config(filename=filename)
670
671         VPPUtil.restart_vpp_service(self._node, self._node_key)
672         if verify_vpp:
673             VPPUtil.verify_vpp(self._node)
674
675     def restore_config(self):
676         """Restore VPP startup.conf from backup."""
677         cmd = f"cp {self._vpp_startup_conf_backup} {self._vpp_startup_conf}"
678         exec_cmd_no_error(
679             self._node, cmd, sudo=True, message=u"Copy config file failed!"
680         )