xref: /illumos-gate/usr/src/lib/libds/common/libds.h (revision 30588217a56ff2c9137248fb2e5065c4f0101459)
1*30588217SMike Christensen /*
2*30588217SMike Christensen  * CDDL HEADER START
3*30588217SMike Christensen  *
4*30588217SMike Christensen  * The contents of this file are subject to the terms of the
5*30588217SMike Christensen  * Common Development and Distribution License (the "License").
6*30588217SMike Christensen  * You may not use this file except in compliance with the License.
7*30588217SMike Christensen  *
8*30588217SMike Christensen  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9*30588217SMike Christensen  * or http://www.opensolaris.org/os/licensing.
10*30588217SMike Christensen  * See the License for the specific language governing permissions
11*30588217SMike Christensen  * and limitations under the License.
12*30588217SMike Christensen  *
13*30588217SMike Christensen  * When distributing Covered Code, include this CDDL HEADER in each
14*30588217SMike Christensen  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15*30588217SMike Christensen  * If applicable, add the following below this CDDL HEADER, with the
16*30588217SMike Christensen  * fields enclosed by brackets "[]" replaced with your own identifying
17*30588217SMike Christensen  * information: Portions Copyright [yyyy] [name of copyright owner]
18*30588217SMike Christensen  *
19*30588217SMike Christensen  * CDDL HEADER END
20*30588217SMike Christensen  */
21*30588217SMike Christensen /*
22*30588217SMike Christensen  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
23*30588217SMike Christensen  * Use is subject to license terms.
24*30588217SMike Christensen  */
25*30588217SMike Christensen 
26*30588217SMike Christensen #ifndef	_LIBDS_H
27*30588217SMike Christensen #define	_LIBDS_H
28*30588217SMike Christensen 
29*30588217SMike Christensen #ifdef	__cplusplus
30*30588217SMike Christensen extern "C" {
31*30588217SMike Christensen #endif
32*30588217SMike Christensen 
33*30588217SMike Christensen #include <sys/types.h>
34*30588217SMike Christensen 
35*30588217SMike Christensen /*
36*30588217SMike Christensen  * LDOMs User Domain Services library Interfaces
37*30588217SMike Christensen  */
38*30588217SMike Christensen 
39*30588217SMike Christensen typedef uint64_t	ds_hdl_t;		/* service handle */
40*30588217SMike Christensen typedef uint64_t	ds_domain_hdl_t;	/* domain handle */
41*30588217SMike Christensen typedef void		*ds_cb_arg_t;		/* client callback arg */
42*30588217SMike Christensen 
43*30588217SMike Christensen #define	DS_INVALID_HDL	(0)		/* a ds handle cannot be zero */
44*30588217SMike Christensen 
45*30588217SMike Christensen /*
46*30588217SMike Christensen  * LDOMs User Domain Services versioning
47*30588217SMike Christensen  */
48*30588217SMike Christensen typedef struct ds_ver {
49*30588217SMike Christensen 	uint16_t	major;
50*30588217SMike Christensen 	uint16_t	minor;
51*30588217SMike Christensen } ds_ver_t;
52*30588217SMike Christensen 
53*30588217SMike Christensen /*
54*30588217SMike Christensen  * LDOMs User Domain Services capability
55*30588217SMike Christensen  */
56*30588217SMike Christensen typedef struct ds_capability {
57*30588217SMike Christensen 	char		*svc_id;	/* service identifier */
58*30588217SMike Christensen 	ds_ver_t	*vers;		/* list of supported versions */
59*30588217SMike Christensen 	uint_t		nvers;		/* number of supported versions */
60*30588217SMike Christensen } ds_capability_t;
61*30588217SMike Christensen 
62*30588217SMike Christensen /*
63*30588217SMike Christensen  * LDOMs User Domain Services event callbacks
64*30588217SMike Christensen  */
65*30588217SMike Christensen typedef struct ds_ops {
66*30588217SMike Christensen 	void (*ds_reg_cb)(ds_hdl_t hdl, ds_cb_arg_t arg, ds_ver_t *ver,
67*30588217SMike Christensen 	    ds_domain_hdl_t dhdl);
68*30588217SMike Christensen 	void (*ds_unreg_cb)(ds_hdl_t hdl, ds_cb_arg_t arg);
69*30588217SMike Christensen 	void (*ds_data_cb)(ds_hdl_t hdl, ds_cb_arg_t arg, void *buf,
70*30588217SMike Christensen 	    size_t buflen);
71*30588217SMike Christensen 	ds_cb_arg_t cb_arg;
72*30588217SMike Christensen } ds_ops_t;
73*30588217SMike Christensen 
74*30588217SMike Christensen extern int ds_init(void);
75*30588217SMike Christensen extern int ds_svc_reg(ds_capability_t *cap, ds_ops_t *ops);
76*30588217SMike Christensen extern int ds_clnt_reg(ds_capability_t *cap, ds_ops_t *ops);
77*30588217SMike Christensen extern int ds_hdl_lookup(char *service, boolean_t is_client, ds_hdl_t *hdlsp,
78*30588217SMike Christensen     uint_t maxhdls, uint_t *nhdlsp);
79*30588217SMike Christensen extern int ds_domain_lookup(ds_hdl_t hdl, ds_domain_hdl_t *dhdlp);
80*30588217SMike Christensen extern int ds_unreg_hdl(ds_hdl_t hdl);
81*30588217SMike Christensen extern int ds_send_msg(ds_hdl_t hdl, void *buf, size_t buflen);
82*30588217SMike Christensen extern int ds_recv_msg(ds_hdl_t hdl, void *buf, size_t buflen,
83*30588217SMike Christensen     size_t *msglen);
84*30588217SMike Christensen extern int ds_isready(ds_hdl_t hdl, boolean_t *is_ready);
85*30588217SMike Christensen extern int ds_dom_name_to_hdl(char *domain_name, ds_domain_hdl_t *dhdlp);
86*30588217SMike Christensen extern int ds_dom_hdl_to_name(ds_domain_hdl_t dhdl, char *domain_name,
87*30588217SMike Christensen     uint_t maxnamlen);
88*30588217SMike Christensen extern void ds_unreg_svc(char *service, boolean_t is_client);
89*30588217SMike Christensen extern void ds_fini(void);
90*30588217SMike Christensen 
91*30588217SMike Christensen #ifdef	__cplusplus
92*30588217SMike Christensen }
93*30588217SMike Christensen #endif
94*30588217SMike Christensen 
95*30588217SMike Christensen #endif	/* _LIBDS_H */
96