Whamcloud - gitweb
LU-14390 gnilnd: Use DIV_ROUND_UP to calculate niov
[fs/lustre-release.git] / 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 root_ioctl(const char *mdtname, int opc, void *data, int *mdtidxp,
61                int want_error);
62 int llapi_ioctl_pack(struct obd_ioctl_data *data, char **pbuf, int max_len);
63 int llapi_ioctl_unpack(struct obd_ioctl_data *data, char *pbuf, int max_len);
64 int sattr_cache_get_defaults(const char *const fsname,
65                              const char *const pathname, unsigned int *scount,
66                              unsigned int *ssize, unsigned int *soffset);
67
68 /**
69  * Often when determining the parameter path in sysfs/procfs we
70  * are often only interest set of data. This enum gives use the
71  * ability to return data of parameters for:
72  *
73  * FILTER_BY_FS_NAME: a specific file system mount
74  * FILTER_BY_PATH:    Using a Lustre file path to determine which
75  *                    file system is of interest
76  * FILTER_BY_EXACT:   The default behavior. Search the parameter
77  *                    path as is.
78  */
79 enum param_filter {
80         FILTER_BY_NONE,
81         FILTER_BY_EXACT,
82         FILTER_BY_FS_NAME,
83         FILTER_BY_PATH
84 };
85
86 int get_lustre_param_path(const char *obd_type, const char *filter,
87                           enum param_filter type, const char *param_name,
88                           glob_t *param);
89 int get_lustre_param_value(const char *obd_type, const char *filter,
90                            enum param_filter type, const char *param_name,
91                            char *value, size_t val_len);
92
93 static inline int
94 poolpath(glob_t *pool_path, const char *fsname, char *pathname)
95 {
96         int rc;
97
98         if (fsname != NULL)
99                 rc = get_lustre_param_path("lov", fsname, FILTER_BY_FS_NAME,
100                                            "pools", pool_path);
101         else
102                 rc = get_lustre_param_path("lov", pathname, FILTER_BY_PATH,
103                                            "pools", pool_path);
104         return rc;
105 }
106
107 #define LLAPI_LAYOUT_MAGIC 0x11AD1107 /* LLAPILOT */
108
109 /* Helper functions for testing validity of stripe attributes. */
110
111 static inline bool llapi_stripe_size_is_aligned(uint64_t size)
112 {
113         return (size & (LOV_MIN_STRIPE_SIZE - 1)) == 0;
114 }
115
116 static inline bool llapi_stripe_size_is_too_big(uint64_t size)
117 {
118         return size >= (1ULL << 32);
119 }
120
121 static inline bool llapi_stripe_count_is_valid(int64_t count)
122 {
123         return count >= -1 && count <= LOV_MAX_STRIPE_COUNT;
124 }
125
126 static inline bool llapi_stripe_index_is_valid(int64_t index)
127 {
128         return index >= -1 && index <= LOV_V1_INSANE_STRIPE_COUNT;
129 }
130
131 /* Compatibility macro for legacy llapi functions that use "offset"
132  * terminology instead of the preferred "index". */
133 #define llapi_stripe_offset_is_valid(os) llapi_stripe_index_is_valid(os)
134
135 static inline bool llapi_dir_stripe_count_is_valid(int64_t count)
136 {
137         return count >= -1 && count <= LMV_MAX_STRIPE_COUNT;
138 }
139
140 static inline bool llapi_dir_stripe_index_is_valid(int64_t index)
141 {
142         return index >= -1 && index < LMV_MAX_STRIPE_COUNT;
143 }
144
145 static inline bool llapi_dir_hash_type_is_valid(int64_t hash)
146 {
147         int64_t _hash = hash & LMV_HASH_TYPE_MASK;
148
149         return _hash >= LMV_HASH_TYPE_UNKNOWN && _hash <  LMV_HASH_TYPE_MAX;
150 }
151
152 /*
153  * Kernel communication for Changelogs and HSM requests.
154  */
155 int libcfs_ukuc_start(struct lustre_kernelcomm *l, int groups, int rfd_flags);
156 int libcfs_ukuc_stop(struct lustre_kernelcomm *l);
157 int libcfs_ukuc_get_rfd(struct lustre_kernelcomm *link);
158 int libcfs_ukuc_msg_get(struct lustre_kernelcomm *l, char *buf, int maxsize,
159                         int transport);
160
161 enum get_lmd_info_type {
162         GET_LMD_INFO = 1,
163         GET_LMD_STRIPE = 2,
164 };
165
166 int get_lmd_info_fd(const char *path, int parentfd, int dirfd,
167                     void *lmd_buf, int lmd_len, enum get_lmd_info_type type);
168
169 int lov_comp_md_size(struct lov_comp_md_v1 *lcm);
170 #endif /* _LUSTREAPI_INTERNAL_H_ */