1 #include <linux/kernel.h> 2 #include <linux/types.h> 3 #include <linux/spinlock_types.h> 4 #include <linux/slab.h> 5 #include <linux/ioctl.h> 6 7 extern struct client_debug_mask *cdm_array; 8 extern char *debug_help_string; 9 extern int help_string_initialized; 10 extern struct dentry *debug_dir; 11 extern struct dentry *help_file_dentry; 12 extern struct dentry *client_debug_dentry; 13 extern const struct file_operations debug_help_fops; 14 extern int client_all_index; 15 extern int client_verbose_index; 16 extern int cdm_element_count; 17 #define DEBUG_HELP_STRING_SIZE 4096 18 #define HELP_STRING_UNINITIALIZED \ 19 "Client Debug Keywords are unknown until the first time\n" \ 20 "the client is started after boot.\n" 21 #define ORANGEFS_KMOD_DEBUG_HELP_FILE "debug-help" 22 #define ORANGEFS_KMOD_DEBUG_FILE "kernel-debug" 23 #define ORANGEFS_CLIENT_DEBUG_FILE "client-debug" 24 #define ORANGEFS_VERBOSE "verbose" 25 #define ORANGEFS_ALL "all" 26 27 /* pvfs2-config.h ***********************************************************/ 28 #define ORANGEFS_VERSION_MAJOR 2 29 #define ORANGEFS_VERSION_MINOR 9 30 #define ORANGEFS_VERSION_SUB 0 31 32 /* khandle stuff ***********************************************************/ 33 34 /* 35 * The 2.9 core will put 64 bit handles in here like this: 36 * 1234 0000 0000 5678 37 * The 3.0 and beyond cores will put 128 bit handles in here like this: 38 * 1234 5678 90AB CDEF 39 * The kernel module will always use the first four bytes and 40 * the last four bytes as an inum. 41 */ 42 struct orangefs_khandle { 43 unsigned char u[16]; 44 } __aligned(8); 45 46 /* 47 * kernel version of an object ref. 48 */ 49 struct orangefs_object_kref { 50 struct orangefs_khandle khandle; 51 __s32 fs_id; 52 __s32 __pad1; 53 }; 54 55 /* 56 * compare 2 khandles assumes little endian thus from large address to 57 * small address 58 */ 59 static inline int ORANGEFS_khandle_cmp(const struct orangefs_khandle *kh1, 60 const struct orangefs_khandle *kh2) 61 { 62 int i; 63 64 for (i = 15; i >= 0; i--) { 65 if (kh1->u[i] > kh2->u[i]) 66 return 1; 67 if (kh1->u[i] < kh2->u[i]) 68 return -1; 69 } 70 71 return 0; 72 } 73 74 static inline void ORANGEFS_khandle_to(const struct orangefs_khandle *kh, 75 void *p, int size) 76 { 77 78 memcpy(p, kh->u, 16); 79 memset(p + 16, 0, size - 16); 80 81 } 82 83 static inline void ORANGEFS_khandle_from(struct orangefs_khandle *kh, 84 void *p, int size) 85 { 86 memset(kh, 0, 16); 87 memcpy(kh->u, p, 16); 88 89 } 90 91 /* pvfs2-types.h ************************************************************/ 92 typedef __u32 ORANGEFS_uid; 93 typedef __u32 ORANGEFS_gid; 94 typedef __s32 ORANGEFS_fs_id; 95 typedef __u32 ORANGEFS_permissions; 96 typedef __u64 ORANGEFS_time; 97 typedef __s64 ORANGEFS_size; 98 typedef __u64 ORANGEFS_flags; 99 typedef __u64 ORANGEFS_ds_position; 100 typedef __s32 ORANGEFS_error; 101 typedef __s64 ORANGEFS_offset; 102 103 #define ORANGEFS_SUPER_MAGIC 0x20030528 104 105 /* 106 * ORANGEFS error codes are a signed 32-bit integer. Error codes are negative, but 107 * the sign is stripped before decoding. 108 */ 109 110 /* Bit 31 is not used since it is the sign. */ 111 112 /* 113 * Bit 30 specifies that this is a ORANGEFS error. A ORANGEFS error is either an 114 * encoded errno value or a ORANGEFS protocol error. 115 */ 116 #define ORANGEFS_ERROR_BIT (1 << 30) 117 118 /* 119 * Bit 29 specifies that this is a ORANGEFS protocol error and not an encoded 120 * errno value. 121 */ 122 #define ORANGEFS_NON_ERRNO_ERROR_BIT (1 << 29) 123 124 /* 125 * Bits 9, 8, and 7 specify the error class, which encodes the section of 126 * server code the error originated in for logging purposes. It is not used 127 * in the kernel except to be masked out. 128 */ 129 #define ORANGEFS_ERROR_CLASS_BITS 0x380 130 131 /* Bits 6 - 0 are reserved for the actual error code. */ 132 #define ORANGEFS_ERROR_NUMBER_BITS 0x7f 133 134 /* Encoded errno values decoded by PINT_errno_mapping in orangefs-utils.c. */ 135 136 /* Our own ORANGEFS protocol error codes. */ 137 #define ORANGEFS_ECANCEL (1|ORANGEFS_NON_ERRNO_ERROR_BIT|ORANGEFS_ERROR_BIT) 138 #define ORANGEFS_EDEVINIT (2|ORANGEFS_NON_ERRNO_ERROR_BIT|ORANGEFS_ERROR_BIT) 139 #define ORANGEFS_EDETAIL (3|ORANGEFS_NON_ERRNO_ERROR_BIT|ORANGEFS_ERROR_BIT) 140 #define ORANGEFS_EHOSTNTFD (4|ORANGEFS_NON_ERRNO_ERROR_BIT|ORANGEFS_ERROR_BIT) 141 #define ORANGEFS_EADDRNTFD (5|ORANGEFS_NON_ERRNO_ERROR_BIT|ORANGEFS_ERROR_BIT) 142 #define ORANGEFS_ENORECVR (6|ORANGEFS_NON_ERRNO_ERROR_BIT|ORANGEFS_ERROR_BIT) 143 #define ORANGEFS_ETRYAGAIN (7|ORANGEFS_NON_ERRNO_ERROR_BIT|ORANGEFS_ERROR_BIT) 144 #define ORANGEFS_ENOTPVFS (8|ORANGEFS_NON_ERRNO_ERROR_BIT|ORANGEFS_ERROR_BIT) 145 #define ORANGEFS_ESECURITY (9|ORANGEFS_NON_ERRNO_ERROR_BIT|ORANGEFS_ERROR_BIT) 146 147 /* permission bits */ 148 #define ORANGEFS_O_EXECUTE (1 << 0) 149 #define ORANGEFS_O_WRITE (1 << 1) 150 #define ORANGEFS_O_READ (1 << 2) 151 #define ORANGEFS_G_EXECUTE (1 << 3) 152 #define ORANGEFS_G_WRITE (1 << 4) 153 #define ORANGEFS_G_READ (1 << 5) 154 #define ORANGEFS_U_EXECUTE (1 << 6) 155 #define ORANGEFS_U_WRITE (1 << 7) 156 #define ORANGEFS_U_READ (1 << 8) 157 /* no ORANGEFS_U_VTX (sticky bit) */ 158 #define ORANGEFS_G_SGID (1 << 10) 159 #define ORANGEFS_U_SUID (1 << 11) 160 161 /* definition taken from stdint.h */ 162 #define INT32_MAX (2147483647) 163 #define ORANGEFS_ITERATE_START (INT32_MAX - 1) 164 #define ORANGEFS_ITERATE_END (INT32_MAX - 2) 165 #define ORANGEFS_ITERATE_NEXT (INT32_MAX - 3) 166 #define ORANGEFS_READDIR_START ORANGEFS_ITERATE_START 167 #define ORANGEFS_READDIR_END ORANGEFS_ITERATE_END 168 #define ORANGEFS_IMMUTABLE_FL FS_IMMUTABLE_FL 169 #define ORANGEFS_APPEND_FL FS_APPEND_FL 170 #define ORANGEFS_NOATIME_FL FS_NOATIME_FL 171 #define ORANGEFS_MIRROR_FL 0x01000000ULL 172 #define ORANGEFS_O_EXECUTE (1 << 0) 173 #define ORANGEFS_FS_ID_NULL ((__s32)0) 174 #define ORANGEFS_ATTR_SYS_UID (1 << 0) 175 #define ORANGEFS_ATTR_SYS_GID (1 << 1) 176 #define ORANGEFS_ATTR_SYS_PERM (1 << 2) 177 #define ORANGEFS_ATTR_SYS_ATIME (1 << 3) 178 #define ORANGEFS_ATTR_SYS_CTIME (1 << 4) 179 #define ORANGEFS_ATTR_SYS_MTIME (1 << 5) 180 #define ORANGEFS_ATTR_SYS_TYPE (1 << 6) 181 #define ORANGEFS_ATTR_SYS_ATIME_SET (1 << 7) 182 #define ORANGEFS_ATTR_SYS_MTIME_SET (1 << 8) 183 #define ORANGEFS_ATTR_SYS_SIZE (1 << 20) 184 #define ORANGEFS_ATTR_SYS_LNK_TARGET (1 << 24) 185 #define ORANGEFS_ATTR_SYS_DFILE_COUNT (1 << 25) 186 #define ORANGEFS_ATTR_SYS_DIRENT_COUNT (1 << 26) 187 #define ORANGEFS_ATTR_SYS_BLKSIZE (1 << 28) 188 #define ORANGEFS_ATTR_SYS_MIRROR_COPIES_COUNT (1 << 29) 189 #define ORANGEFS_ATTR_SYS_COMMON_ALL \ 190 (ORANGEFS_ATTR_SYS_UID | \ 191 ORANGEFS_ATTR_SYS_GID | \ 192 ORANGEFS_ATTR_SYS_PERM | \ 193 ORANGEFS_ATTR_SYS_ATIME | \ 194 ORANGEFS_ATTR_SYS_CTIME | \ 195 ORANGEFS_ATTR_SYS_MTIME | \ 196 ORANGEFS_ATTR_SYS_TYPE) 197 198 #define ORANGEFS_ATTR_SYS_ALL_SETABLE \ 199 (ORANGEFS_ATTR_SYS_COMMON_ALL-ORANGEFS_ATTR_SYS_TYPE) 200 201 #define ORANGEFS_ATTR_SYS_ALL_NOHINT \ 202 (ORANGEFS_ATTR_SYS_COMMON_ALL | \ 203 ORANGEFS_ATTR_SYS_SIZE | \ 204 ORANGEFS_ATTR_SYS_LNK_TARGET | \ 205 ORANGEFS_ATTR_SYS_DFILE_COUNT | \ 206 ORANGEFS_ATTR_SYS_MIRROR_COPIES_COUNT | \ 207 ORANGEFS_ATTR_SYS_DIRENT_COUNT | \ 208 ORANGEFS_ATTR_SYS_BLKSIZE) 209 210 #define ORANGEFS_ATTR_SYS_ALL_NOHINT_NOSIZE \ 211 (ORANGEFS_ATTR_SYS_COMMON_ALL | \ 212 ORANGEFS_ATTR_SYS_LNK_TARGET | \ 213 ORANGEFS_ATTR_SYS_DFILE_COUNT | \ 214 ORANGEFS_ATTR_SYS_MIRROR_COPIES_COUNT | \ 215 ORANGEFS_ATTR_SYS_DIRENT_COUNT | \ 216 ORANGEFS_ATTR_SYS_BLKSIZE) 217 218 #define ORANGEFS_XATTR_REPLACE 0x2 219 #define ORANGEFS_XATTR_CREATE 0x1 220 #define ORANGEFS_MAX_SERVER_ADDR_LEN 256 221 #define ORANGEFS_NAME_MAX 256 222 /* 223 * max extended attribute name len as imposed by the VFS and exploited for the 224 * upcall request types. 225 * NOTE: Please retain them as multiples of 8 even if you wish to change them 226 * This is *NECESSARY* for supporting 32 bit user-space binaries on a 64-bit 227 * kernel. Due to implementation within DBPF, this really needs to be 228 * ORANGEFS_NAME_MAX, which it was the same value as, but no reason to let it 229 * break if that changes in the future. 230 */ 231 #define ORANGEFS_MAX_XATTR_NAMELEN ORANGEFS_NAME_MAX /* Not the same as 232 * XATTR_NAME_MAX defined 233 * by <linux/xattr.h> 234 */ 235 #define ORANGEFS_MAX_XATTR_VALUELEN 8192 /* Not the same as XATTR_SIZE_MAX 236 * defined by <linux/xattr.h> 237 */ 238 #define ORANGEFS_MAX_XATTR_LISTLEN 16 /* Not the same as XATTR_LIST_MAX 239 * defined by <linux/xattr.h> 240 */ 241 /* 242 * ORANGEFS I/O operation types, used in both system and server interfaces. 243 */ 244 enum ORANGEFS_io_type { 245 ORANGEFS_IO_READ = 1, 246 ORANGEFS_IO_WRITE = 2 247 }; 248 249 /* 250 * If this enum is modified the server parameters related to the precreate pool 251 * batch and low threshold sizes may need to be modified to reflect this 252 * change. 253 */ 254 enum orangefs_ds_type { 255 ORANGEFS_TYPE_NONE = 0, 256 ORANGEFS_TYPE_METAFILE = (1 << 0), 257 ORANGEFS_TYPE_DATAFILE = (1 << 1), 258 ORANGEFS_TYPE_DIRECTORY = (1 << 2), 259 ORANGEFS_TYPE_SYMLINK = (1 << 3), 260 ORANGEFS_TYPE_DIRDATA = (1 << 4), 261 ORANGEFS_TYPE_INTERNAL = (1 << 5) /* for the server's private use */ 262 }; 263 264 /* 265 * ORANGEFS_certificate simply stores a buffer with the buffer size. 266 * The buffer can be converted to an OpenSSL X509 struct for use. 267 */ 268 struct ORANGEFS_certificate { 269 __u32 buf_size; 270 unsigned char *buf; 271 }; 272 273 /* 274 * A credential identifies a user and is signed by the client/user 275 * private key. 276 */ 277 struct ORANGEFS_credential { 278 __u32 userid; /* user id */ 279 __u32 num_groups; /* length of group_array */ 280 __u32 *group_array; /* groups for which the user is a member */ 281 char *issuer; /* alias of the issuing server */ 282 __u64 timeout; /* seconds after epoch to time out */ 283 __u32 sig_size; /* length of the signature in bytes */ 284 unsigned char *signature; /* digital signature */ 285 struct ORANGEFS_certificate certificate; /* user certificate buffer */ 286 }; 287 #define extra_size_ORANGEFS_credential (ORANGEFS_REQ_LIMIT_GROUPS * \ 288 sizeof(__u32) + \ 289 ORANGEFS_REQ_LIMIT_ISSUER + \ 290 ORANGEFS_REQ_LIMIT_SIGNATURE + \ 291 extra_size_ORANGEFS_certificate) 292 293 /* This structure is used by the VFS-client interaction alone */ 294 struct ORANGEFS_keyval_pair { 295 char key[ORANGEFS_MAX_XATTR_NAMELEN]; 296 __s32 key_sz; /* __s32 for portable, fixed-size structures */ 297 __s32 val_sz; 298 char val[ORANGEFS_MAX_XATTR_VALUELEN]; 299 }; 300 301 /* pvfs2-sysint.h ***********************************************************/ 302 /* Describes attributes for a file, directory, or symlink. */ 303 struct ORANGEFS_sys_attr_s { 304 __u32 owner; 305 __u32 group; 306 __u32 perms; 307 __u64 atime; 308 __u64 mtime; 309 __u64 ctime; 310 __s64 size; 311 312 /* NOTE: caller must free if valid */ 313 char *link_target; 314 315 /* Changed to __s32 so that size of structure does not change */ 316 __s32 dfile_count; 317 318 /* Changed to __s32 so that size of structure does not change */ 319 __s32 distr_dir_servers_initial; 320 321 /* Changed to __s32 so that size of structure does not change */ 322 __s32 distr_dir_servers_max; 323 324 /* Changed to __s32 so that size of structure does not change */ 325 __s32 distr_dir_split_size; 326 327 __u32 mirror_copies_count; 328 329 /* NOTE: caller must free if valid */ 330 char *dist_name; 331 332 /* NOTE: caller must free if valid */ 333 char *dist_params; 334 335 __s64 dirent_count; 336 enum orangefs_ds_type objtype; 337 __u64 flags; 338 __u32 mask; 339 __s64 blksize; 340 }; 341 342 #define ORANGEFS_LOOKUP_LINK_NO_FOLLOW 0 343 344 /* pint-dev.h ***************************************************************/ 345 346 /* parameter structure used in ORANGEFS_DEV_DEBUG ioctl command */ 347 struct dev_mask_info_s { 348 enum { 349 KERNEL_MASK, 350 CLIENT_MASK, 351 } mask_type; 352 __u64 mask_value; 353 }; 354 355 struct dev_mask2_info_s { 356 __u64 mask1_value; 357 __u64 mask2_value; 358 }; 359 360 /* pvfs2-util.h *************************************************************/ 361 __s32 ORANGEFS_util_translate_mode(int mode); 362 363 /* pvfs2-debug.h ************************************************************/ 364 #include "orangefs-debug.h" 365 366 /* pvfs2-internal.h *********************************************************/ 367 #define llu(x) (unsigned long long)(x) 368 #define lld(x) (long long)(x) 369 370 /* pint-dev-shared.h ********************************************************/ 371 #define ORANGEFS_DEV_MAGIC 'k' 372 373 #define ORANGEFS_READDIR_DEFAULT_DESC_COUNT 5 374 375 #define DEV_GET_MAGIC 0x1 376 #define DEV_GET_MAX_UPSIZE 0x2 377 #define DEV_GET_MAX_DOWNSIZE 0x3 378 #define DEV_MAP 0x4 379 #define DEV_REMOUNT_ALL 0x5 380 #define DEV_DEBUG 0x6 381 #define DEV_UPSTREAM 0x7 382 #define DEV_CLIENT_MASK 0x8 383 #define DEV_CLIENT_STRING 0x9 384 #define DEV_MAX_NR 0xa 385 386 /* supported ioctls, codes are with respect to user-space */ 387 enum { 388 ORANGEFS_DEV_GET_MAGIC = _IOW(ORANGEFS_DEV_MAGIC, DEV_GET_MAGIC, __s32), 389 ORANGEFS_DEV_GET_MAX_UPSIZE = 390 _IOW(ORANGEFS_DEV_MAGIC, DEV_GET_MAX_UPSIZE, __s32), 391 ORANGEFS_DEV_GET_MAX_DOWNSIZE = 392 _IOW(ORANGEFS_DEV_MAGIC, DEV_GET_MAX_DOWNSIZE, __s32), 393 ORANGEFS_DEV_MAP = _IO(ORANGEFS_DEV_MAGIC, DEV_MAP), 394 ORANGEFS_DEV_REMOUNT_ALL = _IO(ORANGEFS_DEV_MAGIC, DEV_REMOUNT_ALL), 395 ORANGEFS_DEV_DEBUG = _IOR(ORANGEFS_DEV_MAGIC, DEV_DEBUG, __s32), 396 ORANGEFS_DEV_UPSTREAM = _IOW(ORANGEFS_DEV_MAGIC, DEV_UPSTREAM, int), 397 ORANGEFS_DEV_CLIENT_MASK = _IOW(ORANGEFS_DEV_MAGIC, 398 DEV_CLIENT_MASK, 399 struct dev_mask2_info_s), 400 ORANGEFS_DEV_CLIENT_STRING = _IOW(ORANGEFS_DEV_MAGIC, 401 DEV_CLIENT_STRING, 402 char *), 403 ORANGEFS_DEV_MAXNR = DEV_MAX_NR, 404 }; 405 406 /* 407 * version number for use in communicating between kernel space and user 408 * space. Zero signifies the upstream version of the kernel module. 409 */ 410 #define ORANGEFS_KERNEL_PROTO_VERSION 0 411 #define ORANGEFS_MINIMUM_USERSPACE_VERSION 20903 412 413 /* 414 * describes memory regions to map in the ORANGEFS_DEV_MAP ioctl. 415 * NOTE: See devorangefs-req.c for 32 bit compat structure. 416 * Since this structure has a variable-sized layout that is different 417 * on 32 and 64 bit platforms, we need to normalize to a 64 bit layout 418 * on such systems before servicing ioctl calls from user-space binaries 419 * that may be 32 bit! 420 */ 421 struct ORANGEFS_dev_map_desc { 422 void *ptr; 423 __s32 total_size; 424 __s32 size; 425 __s32 count; 426 }; 427 428 /* gossip.h *****************************************************************/ 429 430 #ifdef GOSSIP_DISABLE_DEBUG 431 #define gossip_debug(mask, fmt, ...) \ 432 do { \ 433 if (0) \ 434 printk(KERN_DEBUG fmt, ##__VA_ARGS__); \ 435 } while (0) 436 #else 437 extern __u64 gossip_debug_mask; 438 extern struct client_debug_mask client_debug_mask; 439 440 /* try to avoid function call overhead by checking masks in macro */ 441 #define gossip_debug(mask, fmt, ...) \ 442 do { \ 443 if (gossip_debug_mask & (mask)) \ 444 printk(KERN_DEBUG fmt, ##__VA_ARGS__); \ 445 } while (0) 446 #endif /* GOSSIP_DISABLE_DEBUG */ 447 448 /* do file and line number printouts w/ the GNU preprocessor */ 449 #define gossip_ldebug(mask, fmt, ...) \ 450 gossip_debug(mask, "%s: " fmt, __func__, ##__VA_ARGS__) 451 452 #define gossip_err pr_err 453 #define gossip_lerr(fmt, ...) \ 454 gossip_err("%s line %d: " fmt, \ 455 __FILE__, __LINE__, ##__VA_ARGS__) 456