2 * Copyright (c) 1987, 1993
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. Neither the name of the University nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * @(#) Copyright (c) 1987, 1993 The Regents of the University of California. All rights reserved.
30 * @(#)xinstall.c 8.1 (Berkeley) 7/21/93
31 * $FreeBSD: src/usr.bin/xinstall/xinstall.c,v 1.38.2.8 2002/08/07 16:29:48 ru Exp $
34 #include <sys/param.h>
36 #include <sys/mount.h>
54 /* Bootstrap aid - this doesn't exist in most older releases */
56 #define MAP_FAILED ((void *)-1) /* from <sys/mman.h> */
59 #define UF_NOHISTORY 0
62 #define MAX_CMP_SIZE (16 * 1024 * 1024)
64 #define DIRECTORY 0x01 /* Tell install it's a directory. */
65 #define SETFLAGS 0x02 /* Tell install to set flags. */
66 #define NOCHANGEBITS (UF_IMMUTABLE | UF_APPEND | SF_IMMUTABLE | SF_APPEND)
67 #define BACKUP_SUFFIX ".old"
73 int dobackup, docompare, dodir, dopreserve, dostrip, nommap, safecopy, verbose;
74 mode_t mode = S_IRWXU | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH;
75 const char *suffix = BACKUP_SUFFIX;
78 static int file_getgroup(const char *etcdir, const char *group, gid_t *gidret);
79 static int file_getowner(const char *etcdir, const char *owner, uid_t *uidret);
81 static int compare(int, const char *, size_t, int, const char *, size_t);
82 static void copy(int, const char *, int, const char *, off_t);
83 static int create_newfile(const char *, int, struct stat *);
84 static int create_tempfile(const char *, char *, size_t);
85 static void install(const char *, const char *, u_long, u_long, u_int);
86 static void install_dir(char *);
87 u_long numeric_id(const char *, const char *);
88 static void strip(const char *);
89 static int trymmap(int);
90 static void usage(void);
93 main(int argc, char *argv[])
95 struct stat from_sb, to_sb;
103 const char *group, *owner, *to_name;
112 while ((ch = getopt(argc, argv, "L:B:bCcD:df:g:lMm:o:pSsv")) != -1)
124 /* For backwards compatibility. */
134 if (strtofflags(&flags, &fset, &fclr))
135 errx(EX_USAGE, "%s: invalid flag", flags);
151 if (!(set = setmode(optarg)))
152 errx(EX_USAGE, "invalid file mode: %s",
154 mode = getmode(set, 0);
161 docompare = dopreserve = 1;
179 /* some options make no sense when creating directories */
180 if (dostrip && dodir) {
181 warnx("-d and -s may not be specified together");
185 /* must have at least two arguments, except when creating directories */
186 if (argc < 2 && !dodir)
189 /* need to make a temp copy so we can compare stripped version */
190 if (docompare && dostrip)
193 /* no etcdir specified, always try the system */
199 /* get group and owner id's */
201 if (etcdir && file_getgroup(etcdir, group, &gid)) {
203 } else if (trysys && (gp = getgrnam(group)) != NULL) {
206 gid = (gid_t)numeric_id(group, "group");
211 if (etcdir && file_getowner(etcdir, owner, &uid)) {
213 } else if (trysys && (pp = getpwnam(owner)) != NULL) {
216 uid = (uid_t)numeric_id(owner, "user");
221 for (; *argv != NULL; ++argv)
227 no_target = stat(to_name = argv[argc - 1], &to_sb);
228 if (!no_target && S_ISDIR(to_sb.st_mode)) {
229 for (; *argv != to_name; ++argv)
230 install(*argv, to_name, fset, fclr, iflags | DIRECTORY);
235 /* can't do file1 file2 directory/file */
238 warnx("target directory `%s' does not exist",
241 warnx("target `%s' is not a directory",
247 if (stat(*argv, &from_sb))
248 err(EX_OSERR, "%s", *argv);
249 if (!S_ISREG(to_sb.st_mode)) {
251 err(EX_OSERR, "%s", to_name);
253 if (to_sb.st_dev == from_sb.st_dev &&
254 to_sb.st_ino == from_sb.st_ino)
256 "%s and %s are the same file", *argv, to_name);
258 install(*argv, to_name, fset, fclr, iflags);
264 numeric_id(const char *name, const char *type)
271 * We know that uid_t's and gid_t's are unsigned longs.
274 val = strtoul(name, &ep, 10);
276 err(EX_NOUSER, "%s", name);
278 errx(EX_NOUSER, "unknown %s %s", type, name);
284 file_getgroup(const char *etcdir, const char *group, gid_t *gidret)
293 grlen = strlen(group);
295 if (asprintf(&path, "%s/group", etcdir) < 0)
296 errx(EX_OSERR, "asprintf()");
297 if ((fp = fopen(path, "r")) != NULL) {
298 while ((ptr = fgetln(fp, &len)) != NULL && len) {
300 if ((scan = strchr(ptr, ':')) == NULL)
302 if ((size_t)(scan - ptr) != grlen)
304 if (strncmp(ptr, group, grlen) != 0)
306 if ((scan = strchr(scan + 1, ':')) == NULL)
308 *gidret = strtoul(scan + 1, NULL, 10);
314 return((*gidret == (gid_t)-1) ? 0 : 1);
319 file_getowner(const char *etcdir, const char *owner, uid_t *uidret)
328 owner_len = strlen(owner);
330 if (asprintf(&path, "%s/master.passwd", etcdir) < 0)
331 errx(EX_OSERR, "asprintf()");
332 if ((fp = fopen(path, "r")) != NULL) {
333 while ((ptr = fgetln(fp, &len)) != NULL && len) {
335 if ((scan = strchr(ptr, ':')) == NULL)
337 if ((size_t)(scan - ptr) != owner_len)
339 if (strncmp(ptr, owner, owner_len) != 0)
341 if ((scan = strchr(scan + 1, ':')) == NULL)
343 *uidret = strtoul(scan + 1, NULL, 10);
349 return((*uidret == (uid_t)-1) ? 0 : 1);
354 * build a path name and install the file
357 install(const char *from_name, const char *to_name, u_long fset, u_long fclr,
360 struct stat from_sb, temp_sb, to_sb;
362 int devnull, files_match, from_fd, serrno, target;
363 int tempcopy, temp_fd, to_fd;
365 char backup[MAXPATHLEN], *p, pathbuf[MAXPATHLEN], tempfile[MAXPATHLEN];
370 /* If try to install NULL file to a directory, fails. */
371 if (flags & DIRECTORY || strcmp(from_name, _PATH_DEVNULL)) {
372 if (stat(from_name, &from_sb))
373 err(EX_OSERR, "%s", from_name);
374 if (!S_ISREG(from_sb.st_mode)) {
376 err(EX_OSERR, "%s", from_name);
378 /* Build the target path. */
379 if (flags & DIRECTORY) {
380 (void)snprintf(pathbuf, sizeof(pathbuf), "%s/%s",
382 (p = strrchr(from_name, '/')) ? ++p : from_name);
390 target = stat(to_name, &to_sb) == 0;
392 /* Only install to regular files. */
393 if (target && !S_ISREG(to_sb.st_mode)) {
399 /* Only copy safe if the target exists. */
400 tempcopy = safecopy && target;
402 if (!devnull && (from_fd = open(from_name, O_RDONLY, 0)) < 0)
403 err(EX_OSERR, "%s", from_name);
405 /* If we don't strip, we can compare first. */
406 if (docompare && !dostrip && target) {
407 if ((to_fd = open(to_name, O_RDONLY, 0)) < 0)
408 err(EX_OSERR, "%s", to_name);
410 files_match = to_sb.st_size == 0;
412 files_match = !(compare(from_fd, from_name,
413 (size_t)from_sb.st_size, to_fd,
414 to_name, (size_t)to_sb.st_size));
416 /* Close "to" file unless we match. */
423 to_fd = create_tempfile(to_name, tempfile,
426 err(EX_OSERR, "%s", tempfile);
428 if ((to_fd = create_newfile(to_name, target,
430 err(EX_OSERR, "%s", to_name);
432 (void)printf("install: %s -> %s\n",
436 copy(from_fd, from_name, to_fd,
437 tempcopy ? tempfile : to_name, from_sb.st_size);
441 strip(tempcopy ? tempfile : to_name);
444 * Re-open our fd on the target, in case we used a strip
445 * that does not work in-place -- like GNU binutils strip.
448 to_fd = open(tempcopy ? tempfile : to_name, O_RDONLY, 0);
450 err(EX_OSERR, "stripping %s", to_name);
454 * Compare the stripped temp file with the target.
456 if (docompare && dostrip && target) {
459 /* Re-open to_fd using the real target name. */
460 if ((to_fd = open(to_name, O_RDONLY, 0)) < 0)
461 err(EX_OSERR, "%s", to_name);
463 if (fstat(temp_fd, &temp_sb)) {
465 (void)unlink(tempfile);
467 err(EX_OSERR, "%s", tempfile);
470 if (compare(temp_fd, tempfile, (size_t)temp_sb.st_size, to_fd,
471 to_name, (size_t)to_sb.st_size) == 0) {
473 * If target has more than one link we need to
474 * replace it in order to snap the extra links.
475 * Need to preserve target file times, though.
477 if (to_sb.st_nlink != 1) {
478 utb.actime = to_sb.st_atime;
479 utb.modtime = to_sb.st_mtime;
480 utime(tempfile, &utb);
483 (void)unlink(tempfile);
485 (void) close(temp_fd);
490 * Move the new file into place if doing a safe copy
491 * and the files are different (or just not compared).
493 if (tempcopy && !files_match) {
494 /* Try to turn off the immutable bits. */
495 if (to_sb.st_flags & NOCHANGEBITS)
496 (void)chflags(to_name, to_sb.st_flags & ~NOCHANGEBITS);
498 if ((size_t)snprintf(backup, MAXPATHLEN, "%s%s", to_name,
499 suffix) != strlen(to_name) + strlen(suffix)) {
501 errx(EX_OSERR, "%s: backup filename too long",
505 (void)printf("install: %s -> %s\n", to_name, backup);
506 if (rename(to_name, backup) < 0) {
510 err(EX_OSERR, "rename: %s to %s", to_name,
515 (void)printf("install: %s -> %s\n", from_name, to_name);
516 if (rename(tempfile, to_name) < 0) {
520 err(EX_OSERR, "rename: %s to %s",
524 /* Re-open to_fd so we aren't hosed by the rename(2). */
526 if ((to_fd = open(to_name, O_RDONLY, 0)) < 0)
527 err(EX_OSERR, "%s", to_name);
531 * Preserve the timestamp of the source file if necessary.
533 if (dopreserve && !files_match && !devnull) {
534 utb.actime = from_sb.st_atime;
535 utb.modtime = from_sb.st_mtime;
536 utime(to_name, &utb);
539 if (fstat(to_fd, &to_sb) == -1) {
541 (void)unlink(to_name);
543 err(EX_OSERR, "%s", to_name);
547 * Set owner, group, mode for target; do the chown first,
548 * chown may lose the setuid bits.
550 if ((gid != (gid_t)-1 && gid != to_sb.st_gid) ||
551 (uid != (uid_t)-1 && uid != to_sb.st_uid) ||
552 (mode != to_sb.st_mode)) {
553 /* Try to turn off the immutable bits. */
554 if (to_sb.st_flags & NOCHANGEBITS)
555 (void)fchflags(to_fd, to_sb.st_flags & ~NOCHANGEBITS);
558 if ((gid != (gid_t)-1 && gid != to_sb.st_gid) ||
559 (uid != (uid_t)-1 && uid != to_sb.st_uid))
560 if (fchown(to_fd, uid, gid) == -1) {
562 (void)unlink(to_name);
564 err(EX_OSERR,"%s: chown/chgrp", to_name);
567 if (mode != to_sb.st_mode)
568 if (fchmod(to_fd, mode)) {
570 (void)unlink(to_name);
572 err(EX_OSERR, "%s: chmod", to_name);
576 * If provided a set of flags, set them, otherwise, preserve the
577 * flags, except for the dump and history flags. The dump flag
578 * is left clear on the target while the history flag from when
579 * the target was created (which is inherited from the target's
580 * parent directory) is retained.
582 if (flags & SETFLAGS) {
583 nfset = (to_sb.st_flags | fset) & ~fclr;
585 nfset = (from_sb.st_flags & ~(UF_NODUMP | UF_NOHISTORY)) |
586 (to_sb.st_flags & UF_NOHISTORY);
590 * NFS does not support flags. Ignore EOPNOTSUPP flags if we're just
591 * trying to turn off UF_NODUMP. If we're trying to set real flags,
592 * then warn if the fs doesn't support it, otherwise fail.
594 if (!devnull && fchflags(to_fd, nfset)) {
595 if (flags & SETFLAGS) {
596 if (errno == EOPNOTSUPP)
597 warn("%s: chflags", to_name);
600 (void)unlink(to_name);
602 err(EX_OSERR, "%s: chflags", to_name);
609 (void)close(from_fd);
614 * compare two files; non-zero means files differ
617 compare(int from_fd, const char *from_name __unused, size_t from_len,
618 int to_fd, const char *to_name __unused, size_t to_len)
625 if (from_len != to_len)
628 if (from_len <= MAX_CMP_SIZE) {
630 if (trymmap(from_fd) && trymmap(to_fd)) {
631 p = mmap(NULL, from_len, PROT_READ, MAP_SHARED, from_fd, (off_t)0);
632 if (p == (char *)MAP_FAILED)
634 q = mmap(NULL, from_len, PROT_READ, MAP_SHARED, to_fd, (off_t)0);
635 if (q == (char *)MAP_FAILED) {
640 rv = memcmp(p, q, from_len);
652 lseek(from_fd, 0, SEEK_SET);
653 lseek(to_fd, 0, SEEK_SET);
655 n1 = read(from_fd, buf1, sizeof(buf1));
659 n2 = read(to_fd, buf2, n1);
661 rv = memcmp(buf1, buf2, n1);
663 rv = 1; /* out of sync */
665 rv = 1; /* read failure */
667 lseek(from_fd, 0, SEEK_SET);
668 lseek(to_fd, 0, SEEK_SET);
671 rv = 1; /* don't bother in this case */
678 * create a temporary file based on path and open it
681 create_tempfile(const char *path, char *temp, size_t tsize)
685 (void)strncpy(temp, path, tsize);
686 temp[tsize - 1] = '\0';
687 if ((p = strrchr(temp, '/')) != NULL)
691 (void)strncpy(p, "INS@XXXX", &temp[tsize - 1] - p);
692 temp[tsize - 1] = '\0';
693 return (mkstemp(temp));
698 * create a new file, overwriting an existing one if necessary
701 create_newfile(const char *path, int target, struct stat *sbp)
703 char backup[MAXPATHLEN];
707 * Unlink now... avoid ETXTBSY errors later. Try to turn
708 * off the append/immutable bits -- if we fail, go ahead,
711 if (sbp->st_flags & NOCHANGEBITS)
712 (void)chflags(path, sbp->st_flags & ~NOCHANGEBITS);
715 if ((size_t)snprintf(backup, MAXPATHLEN, "%s%s",
716 path, suffix) != strlen(path) + strlen(suffix))
717 errx(EX_OSERR, "%s: backup filename too long",
719 (void)snprintf(backup, MAXPATHLEN, "%s%s",
722 (void)printf("install: %s -> %s\n",
724 if (rename(path, backup) < 0)
725 err(EX_OSERR, "rename: %s to %s", path, backup);
730 return (open(path, O_CREAT | O_RDWR | O_TRUNC, S_IRUSR | S_IWUSR));
735 * copy from one file to another
738 copy(int from_fd, const char *from_name, int to_fd,
739 const char *to_name, off_t size)
743 char *p, buf[MAXBSIZE];
746 /* Rewind file descriptors. */
747 if (lseek(from_fd, (off_t)0, SEEK_SET) == (off_t)-1)
748 err(EX_OSERR, "lseek: %s", from_name);
749 if (lseek(to_fd, (off_t)0, SEEK_SET) == (off_t)-1)
750 err(EX_OSERR, "lseek: %s", to_name);
753 * Mmap and write if less than 8M (the limit is so we don't totally
754 * trash memory on big files. This is really a minor hack, but it
755 * wins some CPU back.
758 if (size <= 8 * 1048576 && trymmap(from_fd) &&
759 (p = mmap(NULL, (size_t)size, PROT_READ, MAP_SHARED,
760 from_fd, (off_t)0)) != (char *)MAP_FAILED) {
761 if ((nw = write(to_fd, p, size)) != size) {
763 (void)unlink(to_name);
764 errno = nw > 0 ? EIO : serrno;
765 err(EX_OSERR, "%s", to_name);
770 while ((nr = read(from_fd, buf, sizeof(buf))) > 0)
771 if ((nw = write(to_fd, buf, nr)) != nr) {
773 (void)unlink(to_name);
774 errno = nw > 0 ? EIO : serrno;
775 err(EX_OSERR, "%s", to_name);
779 (void)unlink(to_name);
781 err(EX_OSERR, "%s", from_name);
788 * use strip(1) to strip the target file
791 strip(const char *to_name)
793 const char *stripbin;
799 (void)unlink(to_name);
801 err(EX_TEMPFAIL, "fork");
803 stripbin = getenv("STRIPBIN");
804 if (stripbin == NULL)
806 execlp(stripbin, stripbin, to_name, NULL);
807 err(EX_OSERR, "exec(%s)", stripbin);
809 if (wait(&status) == -1 || status) {
811 (void)unlink(to_name);
812 errc(EX_SOFTWARE, serrno, "wait");
819 * When doing a concurrent make -j N multiple install's can race the mkdir.
823 mkdir_race(const char *path, int nmode)
828 res = mkdir(path, nmode);
829 if (res < 0 && errno == EEXIST) {
830 if (stat(path, &sb) == 0 && S_ISDIR(sb.st_mode))
832 res = mkdir(path, nmode);
839 * build directory hierarchy
842 install_dir(char *path)
849 if (!*p || (p != path && *p == '/')) {
852 if (stat(path, &sb)) {
853 if (errno != ENOENT ||
854 mkdir_race(path, 0755) < 0) {
855 err(EX_OSERR, "mkdir %s", path);
858 (void)printf("install: mkdir %s\n",
860 } else if (!S_ISDIR(sb.st_mode))
861 errx(EX_OSERR, "%s exists but is not a directory", path);
866 if ((gid != (gid_t)-1 || uid != (uid_t)-1) && chown(path, uid, gid))
867 warn("chown %u:%u %s", uid, gid, path);
868 if (chmod(path, mode))
869 warn("chmod %o %s", mode, path);
874 * print a usage message and die
880 usage: install [-bCcpSsv] [-B suffix] [-D dest] [-f flags] [-g group] [-m mode]\n\
881 [-o owner] file1 file2\n\
882 install [-bCcpSsv] [-B suffix] [-D dest] [-f flags] [-g group] [-m mode]\n\
883 [-o owner] file1 ... fileN directory\n\
884 install -d [-v] [-D dest] [-g group] [-m mode] [-o owner] directory ...\n");
891 * return true (1) if mmap should be tried, false (0) if not.
897 * The ifdef is for bootstrapping - f_fstypename doesn't exist in
898 * pre-Lite2-merge systems.
903 if (nommap || fstatfs(fd, &stfs) != 0)
905 if (strcmp(stfs.f_fstypename, "ufs") == 0 ||
906 strcmp(stfs.f_fstypename, "cd9660") == 0)