2 * This file is part of UBIFS.
4 * Copyright (C) 2006-2008 Nokia Corporation.
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.
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
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
19 * Authors: Adrian Hunter
20 * Artem Bityutskiy (Битюцкий Артём)
24 * This file implements TNC (Tree Node Cache) which caches indexing nodes of
27 * At the moment the locking rules of the TNC tree are quite simple and
28 * straightforward. We just have a mutex and lock it when we traverse the
29 * tree. If a znode is not in memory, we read it from flash while still having
33 #include <linux/crc32.h>
34 #include <linux/slab.h>
38 * Returned codes of 'matches_name()' and 'fallible_matches_name()' functions.
39 * @NAME_LESS: name corresponding to the first argument is less than second
40 * @NAME_MATCHES: names match
41 * @NAME_GREATER: name corresponding to the second argument is greater than
43 * @NOT_ON_MEDIA: node referred by zbranch does not exist on the media
45 * These constants were introduce to improve readability.
55 * insert_old_idx - record an index node obsoleted since the last commit start.
56 * @c: UBIFS file-system description object
57 * @lnum: LEB number of obsoleted index node
58 * @offs: offset of obsoleted index node
60 * Returns %0 on success, and a negative error code on failure.
62 * For recovery, there must always be a complete intact version of the index on
63 * flash at all times. That is called the "old index". It is the index as at the
64 * time of the last successful commit. Many of the index nodes in the old index
65 * may be dirty, but they must not be erased until the next successful commit
66 * (at which point that index becomes the old index).
68 * That means that the garbage collection and the in-the-gaps method of
69 * committing must be able to determine if an index node is in the old index.
70 * Most of the old index nodes can be found by looking up the TNC using the
71 * 'lookup_znode()' function. However, some of the old index nodes may have
72 * been deleted from the current index or may have been changed so much that
73 * they cannot be easily found. In those cases, an entry is added to an RB-tree.
74 * That is what this function does. The RB-tree is ordered by LEB number and
75 * offset because they uniquely identify the old index node.
77 static int insert_old_idx(struct ubifs_info
*c
, int lnum
, int offs
)
79 struct ubifs_old_idx
*old_idx
, *o
;
80 struct rb_node
**p
, *parent
= NULL
;
82 old_idx
= kmalloc(sizeof(struct ubifs_old_idx
), GFP_NOFS
);
83 if (unlikely(!old_idx
))
88 p
= &c
->old_idx
.rb_node
;
91 o
= rb_entry(parent
, struct ubifs_old_idx
, rb
);
94 else if (lnum
> o
->lnum
)
96 else if (offs
< o
->offs
)
98 else if (offs
> o
->offs
)
101 ubifs_err("old idx added twice!");
106 rb_link_node(&old_idx
->rb
, parent
, p
);
107 rb_insert_color(&old_idx
->rb
, &c
->old_idx
);
112 * insert_old_idx_znode - record a znode obsoleted since last commit start.
113 * @c: UBIFS file-system description object
114 * @znode: znode of obsoleted index node
116 * Returns %0 on success, and a negative error code on failure.
118 int insert_old_idx_znode(struct ubifs_info
*c
, struct ubifs_znode
*znode
)
121 struct ubifs_zbranch
*zbr
;
123 zbr
= &znode
->parent
->zbranch
[znode
->iip
];
125 return insert_old_idx(c
, zbr
->lnum
, zbr
->offs
);
128 return insert_old_idx(c
, c
->zroot
.lnum
,
134 * ins_clr_old_idx_znode - record a znode obsoleted since last commit start.
135 * @c: UBIFS file-system description object
136 * @znode: znode of obsoleted index node
138 * Returns %0 on success, and a negative error code on failure.
140 static int ins_clr_old_idx_znode(struct ubifs_info
*c
,
141 struct ubifs_znode
*znode
)
146 struct ubifs_zbranch
*zbr
;
148 zbr
= &znode
->parent
->zbranch
[znode
->iip
];
150 err
= insert_old_idx(c
, zbr
->lnum
, zbr
->offs
);
159 err
= insert_old_idx(c
, c
->zroot
.lnum
, c
->zroot
.offs
);
170 * destroy_old_idx - destroy the old_idx RB-tree.
171 * @c: UBIFS file-system description object
173 * During start commit, the old_idx RB-tree is used to avoid overwriting index
174 * nodes that were in the index last commit but have since been deleted. This
175 * is necessary for recovery i.e. the old index must be kept intact until the
176 * new index is successfully written. The old-idx RB-tree is used for the
177 * in-the-gaps method of writing index nodes and is destroyed every commit.
179 void destroy_old_idx(struct ubifs_info
*c
)
181 struct rb_node
*this = c
->old_idx
.rb_node
;
182 struct ubifs_old_idx
*old_idx
;
186 this = this->rb_left
;
188 } else if (this->rb_right
) {
189 this = this->rb_right
;
192 old_idx
= rb_entry(this, struct ubifs_old_idx
, rb
);
193 this = rb_parent(this);
195 if (this->rb_left
== &old_idx
->rb
)
196 this->rb_left
= NULL
;
198 this->rb_right
= NULL
;
202 c
->old_idx
= RB_ROOT
;
206 * copy_znode - copy a dirty znode.
207 * @c: UBIFS file-system description object
208 * @znode: znode to copy
210 * A dirty znode being committed may not be changed, so it is copied.
212 static struct ubifs_znode
*copy_znode(struct ubifs_info
*c
,
213 struct ubifs_znode
*znode
)
215 struct ubifs_znode
*zn
;
217 zn
= kmalloc(c
->max_znode_sz
, GFP_NOFS
);
219 return ERR_PTR(-ENOMEM
);
221 memcpy(zn
, znode
, c
->max_znode_sz
);
223 __set_bit(DIRTY_ZNODE
, &zn
->flags
);
224 __clear_bit(COW_ZNODE
, &zn
->flags
);
226 ubifs_assert(!ubifs_zn_obsolete(znode
));
227 __set_bit(OBSOLETE_ZNODE
, &znode
->flags
);
229 if (znode
->level
!= 0) {
231 const int n
= zn
->child_cnt
;
233 /* The children now have new parent */
234 for (i
= 0; i
< n
; i
++) {
235 struct ubifs_zbranch
*zbr
= &zn
->zbranch
[i
];
238 zbr
->znode
->parent
= zn
;
242 atomic_long_inc(&c
->dirty_zn_cnt
);
247 * add_idx_dirt - add dirt due to a dirty znode.
248 * @c: UBIFS file-system description object
249 * @lnum: LEB number of index node
250 * @dirt: size of index node
252 * This function updates lprops dirty space and the new size of the index.
254 static int add_idx_dirt(struct ubifs_info
*c
, int lnum
, int dirt
)
256 c
->calc_idx_sz
-= ALIGN(dirt
, 8);
257 return ubifs_add_dirt(c
, lnum
, dirt
);
261 * dirty_cow_znode - ensure a znode is not being committed.
262 * @c: UBIFS file-system description object
263 * @zbr: branch of znode to check
265 * Returns dirtied znode on success or negative error code on failure.
267 static struct ubifs_znode
*dirty_cow_znode(struct ubifs_info
*c
,
268 struct ubifs_zbranch
*zbr
)
270 struct ubifs_znode
*znode
= zbr
->znode
;
271 struct ubifs_znode
*zn
;
274 if (!ubifs_zn_cow(znode
)) {
275 /* znode is not being committed */
276 if (!test_and_set_bit(DIRTY_ZNODE
, &znode
->flags
)) {
277 atomic_long_inc(&c
->dirty_zn_cnt
);
278 atomic_long_dec(&c
->clean_zn_cnt
);
279 atomic_long_dec(&ubifs_clean_zn_cnt
);
280 err
= add_idx_dirt(c
, zbr
->lnum
, zbr
->len
);
287 zn
= copy_znode(c
, znode
);
292 err
= insert_old_idx(c
, zbr
->lnum
, zbr
->offs
);
295 err
= add_idx_dirt(c
, zbr
->lnum
, zbr
->len
);
310 * lnc_add - add a leaf node to the leaf node cache.
311 * @c: UBIFS file-system description object
312 * @zbr: zbranch of leaf node
315 * Leaf nodes are non-index nodes directory entry nodes or data nodes. The
316 * purpose of the leaf node cache is to save re-reading the same leaf node over
317 * and over again. Most things are cached by VFS, however the file system must
318 * cache directory entries for readdir and for resolving hash collisions. The
319 * present implementation of the leaf node cache is extremely simple, and
320 * allows for error returns that are not used but that may be needed if a more
321 * complex implementation is created.
323 * Note, this function does not add the @node object to LNC directly, but
324 * allocates a copy of the object and adds the copy to LNC. The reason for this
325 * is that @node has been allocated outside of the TNC subsystem and will be
326 * used with @c->tnc_mutex unlock upon return from the TNC subsystem. But LNC
327 * may be changed at any time, e.g. freed by the shrinker.
329 static int lnc_add(struct ubifs_info
*c
, struct ubifs_zbranch
*zbr
,
334 const struct ubifs_dent_node
*dent
= node
;
336 ubifs_assert(!zbr
->leaf
);
337 ubifs_assert(zbr
->len
!= 0);
338 ubifs_assert(is_hash_key(c
, &zbr
->key
));
340 err
= ubifs_validate_entry(c
, dent
);
343 dbg_dump_node(c
, dent
);
347 lnc_node
= kmalloc(zbr
->len
, GFP_NOFS
);
349 /* We don't have to have the cache, so no error */
352 memcpy(lnc_node
, node
, zbr
->len
);
353 zbr
->leaf
= lnc_node
;
358 * lnc_add_directly - add a leaf node to the leaf-node-cache.
359 * @c: UBIFS file-system description object
360 * @zbr: zbranch of leaf node
363 * This function is similar to 'lnc_add()', but it does not create a copy of
364 * @node but inserts @node to TNC directly.
366 static int lnc_add_directly(struct ubifs_info
*c
, struct ubifs_zbranch
*zbr
,
371 ubifs_assert(!zbr
->leaf
);
372 ubifs_assert(zbr
->len
!= 0);
374 err
= ubifs_validate_entry(c
, node
);
377 dbg_dump_node(c
, node
);
386 * lnc_free - remove a leaf node from the leaf node cache.
387 * @zbr: zbranch of leaf node
390 static void lnc_free(struct ubifs_zbranch
*zbr
)
399 * tnc_read_node_nm - read a "hashed" leaf node.
400 * @c: UBIFS file-system description object
401 * @zbr: key and position of the node
402 * @node: node is returned here
404 * This function reads a "hashed" node defined by @zbr from the leaf node cache
405 * (in it is there) or from the hash media, in which case the node is also
406 * added to LNC. Returns zero in case of success or a negative negative error
407 * code in case of failure.
409 static int tnc_read_node_nm(struct ubifs_info
*c
, struct ubifs_zbranch
*zbr
,
414 ubifs_assert(is_hash_key(c
, &zbr
->key
));
417 /* Read from the leaf node cache */
418 ubifs_assert(zbr
->len
!= 0);
419 memcpy(node
, zbr
->leaf
, zbr
->len
);
423 err
= ubifs_tnc_read_node(c
, zbr
, node
);
427 /* Add the node to the leaf node cache */
428 err
= lnc_add(c
, zbr
, node
);
433 * try_read_node - read a node if it is a node.
434 * @c: UBIFS file-system description object
435 * @buf: buffer to read to
437 * @len: node length (not aligned)
438 * @lnum: LEB number of node to read
439 * @offs: offset of node to read
441 * This function tries to read a node of known type and length, checks it and
442 * stores it in @buf. This function returns %1 if a node is present and %0 if
443 * a node is not present. A negative error code is returned for I/O errors.
444 * This function performs that same function as ubifs_read_node except that
445 * it does not require that there is actually a node present and instead
446 * the return code indicates if a node was read.
448 * Note, this function does not check CRC of data nodes if @c->no_chk_data_crc
449 * is true (it is controlled by corresponding mount option). However, if
450 * @c->mounting or @c->remounting_rw is true (we are mounting or re-mounting to
451 * R/W mode), @c->no_chk_data_crc is ignored and CRC is checked. This is
452 * because during mounting or re-mounting from R/O mode to R/W mode we may read
453 * journal nodes (when replying the journal or doing the recovery) and the
454 * journal nodes may potentially be corrupted, so checking is required.
456 static int try_read_node(const struct ubifs_info
*c
, void *buf
, int type
,
457 int len
, int lnum
, int offs
)
460 struct ubifs_ch
*ch
= buf
;
461 uint32_t crc
, node_crc
;
463 dbg_io("LEB %d:%d, %s, length %d", lnum
, offs
, dbg_ntype(type
), len
);
465 err
= ubifs_leb_read(c
, lnum
, buf
, offs
, len
, 1);
467 ubifs_err("cannot read node type %d from LEB %d:%d, error %d",
468 type
, lnum
, offs
, err
);
472 if (le32_to_cpu(ch
->magic
) != UBIFS_NODE_MAGIC
)
475 if (ch
->node_type
!= type
)
478 node_len
= le32_to_cpu(ch
->len
);
482 if (type
== UBIFS_DATA_NODE
&& c
->no_chk_data_crc
&& !c
->mounting
&&
486 crc
= crc32(UBIFS_CRC32_INIT
, buf
+ 8, node_len
- 8);
487 node_crc
= le32_to_cpu(ch
->crc
);
495 * fallible_read_node - try to read a leaf node.
496 * @c: UBIFS file-system description object
497 * @key: key of node to read
498 * @zbr: position of node
499 * @node: node returned
501 * This function tries to read a node and returns %1 if the node is read, %0
502 * if the node is not present, and a negative error code in the case of error.
504 static int fallible_read_node(struct ubifs_info
*c
, const union ubifs_key
*key
,
505 struct ubifs_zbranch
*zbr
, void *node
)
509 dbg_tnc("LEB %d:%d, key %s", zbr
->lnum
, zbr
->offs
, DBGKEY(key
));
511 ret
= try_read_node(c
, node
, key_type(c
, key
), zbr
->len
, zbr
->lnum
,
514 union ubifs_key node_key
;
515 struct ubifs_dent_node
*dent
= node
;
517 /* All nodes have key in the same place */
518 key_read(c
, &dent
->key
, &node_key
);
519 if (keys_cmp(c
, key
, &node_key
) != 0)
522 if (ret
== 0 && c
->replaying
)
523 dbg_mnt("dangling branch LEB %d:%d len %d, key %s",
524 zbr
->lnum
, zbr
->offs
, zbr
->len
, DBGKEY(key
));
529 * matches_name - determine if a direntry or xattr entry matches a given name.
530 * @c: UBIFS file-system description object
531 * @zbr: zbranch of dent
534 * This function checks if xentry/direntry referred by zbranch @zbr matches name
535 * @nm. Returns %NAME_MATCHES if it does, %NAME_LESS if the name referred by
536 * @zbr is less than @nm, and %NAME_GREATER if it is greater than @nm. In case
537 * of failure, a negative error code is returned.
539 static int matches_name(struct ubifs_info
*c
, struct ubifs_zbranch
*zbr
,
540 const struct qstr
*nm
)
542 struct ubifs_dent_node
*dent
;
545 /* If possible, match against the dent in the leaf node cache */
547 dent
= kmalloc(zbr
->len
, GFP_NOFS
);
551 err
= ubifs_tnc_read_node(c
, zbr
, dent
);
555 /* Add the node to the leaf node cache */
556 err
= lnc_add_directly(c
, zbr
, dent
);
562 nlen
= le16_to_cpu(dent
->nlen
);
563 err
= memcmp(dent
->name
, nm
->name
, min_t(int, nlen
, nm
->len
));
567 else if (nlen
< nm
->len
)
582 * get_znode - get a TNC znode that may not be loaded yet.
583 * @c: UBIFS file-system description object
584 * @znode: parent znode
585 * @n: znode branch slot number
587 * This function returns the znode or a negative error code.
589 static struct ubifs_znode
*get_znode(struct ubifs_info
*c
,
590 struct ubifs_znode
*znode
, int n
)
592 struct ubifs_zbranch
*zbr
;
594 zbr
= &znode
->zbranch
[n
];
598 znode
= ubifs_load_znode(c
, zbr
, znode
, n
);
603 * tnc_next - find next TNC entry.
604 * @c: UBIFS file-system description object
605 * @zn: znode is passed and returned here
606 * @n: znode branch slot number is passed and returned here
608 * This function returns %0 if the next TNC entry is found, %-ENOENT if there is
609 * no next entry, or a negative error code otherwise.
611 static int tnc_next(struct ubifs_info
*c
, struct ubifs_znode
**zn
, int *n
)
613 struct ubifs_znode
*znode
= *zn
;
617 if (nn
< znode
->child_cnt
) {
622 struct ubifs_znode
*zp
;
629 if (nn
< znode
->child_cnt
) {
630 znode
= get_znode(c
, znode
, nn
);
632 return PTR_ERR(znode
);
633 while (znode
->level
!= 0) {
634 znode
= get_znode(c
, znode
, 0);
636 return PTR_ERR(znode
);
648 * tnc_prev - find previous TNC entry.
649 * @c: UBIFS file-system description object
650 * @zn: znode is returned here
651 * @n: znode branch slot number is passed and returned here
653 * This function returns %0 if the previous TNC entry is found, %-ENOENT if
654 * there is no next entry, or a negative error code otherwise.
656 static int tnc_prev(struct ubifs_info
*c
, struct ubifs_znode
**zn
, int *n
)
658 struct ubifs_znode
*znode
= *zn
;
666 struct ubifs_znode
*zp
;
674 znode
= get_znode(c
, znode
, nn
);
676 return PTR_ERR(znode
);
677 while (znode
->level
!= 0) {
678 nn
= znode
->child_cnt
- 1;
679 znode
= get_znode(c
, znode
, nn
);
681 return PTR_ERR(znode
);
683 nn
= znode
->child_cnt
- 1;
693 * resolve_collision - resolve a collision.
694 * @c: UBIFS file-system description object
695 * @key: key of a directory or extended attribute entry
696 * @zn: znode is returned here
697 * @n: zbranch number is passed and returned here
698 * @nm: name of the entry
700 * This function is called for "hashed" keys to make sure that the found key
701 * really corresponds to the looked up node (directory or extended attribute
702 * entry). It returns %1 and sets @zn and @n if the collision is resolved.
703 * %0 is returned if @nm is not found and @zn and @n are set to the previous
704 * entry, i.e. to the entry after which @nm could follow if it were in TNC.
705 * This means that @n may be set to %-1 if the leftmost key in @zn is the
706 * previous one. A negative error code is returned on failures.
708 static int resolve_collision(struct ubifs_info
*c
, const union ubifs_key
*key
,
709 struct ubifs_znode
**zn
, int *n
,
710 const struct qstr
*nm
)
714 err
= matches_name(c
, &(*zn
)->zbranch
[*n
], nm
);
715 if (unlikely(err
< 0))
717 if (err
== NAME_MATCHES
)
720 if (err
== NAME_GREATER
) {
723 err
= tnc_prev(c
, zn
, n
);
724 if (err
== -ENOENT
) {
725 ubifs_assert(*n
== 0);
731 if (keys_cmp(c
, &(*zn
)->zbranch
[*n
].key
, key
)) {
733 * We have found the branch after which we would
734 * like to insert, but inserting in this znode
735 * may still be wrong. Consider the following 3
736 * znodes, in the case where we are resolving a
737 * collision with Key2.
740 * ----------------------
741 * level 1 | Key0 | Key1 |
742 * -----------------------
744 * znode za | | znode zb
745 * ------------ ------------
746 * level 0 | Key0 | | Key2 |
747 * ------------ ------------
749 * The lookup finds Key2 in znode zb. Lets say
750 * there is no match and the name is greater so
751 * we look left. When we find Key0, we end up
752 * here. If we return now, we will insert into
753 * znode za at slot n = 1. But that is invalid
754 * according to the parent's keys. Key2 must
755 * be inserted into znode zb.
757 * Note, this problem is not relevant for the
758 * case when we go right, because
759 * 'tnc_insert()' would correct the parent key.
761 if (*n
== (*zn
)->child_cnt
- 1) {
762 err
= tnc_next(c
, zn
, n
);
764 /* Should be impossible */
770 ubifs_assert(*n
== 0);
775 err
= matches_name(c
, &(*zn
)->zbranch
[*n
], nm
);
778 if (err
== NAME_LESS
)
780 if (err
== NAME_MATCHES
)
782 ubifs_assert(err
== NAME_GREATER
);
786 struct ubifs_znode
*znode
= *zn
;
790 err
= tnc_next(c
, &znode
, &nn
);
795 if (keys_cmp(c
, &znode
->zbranch
[nn
].key
, key
))
797 err
= matches_name(c
, &znode
->zbranch
[nn
], nm
);
800 if (err
== NAME_GREATER
)
804 if (err
== NAME_MATCHES
)
806 ubifs_assert(err
== NAME_LESS
);
812 * fallible_matches_name - determine if a dent matches a given name.
813 * @c: UBIFS file-system description object
814 * @zbr: zbranch of dent
817 * This is a "fallible" version of 'matches_name()' function which does not
818 * panic if the direntry/xentry referred by @zbr does not exist on the media.
820 * This function checks if xentry/direntry referred by zbranch @zbr matches name
821 * @nm. Returns %NAME_MATCHES it does, %NAME_LESS if the name referred by @zbr
822 * is less than @nm, %NAME_GREATER if it is greater than @nm, and @NOT_ON_MEDIA
823 * if xentry/direntry referred by @zbr does not exist on the media. A negative
824 * error code is returned in case of failure.
826 static int fallible_matches_name(struct ubifs_info
*c
,
827 struct ubifs_zbranch
*zbr
,
828 const struct qstr
*nm
)
830 struct ubifs_dent_node
*dent
;
833 /* If possible, match against the dent in the leaf node cache */
835 dent
= kmalloc(zbr
->len
, GFP_NOFS
);
839 err
= fallible_read_node(c
, &zbr
->key
, zbr
, dent
);
843 /* The node was not present */
847 ubifs_assert(err
== 1);
849 err
= lnc_add_directly(c
, zbr
, dent
);
855 nlen
= le16_to_cpu(dent
->nlen
);
856 err
= memcmp(dent
->name
, nm
->name
, min_t(int, nlen
, nm
->len
));
860 else if (nlen
< nm
->len
)
875 * fallible_resolve_collision - resolve a collision even if nodes are missing.
876 * @c: UBIFS file-system description object
878 * @zn: znode is returned here
879 * @n: branch number is passed and returned here
880 * @nm: name of directory entry
881 * @adding: indicates caller is adding a key to the TNC
883 * This is a "fallible" version of the 'resolve_collision()' function which
884 * does not panic if one of the nodes referred to by TNC does not exist on the
885 * media. This may happen when replaying the journal if a deleted node was
886 * Garbage-collected and the commit was not done. A branch that refers to a node
887 * that is not present is called a dangling branch. The following are the return
888 * codes for this function:
889 * o if @nm was found, %1 is returned and @zn and @n are set to the found
891 * o if we are @adding and @nm was not found, %0 is returned;
892 * o if we are not @adding and @nm was not found, but a dangling branch was
893 * found, then %1 is returned and @zn and @n are set to the dangling branch;
894 * o a negative error code is returned in case of failure.
896 static int fallible_resolve_collision(struct ubifs_info
*c
,
897 const union ubifs_key
*key
,
898 struct ubifs_znode
**zn
, int *n
,
899 const struct qstr
*nm
, int adding
)
901 struct ubifs_znode
*o_znode
= NULL
, *znode
= *zn
;
902 int uninitialized_var(o_n
), err
, cmp
, unsure
= 0, nn
= *n
;
904 cmp
= fallible_matches_name(c
, &znode
->zbranch
[nn
], nm
);
905 if (unlikely(cmp
< 0))
907 if (cmp
== NAME_MATCHES
)
909 if (cmp
== NOT_ON_MEDIA
) {
913 * We are unlucky and hit a dangling branch straight away.
914 * Now we do not really know where to go to find the needed
915 * branch - to the left or to the right. Well, let's try left.
919 unsure
= 1; /* Remove a dangling branch wherever it is */
921 if (cmp
== NAME_GREATER
|| unsure
) {
924 err
= tnc_prev(c
, zn
, n
);
925 if (err
== -ENOENT
) {
926 ubifs_assert(*n
== 0);
932 if (keys_cmp(c
, &(*zn
)->zbranch
[*n
].key
, key
)) {
933 /* See comments in 'resolve_collision()' */
934 if (*n
== (*zn
)->child_cnt
- 1) {
935 err
= tnc_next(c
, zn
, n
);
937 /* Should be impossible */
943 ubifs_assert(*n
== 0);
948 err
= fallible_matches_name(c
, &(*zn
)->zbranch
[*n
], nm
);
951 if (err
== NAME_MATCHES
)
953 if (err
== NOT_ON_MEDIA
) {
960 if (err
== NAME_LESS
)
967 if (cmp
== NAME_LESS
|| unsure
) {
972 err
= tnc_next(c
, &znode
, &nn
);
977 if (keys_cmp(c
, &znode
->zbranch
[nn
].key
, key
))
979 err
= fallible_matches_name(c
, &znode
->zbranch
[nn
], nm
);
982 if (err
== NAME_GREATER
)
986 if (err
== NAME_MATCHES
)
988 if (err
== NOT_ON_MEDIA
) {
995 /* Never match a dangling branch when adding */
996 if (adding
|| !o_znode
)
999 dbg_mnt("dangling match LEB %d:%d len %d %s",
1000 o_znode
->zbranch
[o_n
].lnum
, o_znode
->zbranch
[o_n
].offs
,
1001 o_znode
->zbranch
[o_n
].len
, DBGKEY(key
));
1008 * matches_position - determine if a zbranch matches a given position.
1009 * @zbr: zbranch of dent
1010 * @lnum: LEB number of dent to match
1011 * @offs: offset of dent to match
1013 * This function returns %1 if @lnum:@offs matches, and %0 otherwise.
1015 static int matches_position(struct ubifs_zbranch
*zbr
, int lnum
, int offs
)
1017 if (zbr
->lnum
== lnum
&& zbr
->offs
== offs
)
1024 * resolve_collision_directly - resolve a collision directly.
1025 * @c: UBIFS file-system description object
1026 * @key: key of directory entry
1027 * @zn: znode is passed and returned here
1028 * @n: zbranch number is passed and returned here
1029 * @lnum: LEB number of dent node to match
1030 * @offs: offset of dent node to match
1032 * This function is used for "hashed" keys to make sure the found directory or
1033 * extended attribute entry node is what was looked for. It is used when the
1034 * flash address of the right node is known (@lnum:@offs) which makes it much
1035 * easier to resolve collisions (no need to read entries and match full
1036 * names). This function returns %1 and sets @zn and @n if the collision is
1037 * resolved, %0 if @lnum:@offs is not found and @zn and @n are set to the
1038 * previous directory entry. Otherwise a negative error code is returned.
1040 static int resolve_collision_directly(struct ubifs_info
*c
,
1041 const union ubifs_key
*key
,
1042 struct ubifs_znode
**zn
, int *n
,
1045 struct ubifs_znode
*znode
;
1050 if (matches_position(&znode
->zbranch
[nn
], lnum
, offs
))
1055 err
= tnc_prev(c
, &znode
, &nn
);
1060 if (keys_cmp(c
, &znode
->zbranch
[nn
].key
, key
))
1062 if (matches_position(&znode
->zbranch
[nn
], lnum
, offs
)) {
1073 err
= tnc_next(c
, &znode
, &nn
);
1078 if (keys_cmp(c
, &znode
->zbranch
[nn
].key
, key
))
1082 if (matches_position(&znode
->zbranch
[nn
], lnum
, offs
))
1088 * dirty_cow_bottom_up - dirty a znode and its ancestors.
1089 * @c: UBIFS file-system description object
1090 * @znode: znode to dirty
1092 * If we do not have a unique key that resides in a znode, then we cannot
1093 * dirty that znode from the top down (i.e. by using lookup_level0_dirty)
1094 * This function records the path back to the last dirty ancestor, and then
1095 * dirties the znodes on that path.
1097 static struct ubifs_znode
*dirty_cow_bottom_up(struct ubifs_info
*c
,
1098 struct ubifs_znode
*znode
)
1100 struct ubifs_znode
*zp
;
1101 int *path
= c
->bottom_up_buf
, p
= 0;
1103 ubifs_assert(c
->zroot
.znode
);
1104 ubifs_assert(znode
);
1105 if (c
->zroot
.znode
->level
> BOTTOM_UP_HEIGHT
) {
1106 kfree(c
->bottom_up_buf
);
1107 c
->bottom_up_buf
= kmalloc(c
->zroot
.znode
->level
* sizeof(int),
1109 if (!c
->bottom_up_buf
)
1110 return ERR_PTR(-ENOMEM
);
1111 path
= c
->bottom_up_buf
;
1113 if (c
->zroot
.znode
->level
) {
1114 /* Go up until parent is dirty */
1122 ubifs_assert(p
< c
->zroot
.znode
->level
);
1124 if (!zp
->cnext
&& ubifs_zn_dirty(znode
))
1130 /* Come back down, dirtying as we go */
1132 struct ubifs_zbranch
*zbr
;
1136 ubifs_assert(path
[p
- 1] >= 0);
1137 ubifs_assert(path
[p
- 1] < zp
->child_cnt
);
1138 zbr
= &zp
->zbranch
[path
[--p
]];
1139 znode
= dirty_cow_znode(c
, zbr
);
1141 ubifs_assert(znode
== c
->zroot
.znode
);
1142 znode
= dirty_cow_znode(c
, &c
->zroot
);
1144 if (IS_ERR(znode
) || !p
)
1146 ubifs_assert(path
[p
- 1] >= 0);
1147 ubifs_assert(path
[p
- 1] < znode
->child_cnt
);
1148 znode
= znode
->zbranch
[path
[p
- 1]].znode
;
1155 * ubifs_lookup_level0 - search for zero-level znode.
1156 * @c: UBIFS file-system description object
1157 * @key: key to lookup
1158 * @zn: znode is returned here
1159 * @n: znode branch slot number is returned here
1161 * This function looks up the TNC tree and search for zero-level znode which
1162 * refers key @key. The found zero-level znode is returned in @zn. There are 3
1164 * o exact match, i.e. the found zero-level znode contains key @key, then %1
1165 * is returned and slot number of the matched branch is stored in @n;
1166 * o not exact match, which means that zero-level znode does not contain
1167 * @key, then %0 is returned and slot number of the closest branch is stored
1169 * o @key is so small that it is even less than the lowest key of the
1170 * leftmost zero-level node, then %0 is returned and %0 is stored in @n.
1172 * Note, when the TNC tree is traversed, some znodes may be absent, then this
1173 * function reads corresponding indexing nodes and inserts them to TNC. In
1174 * case of failure, a negative error code is returned.
1176 int ubifs_lookup_level0(struct ubifs_info
*c
, const union ubifs_key
*key
,
1177 struct ubifs_znode
**zn
, int *n
)
1180 struct ubifs_znode
*znode
;
1181 unsigned long time
= get_seconds();
1183 dbg_tnc("search key %s", DBGKEY(key
));
1184 ubifs_assert(key_type(c
, key
) < UBIFS_INVALID_KEY
);
1186 znode
= c
->zroot
.znode
;
1187 if (unlikely(!znode
)) {
1188 znode
= ubifs_load_znode(c
, &c
->zroot
, NULL
, 0);
1190 return PTR_ERR(znode
);
1196 struct ubifs_zbranch
*zbr
;
1198 exact
= ubifs_search_zbranch(c
, znode
, key
, n
);
1200 if (znode
->level
== 0)
1205 zbr
= &znode
->zbranch
[*n
];
1213 /* znode is not in TNC cache, load it from the media */
1214 znode
= ubifs_load_znode(c
, zbr
, znode
, *n
);
1216 return PTR_ERR(znode
);
1220 if (exact
|| !is_hash_key(c
, key
) || *n
!= -1) {
1221 dbg_tnc("found %d, lvl %d, n %d", exact
, znode
->level
, *n
);
1226 * Here is a tricky place. We have not found the key and this is a
1227 * "hashed" key, which may collide. The rest of the code deals with
1228 * situations like this:
1232 * | 3 | 5 | | 6 | 7 | (x)
1234 * Or more a complex example:
1238 * | 1 | 3 | | 5 | 8 |
1240 * | 5 | 5 | | 6 | 7 | (x)
1242 * In the examples, if we are looking for key "5", we may reach nodes
1243 * marked with "(x)". In this case what we have do is to look at the
1244 * left and see if there is "5" key there. If there is, we have to
1247 * Note, this whole situation is possible because we allow to have
1248 * elements which are equivalent to the next key in the parent in the
1249 * children of current znode. For example, this happens if we split a
1250 * znode like this: | 3 | 5 | 5 | 6 | 7 |, which results in something
1254 * | 3 | 5 | | 5 | 6 | 7 |
1256 * And this becomes what is at the first "picture" after key "5" marked
1257 * with "^" is removed. What could be done is we could prohibit
1258 * splitting in the middle of the colliding sequence. Also, when
1259 * removing the leftmost key, we would have to correct the key of the
1260 * parent node, which would introduce additional complications. Namely,
1261 * if we changed the leftmost key of the parent znode, the garbage
1262 * collector would be unable to find it (GC is doing this when GC'ing
1263 * indexing LEBs). Although we already have an additional RB-tree where
1264 * we save such changed znodes (see 'ins_clr_old_idx_znode()') until
1265 * after the commit. But anyway, this does not look easy to implement
1266 * so we did not try this.
1268 err
= tnc_prev(c
, &znode
, n
);
1269 if (err
== -ENOENT
) {
1270 dbg_tnc("found 0, lvl %d, n -1", znode
->level
);
1274 if (unlikely(err
< 0))
1276 if (keys_cmp(c
, key
, &znode
->zbranch
[*n
].key
)) {
1277 dbg_tnc("found 0, lvl %d, n -1", znode
->level
);
1282 dbg_tnc("found 1, lvl %d, n %d", znode
->level
, *n
);
1288 * lookup_level0_dirty - search for zero-level znode dirtying.
1289 * @c: UBIFS file-system description object
1290 * @key: key to lookup
1291 * @zn: znode is returned here
1292 * @n: znode branch slot number is returned here
1294 * This function looks up the TNC tree and search for zero-level znode which
1295 * refers key @key. The found zero-level znode is returned in @zn. There are 3
1297 * o exact match, i.e. the found zero-level znode contains key @key, then %1
1298 * is returned and slot number of the matched branch is stored in @n;
1299 * o not exact match, which means that zero-level znode does not contain @key
1300 * then %0 is returned and slot number of the closed branch is stored in
1302 * o @key is so small that it is even less than the lowest key of the
1303 * leftmost zero-level node, then %0 is returned and %-1 is stored in @n.
1305 * Additionally all znodes in the path from the root to the located zero-level
1306 * znode are marked as dirty.
1308 * Note, when the TNC tree is traversed, some znodes may be absent, then this
1309 * function reads corresponding indexing nodes and inserts them to TNC. In
1310 * case of failure, a negative error code is returned.
1312 static int lookup_level0_dirty(struct ubifs_info
*c
, const union ubifs_key
*key
,
1313 struct ubifs_znode
**zn
, int *n
)
1316 struct ubifs_znode
*znode
;
1317 unsigned long time
= get_seconds();
1319 dbg_tnc("search and dirty key %s", DBGKEY(key
));
1321 znode
= c
->zroot
.znode
;
1322 if (unlikely(!znode
)) {
1323 znode
= ubifs_load_znode(c
, &c
->zroot
, NULL
, 0);
1325 return PTR_ERR(znode
);
1328 znode
= dirty_cow_znode(c
, &c
->zroot
);
1330 return PTR_ERR(znode
);
1335 struct ubifs_zbranch
*zbr
;
1337 exact
= ubifs_search_zbranch(c
, znode
, key
, n
);
1339 if (znode
->level
== 0)
1344 zbr
= &znode
->zbranch
[*n
];
1348 znode
= dirty_cow_znode(c
, zbr
);
1350 return PTR_ERR(znode
);
1354 /* znode is not in TNC cache, load it from the media */
1355 znode
= ubifs_load_znode(c
, zbr
, znode
, *n
);
1357 return PTR_ERR(znode
);
1358 znode
= dirty_cow_znode(c
, zbr
);
1360 return PTR_ERR(znode
);
1364 if (exact
|| !is_hash_key(c
, key
) || *n
!= -1) {
1365 dbg_tnc("found %d, lvl %d, n %d", exact
, znode
->level
, *n
);
1370 * See huge comment at 'lookup_level0_dirty()' what is the rest of the
1373 err
= tnc_prev(c
, &znode
, n
);
1374 if (err
== -ENOENT
) {
1376 dbg_tnc("found 0, lvl %d, n -1", znode
->level
);
1379 if (unlikely(err
< 0))
1381 if (keys_cmp(c
, key
, &znode
->zbranch
[*n
].key
)) {
1383 dbg_tnc("found 0, lvl %d, n -1", znode
->level
);
1387 if (znode
->cnext
|| !ubifs_zn_dirty(znode
)) {
1388 znode
= dirty_cow_bottom_up(c
, znode
);
1390 return PTR_ERR(znode
);
1393 dbg_tnc("found 1, lvl %d, n %d", znode
->level
, *n
);
1399 * maybe_leb_gced - determine if a LEB may have been garbage collected.
1400 * @c: UBIFS file-system description object
1402 * @gc_seq1: garbage collection sequence number
1404 * This function determines if @lnum may have been garbage collected since
1405 * sequence number @gc_seq1. If it may have been then %1 is returned, otherwise
1408 static int maybe_leb_gced(struct ubifs_info
*c
, int lnum
, int gc_seq1
)
1410 int gc_seq2
, gced_lnum
;
1412 gced_lnum
= c
->gced_lnum
;
1414 gc_seq2
= c
->gc_seq
;
1415 /* Same seq means no GC */
1416 if (gc_seq1
== gc_seq2
)
1418 /* Different by more than 1 means we don't know */
1419 if (gc_seq1
+ 1 != gc_seq2
)
1422 * We have seen the sequence number has increased by 1. Now we need to
1423 * be sure we read the right LEB number, so read it again.
1426 if (gced_lnum
!= c
->gced_lnum
)
1428 /* Finally we can check lnum */
1429 if (gced_lnum
== lnum
)
1435 * ubifs_tnc_locate - look up a file-system node and return it and its location.
1436 * @c: UBIFS file-system description object
1437 * @key: node key to lookup
1438 * @node: the node is returned here
1439 * @lnum: LEB number is returned here
1440 * @offs: offset is returned here
1442 * This function looks up and reads node with key @key. The caller has to make
1443 * sure the @node buffer is large enough to fit the node. Returns zero in case
1444 * of success, %-ENOENT if the node was not found, and a negative error code in
1445 * case of failure. The node location can be returned in @lnum and @offs.
1447 int ubifs_tnc_locate(struct ubifs_info
*c
, const union ubifs_key
*key
,
1448 void *node
, int *lnum
, int *offs
)
1450 int found
, n
, err
, safely
= 0, gc_seq1
;
1451 struct ubifs_znode
*znode
;
1452 struct ubifs_zbranch zbr
, *zt
;
1455 mutex_lock(&c
->tnc_mutex
);
1456 found
= ubifs_lookup_level0(c
, key
, &znode
, &n
);
1460 } else if (found
< 0) {
1464 zt
= &znode
->zbranch
[n
];
1469 if (is_hash_key(c
, key
)) {
1471 * In this case the leaf node cache gets used, so we pass the
1472 * address of the zbranch and keep the mutex locked
1474 err
= tnc_read_node_nm(c
, zt
, node
);
1478 err
= ubifs_tnc_read_node(c
, zt
, node
);
1481 /* Drop the TNC mutex prematurely and race with garbage collection */
1482 zbr
= znode
->zbranch
[n
];
1483 gc_seq1
= c
->gc_seq
;
1484 mutex_unlock(&c
->tnc_mutex
);
1486 if (ubifs_get_wbuf(c
, zbr
.lnum
)) {
1487 /* We do not GC journal heads */
1488 err
= ubifs_tnc_read_node(c
, &zbr
, node
);
1492 err
= fallible_read_node(c
, key
, &zbr
, node
);
1493 if (err
<= 0 || maybe_leb_gced(c
, zbr
.lnum
, gc_seq1
)) {
1495 * The node may have been GC'ed out from under us so try again
1496 * while keeping the TNC mutex locked.
1504 mutex_unlock(&c
->tnc_mutex
);
1509 * ubifs_tnc_get_bu_keys - lookup keys for bulk-read.
1510 * @c: UBIFS file-system description object
1511 * @bu: bulk-read parameters and results
1513 * Lookup consecutive data node keys for the same inode that reside
1514 * consecutively in the same LEB. This function returns zero in case of success
1515 * and a negative error code in case of failure.
1517 * Note, if the bulk-read buffer length (@bu->buf_len) is known, this function
1518 * makes sure bulk-read nodes fit the buffer. Otherwise, this function prepares
1519 * maximum possible amount of nodes for bulk-read.
1521 int ubifs_tnc_get_bu_keys(struct ubifs_info
*c
, struct bu_info
*bu
)
1523 int n
, err
= 0, lnum
= -1, uninitialized_var(offs
);
1524 int uninitialized_var(len
);
1525 unsigned int block
= key_block(c
, &bu
->key
);
1526 struct ubifs_znode
*znode
;
1532 mutex_lock(&c
->tnc_mutex
);
1533 /* Find first key */
1534 err
= ubifs_lookup_level0(c
, &bu
->key
, &znode
, &n
);
1539 len
= znode
->zbranch
[n
].len
;
1540 /* The buffer must be big enough for at least 1 node */
1541 if (len
> bu
->buf_len
) {
1546 bu
->zbranch
[bu
->cnt
++] = znode
->zbranch
[n
];
1548 lnum
= znode
->zbranch
[n
].lnum
;
1549 offs
= ALIGN(znode
->zbranch
[n
].offs
+ len
, 8);
1552 struct ubifs_zbranch
*zbr
;
1553 union ubifs_key
*key
;
1554 unsigned int next_block
;
1557 err
= tnc_next(c
, &znode
, &n
);
1560 zbr
= &znode
->zbranch
[n
];
1562 /* See if there is another data key for this file */
1563 if (key_inum(c
, key
) != key_inum(c
, &bu
->key
) ||
1564 key_type(c
, key
) != UBIFS_DATA_KEY
) {
1569 /* First key found */
1571 offs
= ALIGN(zbr
->offs
+ zbr
->len
, 8);
1573 if (len
> bu
->buf_len
) {
1579 * The data nodes must be in consecutive positions in
1582 if (zbr
->lnum
!= lnum
|| zbr
->offs
!= offs
)
1584 offs
+= ALIGN(zbr
->len
, 8);
1585 len
= ALIGN(len
, 8) + zbr
->len
;
1586 /* Must not exceed buffer length */
1587 if (len
> bu
->buf_len
)
1590 /* Allow for holes */
1591 next_block
= key_block(c
, key
);
1592 bu
->blk_cnt
+= (next_block
- block
- 1);
1593 if (bu
->blk_cnt
>= UBIFS_MAX_BULK_READ
)
1597 bu
->zbranch
[bu
->cnt
++] = *zbr
;
1599 /* See if we have room for more */
1600 if (bu
->cnt
>= UBIFS_MAX_BULK_READ
)
1602 if (bu
->blk_cnt
>= UBIFS_MAX_BULK_READ
)
1606 if (err
== -ENOENT
) {
1610 bu
->gc_seq
= c
->gc_seq
;
1611 mutex_unlock(&c
->tnc_mutex
);
1615 * An enormous hole could cause bulk-read to encompass too many
1616 * page cache pages, so limit the number here.
1618 if (bu
->blk_cnt
> UBIFS_MAX_BULK_READ
)
1619 bu
->blk_cnt
= UBIFS_MAX_BULK_READ
;
1621 * Ensure that bulk-read covers a whole number of page cache
1624 if (UBIFS_BLOCKS_PER_PAGE
== 1 ||
1625 !(bu
->blk_cnt
& (UBIFS_BLOCKS_PER_PAGE
- 1)))
1628 /* At the end of file we can round up */
1629 bu
->blk_cnt
+= UBIFS_BLOCKS_PER_PAGE
- 1;
1632 /* Exclude data nodes that do not make up a whole page cache page */
1633 block
= key_block(c
, &bu
->key
) + bu
->blk_cnt
;
1634 block
&= ~(UBIFS_BLOCKS_PER_PAGE
- 1);
1636 if (key_block(c
, &bu
->zbranch
[bu
->cnt
- 1].key
) < block
)
1644 * read_wbuf - bulk-read from a LEB with a wbuf.
1645 * @wbuf: wbuf that may overlap the read
1646 * @buf: buffer into which to read
1648 * @lnum: LEB number from which to read
1649 * @offs: offset from which to read
1651 * This functions returns %0 on success or a negative error code on failure.
1653 static int read_wbuf(struct ubifs_wbuf
*wbuf
, void *buf
, int len
, int lnum
,
1656 const struct ubifs_info
*c
= wbuf
->c
;
1659 dbg_io("LEB %d:%d, length %d", lnum
, offs
, len
);
1660 ubifs_assert(wbuf
&& lnum
>= 0 && lnum
< c
->leb_cnt
&& offs
>= 0);
1661 ubifs_assert(!(offs
& 7) && offs
< c
->leb_size
);
1662 ubifs_assert(offs
+ len
<= c
->leb_size
);
1664 spin_lock(&wbuf
->lock
);
1665 overlap
= (lnum
== wbuf
->lnum
&& offs
+ len
> wbuf
->offs
);
1667 /* We may safely unlock the write-buffer and read the data */
1668 spin_unlock(&wbuf
->lock
);
1669 return ubifs_leb_read(c
, lnum
, buf
, offs
, len
, 0);
1672 /* Don't read under wbuf */
1673 rlen
= wbuf
->offs
- offs
;
1677 /* Copy the rest from the write-buffer */
1678 memcpy(buf
+ rlen
, wbuf
->buf
+ offs
+ rlen
- wbuf
->offs
, len
- rlen
);
1679 spin_unlock(&wbuf
->lock
);
1682 /* Read everything that goes before write-buffer */
1683 return ubifs_leb_read(c
, lnum
, buf
, offs
, rlen
, 0);
1689 * validate_data_node - validate data nodes for bulk-read.
1690 * @c: UBIFS file-system description object
1691 * @buf: buffer containing data node to validate
1692 * @zbr: zbranch of data node to validate
1694 * This functions returns %0 on success or a negative error code on failure.
1696 static int validate_data_node(struct ubifs_info
*c
, void *buf
,
1697 struct ubifs_zbranch
*zbr
)
1699 union ubifs_key key1
;
1700 struct ubifs_ch
*ch
= buf
;
1703 if (ch
->node_type
!= UBIFS_DATA_NODE
) {
1704 ubifs_err("bad node type (%d but expected %d)",
1705 ch
->node_type
, UBIFS_DATA_NODE
);
1709 err
= ubifs_check_node(c
, buf
, zbr
->lnum
, zbr
->offs
, 0, 0);
1711 ubifs_err("expected node type %d", UBIFS_DATA_NODE
);
1715 len
= le32_to_cpu(ch
->len
);
1716 if (len
!= zbr
->len
) {
1717 ubifs_err("bad node length %d, expected %d", len
, zbr
->len
);
1721 /* Make sure the key of the read node is correct */
1722 key_read(c
, buf
+ UBIFS_KEY_OFFSET
, &key1
);
1723 if (!keys_eq(c
, &zbr
->key
, &key1
)) {
1724 ubifs_err("bad key in node at LEB %d:%d",
1725 zbr
->lnum
, zbr
->offs
);
1726 dbg_tnc("looked for key %s found node's key %s",
1727 DBGKEY(&zbr
->key
), DBGKEY1(&key1
));
1736 ubifs_err("bad node at LEB %d:%d", zbr
->lnum
, zbr
->offs
);
1737 dbg_dump_node(c
, buf
);
1743 * ubifs_tnc_bulk_read - read a number of data nodes in one go.
1744 * @c: UBIFS file-system description object
1745 * @bu: bulk-read parameters and results
1747 * This functions reads and validates the data nodes that were identified by the
1748 * 'ubifs_tnc_get_bu_keys()' function. This functions returns %0 on success,
1749 * -EAGAIN to indicate a race with GC, or another negative error code on
1752 int ubifs_tnc_bulk_read(struct ubifs_info
*c
, struct bu_info
*bu
)
1754 int lnum
= bu
->zbranch
[0].lnum
, offs
= bu
->zbranch
[0].offs
, len
, err
, i
;
1755 struct ubifs_wbuf
*wbuf
;
1758 len
= bu
->zbranch
[bu
->cnt
- 1].offs
;
1759 len
+= bu
->zbranch
[bu
->cnt
- 1].len
- offs
;
1760 if (len
> bu
->buf_len
) {
1761 ubifs_err("buffer too small %d vs %d", bu
->buf_len
, len
);
1766 wbuf
= ubifs_get_wbuf(c
, lnum
);
1768 err
= read_wbuf(wbuf
, bu
->buf
, len
, lnum
, offs
);
1770 err
= ubifs_leb_read(c
, lnum
, bu
->buf
, offs
, len
, 0);
1772 /* Check for a race with GC */
1773 if (maybe_leb_gced(c
, lnum
, bu
->gc_seq
))
1776 if (err
&& err
!= -EBADMSG
) {
1777 ubifs_err("failed to read from LEB %d:%d, error %d",
1780 dbg_tnc("key %s", DBGKEY(&bu
->key
));
1784 /* Validate the nodes read */
1786 for (i
= 0; i
< bu
->cnt
; i
++) {
1787 err
= validate_data_node(c
, buf
, &bu
->zbranch
[i
]);
1790 buf
= buf
+ ALIGN(bu
->zbranch
[i
].len
, 8);
1797 * do_lookup_nm- look up a "hashed" node.
1798 * @c: UBIFS file-system description object
1799 * @key: node key to lookup
1800 * @node: the node is returned here
1803 * This function look up and reads a node which contains name hash in the key.
1804 * Since the hash may have collisions, there may be many nodes with the same
1805 * key, so we have to sequentially look to all of them until the needed one is
1806 * found. This function returns zero in case of success, %-ENOENT if the node
1807 * was not found, and a negative error code in case of failure.
1809 static int do_lookup_nm(struct ubifs_info
*c
, const union ubifs_key
*key
,
1810 void *node
, const struct qstr
*nm
)
1813 struct ubifs_znode
*znode
;
1815 dbg_tnc("name '%.*s' key %s", nm
->len
, nm
->name
, DBGKEY(key
));
1816 mutex_lock(&c
->tnc_mutex
);
1817 found
= ubifs_lookup_level0(c
, key
, &znode
, &n
);
1821 } else if (found
< 0) {
1826 ubifs_assert(n
>= 0);
1828 err
= resolve_collision(c
, key
, &znode
, &n
, nm
);
1829 dbg_tnc("rc returned %d, znode %p, n %d", err
, znode
, n
);
1830 if (unlikely(err
< 0))
1837 err
= tnc_read_node_nm(c
, &znode
->zbranch
[n
], node
);
1840 mutex_unlock(&c
->tnc_mutex
);
1845 * ubifs_tnc_lookup_nm - look up a "hashed" node.
1846 * @c: UBIFS file-system description object
1847 * @key: node key to lookup
1848 * @node: the node is returned here
1851 * This function look up and reads a node which contains name hash in the key.
1852 * Since the hash may have collisions, there may be many nodes with the same
1853 * key, so we have to sequentially look to all of them until the needed one is
1854 * found. This function returns zero in case of success, %-ENOENT if the node
1855 * was not found, and a negative error code in case of failure.
1857 int ubifs_tnc_lookup_nm(struct ubifs_info
*c
, const union ubifs_key
*key
,
1858 void *node
, const struct qstr
*nm
)
1861 const struct ubifs_dent_node
*dent
= node
;
1864 * We assume that in most of the cases there are no name collisions and
1865 * 'ubifs_tnc_lookup()' returns us the right direntry.
1867 err
= ubifs_tnc_lookup(c
, key
, node
);
1871 len
= le16_to_cpu(dent
->nlen
);
1872 if (nm
->len
== len
&& !memcmp(dent
->name
, nm
->name
, len
))
1876 * Unluckily, there are hash collisions and we have to iterate over
1877 * them look at each direntry with colliding name hash sequentially.
1879 return do_lookup_nm(c
, key
, node
, nm
);
1883 * correct_parent_keys - correct parent znodes' keys.
1884 * @c: UBIFS file-system description object
1885 * @znode: znode to correct parent znodes for
1887 * This is a helper function for 'tnc_insert()'. When the key of the leftmost
1888 * zbranch changes, keys of parent znodes have to be corrected. This helper
1889 * function is called in such situations and corrects the keys if needed.
1891 static void correct_parent_keys(const struct ubifs_info
*c
,
1892 struct ubifs_znode
*znode
)
1894 union ubifs_key
*key
, *key1
;
1896 ubifs_assert(znode
->parent
);
1897 ubifs_assert(znode
->iip
== 0);
1899 key
= &znode
->zbranch
[0].key
;
1900 key1
= &znode
->parent
->zbranch
[0].key
;
1902 while (keys_cmp(c
, key
, key1
) < 0) {
1903 key_copy(c
, key
, key1
);
1904 znode
= znode
->parent
;
1906 if (!znode
->parent
|| znode
->iip
)
1908 key1
= &znode
->parent
->zbranch
[0].key
;
1913 * insert_zbranch - insert a zbranch into a znode.
1914 * @znode: znode into which to insert
1915 * @zbr: zbranch to insert
1916 * @n: slot number to insert to
1918 * This is a helper function for 'tnc_insert()'. UBIFS does not allow "gaps" in
1919 * znode's array of zbranches and keeps zbranches consolidated, so when a new
1920 * zbranch has to be inserted to the @znode->zbranches[]' array at the @n-th
1921 * slot, zbranches starting from @n have to be moved right.
1923 static void insert_zbranch(struct ubifs_znode
*znode
,
1924 const struct ubifs_zbranch
*zbr
, int n
)
1928 ubifs_assert(ubifs_zn_dirty(znode
));
1931 for (i
= znode
->child_cnt
; i
> n
; i
--) {
1932 znode
->zbranch
[i
] = znode
->zbranch
[i
- 1];
1933 if (znode
->zbranch
[i
].znode
)
1934 znode
->zbranch
[i
].znode
->iip
= i
;
1937 zbr
->znode
->iip
= n
;
1939 for (i
= znode
->child_cnt
; i
> n
; i
--)
1940 znode
->zbranch
[i
] = znode
->zbranch
[i
- 1];
1942 znode
->zbranch
[n
] = *zbr
;
1943 znode
->child_cnt
+= 1;
1946 * After inserting at slot zero, the lower bound of the key range of
1947 * this znode may have changed. If this znode is subsequently split
1948 * then the upper bound of the key range may change, and furthermore
1949 * it could change to be lower than the original lower bound. If that
1950 * happens, then it will no longer be possible to find this znode in the
1951 * TNC using the key from the index node on flash. That is bad because
1952 * if it is not found, we will assume it is obsolete and may overwrite
1953 * it. Then if there is an unclean unmount, we will start using the
1954 * old index which will be broken.
1956 * So we first mark znodes that have insertions at slot zero, and then
1957 * if they are split we add their lnum/offs to the old_idx tree.
1964 * tnc_insert - insert a node into TNC.
1965 * @c: UBIFS file-system description object
1966 * @znode: znode to insert into
1967 * @zbr: branch to insert
1968 * @n: slot number to insert new zbranch to
1970 * This function inserts a new node described by @zbr into znode @znode. If
1971 * znode does not have a free slot for new zbranch, it is split. Parent znodes
1972 * are splat as well if needed. Returns zero in case of success or a negative
1973 * error code in case of failure.
1975 static int tnc_insert(struct ubifs_info
*c
, struct ubifs_znode
*znode
,
1976 struct ubifs_zbranch
*zbr
, int n
)
1978 struct ubifs_znode
*zn
, *zi
, *zp
;
1979 int i
, keep
, move
, appending
= 0;
1980 union ubifs_key
*key
= &zbr
->key
, *key1
;
1982 ubifs_assert(n
>= 0 && n
<= c
->fanout
);
1984 /* Implement naive insert for now */
1987 if (znode
->child_cnt
< c
->fanout
) {
1988 ubifs_assert(n
!= c
->fanout
);
1989 dbg_tnc("inserted at %d level %d, key %s", n
, znode
->level
,
1992 insert_zbranch(znode
, zbr
, n
);
1994 /* Ensure parent's key is correct */
1995 if (n
== 0 && zp
&& znode
->iip
== 0)
1996 correct_parent_keys(c
, znode
);
2002 * Unfortunately, @znode does not have more empty slots and we have to
2005 dbg_tnc("splitting level %d, key %s", znode
->level
, DBGKEY(key
));
2009 * We can no longer be sure of finding this znode by key, so we
2010 * record it in the old_idx tree.
2012 ins_clr_old_idx_znode(c
, znode
);
2014 zn
= kzalloc(c
->max_znode_sz
, GFP_NOFS
);
2018 zn
->level
= znode
->level
;
2020 /* Decide where to split */
2021 if (znode
->level
== 0 && key_type(c
, key
) == UBIFS_DATA_KEY
) {
2022 /* Try not to split consecutive data keys */
2023 if (n
== c
->fanout
) {
2024 key1
= &znode
->zbranch
[n
- 1].key
;
2025 if (key_inum(c
, key1
) == key_inum(c
, key
) &&
2026 key_type(c
, key1
) == UBIFS_DATA_KEY
)
2030 } else if (appending
&& n
!= c
->fanout
) {
2031 /* Try not to split consecutive data keys */
2034 if (n
>= (c
->fanout
+ 1) / 2) {
2035 key1
= &znode
->zbranch
[0].key
;
2036 if (key_inum(c
, key1
) == key_inum(c
, key
) &&
2037 key_type(c
, key1
) == UBIFS_DATA_KEY
) {
2038 key1
= &znode
->zbranch
[n
].key
;
2039 if (key_inum(c
, key1
) != key_inum(c
, key
) ||
2040 key_type(c
, key1
) != UBIFS_DATA_KEY
) {
2042 move
= c
->fanout
- keep
;
2054 keep
= (c
->fanout
+ 1) / 2;
2055 move
= c
->fanout
- keep
;
2059 * Although we don't at present, we could look at the neighbors and see
2060 * if we can move some zbranches there.
2064 /* Insert into existing znode */
2069 /* Insert into new znode */
2074 zbr
->znode
->parent
= zn
;
2079 __set_bit(DIRTY_ZNODE
, &zn
->flags
);
2080 atomic_long_inc(&c
->dirty_zn_cnt
);
2082 zn
->child_cnt
= move
;
2083 znode
->child_cnt
= keep
;
2085 dbg_tnc("moving %d, keeping %d", move
, keep
);
2088 for (i
= 0; i
< move
; i
++) {
2089 zn
->zbranch
[i
] = znode
->zbranch
[keep
+ i
];
2092 if (zn
->zbranch
[i
].znode
) {
2093 zn
->zbranch
[i
].znode
->parent
= zn
;
2094 zn
->zbranch
[i
].znode
->iip
= i
;
2098 /* Insert new key and branch */
2099 dbg_tnc("inserting at %d level %d, key %s", n
, zn
->level
, DBGKEY(key
));
2101 insert_zbranch(zi
, zbr
, n
);
2103 /* Insert new znode (produced by spitting) into the parent */
2105 if (n
== 0 && zi
== znode
&& znode
->iip
== 0)
2106 correct_parent_keys(c
, znode
);
2108 /* Locate insertion point */
2111 /* Tail recursion */
2112 zbr
->key
= zn
->zbranch
[0].key
;
2122 /* We have to split root znode */
2123 dbg_tnc("creating new zroot at level %d", znode
->level
+ 1);
2125 zi
= kzalloc(c
->max_znode_sz
, GFP_NOFS
);
2130 zi
->level
= znode
->level
+ 1;
2132 __set_bit(DIRTY_ZNODE
, &zi
->flags
);
2133 atomic_long_inc(&c
->dirty_zn_cnt
);
2135 zi
->zbranch
[0].key
= znode
->zbranch
[0].key
;
2136 zi
->zbranch
[0].znode
= znode
;
2137 zi
->zbranch
[0].lnum
= c
->zroot
.lnum
;
2138 zi
->zbranch
[0].offs
= c
->zroot
.offs
;
2139 zi
->zbranch
[0].len
= c
->zroot
.len
;
2140 zi
->zbranch
[1].key
= zn
->zbranch
[0].key
;
2141 zi
->zbranch
[1].znode
= zn
;
2146 c
->zroot
.znode
= zi
;
2157 * ubifs_tnc_add - add a node to TNC.
2158 * @c: UBIFS file-system description object
2160 * @lnum: LEB number of node
2161 * @offs: node offset
2164 * This function adds a node with key @key to TNC. The node may be new or it may
2165 * obsolete some existing one. Returns %0 on success or negative error code on
2168 int ubifs_tnc_add(struct ubifs_info
*c
, const union ubifs_key
*key
, int lnum
,
2171 int found
, n
, err
= 0;
2172 struct ubifs_znode
*znode
;
2174 mutex_lock(&c
->tnc_mutex
);
2175 dbg_tnc("%d:%d, len %d, key %s", lnum
, offs
, len
, DBGKEY(key
));
2176 found
= lookup_level0_dirty(c
, key
, &znode
, &n
);
2178 struct ubifs_zbranch zbr
;
2184 key_copy(c
, key
, &zbr
.key
);
2185 err
= tnc_insert(c
, znode
, &zbr
, n
+ 1);
2186 } else if (found
== 1) {
2187 struct ubifs_zbranch
*zbr
= &znode
->zbranch
[n
];
2190 err
= ubifs_add_dirt(c
, zbr
->lnum
, zbr
->len
);
2197 err
= dbg_check_tnc(c
, 0);
2198 mutex_unlock(&c
->tnc_mutex
);
2204 * ubifs_tnc_replace - replace a node in the TNC only if the old node is found.
2205 * @c: UBIFS file-system description object
2207 * @old_lnum: LEB number of old node
2208 * @old_offs: old node offset
2209 * @lnum: LEB number of node
2210 * @offs: node offset
2213 * This function replaces a node with key @key in the TNC only if the old node
2214 * is found. This function is called by garbage collection when node are moved.
2215 * Returns %0 on success or negative error code on failure.
2217 int ubifs_tnc_replace(struct ubifs_info
*c
, const union ubifs_key
*key
,
2218 int old_lnum
, int old_offs
, int lnum
, int offs
, int len
)
2220 int found
, n
, err
= 0;
2221 struct ubifs_znode
*znode
;
2223 mutex_lock(&c
->tnc_mutex
);
2224 dbg_tnc("old LEB %d:%d, new LEB %d:%d, len %d, key %s", old_lnum
,
2225 old_offs
, lnum
, offs
, len
, DBGKEY(key
));
2226 found
= lookup_level0_dirty(c
, key
, &znode
, &n
);
2233 struct ubifs_zbranch
*zbr
= &znode
->zbranch
[n
];
2236 if (zbr
->lnum
== old_lnum
&& zbr
->offs
== old_offs
) {
2238 err
= ubifs_add_dirt(c
, zbr
->lnum
, zbr
->len
);
2245 } else if (is_hash_key(c
, key
)) {
2246 found
= resolve_collision_directly(c
, key
, &znode
, &n
,
2247 old_lnum
, old_offs
);
2248 dbg_tnc("rc returned %d, znode %p, n %d, LEB %d:%d",
2249 found
, znode
, n
, old_lnum
, old_offs
);
2256 /* Ensure the znode is dirtied */
2257 if (znode
->cnext
|| !ubifs_zn_dirty(znode
)) {
2258 znode
= dirty_cow_bottom_up(c
, znode
);
2259 if (IS_ERR(znode
)) {
2260 err
= PTR_ERR(znode
);
2264 zbr
= &znode
->zbranch
[n
];
2266 err
= ubifs_add_dirt(c
, zbr
->lnum
,
2278 err
= ubifs_add_dirt(c
, lnum
, len
);
2281 err
= dbg_check_tnc(c
, 0);
2284 mutex_unlock(&c
->tnc_mutex
);
2289 * ubifs_tnc_add_nm - add a "hashed" node to TNC.
2290 * @c: UBIFS file-system description object
2292 * @lnum: LEB number of node
2293 * @offs: node offset
2297 * This is the same as 'ubifs_tnc_add()' but it should be used with keys which
2298 * may have collisions, like directory entry keys.
2300 int ubifs_tnc_add_nm(struct ubifs_info
*c
, const union ubifs_key
*key
,
2301 int lnum
, int offs
, int len
, const struct qstr
*nm
)
2303 int found
, n
, err
= 0;
2304 struct ubifs_znode
*znode
;
2306 mutex_lock(&c
->tnc_mutex
);
2307 dbg_tnc("LEB %d:%d, name '%.*s', key %s", lnum
, offs
, nm
->len
, nm
->name
,
2309 found
= lookup_level0_dirty(c
, key
, &znode
, &n
);
2317 found
= fallible_resolve_collision(c
, key
, &znode
, &n
,
2320 found
= resolve_collision(c
, key
, &znode
, &n
, nm
);
2321 dbg_tnc("rc returned %d, znode %p, n %d", found
, znode
, n
);
2327 /* Ensure the znode is dirtied */
2328 if (znode
->cnext
|| !ubifs_zn_dirty(znode
)) {
2329 znode
= dirty_cow_bottom_up(c
, znode
);
2330 if (IS_ERR(znode
)) {
2331 err
= PTR_ERR(znode
);
2337 struct ubifs_zbranch
*zbr
= &znode
->zbranch
[n
];
2340 err
= ubifs_add_dirt(c
, zbr
->lnum
, zbr
->len
);
2349 struct ubifs_zbranch zbr
;
2355 key_copy(c
, key
, &zbr
.key
);
2356 err
= tnc_insert(c
, znode
, &zbr
, n
+ 1);
2361 * We did not find it in the index so there may be a
2362 * dangling branch still in the index. So we remove it
2363 * by passing 'ubifs_tnc_remove_nm()' the same key but
2364 * an unmatchable name.
2366 struct qstr noname
= { .len
= 0, .name
= "" };
2368 err
= dbg_check_tnc(c
, 0);
2369 mutex_unlock(&c
->tnc_mutex
);
2372 return ubifs_tnc_remove_nm(c
, key
, &noname
);
2378 err
= dbg_check_tnc(c
, 0);
2379 mutex_unlock(&c
->tnc_mutex
);
2384 * tnc_delete - delete a znode form TNC.
2385 * @c: UBIFS file-system description object
2386 * @znode: znode to delete from
2387 * @n: zbranch slot number to delete
2389 * This function deletes a leaf node from @n-th slot of @znode. Returns zero in
2390 * case of success and a negative error code in case of failure.
2392 static int tnc_delete(struct ubifs_info
*c
, struct ubifs_znode
*znode
, int n
)
2394 struct ubifs_zbranch
*zbr
;
2395 struct ubifs_znode
*zp
;
2398 /* Delete without merge for now */
2399 ubifs_assert(znode
->level
== 0);
2400 ubifs_assert(n
>= 0 && n
< c
->fanout
);
2401 dbg_tnc("deleting %s", DBGKEY(&znode
->zbranch
[n
].key
));
2403 zbr
= &znode
->zbranch
[n
];
2406 err
= ubifs_add_dirt(c
, zbr
->lnum
, zbr
->len
);
2408 dbg_dump_znode(c
, znode
);
2412 /* We do not "gap" zbranch slots */
2413 for (i
= n
; i
< znode
->child_cnt
- 1; i
++)
2414 znode
->zbranch
[i
] = znode
->zbranch
[i
+ 1];
2415 znode
->child_cnt
-= 1;
2417 if (znode
->child_cnt
> 0)
2421 * This was the last zbranch, we have to delete this znode from the
2426 ubifs_assert(!ubifs_zn_obsolete(znode
));
2427 ubifs_assert(ubifs_zn_dirty(znode
));
2432 atomic_long_dec(&c
->dirty_zn_cnt
);
2434 err
= insert_old_idx_znode(c
, znode
);
2439 __set_bit(OBSOLETE_ZNODE
, &znode
->flags
);
2440 atomic_long_inc(&c
->clean_zn_cnt
);
2441 atomic_long_inc(&ubifs_clean_zn_cnt
);
2445 } while (znode
->child_cnt
== 1); /* while removing last child */
2447 /* Remove from znode, entry n - 1 */
2448 znode
->child_cnt
-= 1;
2449 ubifs_assert(znode
->level
!= 0);
2450 for (i
= n
; i
< znode
->child_cnt
; i
++) {
2451 znode
->zbranch
[i
] = znode
->zbranch
[i
+ 1];
2452 if (znode
->zbranch
[i
].znode
)
2453 znode
->zbranch
[i
].znode
->iip
= i
;
2457 * If this is the root and it has only 1 child then
2458 * collapse the tree.
2460 if (!znode
->parent
) {
2461 while (znode
->child_cnt
== 1 && znode
->level
!= 0) {
2463 zbr
= &znode
->zbranch
[0];
2464 znode
= get_znode(c
, znode
, 0);
2466 return PTR_ERR(znode
);
2467 znode
= dirty_cow_znode(c
, zbr
);
2469 return PTR_ERR(znode
);
2470 znode
->parent
= NULL
;
2473 err
= insert_old_idx(c
, c
->zroot
.lnum
,
2478 c
->zroot
.lnum
= zbr
->lnum
;
2479 c
->zroot
.offs
= zbr
->offs
;
2480 c
->zroot
.len
= zbr
->len
;
2481 c
->zroot
.znode
= znode
;
2482 ubifs_assert(!ubifs_zn_obsolete(zp
));
2483 ubifs_assert(ubifs_zn_dirty(zp
));
2484 atomic_long_dec(&c
->dirty_zn_cnt
);
2487 __set_bit(OBSOLETE_ZNODE
, &zp
->flags
);
2488 atomic_long_inc(&c
->clean_zn_cnt
);
2489 atomic_long_inc(&ubifs_clean_zn_cnt
);
2499 * ubifs_tnc_remove - remove an index entry of a node.
2500 * @c: UBIFS file-system description object
2503 * Returns %0 on success or negative error code on failure.
2505 int ubifs_tnc_remove(struct ubifs_info
*c
, const union ubifs_key
*key
)
2507 int found
, n
, err
= 0;
2508 struct ubifs_znode
*znode
;
2510 mutex_lock(&c
->tnc_mutex
);
2511 dbg_tnc("key %s", DBGKEY(key
));
2512 found
= lookup_level0_dirty(c
, key
, &znode
, &n
);
2518 err
= tnc_delete(c
, znode
, n
);
2520 err
= dbg_check_tnc(c
, 0);
2523 mutex_unlock(&c
->tnc_mutex
);
2528 * ubifs_tnc_remove_nm - remove an index entry for a "hashed" node.
2529 * @c: UBIFS file-system description object
2531 * @nm: directory entry name
2533 * Returns %0 on success or negative error code on failure.
2535 int ubifs_tnc_remove_nm(struct ubifs_info
*c
, const union ubifs_key
*key
,
2536 const struct qstr
*nm
)
2539 struct ubifs_znode
*znode
;
2541 mutex_lock(&c
->tnc_mutex
);
2542 dbg_tnc("%.*s, key %s", nm
->len
, nm
->name
, DBGKEY(key
));
2543 err
= lookup_level0_dirty(c
, key
, &znode
, &n
);
2549 err
= fallible_resolve_collision(c
, key
, &znode
, &n
,
2552 err
= resolve_collision(c
, key
, &znode
, &n
, nm
);
2553 dbg_tnc("rc returned %d, znode %p, n %d", err
, znode
, n
);
2557 /* Ensure the znode is dirtied */
2558 if (znode
->cnext
|| !ubifs_zn_dirty(znode
)) {
2559 znode
= dirty_cow_bottom_up(c
, znode
);
2560 if (IS_ERR(znode
)) {
2561 err
= PTR_ERR(znode
);
2565 err
= tnc_delete(c
, znode
, n
);
2571 err
= dbg_check_tnc(c
, 0);
2572 mutex_unlock(&c
->tnc_mutex
);
2577 * key_in_range - determine if a key falls within a range of keys.
2578 * @c: UBIFS file-system description object
2579 * @key: key to check
2580 * @from_key: lowest key in range
2581 * @to_key: highest key in range
2583 * This function returns %1 if the key is in range and %0 otherwise.
2585 static int key_in_range(struct ubifs_info
*c
, union ubifs_key
*key
,
2586 union ubifs_key
*from_key
, union ubifs_key
*to_key
)
2588 if (keys_cmp(c
, key
, from_key
) < 0)
2590 if (keys_cmp(c
, key
, to_key
) > 0)
2596 * ubifs_tnc_remove_range - remove index entries in range.
2597 * @c: UBIFS file-system description object
2598 * @from_key: lowest key to remove
2599 * @to_key: highest key to remove
2601 * This function removes index entries starting at @from_key and ending at
2602 * @to_key. This function returns zero in case of success and a negative error
2603 * code in case of failure.
2605 int ubifs_tnc_remove_range(struct ubifs_info
*c
, union ubifs_key
*from_key
,
2606 union ubifs_key
*to_key
)
2608 int i
, n
, k
, err
= 0;
2609 struct ubifs_znode
*znode
;
2610 union ubifs_key
*key
;
2612 mutex_lock(&c
->tnc_mutex
);
2614 /* Find first level 0 znode that contains keys to remove */
2615 err
= ubifs_lookup_level0(c
, from_key
, &znode
, &n
);
2622 err
= tnc_next(c
, &znode
, &n
);
2623 if (err
== -ENOENT
) {
2629 key
= &znode
->zbranch
[n
].key
;
2630 if (!key_in_range(c
, key
, from_key
, to_key
)) {
2636 /* Ensure the znode is dirtied */
2637 if (znode
->cnext
|| !ubifs_zn_dirty(znode
)) {
2638 znode
= dirty_cow_bottom_up(c
, znode
);
2639 if (IS_ERR(znode
)) {
2640 err
= PTR_ERR(znode
);
2645 /* Remove all keys in range except the first */
2646 for (i
= n
+ 1, k
= 0; i
< znode
->child_cnt
; i
++, k
++) {
2647 key
= &znode
->zbranch
[i
].key
;
2648 if (!key_in_range(c
, key
, from_key
, to_key
))
2650 lnc_free(&znode
->zbranch
[i
]);
2651 err
= ubifs_add_dirt(c
, znode
->zbranch
[i
].lnum
,
2652 znode
->zbranch
[i
].len
);
2654 dbg_dump_znode(c
, znode
);
2657 dbg_tnc("removing %s", DBGKEY(key
));
2660 for (i
= n
+ 1 + k
; i
< znode
->child_cnt
; i
++)
2661 znode
->zbranch
[i
- k
] = znode
->zbranch
[i
];
2662 znode
->child_cnt
-= k
;
2665 /* Now delete the first */
2666 err
= tnc_delete(c
, znode
, n
);
2673 err
= dbg_check_tnc(c
, 0);
2674 mutex_unlock(&c
->tnc_mutex
);
2679 * ubifs_tnc_remove_ino - remove an inode from TNC.
2680 * @c: UBIFS file-system description object
2681 * @inum: inode number to remove
2683 * This function remove inode @inum and all the extended attributes associated
2684 * with the anode from TNC and returns zero in case of success or a negative
2685 * error code in case of failure.
2687 int ubifs_tnc_remove_ino(struct ubifs_info
*c
, ino_t inum
)
2689 union ubifs_key key1
, key2
;
2690 struct ubifs_dent_node
*xent
, *pxent
= NULL
;
2691 struct qstr nm
= { .name
= NULL
};
2693 dbg_tnc("ino %lu", (unsigned long)inum
);
2696 * Walk all extended attribute entries and remove them together with
2697 * corresponding extended attribute inodes.
2699 lowest_xent_key(c
, &key1
, inum
);
2704 xent
= ubifs_tnc_next_ent(c
, &key1
, &nm
);
2706 err
= PTR_ERR(xent
);
2712 xattr_inum
= le64_to_cpu(xent
->inum
);
2713 dbg_tnc("xent '%s', ino %lu", xent
->name
,
2714 (unsigned long)xattr_inum
);
2716 nm
.name
= xent
->name
;
2717 nm
.len
= le16_to_cpu(xent
->nlen
);
2718 err
= ubifs_tnc_remove_nm(c
, &key1
, &nm
);
2724 lowest_ino_key(c
, &key1
, xattr_inum
);
2725 highest_ino_key(c
, &key2
, xattr_inum
);
2726 err
= ubifs_tnc_remove_range(c
, &key1
, &key2
);
2734 key_read(c
, &xent
->key
, &key1
);
2738 lowest_ino_key(c
, &key1
, inum
);
2739 highest_ino_key(c
, &key2
, inum
);
2741 return ubifs_tnc_remove_range(c
, &key1
, &key2
);
2745 * ubifs_tnc_next_ent - walk directory or extended attribute entries.
2746 * @c: UBIFS file-system description object
2747 * @key: key of last entry
2748 * @nm: name of last entry found or %NULL
2750 * This function finds and reads the next directory or extended attribute entry
2751 * after the given key (@key) if there is one. @nm is used to resolve
2754 * If the name of the current entry is not known and only the key is known,
2755 * @nm->name has to be %NULL. In this case the semantics of this function is a
2756 * little bit different and it returns the entry corresponding to this key, not
2757 * the next one. If the key was not found, the closest "right" entry is
2760 * If the fist entry has to be found, @key has to contain the lowest possible
2761 * key value for this inode and @name has to be %NULL.
2763 * This function returns the found directory or extended attribute entry node
2764 * in case of success, %-ENOENT is returned if no entry was found, and a
2765 * negative error code is returned in case of failure.
2767 struct ubifs_dent_node
*ubifs_tnc_next_ent(struct ubifs_info
*c
,
2768 union ubifs_key
*key
,
2769 const struct qstr
*nm
)
2771 int n
, err
, type
= key_type(c
, key
);
2772 struct ubifs_znode
*znode
;
2773 struct ubifs_dent_node
*dent
;
2774 struct ubifs_zbranch
*zbr
;
2775 union ubifs_key
*dkey
;
2777 dbg_tnc("%s %s", nm
->name
? (char *)nm
->name
: "(lowest)", DBGKEY(key
));
2778 ubifs_assert(is_hash_key(c
, key
));
2780 mutex_lock(&c
->tnc_mutex
);
2781 err
= ubifs_lookup_level0(c
, key
, &znode
, &n
);
2782 if (unlikely(err
< 0))
2787 /* Handle collisions */
2788 err
= resolve_collision(c
, key
, &znode
, &n
, nm
);
2789 dbg_tnc("rc returned %d, znode %p, n %d",
2791 if (unlikely(err
< 0))
2795 /* Now find next entry */
2796 err
= tnc_next(c
, &znode
, &n
);
2801 * The full name of the entry was not given, in which case the
2802 * behavior of this function is a little different and it
2803 * returns current entry, not the next one.
2807 * However, the given key does not exist in the TNC
2808 * tree and @znode/@n variables contain the closest
2809 * "preceding" element. Switch to the next one.
2811 err
= tnc_next(c
, &znode
, &n
);
2817 zbr
= &znode
->zbranch
[n
];
2818 dent
= kmalloc(zbr
->len
, GFP_NOFS
);
2819 if (unlikely(!dent
)) {
2825 * The above 'tnc_next()' call could lead us to the next inode, check
2829 if (key_inum(c
, dkey
) != key_inum(c
, key
) ||
2830 key_type(c
, dkey
) != type
) {
2835 err
= tnc_read_node_nm(c
, zbr
, dent
);
2839 mutex_unlock(&c
->tnc_mutex
);
2845 mutex_unlock(&c
->tnc_mutex
);
2846 return ERR_PTR(err
);
2850 * tnc_destroy_cnext - destroy left-over obsolete znodes from a failed commit.
2851 * @c: UBIFS file-system description object
2853 * Destroy left-over obsolete znodes from a failed commit.
2855 static void tnc_destroy_cnext(struct ubifs_info
*c
)
2857 struct ubifs_znode
*cnext
;
2861 ubifs_assert(c
->cmt_state
== COMMIT_BROKEN
);
2864 struct ubifs_znode
*znode
= cnext
;
2866 cnext
= cnext
->cnext
;
2867 if (ubifs_zn_obsolete(znode
))
2869 } while (cnext
&& cnext
!= c
->cnext
);
2873 * ubifs_tnc_close - close TNC subsystem and free all related resources.
2874 * @c: UBIFS file-system description object
2876 void ubifs_tnc_close(struct ubifs_info
*c
)
2878 tnc_destroy_cnext(c
);
2879 if (c
->zroot
.znode
) {
2882 ubifs_destroy_tnc_subtree(c
->zroot
.znode
);
2883 n
= atomic_long_read(&c
->clean_zn_cnt
);
2884 atomic_long_sub(n
, &ubifs_clean_zn_cnt
);
2892 * left_znode - get the znode to the left.
2893 * @c: UBIFS file-system description object
2896 * This function returns a pointer to the znode to the left of @znode or NULL if
2897 * there is not one. A negative error code is returned on failure.
2899 static struct ubifs_znode
*left_znode(struct ubifs_info
*c
,
2900 struct ubifs_znode
*znode
)
2902 int level
= znode
->level
;
2905 int n
= znode
->iip
- 1;
2907 /* Go up until we can go left */
2908 znode
= znode
->parent
;
2912 /* Now go down the rightmost branch to 'level' */
2913 znode
= get_znode(c
, znode
, n
);
2916 while (znode
->level
!= level
) {
2917 n
= znode
->child_cnt
- 1;
2918 znode
= get_znode(c
, znode
, n
);
2929 * right_znode - get the znode to the right.
2930 * @c: UBIFS file-system description object
2933 * This function returns a pointer to the znode to the right of @znode or NULL
2934 * if there is not one. A negative error code is returned on failure.
2936 static struct ubifs_znode
*right_znode(struct ubifs_info
*c
,
2937 struct ubifs_znode
*znode
)
2939 int level
= znode
->level
;
2942 int n
= znode
->iip
+ 1;
2944 /* Go up until we can go right */
2945 znode
= znode
->parent
;
2948 if (n
< znode
->child_cnt
) {
2949 /* Now go down the leftmost branch to 'level' */
2950 znode
= get_znode(c
, znode
, n
);
2953 while (znode
->level
!= level
) {
2954 znode
= get_znode(c
, znode
, 0);
2965 * lookup_znode - find a particular indexing node from TNC.
2966 * @c: UBIFS file-system description object
2967 * @key: index node key to lookup
2968 * @level: index node level
2969 * @lnum: index node LEB number
2970 * @offs: index node offset
2972 * This function searches an indexing node by its first key @key and its
2973 * address @lnum:@offs. It looks up the indexing tree by pulling all indexing
2974 * nodes it traverses to TNC. This function is called for indexing nodes which
2975 * were found on the media by scanning, for example when garbage-collecting or
2976 * when doing in-the-gaps commit. This means that the indexing node which is
2977 * looked for does not have to have exactly the same leftmost key @key, because
2978 * the leftmost key may have been changed, in which case TNC will contain a
2979 * dirty znode which still refers the same @lnum:@offs. This function is clever
2980 * enough to recognize such indexing nodes.
2982 * Note, if a znode was deleted or changed too much, then this function will
2983 * not find it. For situations like this UBIFS has the old index RB-tree
2984 * (indexed by @lnum:@offs).
2986 * This function returns a pointer to the znode found or %NULL if it is not
2987 * found. A negative error code is returned on failure.
2989 static struct ubifs_znode
*lookup_znode(struct ubifs_info
*c
,
2990 union ubifs_key
*key
, int level
,
2993 struct ubifs_znode
*znode
, *zn
;
2996 ubifs_assert(key_type(c
, key
) < UBIFS_INVALID_KEY
);
2999 * The arguments have probably been read off flash, so don't assume
3003 return ERR_PTR(-EINVAL
);
3005 /* Get the root znode */
3006 znode
= c
->zroot
.znode
;
3008 znode
= ubifs_load_znode(c
, &c
->zroot
, NULL
, 0);
3012 /* Check if it is the one we are looking for */
3013 if (c
->zroot
.lnum
== lnum
&& c
->zroot
.offs
== offs
)
3015 /* Descend to the parent level i.e. (level + 1) */
3016 if (level
>= znode
->level
)
3019 ubifs_search_zbranch(c
, znode
, key
, &n
);
3022 * We reached a znode where the leftmost key is greater
3023 * than the key we are searching for. This is the same
3024 * situation as the one described in a huge comment at
3025 * the end of the 'ubifs_lookup_level0()' function. And
3026 * for exactly the same reasons we have to try to look
3027 * left before giving up.
3029 znode
= left_znode(c
, znode
);
3034 ubifs_search_zbranch(c
, znode
, key
, &n
);
3035 ubifs_assert(n
>= 0);
3037 if (znode
->level
== level
+ 1)
3039 znode
= get_znode(c
, znode
, n
);
3043 /* Check if the child is the one we are looking for */
3044 if (znode
->zbranch
[n
].lnum
== lnum
&& znode
->zbranch
[n
].offs
== offs
)
3045 return get_znode(c
, znode
, n
);
3046 /* If the key is unique, there is nowhere else to look */
3047 if (!is_hash_key(c
, key
))
3050 * The key is not unique and so may be also in the znodes to either
3057 /* Move one branch to the left */
3061 znode
= left_znode(c
, znode
);
3066 n
= znode
->child_cnt
- 1;
3069 if (znode
->zbranch
[n
].lnum
== lnum
&&
3070 znode
->zbranch
[n
].offs
== offs
)
3071 return get_znode(c
, znode
, n
);
3072 /* Stop if the key is less than the one we are looking for */
3073 if (keys_cmp(c
, &znode
->zbranch
[n
].key
, key
) < 0)
3076 /* Back to the middle */
3081 /* Move one branch to the right */
3082 if (++n
>= znode
->child_cnt
) {
3083 znode
= right_znode(c
, znode
);
3091 if (znode
->zbranch
[n
].lnum
== lnum
&&
3092 znode
->zbranch
[n
].offs
== offs
)
3093 return get_znode(c
, znode
, n
);
3094 /* Stop if the key is greater than the one we are looking for */
3095 if (keys_cmp(c
, &znode
->zbranch
[n
].key
, key
) > 0)
3102 * is_idx_node_in_tnc - determine if an index node is in the TNC.
3103 * @c: UBIFS file-system description object
3104 * @key: key of index node
3105 * @level: index node level
3106 * @lnum: LEB number of index node
3107 * @offs: offset of index node
3109 * This function returns %0 if the index node is not referred to in the TNC, %1
3110 * if the index node is referred to in the TNC and the corresponding znode is
3111 * dirty, %2 if an index node is referred to in the TNC and the corresponding
3112 * znode is clean, and a negative error code in case of failure.
3114 * Note, the @key argument has to be the key of the first child. Also note,
3115 * this function relies on the fact that 0:0 is never a valid LEB number and
3116 * offset for a main-area node.
3118 int is_idx_node_in_tnc(struct ubifs_info
*c
, union ubifs_key
*key
, int level
,
3121 struct ubifs_znode
*znode
;
3123 znode
= lookup_znode(c
, key
, level
, lnum
, offs
);
3127 return PTR_ERR(znode
);
3129 return ubifs_zn_dirty(znode
) ? 1 : 2;
3133 * is_leaf_node_in_tnc - determine if a non-indexing not is in the TNC.
3134 * @c: UBIFS file-system description object
3136 * @lnum: node LEB number
3137 * @offs: node offset
3139 * This function returns %1 if the node is referred to in the TNC, %0 if it is
3140 * not, and a negative error code in case of failure.
3142 * Note, this function relies on the fact that 0:0 is never a valid LEB number
3143 * and offset for a main-area node.
3145 static int is_leaf_node_in_tnc(struct ubifs_info
*c
, union ubifs_key
*key
,
3148 struct ubifs_zbranch
*zbr
;
3149 struct ubifs_znode
*znode
, *zn
;
3150 int n
, found
, err
, nn
;
3151 const int unique
= !is_hash_key(c
, key
);
3153 found
= ubifs_lookup_level0(c
, key
, &znode
, &n
);
3155 return found
; /* Error code */
3158 zbr
= &znode
->zbranch
[n
];
3159 if (lnum
== zbr
->lnum
&& offs
== zbr
->offs
)
3160 return 1; /* Found it */
3164 * Because the key is not unique, we have to look left
3171 err
= tnc_prev(c
, &znode
, &n
);
3176 if (keys_cmp(c
, key
, &znode
->zbranch
[n
].key
))
3178 zbr
= &znode
->zbranch
[n
];
3179 if (lnum
== zbr
->lnum
&& offs
== zbr
->offs
)
3180 return 1; /* Found it */
3186 err
= tnc_next(c
, &znode
, &n
);
3192 if (keys_cmp(c
, key
, &znode
->zbranch
[n
].key
))
3194 zbr
= &znode
->zbranch
[n
];
3195 if (lnum
== zbr
->lnum
&& offs
== zbr
->offs
)
3196 return 1; /* Found it */
3202 * ubifs_tnc_has_node - determine whether a node is in the TNC.
3203 * @c: UBIFS file-system description object
3205 * @level: index node level (if it is an index node)
3206 * @lnum: node LEB number
3207 * @offs: node offset
3208 * @is_idx: non-zero if the node is an index node
3210 * This function returns %1 if the node is in the TNC, %0 if it is not, and a
3211 * negative error code in case of failure. For index nodes, @key has to be the
3212 * key of the first child. An index node is considered to be in the TNC only if
3213 * the corresponding znode is clean or has not been loaded.
3215 int ubifs_tnc_has_node(struct ubifs_info
*c
, union ubifs_key
*key
, int level
,
3216 int lnum
, int offs
, int is_idx
)
3220 mutex_lock(&c
->tnc_mutex
);
3222 err
= is_idx_node_in_tnc(c
, key
, level
, lnum
, offs
);
3226 /* The index node was found but it was dirty */
3229 /* The index node was found and it was clean */
3234 err
= is_leaf_node_in_tnc(c
, key
, lnum
, offs
);
3237 mutex_unlock(&c
->tnc_mutex
);
3242 * ubifs_dirty_idx_node - dirty an index node.
3243 * @c: UBIFS file-system description object
3244 * @key: index node key
3245 * @level: index node level
3246 * @lnum: index node LEB number
3247 * @offs: index node offset
3249 * This function loads and dirties an index node so that it can be garbage
3250 * collected. The @key argument has to be the key of the first child. This
3251 * function relies on the fact that 0:0 is never a valid LEB number and offset
3252 * for a main-area node. Returns %0 on success and a negative error code on
3255 int ubifs_dirty_idx_node(struct ubifs_info
*c
, union ubifs_key
*key
, int level
,
3258 struct ubifs_znode
*znode
;
3261 mutex_lock(&c
->tnc_mutex
);
3262 znode
= lookup_znode(c
, key
, level
, lnum
, offs
);
3265 if (IS_ERR(znode
)) {
3266 err
= PTR_ERR(znode
);
3269 znode
= dirty_cow_bottom_up(c
, znode
);
3270 if (IS_ERR(znode
)) {
3271 err
= PTR_ERR(znode
);
3276 mutex_unlock(&c
->tnc_mutex
);
3280 #ifdef CONFIG_UBIFS_FS_DEBUG
3283 * dbg_check_inode_size - check if inode size is correct.
3284 * @c: UBIFS file-system description object
3285 * @inum: inode number
3288 * This function makes sure that the inode size (@size) is correct and it does
3289 * not have any pages beyond @size. Returns zero if the inode is OK, %-EINVAL
3290 * if it has a data page beyond @size, and other negative error code in case of
3293 int dbg_check_inode_size(struct ubifs_info
*c
, const struct inode
*inode
,
3297 union ubifs_key from_key
, to_key
, *key
;
3298 struct ubifs_znode
*znode
;
3301 if (!S_ISREG(inode
->i_mode
))
3303 if (!dbg_is_chk_gen(c
))
3306 block
= (size
+ UBIFS_BLOCK_SIZE
- 1) >> UBIFS_BLOCK_SHIFT
;
3307 data_key_init(c
, &from_key
, inode
->i_ino
, block
);
3308 highest_data_key(c
, &to_key
, inode
->i_ino
);
3310 mutex_lock(&c
->tnc_mutex
);
3311 err
= ubifs_lookup_level0(c
, &from_key
, &znode
, &n
);
3321 err
= tnc_next(c
, &znode
, &n
);
3322 if (err
== -ENOENT
) {
3329 ubifs_assert(err
== 0);
3330 key
= &znode
->zbranch
[n
].key
;
3331 if (!key_in_range(c
, key
, &from_key
, &to_key
))
3335 block
= key_block(c
, key
);
3336 ubifs_err("inode %lu has size %lld, but there are data at offset %lld "
3337 "(data key %s)", (unsigned long)inode
->i_ino
, size
,
3338 ((loff_t
)block
) << UBIFS_BLOCK_SHIFT
, DBGKEY(key
));
3339 mutex_unlock(&c
->tnc_mutex
);
3340 dbg_dump_inode(c
, inode
);
3345 mutex_unlock(&c
->tnc_mutex
);
3349 #endif /* CONFIG_UBIFS_FS_DEBUG */