libcfs/include/libcfs/libcfs_cpu.h

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * GPL HEADER END
  17  */
  18 /*
  19  * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
  20  *
  21  * Copyright (c) 2012, 2017, Intel Corporation.
  22  */
  23 /*
  24  * This file is part of Lustre, http://www.lustre.org/
  25  * Lustre is a trademark of Sun Microsystems, Inc.
  26  *
  27  * libcfs/include/libcfs/libcfs_cpu.h
  28  *
  29  * CPU partition
  30  *   . CPU partition is virtual processing unit
  31  *
  32  *   . CPU partition can present 1-N cores, or 1-N NUMA nodes,
  33  *     in other words, CPU partition is a processors pool.
  34  *
  35  * CPU Partition Table (CPT)
  36  *   . a set of CPU partitions
  37  *
  38  *   . There are two modes for CPT: CFS_CPU_MODE_NUMA and CFS_CPU_MODE_SMP
  39  *
  40  *   . User can specify total number of CPU partitions while creating a
  41  *     CPT, ID of CPU partition is always start from 0.
  42  *
  43  *     Example: if there are 8 cores on the system, while creating a CPT
  44  *     with cpu_npartitions=4:
  45  *              core[0, 1] = partition[0], core[2, 3] = partition[1]
  46  *              core[4, 5] = partition[2], core[6, 7] = partition[3]
  47  *
  48  *          cpu_npartitions=1:
  49  *              core[0, 1, ... 7] = partition[0]
  50  *
  51  *   . User can also specify CPU partitions by string pattern
  52  *
  53  *     Examples: cpu_partitions="0[0,1], 1[2,3]"
  54  *               cpu_partitions="N 0[0-3], 1[4-8]"
  55  *
  56  *     The first character "N" means following numbers are numa ID
  57  *
  58  *   . NUMA allocators, CPU affinity threads are built over CPU partitions,
  59  *     instead of HW CPUs or HW nodes.
  60  *
  61  *   . By default, Lustre modules should refer to the global cfs_cpt_table,
  62  *     instead of accessing HW CPUs directly, so concurrency of Lustre can be
  63  *     configured by cpu_npartitions of the global cfs_cpt_table
  64  *
  65  *   . If cpu_npartitions=1(all CPUs in one pool), lustre should work the
  66  *     same way as 2.2 or earlier versions
  67  *
  68  * Author: liang@whamcloud.com
  69  */
  70
  71 #ifndef __LIBCFS_CPU_H__
  72 #define __LIBCFS_CPU_H__
  73
  74 #include <linux/cpu.h>
  75 #include <linux/cpuset.h>
  76 #include <linux/slab.h>
  77 #include <linux/topology.h>
  78 #include <linux/version.h>
  79
  80 #include <libcfs/linux/linux-cpu.h>
  81
  82 #ifdef CONFIG_SMP
  83
  84 /** virtual processing unit */
  85 struct cfs_cpu_partition {
  86         /* CPUs mask for this partition */
  87         cpumask_t                       *cpt_cpumask;
  88         /* nodes mask for this partition */
  89         nodemask_t                      *cpt_nodemask;
  90         /* NUMA distance between CPTs */
  91         unsigned int                    *cpt_distance;
  92         /* spread rotor for NUMA allocator */
  93         int                              cpt_spread_rotor;
  94         /* NUMA node if cpt_nodemask is empty */
  95         int                              cpt_node;
  96 };
  97 #endif /* CONFIG_SMP */
  98
  99 /** descriptor for CPU partitions */
 100 struct cfs_cpt_table {
 101 #ifdef CONFIG_SMP
 102         /* spread rotor for NUMA allocator */
 103         int                              ctb_spread_rotor;
 104         /* maximum NUMA distance between all nodes in table */
 105         unsigned int                     ctb_distance;
 106         /* partitions tables */
 107         struct cfs_cpu_partition        *ctb_parts;
 108         /* shadow HW CPU to CPU partition ID */
 109         int                             *ctb_cpu2cpt;
 110         /* shadow HW node to CPU partition ID */
 111         int                             *ctb_node2cpt;
 112         /* # of CPU partitions */
 113         int                              ctb_nparts;
 114         /* all nodes in this partition table */
 115         nodemask_t                      *ctb_nodemask;
 116 #else
 117         nodemask_t                       ctb_nodemask;
 118 #endif /* CONFIG_SMP */
 119         /* all cpus in this partition table */
 120         cpumask_t                       *ctb_cpumask;
 121 };
 122
 123 /* any CPU partition */
 124 #define CFS_CPT_ANY             (-1)
 125
 126 extern struct cfs_cpt_table     *cfs_cpt_table;
 127
 128 /**
 129  * destroy a CPU partition table
 130  */
 131 void cfs_cpt_table_free(struct cfs_cpt_table *cptab);
 132 /**
 133  * create a cfs_cpt_table with \a ncpt number of partitions
 134  */
 135 struct cfs_cpt_table *cfs_cpt_table_alloc(int ncpt);
 136 /**
 137  * print string information of cpt-table
 138  */
 139 int cfs_cpt_table_print(struct cfs_cpt_table *cptab, char *buf, int len);
 140 /**
 141  * print distance information of cpt-table
 142  */
 143 int cfs_cpt_distance_print(struct cfs_cpt_table *cptab, char *buf, int len);
 144 /**
 145  * return total number of CPU partitions in \a cptab
 146  */
 147 int cfs_cpt_number(struct cfs_cpt_table *cptab);
 148 /**
 149  * return number of HW cores or hyper-threadings in a CPU partition \a cpt
 150  */
 151 int cfs_cpt_weight(struct cfs_cpt_table *cptab, int cpt);
 152 /**
 153  * is there any online CPU in CPU partition \a cpt
 154  */
 155 int cfs_cpt_online(struct cfs_cpt_table *cptab, int cpt);
 156 /**
 157  * return cpumask of CPU partition \a cpt
 158  */
 159 cpumask_t *cfs_cpt_cpumask(struct cfs_cpt_table *cptab, int cpt);
 160 /**
 161  * return nodemask of CPU partition \a cpt
 162  */
 163 nodemask_t *cfs_cpt_nodemask(struct cfs_cpt_table *cptab, int cpt);
 164 /**
 165  * shadow current HW processor ID to CPU-partition ID of \a cptab
 166  */
 167 int cfs_cpt_current(struct cfs_cpt_table *cptab, int remap);
 168 /**
 169  * shadow HW processor ID \a CPU to CPU-partition ID by \a cptab
 170  */
 171 int cfs_cpt_of_cpu(struct cfs_cpt_table *cptab, int cpu);
 172 /**
 173  * shadow HW node ID \a NODE to CPU-partition ID by \a cptab
 174  */
 175 int cfs_cpt_of_node(struct cfs_cpt_table *cptab, int node);
 176 /**
 177  * NUMA distance between \a cpt1 and \a cpt2 in \a cptab
 178  */
 179 unsigned int cfs_cpt_distance(struct cfs_cpt_table *cptab, int cpt1, int cpt2);
 180 /**
 181  * bind current thread on a CPU-partition \a cpt of \a cptab
 182  */
 183 int cfs_cpt_bind(struct cfs_cpt_table *cptab, int cpt);
 184 /**
 185  * add \a cpu to CPU partition @cpt of \a cptab, return 1 for success,
 186  * otherwise 0 is returned
 187  */
 188 int cfs_cpt_set_cpu(struct cfs_cpt_table *cptab, int cpt, int cpu);
 189 /**
 190  * remove \a cpu from CPU partition \a cpt of \a cptab
 191  */
 192 void cfs_cpt_unset_cpu(struct cfs_cpt_table *cptab, int cpt, int cpu);
 193 /**
 194  * add all cpus in \a mask to CPU partition \a cpt
 195  * return 1 if successfully set all CPUs, otherwise return 0
 196  */
 197 int cfs_cpt_set_cpumask(struct cfs_cpt_table *cptab, int cpt,
 198                         const cpumask_t *mask);
 199 /**
 200  * remove all cpus in \a mask from CPU partition \a cpt
 201  */
 202 void cfs_cpt_unset_cpumask(struct cfs_cpt_table *cptab, int cpt,
 203                            const cpumask_t *mask);
 204 /**
 205  * add all cpus in NUMA node \a node to CPU partition \a cpt
 206  * return 1 if successfully set all CPUs, otherwise return 0
 207  */
 208 int cfs_cpt_set_node(struct cfs_cpt_table *cptab, int cpt, int node);
 209 /**
 210  * remove all cpus in NUMA node \a node from CPU partition \a cpt
 211  */
 212 void cfs_cpt_unset_node(struct cfs_cpt_table *cptab, int cpt, int node);
 213
 214 /**
 215  * add all cpus in node mask \a mask to CPU partition \a cpt
 216  * return 1 if successfully set all CPUs, otherwise return 0
 217  */
 218 int cfs_cpt_set_nodemask(struct cfs_cpt_table *cptab, int cpt,
 219                          const nodemask_t *mask);
 220 /**
 221  * remove all cpus in node mask \a mask from CPU partition \a cpt
 222  */
 223 void cfs_cpt_unset_nodemask(struct cfs_cpt_table *cptab, int cpt,
 224                             const nodemask_t *mask);
 225 /**
 226  * convert partition id \a cpt to numa node id, if there are more than one
 227  * nodes in this partition, it might return a different node id each time.
 228  */
 229 int cfs_cpt_spread_node(struct cfs_cpt_table *cptab, int cpt);
 230
 231 /*
 232  * allocate per-cpu-partition data, returned value is an array of pointers,
 233  * variable can be indexed by CPU ID.
 234  *      cptab != NULL: size of array is number of CPU partitions
 235  *      cptab == NULL: size of array is number of HW cores
 236  */
 237 void *cfs_percpt_alloc(struct cfs_cpt_table *cptab, unsigned int size);
 238 /*
 239  * destroy per-cpu-partition variable
 240  */
 241 void cfs_percpt_free(void *vars);
 242 int cfs_percpt_number(void *vars);
 243
 244 #define cfs_percpt_for_each(var, i, vars)               \
 245         for (i = 0; i < cfs_percpt_number(vars) &&      \
 246                 ((var) = (vars)[i]) != NULL; i++)
 247
 248 /*
 249  * percpu partition lock
 250  *
 251  * There are some use-cases like this in Lustre:
 252  * . each CPU partition has it's own private data which is frequently changed,
 253  *   and mostly by the local CPU partition.
 254  * . all CPU partitions share some global data, these data are rarely changed.
 255  *
 256  * LNet is typical example.
 257  * CPU partition lock is designed for this kind of use-cases:
 258  * . each CPU partition has it's own private lock
 259  * . change on private data just needs to take the private lock
 260  * . read on shared data just needs to take _any_ of private locks
 261  * . change on shared data needs to take _all_ private locks,
 262  *   which is slow and should be really rare.
 263  */
 264 enum {
 265         CFS_PERCPT_LOCK_EX      = -1,   /* negative */
 266 };
 267
 268 struct cfs_percpt_lock {
 269         /* cpu-partition-table for this lock */
 270         struct cfs_cpt_table     *pcl_cptab;
 271         /* exclusively locked */
 272         unsigned int              pcl_locked;
 273         /* private lock table */
 274         spinlock_t              **pcl_locks;
 275 };
 276
 277 /* return number of private locks */
 278 #define cfs_percpt_lock_num(pcl)        cfs_cpt_number(pcl->pcl_cptab)
 279
 280 /*
 281  * create a cpu-partition lock based on CPU partition table \a cptab,
 282  * each private lock has extra \a psize bytes padding data
 283  */
 284 struct cfs_percpt_lock *cfs_percpt_lock_create(struct cfs_cpt_table *cptab,
 285                                                struct lock_class_key *keys);
 286 /* destroy a cpu-partition lock */
 287 void cfs_percpt_lock_free(struct cfs_percpt_lock *pcl);
 288
 289 /* lock private lock \a index of \a pcl */
 290 void cfs_percpt_lock(struct cfs_percpt_lock *pcl, int index);
 291
 292 /* unlock private lock \a index of \a pcl */
 293 void cfs_percpt_unlock(struct cfs_percpt_lock *pcl, int index);
 294
 295 #define CFS_PERCPT_LOCK_KEYS    256
 296
 297 /* NB: don't allocate keys dynamically, lockdep needs them to be in ".data" */
 298 #define cfs_percpt_lock_alloc(cptab)                                    \
 299 ({                                                                      \
 300         static struct lock_class_key ___keys[CFS_PERCPT_LOCK_KEYS];     \
 301         struct cfs_percpt_lock *___lk;                                  \
 302                                                                         \
 303         if (cfs_cpt_number(cptab) > CFS_PERCPT_LOCK_KEYS)               \
 304                 ___lk = cfs_percpt_lock_create(cptab, NULL);            \
 305         else                                                            \
 306                 ___lk = cfs_percpt_lock_create(cptab, ___keys);         \
 307         ___lk;                                                          \
 308 })
 309
 310 /**
 311  * allocate \a nr_bytes of physical memory from a contiguous region with the
 312  * properties of \a flags which are bound to the partition id \a cpt. This
 313  * function should only be used for the case when only a few pages of memory
 314  * are need.
 315  */
 316 static inline void *
 317 cfs_cpt_malloc(struct cfs_cpt_table *cptab, int cpt, size_t nr_bytes,
 318                gfp_t flags)
 319 {
 320         return kmalloc_node(nr_bytes, flags,
 321                             cfs_cpt_spread_node(cptab, cpt));
 322 }
 323
 324 /**
 325  * allocate \a nr_bytes of virtually contiguous memory that is bound to the
 326  * partition id \a cpt.
 327  */
 328 static inline void *
 329 cfs_cpt_vzalloc(struct cfs_cpt_table *cptab, int cpt, size_t nr_bytes)
 330 {
 331         /* vzalloc_node() sets __GFP_FS by default but no current Kernel
 332          * exported entry-point allows for both a NUMA node specification
 333          * and a custom allocation flags mask. This may be an issue since
 334          * __GFP_FS usage can cause some deadlock situations in our code,
 335          * like when memory reclaim started, within the same context of a
 336          * thread doing FS operations, that can also attempt conflicting FS
 337          * operations, ...
 338          */
 339         return vzalloc_node(nr_bytes, cfs_cpt_spread_node(cptab, cpt));
 340 }
 341
 342 /**
 343  * allocate a single page of memory with the properties of \a flags were
 344  * that page is bound to the partition id \a cpt.
 345  */
 346 static inline struct page *
 347 cfs_page_cpt_alloc(struct cfs_cpt_table *cptab, int cpt, gfp_t flags)
 348 {
 349         return alloc_pages_node(cfs_cpt_spread_node(cptab, cpt), flags, 0);
 350 }
 351
 352 /**
 353  * allocate a chunck of memory from a memory pool that is bound to the
 354  * partition id \a cpt with the properites of \a flags.
 355  */
 356 static inline void *
 357 cfs_mem_cache_cpt_alloc(struct kmem_cache *cachep, struct cfs_cpt_table *cptab,
 358                         int cpt, gfp_t flags)
 359 {
 360         return kmem_cache_alloc_node(cachep, flags,
 361                                      cfs_cpt_spread_node(cptab, cpt));
 362 }
 363
 364 /**
 365  * iterate over all CPU partitions in \a cptab
 366  */
 367 #define cfs_cpt_for_each(i, cptab)      \
 368         for (i = 0; i < cfs_cpt_number(cptab); i++)
 369
 370 int  cfs_cpu_init(void);
 371 void cfs_cpu_fini(void);
 372
 373 #endif /* __LIBCFS_CPU_H__ */