4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * (C) Copyright 2012 Commissariat a l'energie atomique et aux energies
9 * Copyright (c) 2016, 2017, Intel Corporation.
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
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.
27 * lustre/utils/lustreapi_internal.h
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>
34 #ifndef _LUSTREAPI_INTERNAL_H_
35 #define _LUSTREAPI_INTERNAL_H_
40 #include <libcfs/util/ioctl.h>
41 #include <libcfs/util/param.h>
43 #include <linux/lustre/lustre_ioctl.h>
44 #include <linux/lustre/lustre_kernelcomm.h>
46 #define MAX_IOC_BUFLEN 8192
49 #define WANT_FSNAME 0x2
51 #define WANT_INDEX 0x8
52 #define WANT_ERROR 0x10
54 /* Define a fixed 4096-byte encryption unit size */
55 #define LUSTRE_ENCRYPTION_BLOCKBITS 12
56 #define LUSTRE_ENCRYPTION_UNIT_SIZE ((size_t)1 << LUSTRE_ENCRYPTION_BLOCKBITS)
57 #define LUSTRE_ENCRYPTION_MASK (~(LUSTRE_ENCRYPTION_UNIT_SIZE - 1))
59 /* mount point listings in /proc/mounts */
61 #define PROC_MOUNTS "/proc/mounts"
64 int get_root_path(int want, char *fsname, int *outfd, char *path, int index);
65 int llapi_ioctl_pack(struct obd_ioctl_data *data, char **pbuf, int max_len);
66 int llapi_ioctl_unpack(struct obd_ioctl_data *data, char *pbuf, int max_len);
67 int sattr_cache_get_defaults(const char *const fsname,
68 const char *const pathname, unsigned int *scount,
69 unsigned int *ssize, unsigned int *soffset);
72 * Often when determining the parameter path in sysfs/procfs we
73 * are often only interest set of data. This enum gives use the
74 * ability to return data of parameters for:
76 * FILTER_BY_FS_NAME: a specific file system mount
77 * FILTER_BY_PATH: Using a Lustre file path to determine which
78 * file system is of interest
79 * FILTER_BY_EXACT: The default behavior. Search the parameter
89 int get_lustre_param_path(const char *obd_type, const char *filter,
90 enum param_filter type, const char *param_name,
92 int get_lustre_param_value(const char *obd_type, const char *filter,
93 enum param_filter type, const char *param_name,
94 char *value, size_t val_len);
97 poolpath(glob_t *pool_path, const char *fsname, char *pathname)
102 rc = get_lustre_param_path("lov", fsname, FILTER_BY_FS_NAME,
105 rc = get_lustre_param_path("lov", pathname, FILTER_BY_PATH,
110 #define LLAPI_LAYOUT_MAGIC 0x11AD1107 /* LLAPILOT */
112 /* Helper functions for testing validity of stripe attributes. */
114 static inline bool llapi_stripe_size_is_aligned(uint64_t size)
116 return (size & (LOV_MIN_STRIPE_SIZE - 1)) == 0;
119 static inline bool llapi_stripe_size_is_too_big(uint64_t size)
121 return size >= (1ULL << 32);
124 static inline bool llapi_stripe_count_is_valid(int64_t count)
126 return count >= -1 && count <= LOV_MAX_STRIPE_COUNT;
129 static inline bool llapi_stripe_index_is_valid(int64_t index)
131 return index >= -1 && index <= LOV_V1_INSANE_STRIPE_COUNT;
134 static inline bool llapi_pool_name_is_valid(const char **pool_name)
138 if (*pool_name == NULL)
141 /* Strip off any 'fsname.' portion. */
142 ptr = strchr(*pool_name, '.');
144 *pool_name = ptr + 1;
146 if (strlen(*pool_name) > LOV_MAXPOOLNAME)
152 /* Compatibility macro for legacy llapi functions that use "offset"
153 * terminology instead of the preferred "index". */
154 #define llapi_stripe_offset_is_valid(os) llapi_stripe_index_is_valid(os)
156 static inline bool llapi_dir_stripe_count_is_valid(int64_t count)
158 return count >= -1 && count <= LMV_MAX_STRIPE_COUNT;
161 static inline bool llapi_dir_stripe_index_is_valid(int64_t index)
163 return index >= -1 && index < LMV_MAX_STRIPE_COUNT;
166 static inline bool llapi_dir_hash_type_is_valid(int64_t hash)
168 int64_t _hash = hash & LMV_HASH_TYPE_MASK;
170 return _hash >= LMV_HASH_TYPE_UNKNOWN && _hash < LMV_HASH_TYPE_MAX;
174 * Kernel communication for Changelogs and HSM requests.
176 int libcfs_ukuc_start(struct lustre_kernelcomm *l, int groups, int rfd_flags);
177 int libcfs_ukuc_stop(struct lustre_kernelcomm *l);
178 int libcfs_ukuc_get_rfd(struct lustre_kernelcomm *link);
179 int libcfs_ukuc_msg_get(struct lustre_kernelcomm *l, char *buf, int maxsize,
182 enum get_lmd_info_type {
187 int get_lmd_info_fd(const char *path, int parentfd, int dirfd,
188 void *lmd_buf, int lmd_len, enum get_lmd_info_type type);
190 int lov_comp_md_size(struct lov_comp_md_v1 *lcm);
191 #endif /* _LUSTREAPI_INTERNAL_H_ */