xref: /titanic_41/usr/src/cmd/lvm/metassist/layout/layout.h (revision b3697b90e692e3e5d859fb77d285d4c056d99eda)
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 2003 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #ifndef _VOLUME_LAYOUT_H
28 #define	_VOLUME_LAYOUT_H
29 
30 #pragma ident	"%Z%%M%	%I%	%E% SMI"
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
36 #include "volume_request.h"
37 #include "volume_defaults.h"
38 
39 /*
40  * FUNCTION:	get_layout(devconfig_t *request, defaults_t *defaults)
41  *
42  * INPUT:	request	- a devconfig_t pointer to the toplevel request
43  *		defaults - a results_t pointer to the defaults
44  *
45  * RETURNS:	int	-  0 - on success
46  *			  !0 - otherwise
47  *
48  * PURPOSE:	Public entry point to layout module.
49  */
50 extern int get_layout(request_t *request, defaults_t *defaults);
51 
52 /*
53  * FUNCTION:	layout_clean_up()
54  * INPUT:
55  * OUTPUT:
56  * SIDEEFFECTS:	releases all memory allocated during layout processing
57  *
58  * PURPOSE:	function which handles the details of cleaning up memory
59  *		allocated while processing a request.
60  *
61  *		This function must be called explicitly if a call to
62  *		get_layout() was terminated abnormally, for example,
63  *		if the user terminates the calling process with a SIGINT.
64  */
65 extern void layout_clean_up();
66 
67 #ifdef __cplusplus
68 }
69 #endif
70 
71 #endif /* _VOLUME_LAYOUT_H */
72