RepoMirrors/ceph
1
0
Fork 0
mirror of https://github.com/ceph/ceph synced 2025-01-03 01:22:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: add doxygen help for crush_destroy_{rule,bucket)

Browse Source 
Signed-off-by: Loic Dachary <ldachary@redhat.com>
This commit is contained in:
Loic Dachary 2017-02-19 10:24:13 +01:00
parent fd99312680
commit 1859742b34
2 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/crush/builder.h
View File

@ -55,6 +55,9 @@ extern void crush_finalize(struct crush_map *map);
* crush_find_rule() when looking for a rule and by
* __CRUSH_RULE_CHOOSE*__ steps when looking for items.
*
* The caller is responsible for deallocating the returned pointer via
* crush_destroy_rule().
*
* If __malloc(3)__ fails, return NULL.
*
* @param len number of steps in the rule
@ -151,6 +154,9 @@ extern int crush_add_bucket(struct crush_map *map,
* to have a weight equal to __weights[0]__, otherwise the weight of
* __items[x]__ is set to be the value of __weights[x]__.
*
* The caller is responsible for deallocating the returned pointer via
* crush_destroy_bucket().
*
* @param map __unused__
* @param alg algorithm for item selection
* @param hash always set to CRUSH_HASH_RJENKINS1
@ -158,6 +164,8 @@ extern int crush_add_bucket(struct crush_map *map,
* @param size of the __items__ array
* @param items array of __size__ items
* @param weights the weight of each item in __items__, depending on __alg__
*
* @returns a pointer to the newly created bucket or NULL
*/
struct crush_bucket *crush_make_bucket(struct crush_map *map, int alg, int hash, int type, int size, int *items, int *weights);
/** @ingroup API

12
src/crush/crush.h
View File

@ -393,7 +393,19 @@ extern void crush_destroy_bucket_list(struct crush_bucket_list *b);
extern void crush_destroy_bucket_tree(struct crush_bucket_tree *b);
extern void crush_destroy_bucket_straw(struct crush_bucket_straw *b);
extern void crush_destroy_bucket_straw2(struct crush_bucket_straw2 *b);
/** @ingroup API
*
* Deallocate a bucket created via crush_add_bucket().
*
* @param bucket the bucket to deallocate
*/
extern void crush_destroy_bucket(struct crush_bucket *b);
/** @ingroup API
*
* Deallocate a rule created via crush_add_rule().
*
* @param r the rule to deallocate
*/
extern void crush_destroy_rule(struct crush_rule *r);
/** @ingroup API
*