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  *
   8  * Copyright (c) 2016, Intel Corporation.
   9  *     alternatives
  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  * Copyright (c) 2016 Intel Corporation.
  30  *
  31  * Author: Aurelien Degremont <aurelien.degremont@cea.fr>
  32  * Author: JC Lafoucriere <jacques-charles.lafoucriere@cea.fr>
  33  * Author: Thomas Leibovici <thomas.leibovici@cea.fr>
  34  */
  35
  36 #ifndef _LUSTREAPI_INTERNAL_H_
  37 #define _LUSTREAPI_INTERNAL_H_
  38
  39 #include <limits.h>
  40 #include <stdint.h>
  41
  42 #include <libcfs/util/ioctl.h>
  43 #include <libcfs/util/param.h>
  44
  45 #include <linux/lustre/lustre_ioctl.h>
  46 #include <linux/lustre/lustre_kernelcomm.h>
  47
  48 #define MAX_IOC_BUFLEN  8192
  49
  50 #define WANT_PATH   0x1
  51 #define WANT_FSNAME 0x2
  52 #define WANT_FD     0x4
  53 #define WANT_INDEX  0x8
  54 #define WANT_ERROR  0x10
  55
  56 /* mount point listings in /proc/mounts */
  57 #ifndef PROC_MOUNTS
  58 #define PROC_MOUNTS "/proc/mounts"
  59 #endif
  60
  61 int get_root_path(int want, char *fsname, int *outfd, char *path, int index);
  62 int root_ioctl(const char *mdtname, int opc, void *data, int *mdtidxp,
  63                int want_error);
  64 int obd_ioctl_pack(struct obd_ioctl_data *data, char **pbuf, int max_len);
  65 int obd_ioctl_unpack(struct obd_ioctl_data *data, char *pbuf, int max_len);
  66 int sattr_cache_get_defaults(const char *const fsname,
  67                              const char *const pathname, unsigned int *scount,
  68                              unsigned int *ssize, unsigned int *soffset);
  69
  70 /**
  71  * Often when determining the parameter path in sysfs/procfs we
  72  * are often only interest set of data. This enum gives use the
  73  * ability to return data of parameters for:
  74  *
  75  * FILTER_BY_FS_NAME: a specific file system mount
  76  * FILTER_BY_PATH:    Using a Lustre file path to determine which
  77  *                    file system is of interest
  78  * FILTER_BY_EXACT:   The default behavior. Search the parameter
  79  *                    path as is.
  80  */
  81 enum param_filter {
  82         FILTER_BY_NONE,
  83         FILTER_BY_EXACT,
  84         FILTER_BY_FS_NAME,
  85         FILTER_BY_PATH
  86 };
  87
  88 int get_lustre_param_path(const char *obd_type, const char *filter,
  89                           enum param_filter type, const char *param_name,
  90                           glob_t *param);
  91 int get_lustre_param_value(const char *obd_type, const char *filter,
  92                            enum param_filter type, const char *param_name,
  93                            char *value, size_t val_len);
  94
  95 static inline int
  96 poolpath(glob_t *pool_path, const char *fsname, char *pathname)
  97 {
  98         int rc;
  99
 100         if (fsname != NULL)
 101                 rc = get_lustre_param_path("lov", fsname, FILTER_BY_FS_NAME,
 102                                            "pools", pool_path);
 103         else
 104                 rc = get_lustre_param_path("lov", pathname, FILTER_BY_PATH,
 105                                            "pools", pool_path);
 106         return rc;
 107 }
 108
 109 #define LLAPI_LAYOUT_MAGIC 0x11AD1107 /* LLAPILOT */
 110
 111 /* Helper functions for testing validity of stripe attributes. */
 112
 113 static inline bool llapi_stripe_size_is_aligned(uint64_t size)
 114 {
 115         return (size & (LOV_MIN_STRIPE_SIZE - 1)) == 0;
 116 }
 117
 118 static inline bool llapi_stripe_size_is_too_big(uint64_t size)
 119 {
 120         return size >= (1ULL << 32);
 121 }
 122
 123 static inline bool llapi_stripe_count_is_valid(int64_t count)
 124 {
 125         return count >= -1 && count <= LOV_MAX_STRIPE_COUNT;
 126 }
 127
 128 static inline bool llapi_stripe_index_is_valid(int64_t index)
 129 {
 130         return index >= -1 && index <= LOV_V1_INSANE_STRIPE_COUNT;
 131 }
 132
 133 /* Compatibility macro for legacy llapi functions that use "offset"
 134  * terminology instead of the preferred "index". */
 135 #define llapi_stripe_offset_is_valid(os) llapi_stripe_index_is_valid(os)
 136
 137 /*
 138  * Kernel communication for Changelogs and HSM requests.
 139  */
 140 int libcfs_ukuc_start(struct lustre_kernelcomm *l, int groups, int rfd_flags);
 141 int libcfs_ukuc_stop(struct lustre_kernelcomm *l);
 142 int libcfs_ukuc_get_rfd(struct lustre_kernelcomm *link);
 143 int libcfs_ukuc_msg_get(struct lustre_kernelcomm *l, char *buf, int maxsize,
 144                         int transport);
 145 #endif /* _LUSTREAPI_INTERNAL_H_ */