xref: /illumos-gate/usr/src/cmd/fs.d/ufs/roll_log/roll_log.h (revision 45ede40b2394db7967e59f19288fae9b62efd4aa)
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 (c) 1996,1997,2001 by Sun Microsystems, Inc.
24  * All rights reserved.
25  */
26 
27 #ifndef	_ROLL_LOG_H
28 #define	_ROLL_LOG_H
29 
30 #pragma ident	"%Z%%M%	%I%	%E% SMI"
31 
32 #include <sys/fs/ufs_fs.h>
33 
34 #ifdef	__cplusplus
35 extern "C" {
36 #endif
37 
38 /*
39  * This file contains definitions for the module that rolls the Unix File
40  * System log.
41  */
42 
43 /*
44  * rl_result_t defines the type of the value that is returned by all roll
45  * log functions.
46  */
47 
48 typedef enum rl_result {
49 	/*
50 	 * Choose values so that all passing returns are >= 0, and all
51 	 * failing returns are < 0.
52 	 */
53 
54 	RL_CORRUPT = -4,		/* Corrupted on disk structure. */
55 	RL_FAIL = -3,			/* Generic failure. */
56 	RL_SYSERR = -2,			/* Failing system call. */
57 	RL_FALSE = -1,
58 	RL_SUCCESS = 0,
59 	RL_TRUE = 1
60 } rl_result_t;
61 
62 /* Functions defined in roll_log.c */
63 
64 extern rl_result_t	rl_roll_log(char *dev);
65 extern rl_result_t	rl_log_control(char *dev, int request);
66 
67 #ifdef	__cplusplus
68 }
69 #endif
70 
71 #endif	/* _ROLL_LOG_H */
72