lustre/utils/liblustreapi_hsm.c

   1 /*
   2  * LGPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * (C) Copyright 2012 Commissariat a l'energie atomique et aux energies
   7  *     alternatives
   8  *
   9  * Copyright (c) 2013, 2016, Intel Corporation.
  10  *
  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
  16  *
  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.
  21  *
  22  * LGPL HEADER END
  23  */
  24 /*
  25  * lustre/utils/liblustreapi_hsm.c
  26  *
  27  * lustreapi library for hsm calls
  28  *
  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>
  33  */
  34
  35 #include <fcntl.h>
  36 #include <stdlib.h>
  37 #include <stdio.h>
  38 #include <string.h>
  39 #include <stddef.h>
  40 #include <sys/ioctl.h>
  41 #include <unistd.h>
  42 #include <malloc.h>
  43 #include <errno.h>
  44 #include <dirent.h>
  45 #include <stdarg.h>
  46 #include <sys/stat.h>
  47 #include <sys/time.h>
  48 #include <sys/types.h>
  49 #include <time.h>
  50 #include <utime.h>
  51 #include <sys/syscall.h>
  52 #include <fnmatch.h>
  53 #include <signal.h>
  54 #ifdef HAVE_LINUX_UNISTD_H
  55 #include <linux/unistd.h>
  56 #else
  57 #include <unistd.h>
  58 #endif
  59
  60 #include <linux/lnet/lnetctl.h>
  61 #include <lustre/lustreapi.h>
  62 #include "lustreapi_internal.h"
  63
  64 #define OPEN_BY_FID_PATH dot_lustre_name"/fid"
  65
  66 /****** HSM Copytool API ********/
  67 #define CT_PRIV_MAGIC 0xC0BE2001
  68 struct hsm_copytool_private {
  69         int                      magic;
  70         char                    *mnt;
  71         struct kuc_hdr          *kuch;
  72         int                      mnt_fd;
  73         int                      open_by_fid_fd;
  74         struct lustre_kernelcomm kuc;
  75         __u32                    archives;
  76 };
  77
  78 #define CP_PRIV_MAGIC 0x19880429
  79 struct hsm_copyaction_private {
  80         __u32                                    magic;
  81         __s32                                    data_fd;
  82         const struct hsm_copytool_private       *ct_priv;
  83         struct hsm_copy                          copy;
  84         lstat_t                                  stat;
  85 };
  86
  87 enum ct_progress_type {
  88         CT_START        = 0,
  89         CT_RUNNING      = 50,
  90         CT_FINISH       = 100,
  91         CT_CANCEL       = 150,
  92         CT_ERROR        = 175
  93 };
  94
  95 enum ct_event {
  96         CT_REGISTER             = 1,
  97         CT_UNREGISTER           = 2,
  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,
 113         CT_EVENT_MAX
 114 };
 115
 116 /* initialized in llapi_hsm_register_event_fifo() */
 117 static int llapi_hsm_event_fd = -1;
 118 static bool created_hsm_event_fifo;
 119
 120 static inline const char *llapi_hsm_ct_ev2str(int type)
 121 {
 122         switch (type) {
 123         case CT_REGISTER:
 124                 return "REGISTER";
 125         case CT_UNREGISTER:
 126                 return "UNREGISTER";
 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";
 157         default:
 158                 llapi_err_noerrno(LLAPI_MSG_ERROR,
 159                                   "Unknown event type: %d", type);
 160                 return NULL;
 161         }
 162 }
 163
 164 /**
 165  * Writes a JSON event to the monitor FIFO. Noop if no FIFO has been
 166  * registered.
 167  *
 168  * \param event              A list of llapi_json_items comprising a
 169  *                           single JSON-formatted event.
 170  *
 171  * \retval 0 on success.
 172  * \retval -errno on error.
 173  */
 174 static int llapi_hsm_write_json_event(struct llapi_json_item_list **event)
 175 {
 176         int                             rc;
 177         char                            time_string[40];
 178         char                            json_buf[PIPE_BUF];
 179         FILE                            *buf_file;
 180         time_t                          event_time = time(0);
 181         struct tm                       time_components;
 182         struct llapi_json_item_list     *json_items;
 183
 184         /* Noop unless the event fd was initialized */
 185         if (llapi_hsm_event_fd < 0)
 186                 return 0;
 187
 188         if (event == NULL || *event == NULL)
 189                 return -EINVAL;
 190
 191         json_items = *event;
 192
 193         localtime_r(&event_time, &time_components);
 194
 195         if (strftime(time_string, sizeof(time_string), "%Y-%m-%d %T %z",
 196                      &time_components) == 0) {
 197                 rc = -EINVAL;
 198                 llapi_error(LLAPI_MSG_ERROR, rc, "strftime() failed");
 199                 return rc;
 200         }
 201
 202         rc = llapi_json_add_item(&json_items, "event_time", LLAPI_JSON_STRING,
 203                                  time_string);
 204         if (rc < 0) {
 205                 llapi_error(LLAPI_MSG_ERROR, -rc, "error in "
 206                             "llapi_json_add_item()");
 207                 return rc;
 208         }
 209
 210         buf_file = fmemopen(json_buf, sizeof(json_buf), "w");
 211         if (buf_file == NULL)
 212                 return -errno;
 213
 214         rc = llapi_json_write_list(event, buf_file);
 215         if (rc < 0) {
 216                 fclose(buf_file);
 217                 return rc;
 218         }
 219
 220         fclose(buf_file);
 221
 222         if (write(llapi_hsm_event_fd, json_buf, strlen(json_buf)) < 0) {
 223                 /* Ignore write failures due to missing reader. */
 224                 if (errno != EPIPE)
 225                         return -errno;
 226         }
 227
 228         return 0;
 229 }
 230
 231 /**
 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.
 235  *
 236  * \param priv               Opaque private control structure.
 237  * \param event_type         The type of event (register or unregister).
 238  *
 239  * \retval 0 on success.
 240  * \retval -errno on error.
 241  */
 242 static int llapi_hsm_log_ct_registration(struct hsm_copytool_private **priv,
 243                                          __u32 event_type)
 244 {
 245         int                             rc;
 246         char                            agent_uuid[UUID_MAX];
 247         struct hsm_copytool_private     *ct;
 248         struct llapi_json_item_list     *json_items;
 249
 250         /* Noop unless the event fd was initialized */
 251         if (llapi_hsm_event_fd < 0)
 252                 return 0;
 253
 254         if (priv == NULL || *priv == NULL)
 255                 return -EINVAL;
 256
 257         ct = *priv;
 258         if (ct->magic != CT_PRIV_MAGIC)
 259                 return -EINVAL;
 260
 261         if (event_type != CT_REGISTER && event_type != CT_UNREGISTER)
 262                 return -EINVAL;
 263
 264         rc = llapi_json_init_list(&json_items);
 265         if (rc < 0)
 266                 goto err;
 267
 268         rc = llapi_get_agent_uuid(ct->mnt, agent_uuid, sizeof(agent_uuid));
 269         if (rc < 0)
 270                 goto err;
 271         llapi_chomp_string(agent_uuid);
 272
 273         rc = llapi_json_add_item(&json_items, "uuid", LLAPI_JSON_STRING,
 274                                  agent_uuid);
 275         if (rc < 0)
 276                 goto err;
 277
 278         rc = llapi_json_add_item(&json_items, "mount_point", LLAPI_JSON_STRING,
 279                                  ct->mnt);
 280         if (rc < 0)
 281                 goto err;
 282
 283         rc = llapi_json_add_item(&json_items, "archive", LLAPI_JSON_INTEGER,
 284                                  &ct->archives);
 285         if (rc < 0)
 286                 goto err;
 287
 288         rc = llapi_json_add_item(&json_items, "event_type", LLAPI_JSON_STRING,
 289                                  (char *)llapi_hsm_ct_ev2str(event_type));
 290         if (rc < 0)
 291                 goto err;
 292
 293         rc = llapi_hsm_write_json_event(&json_items);
 294         if (rc < 0)
 295                 goto err;
 296
 297         goto out_free;
 298
 299 err:
 300         llapi_error(LLAPI_MSG_ERROR, rc, "error in "
 301                     "llapi_hsm_log_ct_registration()");
 302
 303 out_free:
 304         if (json_items != NULL)
 305                 llapi_json_destroy_list(&json_items);
 306
 307         return rc;
 308 }
 309
 310 /**
 311  * Given a copytool progress update, construct a JSON event suitable for
 312  * consumption by a copytool monitoring process.
 313  *
 314  * Examples of various events generated here and written by
 315  * llapi_hsm_write_json_event:
 316  *
 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"}
 324  *
 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"}
 335  *
 336  * A log message:
 337  * {"event_time": "2014-02-26 14:50:13 -0500", "event_type": "LOGGED_MESSAGE",
 338  *  "level": "INFO",
 339  *  "message": "lhsmtool_posix[42]: copytool fs=lustre archive#=2 item_count=1"}
 340  *
 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.
 347  *
 348  * \retval 0 on success.
 349  * \retval -errno on error.
 350  */
 351 static int llapi_hsm_log_ct_progress(struct hsm_copyaction_private **phcp,
 352                                      const struct hsm_action_item *hai,
 353                                      __u32 progress_type,
 354                                      __u64 total, __u64 current)
 355 {
 356         int                             rc;
 357         int                             linkno = 0;
 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;
 363
 364         /* Noop unless the event fd was initialized */
 365         if (llapi_hsm_event_fd < 0)
 366                 return 0;
 367
 368         if (phcp == NULL || *phcp == NULL)
 369                 return -EINVAL;
 370
 371         hcp = *phcp;
 372
 373         rc = llapi_json_init_list(&json_items);
 374         if (rc < 0)
 375                 goto err;
 376
 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);
 380         if (rc < 0)
 381                 goto err;
 382
 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);
 386         if (rc < 0)
 387                 goto err;
 388
 389         if (hcp->copy.hc_errval == ECANCELED) {
 390                 progress_type = CT_CANCEL;
 391                 goto cancel;
 392         }
 393
 394         if (hcp->copy.hc_errval != 0) {
 395                 progress_type = CT_ERROR;
 396
 397                 rc = llapi_json_add_item(&json_items, "errno",
 398                                          LLAPI_JSON_INTEGER,
 399                                          &hcp->copy.hc_errval);
 400                 if (rc < 0)
 401                         goto err;
 402
 403                 rc = llapi_json_add_item(&json_items, "error",
 404                                          LLAPI_JSON_STRING,
 405                                          strerror(hcp->copy.hc_errval));
 406                 if (rc < 0)
 407                         goto err;
 408
 409                 goto cancel;
 410         }
 411
 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);
 417                 if (rc < 0)
 418                         goto err;
 419
 420                 rc = llapi_json_add_item(&json_items, "lustre_path",
 421                                          LLAPI_JSON_STRING, lustre_path);
 422                 if (rc < 0)
 423                         goto err;
 424
 425                 rc = llapi_json_add_item(&json_items, "total_bytes",
 426                                          LLAPI_JSON_BIGNUM, &total);
 427                 if (rc < 0)
 428                         goto err;
 429         }
 430
 431         if (progress_type == CT_RUNNING) {
 432                 rc = llapi_json_add_item(&json_items, "current_bytes",
 433                                          LLAPI_JSON_BIGNUM, &current);
 434                 if (rc < 0)
 435                         goto err;
 436         }
 437
 438 cancel:
 439         rc = llapi_json_add_item(&json_items, "event_type", LLAPI_JSON_STRING,
 440                                  (char *)llapi_hsm_ct_ev2str(hai->hai_action +
 441                                                              progress_type));
 442         if (rc < 0)
 443                 goto err;
 444
 445         rc = llapi_hsm_write_json_event(&json_items);
 446         if (rc < 0)
 447                 goto err;
 448
 449         goto out_free;
 450
 451 err:
 452         llapi_error(LLAPI_MSG_ERROR, rc, "error in "
 453                     "llapi_hsm_log_ct_progress()");
 454
 455 out_free:
 456         if (json_items != NULL)
 457                 llapi_json_destroy_list(&json_items);
 458
 459         return rc;
 460 }
 461
 462 /**
 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
 466  * are lost.
 467  *
 468  * \param path               Path to monitor FIFO.
 469  *
 470  * \retval 0 on success.
 471  * \retval -errno on error.
 472  */
 473 int llapi_hsm_register_event_fifo(const char *path)
 474 {
 475         int read_fd;
 476         struct stat statbuf;
 477         struct sigaction ignore_action;
 478         int rc;
 479
 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);
 483                 return -errno;
 484         }
 485         if (errno == EEXIST) {
 486                 if (stat(path, &statbuf) < 0) {
 487                         llapi_error(LLAPI_MSG_ERROR, errno, "mkfifo(%s) failed",
 488                                     path);
 489                         return -errno;
 490                 }
 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);
 495                         return -errno;
 496                 }
 497         } else {
 498                 created_hsm_event_fifo = true;
 499         }
 500
 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);
 504         if (read_fd < 0) {
 505                 llapi_error(LLAPI_MSG_ERROR, errno,
 506                             "cannot open(%s) for read", path);
 507                 return -errno;
 508         }
 509
 510         /* Open the FIFO for writes, but don't block on waiting
 511          * for a reader. */
 512         llapi_hsm_event_fd = open(path, O_WRONLY | O_NONBLOCK);
 513         rc = -errno;
 514
 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! */
 518         close(read_fd);
 519
 520         if (llapi_hsm_event_fd < 0) {
 521                 llapi_error(LLAPI_MSG_ERROR, -rc,
 522                             "cannot open(%s) for write", path);
 523                 return rc;
 524         }
 525
 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);
 531
 532         return 0;
 533 }
 534
 535 /**
 536  * Given a path to a FIFO, close its filehandle and delete the FIFO.
 537  *
 538  * \param path               Path to monitor FIFO.
 539  *
 540  * \retval 0 on success.
 541  * \retval -errno on error.
 542  */
 543 int llapi_hsm_unregister_event_fifo(const char *path)
 544 {
 545         /* Noop unless the event fd was initialized */
 546         if (llapi_hsm_event_fd < 0)
 547                 return 0;
 548
 549         if (close(llapi_hsm_event_fd) < 0)
 550                 return -errno;
 551
 552         if (created_hsm_event_fifo) {
 553                 unlink(path);
 554                 created_hsm_event_fifo = false;
 555         }
 556
 557         llapi_hsm_event_fd = -1;
 558
 559         return 0;
 560 }
 561
 562 /**
 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.
 566  *
 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.
 571  *
 572  * \retval None.
 573  */
 574 void llapi_hsm_log_error(enum llapi_message_level level, int _rc,
 575                          const char *fmt, va_list args)
 576 {
 577         int                             rc;
 578         int                             msg_len;
 579         int                             real_level;
 580         char                            *msg = NULL;
 581         va_list                         args2;
 582         struct llapi_json_item_list     *json_items;
 583
 584         /* Noop unless the event fd was initialized */
 585         if (llapi_hsm_event_fd < 0)
 586                 return;
 587
 588         rc = llapi_json_init_list(&json_items);
 589         if (rc < 0)
 590                 goto err;
 591
 592         if ((level & LLAPI_MSG_NO_ERRNO) == 0) {
 593                 rc = llapi_json_add_item(&json_items, "errno",
 594                                          LLAPI_JSON_INTEGER,
 595                                          &_rc);
 596                 if (rc < 0)
 597                         goto err;
 598
 599                 rc = llapi_json_add_item(&json_items, "error",
 600                                          LLAPI_JSON_STRING,
 601                                          strerror(abs(_rc)));
 602                 if (rc < 0)
 603                         goto err;
 604         }
 605
 606         va_copy(args2, args);
 607         msg_len = vsnprintf(NULL, 0, fmt, args2) + 1;
 608         va_end(args2);
 609         if (msg_len >= 0) {
 610                 msg = (char *) alloca(msg_len);
 611                 if (msg == NULL) {
 612                         rc = -ENOMEM;
 613                         goto err;
 614                 }
 615
 616                 rc = vsnprintf(msg, msg_len, fmt, args);
 617                 if (rc < 0)
 618                         goto err;
 619
 620                 rc = llapi_json_add_item(&json_items, "message",
 621                                          LLAPI_JSON_STRING,
 622                                          msg);
 623                 if (rc < 0)
 624                         goto err;
 625         } else {
 626                 rc = llapi_json_add_item(&json_items, "message",
 627                                          LLAPI_JSON_STRING,
 628                                          "INTERNAL ERROR: message failed");
 629                 if (rc < 0)
 630                         goto err;
 631         }
 632
 633         real_level = level & LLAPI_MSG_NO_ERRNO;
 634         real_level = real_level > 0 ? level - LLAPI_MSG_NO_ERRNO : level;
 635
 636         rc = llapi_json_add_item(&json_items, "level", LLAPI_JSON_STRING,
 637                                  (void *)llapi_msg_level2str(real_level));
 638         if (rc < 0)
 639                 goto err;
 640
 641         rc = llapi_json_add_item(&json_items, "event_type", LLAPI_JSON_STRING,
 642                                  "LOGGED_MESSAGE");
 643         if (rc < 0)
 644                 goto err;
 645
 646         rc = llapi_hsm_write_json_event(&json_items);
 647         if (rc < 0)
 648                 goto err;
 649
 650         goto out_free;
 651
 652 err:
 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);
 656
 657 out_free:
 658         if (json_items != NULL)
 659                 llapi_json_destroy_list(&json_items);
 660
 661         return;
 662 }
 663
 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
 669  *                              responsible for
 670  * \param rfd_flags             flags applied to read fd of pipe
 671  *                              (e.g. O_NONBLOCK)
 672  *
 673  * \retval 0 on success.
 674  * \retval -errno on error.
 675  */
 676 int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
 677                                 const char *mnt, int archive_count,
 678                                 int *archives, int rfd_flags)
 679 {
 680         struct hsm_copytool_private     *ct;
 681         int                              rc;
 682
 683         if (archive_count > 0 && archives == NULL) {
 684                 llapi_err_noerrno(LLAPI_MSG_ERROR,
 685                                   "NULL archive numbers");
 686                 return -EINVAL;
 687         }
 688
 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,
 692                                   LL_HSM_MAX_ARCHIVE);
 693                 return -EINVAL;
 694         }
 695
 696         ct = calloc(1, sizeof(*ct));
 697         if (ct == NULL)
 698                 return -ENOMEM;
 699
 700         ct->magic = CT_PRIV_MAGIC;
 701         ct->mnt_fd = -1;
 702         ct->open_by_fid_fd = -1;
 703         ct->kuc.lk_rfd = LK_NOFD;
 704         ct->kuc.lk_wfd = LK_NOFD;
 705
 706         ct->mnt = strdup(mnt);
 707         if (ct->mnt == NULL) {
 708                 rc = -ENOMEM;
 709                 goto out_err;
 710         }
 711
 712         ct->kuch = malloc(HAL_MAXSIZE + sizeof(*ct->kuch));
 713         if (ct->kuch == NULL) {
 714                 rc = -ENOMEM;
 715                 goto out_err;
 716         }
 717
 718         ct->mnt_fd = open(ct->mnt, O_RDONLY);
 719         if (ct->mnt_fd < 0) {
 720                 rc = -errno;
 721                 goto out_err;
 722         }
 723
 724         ct->open_by_fid_fd = openat(ct->mnt_fd, OPEN_BY_FID_PATH, O_RDONLY);
 725         if (ct->open_by_fid_fd < 0) {
 726                 rc = -errno;
 727                 goto out_err;
 728         }
 729
 730         /* no archives specified means "match all". */
 731         ct->archives = 0;
 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);
 737                         rc = -EINVAL;
 738                         goto out_err;
 739                 }
 740                 /* in the list we have an all archive wildcard
 741                  * so move to all archives mode
 742                  */
 743                 if (archives[rc] == 0) {
 744                         ct->archives = 0;
 745                         archive_count = 0;
 746                         break;
 747                 }
 748                 ct->archives |= (1 << (archives[rc] - 1));
 749         }
 750
 751         rc = libcfs_ukuc_start(&ct->kuc, KUC_GRP_HSM, rfd_flags);
 752         if (rc < 0)
 753                 goto out_err;
 754
 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);
 758         if (rc < 0) {
 759                 rc = -errno;
 760                 llapi_error(LLAPI_MSG_ERROR, rc,
 761                             "cannot start copytool on '%s'", mnt);
 762                 goto out_kuc;
 763         }
 764
 765         llapi_hsm_log_ct_registration(&ct, CT_REGISTER);
 766
 767         /* Only the kernel reference keeps the write side open */
 768         close(ct->kuc.lk_wfd);
 769         ct->kuc.lk_wfd = LK_NOFD;
 770         *priv = ct;
 771
 772         return 0;
 773
 774 out_kuc:
 775         /* cleanup the kuc channel */
 776         libcfs_ukuc_stop(&ct->kuc);
 777
 778 out_err:
 779         if (!(ct->mnt_fd < 0))
 780                 close(ct->mnt_fd);
 781
 782         if (!(ct->open_by_fid_fd < 0))
 783                 close(ct->open_by_fid_fd);
 784
 785         free(ct->mnt);
 786
 787         free(ct->kuch);
 788
 789         free(ct);
 790
 791         return rc;
 792 }
 793
 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.
 798  */
 799 int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv)
 800 {
 801         struct hsm_copytool_private *ct;
 802
 803         if (priv == NULL || *priv == NULL)
 804                 return -EINVAL;
 805
 806         ct = *priv;
 807         if (ct->magic != CT_PRIV_MAGIC)
 808                 return -EINVAL;
 809
 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);
 816
 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);
 820
 821         llapi_hsm_log_ct_registration(&ct, CT_UNREGISTER);
 822
 823         close(ct->open_by_fid_fd);
 824         close(ct->mnt_fd);
 825         free(ct->mnt);
 826         free(ct->kuch);
 827         free(ct);
 828         *priv = NULL;
 829
 830         return 0;
 831 }
 832
 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
 837  */
 838 int llapi_hsm_copytool_get_fd(struct hsm_copytool_private *ct)
 839 {
 840         if (ct == NULL || ct->magic != CT_PRIV_MAGIC)
 841                 return -EINVAL;
 842
 843         return libcfs_ukuc_get_rfd(&ct->kuc);
 844 }
 845
 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
 851  *         <0 error code
 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.
 854  */
 855 int llapi_hsm_copytool_recv(struct hsm_copytool_private *ct,
 856                             struct hsm_action_list **halh, int *msgsize)
 857 {
 858         struct kuc_hdr          *kuch;
 859         struct hsm_action_list  *hal;
 860         int                      rc = 0;
 861
 862         if (ct == NULL || ct->magic != CT_PRIV_MAGIC)
 863                 return -EINVAL;
 864
 865         if (halh == NULL || msgsize == NULL)
 866                 return -EINVAL;
 867
 868         kuch = ct->kuch;
 869
 870 repeat:
 871         rc = libcfs_ukuc_msg_get(&ct->kuc, (char *)kuch,
 872                                  HAL_MAXSIZE + sizeof(*kuch),
 873                                  KUC_TRANSPORT_HSM);
 874         if (rc < 0)
 875                 goto out_err;
 876
 877         /* Handle generic messages */
 878         if (kuch->kuc_transport == KUC_TRANSPORT_GENERIC &&
 879             kuch->kuc_msgtype == KUC_MSG_SHUTDOWN) {
 880                 rc = -ESHUTDOWN;
 881                 goto out_err;
 882         }
 883
 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);
 889                 rc = -EPROTO;
 890                 goto out_err;
 891         }
 892
 893         if (kuch->kuc_msglen < sizeof(*kuch) + sizeof(*hal)) {
 894                 llapi_err_noerrno(LLAPI_MSG_ERROR, "Short HSM message %d",
 895                                   kuch->kuc_msglen);
 896                 rc = -EPROTO;
 897                 goto out_err;
 898         }
 899
 900         /* Our message is a hsm_action_list. Use pointer math to skip
 901         * kuch_hdr and point directly to the message payload.
 902         */
 903         hal = (struct hsm_action_list *)(kuch + 1);
 904
 905         /* Check that we have registered for this archive #
 906          * if 0 registered, we serve any archive */
 907         if (ct->archives &&
 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);
 914
 915                 goto repeat;
 916         }
 917
 918         *halh = hal;
 919         *msgsize = kuch->kuc_msglen - sizeof(*kuch);
 920         return 0;
 921
 922 out_err:
 923         *halh = NULL;
 924         *msgsize = 0;
 925         return rc;
 926 }
 927
 928 /** Get parent path from mount point and fid.
 929  *
 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.
 935  */
 936 static int fid_parent(const char *mnt, const struct lu_fid *fid, char *parent,
 937                       size_t parent_len)
 938 {
 939         int              rc;
 940         int              linkno = 0;
 941         long long        recno = -1;
 942         char             file[PATH_MAX];
 943         char             strfid[FID_NOBRACE_LEN + 1];
 944         char            *ptr;
 945
 946         snprintf(strfid, sizeof(strfid), DFID_NOBRACE, PFID(fid));
 947
 948         rc = llapi_fid2path(mnt, strfid, file, sizeof(file),
 949                             &recno, &linkno);
 950         if (rc < 0)
 951                 return rc;
 952
 953         /* fid2path returns a relative path */
 954         rc = snprintf(parent, parent_len, "%s/%s", mnt, file);
 955         if (rc >= parent_len)
 956                 return -ENAMETOOLONG;
 957
 958         /* remove file name */
 959         ptr = strrchr(parent, '/');
 960         if (ptr == NULL || ptr == parent) {
 961                 rc = -EINVAL;
 962         } else {
 963                 *ptr = '\0';
 964                 rc = 0;
 965         }
 966
 967         return rc;
 968 }
 969
 970 static int ct_open_by_fid(const struct hsm_copytool_private *ct,
 971                           const struct lu_fid *fid, int open_flags)
 972 {
 973         char fid_name[FID_NOBRACE_LEN + 1];
 974         int fd;
 975
 976         snprintf(fid_name, sizeof(fid_name), DFID_NOBRACE, PFID(fid));
 977
 978         fd = openat(ct->open_by_fid_fd, fid_name, open_flags);
 979         return fd < 0 ? -errno : fd;
 980 }
 981
 982 /**
 983  * Get metadata attributes of file by FID.
 984  *
 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.
 990  */
 991 static int ct_md_getattr(const struct hsm_copytool_private *ct,
 992                          const struct lu_fid *fid,
 993                          lstat_t *st)
 994 {
 995         struct lov_user_mds_data *lmd;
 996         size_t lmd_size;
 997         int rc;
 998
 999         lmd_size = sizeof(lmd->lmd_st) +
1000                 lov_user_md_size(LOV_MAX_STRIPE_COUNT, LOV_USER_MAGIC_V3);
1001
1002         if (lmd_size < sizeof(lmd->lmd_st) + XATTR_SIZE_MAX)
1003                 lmd_size = sizeof(lmd->lmd_st) + XATTR_SIZE_MAX;
1004
1005         if (lmd_size < FID_NOBRACE_LEN + 1)
1006                 lmd_size = FID_NOBRACE_LEN + 1;
1007
1008         lmd = malloc(lmd_size);
1009         if (lmd == NULL)
1010                 return -ENOMEM;
1011
1012         snprintf((char *)lmd, lmd_size, DFID_NOBRACE, PFID(fid));
1013
1014         rc = ioctl(ct->open_by_fid_fd, IOC_MDC_GETFILEINFO, lmd);
1015         if (rc != 0) {
1016                 rc = -errno;
1017                 llapi_error(LLAPI_MSG_ERROR, rc,
1018                             "cannot get metadata attributes of "DFID" in '%s'",
1019                             PFID(fid), ct->mnt);
1020                 goto out;
1021         }
1022
1023         *st = lmd->lmd_st;
1024 out:
1025         free(lmd);
1026
1027         return rc;
1028 }
1029
1030 /** Create the destination volatile file for a restore operation.
1031  *
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.
1036  */
1037 static int create_restore_volatile(struct hsm_copyaction_private *hcp,
1038                                    int mdt_index, int open_flags)
1039 {
1040         int                      rc;
1041         int                      fd;
1042         char                     parent[PATH_MAX + 1];
1043         const char              *mnt = hcp->ct_priv->mnt;
1044         struct hsm_action_item  *hai = &hcp->copy.hc_hai;
1045
1046         rc = fid_parent(mnt, &hai->hai_fid, parent, sizeof(parent));
1047         if (rc < 0) {
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);
1053         }
1054
1055         fd = llapi_create_volatile_idx(parent, mdt_index, open_flags);
1056         if (fd < 0)
1057                 return fd;
1058
1059         rc = fchown(fd, hcp->stat.st_uid, hcp->stat.st_gid);
1060         if (rc < 0)
1061                 goto err_cleanup;
1062
1063         rc = llapi_fd2fid(fd, &hai->hai_dfid);
1064         if (rc < 0)
1065                 goto err_cleanup;
1066
1067         hcp->data_fd = fd;
1068
1069         return 0;
1070
1071 err_cleanup:
1072         hcp->data_fd = -1;
1073         close(fd);
1074
1075         return rc;
1076 }
1077
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().
1082  *
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
1091  *                           afterwards.
1092  * \param is_error           Whether this call is just to report an error.
1093  *
1094  * \return 0 on success.
1095  */
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,
1100                            bool is_error)
1101 {
1102         struct hsm_copyaction_private   *hcp;
1103         int                              rc;
1104
1105         hcp = calloc(1, sizeof(*hcp));
1106         if (hcp == NULL)
1107                 return -ENOMEM;
1108
1109         hcp->data_fd = -1;
1110         hcp->ct_priv = ct;
1111         hcp->copy.hc_hai = *hai;
1112         hcp->copy.hc_hai.hai_len = sizeof(*hai);
1113
1114         if (is_error)
1115                 goto ok_out;
1116
1117         if (hai->hai_action == HSMA_RESTORE) {
1118                 rc = ct_md_getattr(hcp->ct_priv, &hai->hai_fid, &hcp->stat);
1119                 if (rc < 0)
1120                         goto err_out;
1121
1122                 rc = create_restore_volatile(hcp, restore_mdt_index,
1123                                              restore_open_flags);
1124                 if (rc < 0)
1125                         goto err_out;
1126         }
1127
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)
1131                 goto out_log;
1132
1133         rc = ioctl(ct->mnt_fd, LL_IOC_HSM_COPY_START, &hcp->copy);
1134         if (rc < 0) {
1135                 rc = -errno;
1136                 goto err_out;
1137         }
1138
1139 out_log:
1140         llapi_hsm_log_ct_progress(&hcp, hai, CT_START, 0, 0);
1141
1142 ok_out:
1143         hcp->magic = CP_PRIV_MAGIC;
1144         *phcp = hcp;
1145         return 0;
1146
1147 err_out:
1148         if (!(hcp->data_fd < 0))
1149                 close(hcp->data_fd);
1150
1151         free(hcp);
1152
1153         return rc;
1154 }
1155
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).
1163  *
1164  * \return 0 on success.
1165  */
1166 int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
1167                          const struct hsm_extent *he, int hp_flags, int errval)
1168 {
1169         struct hsm_copyaction_private   *hcp;
1170         struct hsm_action_item          *hai;
1171         int                              rc;
1172
1173         if (phcp == NULL || *phcp == NULL || he == NULL)
1174                 return -EINVAL;
1175
1176         hcp = *phcp;
1177
1178         if (hcp->magic != CP_PRIV_MAGIC)
1179                 return -EINVAL;
1180
1181         hai = &hcp->copy.hc_hai;
1182
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,
1191                 };
1192
1193                 rc = fsync(hcp->data_fd);
1194                 if (rc < 0) {
1195                         errval = -errno;
1196                         goto end;
1197                 }
1198
1199                 /* Set {a,m,c}time of volatile file to that of original. */
1200                 rc = ioctl(hcp->data_fd, LL_IOC_FUTIMES_3, &lfu);
1201                 if (rc < 0) {
1202                         errval = -errno;
1203                         goto end;
1204                 }
1205         }
1206
1207 end:
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;
1212
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);
1217
1218         hcp->copy.hc_hai.hai_extent = *he;
1219
1220         rc = ioctl(hcp->ct_priv->mnt_fd, LL_IOC_HSM_COPY_END, &hcp->copy);
1221         if (rc) {
1222                 rc = -errno;
1223                 goto err_cleanup;
1224         }
1225
1226         llapi_hsm_log_ct_progress(&hcp, hai, CT_FINISH, 0, 0);
1227
1228 err_cleanup:
1229         if (!(hcp->data_fd < 0))
1230                 close(hcp->data_fd);
1231
1232         free(hcp);
1233         *phcp = NULL;
1234
1235         return rc;
1236 }
1237
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.
1244  */
1245 int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
1246                               const struct hsm_extent *he, __u64 total,
1247                               int hp_flags)
1248 {
1249         int                      rc;
1250         struct hsm_progress      hp;
1251         struct hsm_action_item  *hai;
1252
1253         if (hcp == NULL || he == NULL)
1254                 return -EINVAL;
1255
1256         if (hcp->magic != CP_PRIV_MAGIC)
1257                 return -EINVAL;
1258
1259         hai = &hcp->copy.hc_hai;
1260
1261         memset(&hp, 0, sizeof(hp));
1262
1263         hp.hp_cookie = hai->hai_cookie;
1264         hp.hp_flags  = hp_flags;
1265
1266         /* Progress is made on the data fid */
1267         hp.hp_fid = hai->hai_dfid;
1268         hp.hp_extent = *he;
1269
1270         rc = ioctl(hcp->ct_priv->mnt_fd, LL_IOC_HSM_PROGRESS, &hp);
1271         if (rc < 0)
1272                 rc = -errno;
1273
1274         llapi_hsm_log_ct_progress(&hcp, hai, CT_RUNNING, total, he->length);
1275
1276         return rc;
1277 }
1278
1279 /** Get the fid of object to be used for copying data.
1280  * @return error code if the action is not a copy operation.
1281  */
1282 int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
1283                               struct lu_fid *fid)
1284 {
1285         const struct hsm_action_item    *hai = &hcp->copy.hc_hai;
1286
1287         if (hcp->magic != CP_PRIV_MAGIC)
1288                 return -EINVAL;
1289
1290         if (hai->hai_action != HSMA_RESTORE && hai->hai_action != HSMA_ARCHIVE)
1291                 return -EINVAL;
1292
1293         *fid = hai->hai_dfid;
1294
1295         return 0;
1296 }
1297
1298 /**
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.
1301  *
1302  * @retval a file descriptor on success.
1303  * @retval a negative error code on failure.
1304  */
1305 int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp)
1306 {
1307         const struct hsm_action_item    *hai = &hcp->copy.hc_hai;
1308         int fd;
1309
1310         if (hcp->magic != CP_PRIV_MAGIC)
1311                 return -EINVAL;
1312
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;
1319         } else {
1320                 return -EINVAL;
1321         }
1322 }
1323
1324 /**
1325  * Import an existing hsm-archived file into Lustre.
1326  *
1327  * Caller must access file by (returned) newfid value from now on.
1328  *
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
1334  *                 be used.
1335  * \param newfid[out] Filled with new Lustre fid.
1336  */
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,
1340                      struct lu_fid *newfid)
1341 {
1342         struct hsm_user_import   hui;
1343         int                      fd;
1344         int                      rc = 0;
1345
1346         if (stripe_pattern == 0)
1347                 stripe_pattern = LOV_PATTERN_RAID0;
1348
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,
1353                                   pool_name);
1354         if (fd < 0) {
1355                 llapi_error(LLAPI_MSG_ERROR, fd,
1356                             "cannot create '%s' for import", dst);
1357                 return fd;
1358         }
1359
1360         /* Get the new fid in Lustre. Caller needs to use this fid
1361            from now on. */
1362         rc = llapi_fd2fid(fd, newfid);
1363         if (rc != 0) {
1364                 llapi_error(LLAPI_MSG_ERROR, rc,
1365                             "cannot get fid of '%s' for import", dst);
1366                 goto out_unlink;
1367         }
1368
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);
1379         if (rc != 0) {
1380                 rc = -errno;
1381                 llapi_error(LLAPI_MSG_ERROR, rc, "cannot import '%s'", dst);
1382                 goto out_unlink;
1383         }
1384
1385 out_unlink:
1386         if (fd >= 0)
1387                 close(fd);
1388         if (rc)
1389                 unlink(dst);
1390         return rc;
1391 }
1392
1393 /**
1394  * Return the current HSM states and HSM requests related to file pointed by \a
1395  * path.
1396  *
1397  * \param hus  Should be allocated by caller. Will be filled with current file
1398  *             states.
1399  *
1400  * \retval 0 on success.
1401  * \retval -errno on error.
1402  */
1403 int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus)
1404 {
1405         int rc;
1406
1407         rc = ioctl(fd, LL_IOC_HSM_STATE_GET, hus);
1408         /* If error, save errno value */
1409         rc = rc ? -errno : 0;
1410
1411         return rc;
1412 }
1413
1414 /**
1415  * Return the current HSM states and HSM requests related to file pointed by \a
1416  * path.
1417  *
1418  * see llapi_hsm_state_get_fd() for args use and return
1419  */
1420 int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus)
1421 {
1422         int fd;
1423         int rc;
1424
1425         fd = open(path, O_RDONLY | O_NONBLOCK);
1426         if (fd < 0)
1427                 return -errno;
1428
1429         rc = llapi_hsm_state_get_fd(fd, hus);
1430
1431         close(fd);
1432         return rc;
1433 }
1434
1435 /**
1436  * Set HSM states of file pointed by \a fd
1437  *
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.
1441  *
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.
1445  *
1446  * \retval 0 on success.
1447  * \retval -errno on error.
1448  */
1449 int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
1450                            __u32 archive_id)
1451 {
1452         struct hsm_state_set     hss;
1453         int                      rc;
1454
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;
1463         }
1464         rc = ioctl(fd, LL_IOC_HSM_STATE_SET, &hss);
1465         /* If error, save errno value */
1466         rc = rc ? -errno : 0;
1467
1468         return rc;
1469 }
1470
1471 /**
1472  * Set HSM states of file pointed by \a path.
1473  *
1474  * see llapi_hsm_state_set_fd() for args use and return
1475  */
1476 int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
1477                         __u32 archive_id)
1478 {
1479         int fd;
1480         int rc;
1481
1482         fd = open(path, O_WRONLY | O_LOV_DELAY_CREATE | O_NONBLOCK);
1483         if (fd < 0)
1484                 return -errno;
1485
1486         rc = llapi_hsm_state_set_fd(fd, setmask, clearmask, archive_id);
1487
1488         close(fd);
1489         return rc;
1490 }
1491
1492 /**
1493  * Return the current HSM request related to file pointed by \a path.
1494  *
1495  * \param hca  Should be allocated by caller. Will be filled with current file
1496  *             actions.
1497  *
1498  * \retval 0 on success.
1499  * \retval -errno on error.
1500  */
1501 int llapi_hsm_current_action(const char *path, struct hsm_current_action *hca)
1502 {
1503         int fd;
1504         int rc;
1505
1506         fd = open(path, O_RDONLY | O_NONBLOCK);
1507         if (fd < 0)
1508                 return -errno;
1509
1510         rc = ioctl(fd, LL_IOC_HSM_ACTION, hca);
1511         /* If error, save errno value */
1512         rc = rc ? -errno : 0;
1513
1514         close(fd);
1515         return rc;
1516 }
1517
1518 /**
1519  * Allocate a hsm_user_request with the specified carateristics.
1520  * This structure should be freed with free().
1521  *
1522  * \return an allocated structure on success, NULL otherwise.
1523  */
1524 struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
1525                                                       int data_len)
1526 {
1527         int len = 0;
1528
1529         len += sizeof(struct hsm_user_request);
1530         len += sizeof(struct hsm_user_item) * itemcount;
1531         len += data_len;
1532
1533         return (struct hsm_user_request *)malloc(len);
1534 }
1535
1536 /**
1537  * Send a HSM request to Lustre, described in \param request.
1538  *
1539  * \param path    Fullpath to the file to operate on.
1540  * \param request The request, allocated with llapi_hsm_user_request_alloc().
1541  *
1542  * \return 0 on success, an error code otherwise.
1543  */
1544 int llapi_hsm_request(const char *path, const struct hsm_user_request *request)
1545 {
1546         int rc;
1547         int fd;
1548
1549         rc = get_root_path(WANT_FD, NULL, &fd, (char *)path, -1);
1550         if (rc)
1551                 return rc;
1552
1553         rc = ioctl(fd, LL_IOC_HSM_REQUEST, request);
1554         /* If error, save errno value */
1555         rc = rc ? -errno : 0;
1556
1557         close(fd);
1558         return rc;
1559 }
1560