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)
376 while ((ptr = strchr(ptr, '/')) != NULL) {
378 rc = mkdir(saved, DIR_PERM);
380 if (rc < 0 && errno != EEXIST) {
382 CT_ERROR(rc, "cannot mkdir '%s'", path);
394 static int ct_save_stripe(int src_fd, const char *src, const char *dst)
396 char lov_file[PATH_MAX];
397 char lov_buf[XATTR_SIZE_MAX];
398 struct lov_user_md *lum;
403 snprintf(lov_file, sizeof(lov_file), "%s.lov", dst);
404 CT_TRACE("saving stripe info of '%s' in %s", src, lov_file);
406 xattr_size = fgetxattr(src_fd, XATTR_LUSTRE_LOV, lov_buf,
408 if (xattr_size < 0) {
410 CT_ERROR(rc, "cannot get stripe info on '%s'", src);
414 lum = (struct lov_user_md *)lov_buf;
416 if (lum->lmm_magic == LOV_USER_MAGIC_V1 ||
417 lum->lmm_magic == LOV_USER_MAGIC_V3) {
418 /* Set stripe_offset to -1 so that it is not interpreted as a
419 * hint on restore. */
420 lum->lmm_stripe_offset = -1;
423 fd = open(lov_file, O_TRUNC | O_CREAT | O_WRONLY, FILE_PERM);
426 CT_ERROR(rc, "cannot open '%s'", lov_file);
430 rc = write(fd, lum, xattr_size);
433 CT_ERROR(rc, "cannot write %zd bytes to '%s'",
434 xattr_size, lov_file);
442 CT_ERROR(rc, "cannot close '%s'", lov_file);
454 static int ct_load_stripe(const char *src, void *lovea, size_t *lovea_size)
456 char lov_file[PATH_MAX];
460 snprintf(lov_file, sizeof(lov_file), "%s.lov", src);
461 CT_TRACE("reading stripe rules from '%s' for '%s'", lov_file, src);
463 fd = open(lov_file, O_RDONLY);
465 CT_ERROR(errno, "cannot open '%s'", lov_file);
469 rc = read(fd, lovea, *lovea_size);
471 CT_ERROR(errno, "cannot read %zu bytes from '%s'",
472 *lovea_size, lov_file);
483 static int ct_restore_stripe(const char *src, const char *dst, int dst_fd,
484 const void *lovea, size_t lovea_size)
488 rc = fsetxattr(dst_fd, XATTR_LUSTRE_LOV, lovea, lovea_size,
491 CT_ERROR(errno, "cannot set lov EA on '%s'", dst);
498 static void bandwidth_ctl_delay(int wsize)
500 static unsigned long long tot_bytes;
501 static time_t start_time;
502 static time_t last_time;
503 time_t now = time(0);
506 unsigned int sleep_time;
508 if (now > last_time + 5) {
510 start_time = last_time = now;
514 tot_time = now - start_time;
518 excess = tot_bytes - tot_time * opt.o_bandwidth;
519 sleep_time = excess * 1000000 / opt.o_bandwidth;
520 if ((now - start_time) % 10 == 1)
521 CT_TRACE("bandwith control: excess=%E sleep for %dus", excess,
530 static int ct_copy_data(struct hsm_copyaction_private *hcp, const char *src,
531 const char *dst, int src_fd, int dst_fd,
532 const struct hsm_action_item *hai, long hal_flags)
534 struct hsm_extent he;
535 __u64 offset = hai->hai_extent.offset;
539 __u64 write_total = 0;
541 time_t last_print_time = time(NULL);
544 CT_TRACE("going to copy data from '%s' to '%s'", src, dst);
546 if (fstat(src_fd, &src_st) < 0) {
548 CT_ERROR(rc, "cannot stat '%s'", src);
552 if (!S_ISREG(src_st.st_mode)) {
554 CT_ERROR(rc, "'%s' is not a regular file", src);
558 if (fstat(dst_fd, &dst_st) < 0) {
560 CT_ERROR(rc, "cannot stat '%s'", dst);
564 if (!S_ISREG(dst_st.st_mode)) {
566 CT_ERROR(rc, "'%s' is not a regular file", dst);
570 rc = lseek(src_fd, hai->hai_extent.offset, SEEK_SET);
574 "cannot seek for read to "LPU64" (len %jd) in '%s'",
575 hai->hai_extent.offset, (intmax_t)src_st.st_size, src);
579 /* Don't read beyond a given extent */
580 length = min(hai->hai_extent.length, src_st.st_size);
584 rc = llapi_hsm_action_progress(hcp, &he, length, 0);
586 /* Action has been canceled or something wrong
587 * is happening. Stop copying data. */
588 CT_ERROR(rc, "progress ioctl for copy '%s'->'%s' failed",
595 buf = malloc(opt.o_chunk_size);
601 CT_DEBUG("Going to copy "LPU64" bytes %s -> %s\n", length, src, dst);
603 while (write_total < length) {
606 int chunk = (length - write_total > opt.o_chunk_size) ?
607 opt.o_chunk_size : length - write_total;
609 rsize = pread(src_fd, buf, chunk, offset);
616 CT_ERROR(rc, "cannot read from '%s'", src);
620 wsize = pwrite(dst_fd, buf, rsize, offset);
623 CT_ERROR(rc, "cannot write to '%s'", dst);
627 write_total += wsize;
630 if (opt.o_bandwidth != 0)
631 /* sleep if needed, to honor bandwidth limits */
632 bandwidth_ctl_delay(wsize);
634 if (time(0) >= last_print_time + opt.o_report_int) {
635 last_print_time = time(0);
636 CT_TRACE("%%"LPU64" ", 100 * write_total / length);
637 he.length = write_total;
638 rc = llapi_hsm_action_progress(hcp, &he, length, 0);
640 /* Action has been canceled or something wrong
641 * is happening. Stop copying data. */
642 CT_ERROR(rc, "progress ioctl for copy"
643 " '%s'->'%s' failed", src, dst);
652 * truncate restored file
653 * size is taken from the archive this is done to support
654 * restore after a force release which leaves the file with the
655 * wrong size (can big bigger than the new size)
657 if ((hai->hai_action == HSMA_RESTORE) &&
658 (src_st.st_size < dst_st.st_size)) {
660 * make sure the file is on disk before reporting success.
662 rc = ftruncate(dst_fd, src_st.st_size);
665 CT_ERROR(rc, "cannot truncate '%s' to size %jd",
666 dst, (intmax_t)src_st.st_size);
677 /* Copy file attributes from file src to file dest */
678 static int ct_copy_attr(const char *src, const char *dst, int src_fd,
682 struct timeval times[2];
685 if (fstat(src_fd, &st) < 0) {
687 CT_ERROR(rc, "cannot stat '%s'", src);
691 times[0].tv_sec = st.st_atime;
692 times[0].tv_usec = 0;
693 times[1].tv_sec = st.st_mtime;
694 times[1].tv_usec = 0;
695 if (fchmod(dst_fd, st.st_mode) < 0 ||
696 fchown(dst_fd, st.st_uid, st.st_gid) < 0 ||
697 futimes(dst_fd, times) < 0) {
699 CT_ERROR(rc, "cannot set attributes of '%s'", src);
706 static int ct_copy_xattr(const char *src, const char *dst, int src_fd,
707 int dst_fd, bool is_restore)
709 char list[XATTR_LIST_MAX];
710 char value[XATTR_SIZE_MAX];
715 list_len = flistxattr(src_fd, list, sizeof(list));
720 while (name < list + list_len) {
721 rc = fgetxattr(src_fd, name, value, sizeof(value));
725 /* when we restore, we do not restore lustre xattr */
727 (strncmp(XATTR_TRUSTED_PREFIX, name,
728 sizeof(XATTR_TRUSTED_PREFIX) - 1) != 0)) {
729 rc = fsetxattr(dst_fd, name, value, rc, 0);
730 CT_TRACE("fsetxattr of '%s' on '%s' rc=%d (%s)",
731 name, dst, rc, strerror(errno));
732 /* lustre.* attrs aren't supported on other FS's */
733 if (rc < 0 && errno != EOPNOTSUPP) {
735 CT_ERROR(rc, "cannot set extended attribute"
741 name += strlen(name) + 1;
747 static int ct_path_lustre(char *buf, int sz, const char *mnt,
748 const lustre_fid *fid)
750 return snprintf(buf, sz, "%s/%s/fid/"DFID_NOBRACE, mnt,
751 dot_lustre_name, PFID(fid));
754 static int ct_path_archive(char *buf, int sz, const char *archive_dir,
755 const lustre_fid *fid)
757 return snprintf(buf, sz, "%s/%04x/%04x/%04x/%04x/%04x/%04x/"
758 DFID_NOBRACE, archive_dir,
759 (fid)->f_oid & 0xFFFF,
760 (fid)->f_oid >> 16 & 0xFFFF,
761 (unsigned int)((fid)->f_seq & 0xFFFF),
762 (unsigned int)((fid)->f_seq >> 16 & 0xFFFF),
763 (unsigned int)((fid)->f_seq >> 32 & 0xFFFF),
764 (unsigned int)((fid)->f_seq >> 48 & 0xFFFF),
768 static bool ct_is_retryable(int err)
770 return err == -ETIMEDOUT;
773 static int ct_begin_restore(struct hsm_copyaction_private **phcp,
774 const struct hsm_action_item *hai,
775 int mdt_index, int open_flags)
780 rc = llapi_hsm_action_begin(phcp, ctdata, hai, mdt_index, open_flags,
783 ct_path_lustre(src, sizeof(src), opt.o_mnt, &hai->hai_fid);
784 CT_ERROR(rc, "llapi_hsm_action_begin() on '%s' failed", src);
790 static int ct_begin(struct hsm_copyaction_private **phcp,
791 const struct hsm_action_item *hai)
793 /* Restore takes specific parameters. Call the same function w/ default
794 * values for all other operations. */
795 return ct_begin_restore(phcp, hai, -1, 0);
798 static int ct_fini(struct hsm_copyaction_private **phcp,
799 const struct hsm_action_item *hai, int hp_flags, int ct_rc)
801 struct hsm_copyaction_private *hcp;
805 CT_TRACE("Action completed, notifying coordinator "
806 "cookie="LPX64", FID="DFID", hp_flags=%d err=%d",
807 hai->hai_cookie, PFID(&hai->hai_fid),
810 ct_path_lustre(lstr, sizeof(lstr), opt.o_mnt, &hai->hai_fid);
812 if (phcp == NULL || *phcp == NULL) {
813 rc = llapi_hsm_action_begin(&hcp, ctdata, hai, -1, 0, true);
815 CT_ERROR(rc, "llapi_hsm_action_begin() on '%s' failed",
822 rc = llapi_hsm_action_end(phcp, &hai->hai_extent, hp_flags, abs(ct_rc));
823 if (rc == -ECANCELED)
824 CT_ERROR(rc, "completed action on '%s' has been canceled: "
825 "cookie="LPX64", FID="DFID, lstr, hai->hai_cookie,
826 PFID(&hai->hai_fid));
828 CT_ERROR(rc, "llapi_hsm_action_end() on '%s' failed", lstr);
830 CT_TRACE("llapi_hsm_action_end() on '%s' ok (rc=%d)",
836 static int ct_archive(const struct hsm_action_item *hai, const long hal_flags)
838 struct hsm_copyaction_private *hcp = NULL;
840 char dst[PATH_MAX] = "";
843 bool rename_needed = false;
849 rc = ct_begin(&hcp, hai);
853 /* we fill archive so:
855 * destination = lustre FID
857 ct_path_lustre(src, sizeof(src), opt.o_mnt, &hai->hai_dfid);
858 ct_path_archive(dst, sizeof(dst), opt.o_hsm_root, &hai->hai_fid);
859 if (hai->hai_extent.length == -1) {
860 /* whole file, write it to tmp location and atomically
861 * replace old archived file */
862 strlcat(dst, "_tmp", sizeof(dst));
863 /* we cannot rely on the same test because ct_copy_data()
864 * updates hai_extent.length */
865 rename_needed = true;
868 CT_TRACE("archiving '%s' to '%s'", src, dst);
875 rc = ct_mkdir_p(dst);
877 CT_ERROR(rc, "mkdir_p '%s' failed", dst);
881 src_fd = llapi_hsm_action_get_fd(hcp);
884 CT_ERROR(rc, "cannot open '%s' for read", src);
888 open_flags = O_WRONLY | O_NOFOLLOW | O_NONBLOCK;
889 /* If extent is specified, don't truncate an old archived copy */
890 open_flags |= ((hai->hai_extent.length == -1) ? O_TRUNC : 0) | O_CREAT;
892 dst_fd = open(dst, open_flags, FILE_PERM);
895 CT_ERROR(rc, "cannot open '%s' for write", dst);
899 /* saving stripe is not critical */
900 rc = ct_save_stripe(src_fd, src, dst);
902 CT_ERROR(rc, "cannot save file striping info of '%s' in '%s'",
905 rc = ct_copy_data(hcp, src, dst, src_fd, dst_fd, hai, hal_flags);
907 CT_ERROR(rc, "data copy failed from '%s' to '%s'", src, dst);
914 CT_ERROR(rc, "cannot flush '%s' archive file '%s'", src, dst);
918 CT_TRACE("data archiving for '%s' to '%s' done", src, dst);
920 /* attrs will remain on the MDS; no need to copy them, except possibly
921 for disaster recovery */
922 if (opt.o_copy_attrs) {
923 rc = ct_copy_attr(src, dst, src_fd, dst_fd);
925 CT_ERROR(rc, "cannot copy attr of '%s' to '%s'",
929 CT_TRACE("attr file for '%s' saved to archive '%s'",
933 /* xattrs will remain on the MDS; no need to copy them, except possibly
934 for disaster recovery */
935 if (opt.o_copy_xattrs) {
936 rc = ct_copy_xattr(src, dst, src_fd, dst_fd, false);
938 CT_ERROR(rc, "cannot copy xattr of '%s' to '%s'",
940 rcf = rcf ? rcf : rc;
942 CT_TRACE("xattr file for '%s' saved to archive '%s'",
946 if (rename_needed == true) {
947 char tmp_src[PATH_MAX];
948 char tmp_dst[PATH_MAX];
950 /* atomically replace old archived file */
951 ct_path_archive(src, sizeof(src), opt.o_hsm_root,
953 rc = rename(dst, src);
956 CT_ERROR(rc, "cannot rename '%s' to '%s'", dst, src);
959 /* rename lov file */
960 snprintf(tmp_src, sizeof(tmp_src), "%s.lov", src);
961 snprintf(tmp_dst, sizeof(tmp_dst), "%s.lov", dst);
962 rc = rename(tmp_dst, tmp_src);
964 CT_ERROR(errno, "cannot rename '%s' to '%s'",
968 if (opt.o_shadow_tree) {
969 /* Create a namespace of softlinks that shadows the original
970 * Lustre namespace. This will only be current at
971 * time-of-archive (won't follow renames).
972 * WARNING: release won't kill these links; a manual
973 * cleanup of dead links would be required.
976 long long recno = -1;
982 sprintf(buf, DFID, PFID(&hai->hai_fid));
983 sprintf(src, "%s/shadow/", opt.o_hsm_root);
985 ptr = opt.o_hsm_root;
987 (*ptr++ == '/') ? depth-- : 0;
989 rc = llapi_fid2path(opt.o_mnt, buf, src + strlen(src),
990 sizeof(src) - strlen(src), &recno, &linkno);
992 CT_ERROR(rc, "cannot get FID of '%s'", buf);
993 rcf = rcf ? rcf : rc;
997 /* Figure out how many parent dirs to symlink back */
1000 (*ptr++ == '/') ? depth++ : 0;
1005 ct_path_archive(dst, sizeof(dst), buf, &hai->hai_fid);
1007 if (ct_mkdir_p(src)) {
1008 CT_ERROR(errno, "mkdir_p '%s' failed", src);
1009 rcf = rcf ? rcf : -errno;
1012 /* symlink already exists ? */
1013 sz = readlink(src, buf, sizeof(buf));
1014 /* detect truncation */
1015 if (sz == sizeof(buf)) {
1016 rcf = rcf ? rcf : -E2BIG;
1017 CT_ERROR(rcf, "readlink '%s' truncated", src);
1022 if (sz == 0 || strncmp(buf, dst, sz) != 0) {
1023 if (unlink(src) && errno != ENOENT) {
1025 "cannot unlink symlink '%s'",
1027 rcf = rcf ? rcf : -errno;
1029 /* unlink old symlink done */
1030 CT_TRACE("remove old symlink '%s' pointing"
1031 " to '%s'", src, buf);
1034 /* symlink already ok */
1035 CT_TRACE("symlink '%s' already pointing"
1036 " to '%s'", src, dst);
1041 if (symlink(dst, src)) {
1042 CT_ERROR(errno, "cannot symlink '%s' to '%s'",
1044 rcf = rcf ? rcf : -errno;
1047 CT_TRACE("symlink '%s' to '%s' done", src, dst);
1059 if (ct_is_retryable(rc))
1060 hp_flags |= HP_FLAG_RETRY;
1071 rc = ct_fini(&hcp, hai, hp_flags, rcf);
1076 static int ct_restore(const struct hsm_action_item *hai, const long hal_flags)
1078 struct hsm_copyaction_private *hcp = NULL;
1081 char lov_buf[XATTR_SIZE_MAX];
1082 size_t lov_size = sizeof(lov_buf);
1087 int mdt_index = -1; /* Not implemented */
1091 /* we fill lustre so:
1092 * source = lustre FID in the backend
1093 * destination = data FID = volatile file
1096 /* build backend file name from released file FID */
1097 ct_path_archive(src, sizeof(src), opt.o_hsm_root, &hai->hai_fid);
1099 /* restore loads and sets the LOVEA w/o interpreting it to avoid
1100 * dependency on the structure format. */
1101 rc = ct_load_stripe(src, lov_buf, &lov_size);
1103 CT_WARN("cannot get stripe rules for '%s' (%s), use default",
1104 src, strerror(-rc));
1107 open_flags |= O_LOV_DELAY_CREATE;
1111 rc = ct_begin_restore(&hcp, hai, mdt_index, open_flags);
1115 /* get the FID of the volatile file */
1116 rc = llapi_hsm_action_get_dfid(hcp, &dfid);
1118 CT_ERROR(rc, "restoring "DFID
1119 ", cannot get FID of created volatile file",
1120 PFID(&hai->hai_fid));
1124 /* build volatile "file name", for messages */
1125 snprintf(dst, sizeof(dst), "{VOLATILE}="DFID, PFID(&dfid));
1127 CT_TRACE("restoring data from '%s' to '%s'", src, dst);
1129 if (opt.o_dry_run) {
1134 src_fd = open(src, O_RDONLY | O_NOATIME | O_NONBLOCK | O_NOFOLLOW);
1137 CT_ERROR(rc, "cannot open '%s' for read", src);
1141 dst_fd = llapi_hsm_action_get_fd(hcp);
1144 /* the layout cannot be allocated through .fid so we have to
1145 * restore a layout */
1146 rc = ct_restore_stripe(src, dst, dst_fd, lov_buf, lov_size);
1148 CT_ERROR(rc, "cannot restore file striping info"
1149 " for '%s' from '%s'", dst, src);
1155 rc = ct_copy_data(hcp, src, dst, src_fd, dst_fd, hai, hal_flags);
1157 CT_ERROR(rc, "cannot copy data from '%s' to '%s'",
1160 if (ct_is_retryable(rc))
1161 hp_flags |= HP_FLAG_RETRY;
1165 CT_TRACE("data restore from '%s' to '%s' done", src, dst);
1168 rc = ct_fini(&hcp, hai, hp_flags, rc);
1170 /* object swaping is done by cdt at copy end, so close of volatile file
1171 * cannot be done before */
1181 static int ct_remove(const struct hsm_action_item *hai, const long hal_flags)
1183 struct hsm_copyaction_private *hcp = NULL;
1187 rc = ct_begin(&hcp, hai);
1191 ct_path_archive(dst, sizeof(dst), opt.o_hsm_root, &hai->hai_fid);
1193 CT_TRACE("removing file '%s'", dst);
1195 if (opt.o_dry_run) {
1203 CT_ERROR(rc, "cannot unlink '%s'", dst);
1208 strlcat(dst, ".lov", sizeof(dst));
1212 CT_ERROR(rc, "cannot unlink '%s'", dst);
1218 rc = ct_fini(&hcp, hai, 0, rc);
1223 static int ct_process_item(struct hsm_action_item *hai, const long hal_flags)
1227 if (opt.o_verbose >= LLAPI_MSG_INFO || opt.o_dry_run) {
1228 /* Print the original path */
1230 char path[PATH_MAX];
1231 long long recno = -1;
1234 sprintf(fid, DFID, PFID(&hai->hai_fid));
1235 CT_TRACE("'%s' action %s reclen %d, cookie="LPX64,
1236 fid, hsm_copytool_action2name(hai->hai_action),
1237 hai->hai_len, hai->hai_cookie);
1238 rc = llapi_fid2path(opt.o_mnt, fid, path,
1239 sizeof(path), &recno, &linkno);
1241 CT_ERROR(rc, "cannot get path of FID %s", fid);
1243 CT_TRACE("processing file '%s'", path);
1246 switch (hai->hai_action) {
1247 /* set err_major, minor inside these functions */
1249 rc = ct_archive(hai, hal_flags);
1252 rc = ct_restore(hai, hal_flags);
1255 rc = ct_remove(hai, hal_flags);
1258 CT_TRACE("cancel not implemented for file system '%s'",
1260 /* Don't report progress to coordinator for this cookie:
1261 * the copy function will get ECANCELED when reporting
1268 CT_ERROR(rc, "unknown action %d, on '%s'", hai->hai_action,
1271 ct_fini(NULL, hai, 0, rc);
1279 struct hsm_action_item *hai;
1282 static void *ct_thread(void *data)
1284 struct ct_th_data *cttd = data;
1287 rc = ct_process_item(cttd->hai, cttd->hal_flags);
1291 pthread_exit((void *)(intptr_t)rc);
1294 static int ct_process_item_async(const struct hsm_action_item *hai,
1297 pthread_attr_t attr;
1299 struct ct_th_data *data;
1302 data = malloc(sizeof(*data));
1306 data->hai = malloc(hai->hai_len);
1307 if (data->hai == NULL) {
1312 memcpy(data->hai, hai, hai->hai_len);
1313 data->hal_flags = hal_flags;
1315 rc = pthread_attr_init(&attr);
1317 CT_ERROR(rc, "pthread_attr_init failed for '%s' service",
1324 pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
1326 rc = pthread_create(&thread, &attr, ct_thread, data);
1328 CT_ERROR(rc, "cannot create thread for '%s' service",
1331 pthread_attr_destroy(&attr);
1335 static int ct_import_one(const char *src, const char *dst)
1337 char newarc[PATH_MAX];
1342 CT_TRACE("importing '%s' from '%s'", dst, src);
1344 if (stat(src, &st) < 0) {
1346 CT_ERROR(rc, "cannot stat '%s'", src);
1353 rc = llapi_hsm_import(dst,
1354 opt.o_archive_cnt ? opt.o_archive_id[0] : 0,
1355 &st, 0, 0, 0, 0, NULL, &fid);
1357 CT_ERROR(rc, "cannot import '%s' from '%s'", dst, src);
1361 ct_path_archive(newarc, sizeof(newarc), opt.o_hsm_root, &fid);
1363 rc = ct_mkdir_p(newarc);
1365 CT_ERROR(rc, "mkdir_p '%s' failed", newarc);
1371 /* Lots of choices now: mv, ln, ln -s ? */
1372 rc = link(src, newarc); /* hardlink */
1375 CT_ERROR(rc, "cannot link '%s' to '%s'", newarc, src);
1379 CT_TRACE("imported '%s' from '%s'=='%s'", dst, newarc, src);
1384 static char *path_concat(const char *dirname, const char *basename)
1389 rc = asprintf(&result, "%s/%s", dirname, basename);
1396 static int ct_import_fid(const lustre_fid *import_fid)
1398 char fid_path[PATH_MAX];
1401 ct_path_lustre(fid_path, sizeof(fid_path), opt.o_mnt, import_fid);
1402 rc = access(fid_path, F_OK);
1403 if (rc == 0 || errno != ENOENT) {
1404 rc = (errno == 0) ? -EEXIST : -errno;
1405 CT_ERROR(rc, "cannot import '"DFID"'", PFID(import_fid));
1409 ct_path_archive(fid_path, sizeof(fid_path), opt.o_hsm_root,
1412 CT_TRACE("Resolving "DFID" to %s", PFID(import_fid), fid_path);
1414 return ct_import_one(fid_path, opt.o_dst);
1417 static int ct_import_recurse(const char *relpath)
1420 struct dirent ent, *cookie = NULL;
1421 char *srcpath, *newpath;
1422 lustre_fid import_fid;
1425 if (relpath == NULL)
1428 /* Is relpath a FID? In which case SFID should expand to three
1430 rc = sscanf(relpath, SFID, RFID(&import_fid));
1432 return ct_import_fid(&import_fid);
1434 srcpath = path_concat(opt.o_hsm_root, relpath);
1435 if (srcpath == NULL) {
1440 dir = opendir(srcpath);
1442 /* Not a dir, or error */
1443 if (errno == ENOTDIR) {
1444 /* Single regular file case, treat o_dst as absolute
1446 rc = ct_import_one(srcpath, opt.o_dst);
1449 CT_ERROR(rc, "cannot opendir '%s'", srcpath);
1458 rc = readdir_r(dir, &ent, &cookie);
1461 CT_ERROR(rc, "cannot readdir_r '%s'", relpath);
1464 } else if ((rc == 0) && (cookie == NULL)) {
1465 /* end of directory */
1469 if (!strcmp(ent.d_name, ".") ||
1470 !strcmp(ent.d_name, ".."))
1473 /* New relative path */
1474 newpath = path_concat(relpath, ent.d_name);
1475 if (newpath == NULL) {
1481 if (ent.d_type == DT_DIR) {
1482 rc = ct_import_recurse(newpath);
1487 sprintf(src, "%s/%s", opt.o_hsm_root, newpath);
1488 sprintf(dst, "%s/%s", opt.o_dst, newpath);
1489 /* Make the target dir in the Lustre fs */
1490 rc = ct_mkdir_p(dst);
1492 /* Import the file */
1493 rc = ct_import_one(src, dst);
1495 CT_ERROR(rc, "ct_mkdir_p '%s' failed", dst);
1501 CT_ERROR(rc, "cannot import '%s'", newpath);
1502 if (err_major && opt.o_abort_on_error) {
1516 static int ct_rebind_one(const lustre_fid *old_fid, const lustre_fid *new_fid)
1522 CT_TRACE("rebind "DFID" to "DFID, PFID(old_fid), PFID(new_fid));
1524 ct_path_archive(src, sizeof(src), opt.o_hsm_root, old_fid);
1525 ct_path_archive(dst, sizeof(dst), opt.o_hsm_root, new_fid);
1527 if (!opt.o_dry_run) {
1529 if (rename(src, dst)) {
1531 CT_ERROR(rc, "cannot rename '%s' to '%s'", src, dst);
1534 /* rename lov file */
1535 strlcat(src, ".lov", sizeof(src));
1536 strlcat(dst, ".lov", sizeof(dst));
1537 if (rename(src, dst))
1538 CT_ERROR(errno, "cannot rename '%s' to '%s'", src, dst);
1544 static bool fid_is_file(lustre_fid *fid)
1546 return fid_is_norm(fid) || fid_is_igif(fid);
1549 static bool should_ignore_line(const char *line)
1553 for (i = 0; line[i] != '\0'; i++) {
1554 if (isspace(line[i]))
1556 else if (line[i] == '#')
1565 static int ct_rebind_list(const char *list)
1571 size_t line_size = 0;
1572 unsigned int nl = 0;
1573 unsigned int ok = 0;
1575 filp = fopen(list, "r");
1578 CT_ERROR(rc, "cannot open '%s'", list);
1582 /* each line consists of 2 FID */
1583 while ((r = getline(&line, &line_size, filp)) != -1) {
1587 /* Ignore empty and commented out ('#...') lines. */
1588 if (should_ignore_line(line))
1593 rc = sscanf(line, SFID" "SFID, RFID(&old_fid), RFID(&new_fid));
1594 if (rc != 6 || !fid_is_file(&old_fid) ||
1595 !fid_is_file(&new_fid)) {
1597 "'%s' FID expected near '%s', line %u",
1603 if (ct_rebind_one(&old_fid, &new_fid))
1614 /* return 0 if all rebinds were sucessful */
1615 CT_TRACE("%u lines read from '%s', %u rebind successful", nl, list, ok);
1617 return ok == nl ? 0 : -1;
1620 static int ct_rebind(void)
1628 if (sscanf(opt.o_src, SFID, RFID(&old_fid)) != 3 ||
1629 !fid_is_file(&old_fid)) {
1631 CT_ERROR(rc, "'%s' invalid FID format", opt.o_src);
1635 if (sscanf(opt.o_dst, SFID, RFID(&new_fid)) != 3 ||
1636 !fid_is_file(&new_fid)) {
1638 CT_ERROR(rc, "'%s' invalid FID format", opt.o_dst);
1642 rc = ct_rebind_one(&old_fid, &new_fid);
1647 /* o_src is a list file */
1648 rc = ct_rebind_list(opt.o_src);
1653 static int ct_dir_level_max(const char *dirpath, __u16 *sub_seqmax)
1658 struct dirent ent, *cookie = NULL;
1662 dir = opendir(dirpath);
1665 CT_ERROR(rc, "cannot open directory '%s'", opt.o_hsm_root);
1669 while ((rc = readdir_r(dir, &ent, &cookie)) == 0) {
1671 /* end of directory.
1672 * rc is 0 and seqmax contains the max value. */
1675 if (!strcmp(ent.d_name, ".") || !strcmp(ent.d_name, ".."))
1678 if (sscanf(ent.d_name, "%hx", &sub_seq) != 1) {
1679 CT_TRACE("'%s' has an unexpected dirname format, "
1680 "skip entry", ent.d_name);
1683 if (sub_seq > *sub_seqmax)
1684 *sub_seqmax = sub_seq;
1687 CT_ERROR(rc, "cannot readdir_r '%s'", dirpath);
1694 static int ct_max_sequence(void)
1697 char path[PATH_MAX];
1701 strlcpy(path, opt.o_hsm_root, sizeof(path));
1702 /* FID sequence is stored in top-level directory names:
1703 * hsm_root/16bits (high weight)/16 bits/16 bits/16 bits (low weight).
1705 for (i = 0; i < 4; i++) {
1708 rc = ct_dir_level_max(path, &subseq);
1711 seq |= ((__u64)subseq << ((3 - i) * 16));
1712 path_len = strlen(path);
1713 rc = snprintf(path + path_len, sizeof(path) - path_len,
1715 if (rc >= (sizeof(path) - path_len))
1717 path[sizeof(path) - 1] = '\0';
1720 printf("max_sequence: "LPX64"\n", seq);
1725 static void handler(int signal)
1727 psignal(signal, "exiting");
1728 /* If we don't clean up upon interrupt, umount thinks there's a ref
1729 * and doesn't remove us from mtab (EINPROGRESS). The lustre client
1730 * does successfully unmount and the mount is actually gone, but the
1731 * mtab entry remains. So this just makes mtab happier. */
1732 llapi_hsm_copytool_unregister(&ctdata);
1736 /* Daemon waits for messages from the kernel; run it in the background. */
1737 static int ct_run(void)
1741 if (opt.o_daemonize) {
1745 CT_ERROR(rc, "cannot daemonize");
1750 setbuf(stdout, NULL);
1752 if (opt.o_event_fifo != NULL) {
1753 rc = llapi_hsm_register_event_fifo(opt.o_event_fifo);
1755 CT_ERROR(rc, "failed to register event fifo");
1758 llapi_error_callback_set(llapi_hsm_log_error);
1761 rc = llapi_hsm_copytool_register(&ctdata, opt.o_mnt, 0,
1762 opt.o_archive_cnt, opt.o_archive_id);
1764 CT_ERROR(rc, "cannot start copytool interface");
1768 signal(SIGINT, handler);
1769 signal(SIGTERM, handler);
1772 struct hsm_action_list *hal;
1773 struct hsm_action_item *hai;
1777 CT_TRACE("waiting for message from kernel");
1779 rc = llapi_hsm_copytool_recv(ctdata, &hal, &msgsize);
1780 if (rc == -ESHUTDOWN) {
1781 CT_TRACE("shutting down");
1783 } else if (rc == -EAGAIN) {
1784 continue; /* msg not for us */
1785 } else if (rc < 0) {
1786 CT_WARN("cannot receive action list: %s",
1789 if (opt.o_abort_on_error)
1795 CT_TRACE("copytool fs=%s archive#=%d item_count=%d",
1796 hal->hal_fsname, hal->hal_archive_id, hal->hal_count);
1798 if (strcmp(hal->hal_fsname, fs_name) != 0) {
1800 CT_ERROR(rc, "'%s' invalid fs name, expecting: %s",
1801 hal->hal_fsname, fs_name);
1803 if (opt.o_abort_on_error)
1809 hai = hai_first(hal);
1810 while (++i <= hal->hal_count) {
1811 if ((char *)hai - (char *)hal > msgsize) {
1814 "'%s' item %d past end of message!",
1819 rc = ct_process_item_async(hai, hal->hal_flags);
1821 CT_ERROR(rc, "'%s' item %d process",
1823 if (opt.o_abort_on_error && err_major)
1825 hai = hai_next(hai);
1828 if (opt.o_abort_on_error && err_major)
1832 llapi_hsm_copytool_unregister(&ctdata);
1833 if (opt.o_event_fifo != NULL)
1834 llapi_hsm_unregister_event_fifo(opt.o_event_fifo);
1839 static int ct_setup(void)
1843 /* set llapi message level */
1844 llapi_msg_set_level(opt.o_verbose);
1846 arc_fd = open(opt.o_hsm_root, O_RDONLY);
1849 CT_ERROR(rc, "cannot open archive at '%s'", opt.o_hsm_root);
1853 rc = llapi_search_fsname(opt.o_mnt, fs_name);
1855 CT_ERROR(rc, "cannot find a Lustre filesystem mounted at '%s'",
1863 static int ct_cleanup(void)
1870 if (close(arc_fd) < 0) {
1872 CT_ERROR(rc, "cannot close archive root directory");
1879 int main(int argc, char **argv)
1883 strlcpy(cmd_name, basename(argv[0]), sizeof(cmd_name));
1884 rc = ct_parseopts(argc, argv);
1886 CT_WARN("try '%s --help' for more information", cmd_name);
1894 switch (opt.o_action) {
1896 rc = ct_import_recurse(opt.o_src);
1902 rc = ct_max_sequence();
1909 if (opt.o_action != CA_MAXSEQ)
1910 CT_TRACE("process finished, errs: %d major, %d minor,"
1911 " rc=%d (%s)", err_major, err_minor, rc,