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 struct cfs_cpt_table {
  82         /* # of CPU partitions */
  83         int                     ctb_nparts;
  84         /* cpu mask */
  85         cpumask_t               ctb_mask;
  86         /* node mask */
  87         nodemask_t              ctb_nodemask;
  88         /* version */
  89         __u64                   ctb_version;
  90 };
  91
  92 #endif /* !HAVE_LIBCFS_CPT */
  93
  94 /* any CPU partition */
  95 #define CFS_CPT_ANY             (-1)
  96
  97 extern struct cfs_cpt_table     *cfs_cpt_table;
  98
  99 /**
 100  * destroy a CPU partition table
 101  */
 102 void cfs_cpt_table_free(struct cfs_cpt_table *cptab);
 103 /**
 104  * create a cfs_cpt_table with \a ncpt number of partitions
 105  */
 106 struct cfs_cpt_table *cfs_cpt_table_alloc(int ncpt);
 107 /**
 108  * print string information of cpt-table
 109  */
 110 int cfs_cpt_table_print(struct cfs_cpt_table *cptab, char *buf, int len);
 111 /**
 112  * print distance information of cpt-table
 113  */
 114 int cfs_cpt_distance_print(struct cfs_cpt_table *cptab, char *buf, int len);
 115 /**
 116  * return total number of CPU partitions in \a cptab
 117  */
 118 int cfs_cpt_number(struct cfs_cpt_table *cptab);
 119 /**
 120  * return number of HW cores or hypter-threadings in a CPU partition \a cpt
 121  */
 122 int cfs_cpt_weight(struct cfs_cpt_table *cptab, int cpt);
 123 /**
 124  * is there any online CPU in CPU partition \a cpt
 125  */
 126 int cfs_cpt_online(struct cfs_cpt_table *cptab, int cpt);
 127 /**
 128  * return cpumask of CPU partition \a cpt
 129  */
 130 cpumask_t *cfs_cpt_cpumask(struct cfs_cpt_table *cptab, int cpt);
 131 /**
 132  * return nodemask of CPU partition \a cpt
 133  */
 134 nodemask_t *cfs_cpt_nodemask(struct cfs_cpt_table *cptab, int cpt);
 135 /**
 136  * shadow current HW processor ID to CPU-partition ID of \a cptab
 137  */
 138 int cfs_cpt_current(struct cfs_cpt_table *cptab, int remap);
 139 /**
 140  * shadow HW processor ID \a CPU to CPU-partition ID by \a cptab
 141  */
 142 int cfs_cpt_of_cpu(struct cfs_cpt_table *cptab, int cpu);
 143 /**
 144  * shadow HW node ID \a NODE to CPU-partition ID by \a cptab
 145  */
 146 int cfs_cpt_of_node(struct cfs_cpt_table *cptab, int node);
 147 /**
 148  * NUMA distance between \a cpt1 and \a cpt2 in \a cptab
 149  */
 150 unsigned cfs_cpt_distance(struct cfs_cpt_table *cptab, int cpt1, int cpt2);
 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
 169 int cfs_cpt_set_cpumask(struct cfs_cpt_table *cptab, int cpt,
 170                         const cpumask_t *mask);
 171 /**
 172  * remove all cpus in \a mask from CPU partition \a cpt
 173  */
 174 void cfs_cpt_unset_cpumask(struct cfs_cpt_table *cptab, int cpt,
 175                            const cpumask_t *mask);
 176 /**
 177  * add all cpus in NUMA node \a node to CPU partition \a cpt
 178  * return 1 if successfully set all CPUs, otherwise return 0
 179  */
 180 int cfs_cpt_set_node(struct cfs_cpt_table *cptab, int cpt, int node);
 181 /**
 182  * remove all cpus in NUMA node \a node from CPU partition \a cpt
 183  */
 184 void cfs_cpt_unset_node(struct cfs_cpt_table *cptab, int cpt, int node);
 185
 186 /**
 187  * add all cpus in node mask \a mask to CPU partition \a cpt
 188  * return 1 if successfully set all CPUs, otherwise return 0
 189  */
 190 int cfs_cpt_set_nodemask(struct cfs_cpt_table *cptab, int cpt,
 191                          const nodemask_t *mask);
 192 /**
 193  * remove all cpus in node mask \a mask from CPU partition \a cpt
 194  */
 195 void cfs_cpt_unset_nodemask(struct cfs_cpt_table *cptab, int cpt,
 196                             const nodemask_t *mask);
 197 /**
 198  * convert partition id \a cpt to numa node id, if there are more than one
 199  * nodes in this partition, it might return a different node id each time.
 200  */
 201 int cfs_cpt_spread_node(struct cfs_cpt_table *cptab, int cpt);
 202
 203 /*
 204  * allocate per-cpu-partition data, returned value is an array of pointers,
 205  * variable can be indexed by CPU ID.
 206  *      cptab != NULL: size of array is number of CPU partitions
 207  *      cptab == NULL: size of array is number of HW cores
 208  */
 209 void *cfs_percpt_alloc(struct cfs_cpt_table *cptab, unsigned int size);
 210 /*
 211  * destory per-cpu-partition variable
 212  */
 213 void  cfs_percpt_free(void *vars);
 214 int   cfs_percpt_number(void *vars);
 215
 216 #define cfs_percpt_for_each(var, i, vars)               \
 217         for (i = 0; i < cfs_percpt_number(vars) &&      \
 218                 ((var) = (vars)[i]) != NULL; i++)
 219
 220 /*
 221  * percpu partition lock
 222  *
 223  * There are some use-cases like this in Lustre:
 224  * . each CPU partition has it's own private data which is frequently changed,
 225  *   and mostly by the local CPU partition.
 226  * . all CPU partitions share some global data, these data are rarely changed.
 227  *
 228  * LNet is typical example.
 229  * CPU partition lock is designed for this kind of use-cases:
 230  * . each CPU partition has it's own private lock
 231  * . change on private data just needs to take the private lock
 232  * . read on shared data just needs to take _any_ of private locks
 233  * . change on shared data needs to take _all_ private locks,
 234  *   which is slow and should be really rare.
 235  */
 236 enum {
 237         CFS_PERCPT_LOCK_EX      = -1,   /* negative */
 238 };
 239
 240 struct cfs_percpt_lock {
 241         /* cpu-partition-table for this lock */
 242         struct cfs_cpt_table     *pcl_cptab;
 243         /* exclusively locked */
 244         unsigned int              pcl_locked;
 245         /* private lock table */
 246         spinlock_t              **pcl_locks;
 247 };
 248
 249 /* return number of private locks */
 250 #define cfs_percpt_lock_num(pcl)        cfs_cpt_number(pcl->pcl_cptab)
 251
 252 /*
 253  * create a cpu-partition lock based on CPU partition table \a cptab,
 254  * each private lock has extra \a psize bytes padding data
 255  */
 256 struct cfs_percpt_lock *cfs_percpt_lock_create(struct cfs_cpt_table *cptab,
 257                                                struct lock_class_key *keys);
 258 /* destroy a cpu-partition lock */
 259 void cfs_percpt_lock_free(struct cfs_percpt_lock *pcl);
 260
 261 /* lock private lock \a index of \a pcl */
 262 void cfs_percpt_lock(struct cfs_percpt_lock *pcl, int index);
 263 /* unlock private lock \a index of \a pcl */
 264 void cfs_percpt_unlock(struct cfs_percpt_lock *pcl, int index);
 265
 266 #define CFS_PERCPT_LOCK_KEYS   256
 267
 268 /* NB: don't allocate keys dynamically, lockdep needs them to be in ".data" */
 269 #define cfs_percpt_lock_alloc(cptab)                                    \
 270 ({                                                                      \
 271         static struct lock_class_key  ___keys[CFS_PERCPT_LOCK_KEYS];    \
 272         struct cfs_percpt_lock       *___lk;                            \
 273                                                                         \
 274         if (cfs_cpt_number(cptab) > CFS_PERCPT_LOCK_KEYS)               \
 275                 ___lk = cfs_percpt_lock_create(cptab, NULL);            \
 276         else                                                            \
 277                 ___lk = cfs_percpt_lock_create(cptab, ___keys);         \
 278         ___lk;                                                          \
 279 })
 280
 281 /**
 282  * allocate \a nr_bytes of physical memory from a contiguous region with the
 283  * properties of \a flags which are bound to the partition id \a cpt. This
 284  * function should only be used for the case when only a few pages of memory
 285  * are need.
 286  */
 287 static inline void *
 288 cfs_cpt_malloc(struct cfs_cpt_table *cptab, int cpt, size_t nr_bytes,
 289                gfp_t flags)
 290 {
 291         return kmalloc_node(nr_bytes, flags,
 292                             cfs_cpt_spread_node(cptab, cpt));
 293 }
 294
 295 /**
 296  * allocate \a nr_bytes of virtually contiguous memory that is bound to the
 297  * partition id \a cpt.
 298  */
 299 static inline void *
 300 cfs_cpt_vzalloc(struct cfs_cpt_table *cptab, int cpt, size_t nr_bytes)
 301 {
 302         /* vzalloc_node() sets __GFP_FS by default but no current Kernel
 303          * exported entry-point allows for both a NUMA node specification
 304          * and a custom allocation flags mask. This may be an issue since
 305          * __GFP_FS usage can cause some deadlock situations in our code,
 306          * like when memory reclaim started, within the same context of a
 307          * thread doing FS operations, that can also attempt conflicting FS
 308          * operations, ...
 309          */
 310         return vzalloc_node(nr_bytes, cfs_cpt_spread_node(cptab, cpt));
 311 }
 312
 313 /**
 314  * allocate a single page of memory with the properties of \a flags were
 315  * that page is bound to the partition id \a cpt.
 316  */
 317 static inline struct page *
 318 cfs_page_cpt_alloc(struct cfs_cpt_table *cptab, int cpt, gfp_t flags)
 319 {
 320         return alloc_pages_node(cfs_cpt_spread_node(cptab, cpt), flags, 0);
 321 }
 322
 323 /**
 324  * allocate a chunck of memory from a memory pool that is bound to the
 325  * partition id \a cpt with the properites of \a flags.
 326  */
 327 static inline void *
 328 cfs_mem_cache_cpt_alloc(struct kmem_cache *cachep, struct cfs_cpt_table *cptab,
 329                         int cpt, gfp_t flags)
 330 {
 331         return kmem_cache_alloc_node(cachep, flags,
 332                                      cfs_cpt_spread_node(cptab, cpt));
 333 }
 334
 335 /**
 336  * iterate over all CPU partitions in \a cptab
 337  */
 338 #define cfs_cpt_for_each(i, cptab)      \
 339         for (i = 0; i < cfs_cpt_number(cptab); i++)
 340
 341 #ifndef __read_mostly
 342 # define __read_mostly
 343 #endif
 344
 345 #ifndef ____cacheline_aligned
 346 #define ____cacheline_aligned
 347 #endif
 348
 349 int  cfs_cpu_init(void);
 350 void cfs_cpu_fini(void);
 351
 352 #endif /* __LIBCFS_CPU_H__ */