Trivial: Cleanup some typos.
[vpp.git] / src / vpp / conf / startup.conf
1
2 unix {
3   nodaemon
4   log /var/log/vpp/vpp.log
5   full-coredump
6   cli-listen /run/vpp/cli.sock
7   gid vpp
8 }
9
10 api-trace {
11 ## This stanza controls binary API tracing. Unless there is a very strong reason,
12 ## please leave this feature enabled.
13   on
14 ## Additional parameters:
15 ##
16 ## To set the number of binary API trace records in the circular buffer, configure nitems
17 ##
18 ## nitems <nnn>
19 ##
20 ## To save the api message table decode tables, configure a filename. Results in /tmp/<filename>
21 ## Very handy for understanding api message changes between versions, identifying missing
22 ## plugins, and so forth.
23 ##
24 ## save-api-table <filename>
25 }
26
27 api-segment {
28   gid vpp
29 }
30
31 socksvr {
32   default
33 }
34
35 cpu {
36         ## In the VPP there is one main thread and optionally the user can create worker(s)
37         ## The main thread and worker thread(s) can be pinned to CPU core(s) manually or automatically
38
39         ## Manual pinning of thread(s) to CPU core(s)
40
41         ## Set logical CPU core where main thread runs, if main core is not set
42         ## VPP will use core 1 if available
43         # main-core 1
44
45         ## Set logical CPU core(s) where worker threads are running
46         # corelist-workers 2-3,18-19
47
48         ## Automatic pinning of thread(s) to CPU core(s)
49
50         ## Sets number of CPU core(s) to be skipped (1 ... N-1)
51         ## Skipped CPU core(s) are not used for pinning main thread and working thread(s).
52         ## The main thread is automatically pinned to the first available CPU core and worker(s)
53         ## are pinned to next free CPU core(s) after core assigned to main thread
54         # skip-cores 4
55
56         ## Specify a number of workers to be created
57         ## Workers are pinned to N consecutive CPU cores while skipping "skip-cores" CPU core(s)
58         ## and main thread's CPU core
59         # workers 2
60
61         ## Set scheduling policy and priority of main and worker threads
62
63         ## Scheduling policy options are: other (SCHED_OTHER), batch (SCHED_BATCH)
64         ## idle (SCHED_IDLE), fifo (SCHED_FIFO), rr (SCHED_RR)
65         # scheduler-policy fifo
66
67         ## Scheduling priority is used only for "real-time policies (fifo and rr),
68         ## and has to be in the range of priorities supported for a particular policy
69         # scheduler-priority 50
70 }
71
72 # dpdk {
73         ## Change default settings for all interfaces
74         # dev default {
75                 ## Number of receive queues, enables RSS
76                 ## Default is 1
77                 # num-rx-queues 3
78
79                 ## Number of transmit queues, Default is equal
80                 ## to number of worker threads or 1 if no workers treads
81                 # num-tx-queues 3
82
83                 ## Number of descriptors in transmit and receive rings
84                 ## increasing or reducing number can impact performance
85                 ## Default is 1024 for both rx and tx
86                 # num-rx-desc 512
87                 # num-tx-desc 512
88
89                 ## VLAN strip offload mode for interface
90                 ## Default is off
91                 # vlan-strip-offload on
92         # }
93
94         ## Whitelist specific interface by specifying PCI address
95         # dev 0000:02:00.0
96
97         ## Whitelist specific interface by specifying PCI address and in
98         ## addition specify custom parameters for this interface
99         # dev 0000:02:00.1 {
100         #       num-rx-queues 2
101         # }
102
103         ## Specify bonded interface and its slaves via PCI addresses
104         ##
105         ## Bonded interface in XOR load balance mode (mode 2) with L3 and L4 headers
106         # vdev eth_bond0,mode=2,slave=0000:02:00.0,slave=0000:03:00.0,xmit_policy=l34
107         # vdev eth_bond1,mode=2,slave=0000:02:00.1,slave=0000:03:00.1,xmit_policy=l34
108         ##
109         ## Bonded interface in Active-Back up mode (mode 1)
110         # vdev eth_bond0,mode=1,slave=0000:02:00.0,slave=0000:03:00.0
111         # vdev eth_bond1,mode=1,slave=0000:02:00.1,slave=0000:03:00.1
112
113         ## Change UIO driver used by VPP, Options are: igb_uio, vfio-pci,
114         ## uio_pci_generic or auto (default)
115         # uio-driver vfio-pci
116
117         ## Disable multi-segment buffers, improves performance but
118         ## disables Jumbo MTU support
119         # no-multi-seg
120
121         ## Increase number of buffers allocated, needed only in scenarios with
122         ## large number of interfaces and worker threads. Value is per CPU socket.
123         ## Default is 16384
124         # num-mbufs 128000
125
126         ## Change hugepages allocation per-socket, needed only if there is need for
127         ## larger number of mbufs. Default is 256M on each detected CPU socket
128         # socket-mem 2048,2048
129
130         ## Disables UDP / TCP TX checksum offload. Typically needed for use
131         ## faster vector PMDs (together with no-multi-seg)
132         # no-tx-checksum-offload
133 # }
134
135
136 # plugins {
137         ## Adjusting the plugin path depending on where the VPP plugins are
138         #       path /home/bms/vpp/build-root/install-vpp-native/vpp/lib/vpp_plugins
139
140         ## Disable all plugins by default and then selectively enable specific plugins
141         # plugin default { disable }
142         # plugin dpdk_plugin.so { enable }
143         # plugin acl_plugin.so { enable }
144
145         ## Enable all plugins by default and then selectively disable specific plugins
146         # plugin dpdk_plugin.so { disable }
147         # plugin acl_plugin.so { disable }
148 # }
149
150         ## Alternate syntax to choose plugin path
151         # plugin_path /home/bms/vpp/build-root/install-vpp-native/vpp/lib/vpp_plugins