2 * arch/s390/hypfs/inode.c
3 * Hypervisor filesystem for Linux on s390.
5 * Copyright IBM Corp. 2006, 2008
6 * Author(s): Michael Holzheu <holzheu@de.ibm.com>
9 #define KMSG_COMPONENT "hypfs"
10 #define pr_fmt(fmt) KMSG_COMPONENT ": " fmt
12 #include <linux/types.h>
13 #include <linux/errno.h>
15 #include <linux/namei.h>
16 #include <linux/vfs.h>
17 #include <linux/pagemap.h>
18 #include <linux/gfp.h>
19 #include <linux/time.h>
20 #include <linux/parser.h>
21 #include <linux/sysfs.h>
22 #include <linux/module.h>
23 #include <linux/seq_file.h>
24 #include <linux/mount.h>
25 #include <asm/ebcdic.h>
28 #define HYPFS_MAGIC 0x687970 /* ASCII 'hyp' */
29 #define TMP_SIZE 64 /* size of temporary buffers */
31 static struct dentry *hypfs_create_update_file(struct super_block *sb,
34 struct hypfs_sb_info {
35 uid_t uid; /* uid used for files and dirs */
36 gid_t gid; /* gid used for files and dirs */
37 struct dentry *update_file; /* file to trigger update */
38 time_t last_update; /* last update time in secs since 1970 */
39 struct mutex lock; /* lock to protect update process */
42 static const struct file_operations hypfs_file_ops;
43 static struct file_system_type hypfs_type;
44 static struct super_operations hypfs_s_ops;
46 /* start of list of all dentries, which have to be deleted on update */
47 static struct dentry *hypfs_last_dentry;
49 static void hypfs_update_update(struct super_block *sb)
51 struct hypfs_sb_info *sb_info = sb->s_fs_info;
52 struct inode *inode = sb_info->update_file->d_inode;
54 sb_info->last_update = get_seconds();
55 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
58 /* directory tree removal functions */
60 static void hypfs_add_dentry(struct dentry *dentry)
62 dentry->d_fsdata = hypfs_last_dentry;
63 hypfs_last_dentry = dentry;
66 static inline int hypfs_positive(struct dentry *dentry)
68 return dentry->d_inode && !d_unhashed(dentry);
71 static void hypfs_remove(struct dentry *dentry)
73 struct dentry *parent;
75 parent = dentry->d_parent;
76 if (!parent || !parent->d_inode)
78 mutex_lock(&parent->d_inode->i_mutex);
79 if (hypfs_positive(dentry)) {
80 if (S_ISDIR(dentry->d_inode->i_mode))
81 simple_rmdir(parent->d_inode, dentry);
83 simple_unlink(parent->d_inode, dentry);
87 mutex_unlock(&parent->d_inode->i_mutex);
90 static void hypfs_delete_tree(struct dentry *root)
92 while (hypfs_last_dentry) {
93 struct dentry *next_dentry;
94 next_dentry = hypfs_last_dentry->d_fsdata;
95 hypfs_remove(hypfs_last_dentry);
96 hypfs_last_dentry = next_dentry;
100 static struct inode *hypfs_make_inode(struct super_block *sb, int mode)
102 struct inode *ret = new_inode(sb);
105 struct hypfs_sb_info *hypfs_info = sb->s_fs_info;
107 ret->i_uid = hypfs_info->uid;
108 ret->i_gid = hypfs_info->gid;
109 ret->i_atime = ret->i_mtime = ret->i_ctime = CURRENT_TIME;
118 static void hypfs_drop_inode(struct inode *inode)
120 kfree(inode->i_private);
121 generic_delete_inode(inode);
124 static int hypfs_open(struct inode *inode, struct file *filp)
126 char *data = filp->f_path.dentry->d_inode->i_private;
127 struct hypfs_sb_info *fs_info;
129 if (filp->f_mode & FMODE_WRITE) {
130 if (!(inode->i_mode & S_IWUGO))
133 if (filp->f_mode & FMODE_READ) {
134 if (!(inode->i_mode & S_IRUGO))
138 fs_info = inode->i_sb->s_fs_info;
140 mutex_lock(&fs_info->lock);
141 filp->private_data = kstrdup(data, GFP_KERNEL);
142 if (!filp->private_data) {
143 mutex_unlock(&fs_info->lock);
146 mutex_unlock(&fs_info->lock);
151 static ssize_t hypfs_aio_read(struct kiocb *iocb, const struct iovec *iov,
152 unsigned long nr_segs, loff_t offset)
156 struct file *filp = iocb->ki_filp;
158 char __user *buf = iov[0].iov_base;
159 size_t count = iov[0].iov_len;
164 data = filp->private_data;
165 ret = simple_read_from_buffer(buf, count, &offset, data, strlen(data));
174 static ssize_t hypfs_aio_write(struct kiocb *iocb, const struct iovec *iov,
175 unsigned long nr_segs, loff_t offset)
178 struct super_block *sb;
179 struct hypfs_sb_info *fs_info;
180 size_t count = iov_length(iov, nr_segs);
182 sb = iocb->ki_filp->f_path.dentry->d_inode->i_sb;
183 fs_info = sb->s_fs_info;
185 * Currently we only allow one update per second for two reasons:
186 * 1. diag 204 is VERY expensive
187 * 2. If several processes do updates in parallel and then read the
188 * hypfs data, the likelihood of collisions is reduced, if we restrict
189 * the minimum update interval. A collision occurs, if during the
190 * data gathering of one process another process triggers an update
191 * If the first process wants to ensure consistent data, it has
192 * to restart data collection in this case.
194 mutex_lock(&fs_info->lock);
195 if (fs_info->last_update == get_seconds()) {
199 hypfs_delete_tree(sb->s_root);
201 rc = hypfs_vm_create_files(sb, sb->s_root);
203 rc = hypfs_diag_create_files(sb, sb->s_root);
205 pr_err("Updating the hypfs tree failed\n");
206 hypfs_delete_tree(sb->s_root);
209 hypfs_update_update(sb);
212 mutex_unlock(&fs_info->lock);
216 static int hypfs_release(struct inode *inode, struct file *filp)
218 kfree(filp->private_data);
222 enum { opt_uid, opt_gid, opt_err };
224 static const match_table_t hypfs_tokens = {
230 static int hypfs_parse_options(char *options, struct super_block *sb)
233 substring_t args[MAX_OPT_ARGS];
237 while ((str = strsep(&options, ",")) != NULL) {
239 struct hypfs_sb_info *hypfs_info = sb->s_fs_info;
243 token = match_token(str, hypfs_tokens, args);
246 if (match_int(&args[0], &option))
248 hypfs_info->uid = option;
251 if (match_int(&args[0], &option))
253 hypfs_info->gid = option;
257 pr_err("%s is not a valid mount option\n", str);
264 static int hypfs_show_options(struct seq_file *s, struct vfsmount *mnt)
266 struct hypfs_sb_info *hypfs_info = mnt->mnt_sb->s_fs_info;
268 seq_printf(s, ",uid=%u", hypfs_info->uid);
269 seq_printf(s, ",gid=%u", hypfs_info->gid);
273 static int hypfs_fill_super(struct super_block *sb, void *data, int silent)
275 struct inode *root_inode;
276 struct dentry *root_dentry;
278 struct hypfs_sb_info *sbi;
280 sbi = kzalloc(sizeof(struct hypfs_sb_info), GFP_KERNEL);
283 mutex_init(&sbi->lock);
284 sbi->uid = current_uid();
285 sbi->gid = current_gid();
287 sb->s_blocksize = PAGE_CACHE_SIZE;
288 sb->s_blocksize_bits = PAGE_CACHE_SHIFT;
289 sb->s_magic = HYPFS_MAGIC;
290 sb->s_op = &hypfs_s_ops;
291 if (hypfs_parse_options(data, sb)) {
295 root_inode = hypfs_make_inode(sb, S_IFDIR | 0755);
300 root_inode->i_op = &simple_dir_inode_operations;
301 root_inode->i_fop = &simple_dir_operations;
302 root_dentry = d_alloc_root(root_inode);
309 rc = hypfs_vm_create_files(sb, root_dentry);
311 rc = hypfs_diag_create_files(sb, root_dentry);
314 sbi->update_file = hypfs_create_update_file(sb, root_dentry);
315 if (IS_ERR(sbi->update_file)) {
316 rc = PTR_ERR(sbi->update_file);
319 hypfs_update_update(sb);
320 sb->s_root = root_dentry;
321 pr_info("Hypervisor filesystem mounted\n");
325 hypfs_delete_tree(root_dentry);
326 d_genocide(root_dentry);
333 static int hypfs_get_super(struct file_system_type *fst, int flags,
334 const char *devname, void *data, struct vfsmount *mnt)
336 return get_sb_single(fst, flags, data, hypfs_fill_super, mnt);
339 static void hypfs_kill_super(struct super_block *sb)
341 struct hypfs_sb_info *sb_info = sb->s_fs_info;
344 hypfs_delete_tree(sb->s_root);
345 hypfs_remove(sb_info->update_file);
346 kfree(sb->s_fs_info);
347 sb->s_fs_info = NULL;
349 kill_litter_super(sb);
352 static struct dentry *hypfs_create_file(struct super_block *sb,
353 struct dentry *parent, const char *name,
354 char *data, mode_t mode)
356 struct dentry *dentry;
361 qname.len = strlen(name);
362 qname.hash = full_name_hash(name, qname.len);
363 mutex_lock(&parent->d_inode->i_mutex);
364 dentry = lookup_one_len(name, parent, strlen(name));
365 if (IS_ERR(dentry)) {
366 dentry = ERR_PTR(-ENOMEM);
369 inode = hypfs_make_inode(sb, mode);
372 dentry = ERR_PTR(-ENOMEM);
375 if (mode & S_IFREG) {
376 inode->i_fop = &hypfs_file_ops;
378 inode->i_size = strlen(data);
381 } else if (mode & S_IFDIR) {
382 inode->i_op = &simple_dir_inode_operations;
383 inode->i_fop = &simple_dir_operations;
384 parent->d_inode->i_nlink++;
387 inode->i_private = data;
388 d_instantiate(dentry, inode);
391 mutex_unlock(&parent->d_inode->i_mutex);
395 struct dentry *hypfs_mkdir(struct super_block *sb, struct dentry *parent,
398 struct dentry *dentry;
400 dentry = hypfs_create_file(sb, parent, name, NULL, S_IFDIR | DIR_MODE);
403 hypfs_add_dentry(dentry);
407 static struct dentry *hypfs_create_update_file(struct super_block *sb,
410 struct dentry *dentry;
412 dentry = hypfs_create_file(sb, dir, "update", NULL,
413 S_IFREG | UPDATE_FILE_MODE);
415 * We do not put the update file on the 'delete' list with
416 * hypfs_add_dentry(), since it should not be removed when the tree
422 struct dentry *hypfs_create_u64(struct super_block *sb, struct dentry *dir,
423 const char *name, __u64 value)
427 struct dentry *dentry;
429 snprintf(tmp, TMP_SIZE, "%lld\n", (unsigned long long int)value);
430 buffer = kstrdup(tmp, GFP_KERNEL);
432 return ERR_PTR(-ENOMEM);
434 hypfs_create_file(sb, dir, name, buffer, S_IFREG | REG_FILE_MODE);
435 if (IS_ERR(dentry)) {
437 return ERR_PTR(-ENOMEM);
439 hypfs_add_dentry(dentry);
443 struct dentry *hypfs_create_str(struct super_block *sb, struct dentry *dir,
444 const char *name, char *string)
447 struct dentry *dentry;
449 buffer = kmalloc(strlen(string) + 2, GFP_KERNEL);
451 return ERR_PTR(-ENOMEM);
452 sprintf(buffer, "%s\n", string);
454 hypfs_create_file(sb, dir, name, buffer, S_IFREG | REG_FILE_MODE);
455 if (IS_ERR(dentry)) {
457 return ERR_PTR(-ENOMEM);
459 hypfs_add_dentry(dentry);
463 static const struct file_operations hypfs_file_ops = {
465 .release = hypfs_release,
466 .read = do_sync_read,
467 .write = do_sync_write,
468 .aio_read = hypfs_aio_read,
469 .aio_write = hypfs_aio_write,
472 static struct file_system_type hypfs_type = {
473 .owner = THIS_MODULE,
474 .name = "s390_hypfs",
475 .get_sb = hypfs_get_super,
476 .kill_sb = hypfs_kill_super
479 static struct super_operations hypfs_s_ops = {
480 .statfs = simple_statfs,
481 .drop_inode = hypfs_drop_inode,
482 .show_options = hypfs_show_options,
485 static struct kobject *s390_kobj;
487 static int __init hypfs_init(void)
493 /* no diag 2fc, just exit */
496 if (hypfs_diag_init()) {
501 s390_kobj = kobject_create_and_add("s390", hypervisor_kobj);
506 rc = register_filesystem(&hypfs_type);
508 goto fail_filesystem;
512 kobject_put(s390_kobj);
517 pr_err("Initialization of hypfs failed with rc=%i\n", rc);
521 static void __exit hypfs_exit(void)
525 unregister_filesystem(&hypfs_type);
526 kobject_put(s390_kobj);
529 module_init(hypfs_init)
530 module_exit(hypfs_exit)
532 MODULE_LICENSE("GPL");
533 MODULE_AUTHOR("Michael Holzheu <holzheu@de.ibm.com>");
534 MODULE_DESCRIPTION("s390 Hypervisor Filesystem");