Whamcloud - gitweb
LU-8551 test: Use mds1 rather than mds to operate on MDT0000
[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  * All rights reserved. This program and the accompanying materials
10  * are made available under the terms of the GNU Lesser General Public License
11  * (LGPL) version 2.1 or (at your discretion) any later version.
12  * (LGPL) version 2.1 accompanies this distribution, and is available at
13  * http://www.gnu.org/licenses/lgpl-2.1.html
14  *
15  *
16  * This library is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19  * Lesser General Public License for more details.
20  *
21  * LGPL HEADER END
22  */
23 /*
24  *
25  * lustre/utils/lustreapi_internal.h
26  *
27  */
28 /*
29  *
30  * Author: Aurelien Degremont <aurelien.degremont@cea.fr>
31  * Author: JC Lafoucriere <jacques-charles.lafoucriere@cea.fr>
32  * Author: Thomas Leibovici <thomas.leibovici@cea.fr>
33  */
34
35 #ifndef _LUSTREAPI_INTERNAL_H_
36 #define _LUSTREAPI_INTERNAL_H_
37
38 #include <libcfs/util/param.h>
39 #include <uapi_kernelcomm.h>
40
41 #define WANT_PATH   0x1
42 #define WANT_FSNAME 0x2
43 #define WANT_FD     0x4
44 #define WANT_INDEX  0x8
45 #define WANT_ERROR  0x10
46
47 /* mount point listings in /proc/mounts */
48 #ifndef PROC_MOUNTS
49 #define PROC_MOUNTS "/proc/mounts"
50 #endif
51
52 int get_root_path(int want, char *fsname, int *outfd, char *path, int index);
53 int root_ioctl(const char *mdtname, int opc, void *data, int *mdtidxp,
54                int want_error);
55
56 /**
57  * Often when determining the parameter path in sysfs/procfs we
58  * are often only interest set of data. This enum gives use the
59  * ability to return data of parameters for:
60  *
61  * FILTER_BY_FS_NAME: a specific file system mount
62  * FILTER_BY_PATH:    Using a Lustre file path to determine which
63  *                    file system is of interest
64  * FILTER_BY_EXACT:   The default behavior. Search the parameter
65  *                    path as is.
66  */
67 enum param_filter {
68         FILTER_BY_NONE,
69         FILTER_BY_EXACT,
70         FILTER_BY_FS_NAME,
71         FILTER_BY_PATH
72 };
73
74 int get_lustre_param_path(const char *obd_type, const char *filter,
75                           enum param_filter type, const char *param_name,
76                           glob_t *param);
77 int get_lustre_param_value(const char *obd_type, const char *filter,
78                            enum param_filter type, const char *param_name,
79                            char *value, size_t val_len);
80
81 static inline int
82 poolpath(glob_t *pool_path, const char *fsname, char *pathname)
83 {
84         int rc;
85
86         if (fsname != NULL)
87                 rc = get_lustre_param_path("lov", fsname, FILTER_BY_FS_NAME,
88                                            "pools", pool_path);
89         else
90                 rc = get_lustre_param_path("lov", pathname, FILTER_BY_PATH,
91                                            "pools", pool_path);
92         return rc;
93 }
94
95 #define LLAPI_LAYOUT_MAGIC 0x11AD1107 /* LLAPILOT */
96
97 /* Helper functions for testing validity of stripe attributes. */
98
99 static inline bool llapi_stripe_size_is_aligned(uint64_t size)
100 {
101         return (size & (LOV_MIN_STRIPE_SIZE - 1)) == 0;
102 }
103
104 static inline bool llapi_stripe_size_is_too_big(uint64_t size)
105 {
106         return size >= (1ULL << 32);
107 }
108
109 static inline bool llapi_stripe_count_is_valid(int64_t count)
110 {
111         return count >= -1 && count <= LOV_MAX_STRIPE_COUNT;
112 }
113
114 static inline bool llapi_stripe_index_is_valid(int64_t index)
115 {
116         return index >= -1 && index <= LOV_V1_INSANE_STRIPE_COUNT;
117 }
118
119 /* Compatibility macro for legacy llapi functions that use "offset"
120  * terminology instead of the preferred "index". */
121 #define llapi_stripe_offset_is_valid(os) llapi_stripe_index_is_valid(os)
122
123 /*
124  * Kernel communication for Changelogs and HSM requests.
125  */
126 int libcfs_ukuc_start(struct lustre_kernelcomm *l, int groups, int rfd_flags);
127 int libcfs_ukuc_stop(struct lustre_kernelcomm *l);
128 int libcfs_ukuc_get_rfd(struct lustre_kernelcomm *link);
129 int libcfs_ukuc_msg_get(struct lustre_kernelcomm *l, char *buf, int maxsize,
130                         int transport);
131 #endif /* _LUSTREAPI_INTERNAL_H_ */