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"
69 static struct passwd *pp;
70 static struct group *gp;
73 static int dobackup, docompare, dodir, dopreserve, dostrip, dounpriv, nommap,
75 static mode_t mode = S_IRWXU | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH;
76 static const char *suffix = BACKUP_SUFFIX;
77 static char *destdir, *fflags;
79 static int file_getgroup(const char *etcdir, const char *group, gid_t *gidret);
80 static int file_getowner(const char *etcdir, const char *owner, uid_t *uidret);
82 static int compare(int, const char *, size_t, int, const char *, size_t);
83 static void copy(int, const char *, int, const char *, off_t);
84 static int create_newfile(const char *, int, struct stat *);
85 static int create_tempfile(const char *, char *, size_t);
86 static void install(const char *, const char *, u_long, u_long, u_int);
87 static void install_dir(char *);
88 u_long numeric_id(const char *, const char *);
89 static void strip(const char *);
90 static int trymmap(int);
91 static void usage(void);
94 main(int argc, char *argv[])
96 struct stat from_sb, to_sb;
103 const char *group, *owner, *to_name;
114 while ((ch = getopt(argc, argv, "L:B:bCcD:df:g:lMm:o:pSsUv")) != -1)
126 /* For backwards compatibility. */
150 if (!(set = setmode(optarg)))
151 errx(EX_USAGE, "invalid file mode: %s",
153 mode = getmode(set, 0);
160 docompare = dopreserve = 1;
181 /* some options make no sense when creating directories */
182 if (dostrip && dodir) {
183 warnx("-d and -s may not be specified together");
187 if (getenv("DONTSTRIP") != NULL) {
188 warnx("DONTSTRIP set - will not strip installed binaries");
192 /* must have at least two arguments, except when creating directories */
193 if (argc < 2 && !dodir)
196 /* need to make a temp copy so we can compare stripped version */
197 if (docompare && dostrip)
200 /* no etcdir specified, always try the system */
206 /* get group and owner id's */
207 if (group != NULL && !dounpriv) {
208 if (etcdir && file_getgroup(etcdir, group, &gid)) {
210 } else if (trysys && (gp = getgrnam(group)) != NULL) {
213 gid = (gid_t)numeric_id(group, "group");
217 if (owner != NULL && !dounpriv) {
218 if (etcdir && file_getowner(etcdir, owner, &uid)) {
220 } else if (trysys && (pp = getpwnam(owner)) != NULL) {
223 uid = (uid_t)numeric_id(owner, "user");
227 if (fflags != NULL && !dounpriv) {
228 if (strtofflags(&fflags, &fset, &fclr))
229 errx(EX_USAGE, "%s: invalid flag", fflags);
234 for (; *argv != NULL; ++argv)
240 to_name = argv[argc - 1];
241 no_target = stat(to_name, &to_sb);
242 if (!no_target && S_ISDIR(to_sb.st_mode)) {
243 for (; *argv != to_name; ++argv)
244 install(*argv, to_name, fset, fclr, iflags | DIRECTORY);
249 /* can't do file1 file2 directory/file */
252 warnx("target directory `%s' does not exist",
255 warnx("target `%s' is not a directory",
261 if (stat(*argv, &from_sb))
262 err(EX_OSERR, "%s", *argv);
263 if (!S_ISREG(to_sb.st_mode)) {
265 err(EX_OSERR, "%s", to_name);
267 if (to_sb.st_dev == from_sb.st_dev &&
268 to_sb.st_ino == from_sb.st_ino)
270 "%s and %s are the same file", *argv, to_name);
272 install(*argv, to_name, fset, fclr, iflags);
278 numeric_id(const char *name, const char *type)
285 * We know that uid_t's and gid_t's are unsigned longs.
288 val = strtoul(name, &ep, 10);
290 err(EX_NOUSER, "%s", name);
292 errx(EX_NOUSER, "unknown %s %s", type, name);
298 file_getgroup(const char *etcdir, const char *group, gid_t *gidret)
307 grlen = strlen(group);
309 if (asprintf(&path, "%s/group", etcdir) < 0)
310 errx(EX_OSERR, "asprintf()");
311 if ((fp = fopen(path, "r")) != NULL) {
312 while ((ptr = fgetln(fp, &len)) != NULL && len) {
314 if ((scan = strchr(ptr, ':')) == NULL)
316 if ((size_t)(scan - ptr) != grlen)
318 if (strncmp(ptr, group, grlen) != 0)
320 if ((scan = strchr(scan + 1, ':')) == NULL)
322 *gidret = strtoul(scan + 1, NULL, 10);
328 return((*gidret == (gid_t)-1) ? 0 : 1);
333 file_getowner(const char *etcdir, const char *owner, uid_t *uidret)
342 owner_len = strlen(owner);
344 if (asprintf(&path, "%s/master.passwd", etcdir) < 0)
345 errx(EX_OSERR, "asprintf()");
346 if ((fp = fopen(path, "r")) != NULL) {
347 while ((ptr = fgetln(fp, &len)) != NULL && len) {
349 if ((scan = strchr(ptr, ':')) == NULL)
351 if ((size_t)(scan - ptr) != owner_len)
353 if (strncmp(ptr, owner, owner_len) != 0)
355 if ((scan = strchr(scan + 1, ':')) == NULL)
357 *uidret = strtoul(scan + 1, NULL, 10);
363 return((*uidret == (uid_t)-1) ? 0 : 1);
368 * build a path name and install the file
371 install(const char *from_name, const char *to_name, u_long fset, u_long fclr,
374 struct stat from_sb, temp_sb, to_sb;
376 int devnull, files_match, from_fd, serrno, target;
377 int tempcopy, temp_fd, to_fd;
379 char backup[MAXPATHLEN], *p, pathbuf[MAXPATHLEN], tempfile[MAXPATHLEN];
384 /* If try to install NULL file to a directory, fails. */
385 if (flags & DIRECTORY || strcmp(from_name, _PATH_DEVNULL)) {
386 if (stat(from_name, &from_sb))
387 err(EX_OSERR, "%s", from_name);
388 if (!S_ISREG(from_sb.st_mode)) {
390 err(EX_OSERR, "%s", from_name);
392 /* Build the target path. */
393 if (flags & DIRECTORY) {
394 (void)snprintf(pathbuf, sizeof(pathbuf), "%s/%s",
396 (p = strrchr(from_name, '/')) ? ++p : from_name);
404 target = stat(to_name, &to_sb) == 0;
406 /* Only install to regular files. */
407 if (target && !S_ISREG(to_sb.st_mode)) {
413 /* Only copy safe if the target exists. */
414 tempcopy = safecopy && target;
416 if (!devnull && (from_fd = open(from_name, O_RDONLY, 0)) < 0)
417 err(EX_OSERR, "%s", from_name);
419 /* If we don't strip, we can compare first. */
420 if (docompare && !dostrip && target) {
421 if ((to_fd = open(to_name, O_RDONLY, 0)) < 0)
422 err(EX_OSERR, "%s", to_name);
424 files_match = to_sb.st_size == 0;
426 files_match = !(compare(from_fd, from_name,
427 (size_t)from_sb.st_size, to_fd,
428 to_name, (size_t)to_sb.st_size));
430 /* Close "to" file unless we match. */
437 to_fd = create_tempfile(to_name, tempfile,
440 err(EX_OSERR, "%s", tempfile);
442 if ((to_fd = create_newfile(to_name, target,
444 err(EX_OSERR, "%s", to_name);
446 (void)printf("install: %s -> %s\n",
450 copy(from_fd, from_name, to_fd,
451 tempcopy ? tempfile : to_name, from_sb.st_size);
455 strip(tempcopy ? tempfile : to_name);
458 * Re-open our fd on the target, in case we used a strip
459 * that does not work in-place -- like GNU binutils strip.
462 to_fd = open(tempcopy ? tempfile : to_name, O_RDONLY, 0);
464 err(EX_OSERR, "stripping %s", to_name);
468 * Compare the stripped temp file with the target.
470 if (docompare && dostrip && target) {
473 /* Re-open to_fd using the real target name. */
474 if ((to_fd = open(to_name, O_RDONLY, 0)) < 0)
475 err(EX_OSERR, "%s", to_name);
477 if (fstat(temp_fd, &temp_sb)) {
479 (void)unlink(tempfile);
481 err(EX_OSERR, "%s", tempfile);
484 if (compare(temp_fd, tempfile, (size_t)temp_sb.st_size, to_fd,
485 to_name, (size_t)to_sb.st_size) == 0) {
487 * If target has more than one link we need to
488 * replace it in order to snap the extra links.
489 * Need to preserve target file times, though.
491 if (to_sb.st_nlink != 1) {
492 utb.actime = to_sb.st_atime;
493 utb.modtime = to_sb.st_mtime;
494 utime(tempfile, &utb);
497 (void)unlink(tempfile);
499 (void) close(temp_fd);
504 * Move the new file into place if doing a safe copy
505 * and the files are different (or just not compared).
507 if (tempcopy && !files_match) {
508 /* Try to turn off the immutable bits. */
509 if (to_sb.st_flags & NOCHANGEBITS)
510 (void)chflags(to_name, to_sb.st_flags & ~NOCHANGEBITS);
512 if ((size_t)snprintf(backup, MAXPATHLEN, "%s%s", to_name,
513 suffix) != strlen(to_name) + strlen(suffix)) {
515 errx(EX_OSERR, "%s: backup filename too long",
519 (void)printf("install: %s -> %s\n", to_name, backup);
520 if (rename(to_name, backup) < 0) {
524 err(EX_OSERR, "rename: %s to %s", to_name,
529 (void)printf("install: %s -> %s\n", from_name, to_name);
530 if (rename(tempfile, to_name) < 0) {
534 err(EX_OSERR, "rename: %s to %s",
538 /* Re-open to_fd so we aren't hosed by the rename(2). */
540 if ((to_fd = open(to_name, O_RDONLY, 0)) < 0)
541 err(EX_OSERR, "%s", to_name);
545 * Preserve the timestamp of the source file if necessary.
547 if (dopreserve && !files_match && !devnull) {
548 utb.actime = from_sb.st_atime;
549 utb.modtime = from_sb.st_mtime;
550 utime(to_name, &utb);
553 if (fstat(to_fd, &to_sb) == -1) {
555 (void)unlink(to_name);
557 err(EX_OSERR, "%s", to_name);
561 * Set owner, group, mode for target; do the chown first,
562 * chown may lose the setuid bits.
564 if (!dounpriv && ((gid != (gid_t)-1 && gid != to_sb.st_gid) ||
565 (uid != (uid_t)-1 && uid != to_sb.st_uid) ||
566 (mode != to_sb.st_mode))) {
567 /* Try to turn off the immutable bits. */
568 if (to_sb.st_flags & NOCHANGEBITS)
569 (void)fchflags(to_fd, to_sb.st_flags & ~NOCHANGEBITS);
573 (gid != (gid_t)-1 && gid != to_sb.st_gid) ||
574 (uid != (uid_t)-1 && uid != to_sb.st_uid)))
575 if (fchown(to_fd, uid, gid) == -1) {
577 (void)unlink(to_name);
579 err(EX_OSERR,"%s: chown/chgrp", to_name);
582 if (mode != to_sb.st_mode) {
584 dounpriv ? mode & (S_IRWXU|S_IRWXG|S_IRWXO) : mode)) {
586 (void)unlink(to_name);
588 err(EX_OSERR, "%s: chmod", to_name);
593 * If provided a set of flags, set them, otherwise, preserve the
594 * flags, except for the dump and history flags. The dump flag
595 * is left clear on the target while the history flag from when
596 * the target was created (which is inherited from the target's
597 * parent directory) is retained.
599 if (flags & SETFLAGS) {
600 nfset = (to_sb.st_flags | fset) & ~fclr;
602 nfset = (from_sb.st_flags & ~(UF_NODUMP | UF_NOHISTORY)) |
603 (to_sb.st_flags & UF_NOHISTORY);
607 * NFS does not support flags. Ignore EOPNOTSUPP flags if we're just
608 * trying to turn off UF_NODUMP. If we're trying to set real flags,
609 * then warn if the fs doesn't support it, otherwise fail.
611 if (!dounpriv && !devnull && fchflags(to_fd, nfset)) {
612 if (flags & SETFLAGS) {
613 if (errno == EOPNOTSUPP)
614 warn("%s: chflags", to_name);
617 (void)unlink(to_name);
619 err(EX_OSERR, "%s: chflags", to_name);
626 (void)close(from_fd);
631 * compare two files; non-zero means files differ
634 compare(int from_fd, const char *from_name __unused, size_t from_len,
635 int to_fd, const char *to_name __unused, size_t to_len)
642 if (from_len != to_len)
645 if (from_len <= MAX_CMP_SIZE) {
647 if (trymmap(from_fd) && trymmap(to_fd)) {
648 p = mmap(NULL, from_len, PROT_READ, MAP_SHARED, from_fd, (off_t)0);
649 if (p == (char *)MAP_FAILED)
651 q = mmap(NULL, from_len, PROT_READ, MAP_SHARED, to_fd, (off_t)0);
652 if (q == (char *)MAP_FAILED) {
657 rv = memcmp(p, q, from_len);
669 lseek(from_fd, 0, SEEK_SET);
670 lseek(to_fd, 0, SEEK_SET);
672 n1 = read(from_fd, buf1, sizeof(buf1));
676 n2 = read(to_fd, buf2, n1);
678 rv = memcmp(buf1, buf2, n1);
680 rv = 1; /* out of sync */
682 rv = 1; /* read failure */
684 lseek(from_fd, 0, SEEK_SET);
685 lseek(to_fd, 0, SEEK_SET);
688 rv = 1; /* don't bother in this case */
695 * create a temporary file based on path and open it
698 create_tempfile(const char *path, char *temp, size_t tsize)
702 (void)strncpy(temp, path, tsize);
703 temp[tsize - 1] = '\0';
704 if ((p = strrchr(temp, '/')) != NULL)
708 (void)strncpy(p, "INS@XXXX", &temp[tsize - 1] - p);
709 temp[tsize - 1] = '\0';
710 return (mkstemp(temp));
715 * create a new file, overwriting an existing one if necessary
718 create_newfile(const char *path, int target, struct stat *sbp)
720 char backup[MAXPATHLEN];
724 * Unlink now... avoid ETXTBSY errors later. Try to turn
725 * off the append/immutable bits -- if we fail, go ahead,
728 if (sbp->st_flags & NOCHANGEBITS)
729 (void)chflags(path, sbp->st_flags & ~NOCHANGEBITS);
732 if ((size_t)snprintf(backup, MAXPATHLEN, "%s%s",
733 path, suffix) != strlen(path) + strlen(suffix))
734 errx(EX_OSERR, "%s: backup filename too long",
736 (void)snprintf(backup, MAXPATHLEN, "%s%s",
739 (void)printf("install: %s -> %s\n",
741 if (rename(path, backup) < 0)
742 err(EX_OSERR, "rename: %s to %s", path, backup);
747 return (open(path, O_CREAT | O_RDWR | O_TRUNC, S_IRUSR | S_IWUSR));
752 * copy from one file to another
755 copy(int from_fd, const char *from_name, int to_fd,
756 const char *to_name, off_t size)
764 /* Rewind file descriptors. */
765 if (lseek(from_fd, (off_t)0, SEEK_SET) == (off_t)-1)
766 err(EX_OSERR, "lseek: %s", from_name);
767 if (lseek(to_fd, (off_t)0, SEEK_SET) == (off_t)-1)
768 err(EX_OSERR, "lseek: %s", to_name);
771 * Mmap and write if less than 8M (the limit is so we don't totally
772 * trash memory on big files. This is really a minor hack, but it
773 * wins some CPU back.
776 if (size <= 8 * 1048576 && trymmap(from_fd) &&
777 (p = mmap(NULL, (size_t)size, PROT_READ, MAP_SHARED,
778 from_fd, (off_t)0)) != (char *)MAP_FAILED) {
779 if ((nw = write(to_fd, p, size)) != size) {
781 (void)unlink(to_name);
782 errno = nw > 0 ? EIO : serrno;
783 err(EX_OSERR, "%s", to_name);
788 while ((nr = read(from_fd, buf, sizeof(buf))) > 0) {
789 if ((nw = write(to_fd, buf, nr)) != nr) {
791 (void)unlink(to_name);
792 errno = nw > 0 ? EIO : serrno;
793 err(EX_OSERR, "%s", to_name);
798 (void)unlink(to_name);
800 err(EX_OSERR, "%s", from_name);
807 * use strip(1) to strip the target file
810 strip(const char *to_name)
812 const char *stripbin;
818 (void)unlink(to_name);
820 err(EX_TEMPFAIL, "fork");
822 stripbin = getenv("STRIPBIN");
823 if (stripbin == NULL)
825 execlp(stripbin, stripbin, to_name, NULL);
826 err(EX_OSERR, "exec(%s)", stripbin);
828 if (wait(&status) == -1 || status) {
830 (void)unlink(to_name);
831 errc(EX_SOFTWARE, serrno, "wait");
838 * When doing a concurrent make -j N multiple install's can race the mkdir.
842 mkdir_race(const char *path, int nmode)
847 res = mkdir(path, nmode);
848 if (res < 0 && errno == EEXIST) {
849 if (stat(path, &sb) == 0 && S_ISDIR(sb.st_mode))
851 res = mkdir(path, nmode);
858 * build directory hierarchy
861 install_dir(char *path)
868 if (!*p || (p != path && *p == '/')) {
871 if (stat(path, &sb)) {
872 if (errno != ENOENT ||
873 mkdir_race(path, 0755) < 0) {
874 err(EX_OSERR, "mkdir %s", path);
877 (void)printf("install: mkdir %s\n",
879 } else if (!S_ISDIR(sb.st_mode))
880 errx(EX_OSERR, "%s exists but is not a directory", path);
886 if ((gid != (gid_t)-1 || uid != (uid_t)-1) &&
887 chown(path, uid, gid))
888 warn("chown %u:%u %s", uid, gid, path);
889 /* XXXBED: should we do the chmod in the dounpriv case? */
890 if (chmod(path, mode))
891 warn("chmod %o %s", mode, path);
897 * print a usage message and die
903 "usage: install [-bCcpSsUv] [-B suffix] [-D dest] [-f flags] [-g group]\n"
904 " [-m mode] [-o owner] file1 file2\n"
905 " install [-bCcpSsUv] [-B suffix] [-D dest] [-f flags] [-g group]\n"
906 " [-m mode] [-o owner] file1 ... fileN directory\n"
907 " install -d [-lUv] [-D dest] [-g group] [-m mode] [-o owner]\n"
915 * return true (1) if mmap should be tried, false (0) if not.
921 * The ifdef is for bootstrapping - f_fstypename doesn't exist in
922 * pre-Lite2-merge systems.
927 if (nommap || fstatfs(fd, &stfs) != 0)
929 if (strcmp(stfs.f_fstypename, "ufs") == 0 ||
930 strcmp(stfs.f_fstypename, "cd9660") == 0)