4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.gnu.org/licenses/gpl-2.0.htm
23 * (C) Copyright 2012 Commissariat a l'energie atomique et aux energies
27 /* HSM copytool program for POSIX filesystem-based HSM's.
29 * An HSM copytool daemon acts on action requests from Lustre to copy files
30 * to and from an HSM archive system. This one in particular makes regular
31 * POSIX filesystem calls to a given path, where an HSM is presumably mounted.
33 * This particular tool can also import an existing HSM archive.
40 #include <sys/xattr.h>
41 #include <sys/syscall.h>
42 #include <sys/types.h>
43 #include <lustre/lustre_idl.h>
44 #include <lustre/lustreapi.h>
46 /* Progress reporting period */
47 #define REPORT_INTERVAL_DEFAULT 30
48 /* HSM hash subdir permissions */
49 #define DIR_PERM S_IRWXU
50 /* HSM hash file permissions */
51 #define FILE_PERM (S_IRUSR | S_IWUSR)
53 #define ONE_MB 0x100000
55 /* copytool uses a 32b bitmask field to register with kuc
56 * archive num = 0 => all
57 * archive num from 1 to 32
59 #define MAX_ARCHIVE_CNT (sizeof(__u32) * 8)
76 int o_archive_id[MAX_ARCHIVE_CNT];
78 unsigned long long o_bandwidth;
80 enum ct_action o_action;
83 char *o_src; /* for import, or rebind */
84 char *o_dst; /* for import, or rebind */
87 /* everything else is zeroed */
88 struct options opt = {
91 .o_verbose = LLAPI_MSG_INFO,
93 .o_report_int = REPORT_INTERVAL_DEFAULT,
94 .o_chunk_size = ONE_MB,
97 /* hsm_copytool_private will hold an open FD on the lustre mount point
98 * for us. Additionally open one on the archive FS root to make sure
99 * it doesn't drop out from under us (and remind the admin to shutdown
100 * the copytool before unmounting). */
102 static int arc_fd = -1;
104 static int err_major;
105 static int err_minor;
107 static char cmd_name[PATH_MAX];
108 static char fs_name[MAX_OBD_NAME + 1];
110 static struct hsm_copytool_private *ctdata;
113 #define CT_ERROR(_rc, _format, ...) \
114 llapi_error(LLAPI_MSG_ERROR, _rc, \
115 "%s[%ld]: "_format, \
116 cmd_name, syscall(SYS_gettid), ## __VA_ARGS__)
117 #define CT_DEBUG(_format, ...) \
118 llapi_error(LLAPI_MSG_DEBUG | LLAPI_MSG_NO_ERRNO, 0, \
119 "%s[%ld]: "_format, \
120 cmd_name, syscall(SYS_gettid), ## __VA_ARGS__)
121 #define CT_WARN(_format, ...) \
122 llapi_error(LLAPI_MSG_WARN | LLAPI_MSG_NO_ERRNO, 0, \
123 "%s[%ld]: "_format, \
124 cmd_name, syscall(SYS_gettid), ## __VA_ARGS__)
125 #define CT_TRACE(_format, ...) \
126 llapi_error(LLAPI_MSG_INFO | LLAPI_MSG_NO_ERRNO, 0, \
127 "%s[%ld]: "_format, \
128 cmd_name, syscall(SYS_gettid), ## __VA_ARGS__)
129 #define CT_PRINTF(_format, ...) \
130 llapi_printf(LLAPI_MSG_NORMAL, \
131 "%s[%ld]: "_format, \
132 cmd_name, syscall(SYS_gettid), ## __VA_ARGS__)
134 static void usage(const char *name, int rc)
137 " Usage: %s [options]... <mode> <lustre_mount_point>\n"
138 "The Lustre HSM Posix copy tool can be used as a daemon or "
139 "as a command line tool\n"
140 "The Lustre HSM daemon acts on action requests from Lustre\n"
141 "to copy files to and from an HSM archive system.\n"
142 "This POSIX-flavored daemon makes regular POSIX filesystem calls\n"
143 "to an HSM mounted at a given hsm_root.\n"
144 " --daemon Daemon mode, run in background\n"
146 " --no-attr Don't copy file attributes\n"
147 " --no-shadow Don't create shadow namespace in archive\n"
148 " --no-xattr Don't copy file extended attributes\n"
149 "The Lustre HSM tool performs administrator-type actions\n"
150 "on a Lustre HSM archive.\n"
151 "This POSIX-flavored tool can link an existing HSM namespace\n"
152 "into a Lustre filesystem.\n"
154 " %s [options] --import <src> <dst> <lustre_mount_point>\n"
155 " import an archived subtree at\n"
156 " <src> (relative to hsm_root) into the Lustre filesystem at\n"
157 " <dst> (absolute)\n"
158 " %s [options] --rebind <old_FID> <new_FID> <lustre_mount_point>\n"
159 " rebind an entry in the HSM to a new FID\n"
160 " <old_FID> old FID the HSM entry is bound to\n"
161 " <new_FID> new FID to bind the HSM entry to\n"
162 " %s [options] --rebind <list_file> <lustre_mount_point>\n"
163 " perform the rebind operation for all FID in the list file\n"
164 " each line of <list_file> consists of <old_FID> <new_FID>\n"
165 " %s [options] --max-sequence <fsname>\n"
166 " return the max fid sequence of archived files\n"
167 " -A, --archive <#> Archive number (repeatable)\n"
168 " -p, --hsm-root <path> Target HSM mount point\n"
169 " -q, --quiet Produce less verbose output\n"
170 " -v, --verbose Produce more verbose output\n"
171 " -c, --chunk-size <sz> I/O size used during data copy\n"
172 " (unit can be used, default is MB)\n"
173 " --abort-on-error Abort operation on major error\n"
174 " --dry-run Don't run, just show what would be done\n"
175 " --bandwidth <bw> Limit I/O bandwidth (unit can be used\n,"
177 cmd_name, cmd_name, cmd_name, cmd_name, cmd_name);
182 static int ct_parseopts(int argc, char * const *argv)
184 struct option long_opts[] = {
185 {"abort-on-error", no_argument, &opt.o_abort_on_error, 1},
186 {"abort_on_error", no_argument, &opt.o_abort_on_error, 1},
187 {"archive", required_argument, NULL, 'A'},
188 {"bandwidth", required_argument, NULL, 'b'},
189 {"chunk-size", required_argument, NULL, 'c'},
190 {"chunk_size", required_argument, NULL, 'c'},
191 {"daemon", no_argument, &opt.o_daemonize, 1},
192 {"dry-run", no_argument, &opt.o_dry_run, 1},
193 {"help", no_argument, NULL, 'h'},
194 {"hsm-root", required_argument, NULL, 'p'},
195 {"hsm_root", required_argument, NULL, 'p'},
196 {"import", no_argument, NULL, 'i'},
197 {"max-sequence", no_argument, NULL, 'M'},
198 {"max_sequence", no_argument, NULL, 'M'},
199 {"no-attr", no_argument, &opt.o_copy_attrs, 0},
200 {"no_attr", no_argument, &opt.o_copy_attrs, 0},
201 {"no-shadow", no_argument, &opt.o_shadow_tree, 0},
202 {"no_shadow", no_argument, &opt.o_shadow_tree, 0},
203 {"no-xattr", no_argument, &opt.o_copy_xattrs, 0},
204 {"no_xattr", no_argument, &opt.o_copy_xattrs, 0},
205 {"quiet", no_argument, NULL, 'q'},
206 {"rebind", no_argument, NULL, 'r'},
207 {"report", required_argument, &opt.o_report_int, 0},
208 {"verbose", no_argument, NULL, 'v'},
212 unsigned long long value;
213 unsigned long long unit;
216 while ((c = getopt_long(argc, argv, "A:b:c:hiMp:qrv",
217 long_opts, NULL)) != -1) {
220 if ((opt.o_archive_cnt >= MAX_ARCHIVE_CNT) ||
221 (atoi(optarg) >= MAX_ARCHIVE_CNT)) {
223 CT_ERROR(rc, "archive number must be less"
224 "than %zu", MAX_ARCHIVE_CNT);
227 opt.o_archive_id[opt.o_archive_cnt] = atoi(optarg);
230 case 'b': /* -b and -c have both a number with unit as arg */
233 if (llapi_parse_size(optarg, &value, &unit, 0) < 0) {
235 CT_ERROR(rc, "bad value for -%c '%s'", c,
240 opt.o_chunk_size = value;
242 opt.o_bandwidth = value;
247 opt.o_action = CA_IMPORT;
250 opt.o_action = CA_MAXSEQ;
253 opt.o_hsm_root = optarg;
259 opt.o_action = CA_REBIND;
271 switch (opt.o_action) {
273 /* src dst mount_point */
274 if (argc != optind + 3) {
276 CT_ERROR(rc, "--import requires 2 arguments");
279 opt.o_src = argv[optind++];
280 opt.o_dst = argv[optind++];
283 /* FID1 FID2 mount_point or FILE mount_point */
284 if (argc == optind + 2) {
285 opt.o_src = argv[optind++];
287 } else if (argc == optind + 3) {
288 opt.o_src = argv[optind++];
289 opt.o_dst = argv[optind++];
292 CT_ERROR(rc, "--rebind requires 1 or 2 arguments");
298 /* just mount point */
302 if (argc != optind + 1) {
304 CT_ERROR(rc, "no mount point specified");
308 opt.o_mnt = argv[optind];
310 CT_TRACE("action=%d src=%s dst=%s mount_point=%s",
311 opt.o_action, opt.o_src, opt.o_dst, opt.o_mnt);
313 if (!opt.o_dry_run && opt.o_hsm_root == NULL) {
315 CT_ERROR(rc, "must specify a root directory for the backend");
319 if (opt.o_action == CA_IMPORT) {
320 if (opt.o_src && opt.o_src[0] == '/') {
323 "source path must be relative to HSM root");
327 if (opt.o_dst && opt.o_dst[0] != '/') {
329 CT_ERROR(rc, "destination path must be absolute");
338 static int ct_mkdir_p(const char *path)
348 while ((ptr = strchr(ptr, '/')) != NULL) {
350 rc = mkdir(saved, DIR_PERM);
352 if (rc < 0 && errno != EEXIST) {
354 CT_ERROR(rc, "cannot mkdir '%s'", path);
366 static int ct_save_stripe(int src_fd, const char *src, const char *dst)
368 char lov_file[PATH_MAX];
369 char lov_buf[XATTR_SIZE_MAX];
370 struct lov_user_md *lum;
375 snprintf(lov_file, sizeof(lov_file), "%s.lov", dst);
376 CT_TRACE("saving stripe info of '%s' in %s", src, lov_file);
378 xattr_size = fgetxattr(src_fd, XATTR_LUSTRE_LOV, lov_buf,
380 if (xattr_size < 0) {
382 CT_ERROR(rc, "cannot get stripe info on '%s'", src);
386 lum = (struct lov_user_md *)lov_buf;
388 if (lum->lmm_magic == LOV_USER_MAGIC_V1 ||
389 lum->lmm_magic == LOV_USER_MAGIC_V3) {
390 /* Set stripe_offset to -1 so that it is not interpreted as a
391 * hint on restore. */
392 lum->lmm_stripe_offset = -1;
395 fd = open(lov_file, O_TRUNC | O_CREAT | O_WRONLY, FILE_PERM);
398 CT_ERROR(rc, "cannot open '%s'", lov_file);
402 rc = write(fd, lum, xattr_size);
405 CT_ERROR(rc, "cannot write %zd bytes to '%s'",
406 xattr_size, lov_file);
414 CT_ERROR(rc, "cannot close '%s'", lov_file);
426 static int ct_load_stripe(const char *src, void *lovea, size_t *lovea_size)
428 char lov_file[PATH_MAX];
432 snprintf(lov_file, sizeof(lov_file), "%s.lov", src);
433 CT_TRACE("reading stripe rules from '%s' for '%s'", lov_file, src);
435 fd = open(lov_file, O_RDONLY);
437 CT_ERROR(errno, "cannot open '%s'", lov_file);
441 rc = read(fd, lovea, *lovea_size);
443 CT_ERROR(errno, "cannot read %zu bytes from '%s'",
444 *lovea_size, lov_file);
455 static int ct_restore_stripe(const char *src, const char *dst, int dst_fd,
456 const void *lovea, size_t lovea_size)
460 rc = fsetxattr(dst_fd, XATTR_LUSTRE_LOV, lovea, lovea_size,
463 CT_ERROR(errno, "cannot set lov EA on '%s'", dst);
470 static void bandwidth_ctl_delay(int wsize)
472 static unsigned long long tot_bytes;
473 static time_t start_time;
474 static time_t last_time;
475 time_t now = time(0);
478 unsigned int sleep_time;
480 if (now > last_time + 5) {
482 start_time = last_time = now;
486 tot_time = now - start_time;
490 excess = tot_bytes - tot_time * opt.o_bandwidth;
491 sleep_time = excess * 1000000 / opt.o_bandwidth;
492 if ((now - start_time) % 10 == 1)
493 CT_TRACE("bandwith control: excess=%E sleep for %dus", excess,
502 static int ct_copy_data(struct hsm_copyaction_private *hcp, const char *src,
503 const char *dst, int src_fd, int dst_fd,
504 const struct hsm_action_item *hai, long hal_flags)
506 struct hsm_extent he;
507 __u64 offset = hai->hai_extent.offset;
511 __u64 write_total = 0;
513 time_t last_print_time = time(NULL);
516 CT_TRACE("going to copy data from '%s' to '%s'", src, dst);
518 buf = malloc(opt.o_chunk_size);
522 if (fstat(src_fd, &src_st) < 0) {
524 CT_ERROR(rc, "cannot stat '%s'", src);
528 if (!S_ISREG(src_st.st_mode)) {
530 CT_ERROR(rc, "'%s' is not a regular file", src);
534 if (fstat(dst_fd, &dst_st) < 0) {
536 CT_ERROR(rc, "cannot stat '%s'", dst);
540 if (!S_ISREG(dst_st.st_mode)) {
542 CT_ERROR(rc, "'%s' is not a regular file", dst);
546 rc = lseek(src_fd, hai->hai_extent.offset, SEEK_SET);
549 "cannot seek for read to "LPU64" (len %jd) in '%s'",
550 hai->hai_extent.offset, (intmax_t)src_st.st_size, src);
557 rc = llapi_hsm_action_progress(hcp, &he, 0);
559 /* Action has been canceled or something wrong
560 * is happening. Stop copying data. */
561 CT_ERROR(rc, "progress ioctl for copy '%s'->'%s' failed",
567 /* Don't read beyond a given extent */
568 length = min(hai->hai_extent.length, src_st.st_size);
570 CT_DEBUG("Going to copy "LPU64" bytes %s -> %s\n", length, src, dst);
572 while (write_total < length) {
575 int chunk = (length - write_total > opt.o_chunk_size) ?
576 opt.o_chunk_size : length - write_total;
578 rsize = pread(src_fd, buf, chunk, offset);
585 CT_ERROR(rc, "cannot read from '%s'", src);
589 wsize = pwrite(dst_fd, buf, rsize, offset);
592 CT_ERROR(rc, "cannot write to '%s'", dst);
596 write_total += wsize;
599 if (opt.o_bandwidth != 0)
600 /* sleep if needed, to honor bandwidth limits */
601 bandwidth_ctl_delay(wsize);
603 if (time(0) >= last_print_time + opt.o_report_int) {
604 last_print_time = time(0);
605 CT_TRACE("%%"LPU64" ", 100 * write_total / length);
606 he.length = write_total;
607 rc = llapi_hsm_action_progress(hcp, &he, 0);
609 /* Action has been canceled or something wrong
610 * is happening. Stop copying data. */
611 CT_ERROR(rc, "progress ioctl for copy"
612 " '%s'->'%s' failed", src, dst);
621 * truncate restored file
622 * size is taken from the archive this is done to support
623 * restore after a force release which leaves the file with the
624 * wrong size (can big bigger than the new size)
626 if ((hai->hai_action == HSMA_RESTORE) &&
627 (src_st.st_size < dst_st.st_size)) {
629 * make sure the file is on disk before reporting success.
631 rc = ftruncate(dst_fd, src_st.st_size);
635 "cannot truncate '%s' to size %jd",
636 dst, (intmax_t)src_st.st_size);
646 /* Copy file attributes from file src to file dest */
647 static int ct_copy_attr(const char *src, const char *dst, int src_fd,
651 struct timeval times[2];
654 if (fstat(src_fd, &st) < 0) {
656 CT_ERROR(rc, "cannot stat '%s'", src);
660 times[0].tv_sec = st.st_atime;
661 times[0].tv_usec = 0;
662 times[1].tv_sec = st.st_mtime;
663 times[1].tv_usec = 0;
664 if (fchmod(dst_fd, st.st_mode) < 0 ||
665 fchown(dst_fd, st.st_uid, st.st_gid) < 0 ||
666 futimes(dst_fd, times) < 0) {
668 CT_ERROR(rc, "cannot set attributes of '%s'", src);
675 static int ct_copy_xattr(const char *src, const char *dst, int src_fd,
676 int dst_fd, bool is_restore)
678 char list[XATTR_LIST_MAX];
679 char value[XATTR_SIZE_MAX];
684 list_len = flistxattr(src_fd, list, sizeof(list));
689 while (name < list + list_len) {
690 rc = fgetxattr(src_fd, name, value, sizeof(value));
694 /* when we restore, we do not restore lustre xattr */
696 (strncmp(XATTR_TRUSTED_PREFIX, name,
697 sizeof(XATTR_TRUSTED_PREFIX) - 1) != 0)) {
698 rc = fsetxattr(dst_fd, name, value, rc, 0);
699 CT_TRACE("fsetxattr of '%s' on '%s' rc=%d (%s)",
700 name, dst, rc, strerror(errno));
701 /* lustre.* attrs aren't supported on other FS's */
702 if (rc < 0 && errno != EOPNOTSUPP) {
704 CT_ERROR(rc, "cannot set extended attribute"
710 name += strlen(name) + 1;
716 static int ct_path_lustre(char *buf, int sz, const char *mnt,
717 const lustre_fid *fid)
719 return snprintf(buf, sz, "%s/%s/fid/"DFID_NOBRACE, mnt,
720 dot_lustre_name, PFID(fid));
723 static int ct_path_archive(char *buf, int sz, const char *archive_dir,
724 const lustre_fid *fid)
726 return snprintf(buf, sz, "%s/%04x/%04x/%04x/%04x/%04x/%04x/"
727 DFID_NOBRACE, archive_dir,
728 (fid)->f_oid & 0xFFFF,
729 (fid)->f_oid >> 16 & 0xFFFF,
730 (unsigned int)((fid)->f_seq & 0xFFFF),
731 (unsigned int)((fid)->f_seq >> 16 & 0xFFFF),
732 (unsigned int)((fid)->f_seq >> 32 & 0xFFFF),
733 (unsigned int)((fid)->f_seq >> 48 & 0xFFFF),
737 static bool ct_is_retryable(int err)
739 return err == -ETIMEDOUT;
742 static int ct_begin_restore(struct hsm_copyaction_private **phcp,
743 const struct hsm_action_item *hai,
744 int mdt_index, int open_flags)
749 rc = llapi_hsm_action_begin(phcp, ctdata, hai, mdt_index, open_flags,
752 ct_path_lustre(src, sizeof(src), opt.o_mnt, &hai->hai_fid);
753 CT_ERROR(rc, "llapi_hsm_action_begin() on '%s' failed", src);
759 static int ct_begin(struct hsm_copyaction_private **phcp,
760 const struct hsm_action_item *hai)
762 /* Restore takes specific parameters. Call the same function w/ default
763 * values for all other operations. */
764 return ct_begin_restore(phcp, hai, -1, 0);
767 static int ct_fini(struct hsm_copyaction_private **phcp,
768 const struct hsm_action_item *hai, int hp_flags, int ct_rc)
773 CT_TRACE("Action completed, notifying coordinator "
774 "cookie="LPX64", FID="DFID", hp_flags=%d err=%d",
775 hai->hai_cookie, PFID(&hai->hai_fid),
778 ct_path_lustre(lstr, sizeof(lstr), opt.o_mnt, &hai->hai_fid);
779 rc = llapi_hsm_action_end(phcp, &hai->hai_extent, hp_flags, abs(ct_rc));
780 if (rc == -ECANCELED)
781 CT_ERROR(rc, "completed action on '%s' has been canceled: "
782 "cookie="LPX64", FID="DFID, lstr, hai->hai_cookie,
783 PFID(&hai->hai_fid));
785 CT_ERROR(rc, "llapi_hsm_action_end() on '%s' failed", lstr);
787 CT_TRACE("llapi_hsm_action_end() on '%s' ok (rc=%d)",
793 static int ct_archive(const struct hsm_action_item *hai, const long hal_flags)
795 struct hsm_copyaction_private *hcp = NULL;
797 char dst[PATH_MAX] = "";
800 bool rename_needed = false;
806 rc = ct_begin(&hcp, hai);
810 /* we fill archive so:
812 * destination = lustre FID
814 ct_path_lustre(src, sizeof(src), opt.o_mnt, &hai->hai_dfid);
815 ct_path_archive(dst, sizeof(dst), opt.o_hsm_root, &hai->hai_fid);
816 if (hai->hai_extent.length == -1) {
817 /* whole file, write it to tmp location and atomically
818 * replace old archived file */
819 strncat(dst, "_tmp", sizeof(dst) - strlen(dst) - 1);
820 /* we cannot rely on the same test because ct_copy_data()
821 * updates hai_extent.length */
822 rename_needed = true;
825 CT_TRACE("archiving '%s' to '%s'", src, dst);
832 rc = ct_mkdir_p(dst);
834 CT_ERROR(rc, "mkdir_p '%s' failed", dst);
838 src_fd = llapi_hsm_action_get_fd(hcp);
841 CT_ERROR(rc, "cannot open '%s' for read", src);
845 open_flags = O_WRONLY | O_NOFOLLOW | O_NONBLOCK;
846 /* If extent is specified, don't truncate an old archived copy */
847 open_flags |= ((hai->hai_extent.length == -1) ? O_TRUNC : 0) | O_CREAT;
849 dst_fd = open(dst, open_flags, FILE_PERM);
852 CT_ERROR(rc, "cannot open '%s' for write", dst);
856 /* saving stripe is not critical */
857 rc = ct_save_stripe(src_fd, src, dst);
859 CT_ERROR(rc, "cannot save file striping info of '%s' in '%s'",
862 rc = ct_copy_data(hcp, src, dst, src_fd, dst_fd, hai, hal_flags);
864 CT_ERROR(rc, "data copy failed from '%s' to '%s'", src, dst);
871 CT_ERROR(rc, "cannot flush '%s' archive file '%s'", src, dst);
875 CT_TRACE("data archiving for '%s' to '%s' done", src, dst);
877 /* attrs will remain on the MDS; no need to copy them, except possibly
878 for disaster recovery */
879 if (opt.o_copy_attrs) {
880 rc = ct_copy_attr(src, dst, src_fd, dst_fd);
882 CT_ERROR(rc, "cannot copy attr of '%s' to '%s'",
886 CT_TRACE("attr file for '%s' saved to archive '%s'",
890 /* xattrs will remain on the MDS; no need to copy them, except possibly
891 for disaster recovery */
892 if (opt.o_copy_xattrs) {
893 rc = ct_copy_xattr(src, dst, src_fd, dst_fd, false);
895 CT_ERROR(rc, "cannot copy xattr of '%s' to '%s'",
897 rcf = rcf ? rcf : rc;
899 CT_TRACE("xattr file for '%s' saved to archive '%s'",
903 if (rename_needed == true) {
904 char tmp_src[PATH_MAX];
905 char tmp_dst[PATH_MAX];
907 /* atomically replace old archived file */
908 ct_path_archive(src, sizeof(src), opt.o_hsm_root,
910 rc = rename(dst, src);
913 CT_ERROR(rc, "cannot rename '%s' to '%s'", dst, src);
916 /* rename lov file */
917 snprintf(tmp_src, sizeof(tmp_src), "%s.lov", src);
918 snprintf(tmp_dst, sizeof(tmp_dst), "%s.lov", dst);
919 rc = rename(tmp_dst, tmp_src);
921 CT_ERROR(errno, "cannot rename '%s' to '%s'",
925 if (opt.o_shadow_tree) {
926 /* Create a namespace of softlinks that shadows the original
927 * Lustre namespace. This will only be current at
928 * time-of-archive (won't follow renames).
929 * WARNING: release won't kill these links; a manual
930 * cleanup of dead links would be required.
933 long long recno = -1;
939 sprintf(buf, DFID, PFID(&hai->hai_fid));
940 sprintf(src, "%s/shadow/", opt.o_hsm_root);
942 ptr = opt.o_hsm_root;
944 (*ptr++ == '/') ? depth-- : 0;
946 rc = llapi_fid2path(opt.o_mnt, buf, src + strlen(src),
947 sizeof(src) - strlen(src), &recno, &linkno);
949 CT_ERROR(rc, "cannot get FID of '%s'", buf);
950 rcf = rcf ? rcf : rc;
954 /* Figure out how many parent dirs to symlink back */
957 (*ptr++ == '/') ? depth++ : 0;
962 ct_path_archive(dst, sizeof(dst), buf, &hai->hai_fid);
964 if (ct_mkdir_p(src)) {
965 CT_ERROR(errno, "mkdir_p '%s' failed", src);
966 rcf = rcf ? rcf : -errno;
969 /* symlink already exists ? */
970 sz = readlink(src, buf, sizeof(buf));
971 /* detect truncation */
972 if (sz == sizeof(buf)) {
973 rcf = rcf ? rcf : -E2BIG;
974 CT_ERROR(rcf, "readlink '%s' truncated", src);
979 if (sz == 0 || strncmp(buf, dst, sz) != 0) {
980 if (unlink(src) && errno != ENOENT) {
982 "cannot unlink symlink '%s'",
984 rcf = rcf ? rcf : -errno;
986 /* unlink old symlink done */
987 CT_TRACE("remove old symlink '%s' pointing"
988 " to '%s'", src, buf);
991 /* symlink already ok */
992 CT_TRACE("symlink '%s' already pointing"
993 " to '%s'", src, dst);
998 if (symlink(dst, src)) {
999 CT_ERROR(errno, "cannot symlink '%s' to '%s'",
1001 rcf = rcf ? rcf : -errno;
1004 CT_TRACE("symlink '%s' to '%s' done", src, dst);
1016 if (ct_is_retryable(rc))
1017 hp_flags |= HP_FLAG_RETRY;
1029 rc = ct_fini(&hcp, hai, hp_flags, rcf);
1034 static int ct_restore(const struct hsm_action_item *hai, const long hal_flags)
1036 struct hsm_copyaction_private *hcp = NULL;
1039 char lov_buf[XATTR_SIZE_MAX];
1040 size_t lov_size = sizeof(lov_buf);
1045 int mdt_index = -1; /* Not implemented */
1049 /* we fill lustre so:
1050 * source = lustre FID in the backend
1051 * destination = data FID = volatile file
1054 /* build backend file name from released file FID */
1055 ct_path_archive(src, sizeof(src), opt.o_hsm_root, &hai->hai_fid);
1057 /* restore loads and sets the LOVEA w/o interpreting it to avoid
1058 * dependency on the structure format. */
1059 rc = ct_load_stripe(src, lov_buf, &lov_size);
1061 CT_WARN("cannot get stripe rules for '%s' (%s), use default",
1062 src, strerror(-rc));
1065 open_flags |= O_LOV_DELAY_CREATE;
1069 rc = ct_begin_restore(&hcp, hai, mdt_index, open_flags);
1073 /* get the FID of the volatile file */
1074 rc = llapi_hsm_action_get_dfid(hcp, &dfid);
1076 CT_ERROR(rc, "restoring "DFID
1077 ", cannot get FID of created volatile file",
1078 PFID(&hai->hai_fid));
1082 /* build volatile "file name", for messages */
1083 snprintf(dst, sizeof(dst), "{VOLATILE}="DFID, PFID(&dfid));
1085 CT_TRACE("restoring data from '%s' to '%s'", src, dst);
1087 if (opt.o_dry_run) {
1092 src_fd = open(src, O_RDONLY | O_NOATIME | O_NONBLOCK | O_NOFOLLOW);
1095 CT_ERROR(rc, "cannot open '%s' for read", src);
1099 dst_fd = llapi_hsm_action_get_fd(hcp);
1102 /* the layout cannot be allocated through .fid so we have to
1103 * restore a layout */
1104 rc = ct_restore_stripe(src, dst, dst_fd, lov_buf, lov_size);
1106 CT_ERROR(rc, "cannot restore file striping info"
1107 " for '%s' from '%s'", dst, src);
1113 rc = ct_copy_data(hcp, src, dst, src_fd, dst_fd, hai, hal_flags);
1115 CT_ERROR(rc, "cannot copy data from '%s' to '%s'",
1118 if (ct_is_retryable(rc))
1119 hp_flags |= HP_FLAG_RETRY;
1123 CT_TRACE("data restore from '%s' to '%s' done", src, dst);
1127 rc = ct_fini(&hcp, hai, hp_flags, rc);
1129 /* object swaping is done by cdt at copy end, so close of volatile file
1130 * cannot be done before */
1140 static int ct_remove(const struct hsm_action_item *hai, const long hal_flags)
1142 struct hsm_copyaction_private *hcp = NULL;
1146 rc = ct_begin(&hcp, hai);
1150 ct_path_archive(dst, sizeof(dst), opt.o_hsm_root, &hai->hai_fid);
1152 CT_TRACE("removing file '%s'", dst);
1154 if (opt.o_dry_run) {
1162 CT_ERROR(rc, "cannot unlink '%s'", dst);
1167 strncat(dst, ".lov", sizeof(dst) - strlen(dst) - 1);
1171 CT_ERROR(rc, "cannot unlink '%s'", dst);
1178 rc = ct_fini(&hcp, hai, 0, rc);
1183 static int ct_report_error(const struct hsm_action_item *hai, int flags,
1186 struct hsm_copyaction_private *hcp;
1189 rc = llapi_hsm_action_begin(&hcp, ctdata, hai, -1, 0, true);
1193 rc = llapi_hsm_action_end(&hcp, &hai->hai_extent, flags, abs(errval));
1198 static int ct_process_item(struct hsm_action_item *hai, const long hal_flags)
1202 if (opt.o_verbose >= LLAPI_MSG_INFO || opt.o_dry_run) {
1203 /* Print the original path */
1205 char path[PATH_MAX];
1206 long long recno = -1;
1209 sprintf(fid, DFID, PFID(&hai->hai_fid));
1210 CT_TRACE("'%s' action %s reclen %d, cookie="LPX64,
1211 fid, hsm_copytool_action2name(hai->hai_action),
1212 hai->hai_len, hai->hai_cookie);
1213 rc = llapi_fid2path(opt.o_mnt, fid, path,
1214 sizeof(path), &recno, &linkno);
1216 CT_ERROR(rc, "cannot get path of FID %s", fid);
1218 CT_TRACE("processing file '%s'", path);
1221 switch (hai->hai_action) {
1222 /* set err_major, minor inside these functions */
1224 rc = ct_archive(hai, hal_flags);
1227 rc = ct_restore(hai, hal_flags);
1230 rc = ct_remove(hai, hal_flags);
1233 CT_TRACE("cancel not implemented for file system '%s'",
1235 /* Don't report progress to coordinator for this cookie:
1236 * the copy function will get ECANCELED when reporting
1243 CT_ERROR(rc, "unknown action %d, on '%s'", hai->hai_action,
1246 ct_report_error(hai, 0, rc);
1254 struct hsm_action_item *hai;
1257 static void *ct_thread(void *data)
1259 struct ct_th_data *cttd = data;
1262 rc = ct_process_item(cttd->hai, cttd->hal_flags);
1266 pthread_exit((void *)(intptr_t)rc);
1269 static int ct_process_item_async(const struct hsm_action_item *hai,
1272 pthread_attr_t attr;
1274 struct ct_th_data *data;
1277 data = malloc(sizeof(*data));
1281 data->hai = malloc(hai->hai_len);
1282 if (data->hai == NULL) {
1287 memcpy(data->hai, hai, hai->hai_len);
1288 data->hal_flags = hal_flags;
1290 rc = pthread_attr_init(&attr);
1292 CT_ERROR(rc, "pthread_attr_init failed for '%s' service",
1299 pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
1301 rc = pthread_create(&thread, &attr, ct_thread, data);
1303 CT_ERROR(rc, "cannot create thread for '%s' service",
1306 pthread_attr_destroy(&attr);
1310 static int ct_import_one(const char *src, const char *dst)
1312 char newarc[PATH_MAX];
1317 CT_TRACE("importing '%s' from '%s'", dst, src);
1319 if (stat(src, &st) < 0) {
1321 CT_ERROR(rc, "cannot stat '%s'", src);
1328 rc = llapi_hsm_import(dst,
1329 opt.o_archive_cnt ? opt.o_archive_id[0] : 0,
1330 &st, 0, 0, 0, 0, NULL, &fid);
1332 CT_ERROR(rc, "cannot import '%s' from '%s'", dst, src);
1336 ct_path_archive(newarc, sizeof(newarc), opt.o_hsm_root, &fid);
1338 rc = ct_mkdir_p(newarc);
1340 CT_ERROR(rc, "mkdir_p '%s' failed", newarc);
1346 /* Lots of choices now: mv, ln, ln -s ? */
1347 rc = link(src, newarc); /* hardlink */
1350 CT_ERROR(rc, "cannot link '%s' to '%s'", newarc, src);
1354 CT_TRACE("imported '%s' from '%s'=='%s'", dst, newarc, src);
1359 static char *path_concat(const char *dirname, const char *basename)
1362 int dirlen = strlen(dirname);
1364 result = malloc(dirlen + strlen(basename) + 2);
1368 memcpy(result, dirname, dirlen);
1369 result[dirlen] = '/';
1370 strcpy(result + dirlen + 1, basename);
1375 static int ct_import_recurse(const char *relpath)
1378 struct dirent ent, *cookie = NULL;
1379 char *srcpath, *newpath;
1382 if (relpath == NULL)
1385 srcpath = path_concat(opt.o_hsm_root, relpath);
1386 if (srcpath == NULL) {
1391 dir = opendir(srcpath);
1393 /* Not a dir, or error */
1394 if (errno == ENOTDIR) {
1395 /* Single regular file case, treat o_dst as absolute
1397 rc = ct_import_one(srcpath, opt.o_dst);
1400 CT_ERROR(rc, "cannot opendir '%s'", srcpath);
1409 rc = readdir_r(dir, &ent, &cookie);
1412 CT_ERROR(rc, "cannot readdir_r '%s'", relpath);
1415 } else if ((rc == 0) && (cookie == NULL)) {
1416 /* end of directory */
1420 if (!strcmp(ent.d_name, ".") ||
1421 !strcmp(ent.d_name, ".."))
1424 /* New relative path */
1425 newpath = path_concat(relpath, ent.d_name);
1426 if (newpath == NULL) {
1432 if (ent.d_type == DT_DIR) {
1433 rc = ct_import_recurse(newpath);
1438 sprintf(src, "%s/%s", opt.o_hsm_root, newpath);
1439 sprintf(dst, "%s/%s", opt.o_dst, newpath);
1440 /* Make the target dir in the Lustre fs */
1441 rc = ct_mkdir_p(dst);
1443 /* Import the file */
1444 rc = ct_import_one(src, dst);
1446 CT_ERROR(rc, "ct_mkdir_p '%s' failed", dst);
1452 CT_ERROR(rc, "cannot import '%s'", newpath);
1453 if (err_major && opt.o_abort_on_error) {
1467 static int ct_rebind_one(const lustre_fid *old_fid, const lustre_fid *new_fid)
1473 CT_TRACE("rebind "DFID" to "DFID, PFID(old_fid), PFID(new_fid));
1475 ct_path_archive(src, sizeof(src), opt.o_hsm_root, old_fid);
1476 ct_path_archive(dst, sizeof(dst), opt.o_hsm_root, new_fid);
1478 if (!opt.o_dry_run) {
1480 if (rename(src, dst)) {
1482 CT_ERROR(rc, "cannot rename '%s' to '%s'", src, dst);
1485 /* rename lov file */
1486 strncat(src, ".lov", sizeof(src) - strlen(src) - 1);
1487 strncat(dst, ".lov", sizeof(dst) - strlen(dst) - 1);
1488 if (rename(src, dst))
1489 CT_ERROR(errno, "cannot '%s' rename to '%s'", src, dst);
1495 static bool fid_is_file(lustre_fid *fid)
1497 return fid_is_norm(fid) || fid_is_igif(fid);
1500 static bool should_ignore_line(const char *line)
1504 for (i = 0; line[i] != '\0'; i++) {
1505 if (isspace(line[i]))
1507 else if (line[i] == '#')
1516 static int ct_rebind_list(const char *list)
1522 size_t line_size = 0;
1523 unsigned int nl = 0;
1524 unsigned int ok = 0;
1526 filp = fopen(list, "r");
1529 CT_ERROR(rc, "cannot open '%s'", list);
1533 /* each line consists of 2 FID */
1534 while ((r = getline(&line, &line_size, filp)) != -1) {
1538 /* Ignore empty and commented out ('#...') lines. */
1539 if (should_ignore_line(line))
1544 rc = sscanf(line, SFID" "SFID, RFID(&old_fid), RFID(&new_fid));
1545 if (rc != 6 || !fid_is_file(&old_fid) ||
1546 !fid_is_file(&new_fid)) {
1548 "'%s' FID expected near '%s', line %u",
1554 if (ct_rebind_one(&old_fid, &new_fid))
1565 /* return 0 if all rebinds were sucessful */
1566 CT_TRACE("%u lines read from '%s', %u rebind successful", nl, list, ok);
1568 return ok == nl ? 0 : -1;
1571 static int ct_rebind(void)
1579 if (sscanf(opt.o_src, SFID, RFID(&old_fid)) != 3 ||
1580 !fid_is_file(&old_fid)) {
1582 CT_ERROR(rc, "'%s' invalid FID format", opt.o_src);
1586 if (sscanf(opt.o_dst, SFID, RFID(&new_fid)) != 3 ||
1587 !fid_is_file(&new_fid)) {
1589 CT_ERROR(rc, "'%s' invalid FID format", opt.o_dst);
1593 rc = ct_rebind_one(&old_fid, &new_fid);
1598 /* o_src is a list file */
1599 rc = ct_rebind_list(opt.o_src);
1604 static int ct_dir_level_max(const char *dirpath, __u16 *sub_seqmax)
1609 struct dirent ent, *cookie = NULL;
1613 dir = opendir(dirpath);
1616 CT_ERROR(rc, "cannot open directory '%s'", opt.o_hsm_root);
1620 while ((rc = readdir_r(dir, &ent, &cookie)) == 0) {
1622 /* end of directory.
1623 * rc is 0 and seqmax contains the max value. */
1626 if (!strcmp(ent.d_name, ".") || !strcmp(ent.d_name, ".."))
1629 if (sscanf(ent.d_name, "%hx", &sub_seq) != 1) {
1630 CT_TRACE("'%s' has an unexpected dirname format, "
1631 "skip entry", ent.d_name);
1634 if (sub_seq > *sub_seqmax)
1635 *sub_seqmax = sub_seq;
1638 CT_ERROR(rc, "cannot readdir_r '%s'", dirpath);
1645 static int ct_max_sequence(void)
1648 char path[PATH_MAX];
1652 strncpy(path, opt.o_hsm_root, sizeof(path));
1653 /* FID sequence is stored in top-level directory names:
1654 * hsm_root/16bits (high weight)/16 bits/16 bits/16 bits (low weight).
1656 for (i = 0; i < 4; i++) {
1657 rc = ct_dir_level_max(path, &subseq);
1660 seq |= ((__u64)subseq << ((3 - i) * 16));
1661 sprintf(path + strlen(path), "/%04x", subseq);
1664 printf("max_sequence: %016Lx\n", seq);
1669 static void handler(int signal)
1671 psignal(signal, "exiting");
1672 /* If we don't clean up upon interrupt, umount thinks there's a ref
1673 * and doesn't remove us from mtab (EINPROGRESS). The lustre client
1674 * does successfully unmount and the mount is actually gone, but the
1675 * mtab entry remains. So this just makes mtab happier. */
1676 llapi_hsm_copytool_unregister(&ctdata);
1680 /* Daemon waits for messages from the kernel; run it in the background. */
1681 static int ct_run(void)
1685 if (opt.o_daemonize) {
1689 CT_ERROR(rc, "cannot daemonize");
1694 setbuf(stdout, NULL);
1696 rc = llapi_hsm_copytool_register(&ctdata, opt.o_mnt, 0,
1697 opt.o_archive_cnt, opt.o_archive_id);
1699 CT_ERROR(rc, "cannot start copytool interface");
1703 signal(SIGINT, handler);
1704 signal(SIGTERM, handler);
1707 struct hsm_action_list *hal;
1708 struct hsm_action_item *hai;
1712 CT_TRACE("waiting for message from kernel");
1714 rc = llapi_hsm_copytool_recv(ctdata, &hal, &msgsize);
1715 if (rc == -ESHUTDOWN) {
1716 CT_TRACE("shutting down");
1718 } else if (rc == -EAGAIN) {
1719 continue; /* msg not for us */
1720 } else if (rc < 0) {
1721 CT_WARN("cannot receive action list: %s",
1724 if (opt.o_abort_on_error)
1730 CT_TRACE("copytool fs=%s archive#=%d item_count=%d",
1731 hal->hal_fsname, hal->hal_archive_id, hal->hal_count);
1733 if (strcmp(hal->hal_fsname, fs_name) != 0) {
1734 CT_ERROR(EINVAL, "'%s' invalid fs name, expecting: %s",
1735 hal->hal_fsname, fs_name);
1737 if (opt.o_abort_on_error)
1743 hai = hai_first(hal);
1744 while (++i <= hal->hal_count) {
1745 if ((char *)hai - (char *)hal > msgsize) {
1748 "'%s' item %d past end of message!",
1753 rc = ct_process_item_async(hai, hal->hal_flags);
1755 CT_ERROR(rc, "'%s' item %d process",
1757 if (opt.o_abort_on_error && err_major)
1759 hai = hai_next(hai);
1762 llapi_hsm_action_list_free(&hal);
1764 if (opt.o_abort_on_error && err_major)
1768 llapi_hsm_copytool_unregister(&ctdata);
1773 static int ct_setup(void)
1777 /* set llapi message level */
1778 llapi_msg_set_level(opt.o_verbose);
1780 arc_fd = open(opt.o_hsm_root, O_RDONLY);
1783 CT_ERROR(rc, "cannot open archive at '%s'", opt.o_hsm_root);
1787 rc = llapi_search_fsname(opt.o_mnt, fs_name);
1789 CT_ERROR(rc, "cannot find a Lustre filesystem mounted at '%s'",
1797 static int ct_cleanup(void)
1804 if (close(arc_fd) < 0) {
1806 CT_ERROR(rc, "cannot close archive root directory");
1813 int main(int argc, char **argv)
1817 strncpy(cmd_name, basename(argv[0]), sizeof(cmd_name));
1818 rc = ct_parseopts(argc, argv);
1820 CT_WARN("try '%s --help' for more information", cmd_name);
1826 switch (opt.o_action) {
1828 rc = ct_import_recurse(opt.o_src);
1834 rc = ct_max_sequence();
1841 if (opt.o_action != CA_MAXSEQ)
1842 CT_TRACE("process finished, errs: %d major, %d minor,"
1843 " rc=%d (%s)", err_major, err_minor, rc,