xiaomi-sm8450/android_kernel_xiaomi_sm8450
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Documentation: Add flexible-arrays.rst to the documentation tree

Browse Source 
Add flexible-arrays.rst to Documentation/core-api. Add kernel-doc
comments to allow referencing.

Signed-off-by: sayli karnik <karniksayli1995@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
sayli karnik
2017-03-30 02:01:16 +05:30
committed by Jonathan Corbet
parent 3f816bac24
commit b2e33536c0
3 changed files with 198 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
include/linux/flex_array.h
View File

@@ -61,16 +61,83 @@ struct flex_array {
FLEX_ARRAY_ELEMENTS_PER_PART(__element_size)); \
}
/**
* flex_array_alloc() - Creates a flexible array.
* @element_size: individual object size.
* @total: maximum number of objects which can be stored.
* @flags: GFP flags
*
* Return: Returns an object of structure flex_array.
*/
struct flex_array *flex_array_alloc(int element_size, unsigned int total,
gfp_t flags);
/**
* flex_array_prealloc() - Ensures that memory for the elements indexed in the
* range defined by start and nr_elements has been allocated.
* @fa: array to allocate memory to.
* @start: start address
* @nr_elements: number of elements to be allocated.
* @flags: GFP flags
*
*/
int flex_array_prealloc(struct flex_array *fa, unsigned int start,
unsigned int nr_elements, gfp_t flags);
/**
* flex_array_free() - Removes all elements of a flexible array.
* @fa: array to be freed.
*/
void flex_array_free(struct flex_array *fa);
/**
* flex_array_free_parts() - Removes all elements of a flexible array, but
* leaves the array itself in place.
* @fa: array to be emptied.
*/
void flex_array_free_parts(struct flex_array *fa);
/**
* flex_array_put() - Stores data into a flexible array.
* @fa: array where element is to be stored.
* @element_nr: position to copy, must be less than the maximum specified when
* the array was created.
* @src: data source to be copied into the array.
* @flags: GFP flags
*
* Return: Returns zero on success, a negative error code otherwise.
*/
int flex_array_put(struct flex_array *fa, unsigned int element_nr, void *src,
gfp_t flags);
/**
* flex_array_clear() - Clears an individual element in the array, sets the
* given element to FLEX_ARRAY_FREE.
* @element_nr: element position to clear.
* @fa: array to which element to be cleared belongs.
*
* Return: Returns zero on success, -EINVAL otherwise.
*/
int flex_array_clear(struct flex_array *fa, unsigned int element_nr);
/**
* flex_array_get() - Retrieves data into a flexible array.
*
* @element_nr: Element position to retrieve data from.
* @fa: array from which data is to be retrieved.
*
* Return: Returns a pointer to the data element, or NULL if that
* particular element has never been allocated.
*/
void *flex_array_get(struct flex_array *fa, unsigned int element_nr);
/**
* flex_array_shrink() - Reduces the allocated size of an array.
* @fa: array to shrink.
*
* Return: Returns number of pages of memory actually freed.
*
*/
int flex_array_shrink(struct flex_array *fa);
#define flex_array_put_ptr(fa, nr, src, gfp) \