xref: /netbsd-src/usr.sbin/sysinst/target.c (revision aad9773e38ed2370a628a6416e098f9008fc10a7)
1 /*	$NetBSD: target.c,v 1.2 2014/08/03 16:09:38 martin Exp $	*/
2 
3 /*
4  * Copyright 1997 Jonathan Stone
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  * 3. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *      This product includes software developed for the NetBSD Project by
18  *      Jonathan Stone.
19  * 4. The name of Jonathan Stone may not be used to endorse
20  *    or promote products derived from this software without specific prior
21  *    written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY JONATHAN STONE ``AS IS''
24  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26  * ARE DISCLAIMED. IN NO EVENT SHALL PIERMONT INFORMATION SYSTEMS INC. BE
27  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
33  * THE POSSIBILITY OF SUCH DAMAGE.
34  *
35  */
36 
37 /* Copyright below applies to the realpath() code */
38 
39 /*
40  * Copyright (c) 1989, 1991, 1993, 1995
41  *      The Regents of the University of California.  All rights reserved.
42  *
43  * This code is derived from software contributed to Berkeley by
44  * Jan-Simon Pendry.
45  *
46  * Redistribution and use in source and binary forms, with or without
47  * modification, are permitted provided that the following conditions
48  * are met:
49  * 1. Redistributions of source code must retain the above copyright
50  *    notice, this list of conditions and the following disclaimer.
51  * 2. Redistributions in binary form must reproduce the above copyright
52  *    notice, this list of conditions and the following disclaimer in the
53  *    documentation and/or other materials provided with the distribution.
54  * 3. Neither the name of the University nor the names of its contributors
55  *    may be used to endorse or promote products derived from this software
56  *    without specific prior written permission.
57  *
58  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
59  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
60  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
61  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
62  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
63  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
64  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
65  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
66  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
67  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
68  * SUCH DAMAGE.
69  */
70 
71 
72 #include <sys/cdefs.h>
73 #if defined(LIBC_SCCS) && !defined(lint)
74 __RCSID("$NetBSD: target.c,v 1.2 2014/08/03 16:09:38 martin Exp $");
75 #endif
76 
77 /*
78  * target.c -- path-prefixing routines to access the target installation
79  *  filesystems. Makes the install tools more independent of whether
80  *  we're installing into a separate filesystem hierarchy mounted under
81  * /targetroot, or into the currently active root mounted on /.
82  */
83 
84 #include <sys/param.h>			/* XXX vm_param.h always defines TRUE*/
85 #include <sys/types.h>
86 #include <sys/sysctl.h>
87 #include <sys/stat.h>			/* stat() */
88 #include <sys/mount.h>			/* statfs() */
89 
90 #include <fcntl.h>
91 #include <stdio.h>
92 #include <stdarg.h>
93 #include <unistd.h>
94 #include <curses.h>			/* defines TRUE, but checks  */
95 #include <errno.h>
96 
97 
98 #include "defs.h"
99 #include "md.h"
100 #include "msg_defs.h"
101 #include "menu_defs.h"
102 
103 /*
104  * local  prototypes
105  */
106 
107 static void make_prefixed_dir (const char *prefix, const char *path);
108 static int do_target_chdir (const char *dir, int flag);
109 int	target_test(unsigned int mode, const char *path);
110 int	target_test_dir (const char *path);	/* deprecated */
111 int	target_test_file (const char *path);	/* deprecated */
112 int	target_test_symlink (const char *path);	/* deprecated */
113 
114 void unwind_mounts(void);
115 
116 /* Record a mount for later unwinding of target mounts. */
117 struct unwind_mount {
118 	struct unwind_mount *um_prev;
119 	char um_mountpoint[4];		/* Allocated longer... */
120 };
121 
122 /* Unwind-mount stack */
123 struct unwind_mount *unwind_mountlist = NULL;
124 
125 /*
126  * Debugging options
127  */
128 /*#define DEBUG_ROOT*/		/* turn on what-is-root? debugging. */
129 /*#define DEBUG_UNWIND*/	/* turn on unwind-target-mount debugging. */
130 
131 /*
132  * debugging helper. curses...
133  */
134 #if defined(DEBUG)  ||	defined(DEBUG_ROOT)
135 void
136 backtowin(void)
137 {
138 
139 	fflush(stdout);	/* curses does not leave stdout linebuffered. */
140 	getchar();	/* wait for user to press return */
141 	wrefresh(stdscr);
142 }
143 #endif
144 
145 
146 /*
147  * Is the root partition we're running from the same as the root
148  * which the user has selected to install/upgrade?
149  * Uses global variable "pm->diskdev" to find the selected device for
150  * install/upgrade.
151  */
152 int
153 target_already_root(void)
154 {
155 
156 	if (strcmp(pm->diskdev, "") == 0)
157 		/* No root partition was ever selected.
158 		 * Assume that the currently mounted one should be used
159 		 */
160 		return 1;
161 
162 	return is_active_rootpart(pm->diskdev, pm->rootpart);
163 }
164 
165 
166 /*
167  * Is this device partition (e.g., "sd0a") mounted as root?
168  */
169 int
170 is_active_rootpart(const char *dev, int ptn)
171 {
172 	int mib[2];
173 	char rootdev[SSTRSIZE];
174 	int rootptn;
175 	size_t varlen;
176 
177 	mib[0] = CTL_KERN;
178 	mib[1] = KERN_ROOT_DEVICE;
179 	varlen = sizeof(rootdev);
180 	if (sysctl(mib, 2, rootdev, &varlen, NULL, 0) < 0)
181 		return 1;
182 
183 	if (strcmp(dev, rootdev) != 0)
184 		return 0;
185 
186 	mib[1] = KERN_ROOT_PARTITION;
187 	varlen = sizeof rootptn;
188 	if (sysctl(mib, 2, &rootptn, &varlen, NULL, 0) < 0)
189 		return 1;
190 
191 	return ptn == rootptn;
192 }
193 
194 /*
195  * Pathname  prefixing glue to support installation either
196  * from in-ramdisk miniroots or on-disk diskimages.
197  * If our root is on the target disk, the install target is mounted
198  * on /targetroot and we need to prefix installed pathnames with /targetroot.
199  * otherwise we are installing to the currently-active root and
200  * no prefix is needed.
201  */
202 const char *
203 target_prefix(void)
204 {
205 	/*
206 	 * XXX fetch sysctl variable for current root, and compare
207 	 * to the devicename of the install target disk.
208 	 */
209 	return(target_already_root() ? "" : targetroot_mnt);
210 }
211 
212 /*
213  * concatenate two pathnames.
214  * XXX returns either input args or result in a static buffer.
215  * The caller must copy if it wants to use the pathname past the
216  * next call to a target-prefixing  function, or to modify the inputs..
217  * Used only  internally so this is probably safe.
218  */
219 const char *
220 concat_paths(const char *prefix, const char *suffix)
221 {
222 	static char real_path[MAXPATHLEN];
223 
224 	/* absolute prefix and null suffix? */
225 	if (prefix[0] == '/' && suffix[0] == 0)
226 		return prefix;
227 
228 	/* null prefix and absolute suffix? */
229 	if (prefix[0] == 0 && suffix[0] == '/')
230 		return suffix;
231 
232 	/* avoid "//" */
233 	if (suffix[0] == '/' || suffix[0] == 0)
234 		snprintf(real_path, sizeof(real_path), "%s%s", prefix, suffix);
235 	else
236 		snprintf(real_path, sizeof(real_path), "%s/%s",
237 		    prefix, suffix);
238 	return (real_path);
239 }
240 
241 /*
242  * Do target prefix expansion on a pathname.
243  * XXX uses concat_paths and so returns result in a static buffer.
244  * The caller must copy if it wants to use the pathname past the
245  * next call to a target-prefixing  function, or to modify the inputs..
246  * Used only  internally so this is probably safe.
247  *
248  * Not static so other functions can generate target related file names.
249  */
250 const char *
251 target_expand(const char *tgtpath)
252 {
253 
254 	return concat_paths(target_prefix(), tgtpath);
255 }
256 
257 /* Make a directory, with a prefix like "/targetroot" or possibly just "". */
258 static void
259 make_prefixed_dir(const char *prefix, const char *path)
260 {
261 
262 	run_program(0, "/bin/mkdir -p %s", concat_paths(prefix, path));
263 }
264 
265 /* Make a directory with a pathname relative to the installation target. */
266 void
267 make_target_dir(const char *path)
268 {
269 
270 	make_prefixed_dir(target_prefix(), path);
271 }
272 
273 
274 static int
275 do_target_chdir(const char *dir, int must_succeed)
276 {
277 	const char *tgt_dir;
278 	int error;
279 
280 	error = 0;
281 	tgt_dir = target_expand(dir);
282 
283 #ifdef DEBUG
284 	printf("target_chdir (%s)\n", tgt_dir);
285 	//return (0);
286 #endif
287 	/* chdir returns -1 on error and sets errno. */
288 	if (chdir(tgt_dir) < 0)
289 		error = errno;
290 	if (logfp) {
291 		fprintf(logfp, "cd to %s\n", tgt_dir);
292 		fflush(logfp);
293 	}
294 	if (script) {
295 		scripting_fprintf(NULL, "cd %s\n", tgt_dir);
296 		fflush(script);
297 	}
298 
299 	if (error && must_succeed) {
300 		fprintf(stderr, msg_string(MSG_realdir),
301 		       target_prefix(), strerror(error));
302 		if (logfp)
303 			fprintf(logfp, msg_string(MSG_realdir),
304 			       target_prefix(), strerror(error));
305 		exit(1);
306 	}
307 	errno = error;
308 	return (error);
309 }
310 
311 void
312 target_chdir_or_die(const char *dir)
313 {
314 
315 	(void)do_target_chdir(dir, 1);
316 }
317 
318 #ifdef notdef
319 int
320 target_chdir(const char *dir)
321 {
322 
323 	return do_target_chdir(dir, 0);
324 }
325 #endif
326 
327 /*
328  * Copy a file from the current root into the target system,
329  * where the  destination pathname is relative to the target root.
330  * Does not check for copy-to-self when target is  current root.
331  */
332 int
333 cp_to_target(const char *srcpath, const char *tgt_path)
334 {
335 	const char *real_path = target_expand(tgt_path);
336 
337 	return run_program(0, "/bin/cp %s %s", srcpath, real_path);
338 }
339 
340 /*
341  * Duplicate a file from the current root to the same pathname
342  * in the target system.  Pathname must be an absolute pathname.
343  * If we're running in the target, do nothing.
344  */
345 void
346 dup_file_into_target(const char *filename)
347 {
348 
349 	if (!target_already_root())
350 		cp_to_target(filename, filename);
351 }
352 
353 
354 /*
355  * Do a mv where both pathnames are within the target filesystem.
356  */
357 void
358 mv_within_target_or_die(const char *frompath, const char *topath)
359 {
360 	char realfrom[STRSIZE];
361 	char realto[STRSIZE];
362 
363 	strlcpy(realfrom, target_expand(frompath), sizeof realfrom);
364 	strlcpy(realto, target_expand(topath), sizeof realto);
365 
366 	run_program(RUN_FATAL, "mv %s %s", realfrom, realto);
367 }
368 
369 /* Do a cp where both pathnames are within the target filesystem. */
370 int
371 cp_within_target(const char *frompath, const char *topath, int optional)
372 {
373 	char realfrom[STRSIZE];
374 	char realto[STRSIZE];
375 
376 	strncpy(realfrom, target_expand(frompath), STRSIZE);
377 	strncpy(realto, target_expand(topath), STRSIZE);
378 
379 	if (access(realfrom, R_OK) == -1 && optional)
380 		return 0;
381 	return (run_program(0, "cp -p %s %s", realfrom, realto));
382 }
383 
384 /* fopen a pathname in the target. */
385 FILE *
386 target_fopen(const char *filename, const char *type)
387 {
388 
389 	return fopen(target_expand(filename), type);
390 }
391 
392 /*
393  * Do a mount onto a mountpoint in the install target.
394  * Record mountpoint so we can unmount when finished.
395  * NB: does not prefix mount-from, which probably breaks nullfs mounts.
396  */
397 int
398 target_mount_do(const char *opts, const char *from, const char *on)
399 {
400 	struct unwind_mount *m;
401 	int error;
402 	int len;
403 
404 	len = strlen(on);
405 	m = malloc(sizeof *m + len);
406 	if (m == 0)
407 		return (ENOMEM);	/* XXX */
408 
409 	memcpy(m->um_mountpoint, on, len + 1);
410 
411 #ifdef DEBUG_UNWIND
412 	endwin();
413 	fprintf(stderr, "mounting %s with unwind\n", on);
414 	backtowin();
415 #endif
416 
417 	error = run_program(0, "/sbin/mount %s %s %s%s",
418 			opts, from, target_prefix(), on);
419 	if (error) {
420 		free(m);
421 		return error;
422 	}
423 	m->um_prev = unwind_mountlist;
424 	unwind_mountlist = m;
425 	return 0;
426 }
427 
428 int
429 target_mount(const char *opts, const char *from, int ptn, const char *on)
430 {
431 	int error;
432 	char *frompath;
433 	asprintf (&frompath, "/dev/%s%c", from, (ptn < 0)? 0 : 'a' + ptn);
434 	if (frompath == 0)
435 		return (ENOMEM);
436 	error = target_mount_do(opts, frompath, on);
437 	free(frompath);
438 	return error;
439 }
440 
441 /*
442  * unwind the mount stack, unmounting mounted filesystems.
443  * For now, ignore any errors in unmount.
444  * (Why would we be unable to unmount?  The user has suspended
445  *  us and forked shell sitting somewhere in the target root?)
446  */
447 void
448 unwind_mounts(void)
449 {
450 	struct unwind_mount *m;
451 	static volatile int unwind_in_progress = 0;
452 
453 	/* signal safety */
454 	if (unwind_in_progress)
455 		return;
456 	unwind_in_progress = 1;
457 
458 	while ((m = unwind_mountlist) != NULL) {
459 		unwind_mountlist = m->um_prev;
460 #ifdef DEBUG_UNWIND
461 		endwin();
462 		fprintf(stderr, "unmounting %s\n", m->um_mountpoint);
463 		backtowin();
464 #endif
465 		run_program(0, "/sbin/umount %s%s",
466 			target_prefix(), m->um_mountpoint);
467 		free(m);
468 	}
469 	unwind_in_progress = 0;
470 }
471 
472 int
473 target_collect_file(int kind, char **buffer, const char *name)
474 {
475 	const char *realname = target_expand(name);
476 
477 #ifdef	DEBUG
478 	printf("collect real name %s\n", realname);
479 #endif
480 	return collect(kind, buffer, "%s", realname);
481 }
482 
483 /*
484  * Verify a pathname already exists in the target root filesystem,
485  * by running  test "testflag" on the expanded target pathname.
486  */
487 int
488 target_test(unsigned int mode, const char *path)
489 {
490 	const char *real_path = target_expand(path);
491 	register int result;
492 
493 	result = !file_mode_match(real_path, mode);
494 	scripting_fprintf(NULL, "if [ $? != 0 ]; then echo \"%s does not exist!\"; fi\n", real_path);
495 
496 #if defined(DEBUG)
497 	printf("target_test(%o, %s) returning %d\n", mode, real_path, result);
498 #endif
499 	return (result);
500 }
501 
502 /*
503  * Verify a directory already exists in the target root
504  * filesystem. Do not create the directory if it doesn't  exist.
505  * Assumes that sysinst has already mounted the target root.
506  */
507 int
508 target_test_dir(const char *path)
509 {
510 
511  	return target_test(S_IFDIR, path);
512 }
513 
514 /*
515  * Verify an ordinary file already exists in the target root
516  * filesystem. Do not create the directory if it doesn't  exist.
517  * Assumes that sysinst has already mounted the target root.
518  */
519 int
520 target_test_file(const char *path)
521 {
522 
523  	return target_test(S_IFREG, path);
524 }
525 
526 int
527 target_test_symlink(const char *path)
528 {
529 
530  	return target_test(S_IFLNK, path);
531 }
532 
533 int
534 target_file_exists_p(const char *path)
535 {
536 
537 	return (target_test_file(path) == 0);
538 }
539 
540 int
541 target_dir_exists_p(const char *path)
542 {
543 
544 	return (target_test_dir(path) == 0);
545 }
546 
547 int
548 target_symlink_exists_p(const char *path)
549 {
550 
551 	return (target_test_symlink(path) == 0);
552 }
553 
554 int
555 target_mounted(void)
556 {
557 	return (unwind_mountlist != NULL);
558 }
559