xref: /titanic_44/usr/src/lib/udapl/udapl_tavor/include/dapl_ring_buffer_util.h (revision 9e39c5ba00a55fa05777cc94b148296af305e135)
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 /*
23  * Copyright (c) 2002-2003, Network Appliance, Inc. All rights reserved.
24  */
25 
26 /*
27  * Copyright 2003 Sun Microsystems, Inc.  All rights reserved.
28  * Use is subject to license terms.
29  */
30 
31 /*
32  *
33  * HEADER: dapl_ring_buffer_util.h
34  *
35  * PURPOSE: Utility defs & routines for the ring buffer data structure
36  *
37  * $Id: dapl_ring_buffer_util.h,v 1.5 2003/06/13 12:21:11 sjs2 Exp $
38  *
39  */
40 
41 #ifndef _DAPL_RING_BUFFER_H_
42 #define	_DAPL_RING_BUFFER_H_
43 
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
47 
48 #include "dapl.h"
49 
50 /*
51  * Prototypes
52  */
53 DAT_RETURN dapls_rbuf_alloc(
54 	DAPL_RING_BUFFER		*rbuf,
55 	DAT_COUNT			 size);
56 
57 DAT_RETURN dapls_rbuf_realloc(
58 	DAPL_RING_BUFFER		*rbuf,
59 	DAT_COUNT			 size);
60 
61 void dapls_rbuf_destroy(
62 	DAPL_RING_BUFFER		*rbuf);
63 
64 DAT_RETURN dapls_rbuf_add(
65 	DAPL_RING_BUFFER		*rbuf,
66 	void				*entry);
67 
68 void * dapls_rbuf_remove(
69 	DAPL_RING_BUFFER		*rbuf);
70 
71 DAT_COUNT dapls_rbuf_count(
72 	DAPL_RING_BUFFER		*rbuf);
73 
74 
75 /*
76  * Simple functions
77  */
78 #define	dapls_rbuf_empty(rbuf)	((rbuf)->head == (rbuf)->tail)
79 
80 #ifdef __cplusplus
81 }
82 #endif
83 
84 #endif /* _DAPL_RING_BUFFER_H_ */
85