Whamcloud - gitweb
LU-10822 utils: stop bogus buffer overflow errors
[fs/lustre-release.git] / lustre / utils / liblustreapi_hsm.c
index e47a7d9..41eac0f 100644 (file)
@@ -6,6 +6,8 @@
  * (C) Copyright 2012 Commissariat a l'energie atomique et aux energies
  *     alternatives
  *
+ * Copyright (c) 2013, 2017, Intel Corporation.
+ *
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the GNU Lesser General Public License
  * (LGPL) version 2.1 or (at your discretion) any later version.
@@ -30,6 +32,7 @@
  * Author: Henri Doreau <henri.doreau@cea.fr>
  */
 
+#include <fcntl.h>
 #include <stdlib.h>
 #include <stdio.h>
 #include <string.h>
 #include <dirent.h>
 #include <stdarg.h>
 #include <sys/stat.h>
+#include <sys/time.h>
 #include <sys/types.h>
+#include <time.h>
 #include <utime.h>
 #include <sys/syscall.h>
 #include <fnmatch.h>
-#include <glob.h>
 #include <signal.h>
 #ifdef HAVE_LINUX_UNISTD_H
 #include <linux/unistd.h>
@@ -53,9 +57,7 @@
 #include <unistd.h>
 #endif
 
-#include <libcfs/libcfs.h>
-#include <lnet/lnetctl.h>
-#include <lustre/lustre_idl.h>
+#include <linux/lnet/lnetctl.h>
 #include <lustre/lustreapi.h>
 #include "lustreapi_internal.h"
 
@@ -69,21 +71,20 @@ struct hsm_copytool_private {
        struct kuc_hdr          *kuch;
        int                      mnt_fd;
        int                      open_by_fid_fd;
-       lustre_kernelcomm        kuc;
+       struct lustre_kernelcomm kuc;
        __u32                    archives;
 };
 
 #define CP_PRIV_MAGIC 0x19880429
 struct hsm_copyaction_private {
        __u32                                    magic;
+       __u32                                    source_fd;
        __s32                                    data_fd;
        const struct hsm_copytool_private       *ct_priv;
        struct hsm_copy                          copy;
-       struct stat                              stat;
+       lstat_t                                  stat;
 };
 
-#include <libcfs/libcfs.h>
-
 enum ct_progress_type {
        CT_START        = 0,
        CT_RUNNING      = 50,
@@ -114,7 +115,8 @@ enum ct_event {
 };
 
 /* initialized in llapi_hsm_register_event_fifo() */
-int llapi_hsm_event_fd = -1;
+static int llapi_hsm_event_fd = -1;
+static bool created_hsm_event_fifo;
 
 static inline const char *llapi_hsm_ct_ev2str(int type)
 {
@@ -170,7 +172,7 @@ static inline const char *llapi_hsm_ct_ev2str(int type)
  * \retval 0 on success.
  * \retval -errno on error.
  */
-int llapi_hsm_write_json_event(struct llapi_json_item_list **event)
+static int llapi_hsm_write_json_event(struct llapi_json_item_list **event)
 {
        int                             rc;
        char                            time_string[40];
@@ -238,14 +240,18 @@ int llapi_hsm_write_json_event(struct llapi_json_item_list **event)
  * \retval 0 on success.
  * \retval -errno on error.
  */
-int llapi_hsm_log_ct_registration(struct hsm_copytool_private **priv,
-                                 __u32 event_type)
+static int llapi_hsm_log_ct_registration(struct hsm_copytool_private **priv,
+                                        __u32 event_type)
 {
        int                             rc;
        char                            agent_uuid[UUID_MAX];
        struct hsm_copytool_private     *ct;
        struct llapi_json_item_list     *json_items;
 
+       /* Noop unless the event fd was initialized */
+       if (llapi_hsm_event_fd < 0)
+               return 0;
+
        if (priv == NULL || *priv == NULL)
                return -EINVAL;
 
@@ -343,9 +349,10 @@ out_free:
  * \retval 0 on success.
  * \retval -errno on error.
  */
-int llapi_hsm_log_ct_progress(struct hsm_copyaction_private **phcp,
-                   const struct hsm_action_item *hai, __u32 progress_type,
-                   __u64 total, __u64 current)
+static int llapi_hsm_log_ct_progress(struct hsm_copyaction_private **phcp,
+                                    const struct hsm_action_item *hai,
+                                    __u32 progress_type,
+                                    __u64 total, __u64 current)
 {
        int                             rc;
        int                             linkno = 0;
@@ -355,6 +362,10 @@ int llapi_hsm_log_ct_progress(struct hsm_copyaction_private **phcp,
        struct hsm_copyaction_private   *hcp;
        struct llapi_json_item_list     *json_items;
 
+       /* Noop unless the event fd was initialized */
+       if (llapi_hsm_event_fd < 0)
+               return 0;
+
        if (phcp == NULL || *phcp == NULL)
                return -EINVAL;
 
@@ -418,11 +429,12 @@ int llapi_hsm_log_ct_progress(struct hsm_copyaction_private **phcp,
                        goto err;
        }
 
-       if (progress_type == CT_RUNNING)
+       if (progress_type == CT_RUNNING) {
                rc = llapi_json_add_item(&json_items, "current_bytes",
                                         LLAPI_JSON_BIGNUM, &current);
                if (rc < 0)
                        goto err;
+       }
 
 cancel:
        rc = llapi_json_add_item(&json_items, "event_type", LLAPI_JSON_STRING,
@@ -459,10 +471,12 @@ out_free:
  * \retval 0 on success.
  * \retval -errno on error.
  */
-int llapi_hsm_register_event_fifo(char *path)
+int llapi_hsm_register_event_fifo(const char *path)
 {
        int read_fd;
        struct stat statbuf;
+       struct sigaction ignore_action;
+       int rc;
 
        /* Create the FIFO if necessary. */
        if ((mkfifo(path, 0644) < 0) && (errno != EEXIST)) {
@@ -481,6 +495,8 @@ int llapi_hsm_register_event_fifo(char *path)
                                    "not a pipe or has a wrong mode", path);
                        return -errno;
                }
+       } else {
+               created_hsm_event_fifo = true;
        }
 
        /* Open the FIFO for read so that the subsequent open for write
@@ -495,19 +511,24 @@ int llapi_hsm_register_event_fifo(char *path)
        /* Open the FIFO for writes, but don't block on waiting
         * for a reader. */
        llapi_hsm_event_fd = open(path, O_WRONLY | O_NONBLOCK);
-       if (llapi_hsm_event_fd < 0) {
-               llapi_error(LLAPI_MSG_ERROR, errno,
-                           "cannot open(%s) for write", path);
-               return -errno;
-       }
+       rc = -errno;
 
        /* Now close the reader. An external monitoring process can
         * now open the FIFO for reads. If no reader comes along the
         * events are lost. NOTE: Only one reader at a time! */
        close(read_fd);
 
+       if (llapi_hsm_event_fd < 0) {
+               llapi_error(LLAPI_MSG_ERROR, -rc,
+                           "cannot open(%s) for write", path);
+               return rc;
+       }
+
        /* Ignore SIGPIPEs -- can occur if the reader goes away. */
-       signal(SIGPIPE, SIG_IGN);
+       memset(&ignore_action, 0, sizeof(ignore_action));
+       ignore_action.sa_handler = SIG_IGN;
+       sigemptyset(&ignore_action.sa_mask);
+       sigaction(SIGPIPE, &ignore_action, NULL);
 
        return 0;
 }
@@ -520,7 +541,7 @@ int llapi_hsm_register_event_fifo(char *path)
  * \retval 0 on success.
  * \retval -errno on error.
  */
-int llapi_hsm_unregister_event_fifo(char *path)
+int llapi_hsm_unregister_event_fifo(const char *path)
 {
        /* Noop unless the event fd was initialized */
        if (llapi_hsm_event_fd < 0)
@@ -529,7 +550,10 @@ int llapi_hsm_unregister_event_fifo(char *path)
        if (close(llapi_hsm_event_fd) < 0)
                return -errno;
 
-       unlink(path);
+       if (created_hsm_event_fifo) {
+               unlink(path);
+               created_hsm_event_fifo = false;
+       }
 
        llapi_hsm_event_fd = -1;
 
@@ -639,11 +663,16 @@ out_free:
 }
 
 /** Register a copytool
- * \param[out] priv Opaque private control structure
- * \param mnt Lustre filesystem mount point
- * \param archive_count
- * \param archives Which archive numbers this copytool is responsible for
- * \param rfd_flags flags applied to read fd of pipe (e.g. O_NONBLOCK)
+ * \param[out] priv            Opaque private control structure
+ * \param mnt                  Lustre filesystem mount point
+ * \param archive_count                Number of valid archive IDs in \a archives
+ * \param archives             Which archive numbers this copytool is
+ *                             responsible for
+ * \param rfd_flags            flags applied to read fd of pipe
+ *                             (e.g. O_NONBLOCK)
+ *
+ * \retval 0 on success.
+ * \retval -errno on error.
  */
 int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
                                const char *mnt, int archive_count,
@@ -658,6 +687,13 @@ int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
                return -EINVAL;
        }
 
+       if (archive_count > LL_HSM_MAX_ARCHIVE) {
+               llapi_err_noerrno(LLAPI_MSG_ERROR, "%d requested when maximum "
+                                 "of %zu archives supported", archive_count,
+                                 LL_HSM_MAX_ARCHIVE);
+               return -EINVAL;
+       }
+
        ct = calloc(1, sizeof(*ct));
        if (ct == NULL)
                return -ENOMEM;
@@ -695,13 +731,14 @@ int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
        /* no archives specified means "match all". */
        ct->archives = 0;
        for (rc = 0; rc < archive_count; rc++) {
-               if (archives[rc] > 8 * sizeof(ct->archives)) {
-                       llapi_err_noerrno(LLAPI_MSG_ERROR,
-                                         "maximum of %zu archives supported",
-                                         8 * sizeof(ct->archives));
+               if ((archives[rc] > LL_HSM_MAX_ARCHIVE) || (archives[rc] < 0)) {
+                       llapi_err_noerrno(LLAPI_MSG_ERROR, "%d requested when "
+                                         "archive id [0 - %zu] is supported",
+                                         archives[rc], LL_HSM_MAX_ARCHIVE);
+                       rc = -EINVAL;
                        goto out_err;
                }
-               /* in the list we have a all archive wildcard
+               /* in the list we have an all archive wildcard
                 * so move to all archives mode
                 */
                if (archives[rc] == 0) {
@@ -723,9 +760,7 @@ int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
                rc = -errno;
                llapi_error(LLAPI_MSG_ERROR, rc,
                            "cannot start copytool on '%s'", mnt);
-               goto out_err;
-       } else {
-               rc = 0;
+               goto out_kuc;
        }
 
        llapi_hsm_log_ct_registration(&ct, CT_REGISTER);
@@ -733,10 +768,8 @@ int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
        /* Only the kernel reference keeps the write side open */
        close(ct->kuc.lk_wfd);
        ct->kuc.lk_wfd = LK_NOFD;
-       if (rc < 0)
-               goto out_kuc;
-
        *priv = ct;
+
        return 0;
 
 out_kuc:
@@ -775,13 +808,17 @@ int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv)
        if (ct->magic != CT_PRIV_MAGIC)
                return -EINVAL;
 
+       /* Close the read side of the KUC pipe. This should be done
+        * before unregistering to avoid deadlock: a ldlm_cb thread
+        * enters libcfs_kkuc_group_put() acquires kg_sem and blocks
+        * in pipe_write() due to full pipe; then we attempt to
+        * unregister and block on kg_sem. */
+       libcfs_ukuc_stop(&ct->kuc);
+
        /* Tell the kernel to stop sending us messages */
        ct->kuc.lk_flags = LK_FLG_STOP;
        ioctl(ct->mnt_fd, LL_IOC_HSM_CT_START, &ct->kuc);
 
-       /* Shut down the kernelcomms */
-       libcfs_ukuc_stop(&ct->kuc);
-
        llapi_hsm_log_ct_registration(&ct, CT_UNREGISTER);
 
        close(ct->open_by_fid_fd);
@@ -897,7 +934,7 @@ out_err:
  * \param parent_len Destination buffer size.
  * \return 0 on success.
  */
-static int fid_parent(const char *mnt, const lustre_fid *fid, char *parent,
+static int fid_parent(const char *mnt, const struct lu_fid *fid, char *parent,
                      size_t parent_len)
 {
        int              rc;
@@ -943,17 +980,50 @@ static int ct_open_by_fid(const struct hsm_copytool_private *ct,
        return fd < 0 ? -errno : fd;
 }
 
-static int ct_stat_by_fid(const struct hsm_copytool_private *ct,
-                         const struct lu_fid *fid,
-                         struct stat *buf)
+/**
+ * Get metadata attributes of file by FID.
+ *
+ * Use the IOC_MDC_GETFILEINFO ioctl (to send a MDS_GETATTR_NAME RPC)
+ * to get the attributes of the file identified by \a fid. This
+ * returns only the attributes stored on the MDT and avoids taking
+ * layout locks or accessing OST objects. It also bypasses the inode
+ * cache. Attributes are returned in \a st.
+ */
+static int ct_md_getattr(const struct hsm_copytool_private *ct,
+                        const struct lu_fid *fid,
+                        lstat_t *st)
 {
-       char fid_name[FID_NOBRACE_LEN + 1];
+       struct lov_user_mds_data *lmd;
+       char fname[FID_NOBRACE_LEN + 1] = "";
+       size_t lmd_size;
        int rc;
 
-       snprintf(fid_name, sizeof(fid_name), DFID_NOBRACE, PFID(fid));
+       rc = snprintf(fname, sizeof(fname), DFID_NOBRACE, PFID(fid));
+       if (rc < 0)
+               return rc;
+       if (rc >= sizeof(fname) || rc == 0)
+               return -EINVAL;
+
+       lmd_size = sizeof(lmd->lmd_st) +
+               lov_user_md_size(LOV_MAX_STRIPE_COUNT, LOV_USER_MAGIC_V3);
+
+       if (lmd_size < sizeof(lmd->lmd_st) + XATTR_SIZE_MAX)
+               lmd_size = sizeof(lmd->lmd_st) + XATTR_SIZE_MAX;
+
+       lmd = malloc(lmd_size);
+       if (lmd == NULL)
+               return -ENOMEM;
+
+       rc = get_lmd_info_fd(fname, ct->open_by_fid_fd, -1,
+                            lmd, lmd_size, GET_LMD_INFO);
+       if (rc)
+               goto out;
+
+       *st = lmd->lmd_st;
+out:
+       free(lmd);
 
-       rc = fstatat(ct->open_by_fid_fd, fid_name, buf, 0);
-       return rc ? -errno : 0;
+       return rc;
 }
 
 /** Create the destination volatile file for a restore operation.
@@ -1028,13 +1098,15 @@ int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
                           int restore_mdt_index, int restore_open_flags,
                           bool is_error)
 {
-       struct hsm_copyaction_private   *hcp;
-       int                              rc;
+       struct hsm_copyaction_private *hcp;
+       int fd;
+       int rc;
 
        hcp = calloc(1, sizeof(*hcp));
        if (hcp == NULL)
                return -ENOMEM;
 
+       hcp->source_fd = -1;
        hcp->data_fd = -1;
        hcp->ct_priv = ct;
        hcp->copy.hc_hai = *hai;
@@ -1043,8 +1115,17 @@ int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
        if (is_error)
                goto ok_out;
 
-       if (hai->hai_action == HSMA_RESTORE) {
-               rc = ct_stat_by_fid(hcp->ct_priv, &hai->hai_fid, &hcp->stat);
+       if (hai->hai_action == HSMA_ARCHIVE) {
+               fd = ct_open_by_fid(hcp->ct_priv, &hai->hai_dfid,
+                               O_RDONLY | O_NOATIME | O_NOFOLLOW | O_NONBLOCK);
+               if (fd < 0) {
+                       rc = fd;
+                       goto err_out;
+               }
+
+               hcp->source_fd = fd;
+       } else if (hai->hai_action == HSMA_RESTORE) {
+               rc = ct_md_getattr(hcp->ct_priv, &hai->hai_fid, &hcp->stat);
                if (rc < 0)
                        goto err_out;
 
@@ -1052,6 +1133,10 @@ int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
                                             restore_open_flags);
                if (rc < 0)
                        goto err_out;
+       } else if (hai->hai_action == HSMA_REMOVE) {
+               /* Since remove is atomic there is no need to send an
+                * initial MDS_HSM_PROGRESS RPC. */
+               goto out_log;
        }
 
        rc = ioctl(ct->mnt_fd, LL_IOC_HSM_COPY_START, &hcp->copy);
@@ -1060,6 +1145,7 @@ int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
                goto err_out;
        }
 
+out_log:
        llapi_hsm_log_ct_progress(&hcp, hai, CT_START, 0, 0);
 
 ok_out:
@@ -1068,6 +1154,9 @@ ok_out:
        return 0;
 
 err_out:
+       if (!(hcp->source_fd < 0))
+               close(hcp->source_fd);
+
        if (!(hcp->data_fd < 0))
                close(hcp->data_fd);
 
@@ -1104,19 +1193,23 @@ int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
        hai = &hcp->copy.hc_hai;
 
        if (hai->hai_action == HSMA_RESTORE && errval == 0) {
-               struct timeval tv[2];
-
-               /* Set {a,m}time of volatile file to that of original. */
-               tv[0].tv_sec = hcp->stat.st_atime;
-               tv[0].tv_usec = 0;
-               tv[1].tv_sec = hcp->stat.st_mtime;
-               tv[1].tv_usec = 0;
-               if (futimes(hcp->data_fd, tv) < 0) {
+               struct ll_futimes_3 lfu = {
+                       .lfu_atime_sec = hcp->stat.st_atim.tv_sec,
+                       .lfu_atime_nsec = hcp->stat.st_atim.tv_nsec,
+                       .lfu_mtime_sec = hcp->stat.st_mtim.tv_sec,
+                       .lfu_mtime_nsec = hcp->stat.st_mtim.tv_nsec,
+                       .lfu_ctime_sec = hcp->stat.st_ctim.tv_sec,
+                       .lfu_ctime_nsec = hcp->stat.st_ctim.tv_nsec,
+               };
+
+               rc = fsync(hcp->data_fd);
+               if (rc < 0) {
                        errval = -errno;
                        goto end;
                }
 
-               rc = fsync(hcp->data_fd);
+               /* Set {a,m,c}time of volatile file to that of original. */
+               rc = ioctl(hcp->data_fd, LL_IOC_FUTIMES_3, &lfu);
                if (rc < 0) {
                        errval = -errno;
                        goto end;
@@ -1145,6 +1238,9 @@ end:
        llapi_hsm_log_ct_progress(&hcp, hai, CT_FINISH, 0, 0);
 
 err_cleanup:
+       if (!(hcp->source_fd < 0))
+               close(hcp->source_fd);
+
        if (!(hcp->data_fd < 0))
                close(hcp->data_fd);
 
@@ -1199,7 +1295,7 @@ int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
  * @return error code if the action is not a copy operation.
  */
 int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
-                             lustre_fid *fid)
+                             struct lu_fid *fid)
 {
        const struct hsm_action_item    *hai = &hcp->copy.hc_hai;
 
@@ -1230,8 +1326,8 @@ int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp)
                return -EINVAL;
 
        if (hai->hai_action == HSMA_ARCHIVE) {
-               return ct_open_by_fid(hcp->ct_priv, &hai->hai_dfid,
-                               O_RDONLY | O_NOATIME | O_NOFOLLOW | O_NONBLOCK);
+               fd = dup(hcp->source_fd);
+               return fd < 0 ? -errno : fd;
        } else if (hai->hai_action == HSMA_RESTORE) {
                fd = dup(hcp->data_fd);
                return fd < 0 ? -errno : fd;
@@ -1256,7 +1352,7 @@ int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp)
 int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
                     unsigned long long stripe_size, int stripe_offset,
                     int stripe_count, int stripe_pattern, char *pool_name,
-                    lustre_fid *newfid)
+                    struct lu_fid *newfid)
 {
        struct hsm_user_import   hui;
        int                      fd;