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