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.
45 #include <sys/xattr.h>
46 #include <sys/syscall.h>
47 #include <sys/types.h>
48 #include <lustre/lustre_idl.h>
49 #include <lustre/lustreapi.h>
51 /* Progress reporting period */
52 #define REPORT_INTERVAL_DEFAULT 30
53 /* HSM hash subdir permissions */
54 #define DIR_PERM S_IRWXU
55 /* HSM hash file permissions */
56 #define FILE_PERM (S_IRUSR | S_IWUSR)
58 #define ONE_MB 0x100000
60 /* copytool uses a 32b bitmask field to register with kuc
61 * archive num = 0 => all
62 * archive num from 1 to 32
64 #define MAX_ARCHIVE_CNT (sizeof(__u32) * 8)
81 int o_archive_id[MAX_ARCHIVE_CNT];
83 unsigned long long o_bandwidth;
85 enum ct_action o_action;
89 char *o_src; /* for import, or rebind */
90 char *o_dst; /* for import, or rebind */
93 /* everything else is zeroed */
94 struct options opt = {
97 .o_verbose = LLAPI_MSG_INFO,
99 .o_report_int = REPORT_INTERVAL_DEFAULT,
100 .o_chunk_size = ONE_MB,
103 /* hsm_copytool_private will hold an open FD on the lustre mount point
104 * for us. Additionally open one on the archive FS root to make sure
105 * it doesn't drop out from under us (and remind the admin to shutdown
106 * the copytool before unmounting). */
108 static int arc_fd = -1;
110 static int err_major;
111 static int err_minor;
113 static char cmd_name[PATH_MAX];
114 static char fs_name[MAX_OBD_NAME + 1];
116 static struct hsm_copytool_private *ctdata;
119 #define CT_ERROR(_rc, _format, ...) \
120 llapi_error(LLAPI_MSG_ERROR, _rc, \
121 "%s[%ld]: "_format, \
122 cmd_name, syscall(SYS_gettid), ## __VA_ARGS__)
123 #define CT_DEBUG(_format, ...) \
124 llapi_error(LLAPI_MSG_DEBUG | LLAPI_MSG_NO_ERRNO, 0, \
125 "%s[%ld]: "_format, \
126 cmd_name, syscall(SYS_gettid), ## __VA_ARGS__)
127 #define CT_WARN(_format, ...) \
128 llapi_error(LLAPI_MSG_WARN | LLAPI_MSG_NO_ERRNO, 0, \
129 "%s[%ld]: "_format, \
130 cmd_name, syscall(SYS_gettid), ## __VA_ARGS__)
131 #define CT_TRACE(_format, ...) \
132 llapi_error(LLAPI_MSG_INFO | LLAPI_MSG_NO_ERRNO, 0, \
133 "%s[%ld]: "_format, \
134 cmd_name, syscall(SYS_gettid), ## __VA_ARGS__)
135 #define CT_PRINTF(_format, ...) \
136 llapi_printf(LLAPI_MSG_NORMAL, \
137 "%s[%ld]: "_format, \
138 cmd_name, syscall(SYS_gettid), ## __VA_ARGS__)
140 static void usage(const char *name, int rc)
143 " Usage: %s [options]... <mode> <lustre_mount_point>\n"
144 "The Lustre HSM Posix copy tool can be used as a daemon or "
145 "as a command line tool\n"
146 "The Lustre HSM daemon acts on action requests from Lustre\n"
147 "to copy files to and from an HSM archive system.\n"
148 "This POSIX-flavored daemon makes regular POSIX filesystem calls\n"
149 "to an HSM mounted at a given hsm_root.\n"
150 " --daemon Daemon mode, run in background\n"
152 " --no-attr Don't copy file attributes\n"
153 " --no-shadow Don't create shadow namespace in archive\n"
154 " --no-xattr Don't copy file extended attributes\n"
155 "The Lustre HSM tool performs administrator-type actions\n"
156 "on a Lustre HSM archive.\n"
157 "This POSIX-flavored tool can link an existing HSM namespace\n"
158 "into a Lustre filesystem.\n"
160 " %s [options] --import <src> <dst> <lustre_mount_point>\n"
161 " import an archived subtree from\n"
162 " <src> (FID or relative path to hsm_root) into the Lustre\n"
164 " <dst> (absolute path)\n"
165 " %s [options] --rebind <old_FID> <new_FID> <lustre_mount_point>\n"
166 " rebind an entry in the HSM to a new FID\n"
167 " <old_FID> old FID the HSM entry is bound to\n"
168 " <new_FID> new FID to bind the HSM entry to\n"
169 " %s [options] --rebind <list_file> <lustre_mount_point>\n"
170 " perform the rebind operation for all FID in the list file\n"
171 " each line of <list_file> consists of <old_FID> <new_FID>\n"
172 " %s [options] --max-sequence <fsname>\n"
173 " return the max fid sequence of archived files\n"
174 " --abort-on-error Abort operation on major error\n"
175 " -A, --archive <#> Archive number (repeatable)\n"
176 " -b, --bandwidth <bw> Limit I/O bandwidth (unit can be used\n,"
178 " --dry-run Don't run, just show what would be done\n"
179 " -c, --chunk-size <sz> I/O size used during data copy\n"
180 " (unit can be used, default is MB)\n"
181 " -f, --event-fifo <path> Write events stream to fifo\n"
182 " -p, --hsm-root <path> Target HSM mount point\n"
183 " -q, --quiet Produce less verbose output\n"
184 " -u, --update-interval <s> Interval between progress reports sent\n"
186 " -v, --verbose Produce more verbose output\n",
187 cmd_name, cmd_name, cmd_name, cmd_name, cmd_name);
192 static int ct_parseopts(int argc, char * const *argv)
194 struct option long_opts[] = {
195 {"abort-on-error", no_argument, &opt.o_abort_on_error, 1},
196 {"abort_on_error", no_argument, &opt.o_abort_on_error, 1},
197 {"archive", required_argument, NULL, 'A'},
198 {"bandwidth", required_argument, NULL, 'b'},
199 {"chunk-size", required_argument, NULL, 'c'},
200 {"chunk_size", required_argument, NULL, 'c'},
201 {"daemon", no_argument, &opt.o_daemonize, 1},
202 {"event-fifo", required_argument, NULL, 'f'},
203 {"event_fifo", required_argument, NULL, 'f'},
204 {"dry-run", no_argument, &opt.o_dry_run, 1},
205 {"help", no_argument, NULL, 'h'},
206 {"hsm-root", required_argument, NULL, 'p'},
207 {"hsm_root", required_argument, NULL, 'p'},
208 {"import", no_argument, NULL, 'i'},
209 {"max-sequence", no_argument, NULL, 'M'},
210 {"max_sequence", no_argument, NULL, 'M'},
211 {"no-attr", no_argument, &opt.o_copy_attrs, 0},
212 {"no_attr", no_argument, &opt.o_copy_attrs, 0},
213 {"no-shadow", no_argument, &opt.o_shadow_tree, 0},
214 {"no_shadow", no_argument, &opt.o_shadow_tree, 0},
215 {"no-xattr", no_argument, &opt.o_copy_xattrs, 0},
216 {"no_xattr", no_argument, &opt.o_copy_xattrs, 0},
217 {"quiet", no_argument, NULL, 'q'},
218 {"rebind", no_argument, NULL, 'r'},
219 {"update-interval", required_argument, NULL, 'u'},
220 {"update_interval", required_argument, NULL, 'u'},
221 {"verbose", no_argument, NULL, 'v'},
225 unsigned long long value;
226 unsigned long long unit;
229 while ((c = getopt_long(argc, argv, "A:b:c:f:hiMp:qru:v",
230 long_opts, NULL)) != -1) {
233 if ((opt.o_archive_cnt >= MAX_ARCHIVE_CNT) ||
234 (atoi(optarg) >= MAX_ARCHIVE_CNT)) {
236 CT_ERROR(rc, "archive number must be less"
237 "than %zu", MAX_ARCHIVE_CNT);
240 opt.o_archive_id[opt.o_archive_cnt] = atoi(optarg);
243 case 'b': /* -b and -c have both a number with unit as arg */
246 if (llapi_parse_size(optarg, &value, &unit, 0) < 0) {
248 CT_ERROR(rc, "bad value for -%c '%s'", c,
253 opt.o_chunk_size = value;
255 opt.o_bandwidth = value;
258 opt.o_event_fifo = optarg;
263 opt.o_action = CA_IMPORT;
266 opt.o_action = CA_MAXSEQ;
269 opt.o_hsm_root = optarg;
275 opt.o_action = CA_REBIND;
278 opt.o_report_int = atoi(optarg);
279 if (opt.o_report_int < 0) {
281 CT_ERROR(rc, "bad value for -%c '%s'", c,
296 switch (opt.o_action) {
298 /* src dst mount_point */
299 if (argc != optind + 3) {
301 CT_ERROR(rc, "--import requires 2 arguments");
304 opt.o_src = argv[optind++];
305 opt.o_dst = argv[optind++];
308 /* FID1 FID2 mount_point or FILE mount_point */
309 if (argc == optind + 2) {
310 opt.o_src = argv[optind++];
312 } else if (argc == optind + 3) {
313 opt.o_src = argv[optind++];
314 opt.o_dst = argv[optind++];
317 CT_ERROR(rc, "--rebind requires 1 or 2 arguments");
323 /* just mount point */
327 if (argc != optind + 1) {
329 CT_ERROR(rc, "no mount point specified");
333 opt.o_mnt = argv[optind];
335 CT_TRACE("action=%d src=%s dst=%s mount_point=%s",
336 opt.o_action, opt.o_src, opt.o_dst, opt.o_mnt);
338 if (!opt.o_dry_run && opt.o_hsm_root == NULL) {
340 CT_ERROR(rc, "must specify a root directory for the backend");
344 if (opt.o_action == CA_IMPORT) {
345 if (opt.o_src && opt.o_src[0] == '/') {
348 "source path must be relative to HSM root");
352 if (opt.o_dst && opt.o_dst[0] != '/') {
354 CT_ERROR(rc, "destination path must be absolute");
363 static int ct_mkdir_p(const char *path)
373 while ((ptr = strchr(ptr, '/')) != NULL) {
375 rc = mkdir(saved, DIR_PERM);
377 if (rc < 0 && errno != EEXIST) {
379 CT_ERROR(rc, "cannot mkdir '%s'", path);
391 static int ct_save_stripe(int src_fd, const char *src, const char *dst)
393 char lov_file[PATH_MAX];
394 char lov_buf[XATTR_SIZE_MAX];
395 struct lov_user_md *lum;
400 snprintf(lov_file, sizeof(lov_file), "%s.lov", dst);
401 CT_TRACE("saving stripe info of '%s' in %s", src, lov_file);
403 xattr_size = fgetxattr(src_fd, XATTR_LUSTRE_LOV, lov_buf,
405 if (xattr_size < 0) {
407 CT_ERROR(rc, "cannot get stripe info on '%s'", src);
411 lum = (struct lov_user_md *)lov_buf;
413 if (lum->lmm_magic == LOV_USER_MAGIC_V1 ||
414 lum->lmm_magic == LOV_USER_MAGIC_V3) {
415 /* Set stripe_offset to -1 so that it is not interpreted as a
416 * hint on restore. */
417 lum->lmm_stripe_offset = -1;
420 fd = open(lov_file, O_TRUNC | O_CREAT | O_WRONLY, FILE_PERM);
423 CT_ERROR(rc, "cannot open '%s'", lov_file);
427 rc = write(fd, lum, xattr_size);
430 CT_ERROR(rc, "cannot write %zd bytes to '%s'",
431 xattr_size, lov_file);
439 CT_ERROR(rc, "cannot close '%s'", lov_file);
451 static int ct_load_stripe(const char *src, void *lovea, size_t *lovea_size)
453 char lov_file[PATH_MAX];
457 snprintf(lov_file, sizeof(lov_file), "%s.lov", src);
458 CT_TRACE("reading stripe rules from '%s' for '%s'", lov_file, src);
460 fd = open(lov_file, O_RDONLY);
462 CT_ERROR(errno, "cannot open '%s'", lov_file);
466 rc = read(fd, lovea, *lovea_size);
468 CT_ERROR(errno, "cannot read %zu bytes from '%s'",
469 *lovea_size, lov_file);
480 static int ct_restore_stripe(const char *src, const char *dst, int dst_fd,
481 const void *lovea, size_t lovea_size)
485 rc = fsetxattr(dst_fd, XATTR_LUSTRE_LOV, lovea, lovea_size,
488 CT_ERROR(errno, "cannot set lov EA on '%s'", dst);
495 static void bandwidth_ctl_delay(int wsize)
497 static unsigned long long tot_bytes;
498 static time_t start_time;
499 static time_t last_time;
500 time_t now = time(0);
503 unsigned int sleep_time;
505 if (now > last_time + 5) {
507 start_time = last_time = now;
511 tot_time = now - start_time;
515 excess = tot_bytes - tot_time * opt.o_bandwidth;
516 sleep_time = excess * 1000000 / opt.o_bandwidth;
517 if ((now - start_time) % 10 == 1)
518 CT_TRACE("bandwith control: excess=%E sleep for %dus", excess,
527 static int ct_copy_data(struct hsm_copyaction_private *hcp, const char *src,
528 const char *dst, int src_fd, int dst_fd,
529 const struct hsm_action_item *hai, long hal_flags)
531 struct hsm_extent he;
532 __u64 offset = hai->hai_extent.offset;
536 __u64 write_total = 0;
538 time_t last_print_time = time(NULL);
541 CT_TRACE("going to copy data from '%s' to '%s'", src, dst);
543 if (fstat(src_fd, &src_st) < 0) {
545 CT_ERROR(rc, "cannot stat '%s'", src);
549 if (!S_ISREG(src_st.st_mode)) {
551 CT_ERROR(rc, "'%s' is not a regular file", src);
555 if (fstat(dst_fd, &dst_st) < 0) {
557 CT_ERROR(rc, "cannot stat '%s'", dst);
561 if (!S_ISREG(dst_st.st_mode)) {
563 CT_ERROR(rc, "'%s' is not a regular file", dst);
567 rc = lseek(src_fd, hai->hai_extent.offset, SEEK_SET);
571 "cannot seek for read to "LPU64" (len %jd) in '%s'",
572 hai->hai_extent.offset, (intmax_t)src_st.st_size, src);
576 /* Don't read beyond a given extent */
577 length = min(hai->hai_extent.length, src_st.st_size);
581 rc = llapi_hsm_action_progress(hcp, &he, length, 0);
583 /* Action has been canceled or something wrong
584 * is happening. Stop copying data. */
585 CT_ERROR(rc, "progress ioctl for copy '%s'->'%s' failed",
592 buf = malloc(opt.o_chunk_size);
598 CT_DEBUG("Going to copy "LPU64" bytes %s -> %s\n", length, src, dst);
600 while (write_total < length) {
603 int chunk = (length - write_total > opt.o_chunk_size) ?
604 opt.o_chunk_size : length - write_total;
606 rsize = pread(src_fd, buf, chunk, offset);
613 CT_ERROR(rc, "cannot read from '%s'", src);
617 wsize = pwrite(dst_fd, buf, rsize, offset);
620 CT_ERROR(rc, "cannot write to '%s'", dst);
624 write_total += wsize;
627 if (opt.o_bandwidth != 0)
628 /* sleep if needed, to honor bandwidth limits */
629 bandwidth_ctl_delay(wsize);
631 if (time(0) >= last_print_time + opt.o_report_int) {
632 last_print_time = time(0);
633 CT_TRACE("%%"LPU64" ", 100 * write_total / length);
634 he.length = write_total;
635 rc = llapi_hsm_action_progress(hcp, &he, length, 0);
637 /* Action has been canceled or something wrong
638 * is happening. Stop copying data. */
639 CT_ERROR(rc, "progress ioctl for copy"
640 " '%s'->'%s' failed", src, dst);
649 * truncate restored file
650 * size is taken from the archive this is done to support
651 * restore after a force release which leaves the file with the
652 * wrong size (can big bigger than the new size)
654 if ((hai->hai_action == HSMA_RESTORE) &&
655 (src_st.st_size < dst_st.st_size)) {
657 * make sure the file is on disk before reporting success.
659 rc = ftruncate(dst_fd, src_st.st_size);
662 CT_ERROR(rc, "cannot truncate '%s' to size %jd",
663 dst, (intmax_t)src_st.st_size);
674 /* Copy file attributes from file src to file dest */
675 static int ct_copy_attr(const char *src, const char *dst, int src_fd,
679 struct timeval times[2];
682 if (fstat(src_fd, &st) < 0) {
684 CT_ERROR(rc, "cannot stat '%s'", src);
688 times[0].tv_sec = st.st_atime;
689 times[0].tv_usec = 0;
690 times[1].tv_sec = st.st_mtime;
691 times[1].tv_usec = 0;
692 if (fchmod(dst_fd, st.st_mode) < 0 ||
693 fchown(dst_fd, st.st_uid, st.st_gid) < 0 ||
694 futimes(dst_fd, times) < 0) {
696 CT_ERROR(rc, "cannot set attributes of '%s'", src);
703 static int ct_copy_xattr(const char *src, const char *dst, int src_fd,
704 int dst_fd, bool is_restore)
706 char list[XATTR_LIST_MAX];
707 char value[XATTR_SIZE_MAX];
712 list_len = flistxattr(src_fd, list, sizeof(list));
717 while (name < list + list_len) {
718 rc = fgetxattr(src_fd, name, value, sizeof(value));
722 /* when we restore, we do not restore lustre xattr */
724 (strncmp(XATTR_TRUSTED_PREFIX, name,
725 sizeof(XATTR_TRUSTED_PREFIX) - 1) != 0)) {
726 rc = fsetxattr(dst_fd, name, value, rc, 0);
727 CT_TRACE("fsetxattr of '%s' on '%s' rc=%d (%s)",
728 name, dst, rc, strerror(errno));
729 /* lustre.* attrs aren't supported on other FS's */
730 if (rc < 0 && errno != EOPNOTSUPP) {
732 CT_ERROR(rc, "cannot set extended attribute"
738 name += strlen(name) + 1;
744 static int ct_path_lustre(char *buf, int sz, const char *mnt,
745 const lustre_fid *fid)
747 return snprintf(buf, sz, "%s/%s/fid/"DFID_NOBRACE, mnt,
748 dot_lustre_name, PFID(fid));
751 static int ct_path_archive(char *buf, int sz, const char *archive_dir,
752 const lustre_fid *fid)
754 return snprintf(buf, sz, "%s/%04x/%04x/%04x/%04x/%04x/%04x/"
755 DFID_NOBRACE, archive_dir,
756 (fid)->f_oid & 0xFFFF,
757 (fid)->f_oid >> 16 & 0xFFFF,
758 (unsigned int)((fid)->f_seq & 0xFFFF),
759 (unsigned int)((fid)->f_seq >> 16 & 0xFFFF),
760 (unsigned int)((fid)->f_seq >> 32 & 0xFFFF),
761 (unsigned int)((fid)->f_seq >> 48 & 0xFFFF),
765 static bool ct_is_retryable(int err)
767 return err == -ETIMEDOUT;
770 static int ct_begin_restore(struct hsm_copyaction_private **phcp,
771 const struct hsm_action_item *hai,
772 int mdt_index, int open_flags)
777 rc = llapi_hsm_action_begin(phcp, ctdata, hai, mdt_index, open_flags,
780 ct_path_lustre(src, sizeof(src), opt.o_mnt, &hai->hai_fid);
781 CT_ERROR(rc, "llapi_hsm_action_begin() on '%s' failed", src);
787 static int ct_begin(struct hsm_copyaction_private **phcp,
788 const struct hsm_action_item *hai)
790 /* Restore takes specific parameters. Call the same function w/ default
791 * values for all other operations. */
792 return ct_begin_restore(phcp, hai, -1, 0);
795 static int ct_fini(struct hsm_copyaction_private **phcp,
796 const struct hsm_action_item *hai, int hp_flags, int ct_rc)
798 struct hsm_copyaction_private *hcp;
802 CT_TRACE("Action completed, notifying coordinator "
803 "cookie="LPX64", FID="DFID", hp_flags=%d err=%d",
804 hai->hai_cookie, PFID(&hai->hai_fid),
807 ct_path_lustre(lstr, sizeof(lstr), opt.o_mnt, &hai->hai_fid);
809 if (phcp == NULL || *phcp == NULL) {
810 rc = llapi_hsm_action_begin(&hcp, ctdata, hai, -1, 0, true);
812 CT_ERROR(rc, "llapi_hsm_action_begin() on '%s' failed",
819 rc = llapi_hsm_action_end(phcp, &hai->hai_extent, hp_flags, abs(ct_rc));
820 if (rc == -ECANCELED)
821 CT_ERROR(rc, "completed action on '%s' has been canceled: "
822 "cookie="LPX64", FID="DFID, lstr, hai->hai_cookie,
823 PFID(&hai->hai_fid));
825 CT_ERROR(rc, "llapi_hsm_action_end() on '%s' failed", lstr);
827 CT_TRACE("llapi_hsm_action_end() on '%s' ok (rc=%d)",
833 static int ct_archive(const struct hsm_action_item *hai, const long hal_flags)
835 struct hsm_copyaction_private *hcp = NULL;
837 char dst[PATH_MAX] = "";
840 bool rename_needed = false;
846 rc = ct_begin(&hcp, hai);
850 /* we fill archive so:
852 * destination = lustre FID
854 ct_path_lustre(src, sizeof(src), opt.o_mnt, &hai->hai_dfid);
855 ct_path_archive(dst, sizeof(dst), opt.o_hsm_root, &hai->hai_fid);
856 if (hai->hai_extent.length == -1) {
857 /* whole file, write it to tmp location and atomically
858 * replace old archived file */
859 strncat(dst, "_tmp", sizeof(dst) - strlen(dst) - 1);
860 /* we cannot rely on the same test because ct_copy_data()
861 * updates hai_extent.length */
862 rename_needed = true;
865 CT_TRACE("archiving '%s' to '%s'", src, dst);
872 rc = ct_mkdir_p(dst);
874 CT_ERROR(rc, "mkdir_p '%s' failed", dst);
878 src_fd = llapi_hsm_action_get_fd(hcp);
881 CT_ERROR(rc, "cannot open '%s' for read", src);
885 open_flags = O_WRONLY | O_NOFOLLOW | O_NONBLOCK;
886 /* If extent is specified, don't truncate an old archived copy */
887 open_flags |= ((hai->hai_extent.length == -1) ? O_TRUNC : 0) | O_CREAT;
889 dst_fd = open(dst, open_flags, FILE_PERM);
892 CT_ERROR(rc, "cannot open '%s' for write", dst);
896 /* saving stripe is not critical */
897 rc = ct_save_stripe(src_fd, src, dst);
899 CT_ERROR(rc, "cannot save file striping info of '%s' in '%s'",
902 rc = ct_copy_data(hcp, src, dst, src_fd, dst_fd, hai, hal_flags);
904 CT_ERROR(rc, "data copy failed from '%s' to '%s'", src, dst);
911 CT_ERROR(rc, "cannot flush '%s' archive file '%s'", src, dst);
915 CT_TRACE("data archiving for '%s' to '%s' done", src, dst);
917 /* attrs will remain on the MDS; no need to copy them, except possibly
918 for disaster recovery */
919 if (opt.o_copy_attrs) {
920 rc = ct_copy_attr(src, dst, src_fd, dst_fd);
922 CT_ERROR(rc, "cannot copy attr of '%s' to '%s'",
926 CT_TRACE("attr file for '%s' saved to archive '%s'",
930 /* xattrs will remain on the MDS; no need to copy them, except possibly
931 for disaster recovery */
932 if (opt.o_copy_xattrs) {
933 rc = ct_copy_xattr(src, dst, src_fd, dst_fd, false);
935 CT_ERROR(rc, "cannot copy xattr of '%s' to '%s'",
937 rcf = rcf ? rcf : rc;
939 CT_TRACE("xattr file for '%s' saved to archive '%s'",
943 if (rename_needed == true) {
944 char tmp_src[PATH_MAX];
945 char tmp_dst[PATH_MAX];
947 /* atomically replace old archived file */
948 ct_path_archive(src, sizeof(src), opt.o_hsm_root,
950 rc = rename(dst, src);
953 CT_ERROR(rc, "cannot rename '%s' to '%s'", dst, src);
956 /* rename lov file */
957 snprintf(tmp_src, sizeof(tmp_src), "%s.lov", src);
958 snprintf(tmp_dst, sizeof(tmp_dst), "%s.lov", dst);
959 rc = rename(tmp_dst, tmp_src);
961 CT_ERROR(errno, "cannot rename '%s' to '%s'",
965 if (opt.o_shadow_tree) {
966 /* Create a namespace of softlinks that shadows the original
967 * Lustre namespace. This will only be current at
968 * time-of-archive (won't follow renames).
969 * WARNING: release won't kill these links; a manual
970 * cleanup of dead links would be required.
973 long long recno = -1;
979 sprintf(buf, DFID, PFID(&hai->hai_fid));
980 sprintf(src, "%s/shadow/", opt.o_hsm_root);
982 ptr = opt.o_hsm_root;
984 (*ptr++ == '/') ? depth-- : 0;
986 rc = llapi_fid2path(opt.o_mnt, buf, src + strlen(src),
987 sizeof(src) - strlen(src), &recno, &linkno);
989 CT_ERROR(rc, "cannot get FID of '%s'", buf);
990 rcf = rcf ? rcf : rc;
994 /* Figure out how many parent dirs to symlink back */
997 (*ptr++ == '/') ? depth++ : 0;
1002 ct_path_archive(dst, sizeof(dst), buf, &hai->hai_fid);
1004 if (ct_mkdir_p(src)) {
1005 CT_ERROR(errno, "mkdir_p '%s' failed", src);
1006 rcf = rcf ? rcf : -errno;
1009 /* symlink already exists ? */
1010 sz = readlink(src, buf, sizeof(buf));
1011 /* detect truncation */
1012 if (sz == sizeof(buf)) {
1013 rcf = rcf ? rcf : -E2BIG;
1014 CT_ERROR(rcf, "readlink '%s' truncated", src);
1019 if (sz == 0 || strncmp(buf, dst, sz) != 0) {
1020 if (unlink(src) && errno != ENOENT) {
1022 "cannot unlink symlink '%s'",
1024 rcf = rcf ? rcf : -errno;
1026 /* unlink old symlink done */
1027 CT_TRACE("remove old symlink '%s' pointing"
1028 " to '%s'", src, buf);
1031 /* symlink already ok */
1032 CT_TRACE("symlink '%s' already pointing"
1033 " to '%s'", src, dst);
1038 if (symlink(dst, src)) {
1039 CT_ERROR(errno, "cannot symlink '%s' to '%s'",
1041 rcf = rcf ? rcf : -errno;
1044 CT_TRACE("symlink '%s' to '%s' done", src, dst);
1056 if (ct_is_retryable(rc))
1057 hp_flags |= HP_FLAG_RETRY;
1068 rc = ct_fini(&hcp, hai, hp_flags, rcf);
1073 static int ct_restore(const struct hsm_action_item *hai, const long hal_flags)
1075 struct hsm_copyaction_private *hcp = NULL;
1078 char lov_buf[XATTR_SIZE_MAX];
1079 size_t lov_size = sizeof(lov_buf);
1084 int mdt_index = -1; /* Not implemented */
1088 /* we fill lustre so:
1089 * source = lustre FID in the backend
1090 * destination = data FID = volatile file
1093 /* build backend file name from released file FID */
1094 ct_path_archive(src, sizeof(src), opt.o_hsm_root, &hai->hai_fid);
1096 /* restore loads and sets the LOVEA w/o interpreting it to avoid
1097 * dependency on the structure format. */
1098 rc = ct_load_stripe(src, lov_buf, &lov_size);
1100 CT_WARN("cannot get stripe rules for '%s' (%s), use default",
1101 src, strerror(-rc));
1104 open_flags |= O_LOV_DELAY_CREATE;
1108 rc = ct_begin_restore(&hcp, hai, mdt_index, open_flags);
1112 /* get the FID of the volatile file */
1113 rc = llapi_hsm_action_get_dfid(hcp, &dfid);
1115 CT_ERROR(rc, "restoring "DFID
1116 ", cannot get FID of created volatile file",
1117 PFID(&hai->hai_fid));
1121 /* build volatile "file name", for messages */
1122 snprintf(dst, sizeof(dst), "{VOLATILE}="DFID, PFID(&dfid));
1124 CT_TRACE("restoring data from '%s' to '%s'", src, dst);
1126 if (opt.o_dry_run) {
1131 src_fd = open(src, O_RDONLY | O_NOATIME | O_NONBLOCK | O_NOFOLLOW);
1134 CT_ERROR(rc, "cannot open '%s' for read", src);
1138 dst_fd = llapi_hsm_action_get_fd(hcp);
1141 /* the layout cannot be allocated through .fid so we have to
1142 * restore a layout */
1143 rc = ct_restore_stripe(src, dst, dst_fd, lov_buf, lov_size);
1145 CT_ERROR(rc, "cannot restore file striping info"
1146 " for '%s' from '%s'", dst, src);
1152 rc = ct_copy_data(hcp, src, dst, src_fd, dst_fd, hai, hal_flags);
1154 CT_ERROR(rc, "cannot copy data from '%s' to '%s'",
1157 if (ct_is_retryable(rc))
1158 hp_flags |= HP_FLAG_RETRY;
1162 CT_TRACE("data restore from '%s' to '%s' done", src, dst);
1165 rc = ct_fini(&hcp, hai, hp_flags, rc);
1167 /* object swaping is done by cdt at copy end, so close of volatile file
1168 * cannot be done before */
1178 static int ct_remove(const struct hsm_action_item *hai, const long hal_flags)
1180 struct hsm_copyaction_private *hcp = NULL;
1184 rc = ct_begin(&hcp, hai);
1188 ct_path_archive(dst, sizeof(dst), opt.o_hsm_root, &hai->hai_fid);
1190 CT_TRACE("removing file '%s'", dst);
1192 if (opt.o_dry_run) {
1200 CT_ERROR(rc, "cannot unlink '%s'", dst);
1205 strncat(dst, ".lov", sizeof(dst) - strlen(dst) - 1);
1209 CT_ERROR(rc, "cannot unlink '%s'", dst);
1215 rc = ct_fini(&hcp, hai, 0, rc);
1220 static int ct_process_item(struct hsm_action_item *hai, const long hal_flags)
1224 if (opt.o_verbose >= LLAPI_MSG_INFO || opt.o_dry_run) {
1225 /* Print the original path */
1227 char path[PATH_MAX];
1228 long long recno = -1;
1231 sprintf(fid, DFID, PFID(&hai->hai_fid));
1232 CT_TRACE("'%s' action %s reclen %d, cookie="LPX64,
1233 fid, hsm_copytool_action2name(hai->hai_action),
1234 hai->hai_len, hai->hai_cookie);
1235 rc = llapi_fid2path(opt.o_mnt, fid, path,
1236 sizeof(path), &recno, &linkno);
1238 CT_ERROR(rc, "cannot get path of FID %s", fid);
1240 CT_TRACE("processing file '%s'", path);
1243 switch (hai->hai_action) {
1244 /* set err_major, minor inside these functions */
1246 rc = ct_archive(hai, hal_flags);
1249 rc = ct_restore(hai, hal_flags);
1252 rc = ct_remove(hai, hal_flags);
1255 CT_TRACE("cancel not implemented for file system '%s'",
1257 /* Don't report progress to coordinator for this cookie:
1258 * the copy function will get ECANCELED when reporting
1265 CT_ERROR(rc, "unknown action %d, on '%s'", hai->hai_action,
1268 ct_fini(NULL, hai, 0, rc);
1276 struct hsm_action_item *hai;
1279 static void *ct_thread(void *data)
1281 struct ct_th_data *cttd = data;
1284 rc = ct_process_item(cttd->hai, cttd->hal_flags);
1288 pthread_exit((void *)(intptr_t)rc);
1291 static int ct_process_item_async(const struct hsm_action_item *hai,
1294 pthread_attr_t attr;
1296 struct ct_th_data *data;
1299 data = malloc(sizeof(*data));
1303 data->hai = malloc(hai->hai_len);
1304 if (data->hai == NULL) {
1309 memcpy(data->hai, hai, hai->hai_len);
1310 data->hal_flags = hal_flags;
1312 rc = pthread_attr_init(&attr);
1314 CT_ERROR(rc, "pthread_attr_init failed for '%s' service",
1321 pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
1323 rc = pthread_create(&thread, &attr, ct_thread, data);
1325 CT_ERROR(rc, "cannot create thread for '%s' service",
1328 pthread_attr_destroy(&attr);
1332 static int ct_import_one(const char *src, const char *dst)
1334 char newarc[PATH_MAX];
1339 CT_TRACE("importing '%s' from '%s'", dst, src);
1341 if (stat(src, &st) < 0) {
1343 CT_ERROR(rc, "cannot stat '%s'", src);
1350 rc = llapi_hsm_import(dst,
1351 opt.o_archive_cnt ? opt.o_archive_id[0] : 0,
1352 &st, 0, 0, 0, 0, NULL, &fid);
1354 CT_ERROR(rc, "cannot import '%s' from '%s'", dst, src);
1358 ct_path_archive(newarc, sizeof(newarc), opt.o_hsm_root, &fid);
1360 rc = ct_mkdir_p(newarc);
1362 CT_ERROR(rc, "mkdir_p '%s' failed", newarc);
1368 /* Lots of choices now: mv, ln, ln -s ? */
1369 rc = link(src, newarc); /* hardlink */
1372 CT_ERROR(rc, "cannot link '%s' to '%s'", newarc, src);
1376 CT_TRACE("imported '%s' from '%s'=='%s'", dst, newarc, src);
1381 static char *path_concat(const char *dirname, const char *basename)
1386 rc = asprintf(&result, "%s/%s", dirname, basename);
1393 static int ct_import_fid(const lustre_fid *import_fid)
1395 char fid_path[PATH_MAX];
1398 ct_path_lustre(fid_path, sizeof(fid_path), opt.o_mnt, import_fid);
1399 rc = access(fid_path, F_OK);
1400 if (rc == 0 || errno != ENOENT) {
1401 rc = (errno == 0) ? -EEXIST : -errno;
1402 CT_ERROR(rc, "cannot import '"DFID"'", PFID(import_fid));
1406 ct_path_archive(fid_path, sizeof(fid_path), opt.o_hsm_root,
1409 CT_TRACE("Resolving "DFID" to %s", PFID(import_fid), fid_path);
1411 return ct_import_one(fid_path, opt.o_dst);
1414 static int ct_import_recurse(const char *relpath)
1417 struct dirent ent, *cookie = NULL;
1418 char *srcpath, *newpath;
1419 lustre_fid import_fid;
1422 if (relpath == NULL)
1425 /* Is relpath a FID? In which case SFID should expand to three
1427 rc = sscanf(relpath, SFID, RFID(&import_fid));
1429 return ct_import_fid(&import_fid);
1431 srcpath = path_concat(opt.o_hsm_root, relpath);
1432 if (srcpath == NULL) {
1437 dir = opendir(srcpath);
1439 /* Not a dir, or error */
1440 if (errno == ENOTDIR) {
1441 /* Single regular file case, treat o_dst as absolute
1443 rc = ct_import_one(srcpath, opt.o_dst);
1446 CT_ERROR(rc, "cannot opendir '%s'", srcpath);
1455 rc = readdir_r(dir, &ent, &cookie);
1458 CT_ERROR(rc, "cannot readdir_r '%s'", relpath);
1461 } else if ((rc == 0) && (cookie == NULL)) {
1462 /* end of directory */
1466 if (!strcmp(ent.d_name, ".") ||
1467 !strcmp(ent.d_name, ".."))
1470 /* New relative path */
1471 newpath = path_concat(relpath, ent.d_name);
1472 if (newpath == NULL) {
1478 if (ent.d_type == DT_DIR) {
1479 rc = ct_import_recurse(newpath);
1484 sprintf(src, "%s/%s", opt.o_hsm_root, newpath);
1485 sprintf(dst, "%s/%s", opt.o_dst, newpath);
1486 /* Make the target dir in the Lustre fs */
1487 rc = ct_mkdir_p(dst);
1489 /* Import the file */
1490 rc = ct_import_one(src, dst);
1492 CT_ERROR(rc, "ct_mkdir_p '%s' failed", dst);
1498 CT_ERROR(rc, "cannot import '%s'", newpath);
1499 if (err_major && opt.o_abort_on_error) {
1513 static int ct_rebind_one(const lustre_fid *old_fid, const lustre_fid *new_fid)
1519 CT_TRACE("rebind "DFID" to "DFID, PFID(old_fid), PFID(new_fid));
1521 ct_path_archive(src, sizeof(src), opt.o_hsm_root, old_fid);
1522 ct_path_archive(dst, sizeof(dst), opt.o_hsm_root, new_fid);
1524 if (!opt.o_dry_run) {
1526 if (rename(src, dst)) {
1528 CT_ERROR(rc, "cannot rename '%s' to '%s'", src, dst);
1531 /* rename lov file */
1532 strncat(src, ".lov", sizeof(src) - strlen(src) - 1);
1533 strncat(dst, ".lov", sizeof(dst) - strlen(dst) - 1);
1534 if (rename(src, dst))
1535 CT_ERROR(errno, "cannot rename '%s' to '%s'", src, dst);
1541 static bool fid_is_file(lustre_fid *fid)
1543 return fid_is_norm(fid) || fid_is_igif(fid);
1546 static bool should_ignore_line(const char *line)
1550 for (i = 0; line[i] != '\0'; i++) {
1551 if (isspace(line[i]))
1553 else if (line[i] == '#')
1562 static int ct_rebind_list(const char *list)
1568 size_t line_size = 0;
1569 unsigned int nl = 0;
1570 unsigned int ok = 0;
1572 filp = fopen(list, "r");
1575 CT_ERROR(rc, "cannot open '%s'", list);
1579 /* each line consists of 2 FID */
1580 while ((r = getline(&line, &line_size, filp)) != -1) {
1584 /* Ignore empty and commented out ('#...') lines. */
1585 if (should_ignore_line(line))
1590 rc = sscanf(line, SFID" "SFID, RFID(&old_fid), RFID(&new_fid));
1591 if (rc != 6 || !fid_is_file(&old_fid) ||
1592 !fid_is_file(&new_fid)) {
1594 "'%s' FID expected near '%s', line %u",
1600 if (ct_rebind_one(&old_fid, &new_fid))
1611 /* return 0 if all rebinds were sucessful */
1612 CT_TRACE("%u lines read from '%s', %u rebind successful", nl, list, ok);
1614 return ok == nl ? 0 : -1;
1617 static int ct_rebind(void)
1625 if (sscanf(opt.o_src, SFID, RFID(&old_fid)) != 3 ||
1626 !fid_is_file(&old_fid)) {
1628 CT_ERROR(rc, "'%s' invalid FID format", opt.o_src);
1632 if (sscanf(opt.o_dst, SFID, RFID(&new_fid)) != 3 ||
1633 !fid_is_file(&new_fid)) {
1635 CT_ERROR(rc, "'%s' invalid FID format", opt.o_dst);
1639 rc = ct_rebind_one(&old_fid, &new_fid);
1644 /* o_src is a list file */
1645 rc = ct_rebind_list(opt.o_src);
1650 static int ct_dir_level_max(const char *dirpath, __u16 *sub_seqmax)
1655 struct dirent ent, *cookie = NULL;
1659 dir = opendir(dirpath);
1662 CT_ERROR(rc, "cannot open directory '%s'", opt.o_hsm_root);
1666 while ((rc = readdir_r(dir, &ent, &cookie)) == 0) {
1668 /* end of directory.
1669 * rc is 0 and seqmax contains the max value. */
1672 if (!strcmp(ent.d_name, ".") || !strcmp(ent.d_name, ".."))
1675 if (sscanf(ent.d_name, "%hx", &sub_seq) != 1) {
1676 CT_TRACE("'%s' has an unexpected dirname format, "
1677 "skip entry", ent.d_name);
1680 if (sub_seq > *sub_seqmax)
1681 *sub_seqmax = sub_seq;
1684 CT_ERROR(rc, "cannot readdir_r '%s'", dirpath);
1691 static int ct_max_sequence(void)
1694 char path[PATH_MAX];
1698 strncpy(path, opt.o_hsm_root, sizeof(path));
1699 /* FID sequence is stored in top-level directory names:
1700 * hsm_root/16bits (high weight)/16 bits/16 bits/16 bits (low weight).
1702 for (i = 0; i < 4; i++) {
1703 rc = ct_dir_level_max(path, &subseq);
1706 seq |= ((__u64)subseq << ((3 - i) * 16));
1707 sprintf(path + strlen(path), "/%04x", subseq);
1710 printf("max_sequence: "LPX64"\n", seq);
1715 static void handler(int signal)
1717 psignal(signal, "exiting");
1718 /* If we don't clean up upon interrupt, umount thinks there's a ref
1719 * and doesn't remove us from mtab (EINPROGRESS). The lustre client
1720 * does successfully unmount and the mount is actually gone, but the
1721 * mtab entry remains. So this just makes mtab happier. */
1722 llapi_hsm_copytool_unregister(&ctdata);
1726 /* Daemon waits for messages from the kernel; run it in the background. */
1727 static int ct_run(void)
1731 if (opt.o_daemonize) {
1735 CT_ERROR(rc, "cannot daemonize");
1740 setbuf(stdout, NULL);
1742 if (opt.o_event_fifo != NULL) {
1743 rc = llapi_hsm_register_event_fifo(opt.o_event_fifo);
1745 CT_ERROR(rc, "failed to register event fifo");
1748 llapi_error_callback_set(llapi_hsm_log_error);
1751 rc = llapi_hsm_copytool_register(&ctdata, opt.o_mnt, 0,
1752 opt.o_archive_cnt, opt.o_archive_id);
1754 CT_ERROR(rc, "cannot start copytool interface");
1758 signal(SIGINT, handler);
1759 signal(SIGTERM, handler);
1762 struct hsm_action_list *hal;
1763 struct hsm_action_item *hai;
1767 CT_TRACE("waiting for message from kernel");
1769 rc = llapi_hsm_copytool_recv(ctdata, &hal, &msgsize);
1770 if (rc == -ESHUTDOWN) {
1771 CT_TRACE("shutting down");
1773 } else if (rc == -EAGAIN) {
1774 continue; /* msg not for us */
1775 } else if (rc < 0) {
1776 CT_WARN("cannot receive action list: %s",
1779 if (opt.o_abort_on_error)
1785 CT_TRACE("copytool fs=%s archive#=%d item_count=%d",
1786 hal->hal_fsname, hal->hal_archive_id, hal->hal_count);
1788 if (strcmp(hal->hal_fsname, fs_name) != 0) {
1790 CT_ERROR(rc, "'%s' invalid fs name, expecting: %s",
1791 hal->hal_fsname, fs_name);
1793 if (opt.o_abort_on_error)
1799 hai = hai_first(hal);
1800 while (++i <= hal->hal_count) {
1801 if ((char *)hai - (char *)hal > msgsize) {
1804 "'%s' item %d past end of message!",
1809 rc = ct_process_item_async(hai, hal->hal_flags);
1811 CT_ERROR(rc, "'%s' item %d process",
1813 if (opt.o_abort_on_error && err_major)
1815 hai = hai_next(hai);
1818 llapi_hsm_action_list_free(&hal);
1820 if (opt.o_abort_on_error && err_major)
1824 llapi_hsm_copytool_unregister(&ctdata);
1825 if (opt.o_event_fifo != NULL)
1826 llapi_hsm_unregister_event_fifo(opt.o_event_fifo);
1831 static int ct_setup(void)
1835 /* set llapi message level */
1836 llapi_msg_set_level(opt.o_verbose);
1838 arc_fd = open(opt.o_hsm_root, O_RDONLY);
1841 CT_ERROR(rc, "cannot open archive at '%s'", opt.o_hsm_root);
1845 rc = llapi_search_fsname(opt.o_mnt, fs_name);
1847 CT_ERROR(rc, "cannot find a Lustre filesystem mounted at '%s'",
1855 static int ct_cleanup(void)
1862 if (close(arc_fd) < 0) {
1864 CT_ERROR(rc, "cannot close archive root directory");
1871 int main(int argc, char **argv)
1875 strncpy(cmd_name, basename(argv[0]), sizeof(cmd_name));
1876 rc = ct_parseopts(argc, argv);
1878 CT_WARN("try '%s --help' for more information", cmd_name);
1884 switch (opt.o_action) {
1886 rc = ct_import_recurse(opt.o_src);
1892 rc = ct_max_sequence();
1899 if (opt.o_action != CA_MAXSEQ)
1900 CT_TRACE("process finished, errs: %d major, %d minor,"
1901 " rc=%d (%s)", err_major, err_minor, rc,