cputopology.txt 3.84 KB
Newer Older
1

2
Export CPU topology info via sysfs. Items (attributes) are similar
3 4 5
to /proc/cpuinfo.

1) /sys/devices/system/cpu/cpuX/topology/physical_package_id:
6 7 8 9 10

	physical package id of cpuX. Typically corresponds to a physical
	socket number, but the actual value is architecture and platform
	dependent.

11
2) /sys/devices/system/cpu/cpuX/topology/core_id:
12 13 14 15 16

	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.

17 18 19 20 21 22 23
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:
24 25 26 27

	internel kernel map of cpuX's hardware threads within the same
	core as cpuX

28
5) /sys/devices/system/cpu/cpuX/topology/core_siblings:
29 30 31

	internal kernel map of cpuX's hardware threads within the same
	physical_package_id.
32

33 34 35 36 37
6) /sys/devices/system/cpu/cpuX/topology/book_siblings:

	internal kernel map of cpuX's hardware threads within the same
	book_id.

38
To implement it in an architecture-neutral way, a new source file,
39 40
drivers/base/topology.c, is to export the 4 or 6 attributes. The two book
related sysfs files will only be created if CONFIG_SCHED_BOOK is selected.
41

42 43
For an architecture to support this feature, it must define some of
these macros in include/asm-XXX/topology.h:
44 45
#define topology_physical_package_id(cpu)
#define topology_core_id(cpu)
46
#define topology_book_id(cpu)
47 48
#define topology_thread_cpumask(cpu)
#define topology_core_cpumask(cpu)
49
#define topology_book_cpumask(cpu)
50 51

The type of **_id is int.
52
The type of siblings is (const) struct cpumask *.
53

54 55 56 57 58 59 60
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
3) thread_siblings: just the given CPU
4) core_siblings: just the given CPU
61

62 63 64
For architectures that don't support books (CONFIG_SCHED_BOOK) there are no
default definitions for topology_book_id() and topology_book_cpumask().

65
Additionally, CPU topology information is provided under
66 67 68
/sys/devices/system/cpu and includes these files.  The internal
source for the output is in brackets ("[]").

69
    kernel_max: the maximum CPU index allowed by the kernel configuration.
70 71
		[NR_CPUS-1]

72
    offline:	CPUs that are not online because they have been
73
		HOTPLUGGED off (see cpu-hotplug.txt) or exceed the limit
74
		of CPUs allowed by the kernel configuration (kernel_max
75 76
		above). [~cpu_online_mask + cpus >= NR_CPUS]

77
    online:	CPUs that are online and being scheduled [cpu_online_mask]
78

79
    possible:	CPUs that have been allocated resources and can be
80 81
		brought online if they are present. [cpu_possible_mask]

82
    present:	CPUs that have been identified as being present in the
83 84 85 86 87
		system. [cpu_present_mask]

The format for the above output is compatible with cpulist_parse()
[see <linux/cpumask.h>].  Some examples follow.

88
In this example, there are 64 CPUs in the system but cpus 32-63 exceed
89
the kernel max which is limited to 0..31 by the NR_CPUS config option
90
being 32.  Note also that CPUs 2 and 4-31 are not online but could be
91 92 93 94 95 96 97 98 99
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
100 101
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
102 103 104 105 106 107 108 109 110
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
111
as well as more information on the various cpumasks.