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.
26 * Copyright 2016 Igor Kozhukhov <ikozhukhov@gmail.com>
36 #include <sys/types.h>
44 #include <sys/zfs_ioctl.h>
46 #include "libzfs_impl.h"
48 #define ZDIFF_SNAPDIR "/.zfs/snapshot/"
49 #define ZDIFF_SHARESDIR "/.zfs/shares/"
50 #define ZDIFF_PREFIX "zfs-diff-%d"
52 #define ZDIFF_ADDED '+'
53 #define ZDIFF_MODIFIED 'M'
54 #define ZDIFF_REMOVED '-'
55 #define ZDIFF_RENAMED 'R'
58 do_name_cmp(const char *fpath, const char *tpath)
61 fname = strrchr(fpath, '/') + 1;
62 tname = strrchr(tpath, '/') + 1;
63 return (strcmp(fname, tname) == 0);
66 typedef struct differ_info {
79 boolean_t timestamped;
88 * Given a {dsname, object id}, get the object path
91 get_stats_for_obj(differ_info_t *di, const char *dsname, uint64_t obj,
92 char *pn, int maxlen, zfs_stat_t *sb)
97 (void) strlcpy(zc.zc_name, dsname, sizeof (zc.zc_name));
101 error = ioctl(di->zhp->zfs_hdl->libzfs_fd, ZFS_IOC_OBJ_TO_STATS, &zc);
104 /* we can get stats even if we failed to get a path */
105 (void) memcpy(sb, &zc.zc_stat, sizeof (zfs_stat_t));
107 ASSERT(di->zerr == 0);
108 (void) strlcpy(pn, zc.zc_value, maxlen);
112 if (di->zerr == EPERM) {
113 (void) snprintf(di->errbuf, sizeof (di->errbuf),
114 dgettext(TEXT_DOMAIN,
115 "The sys_config privilege or diff delegated permission "
116 "is needed\nto discover path names"));
119 (void) snprintf(di->errbuf, sizeof (di->errbuf),
120 dgettext(TEXT_DOMAIN,
121 "Unable to determine path or stats for "
122 "object %lld in %s"), obj, dsname);
130 * Prints a file name out a character at a time. If the character is
131 * not in the range of what we consider "printable" ASCII, display it
132 * as an escaped 3-digit octal value. ASCII values less than a space
133 * are all control characters and we declare the upper end as the
134 * DELete character. This also is the last 7-bit ASCII character.
135 * We choose to treat all 8-bit ASCII as not printable for this
139 stream_bytes(FILE *fp, const char *string)
143 while ((c = *string++) != '\0') {
144 if (c > ' ' && c != '\\' && c < '\177') {
145 (void) fprintf(fp, "%c", c);
147 (void) fprintf(fp, "\\%03o", (uint8_t)c);
153 print_what(FILE *fp, mode_t what)
157 switch (what & S_IFMT) {
193 (void) fprintf(fp, "%c", symbol);
197 print_cmn(FILE *fp, differ_info_t *di, const char *file)
199 stream_bytes(fp, di->dsmnt);
200 stream_bytes(fp, file);
204 print_rename(FILE *fp, differ_info_t *di, const char *old, const char *new,
208 (void) fprintf(fp, "%10lld.%09lld\t",
209 (longlong_t)isb->zs_ctime[0],
210 (longlong_t)isb->zs_ctime[1]);
211 (void) fprintf(fp, "%c\t", ZDIFF_RENAMED);
213 print_what(fp, isb->zs_mode);
214 (void) fprintf(fp, "\t");
216 print_cmn(fp, di, old);
218 (void) fprintf(fp, "\t");
220 (void) fprintf(fp, " -> ");
221 print_cmn(fp, di, new);
222 (void) fprintf(fp, "\n");
226 print_link_change(FILE *fp, differ_info_t *di, int delta, const char *file,
230 (void) fprintf(fp, "%10lld.%09lld\t",
231 (longlong_t)isb->zs_ctime[0],
232 (longlong_t)isb->zs_ctime[1]);
233 (void) fprintf(fp, "%c\t", ZDIFF_MODIFIED);
235 print_what(fp, isb->zs_mode);
236 (void) fprintf(fp, "\t");
238 print_cmn(fp, di, file);
239 (void) fprintf(fp, "\t(%+d)", delta);
240 (void) fprintf(fp, "\n");
244 print_file(FILE *fp, differ_info_t *di, char type, const char *file,
248 (void) fprintf(fp, "%10lld.%09lld\t",
249 (longlong_t)isb->zs_ctime[0],
250 (longlong_t)isb->zs_ctime[1]);
251 (void) fprintf(fp, "%c\t", type);
253 print_what(fp, isb->zs_mode);
254 (void) fprintf(fp, "\t");
256 print_cmn(fp, di, file);
257 (void) fprintf(fp, "\n");
261 write_inuse_diffs_one(FILE *fp, differ_info_t *di, uint64_t dobj)
263 struct zfs_stat fsb, tsb;
266 char fobjname[MAXPATHLEN], tobjname[MAXPATHLEN];
267 int fobjerr, tobjerr;
270 if (dobj == di->shares)
274 * Check the from and to snapshots for info on the object. If
275 * we get ENOENT, then the object just didn't exist in that
276 * snapshot. If we get ENOTSUP, then we tried to get
277 * info on a non-ZPL object, which we don't care about anyway.
279 fobjerr = get_stats_for_obj(di, di->fromsnap, dobj, fobjname,
281 if (fobjerr && di->zerr != ENOENT && di->zerr != ENOTSUP)
284 tobjerr = get_stats_for_obj(di, di->tosnap, dobj, tobjname,
286 if (tobjerr && di->zerr != ENOENT && di->zerr != ENOTSUP)
290 * Unallocated object sharing the same meta dnode block
292 if (fobjerr && tobjerr) {
293 ASSERT(di->zerr == ENOENT || di->zerr == ENOTSUP);
298 di->zerr = 0; /* negate get_stats_for_obj() from side that failed */
299 fmode = fsb.zs_mode & S_IFMT;
300 tmode = tsb.zs_mode & S_IFMT;
301 if (fmode == S_IFDIR || tmode == S_IFDIR || fsb.zs_links == 0 ||
305 change = tsb.zs_links - fsb.zs_links;
309 print_link_change(fp, di, change, tobjname, &tsb);
312 print_file(fp, di, ZDIFF_ADDED, tobjname, &tsb);
314 } else if (tobjerr) {
316 print_link_change(fp, di, change, fobjname, &fsb);
319 print_file(fp, di, ZDIFF_REMOVED, fobjname, &fsb);
323 if (fmode != tmode && fsb.zs_gen == tsb.zs_gen)
324 tsb.zs_gen++; /* Force a generational difference */
325 same_name = do_name_cmp(fobjname, tobjname);
327 /* Simple modification or no change */
328 if (fsb.zs_gen == tsb.zs_gen) {
329 /* No apparent changes. Could we assert !this? */
330 if (fsb.zs_ctime[0] == tsb.zs_ctime[0] &&
331 fsb.zs_ctime[1] == tsb.zs_ctime[1])
334 print_link_change(fp, di, change,
335 change > 0 ? fobjname : tobjname, &tsb);
336 } else if (same_name) {
337 print_file(fp, di, ZDIFF_MODIFIED, fobjname, &tsb);
339 print_rename(fp, di, fobjname, tobjname, &tsb);
343 /* file re-created or object re-used */
344 print_file(fp, di, ZDIFF_REMOVED, fobjname, &fsb);
345 print_file(fp, di, ZDIFF_ADDED, tobjname, &tsb);
351 write_inuse_diffs(FILE *fp, differ_info_t *di, dmu_diff_record_t *dr)
356 for (o = dr->ddr_first; o <= dr->ddr_last; o++) {
357 if ((err = write_inuse_diffs_one(fp, di, o)) != 0)
364 describe_free(FILE *fp, differ_info_t *di, uint64_t object, char *namebuf,
369 if (get_stats_for_obj(di, di->fromsnap, object, namebuf,
371 /* Let it slide, if in the delete queue on from side */
372 if (di->zerr == ENOENT && sb.zs_links == 0) {
379 print_file(fp, di, ZDIFF_REMOVED, namebuf, &sb);
384 write_free_diffs(FILE *fp, differ_info_t *di, dmu_diff_record_t *dr)
386 zfs_cmd_t zc = { 0 };
387 libzfs_handle_t *lhdl = di->zhp->zfs_hdl;
388 char fobjname[MAXPATHLEN];
390 (void) strlcpy(zc.zc_name, di->fromsnap, sizeof (zc.zc_name));
391 zc.zc_obj = dr->ddr_first - 1;
393 ASSERT(di->zerr == 0);
395 while (zc.zc_obj < dr->ddr_last) {
398 err = ioctl(lhdl->libzfs_fd, ZFS_IOC_NEXT_OBJ, &zc);
400 if (zc.zc_obj == di->shares) {
404 if (zc.zc_obj > dr->ddr_last) {
407 err = describe_free(fp, di, zc.zc_obj, fobjname,
411 } else if (errno == ESRCH) {
414 (void) snprintf(di->errbuf, sizeof (di->errbuf),
415 dgettext(TEXT_DOMAIN,
416 "next allocated object (> %lld) find failure"),
430 differ_info_t *di = arg;
431 dmu_diff_record_t dr;
435 if ((ofp = fdopen(di->outputfd, "w")) == NULL) {
437 (void) strerror_r(errno, di->errbuf, sizeof (di->errbuf));
438 (void) close(di->datafd);
443 char *cp = (char *)&dr;
444 int len = sizeof (dr);
448 rv = read(di->datafd, cp, len);
451 } while (len > 0 && rv > 0);
453 if (rv < 0 || (rv == 0 && len != sizeof (dr))) {
456 } else if (rv == 0) {
457 /* end of file at a natural breaking point */
461 switch (dr.ddr_type) {
463 err = write_free_diffs(ofp, di, &dr);
466 err = write_inuse_diffs(ofp, di, &dr);
478 (void) close(di->datafd);
482 ASSERT(di->zerr == EINVAL);
483 (void) snprintf(di->errbuf, sizeof (di->errbuf),
484 dgettext(TEXT_DOMAIN,
485 "Internal error: bad data from diff IOCTL"));
492 find_shares_object(differ_info_t *di)
494 char fullpath[MAXPATHLEN];
495 struct stat64 sb = { 0 };
497 (void) strlcpy(fullpath, di->dsmnt, MAXPATHLEN);
498 (void) strlcat(fullpath, ZDIFF_SHARESDIR, MAXPATHLEN);
500 if (stat64(fullpath, &sb) != 0) {
502 (void) snprintf(di->errbuf, sizeof (di->errbuf),
503 dgettext(TEXT_DOMAIN, "Cannot stat %s"), fullpath);
504 return (zfs_error(di->zhp->zfs_hdl, EZFS_DIFF, di->errbuf));
510 di->shares = (uint64_t)sb.st_ino;
515 make_temp_snapshot(differ_info_t *di)
517 libzfs_handle_t *hdl = di->zhp->zfs_hdl;
518 zfs_cmd_t zc = { 0 };
520 (void) snprintf(zc.zc_value, sizeof (zc.zc_value),
521 ZDIFF_PREFIX, getpid());
522 (void) strlcpy(zc.zc_name, di->ds, sizeof (zc.zc_name));
523 zc.zc_cleanup_fd = di->cleanupfd;
525 if (ioctl(hdl->libzfs_fd, ZFS_IOC_TMP_SNAPSHOT, &zc) != 0) {
528 (void) snprintf(di->errbuf, sizeof (di->errbuf),
529 dgettext(TEXT_DOMAIN, "The diff delegated "
530 "permission is needed in order\nto create a "
531 "just-in-time snapshot for diffing\n"));
532 return (zfs_error(hdl, EZFS_DIFF, di->errbuf));
534 (void) snprintf(di->errbuf, sizeof (di->errbuf),
535 dgettext(TEXT_DOMAIN, "Cannot create just-in-time "
536 "snapshot of '%s'"), zc.zc_name);
537 return (zfs_standard_error(hdl, err, di->errbuf));
541 di->tmpsnap = zfs_strdup(hdl, zc.zc_value);
542 di->tosnap = zfs_asprintf(hdl, "%s@%s", di->ds, di->tmpsnap);
547 teardown_differ_info(differ_info_t *di)
556 (void) close(di->cleanupfd);
560 get_snapshot_names(differ_info_t *di, const char *fromsnap,
563 libzfs_handle_t *hdl = di->zhp->zfs_hdl;
572 * dataset@snap1 dataset@snap2
573 * dataset@snap1 @snap2
574 * dataset@snap1 dataset
575 * @snap1 dataset@snap2
577 if (tosnap == NULL) {
578 /* only a from snapshot given, must be valid */
579 (void) snprintf(di->errbuf, sizeof (di->errbuf),
580 dgettext(TEXT_DOMAIN,
581 "Badly formed snapshot name %s"), fromsnap);
583 if (!zfs_validate_name(hdl, fromsnap, ZFS_TYPE_SNAPSHOT,
585 return (zfs_error(hdl, EZFS_INVALIDNAME,
589 atptrf = strchr(fromsnap, '@');
590 ASSERT(atptrf != NULL);
591 fdslen = atptrf - fromsnap;
593 di->fromsnap = zfs_strdup(hdl, fromsnap);
594 di->ds = zfs_strdup(hdl, fromsnap);
595 di->ds[fdslen] = '\0';
597 /* the to snap will be a just-in-time snap of the head */
598 return (make_temp_snapshot(di));
601 (void) snprintf(di->errbuf, sizeof (di->errbuf),
602 dgettext(TEXT_DOMAIN,
603 "Unable to determine which snapshots to compare"));
605 atptrf = strchr(fromsnap, '@');
606 atptrt = strchr(tosnap, '@');
607 fdslen = atptrf ? atptrf - fromsnap : strlen(fromsnap);
608 tdslen = atptrt ? atptrt - tosnap : strlen(tosnap);
609 fsnlen = strlen(fromsnap) - fdslen; /* includes @ sign */
610 tsnlen = strlen(tosnap) - tdslen; /* includes @ sign */
612 if (fsnlen <= 1 || tsnlen == 1 || (fdslen == 0 && tdslen == 0) ||
613 (fsnlen == 0 && tsnlen == 0)) {
614 return (zfs_error(hdl, EZFS_INVALIDNAME, di->errbuf));
615 } else if ((fdslen > 0 && tdslen > 0) &&
616 ((tdslen != fdslen || strncmp(fromsnap, tosnap, fdslen) != 0))) {
618 * not the same dataset name, might be okay if
619 * tosnap is a clone of a fromsnap descendant.
621 char origin[ZFS_MAXNAMELEN];
625 di->ds = zfs_alloc(di->zhp->zfs_hdl, tdslen + 1);
626 (void) strncpy(di->ds, tosnap, tdslen);
627 di->ds[tdslen] = '\0';
629 zhp = zfs_open(hdl, di->ds, ZFS_TYPE_FILESYSTEM);
630 while (zhp != NULL) {
631 if (zfs_prop_get(zhp, ZFS_PROP_ORIGIN, origin,
632 sizeof (origin), &src, NULL, 0, B_FALSE) != 0) {
633 (void) zfs_close(zhp);
637 if (strncmp(origin, fromsnap, fsnlen) == 0)
640 (void) zfs_close(zhp);
641 zhp = zfs_open(hdl, origin, ZFS_TYPE_FILESYSTEM);
645 (void) snprintf(di->errbuf, sizeof (di->errbuf),
646 dgettext(TEXT_DOMAIN,
647 "Not an earlier snapshot from the same fs"));
648 return (zfs_error(hdl, EZFS_INVALIDNAME, di->errbuf));
650 (void) zfs_close(zhp);
653 di->isclone = B_TRUE;
654 di->fromsnap = zfs_strdup(hdl, fromsnap);
656 di->tosnap = zfs_strdup(hdl, tosnap);
658 return (make_temp_snapshot(di));
661 int dslen = fdslen ? fdslen : tdslen;
663 di->ds = zfs_alloc(hdl, dslen + 1);
664 (void) strncpy(di->ds, fdslen ? fromsnap : tosnap, dslen);
665 di->ds[dslen] = '\0';
667 di->fromsnap = zfs_asprintf(hdl, "%s%s", di->ds, atptrf);
669 di->tosnap = zfs_asprintf(hdl, "%s%s", di->ds, atptrt);
671 return (make_temp_snapshot(di));
678 get_mountpoint(differ_info_t *di, char *dsnm, char **mntpt)
682 mounted = is_mounted(di->zhp->zfs_hdl, dsnm, mntpt);
683 if (mounted == B_FALSE) {
684 (void) snprintf(di->errbuf, sizeof (di->errbuf),
685 dgettext(TEXT_DOMAIN,
686 "Cannot diff an unmounted snapshot"));
687 return (zfs_error(di->zhp->zfs_hdl, EZFS_BADTYPE, di->errbuf));
690 /* Avoid a double slash at the beginning of root-mounted datasets */
691 if (**mntpt == '/' && *(*mntpt + 1) == '\0')
697 get_mountpoints(differ_info_t *di)
703 * first get the mountpoint for the parent dataset
705 if (get_mountpoint(di, di->ds, &di->dsmnt) != 0)
708 strptr = strchr(di->tosnap, '@');
709 ASSERT3P(strptr, !=, NULL);
710 di->tomnt = zfs_asprintf(di->zhp->zfs_hdl, "%s%s%s", di->dsmnt,
711 ZDIFF_SNAPDIR, ++strptr);
713 strptr = strchr(di->fromsnap, '@');
714 ASSERT3P(strptr, !=, NULL);
716 frommntpt = di->dsmnt;
722 err = get_mountpoint(di, di->fromsnap, &mntpt);
729 di->frommnt = zfs_asprintf(di->zhp->zfs_hdl, "%s%s%s", frommntpt,
730 ZDIFF_SNAPDIR, ++strptr);
739 setup_differ_info(zfs_handle_t *zhp, const char *fromsnap,
740 const char *tosnap, differ_info_t *di)
744 di->cleanupfd = open(ZFS_DEV, O_RDWR|O_EXCL);
745 VERIFY(di->cleanupfd >= 0);
747 if (get_snapshot_names(di, fromsnap, tosnap) != 0)
750 if (get_mountpoints(di) != 0)
753 if (find_shares_object(di) != 0)
760 zfs_show_diffs(zfs_handle_t *zhp, int outfd, const char *fromsnap,
761 const char *tosnap, int flags)
763 zfs_cmd_t zc = { 0 };
765 differ_info_t di = { 0 };
770 (void) snprintf(errbuf, sizeof (errbuf),
771 dgettext(TEXT_DOMAIN, "zfs diff failed"));
773 if (setup_differ_info(zhp, fromsnap, tosnap, &di)) {
774 teardown_differ_info(&di);
779 zfs_error_aux(zhp->zfs_hdl, strerror(errno));
780 teardown_differ_info(&di);
781 return (zfs_error(zhp->zfs_hdl, EZFS_PIPEFAILED, errbuf));
784 di.scripted = (flags & ZFS_DIFF_PARSEABLE);
785 di.classify = (flags & ZFS_DIFF_CLASSIFY);
786 di.timestamped = (flags & ZFS_DIFF_TIMESTAMP);
789 di.datafd = pipefd[0];
791 if (pthread_create(&tid, NULL, differ, &di)) {
792 zfs_error_aux(zhp->zfs_hdl, strerror(errno));
793 (void) close(pipefd[0]);
794 (void) close(pipefd[1]);
795 teardown_differ_info(&di);
796 return (zfs_error(zhp->zfs_hdl,
797 EZFS_THREADCREATEFAILED, errbuf));
801 (void) strlcpy(zc.zc_value, di.fromsnap, strlen(di.fromsnap) + 1);
802 (void) strlcpy(zc.zc_name, di.tosnap, strlen(di.tosnap) + 1);
803 zc.zc_cookie = pipefd[1];
805 iocerr = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_DIFF, &zc);
807 (void) snprintf(errbuf, sizeof (errbuf),
808 dgettext(TEXT_DOMAIN, "Unable to obtain diffs"));
809 if (errno == EPERM) {
810 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
811 "\n The sys_mount privilege or diff delegated "
812 "permission is needed\n to execute the "
814 } else if (errno == EXDEV) {
815 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
816 "\n Not an earlier snapshot from the same fs"));
817 } else if (errno != EPIPE || di.zerr == 0) {
818 zfs_error_aux(zhp->zfs_hdl, strerror(errno));
820 (void) close(pipefd[1]);
821 (void) pthread_cancel(tid);
822 (void) pthread_join(tid, NULL);
823 teardown_differ_info(&di);
824 if (di.zerr != 0 && di.zerr != EPIPE) {
825 zfs_error_aux(zhp->zfs_hdl, strerror(di.zerr));
826 return (zfs_error(zhp->zfs_hdl, EZFS_DIFF, di.errbuf));
828 return (zfs_error(zhp->zfs_hdl, EZFS_DIFFDATA, errbuf));
832 (void) close(pipefd[1]);
833 (void) pthread_join(tid, NULL);
836 zfs_error_aux(zhp->zfs_hdl, strerror(di.zerr));
837 return (zfs_error(zhp->zfs_hdl, EZFS_DIFF, di.errbuf));
839 teardown_differ_info(&di);