fs/jffs2/os-linux.h

   1 /*
   2  * JFFS2 -- Journalling Flash File System, Version 2.
   3  *
   4  * Copyright © 2001-2007 Red Hat, Inc.
   5  *
   6  * Created by David Woodhouse <dwmw2@infradead.org>
   7  *
   8  * For licensing information, see the file 'LICENCE' in this directory.
   9  *
  10  */
  11
  12 #ifndef __JFFS2_OS_LINUX_H__
  13 #define __JFFS2_OS_LINUX_H__
  14
  15 /* JFFS2 uses Linux mode bits natively -- no need for conversion */
  16 #define os_to_jffs2_mode(x) (x)
  17 #define jffs2_to_os_mode(x) (x)
  18
  19 struct kstatfs;
  20 struct kvec;
  21
  22 #define JFFS2_INODE_INFO(i) (container_of(i, struct jffs2_inode_info, vfs_inode))
  23 #define OFNI_EDONI_2SFFJ(f)  (&(f)->vfs_inode)
  24 #define JFFS2_SB_INFO(sb) (sb->s_fs_info)
  25 #define OFNI_BS_2SFFJ(c)  ((struct super_block *)c->os_priv)
  26
  27
  28 #define JFFS2_F_I_SIZE(f) (OFNI_EDONI_2SFFJ(f)->i_size)
  29 #define JFFS2_F_I_MODE(f) (OFNI_EDONI_2SFFJ(f)->i_mode)
  30 #define JFFS2_F_I_UID(f) (i_uid_read(OFNI_EDONI_2SFFJ(f)))
  31 #define JFFS2_F_I_GID(f) (i_gid_read(OFNI_EDONI_2SFFJ(f)))
  32 #define JFFS2_F_I_RDEV(f) (OFNI_EDONI_2SFFJ(f)->i_rdev)
  33
  34 #define JFFS2_CLAMP_TIME(t) ((uint32_t)clamp_t(time64_t, (t), 0, U32_MAX))
  35 #define ITIME(sec) ((struct timespec64){sec, 0})
  36 #define JFFS2_NOW() JFFS2_CLAMP_TIME(ktime_get_real_seconds())
  37 #define I_SEC(tv) JFFS2_CLAMP_TIME((tv).tv_sec)
  38 #define JFFS2_F_I_CTIME(f) I_SEC(OFNI_EDONI_2SFFJ(f)->i_ctime)
  39 #define JFFS2_F_I_MTIME(f) I_SEC(OFNI_EDONI_2SFFJ(f)->i_mtime)
  40 #define JFFS2_F_I_ATIME(f) I_SEC(OFNI_EDONI_2SFFJ(f)->i_atime)
  41 #define sleep_on_spinunlock(wq, s)                              \
  42         do {                                                    \
  43                 DECLARE_WAITQUEUE(__wait, current);             \
  44                 add_wait_queue((wq), &__wait);                  \
  45                 set_current_state(TASK_UNINTERRUPTIBLE);        \
  46                 spin_unlock(s);                                 \
  47                 schedule();                                     \
  48                 remove_wait_queue((wq), &__wait);               \
  49         } while(0)
  50
  51 static inline void jffs2_init_inode_info(struct jffs2_inode_info *f)
  52 {
  53         f->highest_version = 0;
  54         f->fragtree = RB_ROOT;
  55         f->metadata = NULL;
  56         f->dents = NULL;
  57         f->target = NULL;
  58         f->flags = 0;
  59         f->usercompr = 0;
  60 }
  61
  62
  63 #define jffs2_is_readonly(c) (OFNI_BS_2SFFJ(c)->s_flags & SB_RDONLY)
  64
  65 #define SECTOR_ADDR(x) ( (((unsigned long)(x) / c->sector_size) * c->sector_size) )
  66 #ifndef CONFIG_JFFS2_FS_WRITEBUFFER
  67
  68
  69 #ifdef CONFIG_JFFS2_SUMMARY
  70 #define jffs2_can_mark_obsolete(c) (0)
  71 #else
  72 #define jffs2_can_mark_obsolete(c) (1)
  73 #endif
  74
  75 #define jffs2_is_writebuffered(c) (0)
  76 #define jffs2_cleanmarker_oob(c) (0)
  77 #define jffs2_write_nand_cleanmarker(c,jeb) (-EIO)
  78
  79 #define jffs2_flash_write(c, ofs, len, retlen, buf) jffs2_flash_direct_write(c, ofs, len, retlen, buf)
  80 #define jffs2_flash_read(c, ofs, len, retlen, buf) (mtd_read((c)->mtd, ofs, len, retlen, buf))
  81 #define jffs2_flush_wbuf_pad(c) ({ do{} while(0); (void)(c), 0; })
  82 #define jffs2_flush_wbuf_gc(c, i) ({ do{} while(0); (void)(c), (void) i, 0; })
  83 #define jffs2_write_nand_badblock(c,jeb,bad_offset) (1)
  84 #define jffs2_nand_flash_setup(c) (0)
  85 #define jffs2_nand_flash_cleanup(c) do {} while(0)
  86 #define jffs2_wbuf_dirty(c) (0)
  87 #define jffs2_flash_writev(a,b,c,d,e,f) jffs2_flash_direct_writev(a,b,c,d,e)
  88 #define jffs2_wbuf_timeout NULL
  89 #define jffs2_wbuf_process NULL
  90 #define jffs2_dataflash(c) (0)
  91 #define jffs2_dataflash_setup(c) (0)
  92 #define jffs2_dataflash_cleanup(c) do {} while (0)
  93 #define jffs2_nor_wbuf_flash(c) (0)
  94 #define jffs2_nor_wbuf_flash_setup(c) (0)
  95 #define jffs2_nor_wbuf_flash_cleanup(c) do {} while (0)
  96 #define jffs2_ubivol(c) (0)
  97 #define jffs2_ubivol_setup(c) (0)
  98 #define jffs2_ubivol_cleanup(c) do {} while (0)
  99 #define jffs2_dirty_trigger(c) do {} while (0)
 100
 101 #else /* NAND and/or ECC'd NOR support present */
 102
 103 #define jffs2_is_writebuffered(c) (c->wbuf != NULL)
 104
 105 #ifdef CONFIG_JFFS2_SUMMARY
 106 #define jffs2_can_mark_obsolete(c) (0)
 107 #else
 108 #define jffs2_can_mark_obsolete(c) (c->mtd->flags & (MTD_BIT_WRITEABLE))
 109 #endif
 110
 111 #define jffs2_cleanmarker_oob(c) (c->mtd->type == MTD_NANDFLASH)
 112
 113 #define jffs2_wbuf_dirty(c) (!!(c)->wbuf_len)
 114
 115 /* wbuf.c */
 116 int jffs2_flash_writev(struct jffs2_sb_info *c, const struct kvec *vecs, unsigned long count, loff_t to, size_t *retlen, uint32_t ino);
 117 int jffs2_flash_write(struct jffs2_sb_info *c, loff_t ofs, size_t len, size_t *retlen, const u_char *buf);
 118 int jffs2_flash_read(struct jffs2_sb_info *c, loff_t ofs, size_t len, size_t *retlen, u_char *buf);
 119 int jffs2_check_oob_empty(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb,int mode);
 120 int jffs2_check_nand_cleanmarker(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb);
 121 int jffs2_write_nand_cleanmarker(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb);
 122 int jffs2_write_nand_badblock(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb, uint32_t bad_offset);
 123 void jffs2_wbuf_timeout(unsigned long data);
 124 void jffs2_wbuf_process(void *data);
 125 int jffs2_flush_wbuf_gc(struct jffs2_sb_info *c, uint32_t ino);
 126 int jffs2_flush_wbuf_pad(struct jffs2_sb_info *c);
 127 int jffs2_nand_flash_setup(struct jffs2_sb_info *c);
 128 void jffs2_nand_flash_cleanup(struct jffs2_sb_info *c);
 129
 130 #define jffs2_dataflash(c) (c->mtd->type == MTD_DATAFLASH)
 131 int jffs2_dataflash_setup(struct jffs2_sb_info *c);
 132 void jffs2_dataflash_cleanup(struct jffs2_sb_info *c);
 133 #define jffs2_ubivol(c) (c->mtd->type == MTD_UBIVOLUME)
 134 int jffs2_ubivol_setup(struct jffs2_sb_info *c);
 135 void jffs2_ubivol_cleanup(struct jffs2_sb_info *c);
 136
 137 #define jffs2_nor_wbuf_flash(c) (c->mtd->type == MTD_NORFLASH && ! (c->mtd->flags & MTD_BIT_WRITEABLE))
 138 int jffs2_nor_wbuf_flash_setup(struct jffs2_sb_info *c);
 139 void jffs2_nor_wbuf_flash_cleanup(struct jffs2_sb_info *c);
 140 void jffs2_dirty_trigger(struct jffs2_sb_info *c);
 141
 142 #endif /* WRITEBUFFER */
 143
 144 /* background.c */
 145 int jffs2_start_garbage_collect_thread(struct jffs2_sb_info *c);
 146 void jffs2_stop_garbage_collect_thread(struct jffs2_sb_info *c);
 147 void jffs2_garbage_collect_trigger(struct jffs2_sb_info *c);
 148
 149 /* dir.c */
 150 extern const struct file_operations jffs2_dir_operations;
 151 extern const struct inode_operations jffs2_dir_inode_operations;
 152
 153 /* file.c */
 154 extern const struct file_operations jffs2_file_operations;
 155 extern const struct inode_operations jffs2_file_inode_operations;
 156 extern const struct address_space_operations jffs2_file_address_operations;
 157 int jffs2_fsync(struct file *, loff_t, loff_t, int);
 158 int jffs2_do_readpage_unlock(void *data, struct page *pg);
 159
 160 /* ioctl.c */
 161 long jffs2_ioctl(struct file *, unsigned int, unsigned long);
 162
 163 /* symlink.c */
 164 extern const struct inode_operations jffs2_symlink_inode_operations;
 165
 166 /* fs.c */
 167 int jffs2_setattr (struct dentry *, struct iattr *);
 168 int jffs2_do_setattr (struct inode *, struct iattr *);
 169 struct inode *jffs2_iget(struct super_block *, unsigned long);
 170 void jffs2_evict_inode (struct inode *);
 171 void jffs2_dirty_inode(struct inode *inode, int flags);
 172 struct inode *jffs2_new_inode (struct inode *dir_i, umode_t mode,
 173                                struct jffs2_raw_inode *ri);
 174 int jffs2_statfs (struct dentry *, struct kstatfs *);
 175 int jffs2_do_remount_fs(struct super_block *sb, struct fs_context *fc);
 176 int jffs2_do_fill_super(struct super_block *sb, struct fs_context *fc);
 177 void jffs2_gc_release_inode(struct jffs2_sb_info *c,
 178                             struct jffs2_inode_info *f);
 179 struct jffs2_inode_info *jffs2_gc_fetch_inode(struct jffs2_sb_info *c,
 180                                               int inum, int unlinked);
 181
 182 unsigned char *jffs2_gc_fetch_page(struct jffs2_sb_info *c,
 183                                    struct jffs2_inode_info *f,
 184                                    unsigned long offset,
 185                                    unsigned long *priv);
 186 void jffs2_flash_cleanup(struct jffs2_sb_info *c);
 187
 188
 189 /* writev.c */
 190 int jffs2_flash_direct_writev(struct jffs2_sb_info *c, const struct kvec *vecs,
 191                        unsigned long count, loff_t to, size_t *retlen);
 192 int jffs2_flash_direct_write(struct jffs2_sb_info *c, loff_t ofs, size_t len,
 193                         size_t *retlen, const u_char *buf);
 194
 195 #endif /* __JFFS2_OS_LINUX_H__ */
 196
 197