xref: /onnv-gate/usr/src/cmd/fs.d/ufs/roll_log/roll_log.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright (c) 1996,1997,2001 by Sun Microsystems, Inc.
24*0Sstevel@tonic-gate  * All rights reserved.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #ifndef	_ROLL_LOG_H
28*0Sstevel@tonic-gate #define	_ROLL_LOG_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate #include <sys/fs/ufs_fs.h>
33*0Sstevel@tonic-gate 
34*0Sstevel@tonic-gate #ifdef	__cplusplus
35*0Sstevel@tonic-gate extern "C" {
36*0Sstevel@tonic-gate #endif
37*0Sstevel@tonic-gate 
38*0Sstevel@tonic-gate /*
39*0Sstevel@tonic-gate  * This file contains definitions for the module that rolls the Unix File
40*0Sstevel@tonic-gate  * System log.
41*0Sstevel@tonic-gate  */
42*0Sstevel@tonic-gate 
43*0Sstevel@tonic-gate /*
44*0Sstevel@tonic-gate  * rl_result_t defines the type of the value that is returned by all roll
45*0Sstevel@tonic-gate  * log functions.
46*0Sstevel@tonic-gate  */
47*0Sstevel@tonic-gate 
48*0Sstevel@tonic-gate typedef enum rl_result {
49*0Sstevel@tonic-gate 	/*
50*0Sstevel@tonic-gate 	 * Choose values so that all passing returns are >= 0, and all
51*0Sstevel@tonic-gate 	 * failing returns are < 0.
52*0Sstevel@tonic-gate 	 */
53*0Sstevel@tonic-gate 
54*0Sstevel@tonic-gate 	RL_CORRUPT = -4,		/* Corrupted on disk structure. */
55*0Sstevel@tonic-gate 	RL_FAIL = -3,			/* Generic failure. */
56*0Sstevel@tonic-gate 	RL_SYSERR = -2,			/* Failing system call. */
57*0Sstevel@tonic-gate 	RL_FALSE = -1,
58*0Sstevel@tonic-gate 	RL_SUCCESS = 0,
59*0Sstevel@tonic-gate 	RL_TRUE = 1
60*0Sstevel@tonic-gate } rl_result_t;
61*0Sstevel@tonic-gate 
62*0Sstevel@tonic-gate /* Functions defined in roll_log.c */
63*0Sstevel@tonic-gate 
64*0Sstevel@tonic-gate extern rl_result_t	rl_roll_log(char *dev);
65*0Sstevel@tonic-gate extern rl_result_t	rl_log_control(char *dev, int request);
66*0Sstevel@tonic-gate 
67*0Sstevel@tonic-gate #ifdef	__cplusplus
68*0Sstevel@tonic-gate }
69*0Sstevel@tonic-gate #endif
70*0Sstevel@tonic-gate 
71*0Sstevel@tonic-gate #endif	/* _ROLL_LOG_H */
72