1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * lustre/lib/lvfs_linux.c
5 * Lustre filesystem abstraction routines
7 * Copyright (C) 2002, 2003 Cluster File Systems, Inc.
8 * Author: Andreas Dilger <adilger@clusterfs.com>
10 * This file is part of Lustre, http://www.lustre.org.
12 * Lustre is free software; you can redistribute it and/or
13 * modify it under the terms of version 2 of the GNU General Public
14 * License as published by the Free Software Foundation.
16 * Lustre 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
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with Lustre; if not, write to the Free Software
23 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
27 # define EXPORT_SYMTAB
30 #define DEBUG_SUBSYSTEM S_FILTER
32 #include <linux/version.h>
34 #include <asm/unistd.h>
35 #include <linux/slab.h>
36 #include <linux/pagemap.h>
37 #include <linux/quotaops.h>
38 #include <linux/version.h>
39 #include <libcfs/kp30.h>
40 #include <linux/lustre_fsfilt.h>
41 #include <linux/obd.h>
42 #include <linux/obd_class.h>
43 #include <linux/module.h>
44 #include <linux/init.h>
45 #include <linux/lustre_compat25.h>
46 #include <linux/lvfs.h>
47 #include "lvfs_internal.h"
49 #include <linux/obd.h>
50 #include <linux/lustre_lib.h>
51 #include <linux/lustre_mds.h> /* for mds_grp_hash_entry */
56 /* Debugging check only needed during development */
58 # define ASSERT_CTXT_MAGIC(magic) LASSERT((magic) == OBD_RUN_CTXT_MAGIC)
59 # define ASSERT_NOT_KERNEL_CTXT(msg) LASSERTF(!segment_eq(get_fs(), get_ds()),\
61 # define ASSERT_KERNEL_CTXT(msg) LASSERTF(segment_eq(get_fs(), get_ds()), msg)
64 # define ASSERT_CTXT_MAGIC(magic) do {} while(0)
65 # define ASSERT_NOT_KERNEL_CTXT(msg) do {} while(0)
66 # define ASSERT_KERNEL_CTXT(msg) do {} while(0)
69 static void push_group_info(struct lvfs_run_ctxt *save,
70 struct group_info *ginfo)
73 save->ngroups = current_ngroups;
76 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,4)
78 save->group_info = current->group_info;
79 current->group_info = ginfo;
82 LASSERT(ginfo->ngroups <= NGROUPS);
84 save->group_info.ngroups = current->ngroups;
86 memcpy(save->group_info.small_block, current->groups,
89 current->ngroups = ginfo->ngroups;
91 memcpy(current->groups, ginfo->small_block,
97 static void pop_group_info(struct lvfs_run_ctxt *save,
98 struct group_info *ginfo)
101 current_ngroups = save->ngroups;
103 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,4)
105 current->group_info = save->group_info;
106 task_unlock(current);
108 current->ngroups = ginfo->ngroups;
109 if (current->ngroups)
110 memcpy(current->groups, save->group_info.small_block,
116 /* push / pop to root of obd store */
117 void push_ctxt(struct lvfs_run_ctxt *save, struct lvfs_run_ctxt *new_ctx,
118 struct lvfs_ucred *uc)
120 //ASSERT_NOT_KERNEL_CTXT("already in kernel context!\n");
121 ASSERT_CTXT_MAGIC(new_ctx->magic);
122 LASSERT(save->magic != OBD_RUN_CTXT_MAGIC || save->pid != current->pid);
123 OBD_SET_CTXT_MAGIC(save);
124 save->pid = current->pid;
128 "= push %p->%p = cur fs %p pwd %p:d%d:i%d (%.*s), pwdmnt %p:%d\n",
129 save, current, current->fs, current->fs->pwd,
130 atomic_read(¤t->fs->pwd->d_count),
131 atomic_read(¤t->fs->pwd->d_inode->i_count),
132 current->fs->pwd->d_name.len, current->fs->pwd->d_name.name,
134 atomic_read(¤t->fs->pwdmnt->mnt_count));
138 LASSERT(atomic_read(¤t->fs->pwd->d_count));
139 LASSERT(atomic_read(&new_ctx->pwd->d_count));
140 save->pwd = dget(current->fs->pwd);
141 save->pwdmnt = mntget(current->fs->pwdmnt);
142 save->ngroups = current_ngroups;
143 save->luc.luc_umask = current->fs->umask;
146 LASSERT(save->pwdmnt);
147 LASSERT(new_ctx->pwd);
148 LASSERT(new_ctx->pwdmnt);
151 save->luc.luc_fsuid = current->fsuid;
152 save->luc.luc_fsgid = current->fsgid;
153 save->luc.luc_cap = current->cap_effective;
155 current->fsuid = uc->luc_fsuid;
156 current->fsgid = uc->luc_fsgid;
157 current->cap_effective = uc->luc_cap;
159 push_group_info(save, uc->luc_ginfo);
161 current->fs->umask = 0; /* umask already applied on client */
163 set_fs_pwd(current->fs, new_ctx->pwdmnt, new_ctx->pwd);
167 "= push %p->%p = cur fs %p pwd %p:d%d:i%d (%.*s), pwdmnt %p:%d\n",
168 new_ctx, current, current->fs, current->fs->pwd,
169 atomic_read(¤t->fs->pwd->d_count),
170 atomic_read(¤t->fs->pwd->d_inode->i_count),
171 current->fs->pwd->d_name.len, current->fs->pwd->d_name.name,
173 atomic_read(¤t->fs->pwdmnt->mnt_count));
176 EXPORT_SYMBOL(push_ctxt);
178 void pop_ctxt(struct lvfs_run_ctxt *saved, struct lvfs_run_ctxt *new_ctx,
179 struct lvfs_ucred *uc)
182 ASSERT_CTXT_MAGIC(saved->magic);
183 LASSERT(saved->pid == current->pid);
187 ASSERT_KERNEL_CTXT("popping non-kernel context!\n");
191 " = pop %p==%p = cur %p pwd %p:d%d:i%d (%.*s), pwdmnt %p:%d\n",
192 new_ctx, current, current->fs, current->fs->pwd,
193 atomic_read(¤t->fs->pwd->d_count),
194 atomic_read(¤t->fs->pwd->d_inode->i_count),
195 current->fs->pwd->d_name.len, current->fs->pwd->d_name.name,
197 atomic_read(¤t->fs->pwdmnt->mnt_count));
200 LASSERT(current->fs->pwd == new_ctx->pwd);
201 LASSERT(current->fs->pwdmnt == new_ctx->pwdmnt);
204 set_fs_pwd(current->fs, saved->pwdmnt, saved->pwd);
207 mntput(saved->pwdmnt);
208 current->fs->umask = saved->luc.luc_umask;
210 current->fsuid = saved->luc.luc_fsuid;
211 current->fsgid = saved->luc.luc_fsgid;
212 current->cap_effective = saved->luc.luc_cap;
214 pop_group_info(saved, uc->luc_ginfo);
219 "= pop %p->%p = cur fs %p pwd %p:d%d:i%d (%.*s), pwdmnt %p:%d\n",
220 saved, current, current->fs, current->fs->pwd,
221 atomic_read(¤t->fs->pwd->d_count),
222 atomic_read(¤t->fs->pwd->d_inode->i_count),
223 current->fs->pwd->d_name.len, current->fs->pwd->d_name.name,
225 atomic_read(¤t->fs->pwdmnt->mnt_count));
228 EXPORT_SYMBOL(pop_ctxt);
230 /* utility to make a file */
231 struct dentry *simple_mknod(struct dentry *dir, char *name, int mode, int fix)
233 struct dentry *dchild;
237 ASSERT_KERNEL_CTXT("kernel doing mknod outside kernel context\n");
238 CDEBUG(D_INODE, "creating file %.*s\n", (int)strlen(name), name);
240 dchild = ll_lookup_one_len(name, dir, strlen(name));
242 GOTO(out_up, dchild);
244 if (dchild->d_inode) {
245 int old_mode = dchild->d_inode->i_mode;
246 if (!S_ISREG(old_mode))
247 GOTO(out_err, err = -EEXIST);
249 /* Fixup file permissions if necessary */
250 if (fix && (old_mode & S_IALLUGO) != (mode & S_IALLUGO)) {
251 CWARN("fixing permissions on %s from %o to %o\n",
252 name, old_mode, mode);
253 dchild->d_inode->i_mode = (mode & S_IALLUGO) |
254 (old_mode & ~S_IALLUGO);
255 mark_inode_dirty(dchild->d_inode);
257 GOTO(out_up, dchild);
260 err = ll_vfs_create(dir->d_inode, dchild, (mode & ~S_IFMT) | S_IFREG,
269 dchild = ERR_PTR(err);
273 EXPORT_SYMBOL(simple_mknod);
275 /* utility to make a directory */
276 struct dentry *simple_mkdir(struct dentry *dir, char *name, int mode, int fix)
278 struct dentry *dchild;
282 ASSERT_KERNEL_CTXT("kernel doing mkdir outside kernel context\n");
283 CDEBUG(D_INODE, "creating directory %.*s\n", (int)strlen(name), name);
284 dchild = ll_lookup_one_len(name, dir, strlen(name));
286 GOTO(out_up, dchild);
288 if (dchild->d_inode) {
289 int old_mode = dchild->d_inode->i_mode;
290 if (!S_ISDIR(old_mode)) {
291 CERROR("found %s (%lu/%u) is mode %o\n", name,
292 dchild->d_inode->i_ino,
293 dchild->d_inode->i_generation, old_mode);
294 GOTO(out_err, err = -ENOTDIR);
297 /* Fixup directory permissions if necessary */
298 if (fix && (old_mode & S_IALLUGO) != (mode & S_IALLUGO)) {
299 CWARN("fixing permissions on %s from %o to %o\n",
300 name, old_mode, mode);
301 dchild->d_inode->i_mode = (mode & S_IALLUGO) |
302 (old_mode & ~S_IALLUGO);
303 mark_inode_dirty(dchild->d_inode);
305 GOTO(out_up, dchild);
308 err = vfs_mkdir(dir->d_inode, dchild, mode);
316 dchild = ERR_PTR(err);
320 EXPORT_SYMBOL(simple_mkdir);
323 * Read a file from within kernel context. Prior to calling this
324 * function we should already have done a push_ctxt().
326 int lustre_fread(struct file *file, void *buf, int len, loff_t *off)
328 ASSERT_KERNEL_CTXT("kernel doing read outside kernel context\n");
329 if (!file || !file->f_op || !file->f_op->read || !off)
332 return file->f_op->read(file, buf, len, off);
334 EXPORT_SYMBOL(lustre_fread);
337 * Write a file from within kernel context. Prior to calling this
338 * function we should already have done a push_ctxt().
340 int lustre_fwrite(struct file *file, const void *buf, int len, loff_t *off)
343 ASSERT_KERNEL_CTXT("kernel doing write outside kernel context\n");
351 if (!file->f_op->write)
354 RETURN(file->f_op->write(file, buf, len, off));
356 EXPORT_SYMBOL(lustre_fwrite);
359 * Sync a file from within kernel context. Prior to calling this
360 * function we should already have done a push_ctxt().
362 int lustre_fsync(struct file *file)
365 ASSERT_KERNEL_CTXT("kernel doing sync outside kernel context\n");
366 if (!file || !file->f_op || !file->f_op->fsync)
369 RETURN(file->f_op->fsync(file, file->f_dentry, 0));
371 EXPORT_SYMBOL(lustre_fsync);
373 struct l_file *l_dentry_open(struct lvfs_run_ctxt *ctxt, struct l_dentry *de,
376 mntget(ctxt->pwdmnt);
377 return dentry_open(de, ctxt->pwdmnt, flags);
379 EXPORT_SYMBOL(l_dentry_open);
381 static int l_filldir(void *__buf, const char *name, int namlen, loff_t offset,
382 ino_t ino, unsigned int d_type)
384 struct l_linux_dirent *dirent;
385 struct l_readdir_callback *buf = (struct l_readdir_callback *)__buf;
387 dirent = buf->lrc_dirent;
389 dirent->lld_off = offset;
391 OBD_ALLOC(dirent, sizeof(*dirent));
393 list_add_tail(&dirent->lld_list, buf->lrc_list);
395 buf->lrc_dirent = dirent;
396 dirent->lld_ino = ino;
397 LASSERT(sizeof(dirent->lld_name) >= namlen + 1);
398 memcpy(dirent->lld_name, name, namlen);
403 long l_readdir(struct file *file, struct list_head *dentry_list)
405 struct l_linux_dirent *lastdirent;
406 struct l_readdir_callback buf;
409 buf.lrc_dirent = NULL;
410 buf.lrc_list = dentry_list;
412 error = vfs_readdir(file, l_filldir, &buf);
416 lastdirent = buf.lrc_dirent;
418 lastdirent->lld_off = file->f_pos;
422 EXPORT_SYMBOL(l_readdir);
423 EXPORT_SYMBOL(obd_memory);
424 EXPORT_SYMBOL(obd_memmax);
426 #if defined (CONFIG_DEBUG_MEMORY) && defined(__KERNEL__)
427 static spinlock_t obd_memlist_lock = SPIN_LOCK_UNLOCKED;
428 static struct hlist_head *obd_memtable;
429 static unsigned long obd_memtable_size;
431 static int lvfs_memdbg_init(int size)
433 struct hlist_head *head;
436 LASSERT(size > sizeof(sizeof(struct hlist_head)));
437 obd_memtable_size = size / sizeof(struct hlist_head);
439 CWARN("Allocating %lu malloc entries...\n",
440 (unsigned long)obd_memtable_size);
442 obd_memtable = kmalloc(size, GFP_KERNEL);
446 i = obd_memtable_size;
449 INIT_HLIST_HEAD(head);
457 static int lvfs_memdbg_cleanup(void)
459 struct hlist_node *node = NULL, *tmp = NULL;
460 struct hlist_head *head;
464 spin_lock(&obd_memlist_lock);
465 for (i = 0, head = obd_memtable; i < obd_memtable_size; i++, head++) {
466 hlist_for_each_safe(node, tmp, head) {
467 mt = hlist_entry(node, struct mtrack, m_hash);
468 hlist_del_init(&mt->m_hash);
472 spin_unlock(&obd_memlist_lock);
477 static inline unsigned long const hashfn(void *ptr)
479 return (unsigned long)ptr &
480 (obd_memtable_size - 1);
483 static void __lvfs_memdbg_insert(struct mtrack *mt)
485 struct hlist_head *head = obd_memtable +
487 hlist_add_head(&mt->m_hash, head);
490 void lvfs_memdbg_insert(struct mtrack *mt)
492 spin_lock(&obd_memlist_lock);
493 __lvfs_memdbg_insert(mt);
494 spin_unlock(&obd_memlist_lock);
496 EXPORT_SYMBOL(lvfs_memdbg_insert);
498 static void __lvfs_memdbg_remove(struct mtrack *mt)
500 hlist_del_init(&mt->m_hash);
503 void lvfs_memdbg_remove(struct mtrack *mt)
505 spin_lock(&obd_memlist_lock);
506 __lvfs_memdbg_remove(mt);
507 spin_unlock(&obd_memlist_lock);
509 EXPORT_SYMBOL(lvfs_memdbg_remove);
511 static struct mtrack *__lvfs_memdbg_find(void *ptr)
513 struct hlist_node *node = NULL;
514 struct mtrack *mt = NULL;
515 struct hlist_head *head;
517 head = obd_memtable + hashfn(ptr);
519 hlist_for_each(node, head) {
520 mt = hlist_entry(node, struct mtrack, m_hash);
521 if ((unsigned long)mt->m_ptr == (unsigned long)ptr)
528 struct mtrack *lvfs_memdbg_find(void *ptr)
532 spin_lock(&obd_memlist_lock);
533 mt = __lvfs_memdbg_find(ptr);
534 spin_unlock(&obd_memlist_lock);
538 EXPORT_SYMBOL(lvfs_memdbg_find);
540 int lvfs_memdbg_check_insert(struct mtrack *mt)
542 spin_lock(&obd_memlist_lock);
543 if (!__lvfs_memdbg_find(mt->m_ptr)) {
544 __lvfs_memdbg_insert(mt);
545 spin_unlock(&obd_memlist_lock);
548 spin_unlock(&obd_memlist_lock);
551 EXPORT_SYMBOL(lvfs_memdbg_check_insert);
554 lvfs_memdbg_check_remove(void *ptr)
558 spin_lock(&obd_memlist_lock);
559 mt = __lvfs_memdbg_find(ptr);
561 __lvfs_memdbg_remove(mt);
562 spin_unlock(&obd_memlist_lock);
565 spin_unlock(&obd_memlist_lock);
568 EXPORT_SYMBOL(lvfs_memdbg_check_remove);
570 static void lvfs_memdbg_show(void)
572 struct hlist_node *node = NULL;
573 struct hlist_head *head;
577 leaked = atomic_read(&obd_memory);
580 CWARN("Memory leaks detected (max %d, leaked %d):\n",
583 spin_lock(&obd_memlist_lock);
584 for (i = 0, head = obd_memtable; i < obd_memtable_size; i++, head++) {
585 hlist_for_each(node, head) {
586 mt = hlist_entry(node, struct mtrack, m_hash);
587 CWARN(" ptr: 0x%p, size: %d, src at \"%s\"\n",
588 mt->m_ptr, mt->m_size, mt->m_loc);
591 spin_unlock(&obd_memlist_lock);
596 static int __init lvfs_linux_init(void)
599 #if defined (CONFIG_DEBUG_MEMORY) && defined(__KERNEL__)
600 lvfs_memdbg_init(PAGE_SIZE);
602 lvfs_mount_list_init();
606 static void __exit lvfs_linux_exit(void)
610 lvfs_mount_list_cleanup();
612 #if defined (CONFIG_DEBUG_MEMORY) && defined(__KERNEL__)
614 lvfs_memdbg_cleanup();
620 MODULE_AUTHOR("Cluster File Systems, Inc. <info@clusterfs.com>");
621 MODULE_DESCRIPTION("Lustre VFS Filesystem Helper v0.1");
622 MODULE_LICENSE("GPL");
624 module_init(lvfs_linux_init);
625 module_exit(lvfs_linux_exit);