4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
23 * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright 2015 Nexenta Systems, Inc. All rights reserved.
25 * Copyright 2016 Joyent, Inc.
35 #include <sys/types.h>
43 #include <sys/zfs_ioctl.h>
45 #include "libzfs_impl.h"
47 #define ZDIFF_SNAPDIR "/.zfs/snapshot/"
48 #define ZDIFF_SHARESDIR "/.zfs/shares/"
49 #define ZDIFF_PREFIX "zfs-diff-%d"
51 #define ZDIFF_ADDED '+'
52 #define ZDIFF_MODIFIED 'M'
53 #define ZDIFF_REMOVED '-'
54 #define ZDIFF_RENAMED 'R'
57 do_name_cmp(const char *fpath, const char *tpath)
60 fname = strrchr(fpath, '/') + 1;
61 tname = strrchr(tpath, '/') + 1;
62 return (strcmp(fname, tname) == 0);
65 typedef struct differ_info {
78 boolean_t timestamped;
87 * Given a {dsname, object id}, get the object path
90 get_stats_for_obj(differ_info_t *di, const char *dsname, uint64_t obj,
91 char *pn, int maxlen, zfs_stat_t *sb)
96 (void) strlcpy(zc.zc_name, dsname, sizeof (zc.zc_name));
100 error = ioctl(di->zhp->zfs_hdl->libzfs_fd, ZFS_IOC_OBJ_TO_STATS, &zc);
103 /* we can get stats even if we failed to get a path */
104 (void) memcpy(sb, &zc.zc_stat, sizeof (zfs_stat_t));
106 ASSERT(di->zerr == 0);
107 (void) strlcpy(pn, zc.zc_value, maxlen);
111 if (di->zerr == EPERM) {
112 (void) snprintf(di->errbuf, sizeof (di->errbuf),
113 dgettext(TEXT_DOMAIN,
114 "The sys_config privilege or diff delegated permission "
115 "is needed\nto discover path names"));
118 (void) snprintf(di->errbuf, sizeof (di->errbuf),
119 dgettext(TEXT_DOMAIN,
120 "Unable to determine path or stats for "
121 "object %lld in %s"), obj, dsname);
129 * Prints a file name out a character at a time. If the character is
130 * not in the range of what we consider "printable" ASCII, display it
131 * as an escaped 3-digit octal value. ASCII values less than a space
132 * are all control characters and we declare the upper end as the
133 * DELete character. This also is the last 7-bit ASCII character.
134 * We choose to treat all 8-bit ASCII as not printable for this
138 stream_bytes(FILE *fp, const char *string)
142 while ((c = *string++) != '\0') {
143 if (c > ' ' && c != '\\' && c < '\177') {
144 (void) fprintf(fp, "%c", c);
146 (void) fprintf(fp, "\\%03o", (uint8_t)c);
152 print_what(FILE *fp, mode_t what)
156 switch (what & S_IFMT) {
192 (void) fprintf(fp, "%c", symbol);
196 print_cmn(FILE *fp, differ_info_t *di, const char *file)
198 stream_bytes(fp, di->dsmnt);
199 stream_bytes(fp, file);
203 print_rename(FILE *fp, differ_info_t *di, const char *old, const char *new,
207 (void) fprintf(fp, "%10lld.%09lld\t",
208 (longlong_t)isb->zs_ctime[0],
209 (longlong_t)isb->zs_ctime[1]);
210 (void) fprintf(fp, "%c\t", ZDIFF_RENAMED);
212 print_what(fp, isb->zs_mode);
213 (void) fprintf(fp, "\t");
215 print_cmn(fp, di, old);
217 (void) fprintf(fp, "\t");
219 (void) fprintf(fp, " -> ");
220 print_cmn(fp, di, new);
221 (void) fprintf(fp, "\n");
225 print_link_change(FILE *fp, differ_info_t *di, int delta, const char *file,
229 (void) fprintf(fp, "%10lld.%09lld\t",
230 (longlong_t)isb->zs_ctime[0],
231 (longlong_t)isb->zs_ctime[1]);
232 (void) fprintf(fp, "%c\t", ZDIFF_MODIFIED);
234 print_what(fp, isb->zs_mode);
235 (void) fprintf(fp, "\t");
237 print_cmn(fp, di, file);
238 (void) fprintf(fp, "\t(%+d)", delta);
239 (void) fprintf(fp, "\n");
243 print_file(FILE *fp, differ_info_t *di, char type, const char *file,
247 (void) fprintf(fp, "%10lld.%09lld\t",
248 (longlong_t)isb->zs_ctime[0],
249 (longlong_t)isb->zs_ctime[1]);
250 (void) fprintf(fp, "%c\t", type);
252 print_what(fp, isb->zs_mode);
253 (void) fprintf(fp, "\t");
255 print_cmn(fp, di, file);
256 (void) fprintf(fp, "\n");
260 write_inuse_diffs_one(FILE *fp, differ_info_t *di, uint64_t dobj)
262 struct zfs_stat fsb, tsb;
265 char fobjname[MAXPATHLEN], tobjname[MAXPATHLEN];
266 int fobjerr, tobjerr;
269 if (dobj == di->shares)
273 * Check the from and to snapshots for info on the object. If
274 * we get ENOENT, then the object just didn't exist in that
275 * snapshot. If we get ENOTSUP, then we tried to get
276 * info on a non-ZPL object, which we don't care about anyway.
278 fobjerr = get_stats_for_obj(di, di->fromsnap, dobj, fobjname,
280 if (fobjerr && di->zerr != ENOENT && di->zerr != ENOTSUP)
283 tobjerr = get_stats_for_obj(di, di->tosnap, dobj, tobjname,
285 if (tobjerr && di->zerr != ENOENT && di->zerr != ENOTSUP)
289 * Unallocated object sharing the same meta dnode block
291 if (fobjerr && tobjerr) {
292 ASSERT(di->zerr == ENOENT || di->zerr == ENOTSUP);
297 di->zerr = 0; /* negate get_stats_for_obj() from side that failed */
298 fmode = fsb.zs_mode & S_IFMT;
299 tmode = tsb.zs_mode & S_IFMT;
300 if (fmode == S_IFDIR || tmode == S_IFDIR || fsb.zs_links == 0 ||
304 change = tsb.zs_links - fsb.zs_links;
308 print_link_change(fp, di, change, tobjname, &tsb);
311 print_file(fp, di, ZDIFF_ADDED, tobjname, &tsb);
313 } else if (tobjerr) {
315 print_link_change(fp, di, change, fobjname, &fsb);
318 print_file(fp, di, ZDIFF_REMOVED, fobjname, &fsb);
322 if (fmode != tmode && fsb.zs_gen == tsb.zs_gen)
323 tsb.zs_gen++; /* Force a generational difference */
324 same_name = do_name_cmp(fobjname, tobjname);
326 /* Simple modification or no change */
327 if (fsb.zs_gen == tsb.zs_gen) {
328 /* No apparent changes. Could we assert !this? */
329 if (fsb.zs_ctime[0] == tsb.zs_ctime[0] &&
330 fsb.zs_ctime[1] == tsb.zs_ctime[1])
333 print_link_change(fp, di, change,
334 change > 0 ? fobjname : tobjname, &tsb);
335 } else if (same_name) {
336 print_file(fp, di, ZDIFF_MODIFIED, fobjname, &tsb);
338 print_rename(fp, di, fobjname, tobjname, &tsb);
342 /* file re-created or object re-used */
343 print_file(fp, di, ZDIFF_REMOVED, fobjname, &fsb);
344 print_file(fp, di, ZDIFF_ADDED, tobjname, &tsb);
350 write_inuse_diffs(FILE *fp, differ_info_t *di, dmu_diff_record_t *dr)
355 for (o = dr->ddr_first; o <= dr->ddr_last; o++) {
356 if (err = write_inuse_diffs_one(fp, di, o))
363 describe_free(FILE *fp, differ_info_t *di, uint64_t object, char *namebuf,
368 if (get_stats_for_obj(di, di->fromsnap, object, namebuf,
370 /* Let it slide, if in the delete queue on from side */
371 if (di->zerr == ENOENT && sb.zs_links == 0) {
378 print_file(fp, di, ZDIFF_REMOVED, namebuf, &sb);
383 write_free_diffs(FILE *fp, differ_info_t *di, dmu_diff_record_t *dr)
385 zfs_cmd_t zc = { 0 };
386 libzfs_handle_t *lhdl = di->zhp->zfs_hdl;
387 char fobjname[MAXPATHLEN];
389 (void) strlcpy(zc.zc_name, di->fromsnap, sizeof (zc.zc_name));
390 zc.zc_obj = dr->ddr_first - 1;
392 ASSERT(di->zerr == 0);
394 while (zc.zc_obj < dr->ddr_last) {
397 err = ioctl(lhdl->libzfs_fd, ZFS_IOC_NEXT_OBJ, &zc);
399 if (zc.zc_obj == di->shares) {
403 if (zc.zc_obj > dr->ddr_last) {
406 err = describe_free(fp, di, zc.zc_obj, fobjname,
410 } else if (errno == ESRCH) {
413 (void) snprintf(di->errbuf, sizeof (di->errbuf),
414 dgettext(TEXT_DOMAIN,
415 "next allocated object (> %lld) find failure"),
429 differ_info_t *di = arg;
430 dmu_diff_record_t dr;
434 if ((ofp = fdopen(di->outputfd, "w")) == NULL) {
436 (void) strerror_r(errno, di->errbuf, sizeof (di->errbuf));
437 (void) close(di->datafd);
442 char *cp = (char *)&dr;
443 int len = sizeof (dr);
447 rv = read(di->datafd, cp, len);
450 } while (len > 0 && rv > 0);
452 if (rv < 0 || (rv == 0 && len != sizeof (dr))) {
455 } else if (rv == 0) {
456 /* end of file at a natural breaking point */
460 switch (dr.ddr_type) {
462 err = write_free_diffs(ofp, di, &dr);
465 err = write_inuse_diffs(ofp, di, &dr);
477 (void) close(di->datafd);
481 ASSERT(di->zerr == EINVAL);
482 (void) snprintf(di->errbuf, sizeof (di->errbuf),
483 dgettext(TEXT_DOMAIN,
484 "Internal error: bad data from diff IOCTL"));
491 find_shares_object(differ_info_t *di)
493 char fullpath[MAXPATHLEN];
494 struct stat64 sb = { 0 };
496 (void) strlcpy(fullpath, di->dsmnt, MAXPATHLEN);
497 (void) strlcat(fullpath, ZDIFF_SHARESDIR, MAXPATHLEN);
499 if (stat64(fullpath, &sb) != 0) {
501 (void) snprintf(di->errbuf, sizeof (di->errbuf),
502 dgettext(TEXT_DOMAIN, "Cannot stat %s"), fullpath);
503 return (zfs_error(di->zhp->zfs_hdl, EZFS_DIFF, di->errbuf));
509 di->shares = (uint64_t)sb.st_ino;
514 make_temp_snapshot(differ_info_t *di)
516 libzfs_handle_t *hdl = di->zhp->zfs_hdl;
517 zfs_cmd_t zc = { 0 };
519 (void) snprintf(zc.zc_value, sizeof (zc.zc_value),
520 ZDIFF_PREFIX, getpid());
521 (void) strlcpy(zc.zc_name, di->ds, sizeof (zc.zc_name));
522 zc.zc_cleanup_fd = di->cleanupfd;
524 if (ioctl(hdl->libzfs_fd, ZFS_IOC_TMP_SNAPSHOT, &zc) != 0) {
527 (void) snprintf(di->errbuf, sizeof (di->errbuf),
528 dgettext(TEXT_DOMAIN, "The diff delegated "
529 "permission is needed in order\nto create a "
530 "just-in-time snapshot for diffing\n"));
531 return (zfs_error(hdl, EZFS_DIFF, di->errbuf));
533 (void) snprintf(di->errbuf, sizeof (di->errbuf),
534 dgettext(TEXT_DOMAIN, "Cannot create just-in-time "
535 "snapshot of '%s'"), zc.zc_name);
536 return (zfs_standard_error(hdl, err, di->errbuf));
540 di->tmpsnap = zfs_strdup(hdl, zc.zc_value);
541 di->tosnap = zfs_asprintf(hdl, "%s@%s", di->ds, di->tmpsnap);
546 teardown_differ_info(differ_info_t *di)
555 (void) close(di->cleanupfd);
559 get_snapshot_names(differ_info_t *di, const char *fromsnap,
562 libzfs_handle_t *hdl = di->zhp->zfs_hdl;
571 * dataset@snap1 dataset@snap2
572 * dataset@snap1 @snap2
573 * dataset@snap1 dataset
574 * @snap1 dataset@snap2
576 if (tosnap == NULL) {
577 /* only a from snapshot given, must be valid */
578 (void) snprintf(di->errbuf, sizeof (di->errbuf),
579 dgettext(TEXT_DOMAIN,
580 "Badly formed snapshot name %s"), fromsnap);
582 if (!zfs_validate_name(hdl, fromsnap, ZFS_TYPE_SNAPSHOT,
584 return (zfs_error(hdl, EZFS_INVALIDNAME,
588 atptrf = strchr(fromsnap, '@');
589 ASSERT(atptrf != NULL);
590 fdslen = atptrf - fromsnap;
592 di->fromsnap = zfs_strdup(hdl, fromsnap);
593 di->ds = zfs_strdup(hdl, fromsnap);
594 di->ds[fdslen] = '\0';
596 /* the to snap will be a just-in-time snap of the head */
597 return (make_temp_snapshot(di));
600 (void) snprintf(di->errbuf, sizeof (di->errbuf),
601 dgettext(TEXT_DOMAIN,
602 "Unable to determine which snapshots to compare"));
604 atptrf = strchr(fromsnap, '@');
605 atptrt = strchr(tosnap, '@');
606 fdslen = atptrf ? atptrf - fromsnap : strlen(fromsnap);
607 tdslen = atptrt ? atptrt - tosnap : strlen(tosnap);
608 fsnlen = strlen(fromsnap) - fdslen; /* includes @ sign */
609 tsnlen = strlen(tosnap) - tdslen; /* includes @ sign */
611 if (fsnlen <= 1 || tsnlen == 1 || (fdslen == 0 && tdslen == 0) ||
612 (fsnlen == 0 && tsnlen == 0)) {
613 return (zfs_error(hdl, EZFS_INVALIDNAME, di->errbuf));
614 } else if ((fdslen > 0 && tdslen > 0) &&
615 ((tdslen != fdslen || strncmp(fromsnap, tosnap, fdslen) != 0))) {
617 * not the same dataset name, might be okay if
618 * tosnap is a clone of a fromsnap descendant.
620 char origin[ZFS_MAXNAMELEN];
624 di->ds = zfs_alloc(di->zhp->zfs_hdl, tdslen + 1);
625 (void) strncpy(di->ds, tosnap, tdslen);
626 di->ds[tdslen] = '\0';
628 zhp = zfs_open(hdl, di->ds, ZFS_TYPE_FILESYSTEM);
629 while (zhp != NULL) {
630 if (zfs_prop_get(zhp, ZFS_PROP_ORIGIN, origin,
631 sizeof (origin), &src, NULL, 0, B_FALSE) != 0) {
632 (void) zfs_close(zhp);
636 if (strncmp(origin, fromsnap, fsnlen) == 0)
639 (void) zfs_close(zhp);
640 zhp = zfs_open(hdl, origin, ZFS_TYPE_FILESYSTEM);
644 (void) snprintf(di->errbuf, sizeof (di->errbuf),
645 dgettext(TEXT_DOMAIN,
646 "Not an earlier snapshot from the same fs"));
647 return (zfs_error(hdl, EZFS_INVALIDNAME, di->errbuf));
649 (void) zfs_close(zhp);
652 di->isclone = B_TRUE;
653 di->fromsnap = zfs_strdup(hdl, fromsnap);
655 di->tosnap = zfs_strdup(hdl, tosnap);
657 return (make_temp_snapshot(di));
660 int dslen = fdslen ? fdslen : tdslen;
662 di->ds = zfs_alloc(hdl, dslen + 1);
663 (void) strncpy(di->ds, fdslen ? fromsnap : tosnap, dslen);
664 di->ds[dslen] = '\0';
666 di->fromsnap = zfs_asprintf(hdl, "%s%s", di->ds, atptrf);
668 di->tosnap = zfs_asprintf(hdl, "%s%s", di->ds, atptrt);
670 return (make_temp_snapshot(di));
677 get_mountpoint(differ_info_t *di, char *dsnm, char **mntpt)
681 mounted = is_mounted(di->zhp->zfs_hdl, dsnm, mntpt);
682 if (mounted == B_FALSE) {
683 (void) snprintf(di->errbuf, sizeof (di->errbuf),
684 dgettext(TEXT_DOMAIN,
685 "Cannot diff an unmounted snapshot"));
686 return (zfs_error(di->zhp->zfs_hdl, EZFS_BADTYPE, di->errbuf));
689 /* Avoid a double slash at the beginning of root-mounted datasets */
690 if (**mntpt == '/' && *(*mntpt + 1) == '\0')
696 get_mountpoints(differ_info_t *di)
702 * first get the mountpoint for the parent dataset
704 if (get_mountpoint(di, di->ds, &di->dsmnt) != 0)
707 strptr = strchr(di->tosnap, '@');
708 ASSERT3P(strptr, !=, NULL);
709 di->tomnt = zfs_asprintf(di->zhp->zfs_hdl, "%s%s%s", di->dsmnt,
710 ZDIFF_SNAPDIR, ++strptr);
712 strptr = strchr(di->fromsnap, '@');
713 ASSERT3P(strptr, !=, NULL);
715 frommntpt = di->dsmnt;
721 err = get_mountpoint(di, di->fromsnap, &mntpt);
728 di->frommnt = zfs_asprintf(di->zhp->zfs_hdl, "%s%s%s", frommntpt,
729 ZDIFF_SNAPDIR, ++strptr);
738 setup_differ_info(zfs_handle_t *zhp, const char *fromsnap,
739 const char *tosnap, differ_info_t *di)
743 di->cleanupfd = open(ZFS_DEV, O_RDWR|O_EXCL);
744 VERIFY(di->cleanupfd >= 0);
746 if (get_snapshot_names(di, fromsnap, tosnap) != 0)
749 if (get_mountpoints(di) != 0)
752 if (find_shares_object(di) != 0)
759 zfs_show_diffs(zfs_handle_t *zhp, int outfd, const char *fromsnap,
760 const char *tosnap, int flags)
762 zfs_cmd_t zc = { 0 };
764 differ_info_t di = { 0 };
769 (void) snprintf(errbuf, sizeof (errbuf),
770 dgettext(TEXT_DOMAIN, "zfs diff failed"));
772 if (setup_differ_info(zhp, fromsnap, tosnap, &di)) {
773 teardown_differ_info(&di);
778 zfs_error_aux(zhp->zfs_hdl, strerror(errno));
779 teardown_differ_info(&di);
780 return (zfs_error(zhp->zfs_hdl, EZFS_PIPEFAILED, errbuf));
783 di.scripted = (flags & ZFS_DIFF_PARSEABLE);
784 di.classify = (flags & ZFS_DIFF_CLASSIFY);
785 di.timestamped = (flags & ZFS_DIFF_TIMESTAMP);
788 di.datafd = pipefd[0];
790 if (pthread_create(&tid, NULL, differ, &di)) {
791 zfs_error_aux(zhp->zfs_hdl, strerror(errno));
792 (void) close(pipefd[0]);
793 (void) close(pipefd[1]);
794 teardown_differ_info(&di);
795 return (zfs_error(zhp->zfs_hdl,
796 EZFS_THREADCREATEFAILED, errbuf));
800 (void) strlcpy(zc.zc_value, di.fromsnap, strlen(di.fromsnap) + 1);
801 (void) strlcpy(zc.zc_name, di.tosnap, strlen(di.tosnap) + 1);
802 zc.zc_cookie = pipefd[1];
804 iocerr = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_DIFF, &zc);
806 (void) snprintf(errbuf, sizeof (errbuf),
807 dgettext(TEXT_DOMAIN, "Unable to obtain diffs"));
808 if (errno == EPERM) {
809 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
810 "\n The sys_mount privilege or diff delegated "
811 "permission is needed\n to execute the "
813 } else if (errno == EXDEV) {
814 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
815 "\n Not an earlier snapshot from the same fs"));
816 } else if (errno != EPIPE || di.zerr == 0) {
817 zfs_error_aux(zhp->zfs_hdl, strerror(errno));
819 (void) close(pipefd[1]);
820 (void) pthread_cancel(tid);
821 (void) pthread_join(tid, NULL);
822 teardown_differ_info(&di);
823 if (di.zerr != 0 && di.zerr != EPIPE) {
824 zfs_error_aux(zhp->zfs_hdl, strerror(di.zerr));
825 return (zfs_error(zhp->zfs_hdl, EZFS_DIFF, di.errbuf));
827 return (zfs_error(zhp->zfs_hdl, EZFS_DIFFDATA, errbuf));
831 (void) close(pipefd[1]);
832 (void) pthread_join(tid, NULL);
835 zfs_error_aux(zhp->zfs_hdl, strerror(di.zerr));
836 return (zfs_error(zhp->zfs_hdl, EZFS_DIFF, di.errbuf));
838 teardown_differ_info(&di);