mm/percpu-internal.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _MM_PERCPU_INTERNAL_H
   3 #define _MM_PERCPU_INTERNAL_H
   4
   5 #include <linux/types.h>
   6 #include <linux/percpu.h>
   7
   8 /*
   9  * pcpu_block_md is the metadata block struct.
  10  * Each chunk's bitmap is split into a number of full blocks.
  11  * All units are in terms of bits.
  12  *
  13  * The scan hint is the largest known contiguous area before the contig hint.
  14  * It is not necessarily the actual largest contig hint though.  There is an
  15  * invariant that the scan_hint_start > contig_hint_start iff
  16  * scan_hint == contig_hint.  This is necessary because when scanning forward,
  17  * we don't know if a new contig hint would be better than the current one.
  18  */
  19 struct pcpu_block_md {
  20         int                     scan_hint;      /* scan hint for block */
  21         int                     scan_hint_start; /* block relative starting
  22                                                     position of the scan hint */
  23         int                     contig_hint;    /* contig hint for block */
  24         int                     contig_hint_start; /* block relative starting
  25                                                       position of the contig hint */
  26         int                     left_free;      /* size of free space along
  27                                                    the left side of the block */
  28         int                     right_free;     /* size of free space along
  29                                                    the right side of the block */
  30         int                     first_free;     /* block position of first free */
  31         int                     nr_bits;        /* total bits responsible for */
  32 };
  33
  34 struct pcpu_chunk {
  35 #ifdef CONFIG_PERCPU_STATS
  36         int                     nr_alloc;       /* # of allocations */
  37         size_t                  max_alloc_size; /* largest allocation size */
  38 #endif
  39
  40         struct list_head        list;           /* linked to pcpu_slot lists */
  41         int                     free_bytes;     /* free bytes in the chunk */
  42         int                     contig_bits;    /* max contiguous size hint */
  43         int                     contig_bits_start; /* contig_bits starting
  44                                                       offset */
  45         void                    *base_addr;     /* base address of this chunk */
  46
  47         unsigned long           *alloc_map;     /* allocation map */
  48         unsigned long           *bound_map;     /* boundary map */
  49         struct pcpu_block_md    *md_blocks;     /* metadata blocks */
  50
  51         void                    *data;          /* chunk data */
  52         int                     first_bit;      /* no free below this */
  53         bool                    immutable;      /* no [de]population allowed */
  54         int                     start_offset;   /* the overlap with the previous
  55                                                    region to have a page aligned
  56                                                    base_addr */
  57         int                     end_offset;     /* additional area required to
  58                                                    have the region end page
  59                                                    aligned */
  60
  61         int                     nr_pages;       /* # of pages served by this chunk */
  62         int                     nr_populated;   /* # of populated pages */
  63         int                     nr_empty_pop_pages; /* # of empty populated pages */
  64         unsigned long           populated[];    /* populated bitmap */
  65 };
  66
  67 extern spinlock_t pcpu_lock;
  68
  69 extern struct list_head *pcpu_slot;
  70 extern int pcpu_nr_slots;
  71 extern int pcpu_nr_empty_pop_pages;
  72
  73 extern struct pcpu_chunk *pcpu_first_chunk;
  74 extern struct pcpu_chunk *pcpu_reserved_chunk;
  75
  76 /**
  77  * pcpu_chunk_nr_blocks - converts nr_pages to # of md_blocks
  78  * @chunk: chunk of interest
  79  *
  80  * This conversion is from the number of physical pages that the chunk
  81  * serves to the number of bitmap blocks used.
  82  */
  83 static inline int pcpu_chunk_nr_blocks(struct pcpu_chunk *chunk)
  84 {
  85         return chunk->nr_pages * PAGE_SIZE / PCPU_BITMAP_BLOCK_SIZE;
  86 }
  87
  88 /**
  89  * pcpu_nr_pages_to_map_bits - converts the pages to size of bitmap
  90  * @pages: number of physical pages
  91  *
  92  * This conversion is from physical pages to the number of bits
  93  * required in the bitmap.
  94  */
  95 static inline int pcpu_nr_pages_to_map_bits(int pages)
  96 {
  97         return pages * PAGE_SIZE / PCPU_MIN_ALLOC_SIZE;
  98 }
  99
 100 /**
 101  * pcpu_chunk_map_bits - helper to convert nr_pages to size of bitmap
 102  * @chunk: chunk of interest
 103  *
 104  * This conversion is from the number of physical pages that the chunk
 105  * serves to the number of bits in the bitmap.
 106  */
 107 static inline int pcpu_chunk_map_bits(struct pcpu_chunk *chunk)
 108 {
 109         return pcpu_nr_pages_to_map_bits(chunk->nr_pages);
 110 }
 111
 112 #ifdef CONFIG_PERCPU_STATS
 113
 114 #include <linux/spinlock.h>
 115
 116 struct percpu_stats {
 117         u64 nr_alloc;           /* lifetime # of allocations */
 118         u64 nr_dealloc;         /* lifetime # of deallocations */
 119         u64 nr_cur_alloc;       /* current # of allocations */
 120         u64 nr_max_alloc;       /* max # of live allocations */
 121         u32 nr_chunks;          /* current # of live chunks */
 122         u32 nr_max_chunks;      /* max # of live chunks */
 123         size_t min_alloc_size;  /* min allocaiton size */
 124         size_t max_alloc_size;  /* max allocation size */
 125 };
 126
 127 extern struct percpu_stats pcpu_stats;
 128 extern struct pcpu_alloc_info pcpu_stats_ai;
 129
 130 /*
 131  * For debug purposes. We don't care about the flexible array.
 132  */
 133 static inline void pcpu_stats_save_ai(const struct pcpu_alloc_info *ai)
 134 {
 135         memcpy(&pcpu_stats_ai, ai, sizeof(struct pcpu_alloc_info));
 136
 137         /* initialize min_alloc_size to unit_size */
 138         pcpu_stats.min_alloc_size = pcpu_stats_ai.unit_size;
 139 }
 140
 141 /*
 142  * pcpu_stats_area_alloc - increment area allocation stats
 143  * @chunk: the location of the area being allocated
 144  * @size: size of area to allocate in bytes
 145  *
 146  * CONTEXT:
 147  * pcpu_lock.
 148  */
 149 static inline void pcpu_stats_area_alloc(struct pcpu_chunk *chunk, size_t size)
 150 {
 151         lockdep_assert_held(&pcpu_lock);
 152
 153         pcpu_stats.nr_alloc++;
 154         pcpu_stats.nr_cur_alloc++;
 155         pcpu_stats.nr_max_alloc =
 156                 max(pcpu_stats.nr_max_alloc, pcpu_stats.nr_cur_alloc);
 157         pcpu_stats.min_alloc_size =
 158                 min(pcpu_stats.min_alloc_size, size);
 159         pcpu_stats.max_alloc_size =
 160                 max(pcpu_stats.max_alloc_size, size);
 161
 162         chunk->nr_alloc++;
 163         chunk->max_alloc_size = max(chunk->max_alloc_size, size);
 164 }
 165
 166 /*
 167  * pcpu_stats_area_dealloc - decrement allocation stats
 168  * @chunk: the location of the area being deallocated
 169  *
 170  * CONTEXT:
 171  * pcpu_lock.
 172  */
 173 static inline void pcpu_stats_area_dealloc(struct pcpu_chunk *chunk)
 174 {
 175         lockdep_assert_held(&pcpu_lock);
 176
 177         pcpu_stats.nr_dealloc++;
 178         pcpu_stats.nr_cur_alloc--;
 179
 180         chunk->nr_alloc--;
 181 }
 182
 183 /*
 184  * pcpu_stats_chunk_alloc - increment chunk stats
 185  */
 186 static inline void pcpu_stats_chunk_alloc(void)
 187 {
 188         unsigned long flags;
 189         spin_lock_irqsave(&pcpu_lock, flags);
 190
 191         pcpu_stats.nr_chunks++;
 192         pcpu_stats.nr_max_chunks =
 193                 max(pcpu_stats.nr_max_chunks, pcpu_stats.nr_chunks);
 194
 195         spin_unlock_irqrestore(&pcpu_lock, flags);
 196 }
 197
 198 /*
 199  * pcpu_stats_chunk_dealloc - decrement chunk stats
 200  */
 201 static inline void pcpu_stats_chunk_dealloc(void)
 202 {
 203         unsigned long flags;
 204         spin_lock_irqsave(&pcpu_lock, flags);
 205
 206         pcpu_stats.nr_chunks--;
 207
 208         spin_unlock_irqrestore(&pcpu_lock, flags);
 209 }
 210
 211 #else
 212
 213 static inline void pcpu_stats_save_ai(const struct pcpu_alloc_info *ai)
 214 {
 215 }
 216
 217 static inline void pcpu_stats_area_alloc(struct pcpu_chunk *chunk, size_t size)
 218 {
 219 }
 220
 221 static inline void pcpu_stats_area_dealloc(struct pcpu_chunk *chunk)
 222 {
 223 }
 224
 225 static inline void pcpu_stats_chunk_alloc(void)
 226 {
 227 }
 228
 229 static inline void pcpu_stats_chunk_dealloc(void)
 230 {
 231 }
 232
 233 #endif /* !CONFIG_PERCPU_STATS */
 234
 235 #endif