fs/pstore/inode.c

   1 /*
   2  * Persistent Storage - ramfs parts.
   3  *
   4  * Copyright (C) 2010 Intel Corporation <tony.luck@intel.com>
   5  *
   6  *  This program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License version 2 as
   8  *  published by the Free Software Foundation.
   9  *
  10  *  This program is distributed in the hope that it will be useful,
  11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  *  GNU General Public License for more details.
  14  *
  15  *  You should have received a copy of the GNU General Public License
  16  *  along with this program; if not, write to the Free Software
  17  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  18  */
  19
  20 #include <linux/module.h>
  21 #include <linux/fs.h>
  22 #include <linux/fsnotify.h>
  23 #include <linux/pagemap.h>
  24 #include <linux/highmem.h>
  25 #include <linux/time.h>
  26 #include <linux/init.h>
  27 #include <linux/list.h>
  28 #include <linux/string.h>
  29 #include <linux/mount.h>
  30 #include <linux/ramfs.h>
  31 #include <linux/parser.h>
  32 #include <linux/sched.h>
  33 #include <linux/magic.h>
  34 #include <linux/pstore.h>
  35 #include <linux/slab.h>
  36 #include <linux/spinlock.h>
  37 #include <linux/uaccess.h>
  38
  39 #include "internal.h"
  40
  41 #define PSTORE_NAMELEN  64
  42
  43 static DEFINE_SPINLOCK(allpstore_lock);
  44 static LIST_HEAD(allpstore);
  45
  46 struct pstore_private {
  47         struct list_head list;
  48         struct pstore_info *psi;
  49         enum pstore_type_id type;
  50         u64     id;
  51         ssize_t size;
  52         char    data[];
  53 };
  54
  55 static ssize_t pstore_file_read(struct file *file, char __user *userbuf,
  56                                                 size_t count, loff_t *ppos)
  57 {
  58         struct pstore_private *ps = file->private_data;
  59
  60         return simple_read_from_buffer(userbuf, count, ppos, ps->data, ps->size);
  61 }
  62
  63 static const struct file_operations pstore_file_operations = {
  64         .open   = simple_open,
  65         .read   = pstore_file_read,
  66         .llseek = default_llseek,
  67 };
  68
  69 /*
  70  * When a file is unlinked from our file system we call the
  71  * platform driver to erase the record from persistent store.
  72  */
  73 static int pstore_unlink(struct inode *dir, struct dentry *dentry)
  74 {
  75         struct pstore_private *p = dentry->d_inode->i_private;
  76
  77         if (p->psi->erase)
  78                 p->psi->erase(p->type, p->id, p->psi);
  79
  80         return simple_unlink(dir, dentry);
  81 }
  82
  83 static void pstore_evict_inode(struct inode *inode)
  84 {
  85         struct pstore_private   *p = inode->i_private;
  86         unsigned long           flags;
  87
  88         end_writeback(inode);
  89         if (p) {
  90                 spin_lock_irqsave(&allpstore_lock, flags);
  91                 list_del(&p->list);
  92                 spin_unlock_irqrestore(&allpstore_lock, flags);
  93                 kfree(p);
  94         }
  95 }
  96
  97 static const struct inode_operations pstore_dir_inode_operations = {
  98         .lookup         = simple_lookup,
  99         .unlink         = pstore_unlink,
 100 };
 101
 102 static struct inode *pstore_get_inode(struct super_block *sb,
 103                                         const struct inode *dir, int mode, dev_t dev)
 104 {
 105         struct inode *inode = new_inode(sb);
 106
 107         if (inode) {
 108                 inode->i_ino = get_next_ino();
 109                 inode->i_uid = inode->i_gid = 0;
 110                 inode->i_mode = mode;
 111                 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
 112                 switch (mode & S_IFMT) {
 113                 case S_IFREG:
 114                         inode->i_fop = &pstore_file_operations;
 115                         break;
 116                 case S_IFDIR:
 117                         inode->i_op = &pstore_dir_inode_operations;
 118                         inode->i_fop = &simple_dir_operations;
 119                         inc_nlink(inode);
 120                         break;
 121                 }
 122         }
 123         return inode;
 124 }
 125
 126 enum {
 127         Opt_kmsg_bytes, Opt_err
 128 };
 129
 130 static const match_table_t tokens = {
 131         {Opt_kmsg_bytes, "kmsg_bytes=%u"},
 132         {Opt_err, NULL}
 133 };
 134
 135 static void parse_options(char *options)
 136 {
 137         char            *p;
 138         substring_t     args[MAX_OPT_ARGS];
 139         int             option;
 140
 141         if (!options)
 142                 return;
 143
 144         while ((p = strsep(&options, ",")) != NULL) {
 145                 int token;
 146
 147                 if (!*p)
 148                         continue;
 149
 150                 token = match_token(p, tokens, args);
 151                 switch (token) {
 152                 case Opt_kmsg_bytes:
 153                         if (!match_int(&args[0], &option))
 154                                 pstore_set_kmsg_bytes(option);
 155                         break;
 156                 }
 157         }
 158 }
 159
 160 static int pstore_remount(struct super_block *sb, int *flags, char *data)
 161 {
 162         parse_options(data);
 163
 164         return 0;
 165 }
 166
 167 static const struct super_operations pstore_ops = {
 168         .statfs         = simple_statfs,
 169         .drop_inode     = generic_delete_inode,
 170         .evict_inode    = pstore_evict_inode,
 171         .remount_fs     = pstore_remount,
 172         .show_options   = generic_show_options,
 173 };
 174
 175 static struct super_block *pstore_sb;
 176
 177 int pstore_is_mounted(void)
 178 {
 179         return pstore_sb != NULL;
 180 }
 181
 182 /*
 183  * Make a regular file in the root directory of our file system.
 184  * Load it up with "size" bytes of data from "buf".
 185  * Set the mtime & ctime to the date that this record was originally stored.
 186  */
 187 int pstore_mkfile(enum pstore_type_id type, char *psname, u64 id,
 188                   char *data, size_t size, struct timespec time,
 189                   struct pstore_info *psi)
 190 {
 191         struct dentry           *root = pstore_sb->s_root;
 192         struct dentry           *dentry;
 193         struct inode            *inode;
 194         int                     rc = 0;
 195         char                    name[PSTORE_NAMELEN];
 196         struct pstore_private   *private, *pos;
 197         unsigned long           flags;
 198
 199         spin_lock_irqsave(&allpstore_lock, flags);
 200         list_for_each_entry(pos, &allpstore, list) {
 201                 if (pos->type == type &&
 202                     pos->id == id &&
 203                     pos->psi == psi) {
 204                         rc = -EEXIST;
 205                         break;
 206                 }
 207         }
 208         spin_unlock_irqrestore(&allpstore_lock, flags);
 209         if (rc)
 210                 return rc;
 211
 212         rc = -ENOMEM;
 213         inode = pstore_get_inode(pstore_sb, root->d_inode, S_IFREG | 0444, 0);
 214         if (!inode)
 215                 goto fail;
 216         private = kmalloc(sizeof *private + size, GFP_KERNEL);
 217         if (!private)
 218                 goto fail_alloc;
 219         private->type = type;
 220         private->id = id;
 221         private->psi = psi;
 222
 223         switch (type) {
 224         case PSTORE_TYPE_DMESG:
 225                 sprintf(name, "dmesg-%s-%lld", psname, id);
 226                 break;
 227         case PSTORE_TYPE_MCE:
 228                 sprintf(name, "mce-%s-%lld", psname, id);
 229                 break;
 230         case PSTORE_TYPE_UNKNOWN:
 231                 sprintf(name, "unknown-%s-%lld", psname, id);
 232                 break;
 233         default:
 234                 sprintf(name, "type%d-%s-%lld", type, psname, id);
 235                 break;
 236         }
 237
 238         mutex_lock(&root->d_inode->i_mutex);
 239
 240         rc = -ENOSPC;
 241         dentry = d_alloc_name(root, name);
 242         if (IS_ERR(dentry))
 243                 goto fail_lockedalloc;
 244
 245         memcpy(private->data, data, size);
 246         inode->i_size = private->size = size;
 247
 248         inode->i_private = private;
 249
 250         if (time.tv_sec)
 251                 inode->i_mtime = inode->i_ctime = time;
 252
 253         d_add(dentry, inode);
 254
 255         spin_lock_irqsave(&allpstore_lock, flags);
 256         list_add(&private->list, &allpstore);
 257         spin_unlock_irqrestore(&allpstore_lock, flags);
 258
 259         mutex_unlock(&root->d_inode->i_mutex);
 260
 261         return 0;
 262
 263 fail_lockedalloc:
 264         mutex_unlock(&root->d_inode->i_mutex);
 265         kfree(private);
 266 fail_alloc:
 267         iput(inode);
 268
 269 fail:
 270         return rc;
 271 }
 272
 273 int pstore_fill_super(struct super_block *sb, void *data, int silent)
 274 {
 275         struct inode *inode;
 276
 277         save_mount_options(sb, data);
 278
 279         pstore_sb = sb;
 280
 281         sb->s_maxbytes          = MAX_LFS_FILESIZE;
 282         sb->s_blocksize         = PAGE_CACHE_SIZE;
 283         sb->s_blocksize_bits    = PAGE_CACHE_SHIFT;
 284         sb->s_magic             = PSTOREFS_MAGIC;
 285         sb->s_op                = &pstore_ops;
 286         sb->s_time_gran         = 1;
 287
 288         parse_options(data);
 289
 290         inode = pstore_get_inode(sb, NULL, S_IFDIR | 0755, 0);
 291         if (inode) {
 292                 /* override ramfs "dir" options so we catch unlink(2) */
 293                 inode->i_op = &pstore_dir_inode_operations;
 294         }
 295         sb->s_root = d_make_root(inode);
 296         if (!sb->s_root)
 297                 return -ENOMEM;
 298
 299         pstore_get_records(0);
 300
 301         return 0;
 302 }
 303
 304 static struct dentry *pstore_mount(struct file_system_type *fs_type,
 305         int flags, const char *dev_name, void *data)
 306 {
 307         return mount_single(fs_type, flags, data, pstore_fill_super);
 308 }
 309
 310 static void pstore_kill_sb(struct super_block *sb)
 311 {
 312         kill_litter_super(sb);
 313         pstore_sb = NULL;
 314 }
 315
 316 static struct file_system_type pstore_fs_type = {
 317         .name           = "pstore",
 318         .mount          = pstore_mount,
 319         .kill_sb        = pstore_kill_sb,
 320 };
 321
 322 static int __init init_pstore_fs(void)
 323 {
 324         return register_filesystem(&pstore_fs_type);
 325 }
 326 module_init(init_pstore_fs)
 327
 328 MODULE_AUTHOR("Tony Luck <tony.luck@intel.com>");
 329 MODULE_LICENSE("GPL");