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