Blame view

Documentation/cputopology.txt 4.46 KB
69dcc9919   Zhang, Yanmin   [PATCH] Export cp...
1

663fb2fc7   Alex Chiang   Documentation: AB...
2
  Export CPU topology info via sysfs. Items (attributes) are similar
54a536948   Bartosz Golaszewski   Documentation: Up...
3
  to /proc/cpuinfo output of some architectures:
69dcc9919   Zhang, Yanmin   [PATCH] Export cp...
4
5
  
  1) /sys/devices/system/cpu/cpuX/topology/physical_package_id:
663fb2fc7   Alex Chiang   Documentation: AB...
6
7
8
9
  
  	physical package id of cpuX. Typically corresponds to a physical
  	socket number, but the actual value is architecture and platform
  	dependent.
69dcc9919   Zhang, Yanmin   [PATCH] Export cp...
10
  2) /sys/devices/system/cpu/cpuX/topology/core_id:
663fb2fc7   Alex Chiang   Documentation: AB...
11
12
13
14
  
  	the CPU core ID of cpuX. Typically it is the hardware platform's
  	identifier (rather than the kernel's).  The actual value is
  	architecture and platform dependent.
b40d8ed4e   Heiko Carstens   topology/sysfs: P...
15
16
17
18
19
20
21
  3) /sys/devices/system/cpu/cpuX/topology/book_id:
  
  	the book ID of cpuX. Typically it is the hardware platform's
  	identifier (rather than the kernel's).	The actual value is
  	architecture and platform dependent.
  
  4) /sys/devices/system/cpu/cpuX/topology/thread_siblings:
663fb2fc7   Alex Chiang   Documentation: AB...
22

f8ea61e63   Xishi Qiu   doc: Documentatio...
23
  	internal kernel map of cpuX's hardware threads within the same
54a536948   Bartosz Golaszewski   Documentation: Up...
24
  	core as cpuX.
663fb2fc7   Alex Chiang   Documentation: AB...
25

54a536948   Bartosz Golaszewski   Documentation: Up...
26
27
28
29
30
31
  5) /sys/devices/system/cpu/cpuX/topology/thread_siblings_list:
  
  	human-readable list of cpuX's hardware threads within the same
  	core as cpuX.
  
  6) /sys/devices/system/cpu/cpuX/topology/core_siblings:
663fb2fc7   Alex Chiang   Documentation: AB...
32
33
34
  
  	internal kernel map of cpuX's hardware threads within the same
  	physical_package_id.
69dcc9919   Zhang, Yanmin   [PATCH] Export cp...
35

54a536948   Bartosz Golaszewski   Documentation: Up...
36
37
38
39
40
41
  7) /sys/devices/system/cpu/cpuX/topology/core_siblings_list:
  
  	human-readable list of cpuX's hardware threads within the same
  	physical_package_id.
  
  8) /sys/devices/system/cpu/cpuX/topology/book_siblings:
b40d8ed4e   Heiko Carstens   topology/sysfs: P...
42
43
44
  
  	internal kernel map of cpuX's hardware threads within the same
  	book_id.
54a536948   Bartosz Golaszewski   Documentation: Up...
45
46
47
48
  9) /sys/devices/system/cpu/cpuX/topology/book_siblings_list:
  
  	human-readable list of cpuX's hardware threads within the same
  	book_id.
69dcc9919   Zhang, Yanmin   [PATCH] Export cp...
49
  To implement it in an architecture-neutral way, a new source file,
54a536948   Bartosz Golaszewski   Documentation: Up...
50
  drivers/base/topology.c, is to export the 6 or 9 attributes. The three book
b40d8ed4e   Heiko Carstens   topology/sysfs: P...
51
  related sysfs files will only be created if CONFIG_SCHED_BOOK is selected.
69dcc9919   Zhang, Yanmin   [PATCH] Export cp...
52

c50cbb05a   Ben Hutchings   cpu topology: alw...
53
54
  For an architecture to support this feature, it must define some of
  these macros in include/asm-XXX/topology.h:
69dcc9919   Zhang, Yanmin   [PATCH] Export cp...
55
56
  #define topology_physical_package_id(cpu)
  #define topology_core_id(cpu)
b40d8ed4e   Heiko Carstens   topology/sysfs: P...
57
  #define topology_book_id(cpu)
06931e622   Bartosz Golaszewski   sched/topology: R...
58
  #define topology_sibling_cpumask(cpu)
fbd59a8d1   Rusty Russell   cpumask: Use topo...
59
  #define topology_core_cpumask(cpu)
b40d8ed4e   Heiko Carstens   topology/sysfs: P...
60
  #define topology_book_cpumask(cpu)
69dcc9919   Zhang, Yanmin   [PATCH] Export cp...
61

54a536948   Bartosz Golaszewski   Documentation: Up...
62
63
64
65
  The type of **_id macros is int.
  The type of **_cpumask macros is (const) struct cpumask *. The latter
  correspond with appropriate **_siblings sysfs attributes (except for
  topology_sibling_cpumask() which corresponds with thread_siblings).
69dcc9919   Zhang, Yanmin   [PATCH] Export cp...
66

c50cbb05a   Ben Hutchings   cpu topology: alw...
67
68
69
70
71
  To be consistent on all architectures, include/linux/topology.h
  provides default definitions for any of the above macros that are
  not defined by include/asm-XXX/topology.h:
  1) physical_package_id: -1
  2) core_id: 0
54a536948   Bartosz Golaszewski   Documentation: Up...
72
73
  3) sibling_cpumask: just the given CPU
  4) core_cpumask: just the given CPU
d62720ade   Mike Travis   sysfs: add docume...
74

b40d8ed4e   Heiko Carstens   topology/sysfs: P...
75
76
  For architectures that don't support books (CONFIG_SCHED_BOOK) there are no
  default definitions for topology_book_id() and topology_book_cpumask().
663fb2fc7   Alex Chiang   Documentation: AB...
77
  Additionally, CPU topology information is provided under
d62720ade   Mike Travis   sysfs: add docume...
78
79
  /sys/devices/system/cpu and includes these files.  The internal
  source for the output is in brackets ("[]").
663fb2fc7   Alex Chiang   Documentation: AB...
80
      kernel_max: the maximum CPU index allowed by the kernel configuration.
d62720ade   Mike Travis   sysfs: add docume...
81
  		[NR_CPUS-1]
663fb2fc7   Alex Chiang   Documentation: AB...
82
      offline:	CPUs that are not online because they have been
d62720ade   Mike Travis   sysfs: add docume...
83
  		HOTPLUGGED off (see cpu-hotplug.txt) or exceed the limit
663fb2fc7   Alex Chiang   Documentation: AB...
84
  		of CPUs allowed by the kernel configuration (kernel_max
d62720ade   Mike Travis   sysfs: add docume...
85
  		above). [~cpu_online_mask + cpus >= NR_CPUS]
663fb2fc7   Alex Chiang   Documentation: AB...
86
      online:	CPUs that are online and being scheduled [cpu_online_mask]
d62720ade   Mike Travis   sysfs: add docume...
87

663fb2fc7   Alex Chiang   Documentation: AB...
88
      possible:	CPUs that have been allocated resources and can be
d62720ade   Mike Travis   sysfs: add docume...
89
  		brought online if they are present. [cpu_possible_mask]
663fb2fc7   Alex Chiang   Documentation: AB...
90
      present:	CPUs that have been identified as being present in the
d62720ade   Mike Travis   sysfs: add docume...
91
92
93
94
  		system. [cpu_present_mask]
  
  The format for the above output is compatible with cpulist_parse()
  [see <linux/cpumask.h>].  Some examples follow.
663fb2fc7   Alex Chiang   Documentation: AB...
95
  In this example, there are 64 CPUs in the system but cpus 32-63 exceed
d62720ade   Mike Travis   sysfs: add docume...
96
  the kernel max which is limited to 0..31 by the NR_CPUS config option
663fb2fc7   Alex Chiang   Documentation: AB...
97
  being 32.  Note also that CPUs 2 and 4-31 are not online but could be
d62720ade   Mike Travis   sysfs: add docume...
98
99
100
101
102
103
104
105
106
  brought online as they are both present and possible.
  
       kernel_max: 31
          offline: 2,4-31,32-63
           online: 0-1,3
         possible: 0-31
          present: 0-31
  
  In this example, the NR_CPUS config option is 128, but the kernel was
663fb2fc7   Alex Chiang   Documentation: AB...
107
108
  started with possible_cpus=144.  There are 4 CPUs in the system and cpu2
  was manually taken offline (and is the only CPU that can be brought
d62720ade   Mike Travis   sysfs: add docume...
109
110
111
112
113
114
115
116
117
  online.)
  
       kernel_max: 127
          offline: 2,4-127,128-143
           online: 0-1,3
         possible: 0-127
          present: 0-3
  
  See cpu-hotplug.txt for the possible_cpus=NUM kernel start parameter
663fb2fc7   Alex Chiang   Documentation: AB...
118
  as well as more information on the various cpumasks.