Add microarch details to 'show cpu'.
[vpp.git] / docs / gettingstarted / users / configutil / sysinfo.rst
1 .. _sysinfo:
2
3 CPU
4 ---
5
6 The CPU section of the system information is a summary of the CPU characteristics of the system.
7 It is important to understand the CPU topology and frequency in order to understand what the VPP
8 performance characteristics would be. 
9
10 Threads
11 -------
12
13 It usually is not needed, but VPP can be configured to run on isolated CPUs. In the example shown
14 VPP is configured with 2 workers. The main thread is also configured to run on a seperate CPU. The
15 stats thread will always run on CPU 0. This utilty will put the worker threads on CPUs that are
16 associated with the ports that are configured.
17
18 Grub Command Line
19 -----------------
20
21 In general the Grub command line does not need to be changed. If the system is running many processes
22 it may be neccessary to isolate CPUs for VPP or other processes.
23
24 Huge Pages
25 ----------
26
27 As default when VPP is configured the number of huge pages that will be configured will be 1024.
28 This may not be enough. This section will show the total system memory and how many are configured.
29
30
31 Devices
32 -------
33
34 In the devices section we have the "Total Number of Buffers". This utility allocates the correct
35 number of buffers. The number of buffers are calculated from the number of rx queues.
36
37 VPP will not use links that are up. Those devices are shown with this utility.
38
39 The devices bound to the kernel are not being used by VPP, but can be.
40
41 The devices that are being used by VPP are shown with the interface name be used with VPP. The
42 socket being used by the VPP port is also shown. Notice in this example the worker thread are
43 on the correct CPU. The number of RX, TX Descriptors and TX queues are calculated from the number
44 of RX queues.
45
46
47 VPP Service Status
48 ------------------
49
50 The VPP service status, will be installed, not installed, running or not.