xref: /onnv-gate/usr/src/uts/common/nfs/nfs4_idmap_impl.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 2004 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 _NFS4_IDMAP_IMPL_H
28*0Sstevel@tonic-gate #define	_NFS4_IDMAP_IMPL_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate #include <sys/list.h>
33*0Sstevel@tonic-gate #include <sys/door.h>
34*0Sstevel@tonic-gate 
35*0Sstevel@tonic-gate /*
36*0Sstevel@tonic-gate  * This is a private header file.  Applications should not directly include
37*0Sstevel@tonic-gate  * this file.
38*0Sstevel@tonic-gate  */
39*0Sstevel@tonic-gate 
40*0Sstevel@tonic-gate #ifdef	__cplusplus
41*0Sstevel@tonic-gate extern "C" {
42*0Sstevel@tonic-gate #endif
43*0Sstevel@tonic-gate 
44*0Sstevel@tonic-gate /*
45*0Sstevel@tonic-gate  * Cache Entry Definitions
46*0Sstevel@tonic-gate  */
47*0Sstevel@tonic-gate #define	NFSID_CACHE_ANCHORS	256
48*0Sstevel@tonic-gate 
49*0Sstevel@tonic-gate typedef struct nfsidmap {
50*0Sstevel@tonic-gate 	struct nfsidmap *id_chain[2];	/* must be first */
51*0Sstevel@tonic-gate 	time_t		 id_time;	/* time stamp */
52*0Sstevel@tonic-gate 	uid_t		 id_no;		/* uid/gid */
53*0Sstevel@tonic-gate 	utf8string	 id_str;	/* user@domain string */
54*0Sstevel@tonic-gate } nfsidmap_t;
55*0Sstevel@tonic-gate 
56*0Sstevel@tonic-gate #define	id_forw			id_chain[0]
57*0Sstevel@tonic-gate #define	id_back			id_chain[1]
58*0Sstevel@tonic-gate #define	id_len			id_str.utf8string_len
59*0Sstevel@tonic-gate #define	id_val			id_str.utf8string_val
60*0Sstevel@tonic-gate 
61*0Sstevel@tonic-gate typedef struct nfsidhq {
62*0Sstevel@tonic-gate 	union {
63*0Sstevel@tonic-gate 		struct nfsidhq	*hq_head[2];	/* for empty queue */
64*0Sstevel@tonic-gate 		struct nfsidmap *hq_chain[2];	/* for LRU list */
65*0Sstevel@tonic-gate 	} hq_link;
66*0Sstevel@tonic-gate 	kmutex_t	hq_lock;		/* protects hash queue */
67*0Sstevel@tonic-gate } nfsidhq_t;
68*0Sstevel@tonic-gate 
69*0Sstevel@tonic-gate #define	hq_que_forw		hq_link.hq_head[0]
70*0Sstevel@tonic-gate #define	hq_que_back		hq_link.hq_head[1]
71*0Sstevel@tonic-gate #define	hq_lru_forw		hq_link.hq_chain[0]
72*0Sstevel@tonic-gate #define	hq_lru_back		hq_link.hq_chain[1]
73*0Sstevel@tonic-gate 
74*0Sstevel@tonic-gate typedef struct {
75*0Sstevel@tonic-gate 	const char	*name;		/* cache name */
76*0Sstevel@tonic-gate 	nfsidhq_t	*table;		/* hash table */
77*0Sstevel@tonic-gate 	/*
78*0Sstevel@tonic-gate 	 * Since we need to know the status of nfsmapid from random functions
79*0Sstevel@tonic-gate 	 * that deal with idmap caches, we keep a pointer to the relevant fields
80*0Sstevel@tonic-gate 	 * in the zone's globals so we don't have to keep passing them around.
81*0Sstevel@tonic-gate 	 */
82*0Sstevel@tonic-gate 	door_handle_t		*nfsidmap_daemon_dh;
83*0Sstevel@tonic-gate } idmap_cache_info_t;
84*0Sstevel@tonic-gate 
85*0Sstevel@tonic-gate typedef enum hash_stat { HQ_HASH_HINT, HQ_HASH_FIND } hash_stat;
86*0Sstevel@tonic-gate 
87*0Sstevel@tonic-gate /*
88*0Sstevel@tonic-gate  * Per-zone modular globals
89*0Sstevel@tonic-gate  */
90*0Sstevel@tonic-gate struct nfsidmap_globals {
91*0Sstevel@tonic-gate 	list_node_t		nig_link; /* linkage into global list */
92*0Sstevel@tonic-gate 	enum clnt_stat		nig_last_stat;	/* status of last RPC call */
93*0Sstevel@tonic-gate 	int			nig_msg_done;	/* have we printed a message? */
94*0Sstevel@tonic-gate 	idmap_cache_info_t	u2s_ci;	/* table mapping uid-to-string */
95*0Sstevel@tonic-gate 	idmap_cache_info_t	s2u_ci;	/* table mapping string-to-uid */
96*0Sstevel@tonic-gate 	idmap_cache_info_t	g2s_ci;	/* table mapping groupid-to-string */
97*0Sstevel@tonic-gate 	idmap_cache_info_t	s2g_ci;	/* table mapping string-to-groupid */
98*0Sstevel@tonic-gate 	pid_t			nfsidmap_pid;
99*0Sstevel@tonic-gate 	kmutex_t		nfsidmap_daemon_lock;
100*0Sstevel@tonic-gate 	/*
101*0Sstevel@tonic-gate 	 * nfsidmap_daemon_lock protects the following:
102*0Sstevel@tonic-gate 	 * 	nfsidmap_daemon_dh
103*0Sstevel@tonic-gate 	 */
104*0Sstevel@tonic-gate 	door_handle_t		nfsidmap_daemon_dh;
105*0Sstevel@tonic-gate };
106*0Sstevel@tonic-gate 
107*0Sstevel@tonic-gate #ifdef	__cplusplus
108*0Sstevel@tonic-gate }
109*0Sstevel@tonic-gate #endif
110*0Sstevel@tonic-gate 
111*0Sstevel@tonic-gate #endif /* _NFS4_IDMAP_IMPL_H */
112