xref: /titanic_51/usr/src/lib/libipmp/common/ipmp.h (revision e11c3f44f531fdff80941ce57c065d2ae861cefc)
17c478bd9Sstevel@tonic-gate /*
27c478bd9Sstevel@tonic-gate  * CDDL HEADER START
37c478bd9Sstevel@tonic-gate  *
47c478bd9Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*e11c3f44Smeem  * Common Development and Distribution License (the "License").
6*e11c3f44Smeem  * You may not use this file except in compliance with the License.
77c478bd9Sstevel@tonic-gate  *
87c478bd9Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
97c478bd9Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
107c478bd9Sstevel@tonic-gate  * See the License for the specific language governing permissions
117c478bd9Sstevel@tonic-gate  * and limitations under the License.
127c478bd9Sstevel@tonic-gate  *
137c478bd9Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
147c478bd9Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
157c478bd9Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
167c478bd9Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
177c478bd9Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
187c478bd9Sstevel@tonic-gate  *
197c478bd9Sstevel@tonic-gate  * CDDL HEADER END
207c478bd9Sstevel@tonic-gate  */
217c478bd9Sstevel@tonic-gate /*
22*e11c3f44Smeem  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
237c478bd9Sstevel@tonic-gate  * Use is subject to license terms.
247c478bd9Sstevel@tonic-gate  */
257c478bd9Sstevel@tonic-gate 
267c478bd9Sstevel@tonic-gate #ifndef _IPMP_H
277c478bd9Sstevel@tonic-gate #define	_IPMP_H
287c478bd9Sstevel@tonic-gate 
297c478bd9Sstevel@tonic-gate /*
307c478bd9Sstevel@tonic-gate  * General IPMP-related definitions and functions.
317c478bd9Sstevel@tonic-gate  *
327c478bd9Sstevel@tonic-gate  * These interfaces may only be used within ON or after signing a contract
337c478bd9Sstevel@tonic-gate  * with ON.  For documentation, refer to PSARC/2002/615.
347c478bd9Sstevel@tonic-gate  */
357c478bd9Sstevel@tonic-gate 
367c478bd9Sstevel@tonic-gate #ifdef __cplusplus
377c478bd9Sstevel@tonic-gate extern "C" {
387c478bd9Sstevel@tonic-gate #endif
397c478bd9Sstevel@tonic-gate 
407c478bd9Sstevel@tonic-gate #include <sys/sysevent/ipmp.h>
417c478bd9Sstevel@tonic-gate 
427c478bd9Sstevel@tonic-gate /*
437c478bd9Sstevel@tonic-gate  * IPMP library error codes.
447c478bd9Sstevel@tonic-gate  */
457c478bd9Sstevel@tonic-gate enum {
467c478bd9Sstevel@tonic-gate 	IPMP_SUCCESS,		/* operation succeeded */
477c478bd9Sstevel@tonic-gate 	IPMP_FAILURE,		/* operation failed (check errno) */
487c478bd9Sstevel@tonic-gate 	IPMP_EMINRED,		/* minimum failover redundancy not met */
497c478bd9Sstevel@tonic-gate 	IPMP_EFBDISABLED,	/* failback disabled */
50*e11c3f44Smeem 	IPMP_EUNKADDR,		/* unknown IPMP data address */
517c478bd9Sstevel@tonic-gate 	IPMP_EINVAL,		/* invalid argument */
527c478bd9Sstevel@tonic-gate 	IPMP_ENOMEM,		/* out of memory */
537c478bd9Sstevel@tonic-gate 	IPMP_ENOMPATHD,		/* cannot contact in.mpathd */
547c478bd9Sstevel@tonic-gate 	IPMP_EUNKGROUP,		/* unknown IPMP group */
557c478bd9Sstevel@tonic-gate 	IPMP_EUNKIF,		/* interface is not using IPMP */
567c478bd9Sstevel@tonic-gate 	IPMP_EPROTO,		/* unable to communicate with in.mpathd */
57*e11c3f44Smeem 	IPMP_EHWADDRDUP,	/* interface has duplicate hardware address */
587c478bd9Sstevel@tonic-gate 	IPMP_NERR		/* number of error codes */
597c478bd9Sstevel@tonic-gate };
607c478bd9Sstevel@tonic-gate 
617c478bd9Sstevel@tonic-gate typedef struct ipmp_state *ipmp_handle_t;
627c478bd9Sstevel@tonic-gate 
637c478bd9Sstevel@tonic-gate extern int ipmp_open(ipmp_handle_t *);
647c478bd9Sstevel@tonic-gate extern void ipmp_close(ipmp_handle_t);
657c478bd9Sstevel@tonic-gate extern const char *ipmp_errmsg(int);
667c478bd9Sstevel@tonic-gate 
677c478bd9Sstevel@tonic-gate #ifdef __cplusplus
687c478bd9Sstevel@tonic-gate }
697c478bd9Sstevel@tonic-gate #endif
707c478bd9Sstevel@tonic-gate 
717c478bd9Sstevel@tonic-gate #endif /* _IPMP_H */
72