Blame view

include/linux/flex_array.h 2.43 KB
534acc057   Dave Hansen   lib: flexible arr...
1
2
3
4
  #ifndef _FLEX_ARRAY_H
  #define _FLEX_ARRAY_H
  
  #include <linux/types.h>
809fa972f   Hannes Frederic Sowa   reciprocal_divide...
5
  #include <linux/reciprocal_div.h>
534acc057   Dave Hansen   lib: flexible arr...
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
  #include <asm/page.h>
  
  #define FLEX_ARRAY_PART_SIZE PAGE_SIZE
  #define FLEX_ARRAY_BASE_SIZE PAGE_SIZE
  
  struct flex_array_part;
  
  /*
   * This is meant to replace cases where an array-like
   * structure has gotten too big to fit into kmalloc()
   * and the developer is getting tempted to use
   * vmalloc().
   */
  
  struct flex_array {
  	union {
  		struct {
  			int element_size;
  			int total_nr_elements;
704f15ddb   Jesse Gross   flex_array: avoid...
25
  			int elems_per_part;
809fa972f   Hannes Frederic Sowa   reciprocal_divide...
26
  			struct reciprocal_value reciprocal_elems;
8e7ee2709   David Rientjes   flex_array: decla...
27
  			struct flex_array_part *parts[];
534acc057   Dave Hansen   lib: flexible arr...
28
29
30
31
32
33
34
35
  		};
  		/*
  		 * This little trick makes sure that
  		 * sizeof(flex_array) == PAGE_SIZE
  		 */
  		char padding[FLEX_ARRAY_BASE_SIZE];
  	};
  };
45b588d6e   David Rientjes   flex_array: intro...
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
  /* Number of bytes left in base struct flex_array, excluding metadata */
  #define FLEX_ARRAY_BASE_BYTES_LEFT					\
  	(FLEX_ARRAY_BASE_SIZE - offsetof(struct flex_array, parts))
  
  /* Number of pointers in base to struct flex_array_part pages */
  #define FLEX_ARRAY_NR_BASE_PTRS						\
  	(FLEX_ARRAY_BASE_BYTES_LEFT / sizeof(struct flex_array_part *))
  
  /* Number of elements of size that fit in struct flex_array_part */
  #define FLEX_ARRAY_ELEMENTS_PER_PART(size)				\
  	(FLEX_ARRAY_PART_SIZE / size)
  
  /*
   * Defines a statically allocated flex array and ensures its parameters are
   * valid.
   */
  #define DEFINE_FLEX_ARRAY(__arrayname, __element_size, __total)		\
  	struct flex_array __arrayname = { { {				\
  		.element_size = (__element_size),			\
  		.total_nr_elements = (__total),				\
  	} } };								\
  	static inline void __arrayname##_invalid_parameter(void)	\
  	{								\
  		BUILD_BUG_ON((__total) > FLEX_ARRAY_NR_BASE_PTRS *	\
  			FLEX_ARRAY_ELEMENTS_PER_PART(__element_size));	\
  	}
534acc057   Dave Hansen   lib: flexible arr...
62

b62e408c0   David Rientjes   flex_array: conve...
63
64
65
  struct flex_array *flex_array_alloc(int element_size, unsigned int total,
  		gfp_t flags);
  int flex_array_prealloc(struct flex_array *fa, unsigned int start,
5d30b10bd   Eric Paris   flex_array: flex_...
66
  		unsigned int nr_elements, gfp_t flags);
534acc057   Dave Hansen   lib: flexible arr...
67
68
  void flex_array_free(struct flex_array *fa);
  void flex_array_free_parts(struct flex_array *fa);
b62e408c0   David Rientjes   flex_array: conve...
69
  int flex_array_put(struct flex_array *fa, unsigned int element_nr, void *src,
534acc057   Dave Hansen   lib: flexible arr...
70
  		gfp_t flags);
e6de3988a   David Rientjes   flex_array: add f...
71
  int flex_array_clear(struct flex_array *fa, unsigned int element_nr);
b62e408c0   David Rientjes   flex_array: conve...
72
  void *flex_array_get(struct flex_array *fa, unsigned int element_nr);
4af5a2f77   David Rientjes   flex_array: add f...
73
  int flex_array_shrink(struct flex_array *fa);
534acc057   Dave Hansen   lib: flexible arr...
74

ea98eed9b   Eric Paris   flex_array: add h...
75
  #define flex_array_put_ptr(fa, nr, src, gfp) \
c41ab6a1b   Eric Paris   flex_array: fix f...
76
  	flex_array_put(fa, nr, (void *)&(src), gfp)
ea98eed9b   Eric Paris   flex_array: add h...
77
78
  
  void *flex_array_get_ptr(struct flex_array *fa, unsigned int element_nr);
534acc057   Dave Hansen   lib: flexible arr...
79
  #endif /* _FLEX_ARRAY_H */