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 (c) 2015 by Delphix. All rights reserved.
26 * Copyright 2016 Joyent, Inc.
27 * Copyright 2016 Igor Kozhukhov <ikozhukhov@gmail.com>
37 #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'
59 do_name_cmp(const char *fpath, const char *tpath)
62 fname = strrchr(fpath, '/') + 1;
63 tname = strrchr(tpath, '/') + 1;
64 return (strcmp(fname, tname) == 0);
67 typedef struct differ_info {
80 boolean_t timestamped;
89 * Given a {dsname, object id}, get the object path
92 get_stats_for_obj(differ_info_t *di, const char *dsname, uint64_t obj,
93 char *pn, int maxlen, zfs_stat_t *sb)
98 (void) strlcpy(zc.zc_name, dsname, sizeof (zc.zc_name));
102 error = ioctl(di->zhp->zfs_hdl->libzfs_fd, ZFS_IOC_OBJ_TO_STATS, &zc);
105 /* we can get stats even if we failed to get a path */
106 (void) memcpy(sb, &zc.zc_stat, sizeof (zfs_stat_t));
108 ASSERT(di->zerr == 0);
109 (void) strlcpy(pn, zc.zc_value, maxlen);
113 if (di->zerr == EPERM) {
114 (void) snprintf(di->errbuf, sizeof (di->errbuf),
115 dgettext(TEXT_DOMAIN,
116 "The sys_config privilege or diff delegated permission "
117 "is needed\nto discover path names"));
120 (void) snprintf(di->errbuf, sizeof (di->errbuf),
121 dgettext(TEXT_DOMAIN,
122 "Unable to determine path or stats for "
123 "object %lld in %s"), obj, dsname);
131 * Prints a file name out a character at a time. If the character is
132 * not in the range of what we consider "printable" ASCII, display it
133 * as an escaped 3-digit octal value. ASCII values less than a space
134 * are all control characters and we declare the upper end as the
135 * DELete character. This also is the last 7-bit ASCII character.
136 * We choose to treat all 8-bit ASCII as not printable for this
140 stream_bytes(FILE *fp, const char *string)
144 while ((c = *string++) != '\0') {
145 if (c > ' ' && c != '\\' && c < '\177') {
146 (void) fprintf(fp, "%c", c);
148 (void) fprintf(fp, "\\%03o", (uint8_t)c);
154 print_what(FILE *fp, mode_t what)
158 switch (what & S_IFMT) {
194 (void) fprintf(fp, "%c", symbol);
198 print_cmn(FILE *fp, differ_info_t *di, const char *file)
200 stream_bytes(fp, di->dsmnt);
201 stream_bytes(fp, file);
205 print_rename(FILE *fp, differ_info_t *di, const char *old, const char *new,
209 (void) fprintf(fp, "%10lld.%09lld\t",
210 (longlong_t)isb->zs_ctime[0],
211 (longlong_t)isb->zs_ctime[1]);
212 (void) fprintf(fp, "%c\t", ZDIFF_RENAMED);
214 print_what(fp, isb->zs_mode);
215 (void) fprintf(fp, "\t");
217 print_cmn(fp, di, old);
219 (void) fprintf(fp, "\t");
221 (void) fprintf(fp, " -> ");
222 print_cmn(fp, di, new);
223 (void) fprintf(fp, "\n");
227 print_link_change(FILE *fp, differ_info_t *di, int delta, const char *file,
231 (void) fprintf(fp, "%10lld.%09lld\t",
232 (longlong_t)isb->zs_ctime[0],
233 (longlong_t)isb->zs_ctime[1]);
234 (void) fprintf(fp, "%c\t", ZDIFF_MODIFIED);
236 print_what(fp, isb->zs_mode);
237 (void) fprintf(fp, "\t");
239 print_cmn(fp, di, file);
240 (void) fprintf(fp, "\t(%+d)", delta);
241 (void) fprintf(fp, "\n");
245 print_file(FILE *fp, differ_info_t *di, char type, const char *file,
249 (void) fprintf(fp, "%10lld.%09lld\t",
250 (longlong_t)isb->zs_ctime[0],
251 (longlong_t)isb->zs_ctime[1]);
252 (void) fprintf(fp, "%c\t", type);
254 print_what(fp, isb->zs_mode);
255 (void) fprintf(fp, "\t");
257 print_cmn(fp, di, file);
258 (void) fprintf(fp, "\n");
262 write_inuse_diffs_one(FILE *fp, differ_info_t *di, uint64_t dobj)
264 struct zfs_stat fsb, tsb;
267 char fobjname[MAXPATHLEN], tobjname[MAXPATHLEN];
268 int fobjerr, tobjerr;
271 if (dobj == di->shares)
275 * Check the from and to snapshots for info on the object. If
276 * we get ENOENT, then the object just didn't exist in that
277 * snapshot. If we get ENOTSUP, then we tried to get
278 * info on a non-ZPL object, which we don't care about anyway.
280 fobjerr = get_stats_for_obj(di, di->fromsnap, dobj, fobjname,
282 if (fobjerr && di->zerr != ENOENT && di->zerr != ENOTSUP)
285 tobjerr = get_stats_for_obj(di, di->tosnap, dobj, tobjname,
287 if (tobjerr && di->zerr != ENOENT && di->zerr != ENOTSUP)
291 * Unallocated object sharing the same meta dnode block
293 if (fobjerr && tobjerr) {
294 ASSERT(di->zerr == ENOENT || di->zerr == ENOTSUP);
299 di->zerr = 0; /* negate get_stats_for_obj() from side that failed */
300 fmode = fsb.zs_mode & S_IFMT;
301 tmode = tsb.zs_mode & S_IFMT;
302 if (fmode == S_IFDIR || tmode == S_IFDIR || fsb.zs_links == 0 ||
306 change = tsb.zs_links - fsb.zs_links;
310 print_link_change(fp, di, change, tobjname, &tsb);
313 print_file(fp, di, ZDIFF_ADDED, tobjname, &tsb);
315 } else if (tobjerr) {
317 print_link_change(fp, di, change, fobjname, &fsb);
320 print_file(fp, di, ZDIFF_REMOVED, fobjname, &fsb);
324 if (fmode != tmode && fsb.zs_gen == tsb.zs_gen)
325 tsb.zs_gen++; /* Force a generational difference */
326 same_name = do_name_cmp(fobjname, tobjname);
328 /* Simple modification or no change */
329 if (fsb.zs_gen == tsb.zs_gen) {
330 /* No apparent changes. Could we assert !this? */
331 if (fsb.zs_ctime[0] == tsb.zs_ctime[0] &&
332 fsb.zs_ctime[1] == tsb.zs_ctime[1])
335 print_link_change(fp, di, change,
336 change > 0 ? fobjname : tobjname, &tsb);
337 } else if (same_name) {
338 print_file(fp, di, ZDIFF_MODIFIED, fobjname, &tsb);
340 print_rename(fp, di, fobjname, tobjname, &tsb);
344 /* file re-created or object re-used */
345 print_file(fp, di, ZDIFF_REMOVED, fobjname, &fsb);
346 print_file(fp, di, ZDIFF_ADDED, tobjname, &tsb);
352 write_inuse_diffs(FILE *fp, differ_info_t *di, dmu_diff_record_t *dr)
357 for (o = dr->ddr_first; o <= dr->ddr_last; o++) {
358 if ((err = write_inuse_diffs_one(fp, di, o)) != 0)
365 describe_free(FILE *fp, differ_info_t *di, uint64_t object, char *namebuf,
370 if (get_stats_for_obj(di, di->fromsnap, object, namebuf,
372 /* Let it slide, if in the delete queue on from side */
373 if (di->zerr == ENOENT && sb.zs_links == 0) {
380 print_file(fp, di, ZDIFF_REMOVED, namebuf, &sb);
385 write_free_diffs(FILE *fp, differ_info_t *di, dmu_diff_record_t *dr)
387 zfs_cmd_t zc = { 0 };
388 libzfs_handle_t *lhdl = di->zhp->zfs_hdl;
389 char fobjname[MAXPATHLEN];
391 (void) strlcpy(zc.zc_name, di->fromsnap, sizeof (zc.zc_name));
392 zc.zc_obj = dr->ddr_first - 1;
394 ASSERT(di->zerr == 0);
396 while (zc.zc_obj < dr->ddr_last) {
399 err = ioctl(lhdl->libzfs_fd, ZFS_IOC_NEXT_OBJ, &zc);
401 if (zc.zc_obj == di->shares) {
405 if (zc.zc_obj > dr->ddr_last) {
408 err = describe_free(fp, di, zc.zc_obj, fobjname,
412 } else if (errno == ESRCH) {
415 (void) snprintf(di->errbuf, sizeof (di->errbuf),
416 dgettext(TEXT_DOMAIN,
417 "next allocated object (> %lld) find failure"),
431 differ_info_t *di = arg;
432 dmu_diff_record_t dr;
436 if ((ofp = fdopen(di->outputfd, "w")) == NULL) {
438 (void) strerror_r(errno, di->errbuf, sizeof (di->errbuf));
439 (void) close(di->datafd);
444 char *cp = (char *)&dr;
445 int len = sizeof (dr);
449 rv = read(di->datafd, cp, len);
452 } while (len > 0 && rv > 0);
454 if (rv < 0 || (rv == 0 && len != sizeof (dr))) {
457 } else if (rv == 0) {
458 /* end of file at a natural breaking point */
462 switch (dr.ddr_type) {
464 err = write_free_diffs(ofp, di, &dr);
467 err = write_inuse_diffs(ofp, di, &dr);
479 (void) close(di->datafd);
483 ASSERT(di->zerr == EINVAL);
484 (void) snprintf(di->errbuf, sizeof (di->errbuf),
485 dgettext(TEXT_DOMAIN,
486 "Internal error: bad data from diff IOCTL"));
493 find_shares_object(differ_info_t *di)
495 char fullpath[MAXPATHLEN];
496 struct stat64 sb = { 0 };
498 (void) strlcpy(fullpath, di->dsmnt, MAXPATHLEN);
499 (void) strlcat(fullpath, ZDIFF_SHARESDIR, MAXPATHLEN);
501 if (stat64(fullpath, &sb) != 0) {
503 (void) snprintf(di->errbuf, sizeof (di->errbuf),
504 dgettext(TEXT_DOMAIN, "Cannot stat %s"), fullpath);
505 return (zfs_error(di->zhp->zfs_hdl, EZFS_DIFF, di->errbuf));
511 di->shares = (uint64_t)sb.st_ino;
516 make_temp_snapshot(differ_info_t *di)
518 libzfs_handle_t *hdl = di->zhp->zfs_hdl;
519 zfs_cmd_t zc = { 0 };
521 (void) snprintf(zc.zc_value, sizeof (zc.zc_value),
522 ZDIFF_PREFIX, getpid());
523 (void) strlcpy(zc.zc_name, di->ds, sizeof (zc.zc_name));
524 zc.zc_cleanup_fd = di->cleanupfd;
526 if (ioctl(hdl->libzfs_fd, ZFS_IOC_TMP_SNAPSHOT, &zc) != 0) {
529 (void) snprintf(di->errbuf, sizeof (di->errbuf),
530 dgettext(TEXT_DOMAIN, "The diff delegated "
531 "permission is needed in order\nto create a "
532 "just-in-time snapshot for diffing\n"));
533 return (zfs_error(hdl, EZFS_DIFF, di->errbuf));
535 (void) snprintf(di->errbuf, sizeof (di->errbuf),
536 dgettext(TEXT_DOMAIN, "Cannot create just-in-time "
537 "snapshot of '%s'"), zc.zc_name);
538 return (zfs_standard_error(hdl, err, di->errbuf));
542 di->tmpsnap = zfs_strdup(hdl, zc.zc_value);
543 di->tosnap = zfs_asprintf(hdl, "%s@%s", di->ds, di->tmpsnap);
548 teardown_differ_info(differ_info_t *di)
557 (void) close(di->cleanupfd);
561 get_snapshot_names(differ_info_t *di, const char *fromsnap,
564 libzfs_handle_t *hdl = di->zhp->zfs_hdl;
573 * dataset@snap1 dataset@snap2
574 * dataset@snap1 @snap2
575 * dataset@snap1 dataset
576 * @snap1 dataset@snap2
578 if (tosnap == NULL) {
579 /* only a from snapshot given, must be valid */
580 (void) snprintf(di->errbuf, sizeof (di->errbuf),
581 dgettext(TEXT_DOMAIN,
582 "Badly formed snapshot name %s"), fromsnap);
584 if (!zfs_validate_name(hdl, fromsnap, ZFS_TYPE_SNAPSHOT,
586 return (zfs_error(hdl, EZFS_INVALIDNAME,
590 atptrf = strchr(fromsnap, '@');
591 ASSERT(atptrf != NULL);
592 fdslen = atptrf - fromsnap;
594 di->fromsnap = zfs_strdup(hdl, fromsnap);
595 di->ds = zfs_strdup(hdl, fromsnap);
596 di->ds[fdslen] = '\0';
598 /* the to snap will be a just-in-time snap of the head */
599 return (make_temp_snapshot(di));
602 (void) snprintf(di->errbuf, sizeof (di->errbuf),
603 dgettext(TEXT_DOMAIN,
604 "Unable to determine which snapshots to compare"));
606 atptrf = strchr(fromsnap, '@');
607 atptrt = strchr(tosnap, '@');
608 fdslen = atptrf ? atptrf - fromsnap : strlen(fromsnap);
609 tdslen = atptrt ? atptrt - tosnap : strlen(tosnap);
610 fsnlen = strlen(fromsnap) - fdslen; /* includes @ sign */
611 tsnlen = strlen(tosnap) - tdslen; /* includes @ sign */
613 if (fsnlen <= 1 || tsnlen == 1 || (fdslen == 0 && tdslen == 0) ||
614 (fsnlen == 0 && tsnlen == 0)) {
615 return (zfs_error(hdl, EZFS_INVALIDNAME, di->errbuf));
616 } else if ((fdslen > 0 && tdslen > 0) &&
617 ((tdslen != fdslen || strncmp(fromsnap, tosnap, fdslen) != 0))) {
619 * not the same dataset name, might be okay if
620 * tosnap is a clone of a fromsnap descendant.
622 char origin[ZFS_MAX_DATASET_NAME_LEN];
626 di->ds = zfs_alloc(di->zhp->zfs_hdl, tdslen + 1);
627 (void) strncpy(di->ds, tosnap, tdslen);
628 di->ds[tdslen] = '\0';
630 zhp = zfs_open(hdl, di->ds, ZFS_TYPE_FILESYSTEM);
631 while (zhp != NULL) {
632 if (zfs_prop_get(zhp, ZFS_PROP_ORIGIN, origin,
633 sizeof (origin), &src, NULL, 0, B_FALSE) != 0) {
634 (void) zfs_close(zhp);
638 if (strncmp(origin, fromsnap, fsnlen) == 0)
641 (void) zfs_close(zhp);
642 zhp = zfs_open(hdl, origin, ZFS_TYPE_FILESYSTEM);
646 (void) snprintf(di->errbuf, sizeof (di->errbuf),
647 dgettext(TEXT_DOMAIN,
648 "Not an earlier snapshot from the same fs"));
649 return (zfs_error(hdl, EZFS_INVALIDNAME, di->errbuf));
651 (void) zfs_close(zhp);
654 di->isclone = B_TRUE;
655 di->fromsnap = zfs_strdup(hdl, fromsnap);
657 di->tosnap = zfs_strdup(hdl, tosnap);
659 return (make_temp_snapshot(di));
662 int dslen = fdslen ? fdslen : tdslen;
664 di->ds = zfs_alloc(hdl, dslen + 1);
665 (void) strncpy(di->ds, fdslen ? fromsnap : tosnap, dslen);
666 di->ds[dslen] = '\0';
668 di->fromsnap = zfs_asprintf(hdl, "%s%s", di->ds, atptrf);
670 di->tosnap = zfs_asprintf(hdl, "%s%s", di->ds, atptrt);
672 return (make_temp_snapshot(di));
679 get_mountpoint(differ_info_t *di, char *dsnm, char **mntpt)
683 mounted = is_mounted(di->zhp->zfs_hdl, dsnm, mntpt);
684 if (mounted == B_FALSE) {
685 (void) snprintf(di->errbuf, sizeof (di->errbuf),
686 dgettext(TEXT_DOMAIN,
687 "Cannot diff an unmounted snapshot"));
688 return (zfs_error(di->zhp->zfs_hdl, EZFS_BADTYPE, di->errbuf));
691 /* Avoid a double slash at the beginning of root-mounted datasets */
692 if (**mntpt == '/' && *(*mntpt + 1) == '\0')
698 get_mountpoints(differ_info_t *di)
704 * first get the mountpoint for the parent dataset
706 if (get_mountpoint(di, di->ds, &di->dsmnt) != 0)
709 strptr = strchr(di->tosnap, '@');
710 ASSERT3P(strptr, !=, NULL);
711 di->tomnt = zfs_asprintf(di->zhp->zfs_hdl, "%s%s%s", di->dsmnt,
712 ZDIFF_SNAPDIR, ++strptr);
714 strptr = strchr(di->fromsnap, '@');
715 ASSERT3P(strptr, !=, NULL);
717 frommntpt = di->dsmnt;
723 err = get_mountpoint(di, di->fromsnap, &mntpt);
730 di->frommnt = zfs_asprintf(di->zhp->zfs_hdl, "%s%s%s", frommntpt,
731 ZDIFF_SNAPDIR, ++strptr);
740 setup_differ_info(zfs_handle_t *zhp, const char *fromsnap,
741 const char *tosnap, differ_info_t *di)
745 di->cleanupfd = open(ZFS_DEV, O_RDWR|O_EXCL);
746 VERIFY(di->cleanupfd >= 0);
748 if (get_snapshot_names(di, fromsnap, tosnap) != 0)
751 if (get_mountpoints(di) != 0)
754 if (find_shares_object(di) != 0)
761 zfs_show_diffs(zfs_handle_t *zhp, int outfd, const char *fromsnap,
762 const char *tosnap, int flags)
764 zfs_cmd_t zc = { 0 };
766 differ_info_t di = { 0 };
771 (void) snprintf(errbuf, sizeof (errbuf),
772 dgettext(TEXT_DOMAIN, "zfs diff failed"));
774 if (setup_differ_info(zhp, fromsnap, tosnap, &di)) {
775 teardown_differ_info(&di);
780 zfs_error_aux(zhp->zfs_hdl, strerror(errno));
781 teardown_differ_info(&di);
782 return (zfs_error(zhp->zfs_hdl, EZFS_PIPEFAILED, errbuf));
785 di.scripted = (flags & ZFS_DIFF_PARSEABLE);
786 di.classify = (flags & ZFS_DIFF_CLASSIFY);
787 di.timestamped = (flags & ZFS_DIFF_TIMESTAMP);
790 di.datafd = pipefd[0];
792 if (pthread_create(&tid, NULL, differ, &di)) {
793 zfs_error_aux(zhp->zfs_hdl, strerror(errno));
794 (void) close(pipefd[0]);
795 (void) close(pipefd[1]);
796 teardown_differ_info(&di);
797 return (zfs_error(zhp->zfs_hdl,
798 EZFS_THREADCREATEFAILED, errbuf));
802 (void) strlcpy(zc.zc_value, di.fromsnap, strlen(di.fromsnap) + 1);
803 (void) strlcpy(zc.zc_name, di.tosnap, strlen(di.tosnap) + 1);
804 zc.zc_cookie = pipefd[1];
806 iocerr = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_DIFF, &zc);
808 (void) snprintf(errbuf, sizeof (errbuf),
809 dgettext(TEXT_DOMAIN, "Unable to obtain diffs"));
810 if (errno == EPERM) {
811 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
812 "\n The sys_mount privilege or diff delegated "
813 "permission is needed\n to execute the "
815 } else if (errno == EXDEV) {
816 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
817 "\n Not an earlier snapshot from the same fs"));
818 } else if (errno != EPIPE || di.zerr == 0) {
819 zfs_error_aux(zhp->zfs_hdl, strerror(errno));
821 (void) close(pipefd[1]);
822 (void) pthread_cancel(tid);
823 (void) pthread_join(tid, NULL);
824 teardown_differ_info(&di);
825 if (di.zerr != 0 && di.zerr != EPIPE) {
826 zfs_error_aux(zhp->zfs_hdl, strerror(di.zerr));
827 return (zfs_error(zhp->zfs_hdl, EZFS_DIFF, di.errbuf));
829 return (zfs_error(zhp->zfs_hdl, EZFS_DIFFDATA, errbuf));
833 (void) close(pipefd[1]);
834 (void) pthread_join(tid, NULL);
837 zfs_error_aux(zhp->zfs_hdl, strerror(di.zerr));
838 return (zfs_error(zhp->zfs_hdl, EZFS_DIFF, di.errbuf));
840 teardown_differ_info(&di);