lustre/utils/lustreapi_internal.h

   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) 2016, 2017, 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  *
  18  * This library is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  21  * Lesser General Public License for more details.
  22  *
  23  * LGPL HEADER END
  24  */
  25 /*
  26  *
  27  * lustre/utils/lustreapi_internal.h
  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  */
  33
  34 #ifndef _LUSTREAPI_INTERNAL_H_
  35 #define _LUSTREAPI_INTERNAL_H_
  36
  37 #include <limits.h>
  38 #include <stdint.h>
  39
  40 #include <libcfs/util/ioctl.h>
  41 #include <libcfs/util/param.h>
  42
  43 #include <linux/lustre/lustre_ioctl.h>
  44 #include <linux/lustre/lustre_kernelcomm.h>
  45
  46 #define MAX_IOC_BUFLEN  8192
  47
  48 #define WANT_PATH   0x1
  49 #define WANT_FSNAME 0x2
  50 #define WANT_FD     0x4
  51 #define WANT_INDEX  0x8
  52 #define WANT_ERROR  0x10
  53
  54 /* mount point listings in /proc/mounts */
  55 #ifndef PROC_MOUNTS
  56 #define PROC_MOUNTS "/proc/mounts"
  57 #endif
  58
  59 int get_root_path(int want, char *fsname, int *outfd, char *path, int index);
  60 int llapi_ioctl_pack(struct obd_ioctl_data *data, char **pbuf, int max_len);
  61 int llapi_ioctl_unpack(struct obd_ioctl_data *data, char *pbuf, int max_len);
  62 int sattr_cache_get_defaults(const char *const fsname,
  63                              const char *const pathname, unsigned int *scount,
  64                              unsigned int *ssize, unsigned int *soffset);
  65
  66 /**
  67  * Often when determining the parameter path in sysfs/procfs we
  68  * are often only interest set of data. This enum gives use the
  69  * ability to return data of parameters for:
  70  *
  71  * FILTER_BY_FS_NAME: a specific file system mount
  72  * FILTER_BY_PATH:    Using a Lustre file path to determine which
  73  *                    file system is of interest
  74  * FILTER_BY_EXACT:   The default behavior. Search the parameter
  75  *                    path as is.
  76  */
  77 enum param_filter {
  78         FILTER_BY_NONE,
  79         FILTER_BY_EXACT,
  80         FILTER_BY_FS_NAME,
  81         FILTER_BY_PATH
  82 };
  83
  84 int get_lustre_param_path(const char *obd_type, const char *filter,
  85                           enum param_filter type, const char *param_name,
  86                           glob_t *param);
  87 int get_lustre_param_value(const char *obd_type, const char *filter,
  88                            enum param_filter type, const char *param_name,
  89                            char *value, size_t val_len);
  90
  91 static inline int
  92 poolpath(glob_t *pool_path, const char *fsname, char *pathname)
  93 {
  94         int rc;
  95
  96         if (fsname != NULL)
  97                 rc = get_lustre_param_path("lov", fsname, FILTER_BY_FS_NAME,
  98                                            "pools", pool_path);
  99         else
 100                 rc = get_lustre_param_path("lov", pathname, FILTER_BY_PATH,
 101                                            "pools", pool_path);
 102         return rc;
 103 }
 104
 105 #define LLAPI_LAYOUT_MAGIC 0x11AD1107 /* LLAPILOT */
 106
 107 /* Helper functions for testing validity of stripe attributes. */
 108
 109 static inline bool llapi_stripe_size_is_aligned(uint64_t size)
 110 {
 111         return (size & (LOV_MIN_STRIPE_SIZE - 1)) == 0;
 112 }
 113
 114 static inline bool llapi_stripe_size_is_too_big(uint64_t size)
 115 {
 116         return size >= (1ULL << 32);
 117 }
 118
 119 static inline bool llapi_stripe_count_is_valid(int64_t count)
 120 {
 121         return count >= -1 && count <= LOV_MAX_STRIPE_COUNT;
 122 }
 123
 124 static inline bool llapi_stripe_index_is_valid(int64_t index)
 125 {
 126         return index >= -1 && index <= LOV_V1_INSANE_STRIPE_COUNT;
 127 }
 128
 129 static inline bool llapi_pool_name_is_valid(char **pool_name,
 130                                             const char *fsname)
 131 {
 132         char *ptr;
 133
 134         if (*pool_name == NULL)
 135                 return false;
 136
 137         /**
 138          * in case user gives the full pool name <fsname>.<poolname>,
 139          * strip the fsname
 140          */
 141         ptr = strchr(*pool_name, '.');
 142         if (ptr != NULL) {
 143                 *ptr = '\0';
 144                 if (fsname != NULL && strcmp(*pool_name, fsname) != 0) {
 145                         *ptr = '.';
 146                         return false;
 147                 }
 148                 *pool_name = ptr + 1;
 149         }
 150
 151         if (strlen(*pool_name) > LOV_MAXPOOLNAME)
 152                 return false;
 153
 154         return true;
 155 }
 156
 157
 158 int llapi_layout_search_ost(__u32 ost, char *pname, char *fsname);
 159
 160 /* Compatibility macro for legacy llapi functions that use "offset"
 161  * terminology instead of the preferred "index". */
 162 #define llapi_stripe_offset_is_valid(os) llapi_stripe_index_is_valid(os)
 163
 164 static inline bool llapi_dir_stripe_count_is_valid(int64_t count)
 165 {
 166         return count >= -1 && count <= LMV_MAX_STRIPE_COUNT;
 167 }
 168
 169 static inline bool llapi_dir_stripe_index_is_valid(int64_t index)
 170 {
 171         return index >= -1 && index < LMV_MAX_STRIPE_COUNT;
 172 }
 173
 174 static inline bool llapi_dir_hash_type_is_valid(int64_t hash)
 175 {
 176         int64_t _hash = hash & LMV_HASH_TYPE_MASK;
 177
 178         return _hash >= LMV_HASH_TYPE_UNKNOWN && _hash <  LMV_HASH_TYPE_MAX;
 179 }
 180
 181 /*
 182  * Kernel communication for Changelogs and HSM requests.
 183  */
 184 int libcfs_ukuc_start(struct lustre_kernelcomm *l, int groups, int rfd_flags);
 185 int libcfs_ukuc_stop(struct lustre_kernelcomm *l);
 186 int libcfs_ukuc_get_rfd(struct lustre_kernelcomm *link);
 187 int libcfs_ukuc_msg_get(struct lustre_kernelcomm *l, char *buf, int maxsize,
 188                         int transport);
 189
 190 enum get_lmd_info_type {
 191         GET_LMD_INFO = 1,
 192         GET_LMD_STRIPE = 2,
 193 };
 194
 195 int get_lmd_info_fd(const char *path, int parentfd, int dirfd,
 196                     void *lmd_buf, int lmd_len, enum get_lmd_info_type type);
 197
 198 int lov_comp_md_size(struct lov_comp_md_v1 *lcm);
 199 #endif /* _LUSTREAPI_INTERNAL_H_ */