xref: /illumos-gate/usr/src/cmd/dumpadm/dconf.h (revision 30fdefb82f3ce27d19928cb02b9a265b2c321a49)
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 (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright (c) 1998, 2010, Oracle and/or its affiliates. All rights reserved.
23  * Copyright 2015 Nexenta Systems, Inc. All rights reserved.
24  * Copyright 2024 MNX Cloud, Inc.
25  */
26 
27 #ifndef	_DCONF_H
28 #define	_DCONF_H
29 
30 #include <sys/types.h>
31 #include <sys/param.h>
32 #include <stdio.h>
33 #include <stdbool.h>
34 
35 #ifdef	__cplusplus
36 extern "C" {
37 #endif
38 
39 typedef struct dumpconf {
40 	char dc_device[MAXPATHLEN];	/* Dump device path */
41 	char dc_savdir[MAXPATHLEN];	/* Savecore dir path */
42 	int dc_cflags;			/* Config flags (see <sys/dumpadm.h>) */
43 	int dc_enable;			/* Run savecore on boot? (see below) */
44 	int dc_csave;			/* Save dump compressed? (see below) */
45 	int dc_mode;			/* Mode flags (see below) */
46 	FILE *dc_conf_fp;		/* File pointer for config file */
47 	int dc_conf_fd;			/* File descriptor for config file */
48 	int dc_dump_fd;			/* File descriptor for dump device */
49 	bool dc_readonly;		/* Readonly conf file */
50 	bool dc_parsable;		/* Parsable values */
51 	bool dc_headers;		/* Print headers */
52 } dumpconf_t;
53 
54 /*
55  * Values for dc_enable (run savecore on boot) property:
56  */
57 #define	DC_OFF		0		/* Savecore disabled */
58 #define	DC_ON		1		/* Savecore enabled */
59 
60 /*
61  * Values for dc_csave (savecore compressed) property:
62  */
63 #define	DC_UNCOMPRESSED	0		/* Savecore uncompresses the dump */
64 #define	DC_COMPRESSED	1		/* Savecore leaves dump compressed */
65 
66 /*
67  * Values for dconf_open mode:
68  */
69 #define	DC_CURRENT	1		/* Kernel overrides file settings */
70 #define	DC_OVERRIDE	2		/* File+defaults override kernel */
71 
72 extern int dconf_open(dumpconf_t *, const char *, const char *, int);
73 extern int dconf_getdev(dumpconf_t *);
74 extern int dconf_close(dumpconf_t *);
75 extern int dconf_write(dumpconf_t *);
76 extern int dconf_update(dumpconf_t *, int);
77 extern void dconf_print(dumpconf_t *, FILE *);
78 extern int dconf_write_uuid(dumpconf_t *);
79 extern int dconf_get_dumpsize(dumpconf_t *);
80 
81 extern int dconf_str2device(dumpconf_t *, char *);
82 extern int dconf_str2savdir(dumpconf_t *, char *);
83 extern int dconf_str2content(dumpconf_t *, char *);
84 extern int dconf_str2enable(dumpconf_t *, char *);
85 extern int dconf_str2csave(dumpconf_t *, char *);
86 
87 #ifdef	__cplusplus
88 }
89 #endif
90 
91 #endif	/* _DCONF_H */
92