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 * Copyright (c) 2013, 2016, Intel Corporation.
11 * All rights reserved. This program and the accompanying materials
12 * are made available under the terms of the GNU Lesser General Public License
13 * (LGPL) version 2.1 or (at your discretion) any later version.
14 * (LGPL) version 2.1 accompanies this distribution, and is available at
15 * http://www.gnu.org/licenses/lgpl-2.1.html
17 * This library is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * Lesser General Public License for more details.
25 * lustre/utils/liblustreapi_hsm.c
27 * lustreapi library for hsm calls
29 * Author: Aurelien Degremont <aurelien.degremont@cea.fr>
30 * Author: JC Lafoucriere <jacques-charles.lafoucriere@cea.fr>
31 * Author: Thomas Leibovici <thomas.leibovici@cea.fr>
32 * Author: Henri Doreau <henri.doreau@cea.fr>
40 #include <sys/ioctl.h>
48 #include <sys/types.h>
51 #include <sys/syscall.h>
54 #ifdef HAVE_LINUX_UNISTD_H
55 #include <linux/unistd.h>
60 #include <linux/lnet/lnetctl.h>
61 #include <lustre/lustreapi.h>
62 #include "lustreapi_internal.h"
64 #define OPEN_BY_FID_PATH dot_lustre_name"/fid"
66 /****** HSM Copytool API ********/
67 #define CT_PRIV_MAGIC 0xC0BE2001
68 struct hsm_copytool_private {
74 struct lustre_kernelcomm kuc;
78 #define CP_PRIV_MAGIC 0x19880429
79 struct hsm_copyaction_private {
82 const struct hsm_copytool_private *ct_priv;
87 enum ct_progress_type {
98 CT_ARCHIVE_START = HSMA_ARCHIVE,
99 CT_ARCHIVE_RUNNING = HSMA_ARCHIVE + CT_RUNNING,
100 CT_ARCHIVE_FINISH = HSMA_ARCHIVE + CT_FINISH,
101 CT_ARCHIVE_CANCEL = HSMA_ARCHIVE + CT_CANCEL,
102 CT_ARCHIVE_ERROR = HSMA_ARCHIVE + CT_ERROR,
103 CT_RESTORE_START = HSMA_RESTORE,
104 CT_RESTORE_RUNNING = HSMA_RESTORE + CT_RUNNING,
105 CT_RESTORE_FINISH = HSMA_RESTORE + CT_FINISH,
106 CT_RESTORE_CANCEL = HSMA_RESTORE + CT_CANCEL,
107 CT_RESTORE_ERROR = HSMA_RESTORE + CT_ERROR,
108 CT_REMOVE_START = HSMA_REMOVE,
109 CT_REMOVE_RUNNING = HSMA_REMOVE + CT_RUNNING,
110 CT_REMOVE_FINISH = HSMA_REMOVE + CT_FINISH,
111 CT_REMOVE_CANCEL = HSMA_REMOVE + CT_CANCEL,
112 CT_REMOVE_ERROR = HSMA_REMOVE + CT_ERROR,
116 /* initialized in llapi_hsm_register_event_fifo() */
117 static int llapi_hsm_event_fd = -1;
118 static bool created_hsm_event_fifo;
120 static inline const char *llapi_hsm_ct_ev2str(int type)
127 case CT_ARCHIVE_START:
128 return "ARCHIVE_START";
129 case CT_ARCHIVE_RUNNING:
130 return "ARCHIVE_RUNNING";
131 case CT_ARCHIVE_FINISH:
132 return "ARCHIVE_FINISH";
133 case CT_ARCHIVE_CANCEL:
134 return "ARCHIVE_CANCEL";
135 case CT_ARCHIVE_ERROR:
136 return "ARCHIVE_ERROR";
137 case CT_RESTORE_START:
138 return "RESTORE_START";
139 case CT_RESTORE_RUNNING:
140 return "RESTORE_RUNNING";
141 case CT_RESTORE_FINISH:
142 return "RESTORE_FINISH";
143 case CT_RESTORE_CANCEL:
144 return "RESTORE_CANCEL";
145 case CT_RESTORE_ERROR:
146 return "RESTORE_ERROR";
147 case CT_REMOVE_START:
148 return "REMOVE_START";
149 case CT_REMOVE_RUNNING:
150 return "REMOVE_RUNNING";
151 case CT_REMOVE_FINISH:
152 return "REMOVE_FINISH";
153 case CT_REMOVE_CANCEL:
154 return "REMOVE_CANCEL";
155 case CT_REMOVE_ERROR:
156 return "REMOVE_ERROR";
158 llapi_err_noerrno(LLAPI_MSG_ERROR,
159 "Unknown event type: %d", type);
165 * Writes a JSON event to the monitor FIFO. Noop if no FIFO has been
168 * \param event A list of llapi_json_items comprising a
169 * single JSON-formatted event.
171 * \retval 0 on success.
172 * \retval -errno on error.
174 static int llapi_hsm_write_json_event(struct llapi_json_item_list **event)
177 char time_string[40];
178 char json_buf[PIPE_BUF];
180 time_t event_time = time(0);
181 struct tm time_components;
182 struct llapi_json_item_list *json_items;
184 /* Noop unless the event fd was initialized */
185 if (llapi_hsm_event_fd < 0)
188 if (event == NULL || *event == NULL)
193 localtime_r(&event_time, &time_components);
195 if (strftime(time_string, sizeof(time_string), "%Y-%m-%d %T %z",
196 &time_components) == 0) {
198 llapi_error(LLAPI_MSG_ERROR, rc, "strftime() failed");
202 rc = llapi_json_add_item(&json_items, "event_time", LLAPI_JSON_STRING,
205 llapi_error(LLAPI_MSG_ERROR, -rc, "error in "
206 "llapi_json_add_item()");
210 buf_file = fmemopen(json_buf, sizeof(json_buf), "w");
211 if (buf_file == NULL)
214 rc = llapi_json_write_list(event, buf_file);
222 if (write(llapi_hsm_event_fd, json_buf, strlen(json_buf)) < 0) {
223 /* Ignore write failures due to missing reader. */
232 * Hook for llapi_hsm_copytool_register and llapi_hsm_copytool_unregister
233 * to generate JSON events suitable for consumption by a copytool
234 * monitoring process.
236 * \param priv Opaque private control structure.
237 * \param event_type The type of event (register or unregister).
239 * \retval 0 on success.
240 * \retval -errno on error.
242 static int llapi_hsm_log_ct_registration(struct hsm_copytool_private **priv,
246 char agent_uuid[UUID_MAX];
247 struct hsm_copytool_private *ct;
248 struct llapi_json_item_list *json_items;
250 /* Noop unless the event fd was initialized */
251 if (llapi_hsm_event_fd < 0)
254 if (priv == NULL || *priv == NULL)
258 if (ct->magic != CT_PRIV_MAGIC)
261 if (event_type != CT_REGISTER && event_type != CT_UNREGISTER)
264 rc = llapi_json_init_list(&json_items);
268 rc = llapi_get_agent_uuid(ct->mnt, agent_uuid, sizeof(agent_uuid));
271 llapi_chomp_string(agent_uuid);
273 rc = llapi_json_add_item(&json_items, "uuid", LLAPI_JSON_STRING,
278 rc = llapi_json_add_item(&json_items, "mount_point", LLAPI_JSON_STRING,
283 rc = llapi_json_add_item(&json_items, "archive", LLAPI_JSON_INTEGER,
288 rc = llapi_json_add_item(&json_items, "event_type", LLAPI_JSON_STRING,
289 (char *)llapi_hsm_ct_ev2str(event_type));
293 rc = llapi_hsm_write_json_event(&json_items);
300 llapi_error(LLAPI_MSG_ERROR, rc, "error in "
301 "llapi_hsm_log_ct_registration()");
304 if (json_items != NULL)
305 llapi_json_destroy_list(&json_items);
311 * Given a copytool progress update, construct a JSON event suitable for
312 * consumption by a copytool monitoring process.
314 * Examples of various events generated here and written by
315 * llapi_hsm_write_json_event:
317 * Copytool registration and deregistration:
318 * {"event_time": "2014-02-26 14:58:01 -0500", "event_type": "REGISTER",
319 * "archive": 0, "mount_point": "/mnt/lustre",
320 * "uuid": "80379a60-1f8a-743f-daf2-307cde793ec2"}
321 * {"event_time": "2014-02-26 14:58:01 -0500", "event_type": "UNREGISTER",
322 * "archive": 0, "mount_point": "/mnt/lustre",
323 * "uuid": "80379a60-1f8a-743f-daf2-307cde793ec2"}
325 * An archive action, start to completion:
326 * {"event_time": "2014-02-26 14:50:13 -0500", "event_type": "ARCHIVE_START",
327 * "total_bytes": 0, "lustre_path": "d71.sanity-hsm/f71.sanity-hsm",
328 * "source_fid": "0x2000013a1:0x2:0x0", "data_fid": "0x2000013a1:0x2:0x0"}
329 * {"event_time": "2014-02-26 14:50:18 -0500", "event_type": "ARCHIVE_RUNNING",
330 * "current_bytes": 5242880, "total_bytes": 39000000,
331 * "lustre_path": "d71.sanity-hsm/f71.sanity-hsm",
332 * "source_fid": "0x2000013a1:0x2:0x0", "data_fid": "0x2000013a1:0x2:0x0"}
333 * {"event_time": "2014-02-26 14:50:50 -0500", "event_type": "ARCHIVE_FINISH",
334 * "source_fid": "0x2000013a1:0x2:0x0", "data_fid": "0x2000013a1:0x2:0x0"}
337 * {"event_time": "2014-02-26 14:50:13 -0500", "event_type": "LOGGED_MESSAGE",
339 * "message": "lhsmtool_posix[42]: copytool fs=lustre archive#=2 item_count=1"}
341 * \param hcp Opaque action handle returned by
342 * llapi_hsm_action_start.
343 * \param hai The hsm_action_item describing the request.
344 * \param progress_type The ct_progress_type describing the update.
345 * \param total The total expected bytes for the request.
346 * \param current The current copied byte count for the request.
348 * \retval 0 on success.
349 * \retval -errno on error.
351 static int llapi_hsm_log_ct_progress(struct hsm_copyaction_private **phcp,
352 const struct hsm_action_item *hai,
354 __u64 total, __u64 current)
358 long long recno = -1;
359 char lustre_path[PATH_MAX];
360 char strfid[FID_NOBRACE_LEN + 1];
361 struct hsm_copyaction_private *hcp;
362 struct llapi_json_item_list *json_items;
364 /* Noop unless the event fd was initialized */
365 if (llapi_hsm_event_fd < 0)
368 if (phcp == NULL || *phcp == NULL)
373 rc = llapi_json_init_list(&json_items);
377 snprintf(strfid, sizeof(strfid), DFID_NOBRACE, PFID(&hai->hai_dfid));
378 rc = llapi_json_add_item(&json_items, "data_fid",
379 LLAPI_JSON_STRING, strfid);
383 snprintf(strfid, sizeof(strfid), DFID_NOBRACE, PFID(&hai->hai_fid));
384 rc = llapi_json_add_item(&json_items, "source_fid",
385 LLAPI_JSON_STRING, strfid);
389 if (hcp->copy.hc_errval == ECANCELED) {
390 progress_type = CT_CANCEL;
394 if (hcp->copy.hc_errval != 0) {
395 progress_type = CT_ERROR;
397 rc = llapi_json_add_item(&json_items, "errno",
399 &hcp->copy.hc_errval);
403 rc = llapi_json_add_item(&json_items, "error",
405 strerror(hcp->copy.hc_errval));
412 /* lustre_path isn't available after a restore completes */
413 /* total_bytes isn't available after a restore or archive completes */
414 if (progress_type != CT_FINISH) {
415 rc = llapi_fid2path(hcp->ct_priv->mnt, strfid, lustre_path,
416 sizeof(lustre_path), &recno, &linkno);
420 rc = llapi_json_add_item(&json_items, "lustre_path",
421 LLAPI_JSON_STRING, lustre_path);
425 rc = llapi_json_add_item(&json_items, "total_bytes",
426 LLAPI_JSON_BIGNUM, &total);
431 if (progress_type == CT_RUNNING) {
432 rc = llapi_json_add_item(&json_items, "current_bytes",
433 LLAPI_JSON_BIGNUM, ¤t);
439 rc = llapi_json_add_item(&json_items, "event_type", LLAPI_JSON_STRING,
440 (char *)llapi_hsm_ct_ev2str(hai->hai_action +
445 rc = llapi_hsm_write_json_event(&json_items);
452 llapi_error(LLAPI_MSG_ERROR, rc, "error in "
453 "llapi_hsm_log_ct_progress()");
456 if (json_items != NULL)
457 llapi_json_destroy_list(&json_items);
463 * Given a path to a FIFO, create a filehandle for nonblocking writes to it.
464 * Intended to be used for copytool monitoring processes that read an
465 * event stream from the FIFO. Events written in the absence of a reader
468 * \param path Path to monitor FIFO.
470 * \retval 0 on success.
471 * \retval -errno on error.
473 int llapi_hsm_register_event_fifo(const char *path)
477 struct sigaction ignore_action;
480 /* Create the FIFO if necessary. */
481 if ((mkfifo(path, 0644) < 0) && (errno != EEXIST)) {
482 llapi_error(LLAPI_MSG_ERROR, errno, "mkfifo(%s) failed", path);
485 if (errno == EEXIST) {
486 if (stat(path, &statbuf) < 0) {
487 llapi_error(LLAPI_MSG_ERROR, errno, "mkfifo(%s) failed",
491 if (!S_ISFIFO(statbuf.st_mode) ||
492 ((statbuf.st_mode & 0777) != 0644)) {
493 llapi_error(LLAPI_MSG_ERROR, errno, "%s exists but is "
494 "not a pipe or has a wrong mode", path);
498 created_hsm_event_fifo = true;
501 /* Open the FIFO for read so that the subsequent open for write
502 * doesn't immediately fail. */
503 read_fd = open(path, O_RDONLY | O_NONBLOCK);
505 llapi_error(LLAPI_MSG_ERROR, errno,
506 "cannot open(%s) for read", path);
510 /* Open the FIFO for writes, but don't block on waiting
512 llapi_hsm_event_fd = open(path, O_WRONLY | O_NONBLOCK);
515 /* Now close the reader. An external monitoring process can
516 * now open the FIFO for reads. If no reader comes along the
517 * events are lost. NOTE: Only one reader at a time! */
520 if (llapi_hsm_event_fd < 0) {
521 llapi_error(LLAPI_MSG_ERROR, -rc,
522 "cannot open(%s) for write", path);
526 /* Ignore SIGPIPEs -- can occur if the reader goes away. */
527 memset(&ignore_action, 0, sizeof(ignore_action));
528 ignore_action.sa_handler = SIG_IGN;
529 sigemptyset(&ignore_action.sa_mask);
530 sigaction(SIGPIPE, &ignore_action, NULL);
536 * Given a path to a FIFO, close its filehandle and delete the FIFO.
538 * \param path Path to monitor FIFO.
540 * \retval 0 on success.
541 * \retval -errno on error.
543 int llapi_hsm_unregister_event_fifo(const char *path)
545 /* Noop unless the event fd was initialized */
546 if (llapi_hsm_event_fd < 0)
549 if (close(llapi_hsm_event_fd) < 0)
552 if (created_hsm_event_fifo) {
554 created_hsm_event_fifo = false;
557 llapi_hsm_event_fd = -1;
563 * Custom logging callback to be used when a monitoring FIFO has been
564 * registered. Formats log entries as JSON events suitable for
565 * consumption by a copytool monitoring process.
567 * \param level The message loglevel.
568 * \param _rc The returncode associated with the message.
569 * \param fmt The message format string.
570 * \param args Arguments to be formatted by the format string.
574 void llapi_hsm_log_error(enum llapi_message_level level, int _rc,
575 const char *fmt, va_list args)
582 struct llapi_json_item_list *json_items;
584 /* Noop unless the event fd was initialized */
585 if (llapi_hsm_event_fd < 0)
588 rc = llapi_json_init_list(&json_items);
592 if ((level & LLAPI_MSG_NO_ERRNO) == 0) {
593 rc = llapi_json_add_item(&json_items, "errno",
599 rc = llapi_json_add_item(&json_items, "error",
606 va_copy(args2, args);
607 msg_len = vsnprintf(NULL, 0, fmt, args2) + 1;
610 msg = (char *) alloca(msg_len);
616 rc = vsnprintf(msg, msg_len, fmt, args);
620 rc = llapi_json_add_item(&json_items, "message",
626 rc = llapi_json_add_item(&json_items, "message",
628 "INTERNAL ERROR: message failed");
633 real_level = level & LLAPI_MSG_NO_ERRNO;
634 real_level = real_level > 0 ? level - LLAPI_MSG_NO_ERRNO : level;
636 rc = llapi_json_add_item(&json_items, "level", LLAPI_JSON_STRING,
637 (void *)llapi_msg_level2str(real_level));
641 rc = llapi_json_add_item(&json_items, "event_type", LLAPI_JSON_STRING,
646 rc = llapi_hsm_write_json_event(&json_items);
653 /* Write directly to stderr to avoid llapi_error, which now
654 * emits JSON event messages. */
655 fprintf(stderr, "\nFATAL ERROR IN llapi_hsm_log_error(): rc %d,", rc);
658 if (json_items != NULL)
659 llapi_json_destroy_list(&json_items);
664 /** Register a copytool
665 * \param[out] priv Opaque private control structure
666 * \param mnt Lustre filesystem mount point
667 * \param archive_count Number of valid archive IDs in \a archives
668 * \param archives Which archive numbers this copytool is
670 * \param rfd_flags flags applied to read fd of pipe
673 * \retval 0 on success.
674 * \retval -errno on error.
676 int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
677 const char *mnt, int archive_count,
678 int *archives, int rfd_flags)
680 struct hsm_copytool_private *ct;
683 if (archive_count > 0 && archives == NULL) {
684 llapi_err_noerrno(LLAPI_MSG_ERROR,
685 "NULL archive numbers");
689 if (archive_count > LL_HSM_MAX_ARCHIVE) {
690 llapi_err_noerrno(LLAPI_MSG_ERROR, "%d requested when maximum "
691 "of %zu archives supported", archive_count,
696 ct = calloc(1, sizeof(*ct));
700 ct->magic = CT_PRIV_MAGIC;
702 ct->open_by_fid_fd = -1;
703 ct->kuc.lk_rfd = LK_NOFD;
704 ct->kuc.lk_wfd = LK_NOFD;
706 ct->mnt = strdup(mnt);
707 if (ct->mnt == NULL) {
712 ct->kuch = malloc(HAL_MAXSIZE + sizeof(*ct->kuch));
713 if (ct->kuch == NULL) {
718 ct->mnt_fd = open(ct->mnt, O_RDONLY);
719 if (ct->mnt_fd < 0) {
724 ct->open_by_fid_fd = openat(ct->mnt_fd, OPEN_BY_FID_PATH, O_RDONLY);
725 if (ct->open_by_fid_fd < 0) {
730 /* no archives specified means "match all". */
732 for (rc = 0; rc < archive_count; rc++) {
733 if ((archives[rc] > LL_HSM_MAX_ARCHIVE) || (archives[rc] < 0)) {
734 llapi_err_noerrno(LLAPI_MSG_ERROR, "%d requested when "
735 "archive id [0 - %zu] is supported",
736 archives[rc], LL_HSM_MAX_ARCHIVE);
740 /* in the list we have an all archive wildcard
741 * so move to all archives mode
743 if (archives[rc] == 0) {
748 ct->archives |= (1 << (archives[rc] - 1));
751 rc = libcfs_ukuc_start(&ct->kuc, KUC_GRP_HSM, rfd_flags);
755 /* Storing archive(s) in lk_data; see mdc_ioc_hsm_ct_start */
756 ct->kuc.lk_data = ct->archives;
757 rc = ioctl(ct->mnt_fd, LL_IOC_HSM_CT_START, &ct->kuc);
760 llapi_error(LLAPI_MSG_ERROR, rc,
761 "cannot start copytool on '%s'", mnt);
765 llapi_hsm_log_ct_registration(&ct, CT_REGISTER);
767 /* Only the kernel reference keeps the write side open */
768 close(ct->kuc.lk_wfd);
769 ct->kuc.lk_wfd = LK_NOFD;
775 /* cleanup the kuc channel */
776 libcfs_ukuc_stop(&ct->kuc);
779 if (!(ct->mnt_fd < 0))
782 if (!(ct->open_by_fid_fd < 0))
783 close(ct->open_by_fid_fd);
794 /** Deregister a copytool
795 * Note: under Linux, until llapi_hsm_copytool_unregister is called
796 * (or the program is killed), the libcfs module will be referenced
797 * and unremovable, even after Lustre services stop.
799 int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv)
801 struct hsm_copytool_private *ct;
803 if (priv == NULL || *priv == NULL)
807 if (ct->magic != CT_PRIV_MAGIC)
810 /* Close the read side of the KUC pipe. This should be done
811 * before unregistering to avoid deadlock: a ldlm_cb thread
812 * enters libcfs_kkuc_group_put() acquires kg_sem and blocks
813 * in pipe_write() due to full pipe; then we attempt to
814 * unregister and block on kg_sem. */
815 libcfs_ukuc_stop(&ct->kuc);
817 /* Tell the kernel to stop sending us messages */
818 ct->kuc.lk_flags = LK_FLG_STOP;
819 ioctl(ct->mnt_fd, LL_IOC_HSM_CT_START, &ct->kuc);
821 llapi_hsm_log_ct_registration(&ct, CT_UNREGISTER);
823 close(ct->open_by_fid_fd);
833 /** Returns a file descriptor to poll/select on.
834 * \param ct Opaque private control structure
835 * \retval -EINVAL on error
836 * \retval the file descriptor for reading HSM events from the kernel
838 int llapi_hsm_copytool_get_fd(struct hsm_copytool_private *ct)
840 if (ct == NULL || ct->magic != CT_PRIV_MAGIC)
843 return libcfs_ukuc_get_rfd(&ct->kuc);
846 /** Wait for the next hsm_action_list
847 * \param ct Opaque private control structure
848 * \param halh Action list handle, will be allocated here
849 * \param msgsize Number of bytes in the message, will be set here
850 * \return 0 valid message received; halh and msgsize are set
852 * Note: The application must not call llapi_hsm_copytool_recv until it has
853 * cleared the data in ct->kuch from the previous call.
855 int llapi_hsm_copytool_recv(struct hsm_copytool_private *ct,
856 struct hsm_action_list **halh, int *msgsize)
858 struct kuc_hdr *kuch;
859 struct hsm_action_list *hal;
862 if (ct == NULL || ct->magic != CT_PRIV_MAGIC)
865 if (halh == NULL || msgsize == NULL)
871 rc = libcfs_ukuc_msg_get(&ct->kuc, (char *)kuch,
872 HAL_MAXSIZE + sizeof(*kuch),
877 /* Handle generic messages */
878 if (kuch->kuc_transport == KUC_TRANSPORT_GENERIC &&
879 kuch->kuc_msgtype == KUC_MSG_SHUTDOWN) {
884 if (kuch->kuc_transport != KUC_TRANSPORT_HSM ||
885 kuch->kuc_msgtype != HMT_ACTION_LIST) {
886 llapi_err_noerrno(LLAPI_MSG_ERROR,
887 "Unknown HSM message type %d:%d\n",
888 kuch->kuc_transport, kuch->kuc_msgtype);
893 if (kuch->kuc_msglen < sizeof(*kuch) + sizeof(*hal)) {
894 llapi_err_noerrno(LLAPI_MSG_ERROR, "Short HSM message %d",
900 /* Our message is a hsm_action_list. Use pointer math to skip
901 * kuch_hdr and point directly to the message payload.
903 hal = (struct hsm_action_list *)(kuch + 1);
905 /* Check that we have registered for this archive #
906 * if 0 registered, we serve any archive */
908 ((1 << (hal->hal_archive_id - 1)) & ct->archives) == 0) {
909 llapi_err_noerrno(LLAPI_MSG_INFO,
910 "This copytool does not service archive #%d,"
911 " ignoring this request."
912 " Mask of served archive is 0x%.8X",
913 hal->hal_archive_id, ct->archives);
919 *msgsize = kuch->kuc_msglen - sizeof(*kuch);
928 /** Get parent path from mount point and fid.
930 * \param mnt Filesystem root path.
931 * \param fid Object FID.
932 * \param parent Destination buffer.
933 * \param parent_len Destination buffer size.
934 * \return 0 on success.
936 static int fid_parent(const char *mnt, const lustre_fid *fid, char *parent,
941 long long recno = -1;
943 char strfid[FID_NOBRACE_LEN + 1];
946 snprintf(strfid, sizeof(strfid), DFID_NOBRACE, PFID(fid));
948 rc = llapi_fid2path(mnt, strfid, file, sizeof(file),
953 /* fid2path returns a relative path */
954 rc = snprintf(parent, parent_len, "%s/%s", mnt, file);
955 if (rc >= parent_len)
956 return -ENAMETOOLONG;
958 /* remove file name */
959 ptr = strrchr(parent, '/');
960 if (ptr == NULL || ptr == parent) {
970 static int ct_open_by_fid(const struct hsm_copytool_private *ct,
971 const struct lu_fid *fid, int open_flags)
973 char fid_name[FID_NOBRACE_LEN + 1];
976 snprintf(fid_name, sizeof(fid_name), DFID_NOBRACE, PFID(fid));
978 fd = openat(ct->open_by_fid_fd, fid_name, open_flags);
979 return fd < 0 ? -errno : fd;
983 * Get metadata attributes of file by FID.
985 * Use the IOC_MDC_GETFILEINFO ioctl (to send a MDS_GETATTR_NAME RPC)
986 * to get the attributes of the file identified by \a fid. This
987 * returns only the attributes stored on the MDT and avoids taking
988 * layout locks or accessing OST objects. It also bypasses the inode
989 * cache. Attributes are returned in \a st.
991 static int ct_md_getattr(const struct hsm_copytool_private *ct,
992 const struct lu_fid *fid,
995 struct lov_user_mds_data *lmd;
999 lmd_size = sizeof(lmd->lmd_st) +
1000 lov_user_md_size(LOV_MAX_STRIPE_COUNT, LOV_USER_MAGIC_V3);
1002 if (lmd_size < sizeof(lmd->lmd_st) + XATTR_SIZE_MAX)
1003 lmd_size = sizeof(lmd->lmd_st) + XATTR_SIZE_MAX;
1005 if (lmd_size < FID_NOBRACE_LEN + 1)
1006 lmd_size = FID_NOBRACE_LEN + 1;
1008 lmd = malloc(lmd_size);
1012 snprintf((char *)lmd, lmd_size, DFID_NOBRACE, PFID(fid));
1014 rc = ioctl(ct->open_by_fid_fd, IOC_MDC_GETFILEINFO, lmd);
1017 llapi_error(LLAPI_MSG_ERROR, rc,
1018 "cannot get metadata attributes of "DFID" in '%s'",
1019 PFID(fid), ct->mnt);
1030 /** Create the destination volatile file for a restore operation.
1032 * \param hcp Private copyaction handle.
1033 * \param mdt_index MDT index where to create the volatile file.
1034 * \param flags Volatile file creation flags.
1035 * \return 0 on success.
1037 static int create_restore_volatile(struct hsm_copyaction_private *hcp,
1038 int mdt_index, int open_flags)
1042 char parent[PATH_MAX + 1];
1043 const char *mnt = hcp->ct_priv->mnt;
1044 struct hsm_action_item *hai = &hcp->copy.hc_hai;
1046 rc = fid_parent(mnt, &hai->hai_fid, parent, sizeof(parent));
1048 /* fid_parent() failed, try to keep on going */
1049 llapi_error(LLAPI_MSG_ERROR, rc,
1050 "cannot get parent path to restore "DFID" "
1051 "using '%s'", PFID(&hai->hai_fid), mnt);
1052 snprintf(parent, sizeof(parent), "%s", mnt);
1055 fd = llapi_create_volatile_idx(parent, mdt_index, open_flags);
1059 rc = fchown(fd, hcp->stat.st_uid, hcp->stat.st_gid);
1063 rc = llapi_fd2fid(fd, &hai->hai_dfid);
1078 /** Start processing an HSM action.
1079 * Should be called by copytools just before starting handling a request.
1080 * It could be skipped if copytool only want to directly report an error,
1081 * \see llapi_hsm_action_end().
1083 * \param hcp Opaque action handle to be passed to
1084 * llapi_hsm_action_progress and llapi_hsm_action_end.
1085 * \param ct Copytool handle acquired at registration.
1086 * \param hai The hsm_action_item describing the request.
1087 * \param restore_mdt_index On restore: MDT index where to create the volatile
1088 * file. Use -1 for default.
1089 * \param restore_open_flags On restore: volatile file creation mode. Use
1090 * O_LOV_DELAY_CREATE to manually set the LOVEA
1092 * \param is_error Whether this call is just to report an error.
1094 * \return 0 on success.
1096 int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
1097 const struct hsm_copytool_private *ct,
1098 const struct hsm_action_item *hai,
1099 int restore_mdt_index, int restore_open_flags,
1102 struct hsm_copyaction_private *hcp;
1105 hcp = calloc(1, sizeof(*hcp));
1111 hcp->copy.hc_hai = *hai;
1112 hcp->copy.hc_hai.hai_len = sizeof(*hai);
1117 if (hai->hai_action == HSMA_RESTORE) {
1118 rc = ct_md_getattr(hcp->ct_priv, &hai->hai_fid, &hcp->stat);
1122 rc = create_restore_volatile(hcp, restore_mdt_index,
1123 restore_open_flags);
1128 /* Since remove is atomic there is no need to send an initial
1129 * MDS_HSM_PROGRESS RPC. */
1130 if (hai->hai_action == HSMA_REMOVE)
1133 rc = ioctl(ct->mnt_fd, LL_IOC_HSM_COPY_START, &hcp->copy);
1140 llapi_hsm_log_ct_progress(&hcp, hai, CT_START, 0, 0);
1143 hcp->magic = CP_PRIV_MAGIC;
1148 if (!(hcp->data_fd < 0))
1149 close(hcp->data_fd);
1156 /** Terminate an HSM action processing.
1157 * Should be called by copytools just having finished handling the request.
1158 * \param hdl[in,out] Handle returned by llapi_hsm_action_start.
1159 * \param he[in] The final range of copied data (for copy actions).
1160 * \param errval[in] The status code of the operation.
1161 * \param flags[in] The flags about the termination status (HP_FLAG_RETRY if
1162 * the error is retryable).
1164 * \return 0 on success.
1166 int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
1167 const struct hsm_extent *he, int hp_flags, int errval)
1169 struct hsm_copyaction_private *hcp;
1170 struct hsm_action_item *hai;
1173 if (phcp == NULL || *phcp == NULL || he == NULL)
1178 if (hcp->magic != CP_PRIV_MAGIC)
1181 hai = &hcp->copy.hc_hai;
1183 if (hai->hai_action == HSMA_RESTORE && errval == 0) {
1184 struct ll_futimes_3 lfu = {
1185 .lfu_atime_sec = hcp->stat.st_atim.tv_sec,
1186 .lfu_atime_nsec = hcp->stat.st_atim.tv_nsec,
1187 .lfu_mtime_sec = hcp->stat.st_mtim.tv_sec,
1188 .lfu_mtime_nsec = hcp->stat.st_mtim.tv_nsec,
1189 .lfu_ctime_sec = hcp->stat.st_ctim.tv_sec,
1190 .lfu_ctime_nsec = hcp->stat.st_ctim.tv_nsec,
1193 rc = fsync(hcp->data_fd);
1199 /* Set {a,m,c}time of volatile file to that of original. */
1200 rc = ioctl(hcp->data_fd, LL_IOC_FUTIMES_3, &lfu);
1208 /* In some cases, like restore, 2 FIDs are used.
1209 * Set the right FID to use here. */
1210 if (hai->hai_action == HSMA_ARCHIVE || hai->hai_action == HSMA_RESTORE)
1211 hai->hai_fid = hai->hai_dfid;
1213 /* Fill the last missing data that will be needed by
1214 * kernel to send a hsm_progress. */
1215 hcp->copy.hc_flags = hp_flags;
1216 hcp->copy.hc_errval = abs(errval);
1218 hcp->copy.hc_hai.hai_extent = *he;
1220 rc = ioctl(hcp->ct_priv->mnt_fd, LL_IOC_HSM_COPY_END, &hcp->copy);
1226 llapi_hsm_log_ct_progress(&hcp, hai, CT_FINISH, 0, 0);
1229 if (!(hcp->data_fd < 0))
1230 close(hcp->data_fd);
1238 /** Notify a progress in processing an HSM action.
1239 * \param hdl[in,out] handle returned by llapi_hsm_action_start.
1240 * \param he[in] the range of copied data (for copy actions).
1241 * \param total[in] the expected total of copied data (for copy actions).
1242 * \param hp_flags[in] HSM progress flags.
1243 * \return 0 on success.
1245 int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
1246 const struct hsm_extent *he, __u64 total,
1250 struct hsm_progress hp;
1251 struct hsm_action_item *hai;
1253 if (hcp == NULL || he == NULL)
1256 if (hcp->magic != CP_PRIV_MAGIC)
1259 hai = &hcp->copy.hc_hai;
1261 memset(&hp, 0, sizeof(hp));
1263 hp.hp_cookie = hai->hai_cookie;
1264 hp.hp_flags = hp_flags;
1266 /* Progress is made on the data fid */
1267 hp.hp_fid = hai->hai_dfid;
1270 rc = ioctl(hcp->ct_priv->mnt_fd, LL_IOC_HSM_PROGRESS, &hp);
1274 llapi_hsm_log_ct_progress(&hcp, hai, CT_RUNNING, total, he->length);
1279 /** Get the fid of object to be used for copying data.
1280 * @return error code if the action is not a copy operation.
1282 int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
1285 const struct hsm_action_item *hai = &hcp->copy.hc_hai;
1287 if (hcp->magic != CP_PRIV_MAGIC)
1290 if (hai->hai_action != HSMA_RESTORE && hai->hai_action != HSMA_ARCHIVE)
1293 *fid = hai->hai_dfid;
1299 * Get a file descriptor to be used for copying data. It's up to the
1300 * caller to close the FDs obtained from this function.
1302 * @retval a file descriptor on success.
1303 * @retval a negative error code on failure.
1305 int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp)
1307 const struct hsm_action_item *hai = &hcp->copy.hc_hai;
1310 if (hcp->magic != CP_PRIV_MAGIC)
1313 if (hai->hai_action == HSMA_ARCHIVE) {
1314 return ct_open_by_fid(hcp->ct_priv, &hai->hai_dfid,
1315 O_RDONLY | O_NOATIME | O_NOFOLLOW | O_NONBLOCK);
1316 } else if (hai->hai_action == HSMA_RESTORE) {
1317 fd = dup(hcp->data_fd);
1318 return fd < 0 ? -errno : fd;
1325 * Import an existing hsm-archived file into Lustre.
1327 * Caller must access file by (returned) newfid value from now on.
1329 * \param dst path to Lustre destination (e.g. /mnt/lustre/my/file).
1330 * \param archive archive number.
1331 * \param st struct stat buffer containing file ownership, perm, etc.
1332 * \param stripe_* Striping options. Currently ignored, since the restore
1333 * operation will set the striping. In V2, this striping might
1335 * \param newfid[out] Filled with new Lustre fid.
1337 int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
1338 unsigned long long stripe_size, int stripe_offset,
1339 int stripe_count, int stripe_pattern, char *pool_name,
1342 struct hsm_user_import hui;
1346 if (stripe_pattern == 0)
1347 stripe_pattern = LOV_PATTERN_RAID0;
1349 /* Create a non-striped file */
1350 fd = llapi_file_open_pool(dst, O_CREAT | O_WRONLY, st->st_mode,
1351 stripe_size, stripe_offset, stripe_count,
1352 stripe_pattern | LOV_PATTERN_F_RELEASED,
1355 llapi_error(LLAPI_MSG_ERROR, fd,
1356 "cannot create '%s' for import", dst);
1360 /* Get the new fid in Lustre. Caller needs to use this fid
1362 rc = llapi_fd2fid(fd, newfid);
1364 llapi_error(LLAPI_MSG_ERROR, rc,
1365 "cannot get fid of '%s' for import", dst);
1369 hui.hui_uid = st->st_uid;
1370 hui.hui_gid = st->st_gid;
1371 hui.hui_mode = st->st_mode;
1372 hui.hui_size = st->st_size;
1373 hui.hui_archive_id = archive;
1374 hui.hui_atime = st->st_atime;
1375 hui.hui_atime_ns = st->st_atim.tv_nsec;
1376 hui.hui_mtime = st->st_mtime;
1377 hui.hui_mtime_ns = st->st_mtim.tv_nsec;
1378 rc = ioctl(fd, LL_IOC_HSM_IMPORT, &hui);
1381 llapi_error(LLAPI_MSG_ERROR, rc, "cannot import '%s'", dst);
1394 * Return the current HSM states and HSM requests related to file pointed by \a
1397 * \param hus Should be allocated by caller. Will be filled with current file
1400 * \retval 0 on success.
1401 * \retval -errno on error.
1403 int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus)
1407 rc = ioctl(fd, LL_IOC_HSM_STATE_GET, hus);
1408 /* If error, save errno value */
1409 rc = rc ? -errno : 0;
1415 * Return the current HSM states and HSM requests related to file pointed by \a
1418 * see llapi_hsm_state_get_fd() for args use and return
1420 int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus)
1425 fd = open(path, O_RDONLY | O_NONBLOCK);
1429 rc = llapi_hsm_state_get_fd(fd, hus);
1436 * Set HSM states of file pointed by \a fd
1438 * Using the provided bitmasks, the current HSM states for this file will be
1439 * changed. \a archive_id could be used to change the archive number also. Set
1440 * it to 0 if you do not want to change it.
1442 * \param setmask Bitmask for flag to be set.
1443 * \param clearmask Bitmask for flag to be cleared.
1444 * \param archive_id Archive number identifier to use. 0 means no change.
1446 * \retval 0 on success.
1447 * \retval -errno on error.
1449 int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
1452 struct hsm_state_set hss;
1455 hss.hss_valid = HSS_SETMASK|HSS_CLEARMASK;
1456 hss.hss_setmask = setmask;
1457 hss.hss_clearmask = clearmask;
1458 /* Change archive_id if provided. We can only change
1459 * to set something different than 0. */
1460 if (archive_id > 0) {
1461 hss.hss_valid |= HSS_ARCHIVE_ID;
1462 hss.hss_archive_id = archive_id;
1464 rc = ioctl(fd, LL_IOC_HSM_STATE_SET, &hss);
1465 /* If error, save errno value */
1466 rc = rc ? -errno : 0;
1472 * Set HSM states of file pointed by \a path.
1474 * see llapi_hsm_state_set_fd() for args use and return
1476 int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
1482 fd = open(path, O_WRONLY | O_LOV_DELAY_CREATE | O_NONBLOCK);
1486 rc = llapi_hsm_state_set_fd(fd, setmask, clearmask, archive_id);
1493 * Return the current HSM request related to file pointed by \a path.
1495 * \param hca Should be allocated by caller. Will be filled with current file
1498 * \retval 0 on success.
1499 * \retval -errno on error.
1501 int llapi_hsm_current_action(const char *path, struct hsm_current_action *hca)
1506 fd = open(path, O_RDONLY | O_NONBLOCK);
1510 rc = ioctl(fd, LL_IOC_HSM_ACTION, hca);
1511 /* If error, save errno value */
1512 rc = rc ? -errno : 0;
1519 * Allocate a hsm_user_request with the specified carateristics.
1520 * This structure should be freed with free().
1522 * \return an allocated structure on success, NULL otherwise.
1524 struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
1529 len += sizeof(struct hsm_user_request);
1530 len += sizeof(struct hsm_user_item) * itemcount;
1533 return (struct hsm_user_request *)malloc(len);
1537 * Send a HSM request to Lustre, described in \param request.
1539 * \param path Fullpath to the file to operate on.
1540 * \param request The request, allocated with llapi_hsm_user_request_alloc().
1542 * \return 0 on success, an error code otherwise.
1544 int llapi_hsm_request(const char *path, const struct hsm_user_request *request)
1549 rc = get_root_path(WANT_FD, NULL, &fd, (char *)path, -1);
1553 rc = ioctl(fd, LL_IOC_HSM_REQUEST, request);
1554 /* If error, save errno value */
1555 rc = rc ? -errno : 0;