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