1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License (the "License").
   6  * You may not use this file except in compliance with the License.
   7  *
   8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9  * or http://www.opensolaris.org/os/licensing.
  10  * See the License for the specific language governing permissions
  11  * and limitations under the License.
  12  *
  13  * When distributing Covered Code, include this CDDL HEADER in each
  14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15  * If applicable, add the following below this CDDL HEADER, with the
  16  * fields enclosed by brackets "[]" replaced with your own identifying
  17  * information: Portions Copyright [yyyy] [name of copyright owner]
  18  *
  19  * CDDL HEADER END
  20  */
  21 /*
  22  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
  23  * Use is subject to license terms.
  24  */
  25 /*
  26  * Copyright 2013 Saso Kiselkov, All rights reserved.
  27  */
  28 
  29 #ifndef _SYS_LIST_H
  30 #define _SYS_LIST_H
  31 
  32 #include <sys/list_impl.h>
  33 
  34 #ifdef  __cplusplus
  35 extern "C" {
  36 #endif
  37 
  38 /*
  39  * Please note that a list_node_t contains pointers back to its parent list_t
  40  * so you cannot copy the list_t around once it has been initialized. In
  41  * particular, this kind of construct won't work:
  42  *
  43  * struct { list_t l; } a, b;
  44  * list_create(&a.l, ...);
  45  * b = a;    <= This will break the list in `b', as the `l' element in `a'
  46  *              got copied to a different memory address.
  47  *
  48  * When copying structures with lists use list_move_tail() to move the list
  49  * from the src to dst (the source reference will then become invalid).
  50  */
  51 typedef struct list_node list_node_t;
  52 typedef struct list list_t;
  53 
  54 void list_create(list_t *, size_t, size_t);
  55 void list_destroy(list_t *);
  56 
  57 void list_insert_after(list_t *, void *, void *);
  58 void list_insert_before(list_t *, void *, void *);
  59 void list_insert_head(list_t *, void *);
  60 void list_insert_tail(list_t *, void *);
  61 void list_remove(list_t *, void *);
  62 void *list_remove_head(list_t *);
  63 void *list_remove_tail(list_t *);
  64 void list_move_tail(list_t *, list_t *);
  65 
  66 void *list_head(list_t *);
  67 void *list_tail(list_t *);
  68 void *list_next(list_t *, void *);
  69 void *list_prev(list_t *, void *);
  70 int list_is_empty(list_t *);
  71 
  72 void list_link_init(list_node_t *);
  73 void list_link_replace(list_node_t *, list_node_t *);
  74 
  75 int list_link_active(list_node_t *);
  76 
  77 #ifdef  __cplusplus
  78 }
  79 #endif
  80 
  81 #endif  /* _SYS_LIST_H */