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, 2015, 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 <lnet/lnetctl.h>
  61 #include <lustre/lustre_idl.h>
  62 #include <lustre/lustreapi.h>
  63 #include "lustreapi_internal.h"
  64
  65 #define OPEN_BY_FID_PATH dot_lustre_name"/fid"
  66
  67 /****** HSM Copytool API ********/
  68 #define CT_PRIV_MAGIC 0xC0BE2001
  69 struct hsm_copytool_private {
  70         int                      magic;
  71         char                    *mnt;
  72         struct kuc_hdr          *kuch;
  73         int                      mnt_fd;
  74         int                      open_by_fid_fd;
  75         struct lustre_kernelcomm kuc;
  76         __u32                    archives;
  77 };
  78
  79 #define CP_PRIV_MAGIC 0x19880429
  80 struct hsm_copyaction_private {
  81         __u32                                    magic;
  82         __s32                                    data_fd;
  83         const struct hsm_copytool_private       *ct_priv;
  84         struct hsm_copy                          copy;
  85         lstat_t                                  stat;
  86 };
  87
  88 enum ct_progress_type {
  89         CT_START        = 0,
  90         CT_RUNNING      = 50,
  91         CT_FINISH       = 100,
  92         CT_CANCEL       = 150,
  93         CT_ERROR        = 175
  94 };
  95
  96 enum ct_event {
  97         CT_REGISTER             = 1,
  98         CT_UNREGISTER           = 2,
  99         CT_ARCHIVE_START        = HSMA_ARCHIVE,
 100         CT_ARCHIVE_RUNNING      = HSMA_ARCHIVE + CT_RUNNING,
 101         CT_ARCHIVE_FINISH       = HSMA_ARCHIVE + CT_FINISH,
 102         CT_ARCHIVE_CANCEL       = HSMA_ARCHIVE + CT_CANCEL,
 103         CT_ARCHIVE_ERROR        = HSMA_ARCHIVE + CT_ERROR,
 104         CT_RESTORE_START        = HSMA_RESTORE,
 105         CT_RESTORE_RUNNING      = HSMA_RESTORE + CT_RUNNING,
 106         CT_RESTORE_FINISH       = HSMA_RESTORE + CT_FINISH,
 107         CT_RESTORE_CANCEL       = HSMA_RESTORE + CT_CANCEL,
 108         CT_RESTORE_ERROR        = HSMA_RESTORE + CT_ERROR,
 109         CT_REMOVE_START         = HSMA_REMOVE,
 110         CT_REMOVE_RUNNING       = HSMA_REMOVE + CT_RUNNING,
 111         CT_REMOVE_FINISH        = HSMA_REMOVE + CT_FINISH,
 112         CT_REMOVE_CANCEL        = HSMA_REMOVE + CT_CANCEL,
 113         CT_REMOVE_ERROR         = HSMA_REMOVE + CT_ERROR,
 114         CT_EVENT_MAX
 115 };
 116
 117 /* initialized in llapi_hsm_register_event_fifo() */
 118 static int llapi_hsm_event_fd = -1;
 119 static bool created_hsm_event_fifo;
 120
 121 static inline const char *llapi_hsm_ct_ev2str(int type)
 122 {
 123         switch (type) {
 124         case CT_REGISTER:
 125                 return "REGISTER";
 126         case CT_UNREGISTER:
 127                 return "UNREGISTER";
 128         case CT_ARCHIVE_START:
 129                 return "ARCHIVE_START";
 130         case CT_ARCHIVE_RUNNING:
 131                 return "ARCHIVE_RUNNING";
 132         case CT_ARCHIVE_FINISH:
 133                 return "ARCHIVE_FINISH";
 134         case CT_ARCHIVE_CANCEL:
 135                 return "ARCHIVE_CANCEL";
 136         case CT_ARCHIVE_ERROR:
 137                 return "ARCHIVE_ERROR";
 138         case CT_RESTORE_START:
 139                 return "RESTORE_START";
 140         case CT_RESTORE_RUNNING:
 141                 return "RESTORE_RUNNING";
 142         case CT_RESTORE_FINISH:
 143                 return "RESTORE_FINISH";
 144         case CT_RESTORE_CANCEL:
 145                 return "RESTORE_CANCEL";
 146         case CT_RESTORE_ERROR:
 147                 return "RESTORE_ERROR";
 148         case CT_REMOVE_START:
 149                 return "REMOVE_START";
 150         case CT_REMOVE_RUNNING:
 151                 return "REMOVE_RUNNING";
 152         case CT_REMOVE_FINISH:
 153                 return "REMOVE_FINISH";
 154         case CT_REMOVE_CANCEL:
 155                 return "REMOVE_CANCEL";
 156         case CT_REMOVE_ERROR:
 157                 return "REMOVE_ERROR";
 158         default:
 159                 llapi_err_noerrno(LLAPI_MSG_ERROR,
 160                                   "Unknown event type: %d", type);
 161                 return NULL;
 162         }
 163 }
 164
 165 /**
 166  * Writes a JSON event to the monitor FIFO. Noop if no FIFO has been
 167  * registered.
 168  *
 169  * \param event              A list of llapi_json_items comprising a
 170  *                           single JSON-formatted event.
 171  *
 172  * \retval 0 on success.
 173  * \retval -errno on error.
 174  */
 175 static int llapi_hsm_write_json_event(struct llapi_json_item_list **event)
 176 {
 177         int                             rc;
 178         char                            time_string[40];
 179         char                            json_buf[PIPE_BUF];
 180         FILE                            *buf_file;
 181         time_t                          event_time = time(0);
 182         struct tm                       time_components;
 183         struct llapi_json_item_list     *json_items;
 184
 185         /* Noop unless the event fd was initialized */
 186         if (llapi_hsm_event_fd < 0)
 187                 return 0;
 188
 189         if (event == NULL || *event == NULL)
 190                 return -EINVAL;
 191
 192         json_items = *event;
 193
 194         localtime_r(&event_time, &time_components);
 195
 196         if (strftime(time_string, sizeof(time_string), "%Y-%m-%d %T %z",
 197                      &time_components) == 0) {
 198                 rc = -EINVAL;
 199                 llapi_error(LLAPI_MSG_ERROR, rc, "strftime() failed");
 200                 return rc;
 201         }
 202
 203         rc = llapi_json_add_item(&json_items, "event_time", LLAPI_JSON_STRING,
 204                                  time_string);
 205         if (rc < 0) {
 206                 llapi_error(LLAPI_MSG_ERROR, -rc, "error in "
 207                             "llapi_json_add_item()");
 208                 return rc;
 209         }
 210
 211         buf_file = fmemopen(json_buf, sizeof(json_buf), "w");
 212         if (buf_file == NULL)
 213                 return -errno;
 214
 215         rc = llapi_json_write_list(event, buf_file);
 216         if (rc < 0) {
 217                 fclose(buf_file);
 218                 return rc;
 219         }
 220
 221         fclose(buf_file);
 222
 223         if (write(llapi_hsm_event_fd, json_buf, strlen(json_buf)) < 0) {
 224                 /* Ignore write failures due to missing reader. */
 225                 if (errno != EPIPE)
 226                         return -errno;
 227         }
 228
 229         return 0;
 230 }
 231
 232 /**
 233  * Hook for llapi_hsm_copytool_register and llapi_hsm_copytool_unregister
 234  * to generate JSON events suitable for consumption by a copytool
 235  * monitoring process.
 236  *
 237  * \param priv               Opaque private control structure.
 238  * \param event_type         The type of event (register or unregister).
 239  *
 240  * \retval 0 on success.
 241  * \retval -errno on error.
 242  */
 243 static int llapi_hsm_log_ct_registration(struct hsm_copytool_private **priv,
 244                                          __u32 event_type)
 245 {
 246         int                             rc;
 247         char                            agent_uuid[UUID_MAX];
 248         struct hsm_copytool_private     *ct;
 249         struct llapi_json_item_list     *json_items;
 250
 251         /* Noop unless the event fd was initialized */
 252         if (llapi_hsm_event_fd < 0)
 253                 return 0;
 254
 255         if (priv == NULL || *priv == NULL)
 256                 return -EINVAL;
 257
 258         ct = *priv;
 259         if (ct->magic != CT_PRIV_MAGIC)
 260                 return -EINVAL;
 261
 262         if (event_type != CT_REGISTER && event_type != CT_UNREGISTER)
 263                 return -EINVAL;
 264
 265         rc = llapi_json_init_list(&json_items);
 266         if (rc < 0)
 267                 goto err;
 268
 269         rc = llapi_get_agent_uuid(ct->mnt, agent_uuid, sizeof(agent_uuid));
 270         if (rc < 0)
 271                 goto err;
 272         llapi_chomp_string(agent_uuid);
 273
 274         rc = llapi_json_add_item(&json_items, "uuid", LLAPI_JSON_STRING,
 275                                  agent_uuid);
 276         if (rc < 0)
 277                 goto err;
 278
 279         rc = llapi_json_add_item(&json_items, "mount_point", LLAPI_JSON_STRING,
 280                                  ct->mnt);
 281         if (rc < 0)
 282                 goto err;
 283
 284         rc = llapi_json_add_item(&json_items, "archive", LLAPI_JSON_INTEGER,
 285                                  &ct->archives);
 286         if (rc < 0)
 287                 goto err;
 288
 289         rc = llapi_json_add_item(&json_items, "event_type", LLAPI_JSON_STRING,
 290                                  (char *)llapi_hsm_ct_ev2str(event_type));
 291         if (rc < 0)
 292                 goto err;
 293
 294         rc = llapi_hsm_write_json_event(&json_items);
 295         if (rc < 0)
 296                 goto err;
 297
 298         goto out_free;
 299
 300 err:
 301         llapi_error(LLAPI_MSG_ERROR, rc, "error in "
 302                     "llapi_hsm_log_ct_registration()");
 303
 304 out_free:
 305         if (json_items != NULL)
 306                 llapi_json_destroy_list(&json_items);
 307
 308         return rc;
 309 }
 310
 311 /**
 312  * Given a copytool progress update, construct a JSON event suitable for
 313  * consumption by a copytool monitoring process.
 314  *
 315  * Examples of various events generated here and written by
 316  * llapi_hsm_write_json_event:
 317  *
 318  * Copytool registration and deregistration:
 319  * {"event_time": "2014-02-26 14:58:01 -0500", "event_type": "REGISTER",
 320  *  "archive": 0, "mount_point": "/mnt/lustre",
 321  *  "uuid": "80379a60-1f8a-743f-daf2-307cde793ec2"}
 322  * {"event_time": "2014-02-26 14:58:01 -0500", "event_type": "UNREGISTER",
 323  *  "archive": 0, "mount_point": "/mnt/lustre",
 324  *  "uuid": "80379a60-1f8a-743f-daf2-307cde793ec2"}
 325  *
 326  * An archive action, start to completion:
 327  * {"event_time": "2014-02-26 14:50:13 -0500", "event_type": "ARCHIVE_START",
 328  *  "total_bytes": 0, "lustre_path": "d71.sanity-hsm/f71.sanity-hsm",
 329  *  "source_fid": "0x2000013a1:0x2:0x0", "data_fid": "0x2000013a1:0x2:0x0"}
 330  * {"event_time": "2014-02-26 14:50:18 -0500", "event_type": "ARCHIVE_RUNNING",
 331  *  "current_bytes": 5242880, "total_bytes": 39000000,
 332  *  "lustre_path": "d71.sanity-hsm/f71.sanity-hsm",
 333  *  "source_fid": "0x2000013a1:0x2:0x0", "data_fid": "0x2000013a1:0x2:0x0"}
 334  * {"event_time": "2014-02-26 14:50:50 -0500", "event_type": "ARCHIVE_FINISH",
 335  *  "source_fid": "0x2000013a1:0x2:0x0", "data_fid": "0x2000013a1:0x2:0x0"}
 336  *
 337  * A log message:
 338  * {"event_time": "2014-02-26 14:50:13 -0500", "event_type": "LOGGED_MESSAGE",
 339  *  "level": "INFO",
 340  *  "message": "lhsmtool_posix[42]: copytool fs=lustre archive#=2 item_count=1"}
 341  *
 342  * \param hcp                Opaque action handle returned by
 343  *                           llapi_hsm_action_start.
 344  * \param hai                The hsm_action_item describing the request.
 345  * \param progress_type      The ct_progress_type describing the update.
 346  * \param total              The total expected bytes for the request.
 347  * \param current            The current copied byte count for the request.
 348  *
 349  * \retval 0 on success.
 350  * \retval -errno on error.
 351  */
 352 static int llapi_hsm_log_ct_progress(struct hsm_copyaction_private **phcp,
 353                                      const struct hsm_action_item *hai,
 354                                      __u32 progress_type,
 355                                      __u64 total, __u64 current)
 356 {
 357         int                             rc;
 358         int                             linkno = 0;
 359         long long                       recno = -1;
 360         char                            lustre_path[PATH_MAX];
 361         char                            strfid[FID_NOBRACE_LEN + 1];
 362         struct hsm_copyaction_private   *hcp;
 363         struct llapi_json_item_list     *json_items;
 364
 365         /* Noop unless the event fd was initialized */
 366         if (llapi_hsm_event_fd < 0)
 367                 return 0;
 368
 369         if (phcp == NULL || *phcp == NULL)
 370                 return -EINVAL;
 371
 372         hcp = *phcp;
 373
 374         rc = llapi_json_init_list(&json_items);
 375         if (rc < 0)
 376                 goto err;
 377
 378         snprintf(strfid, sizeof(strfid), DFID_NOBRACE, PFID(&hai->hai_dfid));
 379         rc = llapi_json_add_item(&json_items, "data_fid",
 380                                  LLAPI_JSON_STRING, strfid);
 381         if (rc < 0)
 382                 goto err;
 383
 384         snprintf(strfid, sizeof(strfid), DFID_NOBRACE, PFID(&hai->hai_fid));
 385         rc = llapi_json_add_item(&json_items, "source_fid",
 386                                  LLAPI_JSON_STRING, strfid);
 387         if (rc < 0)
 388                 goto err;
 389
 390         if (hcp->copy.hc_errval == ECANCELED) {
 391                 progress_type = CT_CANCEL;
 392                 goto cancel;
 393         }
 394
 395         if (hcp->copy.hc_errval != 0) {
 396                 progress_type = CT_ERROR;
 397
 398                 rc = llapi_json_add_item(&json_items, "errno",
 399                                          LLAPI_JSON_INTEGER,
 400                                          &hcp->copy.hc_errval);
 401                 if (rc < 0)
 402                         goto err;
 403
 404                 rc = llapi_json_add_item(&json_items, "error",
 405                                          LLAPI_JSON_STRING,
 406                                          strerror(hcp->copy.hc_errval));
 407                 if (rc < 0)
 408                         goto err;
 409
 410                 goto cancel;
 411         }
 412
 413         /* lustre_path isn't available after a restore completes */
 414         /* total_bytes isn't available after a restore or archive completes */
 415         if (progress_type != CT_FINISH) {
 416                 rc = llapi_fid2path(hcp->ct_priv->mnt, strfid, lustre_path,
 417                                     sizeof(lustre_path), &recno, &linkno);
 418                 if (rc < 0)
 419                         goto err;
 420
 421                 rc = llapi_json_add_item(&json_items, "lustre_path",
 422                                          LLAPI_JSON_STRING, lustre_path);
 423                 if (rc < 0)
 424                         goto err;
 425
 426                 rc = llapi_json_add_item(&json_items, "total_bytes",
 427                                          LLAPI_JSON_BIGNUM, &total);
 428                 if (rc < 0)
 429                         goto err;
 430         }
 431
 432         if (progress_type == CT_RUNNING)
 433                 rc = llapi_json_add_item(&json_items, "current_bytes",
 434                                          LLAPI_JSON_BIGNUM, &current);
 435                 if (rc < 0)
 436                         goto err;
 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
 478         /* Create the FIFO if necessary. */
 479         if ((mkfifo(path, 0644) < 0) && (errno != EEXIST)) {
 480                 llapi_error(LLAPI_MSG_ERROR, errno, "mkfifo(%s) failed", path);
 481                 return -errno;
 482         }
 483         if (errno == EEXIST) {
 484                 if (stat(path, &statbuf) < 0) {
 485                         llapi_error(LLAPI_MSG_ERROR, errno, "mkfifo(%s) failed",
 486                                     path);
 487                         return -errno;
 488                 }
 489                 if (!S_ISFIFO(statbuf.st_mode) ||
 490                     ((statbuf.st_mode & 0777) != 0644)) {
 491                         llapi_error(LLAPI_MSG_ERROR, errno, "%s exists but is "
 492                                     "not a pipe or has a wrong mode", path);
 493                         return -errno;
 494                 }
 495         } else {
 496                 created_hsm_event_fifo = true;
 497         }
 498
 499         /* Open the FIFO for read so that the subsequent open for write
 500          * doesn't immediately fail. */
 501         read_fd = open(path, O_RDONLY | O_NONBLOCK);
 502         if (read_fd < 0) {
 503                 llapi_error(LLAPI_MSG_ERROR, errno,
 504                             "cannot open(%s) for read", path);
 505                 return -errno;
 506         }
 507
 508         /* Open the FIFO for writes, but don't block on waiting
 509          * for a reader. */
 510         llapi_hsm_event_fd = open(path, O_WRONLY | O_NONBLOCK);
 511         if (llapi_hsm_event_fd < 0) {
 512                 llapi_error(LLAPI_MSG_ERROR, errno,
 513                             "cannot open(%s) for write", path);
 514                 return -errno;
 515         }
 516
 517         /* Now close the reader. An external monitoring process can
 518          * now open the FIFO for reads. If no reader comes along the
 519          * events are lost. NOTE: Only one reader at a time! */
 520         close(read_fd);
 521
 522         /* Ignore SIGPIPEs -- can occur if the reader goes away. */
 523         signal(SIGPIPE, SIG_IGN);
 524
 525         return 0;
 526 }
 527
 528 /**
 529  * Given a path to a FIFO, close its filehandle and delete the FIFO.
 530  *
 531  * \param path               Path to monitor FIFO.
 532  *
 533  * \retval 0 on success.
 534  * \retval -errno on error.
 535  */
 536 int llapi_hsm_unregister_event_fifo(const char *path)
 537 {
 538         /* Noop unless the event fd was initialized */
 539         if (llapi_hsm_event_fd < 0)
 540                 return 0;
 541
 542         if (close(llapi_hsm_event_fd) < 0)
 543                 return -errno;
 544
 545         if (created_hsm_event_fifo) {
 546                 unlink(path);
 547                 created_hsm_event_fifo = false;
 548         }
 549
 550         llapi_hsm_event_fd = -1;
 551
 552         return 0;
 553 }
 554
 555 /**
 556  * Custom logging callback to be used when a monitoring FIFO has been
 557  * registered. Formats log entries as JSON events suitable for
 558  * consumption by a copytool monitoring process.
 559  *
 560  * \param level              The message loglevel.
 561  * \param _rc                The returncode associated with the message.
 562  * \param fmt                The message format string.
 563  * \param args               Arguments to be formatted by the format string.
 564  *
 565  * \retval None.
 566  */
 567 void llapi_hsm_log_error(enum llapi_message_level level, int _rc,
 568                          const char *fmt, va_list args)
 569 {
 570         int                             rc;
 571         int                             msg_len;
 572         int                             real_level;
 573         char                            *msg = NULL;
 574         va_list                         args2;
 575         struct llapi_json_item_list     *json_items;
 576
 577         /* Noop unless the event fd was initialized */
 578         if (llapi_hsm_event_fd < 0)
 579                 return;
 580
 581         rc = llapi_json_init_list(&json_items);
 582         if (rc < 0)
 583                 goto err;
 584
 585         if ((level & LLAPI_MSG_NO_ERRNO) == 0) {
 586                 rc = llapi_json_add_item(&json_items, "errno",
 587                                          LLAPI_JSON_INTEGER,
 588                                          &_rc);
 589                 if (rc < 0)
 590                         goto err;
 591
 592                 rc = llapi_json_add_item(&json_items, "error",
 593                                          LLAPI_JSON_STRING,
 594                                          strerror(abs(_rc)));
 595                 if (rc < 0)
 596                         goto err;
 597         }
 598
 599         va_copy(args2, args);
 600         msg_len = vsnprintf(NULL, 0, fmt, args2) + 1;
 601         va_end(args2);
 602         if (msg_len >= 0) {
 603                 msg = (char *) alloca(msg_len);
 604                 if (msg == NULL) {
 605                         rc = -ENOMEM;
 606                         goto err;
 607                 }
 608
 609                 rc = vsnprintf(msg, msg_len, fmt, args);
 610                 if (rc < 0)
 611                         goto err;
 612
 613                 rc = llapi_json_add_item(&json_items, "message",
 614                                          LLAPI_JSON_STRING,
 615                                          msg);
 616                 if (rc < 0)
 617                         goto err;
 618         } else {
 619                 rc = llapi_json_add_item(&json_items, "message",
 620                                          LLAPI_JSON_STRING,
 621                                          "INTERNAL ERROR: message failed");
 622                 if (rc < 0)
 623                         goto err;
 624         }
 625
 626         real_level = level & LLAPI_MSG_NO_ERRNO;
 627         real_level = real_level > 0 ? level - LLAPI_MSG_NO_ERRNO : level;
 628
 629         rc = llapi_json_add_item(&json_items, "level", LLAPI_JSON_STRING,
 630                                  (void *)llapi_msg_level2str(real_level));
 631         if (rc < 0)
 632                 goto err;
 633
 634         rc = llapi_json_add_item(&json_items, "event_type", LLAPI_JSON_STRING,
 635                                  "LOGGED_MESSAGE");
 636         if (rc < 0)
 637                 goto err;
 638
 639         rc = llapi_hsm_write_json_event(&json_items);
 640         if (rc < 0)
 641                 goto err;
 642
 643         goto out_free;
 644
 645 err:
 646         /* Write directly to stderr to avoid llapi_error, which now
 647          * emits JSON event messages. */
 648         fprintf(stderr, "\nFATAL ERROR IN llapi_hsm_log_error(): rc %d,", rc);
 649
 650 out_free:
 651         if (json_items != NULL)
 652                 llapi_json_destroy_list(&json_items);
 653
 654         return;
 655 }
 656
 657 /** Register a copytool
 658  * \param[out] priv             Opaque private control structure
 659  * \param mnt                   Lustre filesystem mount point
 660  * \param archive_count         Number of valid archive IDs in \a archives
 661  * \param archives              Which archive numbers this copytool is
 662  *                              responsible for
 663  * \param rfd_flags             flags applied to read fd of pipe
 664  *                              (e.g. O_NONBLOCK)
 665  *
 666  * \retval 0 on success.
 667  * \retval -errno on error.
 668  */
 669 int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
 670                                 const char *mnt, int archive_count,
 671                                 int *archives, int rfd_flags)
 672 {
 673         struct hsm_copytool_private     *ct;
 674         int                              rc;
 675
 676         if (archive_count > 0 && archives == NULL) {
 677                 llapi_err_noerrno(LLAPI_MSG_ERROR,
 678                                   "NULL archive numbers");
 679                 return -EINVAL;
 680         }
 681
 682         if (archive_count > LL_HSM_MAX_ARCHIVE) {
 683                 llapi_err_noerrno(LLAPI_MSG_ERROR, "%d requested when maximum "
 684                                   "of %zu archives supported", archive_count,
 685                                   LL_HSM_MAX_ARCHIVE);
 686                 return -EINVAL;
 687         }
 688
 689         ct = calloc(1, sizeof(*ct));
 690         if (ct == NULL)
 691                 return -ENOMEM;
 692
 693         ct->magic = CT_PRIV_MAGIC;
 694         ct->mnt_fd = -1;
 695         ct->open_by_fid_fd = -1;
 696         ct->kuc.lk_rfd = LK_NOFD;
 697         ct->kuc.lk_wfd = LK_NOFD;
 698
 699         ct->mnt = strdup(mnt);
 700         if (ct->mnt == NULL) {
 701                 rc = -ENOMEM;
 702                 goto out_err;
 703         }
 704
 705         ct->kuch = malloc(HAL_MAXSIZE + sizeof(*ct->kuch));
 706         if (ct->kuch == NULL) {
 707                 rc = -ENOMEM;
 708                 goto out_err;
 709         }
 710
 711         ct->mnt_fd = open(ct->mnt, O_RDONLY);
 712         if (ct->mnt_fd < 0) {
 713                 rc = -errno;
 714                 goto out_err;
 715         }
 716
 717         ct->open_by_fid_fd = openat(ct->mnt_fd, OPEN_BY_FID_PATH, O_RDONLY);
 718         if (ct->open_by_fid_fd < 0) {
 719                 rc = -errno;
 720                 goto out_err;
 721         }
 722
 723         /* no archives specified means "match all". */
 724         ct->archives = 0;
 725         for (rc = 0; rc < archive_count; rc++) {
 726                 if ((archives[rc] > LL_HSM_MAX_ARCHIVE) || (archives[rc] < 0)) {
 727                         llapi_err_noerrno(LLAPI_MSG_ERROR, "%d requested when "
 728                                           "archive id [0 - %zu] is supported",
 729                                           archives[rc], LL_HSM_MAX_ARCHIVE);
 730                         rc = -EINVAL;
 731                         goto out_err;
 732                 }
 733                 /* in the list we have an all archive wildcard
 734                  * so move to all archives mode
 735                  */
 736                 if (archives[rc] == 0) {
 737                         ct->archives = 0;
 738                         archive_count = 0;
 739                         break;
 740                 }
 741                 ct->archives |= (1 << (archives[rc] - 1));
 742         }
 743
 744         rc = libcfs_ukuc_start(&ct->kuc, KUC_GRP_HSM, rfd_flags);
 745         if (rc < 0)
 746                 goto out_err;
 747
 748         /* Storing archive(s) in lk_data; see mdc_ioc_hsm_ct_start */
 749         ct->kuc.lk_data = ct->archives;
 750         rc = ioctl(ct->mnt_fd, LL_IOC_HSM_CT_START, &ct->kuc);
 751         if (rc < 0) {
 752                 rc = -errno;
 753                 llapi_error(LLAPI_MSG_ERROR, rc,
 754                             "cannot start copytool on '%s'", mnt);
 755                 goto out_kuc;
 756         }
 757
 758         llapi_hsm_log_ct_registration(&ct, CT_REGISTER);
 759
 760         /* Only the kernel reference keeps the write side open */
 761         close(ct->kuc.lk_wfd);
 762         ct->kuc.lk_wfd = LK_NOFD;
 763         *priv = ct;
 764
 765         return 0;
 766
 767 out_kuc:
 768         /* cleanup the kuc channel */
 769         libcfs_ukuc_stop(&ct->kuc);
 770
 771 out_err:
 772         if (!(ct->mnt_fd < 0))
 773                 close(ct->mnt_fd);
 774
 775         if (!(ct->open_by_fid_fd < 0))
 776                 close(ct->open_by_fid_fd);
 777
 778         free(ct->mnt);
 779
 780         free(ct->kuch);
 781
 782         free(ct);
 783
 784         return rc;
 785 }
 786
 787 /** Deregister a copytool
 788  * Note: under Linux, until llapi_hsm_copytool_unregister is called
 789  * (or the program is killed), the libcfs module will be referenced
 790  * and unremovable, even after Lustre services stop.
 791  */
 792 int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv)
 793 {
 794         struct hsm_copytool_private *ct;
 795
 796         if (priv == NULL || *priv == NULL)
 797                 return -EINVAL;
 798
 799         ct = *priv;
 800         if (ct->magic != CT_PRIV_MAGIC)
 801                 return -EINVAL;
 802
 803         /* Tell the kernel to stop sending us messages */
 804         ct->kuc.lk_flags = LK_FLG_STOP;
 805         ioctl(ct->mnt_fd, LL_IOC_HSM_CT_START, &ct->kuc);
 806
 807         /* Shut down the kernelcomms */
 808         libcfs_ukuc_stop(&ct->kuc);
 809
 810         llapi_hsm_log_ct_registration(&ct, CT_UNREGISTER);
 811
 812         close(ct->open_by_fid_fd);
 813         close(ct->mnt_fd);
 814         free(ct->mnt);
 815         free(ct->kuch);
 816         free(ct);
 817         *priv = NULL;
 818
 819         return 0;
 820 }
 821
 822 /** Returns a file descriptor to poll/select on.
 823  * \param ct Opaque private control structure
 824  * \retval -EINVAL on error
 825  * \retval the file descriptor for reading HSM events from the kernel
 826  */
 827 int llapi_hsm_copytool_get_fd(struct hsm_copytool_private *ct)
 828 {
 829         if (ct == NULL || ct->magic != CT_PRIV_MAGIC)
 830                 return -EINVAL;
 831
 832         return libcfs_ukuc_get_rfd(&ct->kuc);
 833 }
 834
 835 /** Wait for the next hsm_action_list
 836  * \param ct Opaque private control structure
 837  * \param halh Action list handle, will be allocated here
 838  * \param msgsize Number of bytes in the message, will be set here
 839  * \return 0 valid message received; halh and msgsize are set
 840  *         <0 error code
 841  * Note: The application must not call llapi_hsm_copytool_recv until it has
 842  * cleared the data in ct->kuch from the previous call.
 843  */
 844 int llapi_hsm_copytool_recv(struct hsm_copytool_private *ct,
 845                             struct hsm_action_list **halh, int *msgsize)
 846 {
 847         struct kuc_hdr          *kuch;
 848         struct hsm_action_list  *hal;
 849         int                      rc = 0;
 850
 851         if (ct == NULL || ct->magic != CT_PRIV_MAGIC)
 852                 return -EINVAL;
 853
 854         if (halh == NULL || msgsize == NULL)
 855                 return -EINVAL;
 856
 857         kuch = ct->kuch;
 858
 859 repeat:
 860         rc = libcfs_ukuc_msg_get(&ct->kuc, (char *)kuch,
 861                                  HAL_MAXSIZE + sizeof(*kuch),
 862                                  KUC_TRANSPORT_HSM);
 863         if (rc < 0)
 864                 goto out_err;
 865
 866         /* Handle generic messages */
 867         if (kuch->kuc_transport == KUC_TRANSPORT_GENERIC &&
 868             kuch->kuc_msgtype == KUC_MSG_SHUTDOWN) {
 869                 rc = -ESHUTDOWN;
 870                 goto out_err;
 871         }
 872
 873         if (kuch->kuc_transport != KUC_TRANSPORT_HSM ||
 874             kuch->kuc_msgtype != HMT_ACTION_LIST) {
 875                 llapi_err_noerrno(LLAPI_MSG_ERROR,
 876                                   "Unknown HSM message type %d:%d\n",
 877                                   kuch->kuc_transport, kuch->kuc_msgtype);
 878                 rc = -EPROTO;
 879                 goto out_err;
 880         }
 881
 882         if (kuch->kuc_msglen < sizeof(*kuch) + sizeof(*hal)) {
 883                 llapi_err_noerrno(LLAPI_MSG_ERROR, "Short HSM message %d",
 884                                   kuch->kuc_msglen);
 885                 rc = -EPROTO;
 886                 goto out_err;
 887         }
 888
 889         /* Our message is a hsm_action_list. Use pointer math to skip
 890         * kuch_hdr and point directly to the message payload.
 891         */
 892         hal = (struct hsm_action_list *)(kuch + 1);
 893
 894         /* Check that we have registered for this archive #
 895          * if 0 registered, we serve any archive */
 896         if (ct->archives &&
 897             ((1 << (hal->hal_archive_id - 1)) & ct->archives) == 0) {
 898                 llapi_err_noerrno(LLAPI_MSG_INFO,
 899                                   "This copytool does not service archive #%d,"
 900                                   " ignoring this request."
 901                                   " Mask of served archive is 0x%.8X",
 902                                   hal->hal_archive_id, ct->archives);
 903
 904                 goto repeat;
 905         }
 906
 907         *halh = hal;
 908         *msgsize = kuch->kuc_msglen - sizeof(*kuch);
 909         return 0;
 910
 911 out_err:
 912         *halh = NULL;
 913         *msgsize = 0;
 914         return rc;
 915 }
 916
 917 /** Get parent path from mount point and fid.
 918  *
 919  * \param mnt        Filesystem root path.
 920  * \param fid        Object FID.
 921  * \param parent     Destination buffer.
 922  * \param parent_len Destination buffer size.
 923  * \return 0 on success.
 924  */
 925 static int fid_parent(const char *mnt, const lustre_fid *fid, char *parent,
 926                       size_t parent_len)
 927 {
 928         int              rc;
 929         int              linkno = 0;
 930         long long        recno = -1;
 931         char             file[PATH_MAX];
 932         char             strfid[FID_NOBRACE_LEN + 1];
 933         char            *ptr;
 934
 935         snprintf(strfid, sizeof(strfid), DFID_NOBRACE, PFID(fid));
 936
 937         rc = llapi_fid2path(mnt, strfid, file, sizeof(file),
 938                             &recno, &linkno);
 939         if (rc < 0)
 940                 return rc;
 941
 942         /* fid2path returns a relative path */
 943         rc = snprintf(parent, parent_len, "%s/%s", mnt, file);
 944         if (rc >= parent_len)
 945                 return -ENAMETOOLONG;
 946
 947         /* remove file name */
 948         ptr = strrchr(parent, '/');
 949         if (ptr == NULL || ptr == parent) {
 950                 rc = -EINVAL;
 951         } else {
 952                 *ptr = '\0';
 953                 rc = 0;
 954         }
 955
 956         return rc;
 957 }
 958
 959 static int ct_open_by_fid(const struct hsm_copytool_private *ct,
 960                           const struct lu_fid *fid, int open_flags)
 961 {
 962         char fid_name[FID_NOBRACE_LEN + 1];
 963         int fd;
 964
 965         snprintf(fid_name, sizeof(fid_name), DFID_NOBRACE, PFID(fid));
 966
 967         fd = openat(ct->open_by_fid_fd, fid_name, open_flags);
 968         return fd < 0 ? -errno : fd;
 969 }
 970
 971 /**
 972  * Get metadata attributes of file by FID.
 973  *
 974  * Use the IOC_MDC_GETFILEINFO ioctl (to send a MDS_GETATTR_NAME RPC)
 975  * to get the attributes of the file identified by \a fid. This
 976  * returns only the attributes stored on the MDT and avoids taking
 977  * layout locks or accessing OST objects. It also bypasses the inode
 978  * cache. Attributes are returned in \a st.
 979  */
 980 static int ct_md_getattr(const struct hsm_copytool_private *ct,
 981                          const struct lu_fid *fid,
 982                          lstat_t *st)
 983 {
 984         struct lov_user_mds_data *lmd;
 985         size_t lmd_size;
 986         int rc;
 987
 988         lmd_size = sizeof(lmd->lmd_st) +
 989                 lov_user_md_size(LOV_MAX_STRIPE_COUNT, LOV_USER_MAGIC_V3);
 990
 991         if (lmd_size < sizeof(lmd->lmd_st) + XATTR_SIZE_MAX)
 992                 lmd_size = sizeof(lmd->lmd_st) + XATTR_SIZE_MAX;
 993
 994         if (lmd_size < FID_NOBRACE_LEN + 1)
 995                 lmd_size = FID_NOBRACE_LEN + 1;
 996
 997         lmd = malloc(lmd_size);
 998         if (lmd == NULL)
 999                 return -ENOMEM;
1000
1001         snprintf((char *)lmd, lmd_size, DFID_NOBRACE, PFID(fid));
1002
1003         rc = ioctl(ct->open_by_fid_fd, IOC_MDC_GETFILEINFO, lmd);
1004         if (rc != 0) {
1005                 rc = -errno;
1006                 llapi_error(LLAPI_MSG_ERROR, rc,
1007                             "cannot get metadata attributes of "DFID" in '%s'",
1008                             PFID(fid), ct->mnt);
1009                 goto out;
1010         }
1011
1012         *st = lmd->lmd_st;
1013 out:
1014         free(lmd);
1015
1016         return rc;
1017 }
1018
1019 /** Create the destination volatile file for a restore operation.
1020  *
1021  * \param hcp        Private copyaction handle.
1022  * \param mdt_index  MDT index where to create the volatile file.
1023  * \param flags      Volatile file creation flags.
1024  * \return 0 on success.
1025  */
1026 static int create_restore_volatile(struct hsm_copyaction_private *hcp,
1027                                    int mdt_index, int open_flags)
1028 {
1029         int                      rc;
1030         int                      fd;
1031         char                     parent[PATH_MAX + 1];
1032         const char              *mnt = hcp->ct_priv->mnt;
1033         struct hsm_action_item  *hai = &hcp->copy.hc_hai;
1034
1035         rc = fid_parent(mnt, &hai->hai_fid, parent, sizeof(parent));
1036         if (rc < 0) {
1037                 /* fid_parent() failed, try to keep on going */
1038                 llapi_error(LLAPI_MSG_ERROR, rc,
1039                             "cannot get parent path to restore "DFID" "
1040                             "using '%s'", PFID(&hai->hai_fid), mnt);
1041                 snprintf(parent, sizeof(parent), "%s", mnt);
1042         }
1043
1044         fd = llapi_create_volatile_idx(parent, mdt_index, open_flags);
1045         if (fd < 0)
1046                 return fd;
1047
1048         rc = fchown(fd, hcp->stat.st_uid, hcp->stat.st_gid);
1049         if (rc < 0)
1050                 goto err_cleanup;
1051
1052         rc = llapi_fd2fid(fd, &hai->hai_dfid);
1053         if (rc < 0)
1054                 goto err_cleanup;
1055
1056         hcp->data_fd = fd;
1057
1058         return 0;
1059
1060 err_cleanup:
1061         hcp->data_fd = -1;
1062         close(fd);
1063
1064         return rc;
1065 }
1066
1067 /** Start processing an HSM action.
1068  * Should be called by copytools just before starting handling a request.
1069  * It could be skipped if copytool only want to directly report an error,
1070  * \see llapi_hsm_action_end().
1071  *
1072  * \param hcp                Opaque action handle to be passed to
1073  *                           llapi_hsm_action_progress and llapi_hsm_action_end.
1074  * \param ct                 Copytool handle acquired at registration.
1075  * \param hai                The hsm_action_item describing the request.
1076  * \param restore_mdt_index  On restore: MDT index where to create the volatile
1077  *                           file. Use -1 for default.
1078  * \param restore_open_flags On restore: volatile file creation mode. Use
1079  *                           O_LOV_DELAY_CREATE to manually set the LOVEA
1080  *                           afterwards.
1081  * \param is_error           Whether this call is just to report an error.
1082  *
1083  * \return 0 on success.
1084  */
1085 int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
1086                            const struct hsm_copytool_private *ct,
1087                            const struct hsm_action_item *hai,
1088                            int restore_mdt_index, int restore_open_flags,
1089                            bool is_error)
1090 {
1091         struct hsm_copyaction_private   *hcp;
1092         int                              rc;
1093
1094         hcp = calloc(1, sizeof(*hcp));
1095         if (hcp == NULL)
1096                 return -ENOMEM;
1097
1098         hcp->data_fd = -1;
1099         hcp->ct_priv = ct;
1100         hcp->copy.hc_hai = *hai;
1101         hcp->copy.hc_hai.hai_len = sizeof(*hai);
1102
1103         if (is_error)
1104                 goto ok_out;
1105
1106         if (hai->hai_action == HSMA_RESTORE) {
1107                 rc = ct_md_getattr(hcp->ct_priv, &hai->hai_fid, &hcp->stat);
1108                 if (rc < 0)
1109                         goto err_out;
1110
1111                 rc = create_restore_volatile(hcp, restore_mdt_index,
1112                                              restore_open_flags);
1113                 if (rc < 0)
1114                         goto err_out;
1115         }
1116
1117         rc = ioctl(ct->mnt_fd, LL_IOC_HSM_COPY_START, &hcp->copy);
1118         if (rc < 0) {
1119                 rc = -errno;
1120                 goto err_out;
1121         }
1122
1123         llapi_hsm_log_ct_progress(&hcp, hai, CT_START, 0, 0);
1124
1125 ok_out:
1126         hcp->magic = CP_PRIV_MAGIC;
1127         *phcp = hcp;
1128         return 0;
1129
1130 err_out:
1131         if (!(hcp->data_fd < 0))
1132                 close(hcp->data_fd);
1133
1134         free(hcp);
1135
1136         return rc;
1137 }
1138
1139 /** Terminate an HSM action processing.
1140  * Should be called by copytools just having finished handling the request.
1141  * \param hdl[in,out]  Handle returned by llapi_hsm_action_start.
1142  * \param he[in]       The final range of copied data (for copy actions).
1143  * \param errval[in]   The status code of the operation.
1144  * \param flags[in]    The flags about the termination status (HP_FLAG_RETRY if
1145  *                     the error is retryable).
1146  *
1147  * \return 0 on success.
1148  */
1149 int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
1150                          const struct hsm_extent *he, int hp_flags, int errval)
1151 {
1152         struct hsm_copyaction_private   *hcp;
1153         struct hsm_action_item          *hai;
1154         int                              rc;
1155
1156         if (phcp == NULL || *phcp == NULL || he == NULL)
1157                 return -EINVAL;
1158
1159         hcp = *phcp;
1160
1161         if (hcp->magic != CP_PRIV_MAGIC)
1162                 return -EINVAL;
1163
1164         hai = &hcp->copy.hc_hai;
1165
1166         if (hai->hai_action == HSMA_RESTORE && errval == 0) {
1167                 struct ll_futimes_3 lfu = {
1168                         .lfu_atime_sec = hcp->stat.st_atim.tv_sec,
1169                         .lfu_atime_nsec = hcp->stat.st_atim.tv_nsec,
1170                         .lfu_mtime_sec = hcp->stat.st_mtim.tv_sec,
1171                         .lfu_mtime_nsec = hcp->stat.st_mtim.tv_nsec,
1172                         .lfu_ctime_sec = hcp->stat.st_ctim.tv_sec,
1173                         .lfu_ctime_nsec = hcp->stat.st_ctim.tv_nsec,
1174                 };
1175
1176                 /* Set {a,m,c}time of volatile file to that of original. */
1177                 if (ioctl(hcp->data_fd, LL_IOC_FUTIMES_3, &lfu) < 0) {
1178                         errval = -errno;
1179                         goto end;
1180                 }
1181
1182                 rc = fsync(hcp->data_fd);
1183                 if (rc < 0) {
1184                         errval = -errno;
1185                         goto end;
1186                 }
1187         }
1188
1189 end:
1190         /* In some cases, like restore, 2 FIDs are used.
1191          * Set the right FID to use here. */
1192         if (hai->hai_action == HSMA_ARCHIVE || hai->hai_action == HSMA_RESTORE)
1193                 hai->hai_fid = hai->hai_dfid;
1194
1195         /* Fill the last missing data that will be needed by
1196          * kernel to send a hsm_progress. */
1197         hcp->copy.hc_flags  = hp_flags;
1198         hcp->copy.hc_errval = abs(errval);
1199
1200         hcp->copy.hc_hai.hai_extent = *he;
1201
1202         rc = ioctl(hcp->ct_priv->mnt_fd, LL_IOC_HSM_COPY_END, &hcp->copy);
1203         if (rc) {
1204                 rc = -errno;
1205                 goto err_cleanup;
1206         }
1207
1208         llapi_hsm_log_ct_progress(&hcp, hai, CT_FINISH, 0, 0);
1209
1210 err_cleanup:
1211         if (!(hcp->data_fd < 0))
1212                 close(hcp->data_fd);
1213
1214         free(hcp);
1215         *phcp = NULL;
1216
1217         return rc;
1218 }
1219
1220 /** Notify a progress in processing an HSM action.
1221  * \param hdl[in,out]   handle returned by llapi_hsm_action_start.
1222  * \param he[in]        the range of copied data (for copy actions).
1223  * \param total[in]     the expected total of copied data (for copy actions).
1224  * \param hp_flags[in]  HSM progress flags.
1225  * \return 0 on success.
1226  */
1227 int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
1228                               const struct hsm_extent *he, __u64 total,
1229                               int hp_flags)
1230 {
1231         int                      rc;
1232         struct hsm_progress      hp;
1233         struct hsm_action_item  *hai;
1234
1235         if (hcp == NULL || he == NULL)
1236                 return -EINVAL;
1237
1238         if (hcp->magic != CP_PRIV_MAGIC)
1239                 return -EINVAL;
1240
1241         hai = &hcp->copy.hc_hai;
1242
1243         memset(&hp, 0, sizeof(hp));
1244
1245         hp.hp_cookie = hai->hai_cookie;
1246         hp.hp_flags  = hp_flags;
1247
1248         /* Progress is made on the data fid */
1249         hp.hp_fid = hai->hai_dfid;
1250         hp.hp_extent = *he;
1251
1252         rc = ioctl(hcp->ct_priv->mnt_fd, LL_IOC_HSM_PROGRESS, &hp);
1253         if (rc < 0)
1254                 rc = -errno;
1255
1256         llapi_hsm_log_ct_progress(&hcp, hai, CT_RUNNING, total, he->length);
1257
1258         return rc;
1259 }
1260
1261 /** Get the fid of object to be used for copying data.
1262  * @return error code if the action is not a copy operation.
1263  */
1264 int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
1265                               lustre_fid *fid)
1266 {
1267         const struct hsm_action_item    *hai = &hcp->copy.hc_hai;
1268
1269         if (hcp->magic != CP_PRIV_MAGIC)
1270                 return -EINVAL;
1271
1272         if (hai->hai_action != HSMA_RESTORE && hai->hai_action != HSMA_ARCHIVE)
1273                 return -EINVAL;
1274
1275         *fid = hai->hai_dfid;
1276
1277         return 0;
1278 }
1279
1280 /**
1281  * Get a file descriptor to be used for copying data. It's up to the
1282  * caller to close the FDs obtained from this function.
1283  *
1284  * @retval a file descriptor on success.
1285  * @retval a negative error code on failure.
1286  */
1287 int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp)
1288 {
1289         const struct hsm_action_item    *hai = &hcp->copy.hc_hai;
1290         int fd;
1291
1292         if (hcp->magic != CP_PRIV_MAGIC)
1293                 return -EINVAL;
1294
1295         if (hai->hai_action == HSMA_ARCHIVE) {
1296                 return ct_open_by_fid(hcp->ct_priv, &hai->hai_dfid,
1297                                 O_RDONLY | O_NOATIME | O_NOFOLLOW | O_NONBLOCK);
1298         } else if (hai->hai_action == HSMA_RESTORE) {
1299                 fd = dup(hcp->data_fd);
1300                 return fd < 0 ? -errno : fd;
1301         } else {
1302                 return -EINVAL;
1303         }
1304 }
1305
1306 /**
1307  * Import an existing hsm-archived file into Lustre.
1308  *
1309  * Caller must access file by (returned) newfid value from now on.
1310  *
1311  * \param dst      path to Lustre destination (e.g. /mnt/lustre/my/file).
1312  * \param archive  archive number.
1313  * \param st       struct stat buffer containing file ownership, perm, etc.
1314  * \param stripe_* Striping options.  Currently ignored, since the restore
1315  *                 operation will set the striping.  In V2, this striping might
1316  *                 be used.
1317  * \param newfid[out] Filled with new Lustre fid.
1318  */
1319 int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
1320                      unsigned long long stripe_size, int stripe_offset,
1321                      int stripe_count, int stripe_pattern, char *pool_name,
1322                      lustre_fid *newfid)
1323 {
1324         struct hsm_user_import   hui;
1325         int                      fd;
1326         int                      rc = 0;
1327
1328         if (stripe_pattern == 0)
1329                 stripe_pattern = LOV_PATTERN_RAID0;
1330
1331         /* Create a non-striped file */
1332         fd = llapi_file_open_pool(dst, O_CREAT | O_WRONLY, st->st_mode,
1333                                   stripe_size, stripe_offset, stripe_count,
1334                                   stripe_pattern | LOV_PATTERN_F_RELEASED,
1335                                   pool_name);
1336         if (fd < 0) {
1337                 llapi_error(LLAPI_MSG_ERROR, fd,
1338                             "cannot create '%s' for import", dst);
1339                 return fd;
1340         }
1341
1342         /* Get the new fid in Lustre. Caller needs to use this fid
1343            from now on. */
1344         rc = llapi_fd2fid(fd, newfid);
1345         if (rc != 0) {
1346                 llapi_error(LLAPI_MSG_ERROR, rc,
1347                             "cannot get fid of '%s' for import", dst);
1348                 goto out_unlink;
1349         }
1350
1351         hui.hui_uid = st->st_uid;
1352         hui.hui_gid = st->st_gid;
1353         hui.hui_mode = st->st_mode;
1354         hui.hui_size = st->st_size;
1355         hui.hui_archive_id = archive;
1356         hui.hui_atime = st->st_atime;
1357         hui.hui_atime_ns = st->st_atim.tv_nsec;
1358         hui.hui_mtime = st->st_mtime;
1359         hui.hui_mtime_ns = st->st_mtim.tv_nsec;
1360         rc = ioctl(fd, LL_IOC_HSM_IMPORT, &hui);
1361         if (rc != 0) {
1362                 rc = -errno;
1363                 llapi_error(LLAPI_MSG_ERROR, rc, "cannot import '%s'", dst);
1364                 goto out_unlink;
1365         }
1366
1367 out_unlink:
1368         if (fd >= 0)
1369                 close(fd);
1370         if (rc)
1371                 unlink(dst);
1372         return rc;
1373 }
1374
1375 /**
1376  * Return the current HSM states and HSM requests related to file pointed by \a
1377  * path.
1378  *
1379  * \param hus  Should be allocated by caller. Will be filled with current file
1380  *             states.
1381  *
1382  * \retval 0 on success.
1383  * \retval -errno on error.
1384  */
1385 int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus)
1386 {
1387         int rc;
1388
1389         rc = ioctl(fd, LL_IOC_HSM_STATE_GET, hus);
1390         /* If error, save errno value */
1391         rc = rc ? -errno : 0;
1392
1393         return rc;
1394 }
1395
1396 /**
1397  * Return the current HSM states and HSM requests related to file pointed by \a
1398  * path.
1399  *
1400  * see llapi_hsm_state_get_fd() for args use and return
1401  */
1402 int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus)
1403 {
1404         int fd;
1405         int rc;
1406
1407         fd = open(path, O_RDONLY | O_NONBLOCK);
1408         if (fd < 0)
1409                 return -errno;
1410
1411         rc = llapi_hsm_state_get_fd(fd, hus);
1412
1413         close(fd);
1414         return rc;
1415 }
1416
1417 /**
1418  * Set HSM states of file pointed by \a fd
1419  *
1420  * Using the provided bitmasks, the current HSM states for this file will be
1421  * changed. \a archive_id could be used to change the archive number also. Set
1422  * it to 0 if you do not want to change it.
1423  *
1424  * \param setmask      Bitmask for flag to be set.
1425  * \param clearmask    Bitmask for flag to be cleared.
1426  * \param archive_id  Archive number identifier to use. 0 means no change.
1427  *
1428  * \retval 0 on success.
1429  * \retval -errno on error.
1430  */
1431 int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
1432                            __u32 archive_id)
1433 {
1434         struct hsm_state_set     hss;
1435         int                      rc;
1436
1437         hss.hss_valid = HSS_SETMASK|HSS_CLEARMASK;
1438         hss.hss_setmask = setmask;
1439         hss.hss_clearmask = clearmask;
1440         /* Change archive_id if provided. We can only change
1441          * to set something different than 0. */
1442         if (archive_id > 0) {
1443                 hss.hss_valid |= HSS_ARCHIVE_ID;
1444                 hss.hss_archive_id = archive_id;
1445         }
1446         rc = ioctl(fd, LL_IOC_HSM_STATE_SET, &hss);
1447         /* If error, save errno value */
1448         rc = rc ? -errno : 0;
1449
1450         return rc;
1451 }
1452
1453 /**
1454  * Set HSM states of file pointed by \a path.
1455  *
1456  * see llapi_hsm_state_set_fd() for args use and return
1457  */
1458 int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
1459                         __u32 archive_id)
1460 {
1461         int fd;
1462         int rc;
1463
1464         fd = open(path, O_WRONLY | O_LOV_DELAY_CREATE | O_NONBLOCK);
1465         if (fd < 0)
1466                 return -errno;
1467
1468         rc = llapi_hsm_state_set_fd(fd, setmask, clearmask, archive_id);
1469
1470         close(fd);
1471         return rc;
1472 }
1473
1474 /**
1475  * Return the current HSM request related to file pointed by \a path.
1476  *
1477  * \param hca  Should be allocated by caller. Will be filled with current file
1478  *             actions.
1479  *
1480  * \retval 0 on success.
1481  * \retval -errno on error.
1482  */
1483 int llapi_hsm_current_action(const char *path, struct hsm_current_action *hca)
1484 {
1485         int fd;
1486         int rc;
1487
1488         fd = open(path, O_RDONLY | O_NONBLOCK);
1489         if (fd < 0)
1490                 return -errno;
1491
1492         rc = ioctl(fd, LL_IOC_HSM_ACTION, hca);
1493         /* If error, save errno value */
1494         rc = rc ? -errno : 0;
1495
1496         close(fd);
1497         return rc;
1498 }
1499
1500 /**
1501  * Allocate a hsm_user_request with the specified carateristics.
1502  * This structure should be freed with free().
1503  *
1504  * \return an allocated structure on success, NULL otherwise.
1505  */
1506 struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
1507                                                       int data_len)
1508 {
1509         int len = 0;
1510
1511         len += sizeof(struct hsm_user_request);
1512         len += sizeof(struct hsm_user_item) * itemcount;
1513         len += data_len;
1514
1515         return (struct hsm_user_request *)malloc(len);
1516 }
1517
1518 /**
1519  * Send a HSM request to Lustre, described in \param request.
1520  *
1521  * \param path    Fullpath to the file to operate on.
1522  * \param request The request, allocated with llapi_hsm_user_request_alloc().
1523  *
1524  * \return 0 on success, an error code otherwise.
1525  */
1526 int llapi_hsm_request(const char *path, const struct hsm_user_request *request)
1527 {
1528         int rc;
1529         int fd;
1530
1531         rc = get_root_path(WANT_FD, NULL, &fd, (char *)path, -1);
1532         if (rc)
1533                 return rc;
1534
1535         rc = ioctl(fd, LL_IOC_HSM_REQUEST, request);
1536         /* If error, save errno value */
1537         rc = rc ? -errno : 0;
1538
1539         close(fd);
1540         return rc;
1541 }
1542