xref: /onnv-gate/usr/src/lib/librsm/inc/rsmlib_in.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright 2001-2002 Sun Microsystems, Inc.  All rights reserved.
24*0Sstevel@tonic-gate  * Use is subject to license terms.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #ifndef _RSMLIB_IN_H
28*0Sstevel@tonic-gate #define	_RSMLIB_IN_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate #ifdef	__cplusplus
33*0Sstevel@tonic-gate extern "C" {
34*0Sstevel@tonic-gate #endif
35*0Sstevel@tonic-gate 
36*0Sstevel@tonic-gate #include <sys/types.h>
37*0Sstevel@tonic-gate #include <sys/mman.h>
38*0Sstevel@tonic-gate #include <sys/stat.h>
39*0Sstevel@tonic-gate #include <fcntl.h>
40*0Sstevel@tonic-gate 
41*0Sstevel@tonic-gate #define	LOOPBACK "loopback"
42*0Sstevel@tonic-gate #define	DEVRSM "/dev/rsm"
43*0Sstevel@tonic-gate #define	RSMSEGIDFILE	"/etc/rsm/rsm.segmentid"
44*0Sstevel@tonic-gate #define	RSMSEG_RESERVED	"reserved"
45*0Sstevel@tonic-gate 
46*0Sstevel@tonic-gate #define	RSM_IMPORT_SEG	1
47*0Sstevel@tonic-gate #define	RSM_EXPORT_SEG	2
48*0Sstevel@tonic-gate 
49*0Sstevel@tonic-gate #define	RSM_MAX_HANDLE_DVMA	0x2000
50*0Sstevel@tonic-gate 
51*0Sstevel@tonic-gate /* This is the default barrier implementation structure */
52*0Sstevel@tonic-gate typedef struct {
53*0Sstevel@tonic-gate 	rsmseg_handle_t	*rsmgenbar_seg;
54*0Sstevel@tonic-gate 	uint16_t	rsmgenbar_gen;
55*0Sstevel@tonic-gate 	rsm_barrier_t	*rsmgenbar_data;
56*0Sstevel@tonic-gate }rsmgenbar_handle_t;
57*0Sstevel@tonic-gate 
58*0Sstevel@tonic-gate #define	RSM_MAX_BUCKETS		128 /* # buckets in the hash table */
59*0Sstevel@tonic-gate #define	RSM_POLLFD_PER_CHUNK	16  /* # pollfd in each chunk */
60*0Sstevel@tonic-gate 
61*0Sstevel@tonic-gate /* least significant 3 bytes of the fd should be unique enough */
62*0Sstevel@tonic-gate #define	RSM_POLLFD_HASH(fd)	(((fd) ^ ((fd) >> 8) ^ ((fd) >> 16)) % \
63*0Sstevel@tonic-gate 		RSM_MAX_BUCKETS)
64*0Sstevel@tonic-gate 
65*0Sstevel@tonic-gate /*
66*0Sstevel@tonic-gate  * pollfd_table maintains a mapping from fd to resource number. It also
67*0Sstevel@tonic-gate  * provides a mechanism to check if a given fd corresponds to an rsmapi
68*0Sstevel@tonic-gate  * segment. Entries get added to this table as a result of
69*0Sstevel@tonic-gate  * rsm_memseg_get_pollfd and removed as a result of rsm_memseg_release_pollfd.
70*0Sstevel@tonic-gate  */
71*0Sstevel@tonic-gate typedef struct {
72*0Sstevel@tonic-gate 	int		fd;
73*0Sstevel@tonic-gate 	minor_t		segrnum;
74*0Sstevel@tonic-gate }rsm_pollfd_element_t;
75*0Sstevel@tonic-gate 
76*0Sstevel@tonic-gate typedef struct rsm_pollfd_chunk {
77*0Sstevel@tonic-gate 	struct rsm_pollfd_chunk	*next;
78*0Sstevel@tonic-gate 	int			nfree;
79*0Sstevel@tonic-gate 	rsm_pollfd_element_t	fdarray[RSM_POLLFD_PER_CHUNK];
80*0Sstevel@tonic-gate } rsm_pollfd_chunk_t;
81*0Sstevel@tonic-gate 
82*0Sstevel@tonic-gate typedef struct {
83*0Sstevel@tonic-gate 	mutex_t			lock;
84*0Sstevel@tonic-gate 	rsm_pollfd_chunk_t	*buckets[RSM_MAX_BUCKETS];
85*0Sstevel@tonic-gate } rsm_pollfd_table_t;
86*0Sstevel@tonic-gate 
87*0Sstevel@tonic-gate /*
88*0Sstevel@tonic-gate  * The following macros are defined only if the DEBUG flag is enabled
89*0Sstevel@tonic-gate  * The macro makes use of category and level values defined in rsm.h
90*0Sstevel@tonic-gate  * and the dbg_printf function defined in rsmlib.c (defined as an
91*0Sstevel@tonic-gate  * extern below)
92*0Sstevel@tonic-gate  */
93*0Sstevel@tonic-gate #ifdef	DEBUG
94*0Sstevel@tonic-gate #define	TRACELOG "/tmp/librsm.log"
95*0Sstevel@tonic-gate #define	DBPRINTF(msg) dbg_printf msg
96*0Sstevel@tonic-gate #else
97*0Sstevel@tonic-gate #define	TRACELOG
98*0Sstevel@tonic-gate #define	DBPRINTF(msg)
99*0Sstevel@tonic-gate #endif
100*0Sstevel@tonic-gate 
101*0Sstevel@tonic-gate extern void dbg_printf(int category, int level, char *fmt, ...);
102*0Sstevel@tonic-gate 
103*0Sstevel@tonic-gate typedef int (*rsm_attach_entry_t)(int, rsm_segops_t **);
104*0Sstevel@tonic-gate 
105*0Sstevel@tonic-gate #ifdef	__cplusplus
106*0Sstevel@tonic-gate }
107*0Sstevel@tonic-gate #endif
108*0Sstevel@tonic-gate 
109*0Sstevel@tonic-gate #endif	/* _RSMLIB_IN_H */
110