2 * arch/s390/hypfs/inode.c
3 * Hypervisor filesystem for Linux on s390.
5 * Copyright (C) IBM Corp. 2006
6 * Author(s): Michael Holzheu <holzheu@de.ibm.com>
9 #include <linux/types.h>
10 #include <linux/errno.h>
12 #include <linux/namei.h>
13 #include <linux/vfs.h>
14 #include <linux/pagemap.h>
15 #include <linux/gfp.h>
16 #include <linux/time.h>
17 #include <linux/parser.h>
18 #include <linux/sysfs.h>
19 #include <linux/module.h>
20 #include <linux/seq_file.h>
21 #include <linux/mount.h>
22 #include <asm/ebcdic.h>
25 #define HYPFS_MAGIC 0x687970 /* ASCII 'hyp' */
26 #define TMP_SIZE 64 /* size of temporary buffers */
28 static struct dentry *hypfs_create_update_file(struct super_block *sb,
31 struct hypfs_sb_info {
32 uid_t uid; /* uid used for files and dirs */
33 gid_t gid; /* gid used for files and dirs */
34 struct dentry *update_file; /* file to trigger update */
35 time_t last_update; /* last update time in secs since 1970 */
36 struct mutex lock; /* lock to protect update process */
39 static const struct file_operations hypfs_file_ops;
40 static struct file_system_type hypfs_type;
41 static struct super_operations hypfs_s_ops;
43 /* start of list of all dentries, which have to be deleted on update */
44 static struct dentry *hypfs_last_dentry;
46 static void hypfs_update_update(struct super_block *sb)
48 struct hypfs_sb_info *sb_info = sb->s_fs_info;
49 struct inode *inode = sb_info->update_file->d_inode;
51 sb_info->last_update = get_seconds();
52 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
55 /* directory tree removal functions */
57 static void hypfs_add_dentry(struct dentry *dentry)
59 dentry->d_fsdata = hypfs_last_dentry;
60 hypfs_last_dentry = dentry;
63 static void hypfs_remove(struct dentry *dentry)
65 struct dentry *parent;
67 parent = dentry->d_parent;
68 if (S_ISDIR(dentry->d_inode->i_mode))
69 simple_rmdir(parent->d_inode, dentry);
71 simple_unlink(parent->d_inode, dentry);
76 static void hypfs_delete_tree(struct dentry *root)
78 while (hypfs_last_dentry) {
79 struct dentry *next_dentry;
80 next_dentry = hypfs_last_dentry->d_fsdata;
81 hypfs_remove(hypfs_last_dentry);
82 hypfs_last_dentry = next_dentry;
86 static struct inode *hypfs_make_inode(struct super_block *sb, int mode)
88 struct inode *ret = new_inode(sb);
91 struct hypfs_sb_info *hypfs_info = sb->s_fs_info;
93 ret->i_uid = hypfs_info->uid;
94 ret->i_gid = hypfs_info->gid;
96 ret->i_atime = ret->i_mtime = ret->i_ctime = CURRENT_TIME;
105 static void hypfs_drop_inode(struct inode *inode)
107 kfree(inode->i_private);
108 generic_delete_inode(inode);
111 static int hypfs_open(struct inode *inode, struct file *filp)
113 char *data = filp->f_path.dentry->d_inode->i_private;
114 struct hypfs_sb_info *fs_info;
116 if (filp->f_mode & FMODE_WRITE) {
117 if (!(inode->i_mode & S_IWUGO))
120 if (filp->f_mode & FMODE_READ) {
121 if (!(inode->i_mode & S_IRUGO))
125 fs_info = inode->i_sb->s_fs_info;
127 mutex_lock(&fs_info->lock);
128 filp->private_data = kstrdup(data, GFP_KERNEL);
129 if (!filp->private_data) {
130 mutex_unlock(&fs_info->lock);
133 mutex_unlock(&fs_info->lock);
138 static ssize_t hypfs_aio_read(struct kiocb *iocb, const struct iovec *iov,
139 unsigned long nr_segs, loff_t offset)
143 struct file *filp = iocb->ki_filp;
145 char __user *buf = iov[0].iov_base;
146 size_t count = iov[0].iov_len;
153 data = filp->private_data;
159 if (count > len - offset)
160 count = len - offset;
161 if (copy_to_user(buf, data + offset, count)) {
165 iocb->ki_pos += count;
170 static ssize_t hypfs_aio_write(struct kiocb *iocb, const struct iovec *iov,
171 unsigned long nr_segs, loff_t offset)
174 struct super_block *sb;
175 struct hypfs_sb_info *fs_info;
176 size_t count = iov_length(iov, nr_segs);
178 sb = iocb->ki_filp->f_path.dentry->d_inode->i_sb;
179 fs_info = sb->s_fs_info;
181 * Currently we only allow one update per second for two reasons:
182 * 1. diag 204 is VERY expensive
183 * 2. If several processes do updates in parallel and then read the
184 * hypfs data, the likelihood of collisions is reduced, if we restrict
185 * the minimum update interval. A collision occurs, if during the
186 * data gathering of one process another process triggers an update
187 * If the first process wants to ensure consistent data, it has
188 * to restart data collection in this case.
190 mutex_lock(&fs_info->lock);
191 if (fs_info->last_update == get_seconds()) {
195 hypfs_delete_tree(sb->s_root);
197 rc = hypfs_vm_create_files(sb, sb->s_root);
199 rc = hypfs_diag_create_files(sb, sb->s_root);
201 printk(KERN_ERR "hypfs: Update failed\n");
202 hypfs_delete_tree(sb->s_root);
205 hypfs_update_update(sb);
208 mutex_unlock(&fs_info->lock);
212 static int hypfs_release(struct inode *inode, struct file *filp)
214 kfree(filp->private_data);
218 enum { opt_uid, opt_gid, opt_err };
220 static match_table_t hypfs_tokens = {
226 static int hypfs_parse_options(char *options, struct super_block *sb)
229 substring_t args[MAX_OPT_ARGS];
233 while ((str = strsep(&options, ",")) != NULL) {
235 struct hypfs_sb_info *hypfs_info = sb->s_fs_info;
239 token = match_token(str, hypfs_tokens, args);
242 if (match_int(&args[0], &option))
244 hypfs_info->uid = option;
247 if (match_int(&args[0], &option))
249 hypfs_info->gid = option;
253 printk(KERN_ERR "hypfs: Unrecognized mount option "
254 "\"%s\" or missing value\n", str);
261 static int hypfs_show_options(struct seq_file *s, struct vfsmount *mnt)
263 struct hypfs_sb_info *hypfs_info = mnt->mnt_sb->s_fs_info;
265 seq_printf(s, ",uid=%u", hypfs_info->uid);
266 seq_printf(s, ",gid=%u", hypfs_info->gid);
270 static int hypfs_fill_super(struct super_block *sb, void *data, int silent)
272 struct inode *root_inode;
273 struct dentry *root_dentry;
275 struct hypfs_sb_info *sbi;
277 sbi = kzalloc(sizeof(struct hypfs_sb_info), GFP_KERNEL);
280 mutex_init(&sbi->lock);
281 sbi->uid = current->uid;
282 sbi->gid = current->gid;
284 sb->s_blocksize = PAGE_CACHE_SIZE;
285 sb->s_blocksize_bits = PAGE_CACHE_SHIFT;
286 sb->s_magic = HYPFS_MAGIC;
287 sb->s_op = &hypfs_s_ops;
288 if (hypfs_parse_options(data, sb)) {
292 root_inode = hypfs_make_inode(sb, S_IFDIR | 0755);
297 root_inode->i_op = &simple_dir_inode_operations;
298 root_inode->i_fop = &simple_dir_operations;
299 root_dentry = d_alloc_root(root_inode);
306 rc = hypfs_vm_create_files(sb, root_dentry);
308 rc = hypfs_diag_create_files(sb, root_dentry);
311 sbi->update_file = hypfs_create_update_file(sb, root_dentry);
312 if (IS_ERR(sbi->update_file)) {
313 rc = PTR_ERR(sbi->update_file);
316 hypfs_update_update(sb);
317 sb->s_root = root_dentry;
321 hypfs_delete_tree(root_dentry);
322 d_genocide(root_dentry);
329 static int hypfs_get_super(struct file_system_type *fst, int flags,
330 const char *devname, void *data, struct vfsmount *mnt)
332 return get_sb_single(fst, flags, data, hypfs_fill_super, mnt);
335 static void hypfs_kill_super(struct super_block *sb)
337 struct hypfs_sb_info *sb_info = sb->s_fs_info;
340 hypfs_delete_tree(sb->s_root);
341 hypfs_remove(sb_info->update_file);
342 kfree(sb->s_fs_info);
343 sb->s_fs_info = NULL;
345 kill_litter_super(sb);
348 static struct dentry *hypfs_create_file(struct super_block *sb,
349 struct dentry *parent, const char *name,
350 char *data, mode_t mode)
352 struct dentry *dentry;
357 qname.len = strlen(name);
358 qname.hash = full_name_hash(name, qname.len);
359 dentry = lookup_one_len(name, parent, strlen(name));
361 return ERR_PTR(-ENOMEM);
362 inode = hypfs_make_inode(sb, mode);
365 return ERR_PTR(-ENOMEM);
367 if (mode & S_IFREG) {
368 inode->i_fop = &hypfs_file_ops;
370 inode->i_size = strlen(data);
373 } else if (mode & S_IFDIR) {
374 inode->i_op = &simple_dir_inode_operations;
375 inode->i_fop = &simple_dir_operations;
376 parent->d_inode->i_nlink++;
379 inode->i_private = data;
380 d_instantiate(dentry, inode);
385 struct dentry *hypfs_mkdir(struct super_block *sb, struct dentry *parent,
388 struct dentry *dentry;
390 dentry = hypfs_create_file(sb, parent, name, NULL, S_IFDIR | DIR_MODE);
393 hypfs_add_dentry(dentry);
394 parent->d_inode->i_nlink++;
398 static struct dentry *hypfs_create_update_file(struct super_block *sb,
401 struct dentry *dentry;
403 dentry = hypfs_create_file(sb, dir, "update", NULL,
404 S_IFREG | UPDATE_FILE_MODE);
406 * We do not put the update file on the 'delete' list with
407 * hypfs_add_dentry(), since it should not be removed when the tree
413 struct dentry *hypfs_create_u64(struct super_block *sb, struct dentry *dir,
414 const char *name, __u64 value)
418 struct dentry *dentry;
420 snprintf(tmp, TMP_SIZE, "%lld\n", (unsigned long long int)value);
421 buffer = kstrdup(tmp, GFP_KERNEL);
423 return ERR_PTR(-ENOMEM);
425 hypfs_create_file(sb, dir, name, buffer, S_IFREG | REG_FILE_MODE);
426 if (IS_ERR(dentry)) {
428 return ERR_PTR(-ENOMEM);
430 hypfs_add_dentry(dentry);
434 struct dentry *hypfs_create_str(struct super_block *sb, struct dentry *dir,
435 const char *name, char *string)
438 struct dentry *dentry;
440 buffer = kmalloc(strlen(string) + 2, GFP_KERNEL);
442 return ERR_PTR(-ENOMEM);
443 sprintf(buffer, "%s\n", string);
445 hypfs_create_file(sb, dir, name, buffer, S_IFREG | REG_FILE_MODE);
446 if (IS_ERR(dentry)) {
448 return ERR_PTR(-ENOMEM);
450 hypfs_add_dentry(dentry);
454 static const struct file_operations hypfs_file_ops = {
456 .release = hypfs_release,
457 .read = do_sync_read,
458 .write = do_sync_write,
459 .aio_read = hypfs_aio_read,
460 .aio_write = hypfs_aio_write,
463 static struct file_system_type hypfs_type = {
464 .owner = THIS_MODULE,
465 .name = "s390_hypfs",
466 .get_sb = hypfs_get_super,
467 .kill_sb = hypfs_kill_super
470 static struct super_operations hypfs_s_ops = {
471 .statfs = simple_statfs,
472 .drop_inode = hypfs_drop_inode,
473 .show_options = hypfs_show_options,
476 static decl_subsys(s390, NULL, NULL);
478 static int __init hypfs_init(void)
484 /* no diag 2fc, just exit */
487 if (hypfs_diag_init()) {
492 kobj_set_kset_s(&s390_subsys, hypervisor_subsys);
493 rc = subsystem_register(&s390_subsys);
496 rc = register_filesystem(&hypfs_type);
498 goto fail_filesystem;
502 subsystem_unregister(&s390_subsys);
507 printk(KERN_ERR "hypfs: Initialization failed with rc = %i.\n", rc);
511 static void __exit hypfs_exit(void)
515 unregister_filesystem(&hypfs_type);
516 subsystem_unregister(&s390_subsys);
519 module_init(hypfs_init)
520 module_exit(hypfs_exit)
522 MODULE_LICENSE("GPL");
523 MODULE_AUTHOR("Michael Holzheu <holzheu@de.ibm.com>");
524 MODULE_DESCRIPTION("s390 Hypervisor Filesystem");