[mirror_ubuntu-bionic-kernel.git] / include / linux / topology.h

/*
 * include/linux/topology.h
 *
 * Written by: Matthew Dobson, IBM Corporation
 *
 * Copyright (C) 2002, IBM Corp.
 *
 * All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
 * NON INFRINGEMENT.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 * Send feedback to <colpatch@us.ibm.com>
 */
#ifndef _LINUX_TOPOLOGY_H
#define _LINUX_TOPOLOGY_H

#include <linux/cpumask.h>
#include <linux/bitops.h>
#include <linux/mmzone.h>
#include <linux/smp.h>
#include <asm/topology.h>

#ifndef node_has_online_mem
#define node_has_online_mem(nid) (1)
#endif

#ifndef nr_cpus_node
#define nr_cpus_node(node) cpumask_weight(cpumask_of_node(node))
#endif

#define for_each_node_with_cpus(node)			\
	for_each_online_node(node)			\
		if (nr_cpus_node(node))

int arch_update_cpu_topology(void);

/* Conform to ACPI 2.0 SLIT distance definitions */
#define LOCAL_DISTANCE		10
#define REMOTE_DISTANCE		20
#ifndef node_distance
#define node_distance(from,to)	((from) == (to) ? LOCAL_DISTANCE : REMOTE_DISTANCE)
#endif
#ifndef RECLAIM_DISTANCE
/*
 * If the distance between nodes in a system is larger than RECLAIM_DISTANCE
 * (in whatever arch specific measurement units returned by node_distance())
 * then switch on zone reclaim on boot.
 */
#define RECLAIM_DISTANCE 20
#endif
#ifndef PENALTY_FOR_NODE_WITH_CPUS
#define PENALTY_FOR_NODE_WITH_CPUS	(1)
#endif

/*
 * Below are the 3 major initializers used in building sched_domains:
 * SD_SIBLING_INIT, for SMT domains
 * SD_CPU_INIT, for SMP domains
 * SD_NODE_INIT, for NUMA domains
 *
 * Any architecture that cares to do any tuning to these values should do so
 * by defining their own arch-specific initializer in include/asm/topology.h.
 * A definition there will automagically override these default initializers
 * and allow arch-specific performance tuning of sched_domains.
 * (Only non-zero and non-null fields need be specified.)
 */

#ifdef CONFIG_SCHED_SMT
/* MCD - Do we really need this?  It is always on if CONFIG_SCHED_SMT is,
 * so can't we drop this in favor of CONFIG_SCHED_SMT?
 */
#define ARCH_HAS_SCHED_WAKE_IDLE
/* Common values for SMT siblings */
#ifndef SD_SIBLING_INIT
#define SD_SIBLING_INIT (struct sched_domain) {				\
	.min_interval		= 1,					\
	.max_interval		= 2,					\
	.busy_factor		= 64,					\
	.imbalance_pct		= 110,					\
									\
	.flags			= 1*SD_LOAD_BALANCE			\
				| 1*SD_BALANCE_NEWIDLE			\
				| 1*SD_BALANCE_EXEC			\
				| 1*SD_BALANCE_FORK			\
				| 0*SD_WAKE_IDLE			\
				| 1*SD_WAKE_AFFINE			\
				| 1*SD_WAKE_BALANCE			\
				| 1*SD_SHARE_CPUPOWER			\
				| 0*SD_POWERSAVINGS_BALANCE		\
				| 0*SD_SHARE_PKG_RESOURCES		\
				| 0*SD_SERIALIZE			\
				| 0*SD_WAKE_IDLE_FAR			\
				| 0*SD_PREFER_SIBLING			\
				,					\
	.last_balance		= jiffies,				\
	.balance_interval	= 1,					\
	.smt_gain		= 1178,	/* 15% */			\
}
#endif
#endif /* CONFIG_SCHED_SMT */

#ifdef CONFIG_SCHED_MC
/* Common values for MC siblings. for now mostly derived from SD_CPU_INIT */
#ifndef SD_MC_INIT
#define SD_MC_INIT (struct sched_domain) {				\
	.min_interval		= 1,					\
	.max_interval		= 4,					\
	.busy_factor		= 64,					\
	.imbalance_pct		= 125,					\
	.cache_nice_tries	= 1,					\
	.busy_idx		= 2,					\
	.wake_idx		= 1,					\
	.forkexec_idx		= 1,					\
									\
	.flags			= 1*SD_LOAD_BALANCE			\
				| 0*SD_BALANCE_NEWIDLE			\
				| 1*SD_BALANCE_EXEC			\
				| 1*SD_BALANCE_FORK			\
				| 0*SD_WAKE_IDLE			\
				| 1*SD_WAKE_AFFINE			\
				| 1*SD_WAKE_BALANCE			\
				| 0*SD_SHARE_CPUPOWER			\
				| 1*SD_SHARE_PKG_RESOURCES		\
				| 0*SD_SERIALIZE			\
				| 0*SD_WAKE_IDLE_FAR			\
				| sd_balance_for_mc_power()		\
				| sd_power_saving_flags()		\
				,					\
	.last_balance		= jiffies,				\
	.balance_interval	= 1,					\
}
#endif
#endif /* CONFIG_SCHED_MC */

/* Common values for CPUs */
#ifndef SD_CPU_INIT
#define SD_CPU_INIT (struct sched_domain) {				\
	.min_interval		= 1,					\
	.max_interval		= 4,					\
	.busy_factor		= 64,					\
	.imbalance_pct		= 125,					\
	.cache_nice_tries	= 1,					\
	.busy_idx		= 2,					\
	.idle_idx		= 1,					\
	.newidle_idx		= 2,					\
	.wake_idx		= 1,					\
	.forkexec_idx		= 1,					\
									\
	.flags			= 1*SD_LOAD_BALANCE			\
				| 0*SD_BALANCE_NEWIDLE			\
				| 1*SD_BALANCE_EXEC			\
				| 1*SD_BALANCE_FORK			\
				| 0*SD_WAKE_IDLE			\
				| 0*SD_WAKE_AFFINE			\
				| 1*SD_WAKE_BALANCE			\
				| 0*SD_SHARE_CPUPOWER			\
				| 0*SD_SHARE_PKG_RESOURCES		\
				| 0*SD_SERIALIZE			\
				| 0*SD_WAKE_IDLE_FAR			\
				| sd_balance_for_package_power()	\
				| sd_power_saving_flags()		\
				,					\
	.last_balance		= jiffies,				\
	.balance_interval	= 1,					\
}
#endif

/* sched_domains SD_ALLNODES_INIT for NUMA machines */
#define SD_ALLNODES_INIT (struct sched_domain) {			\
	.min_interval		= 64,					\
	.max_interval		= 64*num_online_cpus(),			\
	.busy_factor		= 128,					\
	.imbalance_pct		= 133,					\
	.cache_nice_tries	= 1,					\
	.busy_idx		= 3,					\
	.idle_idx		= 3,					\
	.flags			= 1*SD_LOAD_BALANCE			\
				| 1*SD_BALANCE_NEWIDLE			\
				| 0*SD_BALANCE_EXEC			\
				| 0*SD_BALANCE_FORK			\
				| 0*SD_WAKE_IDLE			\
				| 1*SD_WAKE_AFFINE			\
				| 0*SD_WAKE_BALANCE			\
				| 0*SD_SHARE_CPUPOWER			\
				| 0*SD_POWERSAVINGS_BALANCE		\
				| 0*SD_SHARE_PKG_RESOURCES		\
				| 1*SD_SERIALIZE			\
				| 0*SD_WAKE_IDLE_FAR			\
				| 0*SD_PREFER_SIBLING			\
				,					\
	.last_balance		= jiffies,				\
	.balance_interval	= 64,					\
}

#ifdef CONFIG_NUMA
#ifndef SD_NODE_INIT
#error Please define an appropriate SD_NODE_INIT in include/asm/topology.h!!!
#endif
#endif /* CONFIG_NUMA */

#ifndef topology_physical_package_id
#define topology_physical_package_id(cpu)	((void)(cpu), -1)
#endif
#ifndef topology_core_id
#define topology_core_id(cpu)			((void)(cpu), 0)
#endif
#ifndef topology_thread_siblings
#define topology_thread_siblings(cpu)		cpumask_of_cpu(cpu)
#endif
#ifndef topology_core_siblings
#define topology_core_siblings(cpu)		cpumask_of_cpu(cpu)
#endif
#ifndef topology_thread_cpumask
#define topology_thread_cpumask(cpu)		cpumask_of(cpu)
#endif
#ifndef topology_core_cpumask
#define topology_core_cpumask(cpu)		cpumask_of(cpu)
#endif

/* Returns the number of the current Node. */
#ifndef numa_node_id
#define numa_node_id()		(cpu_to_node(raw_smp_processor_id()))
#endif

#endif /* _LINUX_TOPOLOGY_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* include/linux/topology.h
	3	*
	4	* Written by: Matthew Dobson, IBM Corporation
	5	*
	6	* Copyright (C) 2002, IBM Corp.
	7	*
32525d02	8	* All rights reserved.
1da177e4 LT	9	*
	10	* This program is free software; you can redistribute it and/or modify
	11	* it under the terms of the GNU General Public License as published by
	12	* the Free Software Foundation; either version 2 of the License, or
	13	* (at your option) any later version.
	14	*
	15	* This program is distributed in the hope that it will be useful, but
	16	* WITHOUT ANY WARRANTY; without even the implied warranty of
	17	* MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
	18	* NON INFRINGEMENT. See the GNU General Public License for more
	19	* details.
	20	*
	21	* You should have received a copy of the GNU General Public License
	22	* along with this program; if not, write to the Free Software
	23	* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
	24	*
	25	* Send feedback to <colpatch@us.ibm.com>
	26	*/
	27	#ifndef _LINUX_TOPOLOGY_H
	28	#define _LINUX_TOPOLOGY_H
	29
	30	#include <linux/cpumask.h>
	31	#include <linux/bitops.h>
	32	#include <linux/mmzone.h>
	33	#include <linux/smp.h>
	34	#include <asm/topology.h>
	35
	36	#ifndef node_has_online_mem
	37	#define node_has_online_mem(nid) (1)
	38	#endif
	39
	40	#ifndef nr_cpus_node
a70f7302	41	#define nr_cpus_node(node) cpumask_weight(cpumask_of_node(node))
1da177e4 LT	42	#endif
1da177e4 LT	43
7c16ec58 MT	44	#define for_each_node_with_cpus(node) \
7c16ec58 MT	45	for_each_online_node(node) \
1da177e4 LT	46	if (nr_cpus_node(node))
1da177e4 LT	47
ee79d1bd	48	int arch_update_cpu_topology(void);
22e52b07	49
1da177e4 LT	50	/* Conform to ACPI 2.0 SLIT distance definitions */
	51	#define LOCAL_DISTANCE 10
	52	#define REMOTE_DISTANCE 20
f787a503	53	#ifndef node_distance
1da177e4 LT	54	#define node_distance(from,to) ((from) == (to) ? LOCAL_DISTANCE : REMOTE_DISTANCE)
1da177e4 LT	55	#endif
9eeff239 CL	56	#ifndef RECLAIM_DISTANCE
	57	/*
	58	* If the distance between nodes in a system is larger than RECLAIM_DISTANCE
	59	* (in whatever arch specific measurement units returned by node_distance())
	60	* then switch on zone reclaim on boot.
	61	*/
	62	#define RECLAIM_DISTANCE 20
	63	#endif
1da177e4 LT	64	#ifndef PENALTY_FOR_NODE_WITH_CPUS
	65	#define PENALTY_FOR_NODE_WITH_CPUS (1)
	66	#endif
	67
	68	/*
	69	* Below are the 3 major initializers used in building sched_domains:
	70	* SD_SIBLING_INIT, for SMT domains
	71	* SD_CPU_INIT, for SMP domains
	72	* SD_NODE_INIT, for NUMA domains
	73	*
	74	* Any architecture that cares to do any tuning to these values should do so
	75	* by defining their own arch-specific initializer in include/asm/topology.h.
	76	* A definition there will automagically override these default initializers
	77	* and allow arch-specific performance tuning of sched_domains.
7c16ec58	78	* (Only non-zero and non-null fields need be specified.)
1da177e4	79	*/
7c16ec58	80
1da177e4 LT	81	#ifdef CONFIG_SCHED_SMT
	82	/* MCD - Do we really need this? It is always on if CONFIG_SCHED_SMT is,
	83	* so can't we drop this in favor of CONFIG_SCHED_SMT?
	84	*/
	85	#define ARCH_HAS_SCHED_WAKE_IDLE
	86	/* Common values for SMT siblings */
	87	#ifndef SD_SIBLING_INIT
47734f89 IM	88	#define SD_SIBLING_INIT (struct sched_domain) { \
	89	.min_interval = 1, \
	90	.max_interval = 2, \
	91	.busy_factor = 64, \
	92	.imbalance_pct = 110, \
	93	\
	94	.flags = 1*SD_LOAD_BALANCE \
	95	\| 1*SD_BALANCE_NEWIDLE \
	96	\| 1*SD_BALANCE_EXEC \
	97	\| 1*SD_BALANCE_FORK \
	98	\| 0*SD_WAKE_IDLE \
	99	\| 1*SD_WAKE_AFFINE \
	100	\| 1*SD_WAKE_BALANCE \
	101	\| 1*SD_SHARE_CPUPOWER \
	102	\| 0*SD_POWERSAVINGS_BALANCE \
	103	\| 0*SD_SHARE_PKG_RESOURCES \
	104	\| 0*SD_SERIALIZE \
	105	\| 0*SD_WAKE_IDLE_FAR \
	106	\| 0*SD_PREFER_SIBLING \
	107	, \
	108	.last_balance = jiffies, \
	109	.balance_interval = 1, \
	110	.smt_gain = 1178, /* 15% */ \
1da177e4 LT	111	}
	112	#endif
	113	#endif /* CONFIG_SCHED_SMT */
	114
89c4710e SS	115	#ifdef CONFIG_SCHED_MC
	116	/* Common values for MC siblings. for now mostly derived from SD_CPU_INIT */
	117	#ifndef SD_MC_INIT
47734f89 IM	118	#define SD_MC_INIT (struct sched_domain) { \
	119	.min_interval = 1, \
	120	.max_interval = 4, \
	121	.busy_factor = 64, \
	122	.imbalance_pct = 125, \
	123	.cache_nice_tries = 1, \
	124	.busy_idx = 2, \
	125	.wake_idx = 1, \
	126	.forkexec_idx = 1, \
	127	\
	128	.flags = 1*SD_LOAD_BALANCE \
	129	\| 0*SD_BALANCE_NEWIDLE \
	130	\| 1*SD_BALANCE_EXEC \
	131	\| 1*SD_BALANCE_FORK \
	132	\| 0*SD_WAKE_IDLE \
	133	\| 1*SD_WAKE_AFFINE \
	134	\| 1*SD_WAKE_BALANCE \
	135	\| 0*SD_SHARE_CPUPOWER \
	136	\| 1*SD_SHARE_PKG_RESOURCES \
	137	\| 0*SD_SERIALIZE \
	138	\| 0*SD_WAKE_IDLE_FAR \
	139	\| sd_balance_for_mc_power() \
	140	\| sd_power_saving_flags() \
	141	, \
	142	.last_balance = jiffies, \
	143	.balance_interval = 1, \
89c4710e SS	144	}
	145	#endif
	146	#endif /* CONFIG_SCHED_MC */
	147
1da177e4 LT	148	/* Common values for CPUs */
1da177e4 LT	149	#ifndef SD_CPU_INIT
47734f89 IM	150	#define SD_CPU_INIT (struct sched_domain) { \
	151	.min_interval = 1, \
	152	.max_interval = 4, \
	153	.busy_factor = 64, \
	154	.imbalance_pct = 125, \
	155	.cache_nice_tries = 1, \
	156	.busy_idx = 2, \
	157	.idle_idx = 1, \
	158	.newidle_idx = 2, \
	159	.wake_idx = 1, \
	160	.forkexec_idx = 1, \
	161	\
	162	.flags = 1*SD_LOAD_BALANCE \
	163	\| 0*SD_BALANCE_NEWIDLE \
	164	\| 1*SD_BALANCE_EXEC \
	165	\| 1*SD_BALANCE_FORK \
	166	\| 0*SD_WAKE_IDLE \
	167	\| 0*SD_WAKE_AFFINE \
	168	\| 1*SD_WAKE_BALANCE \
	169	\| 0*SD_SHARE_CPUPOWER \
	170	\| 0*SD_SHARE_PKG_RESOURCES \
	171	\| 0*SD_SERIALIZE \
	172	\| 0*SD_WAKE_IDLE_FAR \
	173	\| sd_balance_for_package_power() \
	174	\| sd_power_saving_flags() \
	175	, \
	176	.last_balance = jiffies, \
	177	.balance_interval = 1, \
1da177e4 LT	178	}
	179	#endif
	180
9c1cfda2	181	/* sched_domains SD_ALLNODES_INIT for NUMA machines */
47734f89 IM	182	#define SD_ALLNODES_INIT (struct sched_domain) { \
	183	.min_interval = 64, \
	184	.max_interval = 64*num_online_cpus(), \
	185	.busy_factor = 128, \
	186	.imbalance_pct = 133, \
	187	.cache_nice_tries = 1, \
	188	.busy_idx = 3, \
	189	.idle_idx = 3, \
	190	.flags = 1*SD_LOAD_BALANCE \
	191	\| 1*SD_BALANCE_NEWIDLE \
	192	\| 0*SD_BALANCE_EXEC \
	193	\| 0*SD_BALANCE_FORK \
	194	\| 0*SD_WAKE_IDLE \
	195	\| 1*SD_WAKE_AFFINE \
	196	\| 0*SD_WAKE_BALANCE \
	197	\| 0*SD_SHARE_CPUPOWER \
	198	\| 0*SD_POWERSAVINGS_BALANCE \
	199	\| 0*SD_SHARE_PKG_RESOURCES \
	200	\| 1*SD_SERIALIZE \
	201	\| 0*SD_WAKE_IDLE_FAR \
	202	\| 0*SD_PREFER_SIBLING \
	203	, \
	204	.last_balance = jiffies, \
	205	.balance_interval = 64, \
9c1cfda2 JH	206	}
9c1cfda2 JH	207
1da177e4 LT	208	#ifdef CONFIG_NUMA
	209	#ifndef SD_NODE_INIT
	210	#error Please define an appropriate SD_NODE_INIT in include/asm/topology.h!!!
	211	#endif
	212	#endif /* CONFIG_NUMA */
	213
c50cbb05 BH	214	#ifndef topology_physical_package_id
	215	#define topology_physical_package_id(cpu) ((void)(cpu), -1)
	216	#endif
	217	#ifndef topology_core_id
	218	#define topology_core_id(cpu) ((void)(cpu), 0)
	219	#endif
	220	#ifndef topology_thread_siblings
	221	#define topology_thread_siblings(cpu) cpumask_of_cpu(cpu)
	222	#endif
	223	#ifndef topology_core_siblings
	224	#define topology_core_siblings(cpu) cpumask_of_cpu(cpu)
	225	#endif
fbd59a8d RR	226	#ifndef topology_thread_cpumask
	227	#define topology_thread_cpumask(cpu) cpumask_of(cpu)
	228	#endif
	229	#ifndef topology_core_cpumask
	230	#define topology_core_cpumask(cpu) cpumask_of(cpu)
	231	#endif
c50cbb05	232
082edb7b RR	233	/* Returns the number of the current Node. */
	234	#ifndef numa_node_id
	235	#define numa_node_id() (cpu_to_node(raw_smp_processor_id()))
	236	#endif
	237
1da177e4	238	#endif /* _LINUX_TOPOLOGY_H */