xref: /onnv-gate/usr/src/lib/libipmp/common/ipmp.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 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 _IPMP_H
28*0Sstevel@tonic-gate #define	_IPMP_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate /*
33*0Sstevel@tonic-gate  * General IPMP-related definitions and functions.
34*0Sstevel@tonic-gate  *
35*0Sstevel@tonic-gate  * These interfaces may only be used within ON or after signing a contract
36*0Sstevel@tonic-gate  * with ON.  For documentation, refer to PSARC/2002/615.
37*0Sstevel@tonic-gate  */
38*0Sstevel@tonic-gate 
39*0Sstevel@tonic-gate #ifdef __cplusplus
40*0Sstevel@tonic-gate extern "C" {
41*0Sstevel@tonic-gate #endif
42*0Sstevel@tonic-gate 
43*0Sstevel@tonic-gate #include <sys/sysevent/ipmp.h>
44*0Sstevel@tonic-gate 
45*0Sstevel@tonic-gate /*
46*0Sstevel@tonic-gate  * IPMP library error codes.
47*0Sstevel@tonic-gate  */
48*0Sstevel@tonic-gate enum {
49*0Sstevel@tonic-gate 	IPMP_SUCCESS,		/* operation succeeded */
50*0Sstevel@tonic-gate 	IPMP_FAILURE,		/* operation failed (check errno) */
51*0Sstevel@tonic-gate 	IPMP_EMINRED,		/* minimum failover redundancy not met */
52*0Sstevel@tonic-gate 	IPMP_EFBDISABLED,	/* failback disabled */
53*0Sstevel@tonic-gate 	IPMP_EFBPARTIAL,	/* unable to completely fail back */
54*0Sstevel@tonic-gate 	IPMP_EINVAL,		/* invalid argument */
55*0Sstevel@tonic-gate 	IPMP_ENOMEM,		/* out of memory */
56*0Sstevel@tonic-gate 	IPMP_ENOMPATHD,		/* cannot contact in.mpathd */
57*0Sstevel@tonic-gate 	IPMP_EUNKGROUP,		/* unknown IPMP group */
58*0Sstevel@tonic-gate 	IPMP_EUNKIF,		/* interface is not using IPMP */
59*0Sstevel@tonic-gate 	IPMP_EPROTO,		/* unable to communicate with in.mpathd */
60*0Sstevel@tonic-gate 	IPMP_NERR		/* number of error codes */
61*0Sstevel@tonic-gate };
62*0Sstevel@tonic-gate 
63*0Sstevel@tonic-gate typedef struct ipmp_state *ipmp_handle_t;
64*0Sstevel@tonic-gate 
65*0Sstevel@tonic-gate extern int ipmp_open(ipmp_handle_t *);
66*0Sstevel@tonic-gate extern void ipmp_close(ipmp_handle_t);
67*0Sstevel@tonic-gate extern const char *ipmp_errmsg(int);
68*0Sstevel@tonic-gate 
69*0Sstevel@tonic-gate #ifdef __cplusplus
70*0Sstevel@tonic-gate }
71*0Sstevel@tonic-gate #endif
72*0Sstevel@tonic-gate 
73*0Sstevel@tonic-gate #endif /* _IPMP_H */
74