4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * (C) Copyright 2012 Commissariat a l'energie atomique et aux energies
9 * All rights reserved. This program and the accompanying materials
10 * are made available under the terms of the GNU Lesser General Public License
11 * (LGPL) version 2.1 or (at your discretion) any later version.
12 * (LGPL) version 2.1 accompanies this distribution, and is available at
13 * http://www.gnu.org/licenses/lgpl-2.1.html
15 * This library is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Lesser General Public License for more details.
23 * lustre/utils/liblustreapi_hsm.c
25 * lustreapi library for hsm calls
27 * Author: Aurelien Degremont <aurelien.degremont@cea.fr>
28 * Author: JC Lafoucriere <jacques-charles.lafoucriere@cea.fr>
29 * Author: Thomas Leibovici <thomas.leibovici@cea.fr>
30 * Author: Henri Doreau <henri.doreau@cea.fr>
37 #include <sys/ioctl.h>
44 #include <sys/types.h>
46 #include <sys/syscall.h>
50 #ifdef HAVE_LINUX_UNISTD_H
51 #include <linux/unistd.h>
56 #include <liblustre.h>
57 #include <lnet/lnetctl.h>
58 #include <lustre/lustreapi.h>
59 #include "lustreapi_internal.h"
61 #define OPEN_BY_FID_PATH dot_lustre_name"/fid"
63 /****** HSM Copytool API ********/
64 #define CT_PRIV_MAGIC 0xC0BE2001
65 struct hsm_copytool_private {
70 lustre_kernelcomm kuc;
74 #define CP_PRIV_MAGIC 0x19880429
75 struct hsm_copyaction_private {
78 const struct hsm_copytool_private *ct_priv;
83 #include <libcfs/libcfs.h>
85 enum ct_progress_type {
96 CT_ARCHIVE_START = HSMA_ARCHIVE,
97 CT_ARCHIVE_RUNNING = HSMA_ARCHIVE + CT_RUNNING,
98 CT_ARCHIVE_FINISH = HSMA_ARCHIVE + CT_FINISH,
99 CT_ARCHIVE_CANCEL = HSMA_ARCHIVE + CT_CANCEL,
100 CT_ARCHIVE_ERROR = HSMA_ARCHIVE + CT_ERROR,
101 CT_RESTORE_START = HSMA_RESTORE,
102 CT_RESTORE_RUNNING = HSMA_RESTORE + CT_RUNNING,
103 CT_RESTORE_FINISH = HSMA_RESTORE + CT_FINISH,
104 CT_RESTORE_CANCEL = HSMA_RESTORE + CT_CANCEL,
105 CT_RESTORE_ERROR = HSMA_RESTORE + CT_ERROR,
106 CT_REMOVE_START = HSMA_REMOVE,
107 CT_REMOVE_RUNNING = HSMA_REMOVE + CT_RUNNING,
108 CT_REMOVE_FINISH = HSMA_REMOVE + CT_FINISH,
109 CT_REMOVE_CANCEL = HSMA_REMOVE + CT_CANCEL,
110 CT_REMOVE_ERROR = HSMA_REMOVE + CT_ERROR,
114 /* initialized in llapi_hsm_register_event_fifo() */
115 int llapi_hsm_event_fd = -1;
117 static inline const char *llapi_hsm_ct_ev2str(int type)
124 case CT_ARCHIVE_START:
125 return "ARCHIVE_START";
126 case CT_ARCHIVE_RUNNING:
127 return "ARCHIVE_RUNNING";
128 case CT_ARCHIVE_FINISH:
129 return "ARCHIVE_FINISH";
130 case CT_ARCHIVE_CANCEL:
131 return "ARCHIVE_CANCEL";
132 case CT_ARCHIVE_ERROR:
133 return "ARCHIVE_ERROR";
134 case CT_RESTORE_START:
135 return "RESTORE_START";
136 case CT_RESTORE_RUNNING:
137 return "RESTORE_RUNNING";
138 case CT_RESTORE_FINISH:
139 return "RESTORE_FINISH";
140 case CT_RESTORE_CANCEL:
141 return "RESTORE_CANCEL";
142 case CT_RESTORE_ERROR:
143 return "RESTORE_ERROR";
144 case CT_REMOVE_START:
145 return "REMOVE_START";
146 case CT_REMOVE_RUNNING:
147 return "REMOVE_RUNNING";
148 case CT_REMOVE_FINISH:
149 return "REMOVE_FINISH";
150 case CT_REMOVE_CANCEL:
151 return "REMOVE_CANCEL";
152 case CT_REMOVE_ERROR:
153 return "REMOVE_ERROR";
155 llapi_err_noerrno(LLAPI_MSG_ERROR,
156 "Unknown event type: %d", type);
162 * Writes a JSON event to the monitor FIFO. Noop if no FIFO has been
165 * \param event A list of llapi_json_items comprising a
166 * single JSON-formatted event.
168 * \retval 0 on success.
169 * \retval -errno on error.
171 int llapi_hsm_write_json_event(struct llapi_json_item_list **event)
174 char time_string[40];
175 char json_buf[PIPE_BUF];
177 time_t event_time = time(0);
178 struct tm time_components;
179 struct llapi_json_item_list *json_items;
181 /* Noop unless the event fd was initialized */
182 if (llapi_hsm_event_fd < 0)
185 if (event == NULL || *event == NULL)
190 localtime_r(&event_time, &time_components);
192 if (strftime(time_string, sizeof(time_string), "%Y-%m-%d %T %z",
193 &time_components) == 0) {
195 llapi_error(LLAPI_MSG_ERROR, rc, "strftime() failed");
199 rc = llapi_json_add_item(&json_items, "event_time", LLAPI_JSON_STRING,
202 llapi_error(LLAPI_MSG_ERROR, -rc, "error in "
203 "llapi_json_add_item()");
207 buf_file = fmemopen(json_buf, sizeof(json_buf), "w");
208 if (buf_file == NULL)
211 rc = llapi_json_write_list(event, buf_file);
219 if (write(llapi_hsm_event_fd, json_buf, strlen(json_buf)) < 0) {
220 /* Ignore write failures due to missing reader. */
229 * Hook for llapi_hsm_copytool_register and llapi_hsm_copytool_unregister
230 * to generate JSON events suitable for consumption by a copytool
231 * monitoring process.
233 * \param priv Opaque private control structure.
234 * \param event_type The type of event (register or unregister).
236 * \retval 0 on success.
237 * \retval -errno on error.
239 int llapi_hsm_log_ct_registration(struct hsm_copytool_private **priv,
243 char agent_uuid[UUID_MAX];
244 struct hsm_copytool_private *ct;
245 struct llapi_json_item_list *json_items;
247 if (priv == NULL || *priv == NULL)
251 if (ct->magic != CT_PRIV_MAGIC)
254 if (event_type != CT_REGISTER && event_type != CT_UNREGISTER)
257 rc = llapi_json_init_list(&json_items);
261 rc = llapi_get_agent_uuid(ct->mnt, agent_uuid, sizeof(agent_uuid));
264 llapi_chomp_string(agent_uuid);
266 rc = llapi_json_add_item(&json_items, "uuid", LLAPI_JSON_STRING,
271 rc = llapi_json_add_item(&json_items, "mount_point", LLAPI_JSON_STRING,
276 rc = llapi_json_add_item(&json_items, "archive", LLAPI_JSON_INTEGER,
281 rc = llapi_json_add_item(&json_items, "event_type", LLAPI_JSON_STRING,
282 (char *)llapi_hsm_ct_ev2str(event_type));
286 rc = llapi_hsm_write_json_event(&json_items);
293 llapi_error(LLAPI_MSG_ERROR, rc, "error in "
294 "llapi_hsm_log_ct_registration()");
297 if (json_items != NULL)
298 llapi_json_destroy_list(&json_items);
304 * Given a copytool progress update, construct a JSON event suitable for
305 * consumption by a copytool monitoring process.
307 * Examples of various events generated here and written by
308 * llapi_hsm_write_json_event:
310 * Copytool registration and deregistration:
311 * {"event_time": "2014-02-26 14:58:01 -0500", "event_type": "REGISTER",
312 * "archive": 0, "mount_point": "/mnt/lustre",
313 * "uuid": "80379a60-1f8a-743f-daf2-307cde793ec2"}
314 * {"event_time": "2014-02-26 14:58:01 -0500", "event_type": "UNREGISTER",
315 * "archive": 0, "mount_point": "/mnt/lustre",
316 * "uuid": "80379a60-1f8a-743f-daf2-307cde793ec2"}
318 * An archive action, start to completion:
319 * {"event_time": "2014-02-26 14:50:13 -0500", "event_type": "ARCHIVE_START",
320 * "total_bytes": 0, "lustre_path": "d71.sanity-hsm/f71.sanity-hsm",
321 * "source_fid": "0x2000013a1:0x2:0x0", "data_fid": "0x2000013a1:0x2:0x0"}
322 * {"event_time": "2014-02-26 14:50:18 -0500", "event_type": "ARCHIVE_RUNNING",
323 * "current_bytes": 5242880, "total_bytes": 39000000,
324 * "lustre_path": "d71.sanity-hsm/f71.sanity-hsm",
325 * "source_fid": "0x2000013a1:0x2:0x0", "data_fid": "0x2000013a1:0x2:0x0"}
326 * {"event_time": "2014-02-26 14:50:50 -0500", "event_type": "ARCHIVE_FINISH",
327 * "source_fid": "0x2000013a1:0x2:0x0", "data_fid": "0x2000013a1:0x2:0x0"}
330 * {"event_time": "2014-02-26 14:50:13 -0500", "event_type": "LOGGED_MESSAGE",
332 * "message": "lhsmtool_posix[42]: copytool fs=lustre archive#=2 item_count=1"}
334 * \param hcp Opaque action handle returned by
335 * llapi_hsm_action_start.
336 * \param hai The hsm_action_item describing the request.
337 * \param progress_type The ct_progress_type describing the update.
338 * \param total The total expected bytes for the request.
339 * \param current The current copied byte count for the request.
341 * \retval 0 on success.
342 * \retval -errno on error.
344 int llapi_hsm_log_ct_progress(struct hsm_copyaction_private **phcp,
345 const struct hsm_action_item *hai, __u32 progress_type,
346 __u64 total, __u64 current)
350 long long recno = -1;
351 char lustre_path[PATH_MAX];
352 char strfid[FID_NOBRACE_LEN + 1];
353 struct hsm_copyaction_private *hcp;
354 struct llapi_json_item_list *json_items;
356 if (phcp == NULL || *phcp == NULL)
361 rc = llapi_json_init_list(&json_items);
365 snprintf(strfid, sizeof(strfid), DFID_NOBRACE, PFID(&hai->hai_dfid));
366 rc = llapi_json_add_item(&json_items, "data_fid",
367 LLAPI_JSON_STRING, strfid);
371 snprintf(strfid, sizeof(strfid), DFID_NOBRACE, PFID(&hai->hai_fid));
372 rc = llapi_json_add_item(&json_items, "source_fid",
373 LLAPI_JSON_STRING, strfid);
377 if (hcp->copy.hc_errval == ECANCELED) {
378 progress_type = CT_CANCEL;
382 if (hcp->copy.hc_errval != 0) {
383 progress_type = CT_ERROR;
385 rc = llapi_json_add_item(&json_items, "errno",
387 &hcp->copy.hc_errval);
391 rc = llapi_json_add_item(&json_items, "error",
393 strerror(hcp->copy.hc_errval));
400 /* lustre_path isn't available after a restore completes */
401 /* total_bytes isn't available after a restore or archive completes */
402 if (progress_type != CT_FINISH) {
403 rc = llapi_fid2path(hcp->ct_priv->mnt, strfid, lustre_path,
404 sizeof(lustre_path), &recno, &linkno);
408 rc = llapi_json_add_item(&json_items, "lustre_path",
409 LLAPI_JSON_STRING, lustre_path);
413 rc = llapi_json_add_item(&json_items, "total_bytes",
414 LLAPI_JSON_BIGNUM, &total);
419 if (progress_type == CT_RUNNING)
420 rc = llapi_json_add_item(&json_items, "current_bytes",
421 LLAPI_JSON_BIGNUM, ¤t);
426 rc = llapi_json_add_item(&json_items, "event_type", LLAPI_JSON_STRING,
427 (char *)llapi_hsm_ct_ev2str(hai->hai_action +
432 rc = llapi_hsm_write_json_event(&json_items);
439 llapi_error(LLAPI_MSG_ERROR, rc, "error in "
440 "llapi_hsm_log_ct_progress()");
443 if (json_items != NULL)
444 llapi_json_destroy_list(&json_items);
450 * Given a path to a FIFO, create a filehandle for nonblocking writes to it.
451 * Intended to be used for copytool monitoring processes that read an
452 * event stream from the FIFO. Events written in the absence of a reader
455 * \param path Path to monitor FIFO.
457 * \retval 0 on success.
458 * \retval -errno on error.
460 int llapi_hsm_register_event_fifo(char *path)
465 /* Create the FIFO if necessary. */
466 if ((mkfifo(path, 0644) < 0) && (errno != EEXIST)) {
467 llapi_error(LLAPI_MSG_ERROR, errno, "mkfifo(%s) failed", path);
470 if (errno == EEXIST) {
471 if (stat(path, &statbuf) < 0) {
472 llapi_error(LLAPI_MSG_ERROR, errno, "mkfifo(%s) failed",
476 if (!S_ISFIFO(statbuf.st_mode) ||
477 ((statbuf.st_mode & 0777) != 0644)) {
478 llapi_error(LLAPI_MSG_ERROR, errno, "%s exists but is "
479 "not a pipe or has a wrong mode", path);
484 /* Open the FIFO for read so that the subsequent open for write
485 * doesn't immediately fail. */
486 read_fd = open(path, O_RDONLY | O_NONBLOCK);
488 llapi_error(LLAPI_MSG_ERROR, errno,
489 "cannot open(%s) for read", path);
493 /* Open the FIFO for writes, but don't block on waiting
495 llapi_hsm_event_fd = open(path, O_WRONLY | O_NONBLOCK);
496 if (llapi_hsm_event_fd < 0) {
497 llapi_error(LLAPI_MSG_ERROR, errno,
498 "cannot open(%s) for write", path);
502 /* Now close the reader. An external monitoring process can
503 * now open the FIFO for reads. If no reader comes along the
504 * events are lost. NOTE: Only one reader at a time! */
507 /* Ignore SIGPIPEs -- can occur if the reader goes away. */
508 signal(SIGPIPE, SIG_IGN);
514 * Given a path to a FIFO, close its filehandle and delete the FIFO.
516 * \param path Path to monitor FIFO.
518 * \retval 0 on success.
519 * \retval -errno on error.
521 int llapi_hsm_unregister_event_fifo(char *path)
523 /* Noop unless the event fd was initialized */
524 if (llapi_hsm_event_fd < 0)
527 if (close(llapi_hsm_event_fd) < 0)
532 llapi_hsm_event_fd = -1;
538 * Custom logging callback to be used when a monitoring FIFO has been
539 * registered. Formats log entries as JSON events suitable for
540 * consumption by a copytool monitoring process.
542 * \param level The message loglevel.
543 * \param _rc The returncode associated with the message.
544 * \param fmt The message format string.
545 * \param args Arguments to be formatted by the format string.
549 void llapi_hsm_log_error(enum llapi_message_level level, int _rc,
550 const char *fmt, va_list args)
557 struct llapi_json_item_list *json_items;
559 /* Noop unless the event fd was initialized */
560 if (llapi_hsm_event_fd < 0)
563 rc = llapi_json_init_list(&json_items);
567 if ((level & LLAPI_MSG_NO_ERRNO) == 0) {
568 rc = llapi_json_add_item(&json_items, "errno",
574 rc = llapi_json_add_item(&json_items, "error",
581 va_copy(args2, args);
582 msg_len = vsnprintf(NULL, 0, fmt, args2) + 1;
585 msg = (char *) alloca(msg_len);
591 rc = vsnprintf(msg, msg_len, fmt, args);
595 rc = llapi_json_add_item(&json_items, "message",
601 rc = llapi_json_add_item(&json_items, "message",
603 "INTERNAL ERROR: message failed");
608 real_level = level & LLAPI_MSG_NO_ERRNO;
609 real_level = real_level > 0 ? level - LLAPI_MSG_NO_ERRNO : level;
611 rc = llapi_json_add_item(&json_items, "level", LLAPI_JSON_STRING,
612 (void *)llapi_msg_level2str(real_level));
616 rc = llapi_json_add_item(&json_items, "event_type", LLAPI_JSON_STRING,
621 rc = llapi_hsm_write_json_event(&json_items);
628 /* Write directly to stderr to avoid llapi_error, which now
629 * emits JSON event messages. */
630 fprintf(stderr, "\nFATAL ERROR IN llapi_hsm_log_error(): rc %d,", rc);
633 if (json_items != NULL)
634 llapi_json_destroy_list(&json_items);
639 /** Register a copytool
640 * \param[out] priv Opaque private control structure
641 * \param mnt Lustre filesystem mount point
642 * \param flags Open flags, currently unused (e.g. O_NONBLOCK)
643 * \param archive_count
644 * \param archives Which archive numbers this copytool is responsible for
646 int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
647 const char *mnt, int flags, int archive_count,
650 struct hsm_copytool_private *ct;
653 if (archive_count > 0 && archives == NULL) {
654 llapi_err_noerrno(LLAPI_MSG_ERROR,
655 "NULL archive numbers");
659 ct = calloc(1, sizeof(*ct));
663 ct->magic = CT_PRIV_MAGIC;
665 ct->open_by_fid_fd = -1;
666 ct->kuc.lk_rfd = LK_NOFD;
667 ct->kuc.lk_wfd = LK_NOFD;
669 ct->mnt = strdup(mnt);
670 if (ct->mnt == NULL) {
675 ct->mnt_fd = open(ct->mnt, O_RDONLY);
676 if (ct->mnt_fd < 0) {
681 ct->open_by_fid_fd = openat(ct->mnt_fd, OPEN_BY_FID_PATH, O_RDONLY);
682 if (ct->open_by_fid_fd < 0) {
687 /* no archives specified means "match all". */
689 for (rc = 0; rc < archive_count; rc++) {
690 if (archives[rc] > 8 * sizeof(ct->archives)) {
691 llapi_err_noerrno(LLAPI_MSG_ERROR,
692 "maximum of %zu archives supported",
693 8 * sizeof(ct->archives));
696 /* in the list we have a all archive wildcard
697 * so move to all archives mode
699 if (archives[rc] == 0) {
704 ct->archives |= (1 << (archives[rc] - 1));
707 rc = libcfs_ukuc_start(&ct->kuc, KUC_GRP_HSM);
711 /* Storing archive(s) in lk_data; see mdc_ioc_hsm_ct_start */
712 ct->kuc.lk_data = ct->archives;
713 rc = ioctl(ct->mnt_fd, LL_IOC_HSM_CT_START, &ct->kuc);
716 llapi_error(LLAPI_MSG_ERROR, rc,
717 "cannot start copytool on '%s'", mnt);
723 llapi_hsm_log_ct_registration(&ct, CT_REGISTER);
725 /* Only the kernel reference keeps the write side open */
726 close(ct->kuc.lk_wfd);
727 ct->kuc.lk_wfd = LK_NOFD;
735 /* cleanup the kuc channel */
736 libcfs_ukuc_stop(&ct->kuc);
739 if (!(ct->mnt_fd < 0))
742 if (!(ct->open_by_fid_fd < 0))
743 close(ct->open_by_fid_fd);
753 /** Deregister a copytool
754 * Note: under Linux, until llapi_hsm_copytool_unregister is called
755 * (or the program is killed), the libcfs module will be referenced
756 * and unremovable, even after Lustre services stop.
758 int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv)
760 struct hsm_copytool_private *ct;
762 if (priv == NULL || *priv == NULL)
766 if (ct->magic != CT_PRIV_MAGIC)
769 /* Tell the kernel to stop sending us messages */
770 ct->kuc.lk_flags = LK_FLG_STOP;
771 ioctl(ct->mnt_fd, LL_IOC_HSM_CT_START, &ct->kuc);
773 /* Shut down the kernelcomms */
774 libcfs_ukuc_stop(&ct->kuc);
776 llapi_hsm_log_ct_registration(&ct, CT_UNREGISTER);
778 close(ct->open_by_fid_fd);
787 /** Wait for the next hsm_action_list
788 * \param ct Opaque private control structure
789 * \param halh Action list handle, will be allocated here
790 * \param msgsize Number of bytes in the message, will be set here
791 * \return 0 valid message received; halh and msgsize are set
794 int llapi_hsm_copytool_recv(struct hsm_copytool_private *ct,
795 struct hsm_action_list **halh, int *msgsize)
797 struct kuc_hdr *kuch;
798 struct hsm_action_list *hal;
801 if (ct == NULL || ct->magic != CT_PRIV_MAGIC)
804 if (halh == NULL || msgsize == NULL)
807 kuch = malloc(HAL_MAXSIZE + sizeof(*kuch));
811 rc = libcfs_ukuc_msg_get(&ct->kuc, (char *)kuch,
812 HAL_MAXSIZE + sizeof(*kuch),
817 /* Handle generic messages */
818 if (kuch->kuc_transport == KUC_TRANSPORT_GENERIC &&
819 kuch->kuc_msgtype == KUC_MSG_SHUTDOWN) {
824 if (kuch->kuc_transport != KUC_TRANSPORT_HSM ||
825 kuch->kuc_msgtype != HMT_ACTION_LIST) {
826 llapi_err_noerrno(LLAPI_MSG_ERROR,
827 "Unknown HSM message type %d:%d\n",
828 kuch->kuc_transport, kuch->kuc_msgtype);
833 if (kuch->kuc_msglen < sizeof(*kuch) + sizeof(*hal)) {
834 llapi_err_noerrno(LLAPI_MSG_ERROR, "Short HSM message %d",
840 /* Our message is a hsm_action_list. Use pointer math to skip
841 * kuch_hdr and point directly to the message payload.
843 hal = (struct hsm_action_list *)(kuch + 1);
845 /* Check that we have registered for this archive #
846 * if 0 registered, we serve any archive */
848 ((1 << (hal->hal_archive_id - 1)) & ct->archives) == 0) {
849 llapi_err_noerrno(LLAPI_MSG_INFO,
850 "This copytool does not service archive #%d,"
851 " ignoring this request."
852 " Mask of served archive is 0x%.8X",
853 hal->hal_archive_id, ct->archives);
860 *msgsize = kuch->kuc_msglen - sizeof(*kuch);
870 /** Release the action list when done with it. */
871 void llapi_hsm_action_list_free(struct hsm_action_list **hal)
873 /* Reuse the llapi_changelog_free function */
874 llapi_changelog_free((struct changelog_ext_rec **)hal);
877 /** Get parent path from mount point and fid.
879 * \param mnt Filesystem root path.
880 * \param fid Object FID.
881 * \param parent Destination buffer.
882 * \param parent_len Destination buffer size.
883 * \return 0 on success.
885 static int fid_parent(const char *mnt, const lustre_fid *fid, char *parent,
890 long long recno = -1;
892 char strfid[FID_NOBRACE_LEN + 1];
895 snprintf(strfid, sizeof(strfid), DFID_NOBRACE, PFID(fid));
897 rc = llapi_fid2path(mnt, strfid, file, sizeof(file),
902 /* fid2path returns a relative path */
903 rc = snprintf(parent, parent_len, "%s/%s", mnt, file);
904 if (rc >= parent_len)
905 return -ENAMETOOLONG;
907 /* remove file name */
908 ptr = strrchr(parent, '/');
909 if (ptr == NULL || ptr == parent) {
919 static int ct_open_by_fid(const struct hsm_copytool_private *ct,
920 const struct lu_fid *fid, int open_flags)
922 char fid_name[FID_NOBRACE_LEN + 1];
924 snprintf(fid_name, sizeof(fid_name), DFID_NOBRACE, PFID(fid));
926 return openat(ct->open_by_fid_fd, fid_name, open_flags);
929 static int ct_stat_by_fid(const struct hsm_copytool_private *ct,
930 const struct lu_fid *fid,
933 char fid_name[FID_NOBRACE_LEN + 1];
935 snprintf(fid_name, sizeof(fid_name), DFID_NOBRACE, PFID(fid));
937 return fstatat(ct->open_by_fid_fd, fid_name, buf, 0);
940 /** Create the destination volatile file for a restore operation.
942 * \param hcp Private copyaction handle.
943 * \param mdt_index MDT index where to create the volatile file.
944 * \param flags Volatile file creation flags.
945 * \return 0 on success.
947 static int create_restore_volatile(struct hsm_copyaction_private *hcp,
948 int mdt_index, int open_flags)
952 char parent[PATH_MAX + 1];
953 const char *mnt = hcp->ct_priv->mnt;
954 struct hsm_action_item *hai = &hcp->copy.hc_hai;
956 rc = fid_parent(mnt, &hai->hai_fid, parent, sizeof(parent));
958 /* fid_parent() failed, try to keep on going */
959 llapi_error(LLAPI_MSG_ERROR, rc,
960 "cannot get parent path to restore "DFID" "
961 "using '%s'", PFID(&hai->hai_fid), mnt);
962 snprintf(parent, sizeof(parent), "%s", mnt);
965 fd = llapi_create_volatile_idx(parent, mdt_index, open_flags);
969 rc = fchown(fd, hcp->stat.st_uid, hcp->stat.st_gid);
973 rc = llapi_fd2fid(fd, &hai->hai_dfid);
988 /** Start processing an HSM action.
989 * Should be called by copytools just before starting handling a request.
990 * It could be skipped if copytool only want to directly report an error,
991 * \see llapi_hsm_action_end().
993 * \param hcp Opaque action handle to be passed to
994 * llapi_hsm_action_progress and llapi_hsm_action_end.
995 * \param ct Copytool handle acquired at registration.
996 * \param hai The hsm_action_item describing the request.
997 * \param restore_mdt_index On restore: MDT index where to create the volatile
998 * file. Use -1 for default.
999 * \param restore_open_flags On restore: volatile file creation mode. Use
1000 * O_LOV_DELAY_CREATE to manually set the LOVEA
1002 * \param is_error Whether this call is just to report an error.
1004 * \return 0 on success.
1006 int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
1007 const struct hsm_copytool_private *ct,
1008 const struct hsm_action_item *hai,
1009 int restore_mdt_index, int restore_open_flags,
1012 struct hsm_copyaction_private *hcp;
1015 hcp = calloc(1, sizeof(*hcp));
1021 hcp->copy.hc_hai = *hai;
1022 hcp->copy.hc_hai.hai_len = sizeof(*hai);
1027 if (hai->hai_action == HSMA_RESTORE) {
1028 rc = ct_stat_by_fid(hcp->ct_priv, &hai->hai_fid, &hcp->stat);
1032 rc = create_restore_volatile(hcp, restore_mdt_index,
1033 restore_open_flags);
1038 rc = ioctl(ct->mnt_fd, LL_IOC_HSM_COPY_START, &hcp->copy);
1044 llapi_hsm_log_ct_progress(&hcp, hai, CT_START, 0, 0);
1047 hcp->magic = CP_PRIV_MAGIC;
1052 if (!(hcp->data_fd < 0))
1053 close(hcp->data_fd);
1060 /** Terminate an HSM action processing.
1061 * Should be called by copytools just having finished handling the request.
1062 * \param hdl[in,out] Handle returned by llapi_hsm_action_start.
1063 * \param he[in] The final range of copied data (for copy actions).
1064 * \param errval[in] The status code of the operation.
1065 * \param flags[in] The flags about the termination status (HP_FLAG_RETRY if
1066 * the error is retryable).
1068 * \return 0 on success.
1070 int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
1071 const struct hsm_extent *he, int hp_flags, int errval)
1073 struct hsm_copyaction_private *hcp;
1074 struct hsm_action_item *hai;
1077 if (phcp == NULL || *phcp == NULL || he == NULL)
1082 if (hcp->magic != CP_PRIV_MAGIC)
1085 hai = &hcp->copy.hc_hai;
1087 if (hai->hai_action == HSMA_RESTORE && errval == 0) {
1088 struct timeval tv[2];
1090 /* Set {a,m}time of volatile file to that of original. */
1091 tv[0].tv_sec = hcp->stat.st_atime;
1093 tv[1].tv_sec = hcp->stat.st_mtime;
1095 if (futimes(hcp->data_fd, tv) < 0) {
1100 rc = fsync(hcp->data_fd);
1108 /* In some cases, like restore, 2 FIDs are used.
1109 * Set the right FID to use here. */
1110 if (hai->hai_action == HSMA_ARCHIVE || hai->hai_action == HSMA_RESTORE)
1111 hai->hai_fid = hai->hai_dfid;
1113 /* Fill the last missing data that will be needed by
1114 * kernel to send a hsm_progress. */
1115 hcp->copy.hc_flags = hp_flags;
1116 hcp->copy.hc_errval = abs(errval);
1118 hcp->copy.hc_hai.hai_extent = *he;
1120 rc = ioctl(hcp->ct_priv->mnt_fd, LL_IOC_HSM_COPY_END, &hcp->copy);
1126 llapi_hsm_log_ct_progress(&hcp, hai, CT_FINISH, 0, 0);
1129 if (!(hcp->data_fd < 0))
1130 close(hcp->data_fd);
1138 /** Notify a progress in processing an HSM action.
1139 * \param hdl[in,out] handle returned by llapi_hsm_action_start.
1140 * \param he[in] the range of copied data (for copy actions).
1141 * \param total[in] the expected total of copied data (for copy actions).
1142 * \param hp_flags[in] HSM progress flags.
1143 * \return 0 on success.
1145 int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
1146 const struct hsm_extent *he, __u64 total,
1150 struct hsm_progress hp;
1151 struct hsm_action_item *hai;
1153 if (hcp == NULL || he == NULL)
1156 if (hcp->magic != CP_PRIV_MAGIC)
1159 hai = &hcp->copy.hc_hai;
1161 memset(&hp, 0, sizeof(hp));
1163 hp.hp_cookie = hai->hai_cookie;
1164 hp.hp_flags = hp_flags;
1166 /* Progress is made on the data fid */
1167 hp.hp_fid = hai->hai_dfid;
1170 rc = ioctl(hcp->ct_priv->mnt_fd, LL_IOC_HSM_PROGRESS, &hp);
1174 llapi_hsm_log_ct_progress(&hcp, hai, CT_RUNNING, total, he->length);
1179 /** Get the fid of object to be used for copying data.
1180 * @return error code if the action is not a copy operation.
1182 int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
1185 const struct hsm_action_item *hai = &hcp->copy.hc_hai;
1187 if (hcp->magic != CP_PRIV_MAGIC)
1190 if (hai->hai_action != HSMA_RESTORE && hai->hai_action != HSMA_ARCHIVE)
1193 *fid = hai->hai_dfid;
1199 * Get a file descriptor to be used for copying data. It's up to the
1200 * caller to close the FDs obtained from this function.
1202 * @retval a file descriptor on success.
1203 * @retval a negative error code on failure.
1205 int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp)
1207 const struct hsm_action_item *hai = &hcp->copy.hc_hai;
1209 if (hcp->magic != CP_PRIV_MAGIC)
1212 if (hai->hai_action == HSMA_ARCHIVE)
1213 return ct_open_by_fid(hcp->ct_priv, &hai->hai_dfid,
1214 O_RDONLY | O_NOATIME | O_NOFOLLOW | O_NONBLOCK);
1215 else if (hai->hai_action == HSMA_RESTORE)
1216 return dup(hcp->data_fd);
1222 * Import an existing hsm-archived file into Lustre.
1224 * Caller must access file by (returned) newfid value from now on.
1226 * \param dst path to Lustre destination (e.g. /mnt/lustre/my/file).
1227 * \param archive archive number.
1228 * \param st struct stat buffer containing file ownership, perm, etc.
1229 * \param stripe_* Striping options. Currently ignored, since the restore
1230 * operation will set the striping. In V2, this striping might
1232 * \param newfid[out] Filled with new Lustre fid.
1234 int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
1235 unsigned long long stripe_size, int stripe_offset,
1236 int stripe_count, int stripe_pattern, char *pool_name,
1239 struct hsm_user_import hui;
1243 if (stripe_pattern == 0)
1244 stripe_pattern = LOV_PATTERN_RAID0;
1246 /* Create a non-striped file */
1247 fd = llapi_file_open_pool(dst, O_CREAT | O_WRONLY, st->st_mode,
1248 stripe_size, stripe_offset, stripe_count,
1249 stripe_pattern | LOV_PATTERN_F_RELEASED,
1252 llapi_error(LLAPI_MSG_ERROR, -errno,
1253 "cannot create '%s' for import", dst);
1257 /* Get the new fid in Lustre. Caller needs to use this fid
1259 rc = llapi_fd2fid(fd, newfid);
1261 llapi_error(LLAPI_MSG_ERROR, rc,
1262 "cannot get fid of '%s' for import", dst);
1266 hui.hui_uid = st->st_uid;
1267 hui.hui_gid = st->st_gid;
1268 hui.hui_mode = st->st_mode;
1269 hui.hui_size = st->st_size;
1270 hui.hui_archive_id = archive;
1271 hui.hui_atime = st->st_atime;
1272 hui.hui_atime_ns = st->st_atim.tv_nsec;
1273 hui.hui_mtime = st->st_mtime;
1274 hui.hui_mtime_ns = st->st_mtim.tv_nsec;
1275 rc = ioctl(fd, LL_IOC_HSM_IMPORT, &hui);
1277 llapi_error(LLAPI_MSG_ERROR, rc, "cannot import '%s'", dst);
1291 * Return the current HSM states and HSM requests related to file pointed by \a
1294 * \param hus Should be allocated by caller. Will be filled with current file
1297 * \retval 0 on success.
1298 * \retval -errno on error.
1300 int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus)
1304 rc = ioctl(fd, LL_IOC_HSM_STATE_GET, hus);
1305 /* If error, save errno value */
1306 rc = rc ? -errno : 0;
1312 * Return the current HSM states and HSM requests related to file pointed by \a
1315 * see llapi_hsm_state_get_fd() for args use and return
1317 int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus)
1322 fd = open(path, O_RDONLY | O_NONBLOCK);
1326 rc = llapi_hsm_state_get_fd(fd, hus);
1333 * Set HSM states of file pointed by \a fd
1335 * Using the provided bitmasks, the current HSM states for this file will be
1336 * changed. \a archive_id could be used to change the archive number also. Set
1337 * it to 0 if you do not want to change it.
1339 * \param setmask Bitmask for flag to be set.
1340 * \param clearmask Bitmask for flag to be cleared.
1341 * \param archive_id Archive number identifier to use. 0 means no change.
1343 * \retval 0 on success.
1344 * \retval -errno on error.
1346 int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
1349 struct hsm_state_set hss;
1352 hss.hss_valid = HSS_SETMASK|HSS_CLEARMASK;
1353 hss.hss_setmask = setmask;
1354 hss.hss_clearmask = clearmask;
1355 /* Change archive_id if provided. We can only change
1356 * to set something different than 0. */
1357 if (archive_id > 0) {
1358 hss.hss_valid |= HSS_ARCHIVE_ID;
1359 hss.hss_archive_id = archive_id;
1361 rc = ioctl(fd, LL_IOC_HSM_STATE_SET, &hss);
1362 /* If error, save errno value */
1363 rc = rc ? -errno : 0;
1369 * Set HSM states of file pointed by \a path.
1371 * see llapi_hsm_state_set_fd() for args use and return
1373 int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
1379 fd = open(path, O_WRONLY | O_LOV_DELAY_CREATE | O_NONBLOCK);
1383 rc = llapi_hsm_state_set_fd(fd, setmask, clearmask, archive_id);
1390 * Return the current HSM request related to file pointed by \a path.
1392 * \param hca Should be allocated by caller. Will be filled with current file
1395 * \retval 0 on success.
1396 * \retval -errno on error.
1398 int llapi_hsm_current_action(const char *path, struct hsm_current_action *hca)
1403 fd = open(path, O_RDONLY | O_NONBLOCK);
1407 rc = ioctl(fd, LL_IOC_HSM_ACTION, hca);
1408 /* If error, save errno value */
1409 rc = rc ? -errno : 0;
1416 * Allocate a hsm_user_request with the specified carateristics.
1417 * This structure should be freed with free().
1419 * \return an allocated structure on success, NULL otherwise.
1421 struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
1426 len += sizeof(struct hsm_user_request);
1427 len += sizeof(struct hsm_user_item) * itemcount;
1430 return (struct hsm_user_request *)malloc(len);
1434 * Send a HSM request to Lustre, described in \param request.
1436 * \param path Fullpath to the file to operate on.
1437 * \param request The request, allocated with llapi_hsm_user_request_alloc().
1439 * \return 0 on success, an error code otherwise.
1441 int llapi_hsm_request(const char *path, const struct hsm_user_request *request)
1446 rc = get_root_path(WANT_FD, NULL, &fd, (char *)path, -1);
1450 rc = ioctl(fd, LL_IOC_HSM_REQUEST, request);
1451 /* If error, save errno value */
1452 rc = rc ? -errno : 0;