Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit ec26b805 authored by Mike Travis's avatar Mike Travis Committed by Rusty Russell
Browse files

cpumask: documentation for cpumask_var_t 



Impact: New kerneldoc comments

Additional documentation added to all the alloc_cpumask and free_cpumask
functions.

Signed-off-by: default avatarMike Travis <travis@sgi.com>
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> (minor additions)
parent 7b4967c5

lib/cpumask.c

+43 −0
Original line number Diff line number Diff line
@@ -76,6 +76,20 @@ int cpumask_any_but(const struct cpumask *mask, unsigned int cpu) 


/* These are not inline because of header tangles. */

#ifdef CONFIG_CPUMASK_OFFSTACK

/**

 * alloc_cpumask_var_node - allocate a struct cpumask on a given node

 * @mask: pointer to cpumask_var_t where the cpumask is returned

 * @flags: GFP_ flags

 *

 * Only defined when CONFIG_CPUMASK_OFFSTACK=y, otherwise is

 * a nop returning a constant 1 (in <linux/cpumask.h>)

 * Returns TRUE if memory allocation succeeded, FALSE otherwise.

 *

 * In addition, mask will be NULL if this fails.  Note that gcc is

 * usually smart enough to know that mask can never be NULL if

 * CONFIG_CPUMASK_OFFSTACK=n, so does code elimination in that case

 * too.

 */

bool alloc_cpumask_var_node(cpumask_var_t *mask, gfp_t flags, int node)

{

	if (likely(slab_is_available()))
@@ -97,23 +111,52 @@ bool alloc_cpumask_var_node(cpumask_var_t *mask, gfp_t flags, int node) 
}

EXPORT_SYMBOL(alloc_cpumask_var_node);



/**

 * alloc_cpumask_var - allocate a struct cpumask

 * @mask: pointer to cpumask_var_t where the cpumask is returned

 * @flags: GFP_ flags

 *

 * Only defined when CONFIG_CPUMASK_OFFSTACK=y, otherwise is

 * a nop returning a constant 1 (in <linux/cpumask.h>).

 *

 * See alloc_cpumask_var_node.

 */

bool alloc_cpumask_var(cpumask_var_t *mask, gfp_t flags)

{

	return alloc_cpumask_var_node(mask, flags, numa_node_id());

}

EXPORT_SYMBOL(alloc_cpumask_var);



/**

 * alloc_bootmem_cpumask_var - allocate a struct cpumask from the bootmem arena.

 * @mask: pointer to cpumask_var_t where the cpumask is returned

 *

 * Only defined when CONFIG_CPUMASK_OFFSTACK=y, otherwise is

 * a nop returning a constant 1 (in <linux/cpumask.h>)

 * Either returns an allocated (zero-filled) cpumask, or causes the

 * system to panic.

 */

void __init alloc_bootmem_cpumask_var(cpumask_var_t *mask)

{

	*mask = alloc_bootmem(cpumask_size());

}



/**

 * free_cpumask_var - frees memory allocated for a struct cpumask.

 * @mask: cpumask to free

 *

 * This is safe on a NULL mask.

 */

void free_cpumask_var(cpumask_var_t mask)

{

	kfree(mask);

}

EXPORT_SYMBOL(free_cpumask_var);



/**

 * free_bootmem_cpumask_var - frees result of alloc_bootmem_cpumask_var

 * @mask: cpumask to free

 */

void __init free_bootmem_cpumask_var(cpumask_var_t mask)

{

	free_bootmem((unsigned long)mask, cpumask_size());