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