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, 2015, 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>
39 #include <sys/ioctl.h>
47 #include <sys/types.h>
49 #include <sys/syscall.h>
52 #ifdef HAVE_LINUX_UNISTD_H
53 #include <linux/unistd.h>
58 #include <lnet/lnetctl.h>
59 #include <lustre/lustre_idl.h>
60 #include <lustre/lustreapi.h>
61 #include "lustreapi_internal.h"
63 #define OPEN_BY_FID_PATH dot_lustre_name"/fid"
65 /****** HSM Copytool API ********/
66 #define CT_PRIV_MAGIC 0xC0BE2001
67 struct hsm_copytool_private {
73 struct lustre_kernelcomm kuc;
77 #define CP_PRIV_MAGIC 0x19880429
78 struct hsm_copyaction_private {
81 const struct hsm_copytool_private *ct_priv;
86 enum ct_progress_type {
97 CT_ARCHIVE_START = HSMA_ARCHIVE,
98 CT_ARCHIVE_RUNNING = HSMA_ARCHIVE + CT_RUNNING,
99 CT_ARCHIVE_FINISH = HSMA_ARCHIVE + CT_FINISH,
100 CT_ARCHIVE_CANCEL = HSMA_ARCHIVE + CT_CANCEL,
101 CT_ARCHIVE_ERROR = HSMA_ARCHIVE + CT_ERROR,
102 CT_RESTORE_START = HSMA_RESTORE,
103 CT_RESTORE_RUNNING = HSMA_RESTORE + CT_RUNNING,
104 CT_RESTORE_FINISH = HSMA_RESTORE + CT_FINISH,
105 CT_RESTORE_CANCEL = HSMA_RESTORE + CT_CANCEL,
106 CT_RESTORE_ERROR = HSMA_RESTORE + CT_ERROR,
107 CT_REMOVE_START = HSMA_REMOVE,
108 CT_REMOVE_RUNNING = HSMA_REMOVE + CT_RUNNING,
109 CT_REMOVE_FINISH = HSMA_REMOVE + CT_FINISH,
110 CT_REMOVE_CANCEL = HSMA_REMOVE + CT_CANCEL,
111 CT_REMOVE_ERROR = HSMA_REMOVE + CT_ERROR,
115 /* initialized in llapi_hsm_register_event_fifo() */
116 static int llapi_hsm_event_fd = -1;
117 static bool created_hsm_event_fifo;
119 static inline const char *llapi_hsm_ct_ev2str(int type)
126 case CT_ARCHIVE_START:
127 return "ARCHIVE_START";
128 case CT_ARCHIVE_RUNNING:
129 return "ARCHIVE_RUNNING";
130 case CT_ARCHIVE_FINISH:
131 return "ARCHIVE_FINISH";
132 case CT_ARCHIVE_CANCEL:
133 return "ARCHIVE_CANCEL";
134 case CT_ARCHIVE_ERROR:
135 return "ARCHIVE_ERROR";
136 case CT_RESTORE_START:
137 return "RESTORE_START";
138 case CT_RESTORE_RUNNING:
139 return "RESTORE_RUNNING";
140 case CT_RESTORE_FINISH:
141 return "RESTORE_FINISH";
142 case CT_RESTORE_CANCEL:
143 return "RESTORE_CANCEL";
144 case CT_RESTORE_ERROR:
145 return "RESTORE_ERROR";
146 case CT_REMOVE_START:
147 return "REMOVE_START";
148 case CT_REMOVE_RUNNING:
149 return "REMOVE_RUNNING";
150 case CT_REMOVE_FINISH:
151 return "REMOVE_FINISH";
152 case CT_REMOVE_CANCEL:
153 return "REMOVE_CANCEL";
154 case CT_REMOVE_ERROR:
155 return "REMOVE_ERROR";
157 llapi_err_noerrno(LLAPI_MSG_ERROR,
158 "Unknown event type: %d", type);
164 * Writes a JSON event to the monitor FIFO. Noop if no FIFO has been
167 * \param event A list of llapi_json_items comprising a
168 * single JSON-formatted event.
170 * \retval 0 on success.
171 * \retval -errno on error.
173 static int llapi_hsm_write_json_event(struct llapi_json_item_list **event)
176 char time_string[40];
177 char json_buf[PIPE_BUF];
179 time_t event_time = time(0);
180 struct tm time_components;
181 struct llapi_json_item_list *json_items;
183 /* Noop unless the event fd was initialized */
184 if (llapi_hsm_event_fd < 0)
187 if (event == NULL || *event == NULL)
192 localtime_r(&event_time, &time_components);
194 if (strftime(time_string, sizeof(time_string), "%Y-%m-%d %T %z",
195 &time_components) == 0) {
197 llapi_error(LLAPI_MSG_ERROR, rc, "strftime() failed");
201 rc = llapi_json_add_item(&json_items, "event_time", LLAPI_JSON_STRING,
204 llapi_error(LLAPI_MSG_ERROR, -rc, "error in "
205 "llapi_json_add_item()");
209 buf_file = fmemopen(json_buf, sizeof(json_buf), "w");
210 if (buf_file == NULL)
213 rc = llapi_json_write_list(event, buf_file);
221 if (write(llapi_hsm_event_fd, json_buf, strlen(json_buf)) < 0) {
222 /* Ignore write failures due to missing reader. */
231 * Hook for llapi_hsm_copytool_register and llapi_hsm_copytool_unregister
232 * to generate JSON events suitable for consumption by a copytool
233 * monitoring process.
235 * \param priv Opaque private control structure.
236 * \param event_type The type of event (register or unregister).
238 * \retval 0 on success.
239 * \retval -errno on error.
241 static int llapi_hsm_log_ct_registration(struct hsm_copytool_private **priv,
245 char agent_uuid[UUID_MAX];
246 struct hsm_copytool_private *ct;
247 struct llapi_json_item_list *json_items;
249 /* Noop unless the event fd was initialized */
250 if (llapi_hsm_event_fd < 0)
253 if (priv == NULL || *priv == NULL)
257 if (ct->magic != CT_PRIV_MAGIC)
260 if (event_type != CT_REGISTER && event_type != CT_UNREGISTER)
263 rc = llapi_json_init_list(&json_items);
267 rc = llapi_get_agent_uuid(ct->mnt, agent_uuid, sizeof(agent_uuid));
270 llapi_chomp_string(agent_uuid);
272 rc = llapi_json_add_item(&json_items, "uuid", LLAPI_JSON_STRING,
277 rc = llapi_json_add_item(&json_items, "mount_point", LLAPI_JSON_STRING,
282 rc = llapi_json_add_item(&json_items, "archive", LLAPI_JSON_INTEGER,
287 rc = llapi_json_add_item(&json_items, "event_type", LLAPI_JSON_STRING,
288 (char *)llapi_hsm_ct_ev2str(event_type));
292 rc = llapi_hsm_write_json_event(&json_items);
299 llapi_error(LLAPI_MSG_ERROR, rc, "error in "
300 "llapi_hsm_log_ct_registration()");
303 if (json_items != NULL)
304 llapi_json_destroy_list(&json_items);
310 * Given a copytool progress update, construct a JSON event suitable for
311 * consumption by a copytool monitoring process.
313 * Examples of various events generated here and written by
314 * llapi_hsm_write_json_event:
316 * Copytool registration and deregistration:
317 * {"event_time": "2014-02-26 14:58:01 -0500", "event_type": "REGISTER",
318 * "archive": 0, "mount_point": "/mnt/lustre",
319 * "uuid": "80379a60-1f8a-743f-daf2-307cde793ec2"}
320 * {"event_time": "2014-02-26 14:58:01 -0500", "event_type": "UNREGISTER",
321 * "archive": 0, "mount_point": "/mnt/lustre",
322 * "uuid": "80379a60-1f8a-743f-daf2-307cde793ec2"}
324 * An archive action, start to completion:
325 * {"event_time": "2014-02-26 14:50:13 -0500", "event_type": "ARCHIVE_START",
326 * "total_bytes": 0, "lustre_path": "d71.sanity-hsm/f71.sanity-hsm",
327 * "source_fid": "0x2000013a1:0x2:0x0", "data_fid": "0x2000013a1:0x2:0x0"}
328 * {"event_time": "2014-02-26 14:50:18 -0500", "event_type": "ARCHIVE_RUNNING",
329 * "current_bytes": 5242880, "total_bytes": 39000000,
330 * "lustre_path": "d71.sanity-hsm/f71.sanity-hsm",
331 * "source_fid": "0x2000013a1:0x2:0x0", "data_fid": "0x2000013a1:0x2:0x0"}
332 * {"event_time": "2014-02-26 14:50:50 -0500", "event_type": "ARCHIVE_FINISH",
333 * "source_fid": "0x2000013a1:0x2:0x0", "data_fid": "0x2000013a1:0x2:0x0"}
336 * {"event_time": "2014-02-26 14:50:13 -0500", "event_type": "LOGGED_MESSAGE",
338 * "message": "lhsmtool_posix[42]: copytool fs=lustre archive#=2 item_count=1"}
340 * \param hcp Opaque action handle returned by
341 * llapi_hsm_action_start.
342 * \param hai The hsm_action_item describing the request.
343 * \param progress_type The ct_progress_type describing the update.
344 * \param total The total expected bytes for the request.
345 * \param current The current copied byte count for the request.
347 * \retval 0 on success.
348 * \retval -errno on error.
350 static int llapi_hsm_log_ct_progress(struct hsm_copyaction_private **phcp,
351 const struct hsm_action_item *hai,
353 __u64 total, __u64 current)
357 long long recno = -1;
358 char lustre_path[PATH_MAX];
359 char strfid[FID_NOBRACE_LEN + 1];
360 struct hsm_copyaction_private *hcp;
361 struct llapi_json_item_list *json_items;
363 /* Noop unless the event fd was initialized */
364 if (llapi_hsm_event_fd < 0)
367 if (phcp == NULL || *phcp == NULL)
372 rc = llapi_json_init_list(&json_items);
376 snprintf(strfid, sizeof(strfid), DFID_NOBRACE, PFID(&hai->hai_dfid));
377 rc = llapi_json_add_item(&json_items, "data_fid",
378 LLAPI_JSON_STRING, strfid);
382 snprintf(strfid, sizeof(strfid), DFID_NOBRACE, PFID(&hai->hai_fid));
383 rc = llapi_json_add_item(&json_items, "source_fid",
384 LLAPI_JSON_STRING, strfid);
388 if (hcp->copy.hc_errval == ECANCELED) {
389 progress_type = CT_CANCEL;
393 if (hcp->copy.hc_errval != 0) {
394 progress_type = CT_ERROR;
396 rc = llapi_json_add_item(&json_items, "errno",
398 &hcp->copy.hc_errval);
402 rc = llapi_json_add_item(&json_items, "error",
404 strerror(hcp->copy.hc_errval));
411 /* lustre_path isn't available after a restore completes */
412 /* total_bytes isn't available after a restore or archive completes */
413 if (progress_type != CT_FINISH) {
414 rc = llapi_fid2path(hcp->ct_priv->mnt, strfid, lustre_path,
415 sizeof(lustre_path), &recno, &linkno);
419 rc = llapi_json_add_item(&json_items, "lustre_path",
420 LLAPI_JSON_STRING, lustre_path);
424 rc = llapi_json_add_item(&json_items, "total_bytes",
425 LLAPI_JSON_BIGNUM, &total);
430 if (progress_type == CT_RUNNING)
431 rc = llapi_json_add_item(&json_items, "current_bytes",
432 LLAPI_JSON_BIGNUM, ¤t);
437 rc = llapi_json_add_item(&json_items, "event_type", LLAPI_JSON_STRING,
438 (char *)llapi_hsm_ct_ev2str(hai->hai_action +
443 rc = llapi_hsm_write_json_event(&json_items);
450 llapi_error(LLAPI_MSG_ERROR, rc, "error in "
451 "llapi_hsm_log_ct_progress()");
454 if (json_items != NULL)
455 llapi_json_destroy_list(&json_items);
461 * Given a path to a FIFO, create a filehandle for nonblocking writes to it.
462 * Intended to be used for copytool monitoring processes that read an
463 * event stream from the FIFO. Events written in the absence of a reader
466 * \param path Path to monitor FIFO.
468 * \retval 0 on success.
469 * \retval -errno on error.
471 int llapi_hsm_register_event_fifo(const char *path)
476 /* Create the FIFO if necessary. */
477 if ((mkfifo(path, 0644) < 0) && (errno != EEXIST)) {
478 llapi_error(LLAPI_MSG_ERROR, errno, "mkfifo(%s) failed", path);
481 if (errno == EEXIST) {
482 if (stat(path, &statbuf) < 0) {
483 llapi_error(LLAPI_MSG_ERROR, errno, "mkfifo(%s) failed",
487 if (!S_ISFIFO(statbuf.st_mode) ||
488 ((statbuf.st_mode & 0777) != 0644)) {
489 llapi_error(LLAPI_MSG_ERROR, errno, "%s exists but is "
490 "not a pipe or has a wrong mode", path);
494 created_hsm_event_fifo = true;
497 /* Open the FIFO for read so that the subsequent open for write
498 * doesn't immediately fail. */
499 read_fd = open(path, O_RDONLY | O_NONBLOCK);
501 llapi_error(LLAPI_MSG_ERROR, errno,
502 "cannot open(%s) for read", path);
506 /* Open the FIFO for writes, but don't block on waiting
508 llapi_hsm_event_fd = open(path, O_WRONLY | O_NONBLOCK);
509 if (llapi_hsm_event_fd < 0) {
510 llapi_error(LLAPI_MSG_ERROR, errno,
511 "cannot open(%s) for write", path);
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 /* Ignore SIGPIPEs -- can occur if the reader goes away. */
521 signal(SIGPIPE, SIG_IGN);
527 * Given a path to a FIFO, close its filehandle and delete the FIFO.
529 * \param path Path to monitor FIFO.
531 * \retval 0 on success.
532 * \retval -errno on error.
534 int llapi_hsm_unregister_event_fifo(const char *path)
536 /* Noop unless the event fd was initialized */
537 if (llapi_hsm_event_fd < 0)
540 if (close(llapi_hsm_event_fd) < 0)
543 if (created_hsm_event_fifo) {
545 created_hsm_event_fifo = false;
548 llapi_hsm_event_fd = -1;
554 * Custom logging callback to be used when a monitoring FIFO has been
555 * registered. Formats log entries as JSON events suitable for
556 * consumption by a copytool monitoring process.
558 * \param level The message loglevel.
559 * \param _rc The returncode associated with the message.
560 * \param fmt The message format string.
561 * \param args Arguments to be formatted by the format string.
565 void llapi_hsm_log_error(enum llapi_message_level level, int _rc,
566 const char *fmt, va_list args)
573 struct llapi_json_item_list *json_items;
575 /* Noop unless the event fd was initialized */
576 if (llapi_hsm_event_fd < 0)
579 rc = llapi_json_init_list(&json_items);
583 if ((level & LLAPI_MSG_NO_ERRNO) == 0) {
584 rc = llapi_json_add_item(&json_items, "errno",
590 rc = llapi_json_add_item(&json_items, "error",
597 va_copy(args2, args);
598 msg_len = vsnprintf(NULL, 0, fmt, args2) + 1;
601 msg = (char *) alloca(msg_len);
607 rc = vsnprintf(msg, msg_len, fmt, args);
611 rc = llapi_json_add_item(&json_items, "message",
617 rc = llapi_json_add_item(&json_items, "message",
619 "INTERNAL ERROR: message failed");
624 real_level = level & LLAPI_MSG_NO_ERRNO;
625 real_level = real_level > 0 ? level - LLAPI_MSG_NO_ERRNO : level;
627 rc = llapi_json_add_item(&json_items, "level", LLAPI_JSON_STRING,
628 (void *)llapi_msg_level2str(real_level));
632 rc = llapi_json_add_item(&json_items, "event_type", LLAPI_JSON_STRING,
637 rc = llapi_hsm_write_json_event(&json_items);
644 /* Write directly to stderr to avoid llapi_error, which now
645 * emits JSON event messages. */
646 fprintf(stderr, "\nFATAL ERROR IN llapi_hsm_log_error(): rc %d,", rc);
649 if (json_items != NULL)
650 llapi_json_destroy_list(&json_items);
655 /** Register a copytool
656 * \param[out] priv Opaque private control structure
657 * \param mnt Lustre filesystem mount point
658 * \param archive_count Number of valid archive IDs in \a archives
659 * \param archives Which archive numbers this copytool is
661 * \param rfd_flags flags applied to read fd of pipe
664 * \retval 0 on success.
665 * \retval -errno on error.
667 int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
668 const char *mnt, int archive_count,
669 int *archives, int rfd_flags)
671 struct hsm_copytool_private *ct;
674 if (archive_count > 0 && archives == NULL) {
675 llapi_err_noerrno(LLAPI_MSG_ERROR,
676 "NULL archive numbers");
680 if (archive_count > LL_HSM_MAX_ARCHIVE) {
681 llapi_err_noerrno(LLAPI_MSG_ERROR, "%d requested when maximum "
682 "of %zu archives supported", archive_count,
687 ct = calloc(1, sizeof(*ct));
691 ct->magic = CT_PRIV_MAGIC;
693 ct->open_by_fid_fd = -1;
694 ct->kuc.lk_rfd = LK_NOFD;
695 ct->kuc.lk_wfd = LK_NOFD;
697 ct->mnt = strdup(mnt);
698 if (ct->mnt == NULL) {
703 ct->kuch = malloc(HAL_MAXSIZE + sizeof(*ct->kuch));
704 if (ct->kuch == NULL) {
709 ct->mnt_fd = open(ct->mnt, O_RDONLY);
710 if (ct->mnt_fd < 0) {
715 ct->open_by_fid_fd = openat(ct->mnt_fd, OPEN_BY_FID_PATH, O_RDONLY);
716 if (ct->open_by_fid_fd < 0) {
721 /* no archives specified means "match all". */
723 for (rc = 0; rc < archive_count; rc++) {
724 if ((archives[rc] > LL_HSM_MAX_ARCHIVE) || (archives[rc] < 0)) {
725 llapi_err_noerrno(LLAPI_MSG_ERROR, "%d requested when "
726 "archive id [0 - %zu] is supported",
727 archives[rc], LL_HSM_MAX_ARCHIVE);
731 /* in the list we have an all archive wildcard
732 * so move to all archives mode
734 if (archives[rc] == 0) {
739 ct->archives |= (1 << (archives[rc] - 1));
742 rc = libcfs_ukuc_start(&ct->kuc, KUC_GRP_HSM, rfd_flags);
746 /* Storing archive(s) in lk_data; see mdc_ioc_hsm_ct_start */
747 ct->kuc.lk_data = ct->archives;
748 rc = ioctl(ct->mnt_fd, LL_IOC_HSM_CT_START, &ct->kuc);
751 llapi_error(LLAPI_MSG_ERROR, rc,
752 "cannot start copytool on '%s'", mnt);
756 llapi_hsm_log_ct_registration(&ct, CT_REGISTER);
758 /* Only the kernel reference keeps the write side open */
759 close(ct->kuc.lk_wfd);
760 ct->kuc.lk_wfd = LK_NOFD;
766 /* cleanup the kuc channel */
767 libcfs_ukuc_stop(&ct->kuc);
770 if (!(ct->mnt_fd < 0))
773 if (!(ct->open_by_fid_fd < 0))
774 close(ct->open_by_fid_fd);
785 /** Deregister a copytool
786 * Note: under Linux, until llapi_hsm_copytool_unregister is called
787 * (or the program is killed), the libcfs module will be referenced
788 * and unremovable, even after Lustre services stop.
790 int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv)
792 struct hsm_copytool_private *ct;
794 if (priv == NULL || *priv == NULL)
798 if (ct->magic != CT_PRIV_MAGIC)
801 /* Tell the kernel to stop sending us messages */
802 ct->kuc.lk_flags = LK_FLG_STOP;
803 ioctl(ct->mnt_fd, LL_IOC_HSM_CT_START, &ct->kuc);
805 /* Shut down the kernelcomms */
806 libcfs_ukuc_stop(&ct->kuc);
808 llapi_hsm_log_ct_registration(&ct, CT_UNREGISTER);
810 close(ct->open_by_fid_fd);
820 /** Returns a file descriptor to poll/select on.
821 * \param ct Opaque private control structure
822 * \retval -EINVAL on error
823 * \retval the file descriptor for reading HSM events from the kernel
825 int llapi_hsm_copytool_get_fd(struct hsm_copytool_private *ct)
827 if (ct == NULL || ct->magic != CT_PRIV_MAGIC)
830 return libcfs_ukuc_get_rfd(&ct->kuc);
833 /** Wait for the next hsm_action_list
834 * \param ct Opaque private control structure
835 * \param halh Action list handle, will be allocated here
836 * \param msgsize Number of bytes in the message, will be set here
837 * \return 0 valid message received; halh and msgsize are set
839 * Note: The application must not call llapi_hsm_copytool_recv until it has
840 * cleared the data in ct->kuch from the previous call.
842 int llapi_hsm_copytool_recv(struct hsm_copytool_private *ct,
843 struct hsm_action_list **halh, int *msgsize)
845 struct kuc_hdr *kuch;
846 struct hsm_action_list *hal;
849 if (ct == NULL || ct->magic != CT_PRIV_MAGIC)
852 if (halh == NULL || msgsize == NULL)
858 rc = libcfs_ukuc_msg_get(&ct->kuc, (char *)kuch,
859 HAL_MAXSIZE + sizeof(*kuch),
864 /* Handle generic messages */
865 if (kuch->kuc_transport == KUC_TRANSPORT_GENERIC &&
866 kuch->kuc_msgtype == KUC_MSG_SHUTDOWN) {
871 if (kuch->kuc_transport != KUC_TRANSPORT_HSM ||
872 kuch->kuc_msgtype != HMT_ACTION_LIST) {
873 llapi_err_noerrno(LLAPI_MSG_ERROR,
874 "Unknown HSM message type %d:%d\n",
875 kuch->kuc_transport, kuch->kuc_msgtype);
880 if (kuch->kuc_msglen < sizeof(*kuch) + sizeof(*hal)) {
881 llapi_err_noerrno(LLAPI_MSG_ERROR, "Short HSM message %d",
887 /* Our message is a hsm_action_list. Use pointer math to skip
888 * kuch_hdr and point directly to the message payload.
890 hal = (struct hsm_action_list *)(kuch + 1);
892 /* Check that we have registered for this archive #
893 * if 0 registered, we serve any archive */
895 ((1 << (hal->hal_archive_id - 1)) & ct->archives) == 0) {
896 llapi_err_noerrno(LLAPI_MSG_INFO,
897 "This copytool does not service archive #%d,"
898 " ignoring this request."
899 " Mask of served archive is 0x%.8X",
900 hal->hal_archive_id, ct->archives);
906 *msgsize = kuch->kuc_msglen - sizeof(*kuch);
915 /** Get parent path from mount point and fid.
917 * \param mnt Filesystem root path.
918 * \param fid Object FID.
919 * \param parent Destination buffer.
920 * \param parent_len Destination buffer size.
921 * \return 0 on success.
923 static int fid_parent(const char *mnt, const lustre_fid *fid, char *parent,
928 long long recno = -1;
930 char strfid[FID_NOBRACE_LEN + 1];
933 snprintf(strfid, sizeof(strfid), DFID_NOBRACE, PFID(fid));
935 rc = llapi_fid2path(mnt, strfid, file, sizeof(file),
940 /* fid2path returns a relative path */
941 rc = snprintf(parent, parent_len, "%s/%s", mnt, file);
942 if (rc >= parent_len)
943 return -ENAMETOOLONG;
945 /* remove file name */
946 ptr = strrchr(parent, '/');
947 if (ptr == NULL || ptr == parent) {
957 static int ct_open_by_fid(const struct hsm_copytool_private *ct,
958 const struct lu_fid *fid, int open_flags)
960 char fid_name[FID_NOBRACE_LEN + 1];
963 snprintf(fid_name, sizeof(fid_name), DFID_NOBRACE, PFID(fid));
965 fd = openat(ct->open_by_fid_fd, fid_name, open_flags);
966 return fd < 0 ? -errno : fd;
970 * Get metadata attributes of file by FID.
972 * Use the IOC_MDC_GETFILEINFO ioctl (to send a MDS_GETATTR_NAME RPC)
973 * to get the attributes of the file identified by \a fid. This
974 * returns only the attributes stored on the MDT and avoids taking
975 * layout locks or accessing OST objects. It also bypasses the inode
976 * cache. Attributes are returned in \a st.
978 static int ct_md_getattr(const struct hsm_copytool_private *ct,
979 const struct lu_fid *fid,
982 struct lov_user_mds_data *lmd;
986 lmd_size = sizeof(lmd->lmd_st) +
987 lov_user_md_size(LOV_MAX_STRIPE_COUNT, LOV_USER_MAGIC_V3);
989 if (lmd_size < sizeof(lmd->lmd_st) + XATTR_SIZE_MAX)
990 lmd_size = sizeof(lmd->lmd_st) + XATTR_SIZE_MAX;
992 if (lmd_size < FID_NOBRACE_LEN + 1)
993 lmd_size = FID_NOBRACE_LEN + 1;
995 lmd = malloc(lmd_size);
999 snprintf((char *)lmd, lmd_size, DFID_NOBRACE, PFID(fid));
1001 rc = ioctl(ct->open_by_fid_fd, IOC_MDC_GETFILEINFO, lmd);
1004 llapi_error(LLAPI_MSG_ERROR, rc,
1005 "cannot get metadata attributes of "DFID" in '%s'",
1006 PFID(fid), ct->mnt);
1017 /** Create the destination volatile file for a restore operation.
1019 * \param hcp Private copyaction handle.
1020 * \param mdt_index MDT index where to create the volatile file.
1021 * \param flags Volatile file creation flags.
1022 * \return 0 on success.
1024 static int create_restore_volatile(struct hsm_copyaction_private *hcp,
1025 int mdt_index, int open_flags)
1029 char parent[PATH_MAX + 1];
1030 const char *mnt = hcp->ct_priv->mnt;
1031 struct hsm_action_item *hai = &hcp->copy.hc_hai;
1033 rc = fid_parent(mnt, &hai->hai_fid, parent, sizeof(parent));
1035 /* fid_parent() failed, try to keep on going */
1036 llapi_error(LLAPI_MSG_ERROR, rc,
1037 "cannot get parent path to restore "DFID" "
1038 "using '%s'", PFID(&hai->hai_fid), mnt);
1039 snprintf(parent, sizeof(parent), "%s", mnt);
1042 fd = llapi_create_volatile_idx(parent, mdt_index, open_flags);
1046 rc = fchown(fd, hcp->stat.st_uid, hcp->stat.st_gid);
1050 rc = llapi_fd2fid(fd, &hai->hai_dfid);
1065 /** Start processing an HSM action.
1066 * Should be called by copytools just before starting handling a request.
1067 * It could be skipped if copytool only want to directly report an error,
1068 * \see llapi_hsm_action_end().
1070 * \param hcp Opaque action handle to be passed to
1071 * llapi_hsm_action_progress and llapi_hsm_action_end.
1072 * \param ct Copytool handle acquired at registration.
1073 * \param hai The hsm_action_item describing the request.
1074 * \param restore_mdt_index On restore: MDT index where to create the volatile
1075 * file. Use -1 for default.
1076 * \param restore_open_flags On restore: volatile file creation mode. Use
1077 * O_LOV_DELAY_CREATE to manually set the LOVEA
1079 * \param is_error Whether this call is just to report an error.
1081 * \return 0 on success.
1083 int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
1084 const struct hsm_copytool_private *ct,
1085 const struct hsm_action_item *hai,
1086 int restore_mdt_index, int restore_open_flags,
1089 struct hsm_copyaction_private *hcp;
1092 hcp = calloc(1, sizeof(*hcp));
1098 hcp->copy.hc_hai = *hai;
1099 hcp->copy.hc_hai.hai_len = sizeof(*hai);
1104 if (hai->hai_action == HSMA_RESTORE) {
1105 rc = ct_md_getattr(hcp->ct_priv, &hai->hai_fid, &hcp->stat);
1109 rc = create_restore_volatile(hcp, restore_mdt_index,
1110 restore_open_flags);
1115 rc = ioctl(ct->mnt_fd, LL_IOC_HSM_COPY_START, &hcp->copy);
1121 llapi_hsm_log_ct_progress(&hcp, hai, CT_START, 0, 0);
1124 hcp->magic = CP_PRIV_MAGIC;
1129 if (!(hcp->data_fd < 0))
1130 close(hcp->data_fd);
1137 /** Terminate an HSM action processing.
1138 * Should be called by copytools just having finished handling the request.
1139 * \param hdl[in,out] Handle returned by llapi_hsm_action_start.
1140 * \param he[in] The final range of copied data (for copy actions).
1141 * \param errval[in] The status code of the operation.
1142 * \param flags[in] The flags about the termination status (HP_FLAG_RETRY if
1143 * the error is retryable).
1145 * \return 0 on success.
1147 int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
1148 const struct hsm_extent *he, int hp_flags, int errval)
1150 struct hsm_copyaction_private *hcp;
1151 struct hsm_action_item *hai;
1154 if (phcp == NULL || *phcp == NULL || he == NULL)
1159 if (hcp->magic != CP_PRIV_MAGIC)
1162 hai = &hcp->copy.hc_hai;
1164 if (hai->hai_action == HSMA_RESTORE && errval == 0) {
1165 struct ll_futimes_3 lfu = {
1166 .lfu_atime_sec = hcp->stat.st_atim.tv_sec,
1167 .lfu_atime_nsec = hcp->stat.st_atim.tv_nsec,
1168 .lfu_mtime_sec = hcp->stat.st_mtim.tv_sec,
1169 .lfu_mtime_nsec = hcp->stat.st_mtim.tv_nsec,
1170 .lfu_ctime_sec = hcp->stat.st_ctim.tv_sec,
1171 .lfu_ctime_nsec = hcp->stat.st_ctim.tv_nsec,
1174 /* Set {a,m,c}time of volatile file to that of original. */
1175 if (ioctl(hcp->data_fd, LL_IOC_FUTIMES_3, &lfu) < 0) {
1180 rc = fsync(hcp->data_fd);
1188 /* In some cases, like restore, 2 FIDs are used.
1189 * Set the right FID to use here. */
1190 if (hai->hai_action == HSMA_ARCHIVE || hai->hai_action == HSMA_RESTORE)
1191 hai->hai_fid = hai->hai_dfid;
1193 /* Fill the last missing data that will be needed by
1194 * kernel to send a hsm_progress. */
1195 hcp->copy.hc_flags = hp_flags;
1196 hcp->copy.hc_errval = abs(errval);
1198 hcp->copy.hc_hai.hai_extent = *he;
1200 rc = ioctl(hcp->ct_priv->mnt_fd, LL_IOC_HSM_COPY_END, &hcp->copy);
1206 llapi_hsm_log_ct_progress(&hcp, hai, CT_FINISH, 0, 0);
1209 if (!(hcp->data_fd < 0))
1210 close(hcp->data_fd);
1218 /** Notify a progress in processing an HSM action.
1219 * \param hdl[in,out] handle returned by llapi_hsm_action_start.
1220 * \param he[in] the range of copied data (for copy actions).
1221 * \param total[in] the expected total of copied data (for copy actions).
1222 * \param hp_flags[in] HSM progress flags.
1223 * \return 0 on success.
1225 int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
1226 const struct hsm_extent *he, __u64 total,
1230 struct hsm_progress hp;
1231 struct hsm_action_item *hai;
1233 if (hcp == NULL || he == NULL)
1236 if (hcp->magic != CP_PRIV_MAGIC)
1239 hai = &hcp->copy.hc_hai;
1241 memset(&hp, 0, sizeof(hp));
1243 hp.hp_cookie = hai->hai_cookie;
1244 hp.hp_flags = hp_flags;
1246 /* Progress is made on the data fid */
1247 hp.hp_fid = hai->hai_dfid;
1250 rc = ioctl(hcp->ct_priv->mnt_fd, LL_IOC_HSM_PROGRESS, &hp);
1254 llapi_hsm_log_ct_progress(&hcp, hai, CT_RUNNING, total, he->length);
1259 /** Get the fid of object to be used for copying data.
1260 * @return error code if the action is not a copy operation.
1262 int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
1265 const struct hsm_action_item *hai = &hcp->copy.hc_hai;
1267 if (hcp->magic != CP_PRIV_MAGIC)
1270 if (hai->hai_action != HSMA_RESTORE && hai->hai_action != HSMA_ARCHIVE)
1273 *fid = hai->hai_dfid;
1279 * Get a file descriptor to be used for copying data. It's up to the
1280 * caller to close the FDs obtained from this function.
1282 * @retval a file descriptor on success.
1283 * @retval a negative error code on failure.
1285 int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp)
1287 const struct hsm_action_item *hai = &hcp->copy.hc_hai;
1290 if (hcp->magic != CP_PRIV_MAGIC)
1293 if (hai->hai_action == HSMA_ARCHIVE) {
1294 return ct_open_by_fid(hcp->ct_priv, &hai->hai_dfid,
1295 O_RDONLY | O_NOATIME | O_NOFOLLOW | O_NONBLOCK);
1296 } else if (hai->hai_action == HSMA_RESTORE) {
1297 fd = dup(hcp->data_fd);
1298 return fd < 0 ? -errno : fd;
1305 * Import an existing hsm-archived file into Lustre.
1307 * Caller must access file by (returned) newfid value from now on.
1309 * \param dst path to Lustre destination (e.g. /mnt/lustre/my/file).
1310 * \param archive archive number.
1311 * \param st struct stat buffer containing file ownership, perm, etc.
1312 * \param stripe_* Striping options. Currently ignored, since the restore
1313 * operation will set the striping. In V2, this striping might
1315 * \param newfid[out] Filled with new Lustre fid.
1317 int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
1318 unsigned long long stripe_size, int stripe_offset,
1319 int stripe_count, int stripe_pattern, char *pool_name,
1322 struct hsm_user_import hui;
1326 if (stripe_pattern == 0)
1327 stripe_pattern = LOV_PATTERN_RAID0;
1329 /* Create a non-striped file */
1330 fd = llapi_file_open_pool(dst, O_CREAT | O_WRONLY, st->st_mode,
1331 stripe_size, stripe_offset, stripe_count,
1332 stripe_pattern | LOV_PATTERN_F_RELEASED,
1335 llapi_error(LLAPI_MSG_ERROR, fd,
1336 "cannot create '%s' for import", dst);
1340 /* Get the new fid in Lustre. Caller needs to use this fid
1342 rc = llapi_fd2fid(fd, newfid);
1344 llapi_error(LLAPI_MSG_ERROR, rc,
1345 "cannot get fid of '%s' for import", dst);
1349 hui.hui_uid = st->st_uid;
1350 hui.hui_gid = st->st_gid;
1351 hui.hui_mode = st->st_mode;
1352 hui.hui_size = st->st_size;
1353 hui.hui_archive_id = archive;
1354 hui.hui_atime = st->st_atime;
1355 hui.hui_atime_ns = st->st_atim.tv_nsec;
1356 hui.hui_mtime = st->st_mtime;
1357 hui.hui_mtime_ns = st->st_mtim.tv_nsec;
1358 rc = ioctl(fd, LL_IOC_HSM_IMPORT, &hui);
1361 llapi_error(LLAPI_MSG_ERROR, rc, "cannot import '%s'", dst);
1374 * Return the current HSM states and HSM requests related to file pointed by \a
1377 * \param hus Should be allocated by caller. Will be filled with current file
1380 * \retval 0 on success.
1381 * \retval -errno on error.
1383 int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus)
1387 rc = ioctl(fd, LL_IOC_HSM_STATE_GET, hus);
1388 /* If error, save errno value */
1389 rc = rc ? -errno : 0;
1395 * Return the current HSM states and HSM requests related to file pointed by \a
1398 * see llapi_hsm_state_get_fd() for args use and return
1400 int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus)
1405 fd = open(path, O_RDONLY | O_NONBLOCK);
1409 rc = llapi_hsm_state_get_fd(fd, hus);
1416 * Set HSM states of file pointed by \a fd
1418 * Using the provided bitmasks, the current HSM states for this file will be
1419 * changed. \a archive_id could be used to change the archive number also. Set
1420 * it to 0 if you do not want to change it.
1422 * \param setmask Bitmask for flag to be set.
1423 * \param clearmask Bitmask for flag to be cleared.
1424 * \param archive_id Archive number identifier to use. 0 means no change.
1426 * \retval 0 on success.
1427 * \retval -errno on error.
1429 int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
1432 struct hsm_state_set hss;
1435 hss.hss_valid = HSS_SETMASK|HSS_CLEARMASK;
1436 hss.hss_setmask = setmask;
1437 hss.hss_clearmask = clearmask;
1438 /* Change archive_id if provided. We can only change
1439 * to set something different than 0. */
1440 if (archive_id > 0) {
1441 hss.hss_valid |= HSS_ARCHIVE_ID;
1442 hss.hss_archive_id = archive_id;
1444 rc = ioctl(fd, LL_IOC_HSM_STATE_SET, &hss);
1445 /* If error, save errno value */
1446 rc = rc ? -errno : 0;
1452 * Set HSM states of file pointed by \a path.
1454 * see llapi_hsm_state_set_fd() for args use and return
1456 int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
1462 fd = open(path, O_WRONLY | O_LOV_DELAY_CREATE | O_NONBLOCK);
1466 rc = llapi_hsm_state_set_fd(fd, setmask, clearmask, archive_id);
1473 * Return the current HSM request related to file pointed by \a path.
1475 * \param hca Should be allocated by caller. Will be filled with current file
1478 * \retval 0 on success.
1479 * \retval -errno on error.
1481 int llapi_hsm_current_action(const char *path, struct hsm_current_action *hca)
1486 fd = open(path, O_RDONLY | O_NONBLOCK);
1490 rc = ioctl(fd, LL_IOC_HSM_ACTION, hca);
1491 /* If error, save errno value */
1492 rc = rc ? -errno : 0;
1499 * Allocate a hsm_user_request with the specified carateristics.
1500 * This structure should be freed with free().
1502 * \return an allocated structure on success, NULL otherwise.
1504 struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
1509 len += sizeof(struct hsm_user_request);
1510 len += sizeof(struct hsm_user_item) * itemcount;
1513 return (struct hsm_user_request *)malloc(len);
1517 * Send a HSM request to Lustre, described in \param request.
1519 * \param path Fullpath to the file to operate on.
1520 * \param request The request, allocated with llapi_hsm_user_request_alloc().
1522 * \return 0 on success, an error code otherwise.
1524 int llapi_hsm_request(const char *path, const struct hsm_user_request *request)
1529 rc = get_root_path(WANT_FD, NULL, &fd, (char *)path, -1);
1533 rc = ioctl(fd, LL_IOC_HSM_REQUEST, request);
1534 /* If error, save errno value */
1535 rc = rc ? -errno : 0;