244781f10dcd82684fd8163c016540667842f203Prakash Surya * CDDL HEADER START
244781f10dcd82684fd8163c016540667842f203Prakash Surya * This file and its contents are supplied under the terms of the
244781f10dcd82684fd8163c016540667842f203Prakash Surya * Common Development and Distribution License ("CDDL"), version 1.0.
244781f10dcd82684fd8163c016540667842f203Prakash Surya * You may only use this file in accordance with the terms of version
244781f10dcd82684fd8163c016540667842f203Prakash Surya * 1.0 of the CDDL.
244781f10dcd82684fd8163c016540667842f203Prakash Surya * A full copy of the text of the CDDL should have accompanied this
244781f10dcd82684fd8163c016540667842f203Prakash Surya * source. A copy of the CDDL is also available via the Internet at
244781f10dcd82684fd8163c016540667842f203Prakash Surya * CDDL HEADER END
244781f10dcd82684fd8163c016540667842f203Prakash Surya * Copyright (c) 2013, 2014 by Delphix. All rights reserved.
244781f10dcd82684fd8163c016540667842f203Prakash Suryatypedef struct multilist_sublist multilist_sublist_t;
244781f10dcd82684fd8163c016540667842f203Prakash Suryatypedef unsigned int multilist_sublist_index_func_t(multilist_t *, void *);
244781f10dcd82684fd8163c016540667842f203Prakash Surya * The mutex used internally to implement thread safe insertions
244781f10dcd82684fd8163c016540667842f203Prakash Surya * and removals to this individual sublist. It can also be locked
244781f10dcd82684fd8163c016540667842f203Prakash Surya * by a consumer using multilist_sublist_{lock,unlock}, which is
244781f10dcd82684fd8163c016540667842f203Prakash Surya * useful if a consumer needs to traverse the list in a thread
244781f10dcd82684fd8163c016540667842f203Prakash Surya * safe manner.
244781f10dcd82684fd8163c016540667842f203Prakash Surya * The actual list object containing all objects in this sublist.
244781f10dcd82684fd8163c016540667842f203Prakash Surya * Pad to cache line (64 bytes), in an effort to try and prevent
244781f10dcd82684fd8163c016540667842f203Prakash Surya * cache line contention.
244781f10dcd82684fd8163c016540667842f203Prakash Surya * This is used to get to the multilist_node_t structure given
244781f10dcd82684fd8163c016540667842f203Prakash Surya * the void *object contained on the list.
244781f10dcd82684fd8163c016540667842f203Prakash Surya * The number of sublists used internally by this multilist.
244781f10dcd82684fd8163c016540667842f203Prakash Surya * The array of pointers to the actual sublists.
244781f10dcd82684fd8163c016540667842f203Prakash Surya * Pointer to function which determines the sublist to use
244781f10dcd82684fd8163c016540667842f203Prakash Surya * when inserting and removing objects from this multilist.
244781f10dcd82684fd8163c016540667842f203Prakash Surya * Please see the comment above multilist_create for details.
244781f10dcd82684fd8163c016540667842f203Prakash Surya multilist_sublist_index_func_t *ml_index_func;
244781f10dcd82684fd8163c016540667842f203Prakash Suryavoid multilist_create(multilist_t *, size_t, size_t, unsigned int,
244781f10dcd82684fd8163c016540667842f203Prakash Suryaunsigned int multilist_get_num_sublists(multilist_t *);
244781f10dcd82684fd8163c016540667842f203Prakash Suryaunsigned int multilist_get_random_index(multilist_t *);
244781f10dcd82684fd8163c016540667842f203Prakash Suryamultilist_sublist_t *multilist_sublist_lock(multilist_t *, unsigned int);
244781f10dcd82684fd8163c016540667842f203Prakash Suryavoid multilist_sublist_unlock(multilist_sublist_t *);
244781f10dcd82684fd8163c016540667842f203Prakash Suryavoid multilist_sublist_insert_head(multilist_sublist_t *, void *);
244781f10dcd82684fd8163c016540667842f203Prakash Suryavoid multilist_sublist_insert_tail(multilist_sublist_t *, void *);
244781f10dcd82684fd8163c016540667842f203Prakash Suryavoid multilist_sublist_move_forward(multilist_sublist_t *mls, void *obj);
244781f10dcd82684fd8163c016540667842f203Prakash Suryavoid multilist_sublist_remove(multilist_sublist_t *, void *);
244781f10dcd82684fd8163c016540667842f203Prakash Suryavoid *multilist_sublist_head(multilist_sublist_t *);
244781f10dcd82684fd8163c016540667842f203Prakash Suryavoid *multilist_sublist_tail(multilist_sublist_t *);
244781f10dcd82684fd8163c016540667842f203Prakash Suryavoid *multilist_sublist_next(multilist_sublist_t *, void *);
244781f10dcd82684fd8163c016540667842f203Prakash Suryavoid *multilist_sublist_prev(multilist_sublist_t *, void *);
244781f10dcd82684fd8163c016540667842f203Prakash Surya#endif /* _SYS_MULTILIST_H */