1/*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 2011 Nathan Whitehorn
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 *    notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 */
28
29#ifndef _PARTEDIT_PARTEDIT_H
30#define _PARTEDIT_PARTEDIT_H
31
32#include <sys/queue.h>
33#include <inttypes.h>
34#include <fstab.h>
35
36#include "opt_osname.h"
37
38struct gprovider;
39struct gmesh;
40struct ggeom;
41
42TAILQ_HEAD(pmetadata_head, partition_metadata);
43extern struct pmetadata_head part_metadata;
44
45struct partition_metadata {
46	char *name;		/* name of this partition, as in GEOM */
47
48	struct fstab *fstab;	/* fstab data for this partition */
49	char *newfs;		/* shell command to initialize partition */
50
51	int bootcode;
52
53	TAILQ_ENTRY(partition_metadata) metadata;
54};
55
56struct partition_metadata *get_part_metadata(const char *name, int create);
57void delete_part_metadata(const char *name);
58
59int part_wizard(const char *fstype);
60int scripted_editor(int argc, const char **argv);
61char *boot_disk_select(struct gmesh *mesh);
62int wizard_makeparts(struct gmesh *mesh, const char *disk, const char *fstype,
63    int interactive);
64
65/* gpart operations */
66void gpart_delete(struct gprovider *pp);
67void gpart_destroy(struct ggeom *lg_geom);
68void gpart_edit(struct gprovider *pp);
69void gpart_create(struct gprovider *pp, const char *default_type,
70    const char *default_size, const char *default_mountpoint,
71    char **output, int interactive);
72intmax_t gpart_max_free(struct ggeom *gp, intmax_t *start);
73void gpart_revert(struct gprovider *pp);
74void gpart_revert_all(struct gmesh *mesh);
75void gpart_commit(struct gmesh *mesh);
76int gpart_partition(const char *lg_name, const char *scheme);
77void set_default_part_metadata(const char *name, const char *scheme,
78    const char *type, const char *mountpoint, const char *newfs);
79void gpart_set_root(const char *lg_name, const char *attribute);
80const char *choose_part_type(const char *def_scheme);
81
82/* machine-dependent bootability checks */
83const char *default_scheme(void);		/* Default partition scheme */
84int is_scheme_bootable(const char *scheme);	/* Non-zero if scheme boots */
85int is_fs_bootable(const char *scheme, const char *fs); /* Ditto if FS boots */
86
87/* Size of boot partition in bytes. Zero if no boot partition */
88size_t bootpart_size(const char *scheme);
89
90/*
91 * Type and mountpoint of boot partition for given scheme. If boot partition
92 * should not be mounted, set mountpoint to NULL or leave it unchanged.
93 * Note that mountpoint non-NULL implies partcode_path() will be ignored.
94 * Do *NOT* set both!
95 */
96const char *bootpart_type(const char *scheme, const char **mountpoint);
97
98/* Path to bootcode that goes in the scheme (e.g. disk MBR). NULL if none */
99const char *bootcode_path(const char *scheme);
100
101/*
102 * Path to boot blocks to be dd'ed into the partition suggested by bootpart_*
103 * for the given scheme and root filesystem type. If the boot partition should
104 * be mounted rather than dd'ed to, return NULL here.
105 */
106const char *partcode_path(const char *scheme, const char *fs_type);
107
108#endif
109