864de11251f6ddf3eb7834b7781b0619b32fec31
[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   ## run vpp in the interactive mode
10   # interactive
11
12   ## do not use colors in terminal output
13   # nocolor
14
15   ## do not display banner
16   # nobanner
17 }
18
19 api-trace {
20 ## This stanza controls binary API tracing. Unless there is a very strong reason,
21 ## please leave this feature enabled.
22   on
23 ## Additional parameters:
24 ##
25 ## To set the number of binary API trace records in the circular buffer, configure nitems
26 ##
27 ## nitems <nnn>
28 ##
29 ## To save the api message table decode tables, configure a filename. Results in /tmp/<filename>
30 ## Very handy for understanding api message changes between versions, identifying missing
31 ## plugins, and so forth.
32 ##
33 ## save-api-table <filename>
34 }
35
36 api-segment {
37   gid vpp
38 }
39
40 socksvr {
41   default
42 }
43
44 # memory {
45         ## Set the main heap size, default is 1G
46         # main-heap-size 2G
47
48         ## Set the main heap page size. Default page size is OS default page
49         ## which is in most cases 4K. if different page size is specified VPP
50         ## will try to allocate main heap by using specified page size.
51         ## special keyword 'default-hugepage' will use system default hugepage
52         ## size
53         # main-heap-page-size 1G
54 #}
55
56 cpu {
57         ## In the VPP there is one main thread and optionally the user can create worker(s)
58         ## The main thread and worker thread(s) can be pinned to CPU core(s) manually or automatically
59
60         ## Manual pinning of thread(s) to CPU core(s)
61
62         ## Set logical CPU core where main thread runs, if main core is not set
63         ## VPP will use core 1 if available
64         # main-core 1
65
66         ## Set logical CPU core(s) where worker threads are running
67         # corelist-workers 2-3,18-19
68
69         ## Automatic pinning of thread(s) to CPU core(s)
70
71         ## Sets number of CPU core(s) to be skipped (1 ... N-1)
72         ## Skipped CPU core(s) are not used for pinning main thread and working thread(s).
73         ## The main thread is automatically pinned to the first available CPU core and worker(s)
74         ## are pinned to next free CPU core(s) after core assigned to main thread
75         # skip-cores 4
76
77         ## Specify a number of workers to be created
78         ## Workers are pinned to N consecutive CPU cores while skipping "skip-cores" CPU core(s)
79         ## and main thread's CPU core
80         # workers 2
81
82         ## Set scheduling policy and priority of main and worker threads
83
84         ## Scheduling policy options are: other (SCHED_OTHER), batch (SCHED_BATCH)
85         ## idle (SCHED_IDLE), fifo (SCHED_FIFO), rr (SCHED_RR)
86         # scheduler-policy fifo
87
88         ## Scheduling priority is used only for "real-time policies (fifo and rr),
89         ## and has to be in the range of priorities supported for a particular policy
90         # scheduler-priority 50
91 }
92
93 # buffers {
94         ## Increase number of buffers allocated, needed only in scenarios with
95         ## large number of interfaces and worker threads. Value is per numa node.
96         ## Default is 16384 (8192 if running unpriviledged)
97         # buffers-per-numa 128000
98
99         ## Size of buffer data area
100         ## Default is 2048
101         # default data-size 2048
102 # }
103
104 # dpdk {
105         ## Change default settings for all interfaces
106         # dev default {
107                 ## Number of receive queues, enables RSS
108                 ## Default is 1
109                 # num-rx-queues 3
110
111                 ## Number of transmit queues, Default is equal
112                 ## to number of worker threads or 1 if no workers treads
113                 # num-tx-queues 3
114
115                 ## Number of descriptors in transmit and receive rings
116                 ## increasing or reducing number can impact performance
117                 ## Default is 1024 for both rx and tx
118                 # num-rx-desc 512
119                 # num-tx-desc 512
120
121                 ## VLAN strip offload mode for interface
122                 ## Default is off
123                 # vlan-strip-offload on
124
125                 ## TCP Segment Offload
126                 ## Default is off
127                 ## To enable TSO, 'enable-tcp-udp-checksum' must be set
128                 # tso on
129
130                 ## Devargs
131                 ## device specific init args
132                 ## Default is NULL
133                 # devargs safe-mode-support=1,pipeline-mode-support=1
134
135                 ## rss-queues
136                 ## set valid rss steering queues
137                 # rss-queues 0,2,5-7
138         # }
139
140         ## Whitelist specific interface by specifying PCI address
141         # dev 0000:02:00.0
142
143         ## Blacklist specific device type by specifying PCI vendor:device
144         ## Whitelist entries take precedence
145         # blacklist 8086:10fb
146
147         ## Set interface name
148         # dev 0000:02:00.1 {
149         #       name eth0
150         # }
151
152         ## Whitelist specific interface by specifying PCI address and in
153         ## addition specify custom parameters for this interface
154         # dev 0000:02:00.1 {
155         #       num-rx-queues 2
156         # }
157
158         ## Change UIO driver used by VPP, Options are: igb_uio, vfio-pci,
159         ## uio_pci_generic or auto (default)
160         # uio-driver vfio-pci
161
162         ## Disable multi-segment buffers, improves performance but
163         ## disables Jumbo MTU support
164         # no-multi-seg
165
166         ## Change hugepages allocation per-socket, needed only if there is need for
167         ## larger number of mbufs. Default is 256M on each detected CPU socket
168         # socket-mem 2048,2048
169
170         ## Disables UDP / TCP TX checksum offload. Typically needed for use
171         ## faster vector PMDs (together with no-multi-seg)
172         # no-tx-checksum-offload
173
174         ## Enable UDP / TCP TX checksum offload
175         ## This is the reversed option of 'no-tx-checksum-offload'
176         # enable-tcp-udp-checksum
177 # }
178
179 ## node variant defaults
180 #node {
181
182 ## specify the preferred default variant
183 #       default { variant avx512 }
184
185 ## specify the preferred variant, for a given node
186 #       ip4-rewrite { variant avx2 }
187
188 #}
189
190
191 # plugins {
192         ## Adjusting the plugin path depending on where the VPP plugins are
193         #       path /ws/vpp/build-root/install-vpp-native/vpp/lib/vpp_plugins
194
195         ## Disable all plugins by default and then selectively enable specific plugins
196         # plugin default { disable }
197         # plugin dpdk_plugin.so { enable }
198         # plugin acl_plugin.so { enable }
199
200         ## Enable all plugins by default and then selectively disable specific plugins
201         # plugin dpdk_plugin.so { disable }
202         # plugin acl_plugin.so { disable }
203 # }
204
205 ## Statistics Segment
206 # statseg {
207     # socket-name <filename>, name of the stats segment socket
208     #     defaults to /run/vpp/stats.sock
209     # size <nnn>[KMG], size of the stats segment, defaults to 32mb
210     # page-size <nnn>, page size, ie. 2m, defaults to 4k
211     # per-node-counters on | off, defaults to none
212     # update-interval <f64-seconds>, sets the segment scrape / update interval
213 # }
214
215 ## L2 FIB
216 # l2fib {
217     ## l2fib hash table size.
218     #  table-size 512M
219
220     ## l2fib hash table number of buckets. Must be power of 2.
221     #  num-buckets 524288
222 # }
223
224 ## ipsec
225 # {
226    # ip4 {
227    ## ipsec for ipv4 tunnel lookup hash number of buckets.
228    #  num-buckets 524288
229    # }
230    # ip6 {
231    ## ipsec for ipv6 tunnel lookup hash number of buckets.
232    #  num-buckets 524288
233    # }
234 # }
235
236 # logging {
237    ## set default logging level for logging buffer
238    ## logging levels: emerg, alert,crit, error, warn, notice, info, debug, disabled
239    # default-log-level debug
240    ## set default logging level for syslog or stderr output
241    # default-syslog-log-level info
242    ## Set per-class configuration
243    # class dpdk/cryptodev { rate-limit 100 level debug syslog-level error }
244 # }