Whamcloud - gitweb
LU-10822 utils: stop bogus buffer overflow errors
[fs/lustre-release.git] / lustre / utils / lustreapi_internal.h
index 3ae67e9..4d636f4 100644 (file)
@@ -6,6 +6,8 @@
  * (C) Copyright 2012 Commissariat a l'energie atomique et aux energies
  *     alternatives
  *
+ * Copyright (c) 2016, 2017, Intel Corporation.
+ *
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the GNU Lesser General Public License
  * (LGPL) version 2.1 or (at your discretion) any later version.
@@ -24,9 +26,6 @@
  *
  * lustre/utils/lustreapi_internal.h
  *
- */
-/*
- *
  * Author: Aurelien Degremont <aurelien.degremont@cea.fr>
  * Author: JC Lafoucriere <jacques-charles.lafoucriere@cea.fr>
  * Author: Thomas Leibovici <thomas.leibovici@cea.fr>
 #ifndef _LUSTREAPI_INTERNAL_H_
 #define _LUSTREAPI_INTERNAL_H_
 
+#include <limits.h>
+#include <stdint.h>
+
+#include <libcfs/util/ioctl.h>
+#include <libcfs/util/param.h>
+
+#include <linux/lustre/lustre_ioctl.h>
+#include <linux/lustre/lustre_kernelcomm.h>
+
+#define MAX_IOC_BUFLEN 8192
+
 #define WANT_PATH   0x1
 #define WANT_FSNAME 0x2
 #define WANT_FD     0x4
 #define WANT_INDEX  0x8
 #define WANT_ERROR  0x10
+
+/* mount point listings in /proc/mounts */
+#ifndef PROC_MOUNTS
+#define PROC_MOUNTS "/proc/mounts"
+#endif
+
 int get_root_path(int want, char *fsname, int *outfd, char *path, int index);
 int root_ioctl(const char *mdtname, int opc, void *data, int *mdtidxp,
               int want_error);
+int llapi_ioctl_pack(struct obd_ioctl_data *data, char **pbuf, int max_len);
+int llapi_ioctl_unpack(struct obd_ioctl_data *data, char *pbuf, int max_len);
+int sattr_cache_get_defaults(const char *const fsname,
+                            const char *const pathname, unsigned int *scount,
+                            unsigned int *ssize, unsigned int *soffset);
+
+/**
+ * Often when determining the parameter path in sysfs/procfs we
+ * are often only interest set of data. This enum gives use the
+ * ability to return data of parameters for:
+ *
+ * FILTER_BY_FS_NAME: a specific file system mount
+ * FILTER_BY_PATH:    Using a Lustre file path to determine which
+ *                   file system is of interest
+ * FILTER_BY_EXACT:   The default behavior. Search the parameter
+ *                   path as is.
+ */
+enum param_filter {
+       FILTER_BY_NONE,
+       FILTER_BY_EXACT,
+       FILTER_BY_FS_NAME,
+       FILTER_BY_PATH
+};
+
+int get_lustre_param_path(const char *obd_type, const char *filter,
+                         enum param_filter type, const char *param_name,
+                         glob_t *param);
+int get_lustre_param_value(const char *obd_type, const char *filter,
+                          enum param_filter type, const char *param_name,
+                          char *value, size_t val_len);
+
+static inline int
+poolpath(glob_t *pool_path, const char *fsname, char *pathname)
+{
+       int rc;
+
+       if (fsname != NULL)
+               rc = get_lustre_param_path("lov", fsname, FILTER_BY_FS_NAME,
+                                          "pools", pool_path);
+       else
+               rc = get_lustre_param_path("lov", pathname, FILTER_BY_PATH,
+                                          "pools", pool_path);
+       return rc;
+}
+
+#define LLAPI_LAYOUT_MAGIC 0x11AD1107 /* LLAPILOT */
+
+/* Helper functions for testing validity of stripe attributes. */
+
+static inline bool llapi_stripe_size_is_aligned(uint64_t size)
+{
+       return (size & (LOV_MIN_STRIPE_SIZE - 1)) == 0;
+}
+
+static inline bool llapi_stripe_size_is_too_big(uint64_t size)
+{
+       return size >= (1ULL << 32);
+}
+
+static inline bool llapi_stripe_count_is_valid(int64_t count)
+{
+       return count >= -1 && count <= LOV_MAX_STRIPE_COUNT;
+}
+
+static inline bool llapi_stripe_index_is_valid(int64_t index)
+{
+       return index >= -1 && index <= LOV_V1_INSANE_STRIPE_COUNT;
+}
+
+/* Compatibility macro for legacy llapi functions that use "offset"
+ * terminology instead of the preferred "index". */
+#define llapi_stripe_offset_is_valid(os) llapi_stripe_index_is_valid(os)
+
+static inline bool llapi_dir_stripe_count_is_valid(int64_t count)
+{
+       return count >= -1 && count <= LMV_MAX_STRIPE_COUNT;
+}
+
+static inline bool llapi_dir_stripe_index_is_valid(int64_t index)
+{
+       return index >= -1 && index < LMV_MAX_STRIPE_COUNT;
+}
+
+static inline bool llapi_dir_hash_type_is_valid(int64_t hash)
+{
+       return hash > LMV_HASH_TYPE_UNKNOWN && hash <  LMV_HASH_TYPE_MAX;
+}
+
+/*
+ * Kernel communication for Changelogs and HSM requests.
+ */
+int libcfs_ukuc_start(struct lustre_kernelcomm *l, int groups, int rfd_flags);
+int libcfs_ukuc_stop(struct lustre_kernelcomm *l);
+int libcfs_ukuc_get_rfd(struct lustre_kernelcomm *link);
+int libcfs_ukuc_msg_get(struct lustre_kernelcomm *l, char *buf, int maxsize,
+                       int transport);
 
+enum get_lmd_info_type {
+       GET_LMD_INFO = 1,
+       GET_LMD_STRIPE = 2,
+};
 
+int get_lmd_info_fd(char *path, int parentfd, int dirfd,
+                   void *lmd_buf, int lmd_len, enum get_lmd_info_type type);
 #endif /* _LUSTREAPI_INTERNAL_H_ */