]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - fs/orangefs/pvfs2-utils.c
Orangefs: Clean up error decoding.
[mirror_ubuntu-artful-kernel.git] / fs / orangefs / pvfs2-utils.c
CommitLineData
f7be4ee0
MM
1/*
2 * (C) 2001 Clemson University and The University of Chicago
3 *
4 * See COPYING in top-level directory.
5 */
6#include "protocol.h"
7#include "pvfs2-kernel.h"
8#include "pvfs2-dev-proto.h"
9#include "pvfs2-bufmap.h"
10
11__s32 fsid_of_op(struct pvfs2_kernel_op_s *op)
12{
13 __s32 fsid = PVFS_FS_ID_NULL;
14
15 if (op) {
16 switch (op->upcall.type) {
17 case PVFS2_VFS_OP_FILE_IO:
18 fsid = op->upcall.req.io.refn.fs_id;
19 break;
20 case PVFS2_VFS_OP_LOOKUP:
21 fsid = op->upcall.req.lookup.parent_refn.fs_id;
22 break;
23 case PVFS2_VFS_OP_CREATE:
24 fsid = op->upcall.req.create.parent_refn.fs_id;
25 break;
26 case PVFS2_VFS_OP_GETATTR:
27 fsid = op->upcall.req.getattr.refn.fs_id;
28 break;
29 case PVFS2_VFS_OP_REMOVE:
30 fsid = op->upcall.req.remove.parent_refn.fs_id;
31 break;
32 case PVFS2_VFS_OP_MKDIR:
33 fsid = op->upcall.req.mkdir.parent_refn.fs_id;
34 break;
35 case PVFS2_VFS_OP_READDIR:
36 fsid = op->upcall.req.readdir.refn.fs_id;
37 break;
38 case PVFS2_VFS_OP_SETATTR:
39 fsid = op->upcall.req.setattr.refn.fs_id;
40 break;
41 case PVFS2_VFS_OP_SYMLINK:
42 fsid = op->upcall.req.sym.parent_refn.fs_id;
43 break;
44 case PVFS2_VFS_OP_RENAME:
45 fsid = op->upcall.req.rename.old_parent_refn.fs_id;
46 break;
47 case PVFS2_VFS_OP_STATFS:
48 fsid = op->upcall.req.statfs.fs_id;
49 break;
50 case PVFS2_VFS_OP_TRUNCATE:
51 fsid = op->upcall.req.truncate.refn.fs_id;
52 break;
53 case PVFS2_VFS_OP_MMAP_RA_FLUSH:
54 fsid = op->upcall.req.ra_cache_flush.refn.fs_id;
55 break;
56 case PVFS2_VFS_OP_FS_UMOUNT:
57 fsid = op->upcall.req.fs_umount.fs_id;
58 break;
59 case PVFS2_VFS_OP_GETXATTR:
60 fsid = op->upcall.req.getxattr.refn.fs_id;
61 break;
62 case PVFS2_VFS_OP_SETXATTR:
63 fsid = op->upcall.req.setxattr.refn.fs_id;
64 break;
65 case PVFS2_VFS_OP_LISTXATTR:
66 fsid = op->upcall.req.listxattr.refn.fs_id;
67 break;
68 case PVFS2_VFS_OP_REMOVEXATTR:
69 fsid = op->upcall.req.removexattr.refn.fs_id;
70 break;
71 case PVFS2_VFS_OP_FSYNC:
72 fsid = op->upcall.req.fsync.refn.fs_id;
73 break;
74 default:
75 break;
76 }
77 }
78 return fsid;
79}
80
81static void pvfs2_set_inode_flags(struct inode *inode,
82 struct PVFS_sys_attr_s *attrs)
83{
84 if (attrs->flags & PVFS_IMMUTABLE_FL)
85 inode->i_flags |= S_IMMUTABLE;
86 else
87 inode->i_flags &= ~S_IMMUTABLE;
88
89 if (attrs->flags & PVFS_APPEND_FL)
90 inode->i_flags |= S_APPEND;
91 else
92 inode->i_flags &= ~S_APPEND;
93
94 if (attrs->flags & PVFS_NOATIME_FL)
95 inode->i_flags |= S_NOATIME;
96 else
97 inode->i_flags &= ~S_NOATIME;
98
99}
100
101/* NOTE: symname is ignored unless the inode is a sym link */
102static int copy_attributes_to_inode(struct inode *inode,
103 struct PVFS_sys_attr_s *attrs,
104 char *symname)
105{
106 int ret = -1;
107 int perm_mode = 0;
108 struct pvfs2_inode_s *pvfs2_inode = PVFS2_I(inode);
109 loff_t inode_size = 0;
110 loff_t rounded_up_size = 0;
111
112
113 /*
114 arbitrarily set the inode block size; FIXME: we need to
115 resolve the difference between the reported inode blocksize
116 and the PAGE_CACHE_SIZE, since our block count will always
117 be wrong.
118
119 For now, we're setting the block count to be the proper
120 number assuming the block size is 512 bytes, and the size is
121 rounded up to the nearest 4K. This is apparently required
122 to get proper size reports from the 'du' shell utility.
123
124 changing the inode->i_blkbits to something other than
125 PAGE_CACHE_SHIFT breaks mmap/execution as we depend on that.
126 */
127 gossip_debug(GOSSIP_UTILS_DEBUG,
128 "attrs->mask = %x (objtype = %s)\n",
129 attrs->mask,
130 attrs->objtype == PVFS_TYPE_METAFILE ? "file" :
131 attrs->objtype == PVFS_TYPE_DIRECTORY ? "directory" :
132 attrs->objtype == PVFS_TYPE_SYMLINK ? "symlink" :
133 "invalid/unknown");
134
135 switch (attrs->objtype) {
136 case PVFS_TYPE_METAFILE:
137 pvfs2_set_inode_flags(inode, attrs);
138 if (attrs->mask & PVFS_ATTR_SYS_SIZE) {
139 inode_size = (loff_t) attrs->size;
140 rounded_up_size =
141 (inode_size + (4096 - (inode_size % 4096)));
142
143 pvfs2_lock_inode(inode);
144 inode->i_bytes = inode_size;
145 inode->i_blocks =
146 (unsigned long)(rounded_up_size / 512);
147 pvfs2_unlock_inode(inode);
148
149 /*
150 * NOTE: make sure all the places we're called
151 * from have the inode->i_sem lock. We're fine
152 * in 99% of the cases since we're mostly
153 * called from a lookup.
154 */
155 inode->i_size = inode_size;
156 }
157 break;
158 case PVFS_TYPE_SYMLINK:
159 if (symname != NULL) {
160 inode->i_size = (loff_t) strlen(symname);
161 break;
162 }
163 /*FALLTHRU*/
164 default:
f0566532
MM
165 inode->i_size = PAGE_CACHE_SIZE;
166
f7be4ee0 167 pvfs2_lock_inode(inode);
f0566532 168 inode_set_bytes(inode, inode->i_size);
f7be4ee0 169 pvfs2_unlock_inode(inode);
f7be4ee0
MM
170 break;
171 }
172
173 inode->i_uid = make_kuid(&init_user_ns, attrs->owner);
174 inode->i_gid = make_kgid(&init_user_ns, attrs->group);
175 inode->i_atime.tv_sec = (time_t) attrs->atime;
176 inode->i_mtime.tv_sec = (time_t) attrs->mtime;
177 inode->i_ctime.tv_sec = (time_t) attrs->ctime;
178 inode->i_atime.tv_nsec = 0;
179 inode->i_mtime.tv_nsec = 0;
180 inode->i_ctime.tv_nsec = 0;
181
182 if (attrs->perms & PVFS_O_EXECUTE)
183 perm_mode |= S_IXOTH;
184 if (attrs->perms & PVFS_O_WRITE)
185 perm_mode |= S_IWOTH;
186 if (attrs->perms & PVFS_O_READ)
187 perm_mode |= S_IROTH;
188
189 if (attrs->perms & PVFS_G_EXECUTE)
190 perm_mode |= S_IXGRP;
191 if (attrs->perms & PVFS_G_WRITE)
192 perm_mode |= S_IWGRP;
193 if (attrs->perms & PVFS_G_READ)
194 perm_mode |= S_IRGRP;
195
196 if (attrs->perms & PVFS_U_EXECUTE)
197 perm_mode |= S_IXUSR;
198 if (attrs->perms & PVFS_U_WRITE)
199 perm_mode |= S_IWUSR;
200 if (attrs->perms & PVFS_U_READ)
201 perm_mode |= S_IRUSR;
202
203 if (attrs->perms & PVFS_G_SGID)
204 perm_mode |= S_ISGID;
205 if (attrs->perms & PVFS_U_SUID)
206 perm_mode |= S_ISUID;
207
208 inode->i_mode = perm_mode;
209
210 if (is_root_handle(inode)) {
211 /* special case: mark the root inode as sticky */
212 inode->i_mode |= S_ISVTX;
213 gossip_debug(GOSSIP_UTILS_DEBUG,
214 "Marking inode %pU as sticky\n",
215 get_khandle_from_ino(inode));
216 }
217
218 switch (attrs->objtype) {
219 case PVFS_TYPE_METAFILE:
220 inode->i_mode |= S_IFREG;
221 ret = 0;
222 break;
223 case PVFS_TYPE_DIRECTORY:
224 inode->i_mode |= S_IFDIR;
225 /* NOTE: we have no good way to keep nlink consistent
226 * for directories across clients; keep constant at 1.
227 * Why 1? If we go with 2, then find(1) gets confused
228 * and won't work properly withouth the -noleaf option
229 */
230 set_nlink(inode, 1);
231 ret = 0;
232 break;
233 case PVFS_TYPE_SYMLINK:
234 inode->i_mode |= S_IFLNK;
235
236 /* copy link target to inode private data */
237 if (pvfs2_inode && symname) {
238 strncpy(pvfs2_inode->link_target,
239 symname,
240 PVFS_NAME_MAX);
241 gossip_debug(GOSSIP_UTILS_DEBUG,
242 "Copied attr link target %s\n",
243 pvfs2_inode->link_target);
244 }
245 gossip_debug(GOSSIP_UTILS_DEBUG,
246 "symlink mode %o\n",
247 inode->i_mode);
248 ret = 0;
249 break;
250 default:
251 gossip_err("pvfs2: copy_attributes_to_inode: got invalid attribute type %x\n",
252 attrs->objtype);
253 }
254
255 gossip_debug(GOSSIP_UTILS_DEBUG,
256 "pvfs2: copy_attributes_to_inode: setting i_mode to %o, i_size to %lu\n",
257 inode->i_mode,
258 (unsigned long)i_size_read(inode));
259
260 return ret;
261}
262
263/*
264 * NOTE: in kernel land, we never use the sys_attr->link_target for
265 * anything, so don't bother copying it into the sys_attr object here.
266 */
267static inline int copy_attributes_from_inode(struct inode *inode,
268 struct PVFS_sys_attr_s *attrs,
269 struct iattr *iattr)
270{
271 umode_t tmp_mode;
272
273 if (!iattr || !inode || !attrs) {
274 gossip_err("NULL iattr (%p), inode (%p), attrs (%p) "
275 "in copy_attributes_from_inode!\n",
276 iattr,
277 inode,
278 attrs);
279 return -EINVAL;
280 }
281 /*
282 * We need to be careful to only copy the attributes out of the
283 * iattr object that we know are valid.
284 */
285 attrs->mask = 0;
286 if (iattr->ia_valid & ATTR_UID) {
287 attrs->owner = from_kuid(current_user_ns(), iattr->ia_uid);
288 attrs->mask |= PVFS_ATTR_SYS_UID;
289 gossip_debug(GOSSIP_UTILS_DEBUG, "(UID) %d\n", attrs->owner);
290 }
291 if (iattr->ia_valid & ATTR_GID) {
292 attrs->group = from_kgid(current_user_ns(), iattr->ia_gid);
293 attrs->mask |= PVFS_ATTR_SYS_GID;
294 gossip_debug(GOSSIP_UTILS_DEBUG, "(GID) %d\n", attrs->group);
295 }
296
297 if (iattr->ia_valid & ATTR_ATIME) {
298 attrs->mask |= PVFS_ATTR_SYS_ATIME;
299 if (iattr->ia_valid & ATTR_ATIME_SET) {
300 attrs->atime =
301 pvfs2_convert_time_field((void *)&iattr->ia_atime);
302 attrs->mask |= PVFS_ATTR_SYS_ATIME_SET;
303 }
304 }
305 if (iattr->ia_valid & ATTR_MTIME) {
306 attrs->mask |= PVFS_ATTR_SYS_MTIME;
307 if (iattr->ia_valid & ATTR_MTIME_SET) {
308 attrs->mtime =
309 pvfs2_convert_time_field((void *)&iattr->ia_mtime);
310 attrs->mask |= PVFS_ATTR_SYS_MTIME_SET;
311 }
312 }
313 if (iattr->ia_valid & ATTR_CTIME)
314 attrs->mask |= PVFS_ATTR_SYS_CTIME;
315
316 /*
317 * PVFS2 cannot set size with a setattr operation. Probably not likely
318 * to be requested through the VFS, but just in case, don't worry about
319 * ATTR_SIZE
320 */
321
322 if (iattr->ia_valid & ATTR_MODE) {
323 tmp_mode = iattr->ia_mode;
324 if (tmp_mode & (S_ISVTX)) {
325 if (is_root_handle(inode)) {
326 /*
327 * allow sticky bit to be set on root (since
328 * it shows up that way by default anyhow),
329 * but don't show it to the server
330 */
331 tmp_mode -= S_ISVTX;
332 } else {
333 gossip_debug(GOSSIP_UTILS_DEBUG,
334 "User attempted to set sticky bit on non-root directory; returning EINVAL.\n");
335 return -EINVAL;
336 }
337 }
338
339 if (tmp_mode & (S_ISUID)) {
340 gossip_debug(GOSSIP_UTILS_DEBUG,
341 "Attempting to set setuid bit (not supported); returning EINVAL.\n");
342 return -EINVAL;
343 }
344
345 attrs->perms = PVFS_util_translate_mode(tmp_mode);
346 attrs->mask |= PVFS_ATTR_SYS_PERM;
347 }
348
349 return 0;
350}
351
352/*
353 * issues a pvfs2 getattr request and fills in the appropriate inode
354 * attributes if successful. returns 0 on success; -errno otherwise
355 */
356int pvfs2_inode_getattr(struct inode *inode, __u32 getattr_mask)
357{
358 struct pvfs2_inode_s *pvfs2_inode = PVFS2_I(inode);
359 struct pvfs2_kernel_op_s *new_op;
360 int ret = -EINVAL;
361
362 gossip_debug(GOSSIP_UTILS_DEBUG,
363 "%s: called on inode %pU\n",
364 __func__,
365 get_khandle_from_ino(inode));
366
367 new_op = op_alloc(PVFS2_VFS_OP_GETATTR);
368 if (!new_op)
369 return -ENOMEM;
370 new_op->upcall.req.getattr.refn = pvfs2_inode->refn;
371 new_op->upcall.req.getattr.mask = getattr_mask;
372
373 ret = service_operation(new_op, __func__,
374 get_interruptible_flag(inode));
375 if (ret != 0)
376 goto out;
377
378 if (copy_attributes_to_inode(inode,
379 &new_op->downcall.resp.getattr.attributes,
380 new_op->downcall.resp.getattr.link_target)) {
381 gossip_err("%s: failed to copy attributes\n", __func__);
382 ret = -ENOENT;
383 goto out;
384 }
385
386 /*
387 * Store blksize in pvfs2 specific part of inode structure; we are
388 * only going to use this to report to stat to make sure it doesn't
389 * perturb any inode related code paths.
390 */
391 if (new_op->downcall.resp.getattr.attributes.objtype ==
392 PVFS_TYPE_METAFILE) {
393 pvfs2_inode->blksize =
394 new_op->downcall.resp.getattr.attributes.blksize;
395 } else {
396 /* mimic behavior of generic_fillattr() for other types. */
397 pvfs2_inode->blksize = (1 << inode->i_blkbits);
398
399 }
400
401out:
402 gossip_debug(GOSSIP_UTILS_DEBUG,
403 "Getattr on handle %pU, "
404 "fsid %d\n (inode ct = %d) returned %d\n",
405 &pvfs2_inode->refn.khandle,
406 pvfs2_inode->refn.fs_id,
407 (int)atomic_read(&inode->i_count),
408 ret);
409
410 op_release(new_op);
411 return ret;
412}
413
414/*
415 * issues a pvfs2 setattr request to make sure the new attribute values
416 * take effect if successful. returns 0 on success; -errno otherwise
417 */
418int pvfs2_inode_setattr(struct inode *inode, struct iattr *iattr)
419{
420 struct pvfs2_inode_s *pvfs2_inode = PVFS2_I(inode);
421 struct pvfs2_kernel_op_s *new_op;
422 int ret;
423
424 new_op = op_alloc(PVFS2_VFS_OP_SETATTR);
425 if (!new_op)
426 return -ENOMEM;
427
428 new_op->upcall.req.setattr.refn = pvfs2_inode->refn;
429 ret = copy_attributes_from_inode(inode,
430 &new_op->upcall.req.setattr.attributes,
431 iattr);
432 if (ret < 0) {
433 op_release(new_op);
434 return ret;
435 }
436
437 ret = service_operation(new_op, __func__,
438 get_interruptible_flag(inode));
439
440 gossip_debug(GOSSIP_UTILS_DEBUG,
441 "pvfs2_inode_setattr: returning %d\n",
442 ret);
443
444 /* when request is serviced properly, free req op struct */
445 op_release(new_op);
446
447 /*
448 * successful setattr should clear the atime, mtime and
449 * ctime flags.
450 */
451 if (ret == 0) {
452 ClearAtimeFlag(pvfs2_inode);
453 ClearMtimeFlag(pvfs2_inode);
454 ClearCtimeFlag(pvfs2_inode);
455 ClearModeFlag(pvfs2_inode);
456 }
457
458 return ret;
459}
460
461int pvfs2_flush_inode(struct inode *inode)
462{
463 /*
464 * If it is a dirty inode, this function gets called.
465 * Gather all the information that needs to be setattr'ed
466 * Right now, this will only be used for mode, atime, mtime
467 * and/or ctime.
468 */
469 struct iattr wbattr;
470 int ret;
471 int mtime_flag;
472 int ctime_flag;
473 int atime_flag;
474 int mode_flag;
475 struct pvfs2_inode_s *pvfs2_inode = PVFS2_I(inode);
476
477 memset(&wbattr, 0, sizeof(wbattr));
478
479 /*
480 * check inode flags up front, and clear them if they are set. This
481 * will prevent multiple processes from all trying to flush the same
482 * inode if they call close() simultaneously
483 */
484 mtime_flag = MtimeFlag(pvfs2_inode);
485 ClearMtimeFlag(pvfs2_inode);
486 ctime_flag = CtimeFlag(pvfs2_inode);
487 ClearCtimeFlag(pvfs2_inode);
488 atime_flag = AtimeFlag(pvfs2_inode);
489 ClearAtimeFlag(pvfs2_inode);
490 mode_flag = ModeFlag(pvfs2_inode);
491 ClearModeFlag(pvfs2_inode);
492
493 /* -- Lazy atime,mtime and ctime update --
494 * Note: all times are dictated by server in the new scheme
495 * and not by the clients
496 *
497 * Also mode updates are being handled now..
498 */
499
500 if (mtime_flag)
501 wbattr.ia_valid |= ATTR_MTIME;
502 if (ctime_flag)
503 wbattr.ia_valid |= ATTR_CTIME;
504 if (atime_flag)
505 wbattr.ia_valid |= ATTR_ATIME;
506
507 if (mode_flag) {
508 wbattr.ia_mode = inode->i_mode;
509 wbattr.ia_valid |= ATTR_MODE;
510 }
511
512 gossip_debug(GOSSIP_UTILS_DEBUG,
513 "*********** pvfs2_flush_inode: %pU "
514 "(ia_valid %d)\n",
515 get_khandle_from_ino(inode),
516 wbattr.ia_valid);
517 if (wbattr.ia_valid == 0) {
518 gossip_debug(GOSSIP_UTILS_DEBUG,
519 "pvfs2_flush_inode skipping setattr()\n");
520 return 0;
521 }
522
523 gossip_debug(GOSSIP_UTILS_DEBUG,
524 "pvfs2_flush_inode (%pU) writing mode %o\n",
525 get_khandle_from_ino(inode),
526 inode->i_mode);
527
528 ret = pvfs2_inode_setattr(inode, &wbattr);
529
530 return ret;
531}
532
533int pvfs2_unmount_sb(struct super_block *sb)
534{
535 int ret = -EINVAL;
536 struct pvfs2_kernel_op_s *new_op = NULL;
537
538 gossip_debug(GOSSIP_UTILS_DEBUG,
539 "pvfs2_unmount_sb called on sb %p\n",
540 sb);
541
542 new_op = op_alloc(PVFS2_VFS_OP_FS_UMOUNT);
543 if (!new_op)
544 return -ENOMEM;
545 new_op->upcall.req.fs_umount.id = PVFS2_SB(sb)->id;
546 new_op->upcall.req.fs_umount.fs_id = PVFS2_SB(sb)->fs_id;
547 strncpy(new_op->upcall.req.fs_umount.pvfs2_config_server,
548 PVFS2_SB(sb)->devname,
549 PVFS_MAX_SERVER_ADDR_LEN);
550
551 gossip_debug(GOSSIP_UTILS_DEBUG,
552 "Attempting PVFS2 Unmount via host %s\n",
553 new_op->upcall.req.fs_umount.pvfs2_config_server);
554
555 ret = service_operation(new_op, "pvfs2_fs_umount", 0);
556
557 gossip_debug(GOSSIP_UTILS_DEBUG,
558 "pvfs2_unmount: got return value of %d\n", ret);
559 if (ret)
560 sb = ERR_PTR(ret);
561 else
562 PVFS2_SB(sb)->mount_pending = 1;
563
564 op_release(new_op);
565 return ret;
566}
567
568/*
569 * NOTE: on successful cancellation, be sure to return -EINTR, as
570 * that's the return value the caller expects
571 */
572int pvfs2_cancel_op_in_progress(__u64 tag)
573{
574 int ret = -EINVAL;
575 struct pvfs2_kernel_op_s *new_op = NULL;
576
577 gossip_debug(GOSSIP_UTILS_DEBUG,
578 "pvfs2_cancel_op_in_progress called on tag %llu\n",
579 llu(tag));
580
581 new_op = op_alloc(PVFS2_VFS_OP_CANCEL);
582 if (!new_op)
583 return -ENOMEM;
584 new_op->upcall.req.cancel.op_tag = tag;
585
586 gossip_debug(GOSSIP_UTILS_DEBUG,
587 "Attempting PVFS2 operation cancellation of tag %llu\n",
588 llu(new_op->upcall.req.cancel.op_tag));
589
590 ret = service_operation(new_op, "pvfs2_cancel", PVFS2_OP_CANCELLATION);
591
592 gossip_debug(GOSSIP_UTILS_DEBUG,
593 "pvfs2_cancel_op_in_progress: got return value of %d\n",
594 ret);
595
596 op_release(new_op);
597 return ret;
598}
599
600void pvfs2_op_initialize(struct pvfs2_kernel_op_s *op)
601{
602 if (op) {
603 spin_lock(&op->lock);
604 op->io_completed = 0;
605
606 op->upcall.type = PVFS2_VFS_OP_INVALID;
607 op->downcall.type = PVFS2_VFS_OP_INVALID;
608 op->downcall.status = -1;
609
610 op->op_state = OP_VFS_STATE_UNKNOWN;
611 op->tag = 0;
612 spin_unlock(&op->lock);
613 }
614}
615
616void pvfs2_make_bad_inode(struct inode *inode)
617{
618 if (is_root_handle(inode)) {
619 /*
620 * if this occurs, the pvfs2-client-core was killed but we
621 * can't afford to lose the inode operations and such
622 * associated with the root handle in any case.
623 */
624 gossip_debug(GOSSIP_UTILS_DEBUG,
625 "*** NOT making bad root inode %pU\n",
626 get_khandle_from_ino(inode));
627 } else {
628 gossip_debug(GOSSIP_UTILS_DEBUG,
629 "*** making bad inode %pU\n",
630 get_khandle_from_ino(inode));
631 make_bad_inode(inode);
632 }
633}
634
8c3905ad
MM
635/* Block all blockable signals... */
636void block_signals(sigset_t *orig_sigset)
f7be4ee0 637{
8c3905ad
MM
638 sigset_t mask;
639
640 /*
641 * Initialize all entries in the signal set to the
642 * inverse of the given mask.
643 */
644 siginitsetinv(&mask, sigmask(SIGKILL));
645
646 /* Block 'em Danno... */
647 sigprocmask(SIG_BLOCK, &mask, orig_sigset);
f7be4ee0
MM
648}
649
8c3905ad
MM
650/* set the signal mask to the given template... */
651void set_signals(sigset_t *sigset)
f7be4ee0 652{
8c3905ad 653 sigprocmask(SIG_SETMASK, sigset, NULL);
f7be4ee0
MM
654}
655
656__u64 pvfs2_convert_time_field(void *time_ptr)
657{
658 __u64 pvfs2_time;
659 struct timespec *tspec = (struct timespec *)time_ptr;
660
661 pvfs2_time = (__u64) ((time_t) tspec->tv_sec);
662 return pvfs2_time;
663}
664
894ac432
MB
665/* The following is a very dirty hack that is now a permanent part of the
666 * PVFS2 protocol. See protocol.h for more error definitions. */
667
668/* The order matches include/pvfs2-types.h in the OrangeFS source. */
669static int PINT_errno_mapping[] = {
670 0, EPERM, ENOENT, EINTR, EIO, ENXIO, EBADF, EAGAIN, ENOMEM,
671 EFAULT, EBUSY, EEXIST, ENODEV, ENOTDIR, EISDIR, EINVAL, EMFILE,
672 EFBIG, ENOSPC, EROFS, EMLINK, EPIPE, EDEADLK, ENAMETOOLONG,
673 ENOLCK, ENOSYS, ENOTEMPTY, ELOOP, EWOULDBLOCK, ENOMSG, EUNATCH,
674 EBADR, EDEADLOCK, ENODATA, ETIME, ENONET, EREMOTE, ECOMM,
675 EPROTO, EBADMSG, EOVERFLOW, ERESTART, EMSGSIZE, EPROTOTYPE,
676 ENOPROTOOPT, EPROTONOSUPPORT, EOPNOTSUPP, EADDRINUSE,
677 EADDRNOTAVAIL, ENETDOWN, ENETUNREACH, ENETRESET, ENOBUFS,
678 ETIMEDOUT, ECONNREFUSED, EHOSTDOWN, EHOSTUNREACH, EALREADY,
679 EACCES, ECONNRESET, ERANGE
680};
f7be4ee0
MM
681
682int pvfs2_normalize_to_errno(__s32 error_code)
683{
894ac432
MB
684 /* Success */
685 if (error_code == 0) {
686 return 0;
687 /* This shouldn't ever happen. If it does it should be fixed on the
688 * server. */
689 } else if (error_code > 0) {
f7be4ee0
MM
690 gossip_err("pvfs2: error status receieved.\n");
691 gossip_err("pvfs2: assuming error code is inverted.\n");
692 error_code = -error_code;
693 }
694
894ac432
MB
695 /* XXX: This is very bad since error codes from PVFS2 may not be
696 * suitable for return into userspace. */
697
698 /* Convert PVFS2 error values into errno values suitable for return
699 * from the kernel. */
700 if ((-error_code) & PVFS_NON_ERRNO_ERROR_BIT) {
701 if (((-error_code) &
702 (PVFS_ERROR_NUMBER_BITS|PVFS_NON_ERRNO_ERROR_BIT|
703 PVFS_ERROR_BIT)) == PVFS_ECANCEL) {
f7be4ee0
MM
704 /*
705 * cancellation error codes generally correspond to
706 * a timeout from the client's perspective
707 */
708 error_code = -ETIMEDOUT;
709 } else {
710 /* assume a default error code */
894ac432
MB
711 gossip_err("pvfs2: warning: got error code without "
712 "errno equivalent: %d.\n", error_code);
f7be4ee0
MM
713 error_code = -EINVAL;
714 }
894ac432
MB
715
716 /* Convert PVFS2 encoded errno values into regular errno values. */
717 } else if ((-error_code) & PVFS_ERROR_BIT) {
718 __u32 i;
719 i = (-error_code) & ~(PVFS_ERROR_BIT|PVFS_ERROR_CLASS_BITS);
720 if (i < sizeof PINT_errno_mapping/sizeof *PINT_errno_mapping)
721 error_code = -PINT_errno_mapping[i];
722 else
723 error_code = -EINVAL;
724
725 /* Only PVFS2 protocol error codes should ever come here. Otherwise
726 * there is a bug somewhere. */
727 } else {
728 gossip_err("pvfs2: pvfs2_normalize_to_errno: got error code"
729 "which is not from PVFS2.\n");
f7be4ee0
MM
730 }
731 return error_code;
732}
733
734#define NUM_MODES 11
735__s32 PVFS_util_translate_mode(int mode)
736{
737 int ret = 0;
738 int i = 0;
739 static int modes[NUM_MODES] = {
740 S_IXOTH, S_IWOTH, S_IROTH,
741 S_IXGRP, S_IWGRP, S_IRGRP,
742 S_IXUSR, S_IWUSR, S_IRUSR,
743 S_ISGID, S_ISUID
744 };
745 static int pvfs2_modes[NUM_MODES] = {
746 PVFS_O_EXECUTE, PVFS_O_WRITE, PVFS_O_READ,
747 PVFS_G_EXECUTE, PVFS_G_WRITE, PVFS_G_READ,
748 PVFS_U_EXECUTE, PVFS_U_WRITE, PVFS_U_READ,
749 PVFS_G_SGID, PVFS_U_SUID
750 };
751
752 for (i = 0; i < NUM_MODES; i++)
753 if (mode & modes[i])
754 ret |= pvfs2_modes[i];
755
756 return ret;
757}
758#undef NUM_MODES
759
760/*
761 * After obtaining a string representation of the client's debug
762 * keywords and their associated masks, this function is called to build an
763 * array of these values.
764 */
765int orangefs_prepare_cdm_array(char *debug_array_string)
766{
767 int i;
768 int rc = -EINVAL;
769 char *cds_head = NULL;
770 char *cds_delimiter = NULL;
771 int keyword_len = 0;
772
773 gossip_debug(GOSSIP_UTILS_DEBUG, "%s: start\n", __func__);
774
775 /*
776 * figure out how many elements the cdm_array needs.
777 */
778 for (i = 0; i < strlen(debug_array_string); i++)
779 if (debug_array_string[i] == '\n')
780 cdm_element_count++;
781
782 if (!cdm_element_count) {
783 pr_info("No elements in client debug array string!\n");
784 goto out;
785 }
786
787 cdm_array =
788 kzalloc(cdm_element_count * sizeof(struct client_debug_mask),
789 GFP_KERNEL);
790 if (!cdm_array) {
791 pr_info("malloc failed for cdm_array!\n");
792 rc = -ENOMEM;
793 goto out;
794 }
795
796 cds_head = debug_array_string;
797
798 for (i = 0; i < cdm_element_count; i++) {
799 cds_delimiter = strchr(cds_head, '\n');
800 *cds_delimiter = '\0';
801
802 keyword_len = strcspn(cds_head, " ");
803
804 cdm_array[i].keyword = kzalloc(keyword_len + 1, GFP_KERNEL);
805 if (!cdm_array[i].keyword) {
806 rc = -ENOMEM;
807 goto out;
808 }
809
810 sscanf(cds_head,
811 "%s %llx %llx",
812 cdm_array[i].keyword,
813 (unsigned long long *)&(cdm_array[i].mask1),
814 (unsigned long long *)&(cdm_array[i].mask2));
815
816 if (!strcmp(cdm_array[i].keyword, PVFS2_VERBOSE))
817 client_verbose_index = i;
818
819 if (!strcmp(cdm_array[i].keyword, PVFS2_ALL))
820 client_all_index = i;
821
822 cds_head = cds_delimiter + 1;
823 }
824
825 rc = cdm_element_count;
826
827 gossip_debug(GOSSIP_UTILS_DEBUG, "%s: rc:%d:\n", __func__, rc);
828
829out:
830
831 return rc;
832
833}
834
835/*
836 * /sys/kernel/debug/orangefs/debug-help can be catted to
837 * see all the available kernel and client debug keywords.
838 *
839 * When the kernel boots, we have no idea what keywords the
840 * client supports, nor their associated masks.
841 *
842 * We pass through this function once at boot and stamp a
843 * boilerplate "we don't know" message for the client in the
844 * debug-help file. We pass through here again when the client
845 * starts and then we can fill out the debug-help file fully.
846 *
847 * The client might be restarted any number of times between
848 * reboots, we only build the debug-help file the first time.
849 */
850int orangefs_prepare_debugfs_help_string(int at_boot)
851{
852 int rc = -EINVAL;
853 int i;
854 int byte_count = 0;
855 char *client_title = "Client Debug Keywords:\n";
856 char *kernel_title = "Kernel Debug Keywords:\n";
857
858 gossip_debug(GOSSIP_UTILS_DEBUG, "%s: start\n", __func__);
859
860 if (at_boot) {
861 byte_count += strlen(HELP_STRING_UNINITIALIZED);
862 client_title = HELP_STRING_UNINITIALIZED;
863 } else {
864 /*
865 * fill the client keyword/mask array and remember
866 * how many elements there were.
867 */
868 cdm_element_count =
869 orangefs_prepare_cdm_array(client_debug_array_string);
870 if (cdm_element_count <= 0)
871 goto out;
872
873 /* Count the bytes destined for debug_help_string. */
874 byte_count += strlen(client_title);
875
876 for (i = 0; i < cdm_element_count; i++) {
877 byte_count += strlen(cdm_array[i].keyword + 2);
878 if (byte_count >= DEBUG_HELP_STRING_SIZE) {
879 pr_info("%s: overflow 1!\n", __func__);
880 goto out;
881 }
882 }
883
884 gossip_debug(GOSSIP_UTILS_DEBUG,
885 "%s: cdm_element_count:%d:\n",
886 __func__,
887 cdm_element_count);
888 }
889
890 byte_count += strlen(kernel_title);
891 for (i = 0; i < num_kmod_keyword_mask_map; i++) {
892 byte_count +=
893 strlen(s_kmod_keyword_mask_map[i].keyword + 2);
894 if (byte_count >= DEBUG_HELP_STRING_SIZE) {
895 pr_info("%s: overflow 2!\n", __func__);
896 goto out;
897 }
898 }
899
900 /* build debug_help_string. */
901 debug_help_string = kzalloc(DEBUG_HELP_STRING_SIZE, GFP_KERNEL);
902 if (!debug_help_string) {
903 rc = -ENOMEM;
904 goto out;
905 }
906
907 strcat(debug_help_string, client_title);
908
909 if (!at_boot) {
910 for (i = 0; i < cdm_element_count; i++) {
911 strcat(debug_help_string, "\t");
912 strcat(debug_help_string, cdm_array[i].keyword);
913 strcat(debug_help_string, "\n");
914 }
915 }
916
917 strcat(debug_help_string, "\n");
918 strcat(debug_help_string, kernel_title);
919
920 for (i = 0; i < num_kmod_keyword_mask_map; i++) {
921 strcat(debug_help_string, "\t");
922 strcat(debug_help_string, s_kmod_keyword_mask_map[i].keyword);
923 strcat(debug_help_string, "\n");
924 }
925
926 rc = 0;
927
928out:
929
930 return rc;
931
932}
933
934/*
935 * kernel = type 0
936 * client = type 1
937 */
938void debug_mask_to_string(void *mask, int type)
939{
940 int i;
941 int len = 0;
942 char *debug_string;
943 int element_count = 0;
944
945 gossip_debug(GOSSIP_UTILS_DEBUG, "%s: start\n", __func__);
946
947 if (type) {
948 debug_string = client_debug_string;
949 element_count = cdm_element_count;
950 } else {
951 debug_string = kernel_debug_string;
952 element_count = num_kmod_keyword_mask_map;
953 }
954
955 memset(debug_string, 0, PVFS2_MAX_DEBUG_STRING_LEN);
956
957 /*
958 * Some keywords, like "all" or "verbose", are amalgams of
959 * numerous other keywords. Make a special check for those
960 * before grinding through the whole mask only to find out
961 * later...
962 */
963 if (check_amalgam_keyword(mask, type))
964 goto out;
965
966 /* Build the debug string. */
967 for (i = 0; i < element_count; i++)
968 if (type)
969 do_c_string(mask, i);
970 else
971 do_k_string(mask, i);
972
973 len = strlen(debug_string);
974
975 if ((len) && (type))
976 client_debug_string[len - 1] = '\0';
977 else if (len)
978 kernel_debug_string[len - 1] = '\0';
979 else if (type)
980 strcpy(client_debug_string, "none");
981 else
982 strcpy(kernel_debug_string, "none");
983
984out:
985gossip_debug(GOSSIP_UTILS_DEBUG, "%s: string:%s:\n", __func__, debug_string);
986
987 return;
988
989}
990
991void do_k_string(void *k_mask, int index)
992{
993 __u64 *mask = (__u64 *) k_mask;
994
995 if (keyword_is_amalgam((char *) s_kmod_keyword_mask_map[index].keyword))
996 goto out;
997
998 if (*mask & s_kmod_keyword_mask_map[index].mask_val) {
999 if ((strlen(kernel_debug_string) +
1000 strlen(s_kmod_keyword_mask_map[index].keyword))
1001 < PVFS2_MAX_DEBUG_STRING_LEN - 1) {
1002 strcat(kernel_debug_string,
1003 s_kmod_keyword_mask_map[index].keyword);
1004 strcat(kernel_debug_string, ",");
1005 } else {
1006 gossip_err("%s: overflow!\n", __func__);
1007 strcpy(kernel_debug_string, PVFS2_ALL);
1008 goto out;
1009 }
1010 }
1011
1012out:
1013
1014 return;
1015}
1016
1017void do_c_string(void *c_mask, int index)
1018{
1019 struct client_debug_mask *mask = (struct client_debug_mask *) c_mask;
1020
1021 if (keyword_is_amalgam(cdm_array[index].keyword))
1022 goto out;
1023
1024 if ((mask->mask1 & cdm_array[index].mask1) ||
1025 (mask->mask2 & cdm_array[index].mask2)) {
1026 if ((strlen(client_debug_string) +
1027 strlen(cdm_array[index].keyword) + 1)
1028 < PVFS2_MAX_DEBUG_STRING_LEN - 2) {
1029 strcat(client_debug_string,
1030 cdm_array[index].keyword);
1031 strcat(client_debug_string, ",");
1032 } else {
1033 gossip_err("%s: overflow!\n", __func__);
1034 strcpy(client_debug_string, PVFS2_ALL);
1035 goto out;
1036 }
1037 }
1038out:
1039 return;
1040}
1041
1042int keyword_is_amalgam(char *keyword)
1043{
1044 int rc = 0;
1045
1046 if ((!strcmp(keyword, PVFS2_ALL)) || (!strcmp(keyword, PVFS2_VERBOSE)))
1047 rc = 1;
1048
1049 return rc;
1050}
1051
1052/*
1053 * kernel = type 0
1054 * client = type 1
1055 *
1056 * return 1 if we found an amalgam.
1057 */
1058int check_amalgam_keyword(void *mask, int type)
1059{
1060 __u64 *k_mask;
1061 struct client_debug_mask *c_mask;
1062 int k_all_index = num_kmod_keyword_mask_map - 1;
1063 int rc = 0;
1064
1065 if (type) {
1066 c_mask = (struct client_debug_mask *) mask;
1067
1068 if ((c_mask->mask1 == cdm_array[client_all_index].mask1) &&
1069 (c_mask->mask2 == cdm_array[client_all_index].mask2)) {
1070 strcpy(client_debug_string, PVFS2_ALL);
1071 rc = 1;
1072 goto out;
1073 }
1074
1075 if ((c_mask->mask1 == cdm_array[client_verbose_index].mask1) &&
1076 (c_mask->mask2 == cdm_array[client_verbose_index].mask2)) {
1077 strcpy(client_debug_string, PVFS2_VERBOSE);
1078 rc = 1;
1079 goto out;
1080 }
1081
1082 } else {
1083 k_mask = (__u64 *) mask;
1084
1085 if (*k_mask >= s_kmod_keyword_mask_map[k_all_index].mask_val) {
1086 strcpy(kernel_debug_string, PVFS2_ALL);
1087 rc = 1;
1088 goto out;
1089 }
1090 }
1091
1092out:
1093
1094 return rc;
1095}
1096
1097/*
1098 * kernel = type 0
1099 * client = type 1
1100 */
1101void debug_string_to_mask(char *debug_string, void *mask, int type)
1102{
1103 char *unchecked_keyword;
1104 int i;
1105 char *strsep_fodder = kstrdup(debug_string, GFP_KERNEL);
eeaa3d44 1106 char *original_pointer;
f7be4ee0
MM
1107 int element_count = 0;
1108 struct client_debug_mask *c_mask;
1109 __u64 *k_mask;
1110
1111 gossip_debug(GOSSIP_UTILS_DEBUG, "%s: start\n", __func__);
1112
1113 if (type) {
1114 c_mask = (struct client_debug_mask *)mask;
1115 element_count = cdm_element_count;
1116 } else {
1117 k_mask = (__u64 *)mask;
1118 *k_mask = 0;
1119 element_count = num_kmod_keyword_mask_map;
1120 }
1121
eeaa3d44 1122 original_pointer = strsep_fodder;
f7be4ee0
MM
1123 while ((unchecked_keyword = strsep(&strsep_fodder, ",")))
1124 if (strlen(unchecked_keyword)) {
1125 for (i = 0; i < element_count; i++)
1126 if (type)
1127 do_c_mask(i,
1128 unchecked_keyword,
1129 &c_mask);
1130 else
1131 do_k_mask(i,
1132 unchecked_keyword,
1133 &k_mask);
1134 }
1135
eeaa3d44 1136 kfree(original_pointer);
f7be4ee0
MM
1137}
1138
1139void do_c_mask(int i,
1140 char *unchecked_keyword,
1141 struct client_debug_mask **sane_mask)
1142{
1143
1144 if (!strcmp(cdm_array[i].keyword, unchecked_keyword)) {
1145 (**sane_mask).mask1 = (**sane_mask).mask1 | cdm_array[i].mask1;
1146 (**sane_mask).mask2 = (**sane_mask).mask2 | cdm_array[i].mask2;
1147 }
1148}
1149
1150void do_k_mask(int i, char *unchecked_keyword, __u64 **sane_mask)
1151{
1152
1153 if (!strcmp(s_kmod_keyword_mask_map[i].keyword, unchecked_keyword))
1154 **sane_mask = (**sane_mask) |
1155 s_kmod_keyword_mask_map[i].mask_val;
1156}