Blame view

Documentation/cputopology.txt 5.3 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
  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...
20
21
22
23
24
25
26
  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...
27

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

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

a62247e1f   Heiko Carstens   topology/sysfs: p...
40
  8) /sys/devices/system/cpu/cpuX/topology/core_siblings_list:
54a536948   Bartosz Golaszewski   Documentation: Up...
41
42
43
  
  	human-readable list of cpuX's hardware threads within the same
  	physical_package_id.
a62247e1f   Heiko Carstens   topology/sysfs: p...
44
  9) /sys/devices/system/cpu/cpuX/topology/book_siblings:
b40d8ed4e   Heiko Carstens   topology/sysfs: P...
45
46
47
  
  	internal kernel map of cpuX's hardware threads within the same
  	book_id.
a62247e1f   Heiko Carstens   topology/sysfs: p...
48
  10) /sys/devices/system/cpu/cpuX/topology/book_siblings_list:
54a536948   Bartosz Golaszewski   Documentation: Up...
49
50
51
  
  	human-readable list of cpuX's hardware threads within the same
  	book_id.
a62247e1f   Heiko Carstens   topology/sysfs: p...
52
53
54
55
56
57
58
59
60
  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...
61
  To implement it in an architecture-neutral way, a new source file,
a62247e1f   Heiko Carstens   topology/sysfs: p...
62
63
64
65
66
67
  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...
68

c50cbb05a   Ben Hutchings   cpu topology: alw...
69
70
  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...
71
72
  #define topology_physical_package_id(cpu)
  #define topology_core_id(cpu)
b40d8ed4e   Heiko Carstens   topology/sysfs: P...
73
  #define topology_book_id(cpu)
a62247e1f   Heiko Carstens   topology/sysfs: p...
74
  #define topology_drawer_id(cpu)
06931e622   Bartosz Golaszewski   sched/topology: R...
75
  #define topology_sibling_cpumask(cpu)
fbd59a8d1   Rusty Russell   cpumask: Use topo...
76
  #define topology_core_cpumask(cpu)
b40d8ed4e   Heiko Carstens   topology/sysfs: P...
77
  #define topology_book_cpumask(cpu)
a62247e1f   Heiko Carstens   topology/sysfs: p...
78
  #define topology_drawer_cpumask(cpu)
69dcc9919   Zhang, Yanmin   [PATCH] Export cp...
79

54a536948   Bartosz Golaszewski   Documentation: Up...
80
81
82
83
  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...
84

c50cbb05a   Ben Hutchings   cpu topology: alw...
85
86
87
88
89
  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...
90
91
  3) sibling_cpumask: just the given CPU
  4) core_cpumask: just the given CPU
d62720ade   Mike Travis   sysfs: add docume...
92

b40d8ed4e   Heiko Carstens   topology/sysfs: P...
93
94
  For architectures that don't support books (CONFIG_SCHED_BOOK) there are no
  default definitions for topology_book_id() and topology_book_cpumask().
a62247e1f   Heiko Carstens   topology/sysfs: p...
95
96
  For architectures that don't support drawes (CONFIG_SCHED_DRAWER) there are
  no default definitions for topology_drawer_id() and topology_drawer_cpumask().
b40d8ed4e   Heiko Carstens   topology/sysfs: P...
97

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

663fb2fc7   Alex Chiang   Documentation: AB...
109
      possible:	CPUs that have been allocated resources and can be
d62720ade   Mike Travis   sysfs: add docume...
110
  		brought online if they are present. [cpu_possible_mask]
663fb2fc7   Alex Chiang   Documentation: AB...
111
      present:	CPUs that have been identified as being present in the
d62720ade   Mike Travis   sysfs: add docume...
112
113
114
115
  		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...
116
  In this example, there are 64 CPUs in the system but cpus 32-63 exceed
d62720ade   Mike Travis   sysfs: add docume...
117
  the kernel max which is limited to 0..31 by the NR_CPUS config option
663fb2fc7   Alex Chiang   Documentation: AB...
118
  being 32.  Note also that CPUs 2 and 4-31 are not online but could be
d62720ade   Mike Travis   sysfs: add docume...
119
120
121
122
123
124
125
126
127
  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...
128
129
  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...
130
131
132
133
134
135
136
137
138
  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...
139
  as well as more information on the various cpumasks.