xref: /onnv-gate/usr/src/cmd/cmd-inet/usr.lib/dsvclockd/datastore.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 (c) 2000 by Sun Microsystems, Inc.
24*0Sstevel@tonic-gate  * All rights reserved.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #ifndef	DSVCD_DATASTORE_H
28*0Sstevel@tonic-gate #define	DSVCD_DATASTORE_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/types.h>
33*0Sstevel@tonic-gate #include <synch.h>
34*0Sstevel@tonic-gate #include <door.h>
35*0Sstevel@tonic-gate 
36*0Sstevel@tonic-gate #include "container.h"
37*0Sstevel@tonic-gate 
38*0Sstevel@tonic-gate /*
39*0Sstevel@tonic-gate  * Datastore-related data structures, functions and constants.  See
40*0Sstevel@tonic-gate  * comments in datastore.c for a description of how to use the exported
41*0Sstevel@tonic-gate  * functions.
42*0Sstevel@tonic-gate  */
43*0Sstevel@tonic-gate 
44*0Sstevel@tonic-gate #ifdef	__cplusplus
45*0Sstevel@tonic-gate extern "C" {
46*0Sstevel@tonic-gate #endif
47*0Sstevel@tonic-gate 
48*0Sstevel@tonic-gate #define	DSVCD_DS_HASH_SIZE	100
49*0Sstevel@tonic-gate 
50*0Sstevel@tonic-gate /*
51*0Sstevel@tonic-gate  * A linked list of dsvcd_container_t structures.  Contains a lock,
52*0Sstevel@tonic-gate  * `cl_lock', which is used for controlling manipulation of `cl_head'.
53*0Sstevel@tonic-gate  */
54*0Sstevel@tonic-gate typedef struct {
55*0Sstevel@tonic-gate 	mutex_t			cl_lock;	/* protects the list */
56*0Sstevel@tonic-gate 	dsvcd_container_t	*cl_head;	/* linked list of containers */
57*0Sstevel@tonic-gate 	uint8_t			cl_pad[8];	/* prevent false sharing */
58*0Sstevel@tonic-gate } dsvcd_container_list_t;
59*0Sstevel@tonic-gate 
60*0Sstevel@tonic-gate /*
61*0Sstevel@tonic-gate  * Describes the underlying datastore itself.  There is exactly one
62*0Sstevel@tonic-gate  * dsvcd_datastore_t per datastore using doors (so currently, there are
63*0Sstevel@tonic-gate  * two: one for `ds_files' and one for `ds_data').  Contains per-datastore
64*0Sstevel@tonic-gate  * information, like the door descriptor being used by dsvclockd to listen
65*0Sstevel@tonic-gate  * to requests for this datastore, the datastore name, and a list of all
66*0Sstevel@tonic-gate  * open containers for this datastore.  Instances of this data structure
67*0Sstevel@tonic-gate  * are allocated when dsvclockd is started.
68*0Sstevel@tonic-gate  */
69*0Sstevel@tonic-gate typedef struct dsvcd_datastore {
70*0Sstevel@tonic-gate 	char			*ds_name;	/* datastore name */
71*0Sstevel@tonic-gate 	int			ds_doorfd;	/* datastore door */
72*0Sstevel@tonic-gate 
73*0Sstevel@tonic-gate 	/*
74*0Sstevel@tonic-gate 	 * This hash is used to speed up the open() routine so that a given
75*0Sstevel@tonic-gate 	 * container can be located quicker.  Hash based on the filename,
76*0Sstevel@tonic-gate 	 * and use it as an index into the array..
77*0Sstevel@tonic-gate 	 */
78*0Sstevel@tonic-gate 	dsvcd_container_list_t	ds_hash[DSVCD_DS_HASH_SIZE];
79*0Sstevel@tonic-gate } dsvcd_datastore_t;
80*0Sstevel@tonic-gate 
81*0Sstevel@tonic-gate typedef void dsvcd_svc_t(void *, dsvcd_request_t *, size_t, door_desc_t *,
82*0Sstevel@tonic-gate 	uint_t);
83*0Sstevel@tonic-gate 
84*0Sstevel@tonic-gate extern dsvcd_datastore_t *ds_create(const char *, dsvcd_svc_t *);
85*0Sstevel@tonic-gate extern void ds_destroy(dsvcd_datastore_t *);
86*0Sstevel@tonic-gate extern unsigned int ds_reap_containers(dsvcd_datastore_t *, unsigned int);
87*0Sstevel@tonic-gate extern void ds_release_container(dsvcd_datastore_t *, dsvcd_container_t *);
88*0Sstevel@tonic-gate extern dsvcd_container_t *ds_get_container(dsvcd_datastore_t *, const char *,
89*0Sstevel@tonic-gate     boolean_t);
90*0Sstevel@tonic-gate 
91*0Sstevel@tonic-gate #ifdef	__cplusplus
92*0Sstevel@tonic-gate }
93*0Sstevel@tonic-gate #endif
94*0Sstevel@tonic-gate 
95*0Sstevel@tonic-gate #endif	/* DSVCD_DATASTORE_H */
96