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>
45 #include <sys/zfs_ioctl.h>
47 #include "libzfs_impl.h"
49 #define ZDIFF_SNAPDIR "/.zfs/snapshot/"
50 #define ZDIFF_SHARESDIR "/.zfs/shares/"
51 #define ZDIFF_PREFIX "zfs-diff-%d"
53 #define ZDIFF_ADDED '+'
54 #define ZDIFF_MODIFIED 'M'
55 #define ZDIFF_REMOVED '-'
56 #define ZDIFF_RENAMED 'R'
58 typedef struct differ_info {
71 boolean_t timestamped;
80 * Given a {dsname, object id}, get the object path
83 get_stats_for_obj(differ_info_t *di, const char *dsname, uint64_t obj,
84 char *pn, int maxlen, zfs_stat_t *sb)
86 zfs_cmd_t zc = {"\0"};
89 (void) strlcpy(zc.zc_name, dsname, sizeof (zc.zc_name));
93 error = ioctl(di->zhp->zfs_hdl->libzfs_fd, ZFS_IOC_OBJ_TO_STATS, &zc);
96 /* we can get stats even if we failed to get a path */
97 (void) memcpy(sb, &zc.zc_stat, sizeof (zfs_stat_t));
99 ASSERT(di->zerr == 0);
100 (void) strlcpy(pn, zc.zc_value, maxlen);
104 if (di->zerr == EPERM) {
105 (void) snprintf(di->errbuf, sizeof (di->errbuf),
106 dgettext(TEXT_DOMAIN,
107 "The sys_config privilege or diff delegated permission "
108 "is needed\nto discover path names"));
111 (void) snprintf(di->errbuf, sizeof (di->errbuf),
112 dgettext(TEXT_DOMAIN,
113 "Unable to determine path or stats for "
114 "object %lld in %s"), (longlong_t)obj, dsname);
122 * Prints a file name out a character at a time. If the character is
123 * not in the range of what we consider "printable" ASCII, display it
124 * as an escaped 4-digit octal value. ASCII values less than a space
125 * are all control characters and we declare the upper end as the
126 * DELete character. This also is the last 7-bit ASCII character.
127 * We choose to treat all 8-bit ASCII as not printable for this
131 stream_bytes(FILE *fp, const char *string)
135 while ((c = *string++) != '\0') {
136 if (c > ' ' && c != '\\' && c < '\177') {
137 (void) fprintf(fp, "%c", c);
139 (void) fprintf(fp, "\\%04o", (uint8_t)c);
145 print_what(FILE *fp, mode_t what)
149 switch (what & S_IFMT) {
185 (void) fprintf(fp, "%c", symbol);
189 print_cmn(FILE *fp, differ_info_t *di, const char *file)
191 stream_bytes(fp, di->dsmnt);
192 stream_bytes(fp, file);
196 print_rename(FILE *fp, differ_info_t *di, const char *old, const char *new,
200 (void) fprintf(fp, "%10lld.%09lld\t",
201 (longlong_t)isb->zs_ctime[0],
202 (longlong_t)isb->zs_ctime[1]);
203 (void) fprintf(fp, "%c\t", ZDIFF_RENAMED);
205 print_what(fp, isb->zs_mode);
206 (void) fprintf(fp, "\t");
208 print_cmn(fp, di, old);
210 (void) fprintf(fp, "\t");
212 (void) fprintf(fp, " -> ");
213 print_cmn(fp, di, new);
214 (void) fprintf(fp, "\n");
218 print_link_change(FILE *fp, differ_info_t *di, int delta, const char *file,
222 (void) fprintf(fp, "%10lld.%09lld\t",
223 (longlong_t)isb->zs_ctime[0],
224 (longlong_t)isb->zs_ctime[1]);
225 (void) fprintf(fp, "%c\t", ZDIFF_MODIFIED);
227 print_what(fp, isb->zs_mode);
228 (void) fprintf(fp, "\t");
230 print_cmn(fp, di, file);
231 (void) fprintf(fp, "\t(%+d)", delta);
232 (void) fprintf(fp, "\n");
236 print_file(FILE *fp, differ_info_t *di, char type, const char *file,
240 (void) fprintf(fp, "%10lld.%09lld\t",
241 (longlong_t)isb->zs_ctime[0],
242 (longlong_t)isb->zs_ctime[1]);
243 (void) fprintf(fp, "%c\t", type);
245 print_what(fp, isb->zs_mode);
246 (void) fprintf(fp, "\t");
248 print_cmn(fp, di, file);
249 (void) fprintf(fp, "\n");
253 write_inuse_diffs_one(FILE *fp, differ_info_t *di, uint64_t dobj)
255 struct zfs_stat fsb, tsb;
257 char fobjname[MAXPATHLEN], tobjname[MAXPATHLEN];
258 int fobjerr, tobjerr;
261 if (dobj == di->shares)
265 * Check the from and to snapshots for info on the object. If
266 * we get ENOENT, then the object just didn't exist in that
267 * snapshot. If we get ENOTSUP, then we tried to get
268 * info on a non-ZPL object, which we don't care about anyway.
270 fobjerr = get_stats_for_obj(di, di->fromsnap, dobj, fobjname,
272 if (fobjerr && di->zerr != ENOENT && di->zerr != ENOTSUP)
275 tobjerr = get_stats_for_obj(di, di->tosnap, dobj, tobjname,
277 if (tobjerr && di->zerr != ENOENT && di->zerr != ENOTSUP)
281 * Unallocated object sharing the same meta dnode block
283 if (fobjerr && tobjerr) {
284 ASSERT(di->zerr == ENOENT || di->zerr == ENOTSUP);
289 di->zerr = 0; /* negate get_stats_for_obj() from side that failed */
290 fmode = fsb.zs_mode & S_IFMT;
291 tmode = tsb.zs_mode & S_IFMT;
292 if (fmode == S_IFDIR || tmode == S_IFDIR || fsb.zs_links == 0 ||
296 change = tsb.zs_links - fsb.zs_links;
300 print_link_change(fp, di, change, tobjname, &tsb);
303 print_file(fp, di, ZDIFF_ADDED, tobjname, &tsb);
305 } else if (tobjerr) {
307 print_link_change(fp, di, change, fobjname, &fsb);
310 print_file(fp, di, ZDIFF_REMOVED, fobjname, &fsb);
314 if (fmode != tmode && fsb.zs_gen == tsb.zs_gen)
315 tsb.zs_gen++; /* Force a generational difference */
317 /* Simple modification or no change */
318 if (fsb.zs_gen == tsb.zs_gen) {
319 /* No apparent changes. Could we assert !this? */
320 if (fsb.zs_ctime[0] == tsb.zs_ctime[0] &&
321 fsb.zs_ctime[1] == tsb.zs_ctime[1])
324 print_link_change(fp, di, change,
325 change > 0 ? fobjname : tobjname, &tsb);
326 } else if (strcmp(fobjname, tobjname) == 0) {
327 print_file(fp, di, ZDIFF_MODIFIED, fobjname, &tsb);
329 print_rename(fp, di, fobjname, tobjname, &tsb);
333 /* file re-created or object re-used */
334 print_file(fp, di, ZDIFF_REMOVED, fobjname, &fsb);
335 print_file(fp, di, ZDIFF_ADDED, tobjname, &tsb);
341 write_inuse_diffs(FILE *fp, differ_info_t *di, dmu_diff_record_t *dr)
346 for (o = dr->ddr_first; o <= dr->ddr_last; o++) {
347 if ((err = write_inuse_diffs_one(fp, di, o)))
354 describe_free(FILE *fp, differ_info_t *di, uint64_t object, char *namebuf,
359 if (get_stats_for_obj(di, di->fromsnap, object, namebuf,
361 /* Let it slide, if in the delete queue on from side */
362 if (di->zerr == ENOENT && sb.zs_links == 0) {
369 print_file(fp, di, ZDIFF_REMOVED, namebuf, &sb);
374 write_free_diffs(FILE *fp, differ_info_t *di, dmu_diff_record_t *dr)
376 zfs_cmd_t zc = {"\0"};
377 libzfs_handle_t *lhdl = di->zhp->zfs_hdl;
378 char fobjname[MAXPATHLEN];
380 (void) strlcpy(zc.zc_name, di->fromsnap, sizeof (zc.zc_name));
381 zc.zc_obj = dr->ddr_first - 1;
383 ASSERT(di->zerr == 0);
385 while (zc.zc_obj < dr->ddr_last) {
388 err = ioctl(lhdl->libzfs_fd, ZFS_IOC_NEXT_OBJ, &zc);
390 if (zc.zc_obj == di->shares) {
394 if (zc.zc_obj > dr->ddr_last) {
397 err = describe_free(fp, di, zc.zc_obj, fobjname,
401 } else if (errno == ESRCH) {
404 (void) snprintf(di->errbuf, sizeof (di->errbuf),
405 dgettext(TEXT_DOMAIN,
406 "next allocated object (> %lld) find failure"),
407 (longlong_t)zc.zc_obj);
420 differ_info_t *di = arg;
421 dmu_diff_record_t dr;
425 if ((ofp = fdopen(di->outputfd, "w")) == NULL) {
427 strncpy(di->errbuf, strerror(errno), sizeof (di->errbuf));
428 (void) close(di->datafd);
433 char *cp = (char *)&dr;
434 int len = sizeof (dr);
438 rv = read(di->datafd, cp, len);
441 } while (len > 0 && rv > 0);
443 if (rv < 0 || (rv == 0 && len != sizeof (dr))) {
446 } else if (rv == 0) {
447 /* end of file at a natural breaking point */
451 switch (dr.ddr_type) {
453 err = write_free_diffs(ofp, di, &dr);
456 err = write_inuse_diffs(ofp, di, &dr);
468 (void) close(di->datafd);
472 ASSERT(di->zerr == EINVAL);
473 (void) snprintf(di->errbuf, sizeof (di->errbuf),
474 dgettext(TEXT_DOMAIN,
475 "Internal error: bad data from diff IOCTL"));
482 find_shares_object(differ_info_t *di)
484 char fullpath[MAXPATHLEN];
485 struct stat64 sb = { 0 };
487 (void) strlcpy(fullpath, di->dsmnt, MAXPATHLEN);
488 (void) strlcat(fullpath, ZDIFF_SHARESDIR, MAXPATHLEN);
490 if (stat64(fullpath, &sb) != 0) {
491 (void) snprintf(di->errbuf, sizeof (di->errbuf),
492 dgettext(TEXT_DOMAIN, "Cannot stat %s"), fullpath);
493 return (zfs_error(di->zhp->zfs_hdl, EZFS_DIFF, di->errbuf));
496 di->shares = (uint64_t)sb.st_ino;
501 make_temp_snapshot(differ_info_t *di)
503 libzfs_handle_t *hdl = di->zhp->zfs_hdl;
504 zfs_cmd_t zc = {"\0"};
506 (void) snprintf(zc.zc_value, sizeof (zc.zc_value),
507 ZDIFF_PREFIX, getpid());
508 (void) strlcpy(zc.zc_name, di->ds, sizeof (zc.zc_name));
509 zc.zc_cleanup_fd = di->cleanupfd;
511 if (ioctl(hdl->libzfs_fd, ZFS_IOC_TMP_SNAPSHOT, &zc) != 0) {
514 (void) snprintf(di->errbuf, sizeof (di->errbuf),
515 dgettext(TEXT_DOMAIN, "The diff delegated "
516 "permission is needed in order\nto create a "
517 "just-in-time snapshot for diffing\n"));
518 return (zfs_error(hdl, EZFS_DIFF, di->errbuf));
520 (void) snprintf(di->errbuf, sizeof (di->errbuf),
521 dgettext(TEXT_DOMAIN, "Cannot create just-in-time "
522 "snapshot of '%s'"), zc.zc_name);
523 return (zfs_standard_error(hdl, err, di->errbuf));
527 di->tmpsnap = zfs_strdup(hdl, zc.zc_value);
528 di->tosnap = zfs_asprintf(hdl, "%s@%s", di->ds, di->tmpsnap);
533 teardown_differ_info(differ_info_t *di)
542 (void) close(di->cleanupfd);
546 get_snapshot_names(differ_info_t *di, const char *fromsnap,
549 libzfs_handle_t *hdl = di->zhp->zfs_hdl;
558 * dataset@snap1 dataset@snap2
559 * dataset@snap1 @snap2
560 * dataset@snap1 dataset
561 * @snap1 dataset@snap2
563 if (tosnap == NULL) {
564 /* only a from snapshot given, must be valid */
565 (void) snprintf(di->errbuf, sizeof (di->errbuf),
566 dgettext(TEXT_DOMAIN,
567 "Badly formed snapshot name %s"), fromsnap);
569 if (!zfs_validate_name(hdl, fromsnap, ZFS_TYPE_SNAPSHOT,
571 return (zfs_error(hdl, EZFS_INVALIDNAME,
575 atptrf = strchr(fromsnap, '@');
576 ASSERT(atptrf != NULL);
577 fdslen = atptrf - fromsnap;
579 di->fromsnap = zfs_strdup(hdl, fromsnap);
580 di->ds = zfs_strdup(hdl, fromsnap);
581 di->ds[fdslen] = '\0';
583 /* the to snap will be a just-in-time snap of the head */
584 return (make_temp_snapshot(di));
587 (void) snprintf(di->errbuf, sizeof (di->errbuf),
588 dgettext(TEXT_DOMAIN,
589 "Unable to determine which snapshots to compare"));
591 atptrf = strchr(fromsnap, '@');
592 atptrt = strchr(tosnap, '@');
593 fdslen = atptrf ? atptrf - fromsnap : strlen(fromsnap);
594 tdslen = atptrt ? atptrt - tosnap : strlen(tosnap);
595 fsnlen = strlen(fromsnap) - fdslen; /* includes @ sign */
596 tsnlen = strlen(tosnap) - tdslen; /* includes @ sign */
598 if (fsnlen <= 1 || tsnlen == 1 || (fdslen == 0 && tdslen == 0) ||
599 (fsnlen == 0 && tsnlen == 0)) {
600 return (zfs_error(hdl, EZFS_INVALIDNAME, di->errbuf));
601 } else if ((fdslen > 0 && tdslen > 0) &&
602 ((tdslen != fdslen || strncmp(fromsnap, tosnap, fdslen) != 0))) {
604 * not the same dataset name, might be okay if
605 * tosnap is a clone of a fromsnap descendant.
607 char origin[ZFS_MAXNAMELEN];
611 di->ds = zfs_alloc(di->zhp->zfs_hdl, tdslen + 1);
612 (void) strncpy(di->ds, tosnap, tdslen);
613 di->ds[tdslen] = '\0';
615 zhp = zfs_open(hdl, di->ds, ZFS_TYPE_FILESYSTEM);
616 while (zhp != NULL) {
617 if (zfs_prop_get(zhp, ZFS_PROP_ORIGIN, origin,
618 sizeof (origin), &src, NULL, 0, B_FALSE) != 0) {
619 (void) zfs_close(zhp);
623 if (strncmp(origin, fromsnap, fsnlen) == 0)
626 (void) zfs_close(zhp);
627 zhp = zfs_open(hdl, origin, ZFS_TYPE_FILESYSTEM);
631 (void) snprintf(di->errbuf, sizeof (di->errbuf),
632 dgettext(TEXT_DOMAIN,
633 "Not an earlier snapshot from the same fs"));
634 return (zfs_error(hdl, EZFS_INVALIDNAME, di->errbuf));
636 (void) zfs_close(zhp);
639 di->isclone = B_TRUE;
640 di->fromsnap = zfs_strdup(hdl, fromsnap);
642 di->tosnap = zfs_strdup(hdl, tosnap);
644 return (make_temp_snapshot(di));
647 int dslen = fdslen ? fdslen : tdslen;
649 di->ds = zfs_alloc(hdl, dslen + 1);
650 (void) strncpy(di->ds, fdslen ? fromsnap : tosnap, dslen);
651 di->ds[dslen] = '\0';
653 di->fromsnap = zfs_asprintf(hdl, "%s%s", di->ds, atptrf);
655 di->tosnap = zfs_asprintf(hdl, "%s%s", di->ds, atptrt);
657 return (make_temp_snapshot(di));
664 get_mountpoint(differ_info_t *di, char *dsnm, char **mntpt)
668 mounted = is_mounted(di->zhp->zfs_hdl, dsnm, mntpt);
669 if (mounted == B_FALSE) {
670 (void) snprintf(di->errbuf, sizeof (di->errbuf),
671 dgettext(TEXT_DOMAIN,
672 "Cannot diff an unmounted snapshot"));
673 return (zfs_error(di->zhp->zfs_hdl, EZFS_BADTYPE, di->errbuf));
676 /* Avoid a double slash at the beginning of root-mounted datasets */
677 if (**mntpt == '/' && *(*mntpt + 1) == '\0')
683 get_mountpoints(differ_info_t *di)
689 * first get the mountpoint for the parent dataset
691 if (get_mountpoint(di, di->ds, &di->dsmnt) != 0)
694 strptr = strchr(di->tosnap, '@');
695 ASSERT3P(strptr, !=, NULL);
696 di->tomnt = zfs_asprintf(di->zhp->zfs_hdl, "%s%s%s", di->dsmnt,
697 ZDIFF_SNAPDIR, ++strptr);
699 strptr = strchr(di->fromsnap, '@');
700 ASSERT3P(strptr, !=, NULL);
702 frommntpt = di->dsmnt;
708 err = get_mountpoint(di, di->fromsnap, &mntpt);
715 di->frommnt = zfs_asprintf(di->zhp->zfs_hdl, "%s%s%s", frommntpt,
716 ZDIFF_SNAPDIR, ++strptr);
725 setup_differ_info(zfs_handle_t *zhp, const char *fromsnap,
726 const char *tosnap, differ_info_t *di)
730 di->cleanupfd = open(ZFS_DEV, O_RDWR);
731 VERIFY(di->cleanupfd >= 0);
733 if (get_snapshot_names(di, fromsnap, tosnap) != 0)
736 if (get_mountpoints(di) != 0)
739 if (find_shares_object(di) != 0)
746 zfs_show_diffs(zfs_handle_t *zhp, int outfd, const char *fromsnap,
747 const char *tosnap, int flags)
749 zfs_cmd_t zc = {"\0"};
751 differ_info_t di = { 0 };
756 (void) snprintf(errbuf, sizeof (errbuf),
757 dgettext(TEXT_DOMAIN, "zfs diff failed"));
759 if (setup_differ_info(zhp, fromsnap, tosnap, &di)) {
760 teardown_differ_info(&di);
765 zfs_error_aux(zhp->zfs_hdl, strerror(errno));
766 teardown_differ_info(&di);
767 return (zfs_error(zhp->zfs_hdl, EZFS_PIPEFAILED, errbuf));
770 di.scripted = (flags & ZFS_DIFF_PARSEABLE);
771 di.classify = (flags & ZFS_DIFF_CLASSIFY);
772 di.timestamped = (flags & ZFS_DIFF_TIMESTAMP);
775 di.datafd = pipefd[0];
777 if (pthread_create(&tid, NULL, differ, &di)) {
778 zfs_error_aux(zhp->zfs_hdl, strerror(errno));
779 (void) close(pipefd[0]);
780 (void) close(pipefd[1]);
781 teardown_differ_info(&di);
782 return (zfs_error(zhp->zfs_hdl,
783 EZFS_THREADCREATEFAILED, errbuf));
787 (void) strlcpy(zc.zc_value, di.fromsnap, strlen(di.fromsnap) + 1);
788 (void) strlcpy(zc.zc_name, di.tosnap, strlen(di.tosnap) + 1);
789 zc.zc_cookie = pipefd[1];
791 iocerr = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_DIFF, &zc);
793 (void) snprintf(errbuf, sizeof (errbuf),
794 dgettext(TEXT_DOMAIN, "Unable to obtain diffs"));
795 if (errno == EPERM) {
796 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
797 "\n The sys_mount privilege or diff delegated "
798 "permission is needed\n to execute the "
800 } else if (errno == EXDEV) {
801 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
802 "\n Not an earlier snapshot from the same fs"));
803 } else if (errno != EPIPE || di.zerr == 0) {
804 zfs_error_aux(zhp->zfs_hdl, strerror(errno));
806 (void) close(pipefd[1]);
807 (void) pthread_cancel(tid);
808 (void) pthread_join(tid, NULL);
809 teardown_differ_info(&di);
810 if (di.zerr != 0 && di.zerr != EPIPE) {
811 zfs_error_aux(zhp->zfs_hdl, strerror(di.zerr));
812 return (zfs_error(zhp->zfs_hdl, EZFS_DIFF, di.errbuf));
814 return (zfs_error(zhp->zfs_hdl, EZFS_DIFFDATA, errbuf));
818 (void) close(pipefd[1]);
819 (void) pthread_join(tid, NULL);
822 zfs_error_aux(zhp->zfs_hdl, strerror(di.zerr));
823 return (zfs_error(zhp->zfs_hdl, EZFS_DIFF, di.errbuf));
825 teardown_differ_info(&di);