Blame view

Documentation/cputopology.txt 5.61 KB
e8cb6f1ed   Mauro Carvalho Chehab   cputopology.txt: ...
1
2
3
  ===========================================
  How CPU topology info is exported via sysfs
  ===========================================
69dcc9919   Zhang, Yanmin   [PATCH] Export cp...
4

663fb2fc7   Alex Chiang   Documentation: AB...
5
  Export CPU topology info via sysfs. Items (attributes) are similar
54a536948   Bartosz Golaszewski   Documentation: Up...
6
  to /proc/cpuinfo output of some architectures:
69dcc9919   Zhang, Yanmin   [PATCH] Export cp...
7
8
  
  1) /sys/devices/system/cpu/cpuX/topology/physical_package_id:
663fb2fc7   Alex Chiang   Documentation: AB...
9
10
11
12
  
  	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...
13
  2) /sys/devices/system/cpu/cpuX/topology/core_id:
663fb2fc7   Alex Chiang   Documentation: AB...
14
15
16
17
  
  	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...
18
19
20
21
22
  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.
a62247e1f   Heiko Carstens   topology/sysfs: p...
23
24
25
26
27
28
29
  4) /sys/devices/system/cpu/cpuX/topology/drawer_id:
  
  	the drawer ID of cpuX. Typically it is the hardware platform's
  	identifier (rather than the kernel's).	The actual value is
  	architecture and platform dependent.
  
  5) /sys/devices/system/cpu/cpuX/topology/thread_siblings:
663fb2fc7   Alex Chiang   Documentation: AB...
30

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

a62247e1f   Heiko Carstens   topology/sysfs: p...
34
  6) /sys/devices/system/cpu/cpuX/topology/thread_siblings_list:
54a536948   Bartosz Golaszewski   Documentation: Up...
35
36
37
  
  	human-readable list of cpuX's hardware threads within the same
  	core as cpuX.
a62247e1f   Heiko Carstens   topology/sysfs: p...
38
  7) /sys/devices/system/cpu/cpuX/topology/core_siblings:
663fb2fc7   Alex Chiang   Documentation: AB...
39
40
41
  
  	internal kernel map of cpuX's hardware threads within the same
  	physical_package_id.
69dcc9919   Zhang, Yanmin   [PATCH] Export cp...
42

a62247e1f   Heiko Carstens   topology/sysfs: p...
43
  8) /sys/devices/system/cpu/cpuX/topology/core_siblings_list:
54a536948   Bartosz Golaszewski   Documentation: Up...
44
45
46
  
  	human-readable list of cpuX's hardware threads within the same
  	physical_package_id.
a62247e1f   Heiko Carstens   topology/sysfs: p...
47
  9) /sys/devices/system/cpu/cpuX/topology/book_siblings:
b40d8ed4e   Heiko Carstens   topology/sysfs: P...
48
49
50
  
  	internal kernel map of cpuX's hardware threads within the same
  	book_id.
a62247e1f   Heiko Carstens   topology/sysfs: p...
51
  10) /sys/devices/system/cpu/cpuX/topology/book_siblings_list:
54a536948   Bartosz Golaszewski   Documentation: Up...
52
53
54
  
  	human-readable list of cpuX's hardware threads within the same
  	book_id.
a62247e1f   Heiko Carstens   topology/sysfs: p...
55
56
57
58
59
60
61
62
63
  11) /sys/devices/system/cpu/cpuX/topology/drawer_siblings:
  
  	internal kernel map of cpuX's hardware threads within the same
  	drawer_id.
  
  12) /sys/devices/system/cpu/cpuX/topology/drawer_siblings_list:
  
  	human-readable list of cpuX's hardware threads within the same
  	drawer_id.
69dcc9919   Zhang, Yanmin   [PATCH] Export cp...
64
  To implement it in an architecture-neutral way, a new source file,
a62247e1f   Heiko Carstens   topology/sysfs: p...
65
66
67
68
69
70
  drivers/base/topology.c, is to export the 6 to 12 attributes. The book
  and drawer related sysfs files will only be created if CONFIG_SCHED_BOOK
  and CONFIG_SCHED_DRAWER are selected.
  
  CONFIG_SCHED_BOOK and CONFIG_DRAWER are currently only used on s390, where
  they reflect the cpu and cache hierarchy.
69dcc9919   Zhang, Yanmin   [PATCH] Export cp...
71

c50cbb05a   Ben Hutchings   cpu topology: alw...
72
  For an architecture to support this feature, it must define some of
e8cb6f1ed   Mauro Carvalho Chehab   cputopology.txt: ...
73
74
75
76
77
78
79
80
81
82
83
84
85
86
  these macros in include/asm-XXX/topology.h::
  
  	#define topology_physical_package_id(cpu)
  	#define topology_core_id(cpu)
  	#define topology_book_id(cpu)
  	#define topology_drawer_id(cpu)
  	#define topology_sibling_cpumask(cpu)
  	#define topology_core_cpumask(cpu)
  	#define topology_book_cpumask(cpu)
  	#define topology_drawer_cpumask(cpu)
  
  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
54a536948   Bartosz Golaszewski   Documentation: Up...
87
  topology_sibling_cpumask() which corresponds with thread_siblings).
69dcc9919   Zhang, Yanmin   [PATCH] Export cp...
88

c50cbb05a   Ben Hutchings   cpu topology: alw...
89
90
91
  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:
e8cb6f1ed   Mauro Carvalho Chehab   cputopology.txt: ...
92

c50cbb05a   Ben Hutchings   cpu topology: alw...
93
94
  1) physical_package_id: -1
  2) core_id: 0
54a536948   Bartosz Golaszewski   Documentation: Up...
95
96
  3) sibling_cpumask: just the given CPU
  4) core_cpumask: just the given CPU
d62720ade   Mike Travis   sysfs: add docume...
97

b40d8ed4e   Heiko Carstens   topology/sysfs: P...
98
99
  For architectures that don't support books (CONFIG_SCHED_BOOK) there are no
  default definitions for topology_book_id() and topology_book_cpumask().
9bb0e9cb0   Stan Drozd   docs: Fix a coupl...
100
  For architectures that don't support drawers (CONFIG_SCHED_DRAWER) there are
a62247e1f   Heiko Carstens   topology/sysfs: p...
101
  no default definitions for topology_drawer_id() and topology_drawer_cpumask().
b40d8ed4e   Heiko Carstens   topology/sysfs: P...
102

663fb2fc7   Alex Chiang   Documentation: AB...
103
  Additionally, CPU topology information is provided under
d62720ade   Mike Travis   sysfs: add docume...
104
105
  /sys/devices/system/cpu and includes these files.  The internal
  source for the output is in brackets ("[]").
e8cb6f1ed   Mauro Carvalho Chehab   cputopology.txt: ...
106
      =========== ==========================================================
663fb2fc7   Alex Chiang   Documentation: AB...
107
      kernel_max: the maximum CPU index allowed by the kernel configuration.
d62720ade   Mike Travis   sysfs: add docume...
108
  		[NR_CPUS-1]
663fb2fc7   Alex Chiang   Documentation: AB...
109
      offline:	CPUs that are not online because they have been
d62720ade   Mike Travis   sysfs: add docume...
110
  		HOTPLUGGED off (see cpu-hotplug.txt) or exceed the limit
663fb2fc7   Alex Chiang   Documentation: AB...
111
  		of CPUs allowed by the kernel configuration (kernel_max
d62720ade   Mike Travis   sysfs: add docume...
112
  		above). [~cpu_online_mask + cpus >= NR_CPUS]
663fb2fc7   Alex Chiang   Documentation: AB...
113
      online:	CPUs that are online and being scheduled [cpu_online_mask]
d62720ade   Mike Travis   sysfs: add docume...
114

663fb2fc7   Alex Chiang   Documentation: AB...
115
      possible:	CPUs that have been allocated resources and can be
d62720ade   Mike Travis   sysfs: add docume...
116
  		brought online if they are present. [cpu_possible_mask]
663fb2fc7   Alex Chiang   Documentation: AB...
117
      present:	CPUs that have been identified as being present in the
d62720ade   Mike Travis   sysfs: add docume...
118
  		system. [cpu_present_mask]
e8cb6f1ed   Mauro Carvalho Chehab   cputopology.txt: ...
119
      =========== ==========================================================
d62720ade   Mike Travis   sysfs: add docume...
120
121
122
  
  The format for the above output is compatible with cpulist_parse()
  [see <linux/cpumask.h>].  Some examples follow.
663fb2fc7   Alex Chiang   Documentation: AB...
123
  In this example, there are 64 CPUs in the system but cpus 32-63 exceed
d62720ade   Mike Travis   sysfs: add docume...
124
  the kernel max which is limited to 0..31 by the NR_CPUS config option
663fb2fc7   Alex Chiang   Documentation: AB...
125
  being 32.  Note also that CPUs 2 and 4-31 are not online but could be
e8cb6f1ed   Mauro Carvalho Chehab   cputopology.txt: ...
126
  brought online as they are both present and possible::
d62720ade   Mike Travis   sysfs: add docume...
127
128
129
130
131
132
133
134
  
       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...
135
136
  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
e8cb6f1ed   Mauro Carvalho Chehab   cputopology.txt: ...
137
  online.)::
d62720ade   Mike Travis   sysfs: add docume...
138
139
140
141
142
143
144
145
  
       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...
146
  as well as more information on the various cpumasks.