xref: /netbsd-src/usr.sbin/sysinst/defs.h (revision 3f351f34c6d827cf017cdcff3543f6ec0c88b420)
1 /*	$NetBSD: defs.h,v 1.90 2023/12/17 18:46:42 martin Exp $	*/
2 
3 /*
4  * Copyright 1997 Piermont Information Systems Inc.
5  * All rights reserved.
6  *
7  * Written by Philip A. Nelson for Piermont Information Systems Inc.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. The name of Piermont Information Systems Inc. may not be used to endorse
18  *    or promote products derived from this software without specific prior
19  *    written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY PIERMONT INFORMATION SYSTEMS INC. ``AS IS''
22  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED. IN NO EVENT SHALL PIERMONT INFORMATION SYSTEMS INC. BE
25  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
31  * THE POSSIBILITY OF SUCH DAMAGE.
32  *
33  */
34 
35 #ifndef _DEFS_H_
36 #define _DEFS_H_
37 
38 /* defs.h -- definitions for use in the sysinst program. */
39 
40 /* System includes needed for this. */
41 #include <sys/queue.h>
42 #include <sys/types.h>
43 #include <sys/disk.h>
44 #include <limits.h>
45 #include <uuid.h>
46 
47 const char *getfslabelname(uint, uint);
48 
49 #include "msg_defs.h"
50 #include "menu_defs.h"
51 #include "partitions.h"
52 
53 #define min(a,b)	((a) < (b) ? (a) : (b))
54 #define max(a,b)	((a) > (b) ? (a) : (b))
55 
56 /* constants */
57 #define MEG (1024UL * 1024UL)
58 #define GIG (1024UL * MEG)
59 #define STRSIZE		255
60 #define	MENUSTRSIZE	80
61 #define SSTRSIZE	30
62 #define	DISKNAMESIZE	24	/* max(strlen("/dev/rsd22c")) */
63 
64 /* these are used for different alignment defaults */
65 #define	HUGE_DISK_SIZE	(daddr_t)(128 * (GIG / 512))
66 #define	TINY_DISK_SIZE	(daddr_t)(1800 * (MEG / 512))
67 
68 /*
69  * if a system does not have more ram (in MB) than this, swap will be enabled
70  * very early (as soon as the swap partition has been created)
71  */
72 #ifdef	EXTRACT_NEEDS_BIG_RAM	/* we use an expensive decompressor */
73 #define	TINY_RAM_SIZE		256
74 #else
75 #define	TINY_RAM_SIZE		32
76 #endif
77 
78 /*
79  * if a system has less ram (in MB) than this, we will not create a
80  * tmpfs /tmp by default (to workaround PR misc/54886)
81  */
82 #define	SMALL_RAM_SIZE		384
83 
84 /* helper macros to create unique internal error messages */
85 #define STR_NO(STR)	#STR
86 #define	TO_STR(NO)	STR_NO(NO)
87 #define	INTERNAL_ERROR __FILE__ ":" TO_STR(__LINE__) ": internal error"
88 
89 /* For run.c: collect() */
90 #define T_FILE		0
91 #define T_OUTPUT	1
92 
93 /* Some install status/response values */
94 #define	SET_OK		0		/* Set extracted */
95 #define	SET_RETRY	1		/* Retry */
96 #define	SET_SKIP	2		/* Skip this set */
97 #define	SET_SKIP_GROUP	3		/* Skip this set and rest of group */
98 #define	SET_ABANDON	4		/* Abandon installation */
99 #define	SET_CONTINUE	5		/* Continue (copy from floppy loop) */
100 
101 /* run_prog flags */
102 #define RUN_DISPLAY	0x0001		/* Display program output */
103 #define RUN_FATAL	0x0002		/* errors are fatal */
104 #define RUN_CHROOT	0x0004		/* chroot to target disk */
105 #define RUN_FULLSCREEN	0x0008		/* fullscreen (use with RUN_DISPLAY) */
106 #define RUN_SILENT	0x0010		/* Do not show output */
107 #define RUN_ERROR_OK	0x0040		/* Don't wait for error confirmation */
108 #define RUN_PROGRESS	0x0080		/* Output is just progess test */
109 #define RUN_NO_CLEAR	0x0100		/* Leave program output after error */
110 #define RUN_XFER_DIR	0x0200		/* cd to xfer_dir in child */
111 #define	RUN_STDSCR	0x0400		/* run program in standard screen */
112 
113 /* for bsddisklabel.c */
114 enum layout_type {
115 	LY_KEEPEXISTING,	/* keep existing partitions */
116 	LY_OTHERSCHEME,		/* delete all, select new partitioning scheme */
117 	LY_SETSIZES,		/* edit sizes */
118 	LY_USEDEFAULT,		/* use default sizes */
119 	LY_USEFULL,		/* use full disk for NetBSD */
120 	LY_USENONE,		/* start with empty partitions, manual mode */
121 	LY_ERROR		/* used for "abort" in menu */
122 };
123 
124 enum setup_type { SY_NEWRAID, SY_NEWCGD, SY_NEWLVM };
125 
126 /* Installation sets */
127 enum {
128     SET_NONE,
129     SET_KERNEL_FIRST,
130     SET_KERNEL_1,	/* Usually GENERIC */
131     SET_KERNEL_2,	/* MD kernel... */
132     SET_KERNEL_3,	/* MD kernel... */
133     SET_KERNEL_4,	/* MD kernel... */
134     SET_KERNEL_5,	/* MD kernel... */
135     SET_KERNEL_6,	/* MD kernel... */
136     SET_KERNEL_7,	/* MD kernel... */
137     SET_KERNEL_8,	/* MD kernel... */
138     SET_KERNEL_9,	/* MD kernel... */
139     SET_KERNEL_LAST,	/* allow 9 kernels */
140 
141     /* System sets */
142     SET_BASE,		/* base */
143     SET_ETC,		/* /etc */
144     SET_COMPILER,	/* compiler tools */
145     SET_DTB,		/* devicetree hardware descriptions */
146     SET_GAMES,		/* text games */
147     SET_GPUFW,		/* GPU firmware files */
148     SET_MAN_PAGES,	/* online manual pages */
149     SET_MISC,		/* miscellaneuous */
150     SET_MODULES,	/* kernel modules */
151     SET_RESCUE,		/* /rescue recovery tools */
152     SET_TESTS,		/* tests */
153     SET_TEXT_TOOLS,	/* text processing tools */
154 
155     /* X11 sets */
156     SET_X11_FIRST,
157     SET_X11_BASE,	/* X11 base and clients */
158     SET_X11_FONTS,	/* X11 fonts */
159     SET_X11_SERVERS,	/* X11 servers */
160     SET_X11_PROG,	/* X11 programming */
161     SET_X11_ETC,	/* X11 config */
162     SET_X11_LAST,
163 
164     /* Machine dependent sets */
165     SET_MD_1,		/* Machine dependent set */
166     SET_MD_2,		/* Machine dependent set */
167     SET_MD_3,		/* Machine dependent set */
168     SET_MD_4,		/* Machine dependent set */
169 
170     /* Source sets */
171     SET_SYSSRC,
172     SET_SRC,
173     SET_SHARESRC,
174     SET_GNUSRC,
175     SET_XSRC,
176 
177     /* Debug sets */
178     SET_DEBUG,
179     SET_X11_DEBUG,
180 
181     SET_LAST,
182     SET_GROUP,		/* Start of submenu */
183     SET_GROUP_END,	/* End of submenu */
184     SET_PKGSRC,		/* pkgsrc, not counted as regular set */
185 };
186 
187 /* Initialisers to select sets */
188 /* All kernels */
189 #define SET_KERNEL SET_KERNEL_1, SET_KERNEL_2, SET_KERNEL_3, SET_KERNEL_4, \
190 		    SET_KERNEL_5, SET_KERNEL_6, SET_KERNEL_7, SET_KERNEL_8
191 #ifdef HAVE_MODULES
192 #define	WITH_MODULES	SET_MODULES,
193 #else
194 #define	WITH_MODULES
195 #endif
196 /* Core system sets */
197 #ifdef HAVE_DTB
198 #define	WITH_DTB	SET_DTB,
199 #else
200 #define	WITH_DTB
201 #endif
202 #define SET_CORE WITH_MODULES SET_BASE, WITH_DTB SET_GPUFW, SET_ETC
203 /* All system sets */
204 #define SET_SYSTEM SET_CORE, SET_COMPILER, SET_GAMES, \
205 		    SET_MAN_PAGES, SET_MISC, SET_RESCUE, \
206 		    SET_TESTS, SET_TEXT_TOOLS
207 /* All X11 sets */
208 #define SET_X11_NOSERVERS SET_X11_BASE, SET_X11_FONTS, SET_X11_PROG, SET_X11_ETC
209 #define SET_X11 SET_X11_NOSERVERS, SET_X11_SERVERS
210 
211 /* All machine dependent sets */
212 #define SET_MD SET_MD_1, SET_MD_2, SET_MD_3, SET_MD_4
213 
214 /* All source sets */
215 #define SET_SOURCE SET_SYSSRC, SET_SRC, SET_SHARESRC, SET_GNUSRC, SET_XSRC
216 
217 /* All debug sets */
218 #define SET_DEBUGGING SET_DEBUG, SET_X11_DEBUG
219 
220 /* Set list flags */
221 #define SFLAG_MINIMAL	1
222 #define	SFLAG_NOX	2
223 
224 /* Round up to the next full cylinder size */
225 #define NUMSEC(size, sizemult, cylsize) \
226 	((sizemult) == 1 ? (size) : \
227 	 roundup((size) * (sizemult), (cylsize)))
228 
229 /* What FS type? */
230 #define PI_ISBSDFS(PI) (PI_FSTYPE(PI) == FS_BSDLFS || \
231 		        PI_FSTYPE(PI) == FS_BSDFFS)
232 
233 /*
234  * We do not offer CDs or floppies as installation target usually.
235  * Architectures might want to undefine if they want to allow
236  * these devices or redefine if they have unusual CD device names.
237  * Do not define to empty or an empty string, undefine instead.
238  */
239 #define CD_NAMES "cd*"
240 #define FLOPPY_NAMES "fd*"
241 
242 /* Types */
243 
244 /* pass a void* argument into a menu and also provide a int return value */
245 typedef struct arg_rv {
246 	void *arg;
247 	int rv;
248 } arg_rv;
249 
250 /*
251  * A minimal argument for menus using string replacements
252  */
253 typedef struct arg_replace {
254 	const char **argv;
255 	size_t argc;
256 } arg_replace;
257 
258 /*
259  * pass a parameter array (for string replacements) into a menu and provide
260  * an integer return value
261  */
262 typedef struct arg_rep_int {
263 	arg_replace args;
264 	int rv;
265 } arg_rep_int;
266 
267 typedef struct distinfo {
268 	const char	*name;
269 	uint		set;
270 	bool		force_tgz;	/* this set is always in .tgz format */
271 	const char	*desc;
272 	const char	*marker_file;	/* set assumed installed if exists */
273 } distinfo;
274 
275 #define MOUNTLEN 20
276 
277 
278 /*
279  * A description of a future partition and its usage.
280  * A list of this is the output of the first stage partition
281  * editor, before it gets transformed into a concrete partition
282  * layout according to the partitioning scheme backend.
283  */
284 struct part_usage_info {
285 	daddr_t	size;			/* thumb guestimate of size,
286 					 * [sec if positive, %-of-ram
287 					 * if TMPFS and negative]
288 					 */
289 	daddr_t def_size;		/* default size */
290 	daddr_t limit;			/* max size */
291 	char 	mount[MOUNTLEN];	/* where will we mount this? */
292 	enum part_type type;		/* PT_root/PT_swap/PT_EFI_SYSTEM */
293 
294 #define	PUIFLAG_EXTEND		1	/* extend this part if free space
295 					 * is available */
296 #define	PUIFLAG_ADD_OUTER	2	/* Add this partition to the outer
297 					 * partitions (if available) */
298 #define	PUIFLG_IS_OUTER		4	/* this is an existing outer one */
299 #define	PUIFLG_ADD_INNER	8	/* add outer also to inner */
300 #define	PUIFLG_JUST_MOUNTPOINT	16	/* tmpfs of mfs mountpoints */
301 #define	PUIFLG_CLONE_PARTS	32	/* clone external partitions */
302 	uint flags;
303 	struct disk_partitions *parts;	/* Where does this partition live?
304 					 * We currently only support
305 					 * a single disk, but we plan to
306 					 * extend that.
307 					 * Use pm->parts to access
308 					 * the partitions. */
309 	part_id cur_part_id;		/* this may change, but we try to
310 					 * fix it up after all changes */
311 	daddr_t cur_start;		/* may change during editing, just
312 					 * used as a unique identifier */
313 	uint32_t cur_flags;		/* PTI_* flags from disk_part_info */
314 
315 #define PUIMNT_ASYNC		0x0001	/* mount -o async */
316 #define PUIMNT_NOATIME		0x0002	/* mount -o noatime */
317 #define PUIMNT_NODEV		0x0004	/* mount -o nodev */
318 #define PUIMNT_NODEVMTIME	0x0008	/* mount -o nodevmtime */
319 #define PUIMNT_NOEXEC		0x0010	/* mount -o noexec */
320 #define PUIMNT_NOSUID		0x0020	/* mount -o nosuid */
321 #define PUIMNT_LOG		0x0040	/* mount -o log */
322 #define PUIMNT_NOAUTO		0x0080	/* "noauto" fstab flag */
323 	unsigned int mountflags;	/* flags for fstab */
324 #define PUIINST_NEWFS	0x0001		/* need to 'newfs' partition */
325 #define PUIINST_MOUNT	0x0002		/* need to mount partition */
326 #define	PUIINST_BOOT	0x0004		/* this is a boot partition */
327 	unsigned int instflags;		/* installer handling flags */
328 	uint fs_type, fs_version;	/* e.g. FS_LFS, or FS_BSDFS,
329 					 * version = 2 for FFSv2 */
330 	uint fs_opt1, fs_opt2, fs_opt3;	/* FS specific, FFS: block/frag */
331 #ifndef	NO_CLONES
332 	/*
333 	 * Only != NULL when PUIFLG_CLONE_PARTS is set, describes the
334 	 * source partitions to clone here.
335 	 */
336 	struct selected_partitions *clone_src;
337 	/*
338 	 * If clone_src != NULL, this record corresponds to a single
339 	 * selected source partition, if clone_ndx is a valid index in clone_src
340 	 * (>= 0 && <= clone_src->num_sel, or all of them if clone_ndx = ~0U.
341 	 */
342 	size_t clone_ndx;
343 #endif
344 };
345 
346 /*
347  * A list of partition suggestions, bundled for editing
348  */
349 struct partition_usage_set {
350 	struct disk_partitions *parts;	/* main partition table */
351 	size_t num;			/* number of infos */
352 	struct part_usage_info *infos;	/* 0 .. num-1 */
353 	struct disk_partitions **write_back;
354 					/* partition tables from which we
355 					 * did delete some partitions and
356 					 * that need updating, even if
357 					 * no active partition remains. */
358 	size_t num_write_back;		/* number of write_back */
359 	daddr_t cur_free_space;		/* estimate of free sectors */
360 	daddr_t reserved_space;		/* space we are not allowed to use */
361 	menu_ent *menu_opts;		/* 0 .. num+N */
362 	int menu;			/* the menu to edit this */
363 	bool ok;			/* ok to continue (all fit) */
364 };
365 
366 /*
367  * A structure we pass around in menus that edit a single partition out
368  * of a partition_usage_set.
369  */
370 struct single_part_fs_edit {
371  	struct partition_usage_set *pset;
372 	size_t index, first_custom_attr, offset, mode;
373 	part_id id;
374 	struct disk_part_info info;	/* current partition data */
375 	struct part_usage_info *wanted;	/* points at our edit data */
376 
377 	/*
378 	 * "Backup" of old data, so we can restore previous values
379 	 * ("undo").
380 	 */
381 	struct part_usage_info old_usage;
382 	struct disk_part_info old_info;
383 
384 	/* menu return value */
385 	int rv;
386 };
387 
388 /*
389  * Description of a full target installation, all partitions and
390  * devices (may be across several struct pm_devs / disks).
391  */
392 struct install_partition_desc {
393 	size_t num;				/* how many entries in infos */
394 	struct part_usage_info *infos;		/* individual partitions */
395 	struct disk_partitions **write_back;	/* partition tables from
396 						 * which we did delete some
397 						 * partitions and that need
398 						 * updating, even if no
399 						 * active partition remains. */
400 	size_t num_write_back;			/* number of write_back */
401 	bool cur_system;			/* target is the live system */
402 };
403 
404 /* variables */
405 
406 extern int debug;		/* set by -D option */
407 
408 extern char machine[SSTRSIZE];
409 
410 extern int ignorerror;
411 extern int ttysig_ignore;
412 extern pid_t ttysig_forward;
413 extern uint sizemult;
414 extern const char *multname;
415 extern const char *err_outofmem;
416 extern int partman_go; /* run extended partition manager */
417 
418 /* logging variables */
419 
420 extern FILE *logfp;
421 extern FILE *script;
422 
423 #define MAX_DISKS 15
424 
425 extern daddr_t root_limit;    /* BIOS (etc) read limit */
426 
427 enum SHRED_T { SHRED_NONE=0, SHRED_ZEROS, SHRED_RANDOM };
428 
429 /* All information that is unique for each drive */
430 extern SLIST_HEAD(pm_head_t, pm_devs) pm_head;
431 
432 struct pm_devs {
433 	/*
434 	 * If device is blocked (e.g. part of a raid)
435 	 * this is a pointers to the  parent dev
436 	 */
437 	void *refdev;
438 
439 	char diskdev[SSTRSIZE];		/* Actual name of the disk. */
440 	char diskdev_descr[STRSIZE];	/* e.g. IDENTIFY result */
441 
442 	/*
443 	 * What the disk layout should look like.
444 	 */
445 	struct disk_partitions *parts;
446 
447 	/*
448 	 * The device does not take a MBR, even if we usually use
449 	 * MBR master / disklabel secondary partitioning.
450 	 * Used e.g. for raid* pseudo-disks.
451 	 */
452 	bool no_mbr;	/* userd for raid (etc) */
453 
454 	/*
455 	 * This device can not be partitioned (in any way).
456 	 * Used for wedges (dk*) or LVM devices.
457 	 */
458 	bool no_part;
459 
460 	/*
461 	 * This is a pseudo-device representing the currently running
462 	 * system (i.e. all mounted file systems).
463 	 */
464 	bool cur_system;
465 
466 	/* Actual values for current disk geometry - set by find_disks() or
467 	 *  md_get_info()
468 	 */
469 	uint sectorsize, dlcyl, dlhead, dlsec, dlcylsize, current_cylsize;
470 	/*
471 	 * Total size of the disk - in 'sectorsize' units (!)
472 	 */
473 	daddr_t dlsize;	/* total number of disk sectors */
474 
475 	/* Area of disk we can allocate, start and size in sectors. */
476 	daddr_t ptstart, ptsize;
477 
478 	/* For some bootblocks we need to know the CHS addressable limit */
479 	daddr_t max_chs;	/* bcyl * bhead * bsec */
480 
481 	/* If we have an MBR boot partition, start and size in sectors */
482 	daddr_t bootstart, bootsize;
483 
484 	/*
485 	 * In extended partitioning: all partitions in parts (number of
486 	 * entries is parts->num_part) may actually be mounted (temporarily)
487 	 * somewhere, e.g. to access a vnd device on them. This list has
488 	 * a pointer to the current mount point (strdup()'d) if mounted,
489 	 * or NULL if not.
490 	 */
491 	char **mounted;
492 
493 	bool unsaved;	/* Flag indicating to partman that device need saving */
494 	bool found;	/* Flag to delete unplugged and unconfigured devices */
495 	int blocked;	/* Device is busy and cannot be changed */
496 
497 	SLIST_ENTRY(pm_devs) l;
498 };
499 extern struct pm_devs *pm; /* Pointer to current device with which we work */
500 extern struct pm_devs *pm_new; /* Pointer for next allocating device in find_disks() */
501 
502 /* Generic structure for partman */
503 struct part_entry {
504 	part_id id;
505 	struct disk_partitions *parts;
506 	void *dev_ptr;
507 	struct install_partition_desc *install;
508 	size_t index;	/* e.g. if PM_RAID: this is raids[index] */
509 	int dev_ptr_delta;
510 	char fullname[SSTRSIZE];
511 	enum {PM_DISK=1, PM_PART, PM_SPEC,
512 	    PM_RAID, PM_CGD, PM_VND, PM_LVM, PM_LVMLV} type;
513 };
514 
515 /* Relative file name for storing a distribution. */
516 extern char xfer_dir[STRSIZE];
517 extern int  clean_xfer_dir;
518 
519 #if !defined(SYSINST_FTP_HOST)
520 #define SYSINST_FTP_HOST	"ftp.NetBSD.org"
521 #endif
522 
523 #if !defined(SYSINST_HTTP_HOST)
524 #define SYSINST_HTTP_HOST	"cdn.NetBSD.org"
525 #endif
526 
527 #if !defined(SYSINST_FTP_DIR)
528 #if defined(NETBSD_OFFICIAL_RELEASE)
529 #define SYSINST_FTP_DIR		"pub/NetBSD/NetBSD-" REL
530 #elif defined(REL_PATH)
531 #define SYSINST_FTP_DIR		"pub/NetBSD-daily/" REL_PATH "/latest"
532 #else
533 #define SYSINST_FTP_DIR		"pub/NetBSD/NetBSD-" REL
534 #endif
535 #endif
536 
537 #if !defined(ARCH_SUBDIR)
538 #define	ARCH_SUBDIR	MACH
539 #endif
540 #if !defined(PKG_ARCH_SUBDIR)
541 #define	PKG_ARCH_SUBDIR	MACH
542 #endif
543 
544 #if !defined(SYSINST_PKG_HOST)
545 #define SYSINST_PKG_HOST	"ftp.NetBSD.org"
546 #endif
547 #if !defined(SYSINST_PKG_HTTP_HOST)
548 #define SYSINST_PKG_HTTP_HOST	"cdn.NetBSD.org"
549 #endif
550 
551 #if !defined(SYSINST_PKG_DIR)
552 #define SYSINST_PKG_DIR		"pub/pkgsrc/packages/NetBSD"
553 #endif
554 
555 #if !defined(PKG_SUBDIR)
556 #define	PKG_SUBDIR		REL
557 #endif
558 
559 #if !defined(SYSINST_PKGSRC_HOST)
560 #define SYSINST_PKGSRC_HOST	SYSINST_PKG_HOST
561 #endif
562 #if !defined(SYSINST_PKGSRC_HTTP_HOST)
563 #define SYSINST_PKGSRC_HTTP_HOST	SYSINST_PKG_HTTP_HOST
564 #endif
565 
566 #ifndef SETS_TAR_SUFF
567 #define	SETS_TAR_SUFF	 "tgz"
568 #endif
569 
570 #ifdef	USING_PAXASTAR
571 #define	TAR_EXTRACT_FLAGS	"-xhepf"
572 #else
573 #define	TAR_EXTRACT_FLAGS	"-xpf"
574 #endif
575 
576 /* Abs. path we extract binary sets from */
577 extern char ext_dir_bin[STRSIZE];
578 
579 /* Abs. path we extract source sets from */
580 extern char ext_dir_src[STRSIZE];
581 
582 /* Abs. path we extract pkgsrc from */
583 extern char ext_dir_pkgsrc[STRSIZE];
584 
585 /* Place we look for binary sets in all fs types */
586 extern char set_dir_bin[STRSIZE];
587 
588 /* Place we look for source sets in all fs types */
589 extern char set_dir_src[STRSIZE];
590 
591 /* Place we look for pkgs in all fs types */
592 extern char pkg_dir[STRSIZE];
593 
594 /* Place we look for pkgsrc in all fs types */
595 extern char pkgsrc_dir[STRSIZE];
596 
597 /* User shell */
598 extern const char *ushell;
599 
600 #define	XFER_FTP	0
601 #define	XFER_HTTP	1
602 #define	XFER_HTTPS	2
603 #define	XFER_MAX	XFER_HTTPS
604 #define	XFER_HOST_MAX	XFER_HTTP	/* http and https share a server name */
605 #define	XFER_HOST(XFER)	((XFER) == XFER_FTP ? 0 : 1)
606 
607 struct ftpinfo {
608 	char xfer_host[XFER_HOST_MAX+1][STRSIZE];
609 	char dir[STRSIZE] ;
610 	char user[SSTRSIZE];
611 	char pass[STRSIZE];
612 	char proxy[STRSIZE];
613 	unsigned int xfer;	/* XFER_FTP for "ftp" or XFER_HTTP for "http" */
614 };
615 
616 /* use the same struct for sets ftp and to build pkgpath */
617 extern struct ftpinfo ftp, pkg, pkgsrc;
618 
619 extern int (*fetch_fn)(const char *);
620 extern char nfs_host[STRSIZE];
621 extern char nfs_dir[STRSIZE];
622 extern char entropy_file[PATH_MAX];
623 
624 extern char cdrom_dev[SSTRSIZE];		/* Typically "cd0a" */
625 extern char fd_dev[SSTRSIZE];			/* Typically "/dev/fd0a" */
626 extern const char *fd_type;			/* "msdos", "ffs" or maybe "ados" */
627 
628 extern char localfs_dev[SSTRSIZE];
629 extern char localfs_fs[SSTRSIZE];
630 extern char localfs_dir[STRSIZE];
631 
632 extern char targetroot_mnt[SSTRSIZE];
633 
634 extern int  mnt2_mounted;
635 
636 extern char dist_postfix[SSTRSIZE];
637 extern char dist_tgz_postfix[SSTRSIZE];
638 
639 /* needed prototypes */
640 void set_menu_numopts(int, int);
641 void remove_color_options(void);
642 #ifdef CHECK_ENTROPY
643 bool do_add_entropy(void);
644 size_t entropy_needed(void);
645 #endif
646 void remove_raid_options(void);
647 void remove_lvm_options(void);
648 void remove_cgd_options(void);
649 
650 /* Machine dependent functions .... */
651 void	md_init(void);
652 void	md_init_set_status(int); /* SFLAG_foo */
653 
654  /* MD functions if user selects install - in order called */
655 bool	md_get_info(struct install_partition_desc*);
656 /* returns -1 to restart partitioning, 0 for error, 1 for success */
657 int	md_make_bsd_partitions(struct install_partition_desc*);
658 bool	md_check_partitions(struct install_partition_desc*);
659 #ifdef HAVE_GPT
660 /*
661  * New GPT partitions have been written, update bootloader or remember
662  * data untill needed in md_post_newfs
663  */
664 bool	md_gpt_post_write(struct disk_partitions*, part_id root_id,
665 	    bool root_is_new, part_id efi_id, bool efi_is_new);
666 #endif
667 /*
668  * md_pre_disklabel and md_post_disklabel may be called
669  * multiple times, for each affected device, with the
670  * "inner" partitions pointer of the relevant partitions
671  * passed.
672  */
673 bool	md_pre_disklabel(struct install_partition_desc*, struct disk_partitions*);
674 bool	md_post_disklabel(struct install_partition_desc*, struct disk_partitions*);
675 bool	md_disklabel_is_default(const struct disklabel *);
676 int	md_pre_mount(struct install_partition_desc*, size_t);
677 int	md_post_newfs(struct install_partition_desc*);
678 int	md_post_extract(struct install_partition_desc*, bool upgrade);
679 void	md_cleanup_install(struct install_partition_desc*);
680 
681  /* MD functions if user selects upgrade - in order called */
682 int	md_pre_update(struct install_partition_desc*);
683 int	md_update(struct install_partition_desc*);
684 /* Also calls md_post_extract() */
685 
686 /* from main.c */
687 void	toplevel(void);
688 
689 /* from disks.c */
690 bool	get_default_cdrom(char *, size_t);
691 int	find_disks(const char *, bool);
692 bool enumerate_disks(void *state,bool (*func)(void *state, const char *dev));
693 bool is_cdrom_device(const char *dev, bool as_target);
694 bool is_bootable_device(const char *dev);
695 bool is_partitionable_device(const char *dev);
696 bool convert_scheme(struct pm_devs *p, bool is_boot_drive, const char **err_msg);
697 
698 #ifndef	NO_CLONES
699 /* a single partition selected for cloning (etc) */
700 struct selected_partition {
701 	struct disk_partitions *parts;
702 	part_id id;
703 };
704 struct selected_partitions {
705 	struct selected_partition *selection;
706 	size_t num_sel;
707 	bool with_data;		/* partitions and their data selected */
708 	bool free_parts;	/* caller should free parts */
709 };
710 bool select_partitions(struct selected_partitions *res,
711     const struct disk_partitions *ignore);
712 daddr_t	selected_parts_size(struct selected_partitions *);
713 void	free_selected_partitions(struct selected_partitions *);
714 
715 struct clone_target_menu_data {
716 	struct partition_usage_set usage;
717 	int res;
718 };
719 
720 int	clone_target_select(menudesc *m, void *arg);
721 bool	clone_partition_data(struct disk_partitions *dest_parts, part_id did,
722 	struct disk_partitions *src_parts, part_id sid);
723 #endif
724 
725 struct menudesc;
726 void	disp_cur_fspart(int, int);
727 bool	can_newfs_fstype(unsigned int);
728 int	make_filesystems(struct install_partition_desc *);
729 int	make_fstab(struct install_partition_desc *);
730 int	mount_disks(struct install_partition_desc *);
731 void	set_swap_if_low_ram(struct install_partition_desc *);
732 void	set_swap(struct install_partition_desc *);
733 void	clear_swap(void);
734 int	check_swap(const char *, int);
735 char *bootxx_name(struct install_partition_desc *);
736 int get_dkwedges(struct dkwedge_info **, const char *);
737 
738 /* from disks_lfs.c */
739 int	fs_is_lfs(void *);
740 
741 /* from label.c */
742 /*
743  * Bits valid for "flags" in get_last_mounted.
744  * Currently we return the real last mount from FFS, the volume label
745  * from FAT32, and nothing otherwise. The NTFS support is currently
746  * restricted to verify the partition has an NTFS (as some partitioning
747  * schemes do not tell NTFS from FAT).
748  */
749 #define GLM_LIKELY_FFS		1U
750 #define	GLM_MAYBE_FAT32		2U
751 #define	GLM_MAYBE_NTFS		4U
752 /*
753  * possible fs_sub_types are currently:
754  *  FS_BSDFFS:
755  *	0	unknown
756  *	1	FFSv1
757  *	2	FFSv2
758  * FS_MSDOS:
759  *	0	unknown
760  *	else	MBR_PTYPE_FAT* for the current FAT variant
761  * FS_NTFS:
762  *	0	unknown
763  *	else	MBR_PTYPE_NTFS (if valid NTFS was found)
764  *
765  * The fs_type and fs_sub_type pointers may be NULL.
766  */
767 const char *get_last_mounted(int fd, daddr_t offset, uint *fs_type,
768      uint *fs_sub_type, uint flags);
769 void	canonicalize_last_mounted(char*);
770 int	edit_and_check_label(struct pm_devs *p, struct partition_usage_set *pset, bool install);
771 int edit_ptn(menudesc *, void *);
772 int checkoverlap(struct disk_partitions *parts);
773 daddr_t getpartsize(struct disk_partitions *parts, daddr_t orig_start,
774     daddr_t partstart, daddr_t defpartsize);
775 daddr_t getpartoff(struct disk_partitions *parts, daddr_t defpartstart);
776 
777 /* from install.c */
778 void	do_install(void);
779 
780 /* from factor.c */
781 void	factor(long, long *, int, int *);
782 
783 /* from fdisk.c */
784 void	get_disk_info(char *);
785 void	set_disk_info(char *);
786 
787 /* from geom.c */
788 bool	disk_ioctl(const char *, unsigned long, void *);
789 bool	get_wedge_list(const char *, struct dkwedge_list *);
790 bool	get_wedge_info(const char *, struct dkwedge_info *);
791 bool	get_disk_geom(const char *, struct disk_geom *);
792 bool	get_label_geom(const char *, struct disklabel *);
793 
794 /* from net.c */
795 extern int network_up;
796 extern char net_namesvr[STRSIZE];
797 int	get_via_ftp(unsigned int);
798 int	get_via_nfs(void);
799 int	config_network(int force);
800 void	mnt_net_config(void);
801 void	make_url(char *, struct ftpinfo *, const char *);
802 int	get_pkgsrc(void);
803 const char *url_proto(unsigned int);
804 
805 /* From run.c */
806 int	collect(int, char **, const char *, ...) __printflike(3, 4);
807 int	run_program(int, const char *, ...) __printflike(2, 3);
808 void	do_logging(void);
809 int	do_system(const char *);
810 
811 /* from upgrade.c */
812 void	do_upgrade(void);
813 void	do_reinstall_sets(void);
814 void	restore_etc(void);
815 
816 /* from part_edit.c */
817 int	err_msg_win(const char*);
818 const struct disk_partitioning_scheme *select_part_scheme(struct pm_devs *dev,
819     const struct disk_partitioning_scheme *skip, bool bootable,
820     const char *title);
821 /*
822  * return value:
823  *  0 -> abort
824  *  1 -> ok, continue
825  *  -1 -> partitions have been deleted, start from scratch
826 */
827 int	edit_outer_parts(struct disk_partitions*);
828 bool	parts_use_wholedisk(struct disk_partitions*,
829 	     size_t add_ext_parts, const struct disk_part_info *ext_parts);
830 
831 /*
832  * Machine dependent partitioning function, only used when
833  * innern/outer partitioning schemes are in use - this sets
834  * up the outer scheme for maximum NetBSD usage.
835  */
836 bool	md_parts_use_wholedisk(struct disk_partitions*);
837 
838 /* from util.c */
839 bool	root_is_read_only(void);
840 void	get_ptn_alignment(const struct disk_partitions *parts, daddr_t *align, daddr_t *p0off);
841 struct disk_partitions *get_inner_parts(struct disk_partitions *parts);
842 char*	str_arg_subst(const char *, size_t, const char **);
843 void	msg_display_subst(const char *, size_t, ...);
844 void	msg_display_add_subst(const char *, size_t, ...);
845 int	ask_yesno(const char *);
846 int	ask_noyes(const char *);
847 void	hit_enter_to_continue(const char *msg, const char *title);
848 /*
849  * return value:
850  *  0 -> abort
851  *  1 -> re-edit
852  *  2 -> continue installation
853 */
854 int	ask_reedit(const struct disk_partitions *);
855 int	dir_exists_p(const char *);
856 int	file_exists_p(const char *);
857 int	file_mode_match(const char *, unsigned int);
858 uint64_t	get_ramsize(void);	/* in MB! */
859 void	ask_sizemult(int);
860 void	run_makedev(void);
861 int	boot_media_still_needed(void);
862 int	get_via_floppy(void);
863 int	get_via_cdrom(void);
864 int	get_via_localfs(void);
865 int	get_via_localdir(void);
866 void	show_cur_distsets(void);
867 void	make_ramdisk_dir(const char *);
868 void    set_kernel_set(unsigned int);
869 void    set_noextract_set(unsigned int);
870 unsigned int    get_kernel_set(void);
871 unsigned int    set_X11_selected(void);
872 int 	get_and_unpack_sets(int, msg, msg, msg);
873 int	sanity_check(void);
874 int	set_timezone(void);
875 void	scripting_fprintf(FILE *, const char *, ...) __printflike(2, 3);
876 void	scripting_vfprintf(FILE *, const char *, va_list) __printflike(2, 0);
877 void	add_rc_conf(const char *, ...) __printflike(1, 2);
878 int	del_rc_conf(const char *);
879 void	add_sysctl_conf(const char *, ...) __printflike(1, 2);
880 void	enable_rc_conf(void);
881 void	set_sizemult(daddr_t, uint bps);
882 void	set_default_sizemult(const char *disk, daddr_t unit, uint bps);
883 int	check_lfs_progs(void);
884 void	init_set_status(int);
885 void	customise_sets(void);
886 void	umount_mnt2(void);
887 int 	set_is_source(const char *);
888 const char *set_dir_for_set(const char *);
889 const char *ext_dir_for_set(const char *);
890 void	replace(const char *, const char *, ...) __printflike(2, 3);
891 void	get_tz_default(void);
892 distinfo*	get_set_distinfo(int);
893 int	extract_file(distinfo *, int);
894 int extract_file_to(distinfo *dist, int update, const char *dest_dir,
895     const char *extr_pattern, bool do_stats);
896 void	do_coloring (unsigned int, unsigned int);
897 int set_menu_select(menudesc *, void *);
898 const char *safectime(time_t *);
899 bool	use_tgz_for_set(const char*);
900 const char *set_postfix(const char*);
901 bool	empty_usage_set_from_parts(struct partition_usage_set*,
902 	    struct disk_partitions*);
903 bool	usage_set_from_parts(struct partition_usage_set*,
904 	    struct disk_partitions*);
905 bool	usage_set_from_install_desc(struct partition_usage_set*,
906 	    const struct install_partition_desc*,
907 	    struct disk_partitions*);
908 bool	merge_usage_set_into_install_desc(struct install_partition_desc*,
909 	    const struct partition_usage_set*);
910 void	free_usage_set(struct partition_usage_set*);
911 bool	install_desc_from_parts(struct install_partition_desc *,
912 	    struct disk_partitions*);
913 void	free_install_desc(struct install_partition_desc*);
914 bool	may_swap_if_not_sdmmc(const char*);
915 
916 /* from target.c */
917 #if defined(DEBUG)  ||	defined(DEBUG_ROOT)
918 void	backtowin(void);
919 #endif
920 bool	is_root_part_mount(const char *);
921 const	char *concat_paths(const char *, const char *);
922 const	char *target_expand(const char *);
923 bool	needs_expanding(const char *, size_t);
924 void	make_target_dir(const char *);
925 void	append_to_target_file(const char *, const char *);
926 void	echo_to_target_file(const char *, const char *);
927 void	trunc_target_file(const char *);
928 const	char *target_prefix(void);
929 int	target_chdir(const char *);
930 void	target_chdir_or_die(const char *);
931 int	target_already_root(void);
932 FILE	*target_fopen(const char *, const char *);
933 int	target_collect_file(int, char **, const char *);
934 int	is_active_rootpart(const char *, int);
935 int	cp_to_target(const char *, const char *);
936 void	dup_file_into_target(const char *);
937 void	mv_within_target_or_die(const char *, const char *);
938 int	cp_within_target(const char *, const char *, int);
939 int	target_mount(const char *, const char *, const char *);
940 int	target_unmount(const char *);
941 int	target_mount_do(const char *, const char *, const char *);
942 int	target_test(unsigned int, const char *);
943 int	target_dir_exists_p(const char *);
944 int	target_file_exists_p(const char *);
945 int	target_symlink_exists_p(const char *);
946 void	unwind_mounts(void);
947 void	register_post_umount_delwedge(const char *disk, const char *wedge);
948 int	target_mounted(void);
949 void	umount_root(void);
950 
951 /* from partman.c */
952 #ifndef NO_PARTMAN
953 int partman(struct install_partition_desc*);
954 int pm_getrefdev(struct pm_devs *);
955 void update_wedges(const char *);
956 void pm_destroy_all(void);
957 #else
958 static inline int partman(struct install_partition_desc *i __unused) { return -1; }
959 static inline int pm_getrefdev(struct pm_devs *x __unused) { return -1; }
960 #define update_wedges(x) __nothing
961 #endif
962 void pmdiskentry_enable(menudesc*, struct part_entry *);
963 int pm_partusage(struct pm_devs *, int, int);
964 void pm_setfstype(struct pm_devs *, part_id, int, int);
965 void pm_set_lvmpv(struct pm_devs *, part_id, bool);
966 bool pm_is_lvmpv(struct pm_devs *, part_id, const struct disk_part_info*);
967 int pm_editpart(int);
968 void pm_rename(struct pm_devs *);
969 void pm_shred(struct part_entry *, int);
970 void pm_umount(struct pm_devs *, int);
971 int pm_unconfigure(struct pm_devs *);
972 int pm_cgd_edit_new(struct pm_devs *pm, part_id id);
973 int pm_cgd_edit_old(struct part_entry *);
974 void pm_wedges_fill(struct pm_devs *);
975 void pm_edit_partitions(struct part_entry *);
976 part_id pm_whole_disk(struct part_entry *, int);
977 struct pm_devs * pm_from_pe(struct part_entry *);
978 bool pm_force_parts(struct pm_devs *);
979 
980 /*
981  * Parse a file system position or size in a common way, return
982  * sector count and multiplicator.
983  * If "extend" is supported, things like 120+ will be parsed as
984  * 120 plus "extend this" flag.
985  * Caller needs to init muliplicator upfront to the default value.
986  */
987 daddr_t parse_disk_pos(
988 	const char *,	/* in: input string */
989 	daddr_t *,	/* in/out: multiplicator for return value */
990 	daddr_t bps,	/* in: sector size in bytes */
991 	daddr_t,	/* in: cylinder size in sectors */
992 	bool *);	/* NULL if "extend" is not supported, & of
993 			 * "extend" flag otherwise */
994 
995 /* flags whether to offer the respective options (depending on helper
996    programs available on install media */
997 extern int have_raid, have_vnd, have_cgd, have_lvm, have_gpt, have_dk;
998 /* initialize above variables */
999 void check_available_binaries(void);
1000 
1001 /* from bsddisklabel.c */
1002 /* returns -1 to restart partitioning, 0 for error, 1 for success */
1003 int	make_bsd_partitions(struct install_partition_desc*);
1004 void	set_ptn_titles(menudesc *, int, void *);
1005 int	set_ptn_size(menudesc *, void *);
1006 bool	get_ptn_sizes(struct partition_usage_set*);
1007 bool	check_partitions(struct install_partition_desc*);
1008 
1009 /* from aout2elf.c */
1010 int move_aout_libs(void);
1011 
1012 #ifdef WSKBD
1013 void	get_kb_encoding(void);
1014 void	save_kb_encoding(void);
1015 #else
1016 #define	get_kb_encoding()
1017 #define	save_kb_encoding()
1018 #endif
1019 
1020 /* from configmenu.c */
1021 void	do_configmenu(struct install_partition_desc*);
1022 void	root_pw_setup(void);
1023 
1024 /* from checkrc.c */
1025 int	check_rcvar(const char *);
1026 int	check_rcdefault(const char *);
1027 extern	WINDOW *mainwin;
1028 
1029 /* in menus.mi */
1030 void expand_all_option_texts(menudesc *menu, void *arg);
1031 void resize_menu_height(menudesc *);
1032 
1033 #endif	/* _DEFS_H_ */
1034