fs/ubifs/misc.h

   1 /*
   2  * This file is part of UBIFS.
   3  *
   4  * Copyright (C) 2006-2008 Nokia Corporation
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License version 2 as published by
   8  * the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  13  * more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along with
  16  * this program; if not, write to the Free Software Foundation, Inc., 51
  17  * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  18  *
  19  * Authors: Artem Bityutskiy (Битюцкий Артём)
  20  *          Adrian Hunter
  21  */
  22
  23 /*
  24  * This file contains miscellaneous helper functions.
  25  */
  26
  27 #ifndef __UBIFS_MISC_H__
  28 #define __UBIFS_MISC_H__
  29
  30 /**
  31  * ubifs_zn_dirty - check if znode is dirty.
  32  * @znode: znode to check
  33  *
  34  * This helper function returns %1 if @znode is dirty and %0 otherwise.
  35  */
  36 static inline int ubifs_zn_dirty(const struct ubifs_znode *znode)
  37 {
  38         return !!test_bit(DIRTY_ZNODE, &znode->flags);
  39 }
  40
  41 /**
  42  * ubifs_zn_obsolete - check if znode is obsolete.
  43  * @znode: znode to check
  44  *
  45  * This helper function returns %1 if @znode is obsolete and %0 otherwise.
  46  */
  47 static inline int ubifs_zn_obsolete(const struct ubifs_znode *znode)
  48 {
  49         return !!test_bit(OBSOLETE_ZNODE, &znode->flags);
  50 }
  51
  52 /**
  53  * ubifs_zn_cow - check if znode has to be copied on write.
  54  * @znode: znode to check
  55  *
  56  * This helper function returns %1 if @znode is has COW flag set and %0
  57  * otherwise.
  58  */
  59 static inline int ubifs_zn_cow(const struct ubifs_znode *znode)
  60 {
  61         return !!test_bit(COW_ZNODE, &znode->flags);
  62 }
  63
  64 /**
  65  * ubifs_wake_up_bgt - wake up background thread.
  66  * @c: UBIFS file-system description object
  67  */
  68 static inline void ubifs_wake_up_bgt(struct ubifs_info *c)
  69 {
  70         if (c->bgt && !c->need_bgt) {
  71                 c->need_bgt = 1;
  72                 wake_up_process(c->bgt);
  73         }
  74 }
  75
  76 /**
  77  * ubifs_tnc_find_child - find next child in znode.
  78  * @znode: znode to search at
  79  * @start: the zbranch index to start at
  80  *
  81  * This helper function looks for znode child starting at index @start. Returns
  82  * the child or %NULL if no children were found.
  83  */
  84 static inline struct ubifs_znode *
  85 ubifs_tnc_find_child(struct ubifs_znode *znode, int start)
  86 {
  87         while (start < znode->child_cnt) {
  88                 if (znode->zbranch[start].znode)
  89                         return znode->zbranch[start].znode;
  90                 start += 1;
  91         }
  92
  93         return NULL;
  94 }
  95
  96 /**
  97  * ubifs_inode - get UBIFS inode information by VFS 'struct inode' object.
  98  * @inode: the VFS 'struct inode' pointer
  99  */
 100 static inline struct ubifs_inode *ubifs_inode(const struct inode *inode)
 101 {
 102         return container_of(inode, struct ubifs_inode, vfs_inode);
 103 }
 104
 105 /**
 106  * ubifs_compr_present - check if compressor was compiled in.
 107  * @compr_type: compressor type to check
 108  *
 109  * This function returns %1 of compressor of type @compr_type is present, and
 110  * %0 if not.
 111  */
 112 static inline int ubifs_compr_present(int compr_type)
 113 {
 114         ubifs_assert(compr_type >= 0 && compr_type < UBIFS_COMPR_TYPES_CNT);
 115         return !!ubifs_compressors[compr_type]->capi_name;
 116 }
 117
 118 /**
 119  * ubifs_compr_name - get compressor name string by its type.
 120  * @compr_type: compressor type
 121  *
 122  * This function returns compressor type string.
 123  */
 124 static inline const char *ubifs_compr_name(int compr_type)
 125 {
 126         ubifs_assert(compr_type >= 0 && compr_type < UBIFS_COMPR_TYPES_CNT);
 127         return ubifs_compressors[compr_type]->name;
 128 }
 129
 130 /**
 131  * ubifs_wbuf_sync - synchronize write-buffer.
 132  * @wbuf: write-buffer to synchronize
 133  *
 134  * This is the same as as 'ubifs_wbuf_sync_nolock()' but it does not assume
 135  * that the write-buffer is already locked.
 136  */
 137 static inline int ubifs_wbuf_sync(struct ubifs_wbuf *wbuf)
 138 {
 139         int err;
 140
 141         mutex_lock_nested(&wbuf->io_mutex, wbuf->jhead);
 142         err = ubifs_wbuf_sync_nolock(wbuf);
 143         mutex_unlock(&wbuf->io_mutex);
 144         return err;
 145 }
 146
 147 /**
 148  * ubifs_encode_dev - encode device node IDs.
 149  * @dev: UBIFS device node information
 150  * @rdev: device IDs to encode
 151  *
 152  * This is a helper function which encodes major/minor numbers of a device node
 153  * into UBIFS device node description. We use standard Linux "new" and "huge"
 154  * encodings.
 155  */
 156 static inline int ubifs_encode_dev(union ubifs_dev_desc *dev, dev_t rdev)
 157 {
 158         dev->new = cpu_to_le32(new_encode_dev(rdev));
 159         return sizeof(dev->new);
 160 }
 161
 162 /**
 163  * ubifs_add_dirt - add dirty space to LEB properties.
 164  * @c: the UBIFS file-system description object
 165  * @lnum: LEB to add dirty space for
 166  * @dirty: dirty space to add
 167  *
 168  * This is a helper function which increased amount of dirty LEB space. Returns
 169  * zero in case of success and a negative error code in case of failure.
 170  */
 171 static inline int ubifs_add_dirt(struct ubifs_info *c, int lnum, int dirty)
 172 {
 173         return ubifs_update_one_lp(c, lnum, LPROPS_NC, dirty, 0, 0);
 174 }
 175
 176 /**
 177  * ubifs_return_leb - return LEB to lprops.
 178  * @c: the UBIFS file-system description object
 179  * @lnum: LEB to return
 180  *
 181  * This helper function cleans the "taken" flag of a logical eraseblock in the
 182  * lprops. Returns zero in case of success and a negative error code in case of
 183  * failure.
 184  */
 185 static inline int ubifs_return_leb(struct ubifs_info *c, int lnum)
 186 {
 187         return ubifs_change_one_lp(c, lnum, LPROPS_NC, LPROPS_NC, 0,
 188                                    LPROPS_TAKEN, 0);
 189 }
 190
 191 /**
 192  * ubifs_idx_node_sz - return index node size.
 193  * @c: the UBIFS file-system description object
 194  * @child_cnt: number of children of this index node
 195  */
 196 static inline int ubifs_idx_node_sz(const struct ubifs_info *c, int child_cnt)
 197 {
 198         return UBIFS_IDX_NODE_SZ + (UBIFS_BRANCH_SZ + c->key_len) * child_cnt;
 199 }
 200
 201 /**
 202  * ubifs_idx_branch - return pointer to an index branch.
 203  * @c: the UBIFS file-system description object
 204  * @idx: index node
 205  * @bnum: branch number
 206  */
 207 static inline
 208 struct ubifs_branch *ubifs_idx_branch(const struct ubifs_info *c,
 209                                       const struct ubifs_idx_node *idx,
 210                                       int bnum)
 211 {
 212         return (struct ubifs_branch *)((void *)idx->branches +
 213                                        (UBIFS_BRANCH_SZ + c->key_len) * bnum);
 214 }
 215
 216 /**
 217  * ubifs_idx_key - return pointer to an index key.
 218  * @c: the UBIFS file-system description object
 219  * @idx: index node
 220  */
 221 static inline void *ubifs_idx_key(const struct ubifs_info *c,
 222                                   const struct ubifs_idx_node *idx)
 223 {
 224         return (void *)((struct ubifs_branch *)idx->branches)->key;
 225 }
 226
 227 /**
 228  * ubifs_tnc_lookup - look up a file-system node.
 229  * @c: UBIFS file-system description object
 230  * @key: node key to lookup
 231  * @node: the node is returned here
 232  *
 233  * This function look up and reads node with key @key. The caller has to make
 234  * sure the @node buffer is large enough to fit the node. Returns zero in case
 235  * of success, %-ENOENT if the node was not found, and a negative error code in
 236  * case of failure.
 237  */
 238 static inline int ubifs_tnc_lookup(struct ubifs_info *c,
 239                                    const union ubifs_key *key, void *node)
 240 {
 241         return ubifs_tnc_locate(c, key, node, NULL, NULL);
 242 }
 243
 244 /**
 245  * ubifs_get_lprops - get reference to LEB properties.
 246  * @c: the UBIFS file-system description object
 247  *
 248  * This function locks lprops. Lprops have to be unlocked by
 249  * 'ubifs_release_lprops()'.
 250  */
 251 static inline void ubifs_get_lprops(struct ubifs_info *c)
 252 {
 253         mutex_lock(&c->lp_mutex);
 254 }
 255
 256 /**
 257  * ubifs_release_lprops - release lprops lock.
 258  * @c: the UBIFS file-system description object
 259  *
 260  * This function has to be called after each 'ubifs_get_lprops()' call to
 261  * unlock lprops.
 262  */
 263 static inline void ubifs_release_lprops(struct ubifs_info *c)
 264 {
 265         ubifs_assert(mutex_is_locked(&c->lp_mutex));
 266         ubifs_assert(c->lst.empty_lebs >= 0 &&
 267                      c->lst.empty_lebs <= c->main_lebs);
 268         mutex_unlock(&c->lp_mutex);
 269 }
 270
 271 /**
 272  * ubifs_next_log_lnum - switch to the next log LEB.
 273  * @c: UBIFS file-system description object
 274  * @lnum: current log LEB
 275  *
 276  * This helper function returns the log LEB number which goes next after LEB
 277  * 'lnum'.
 278  */
 279 static inline int ubifs_next_log_lnum(const struct ubifs_info *c, int lnum)
 280 {
 281         lnum += 1;
 282         if (lnum > c->log_last)
 283                 lnum = UBIFS_LOG_LNUM;
 284
 285         return lnum;
 286 }
 287
 288 #endif /* __UBIFS_MISC_H__ */