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