2 .\" Copyright (c) 2009, Sun Microsystems Inc. All Rights Reserved.
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
4 .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with
5 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH LIST_CREATE 9F "Sep 17, 2009"
8 list_create, list_destroy, list_insert_after, list_insert_before,
9 list_insert_head, list_insert_tail, list_remove, list_remove_head,
10 list_remove_tail, list_head, list_tail, list_next, list_prev, list_is_empty,
11 list_link_init, list_link_active, list_move_tail, list_link_replace \- list
18 \fBvoid\fR \fBlist_create\fR(\fBlist_t *\fR \fIlist\fR, \fBsize_t\fR \fIsize\fR, \fBsize_t\fR \fIoffset\fR);
23 \fBvoid\fR \fBlist_destroy\fR(\fBlist_t *\fR \fIlist\fR);
28 \fBvoid\fR \fBlist_insert_after\fR(\fBlist_t *\fR \fIlist\fR, \fBvoid *\fR\fIreference_item\fR,
29 \fBvoid *\fR\fInew_item\fR);
34 \fBvoid\fR \fBlist_insert_before\fR(\fBlist_t *\fR \fIlist\fR, \fBvoid *\fR\fIreference_item\fR,
35 \fBvoid *\fR\fInew_item\fR);
40 \fBvoid\fR \fBlist_insert_head\fR(\fBlist_t *\fR \fIlist\fR*, \fBvoid *\fR\fInew_item\fR);
45 \fBvoid\fR \fBlist_insert_tail\fR(\fBlist_t *\fR \fIlist\fR, \fBvoid *\fR\fInew_item\fR);
50 \fBvoid\fR \fBlist_remove\fR(\fBlist_t *\fR \fIlist\fR, \fBvoid *\fRitem);
55 \fBvoid *\fR\fBlist_remove_head\fR(\fBlist_t *\fR \fIlist\fR);
60 \fBvoid *\fR\fBlist_remove_tail\fR(\fBlist_t *\fR \fIlist\fR);
65 \fBvoid *\fR\fBlist_head\fR(\fBlist_t *\fR \fIlist\fR);
70 \fBvoid *\fR\fBlist_tail\fR(\fBlist_t *\fR \fIlist\fR);
75 \fBvoid *\fR\fBlist_next\fR(\fBlist_t *\fR \fIlist\fR, \fBvoid *\fR\fIreference_item\fR);
80 \fBvoid *\fR\fBlist_prev\fR(\fBlist_t *\fR \fIlist\fR, \fBvoid *\fR\fIreference_item\fR);
85 \fBint\fR \fBlist_is_empty\fR(\fBlist_t *\fR \fIlist\fR);
90 \fBvoid\fR \fBlist_link_init\fR(\fBlist_node_t *\fR\fInode\fR);
95 \fBint\fR \fBlist_link_active\fR(\fBlist_node_t *\fR\fInode\fR);
100 \fBvoid\fR \fBlist_move_tail\fR(\fBlist_t *\fR\fIdst\fR, \fBlist_t *\fR\fIsrc\fR);
105 \fBvoid\fR \fBlist_link_replace\fR(\fBlist_node_t *\fR\fInode1\fR, \fBlist_node_t *\fR\fInode2\fR);
111 The \fBlist_create()\fR function initializes a new list. The driver supplies
112 the storage for the list handle, the size of an individual element, and the
113 offset of a \fBlist_node_t\fR within the element to use for the links of the
117 The \fBlist_destroy()\fR function destroys the list handle, including freeing
118 any resources that may have been internally allocated for the list. The list
119 must be empty when this function is called.
122 The \fBlist_insert_after()\fR and \fBlist_insert_before()\fR functions insert
123 \fInew_item\fR into the linked list at a location after or before the reference
124 item, which must already be on the list.
127 The \fBlist_insert_head()\fR and \fBlist_insert_tail()\fR functions insert the
128 \fInew_item\fR on the list at either the head or tail of the list. (The head
129 is the first item, the tail is the last item).
132 The \fBlist_remove()\fR function removes the item from the list.
135 The \fBlist_remove_head()\fR and \fBlist_remove_tail()\fR functions remove the
136 head (first) or tail (last) item from the list. The item removed is returned to
137 the caller. If the list is empty when these functions are called, then no
138 change is made and \fINULL\fR is returned to the caller.
141 The \fBlist_head()\fR and \fBlist_tail()\fR functions simply return the head
142 (first) or tail (last) item on the list. \fINULL\fR is returned if the list is
146 The \fBlist_next()\fR and \fBlist_prev()\fR functions return the next or
147 previous item in the list, relative to the named reference item which must be
151 The \fBlist_is_empty()\fR function returns 0 if the list has items in it, or
155 The \fBlist_link_init()\fR function initializes the \fBlist_node_t\fR. It is
156 functionally equivalent to \fBbzero\fR(\fInode\fR, \fBsizeof\fR(*\fInode\fR));
159 The \fBlist_link_active()\fR function returns non-zero if the node is on an
163 The \fBlist_move_tail()\fR function is used to append the items on the
164 \fIsrc\fR list to the end of the \fIdst\fR list. It is mandatory that the two
165 lists were initialized using identical size and offset parameters. Upon
166 completion, the \fIsrc\fR list will be empty.
169 The \fBlist_link_replace()\fR function swaps two items on a list. Note that
170 the items need not be on the same list, but extreme care must be used to ensure
171 that both lists are protected from concurrent accesses and that the lists were
172 initialized with identical size and offset parameters.
176 See \fBattributes\fR(5) for descriptions of the following attributes:
184 ATTRIBUTE TYPE ATTRIBUTE VALUE
186 Interface Stability Committed