2 * JFFS2 -- Journalling Flash File System, Version 2.
4 * Copyright © 2001-2007 Red Hat, Inc.
6 * Created by David Woodhouse <dwmw2@infradead.org>
8 * For licensing information, see the file 'LICENCE' in this directory.
12 #include <linux/kernel.h>
13 #include <linux/sched.h>
14 #include <linux/slab.h>
16 #include <linux/crc32.h>
17 #include <linux/pagemap.h>
18 #include <linux/mtd/mtd.h>
19 #include <linux/compiler.h>
23 * Check the data CRC of the node.
25 * Returns: 0 if the data CRC is correct;
27 * error code if an error occured.
29 static int check_node_data(struct jffs2_sb_info *c, struct jffs2_tmp_dnode_info *tn)
31 struct jffs2_raw_node_ref *ref = tn->fn->raw;
32 int err = 0, pointed = 0;
33 struct jffs2_eraseblock *jeb;
34 unsigned char *buffer;
35 uint32_t crc, ofs, len;
38 BUG_ON(tn->csize == 0);
40 /* Calculate how many bytes were already checked */
41 ofs = ref_offset(ref) + sizeof(struct jffs2_raw_inode);
44 if (jffs2_is_writebuffered(c)) {
45 int adj = ofs % c->wbuf_pagesize;
47 adj = c->wbuf_pagesize - adj;
49 if (adj >= tn->csize) {
50 dbg_readinode("no need to check node at %#08x, data length %u, data starts at %#08x - it has already been checked.\n",
51 ref_offset(ref), tn->csize, ofs);
59 dbg_readinode("check node at %#08x, data length %u, partial CRC %#08x, correct CRC %#08x, data starts at %#08x, start checking from %#08x - %u bytes.\n",
60 ref_offset(ref), tn->csize, tn->partial_crc, tn->data_crc, ofs - len, ofs, len);
63 /* TODO: instead, incapsulate point() stuff to jffs2_flash_read(),
64 * adding and jffs2_flash_read_end() interface. */
66 err = c->mtd->point(c->mtd, ofs, len, &retlen,
67 (void **)&buffer, NULL);
68 if (!err && retlen < len) {
69 JFFS2_WARNING("MTD point returned len too short: %zu instead of %u.\n", retlen, tn->csize);
70 c->mtd->unpoint(c->mtd, ofs, retlen);
72 JFFS2_WARNING("MTD point failed: error code %d.\n", err);
74 pointed = 1; /* succefully pointed to device */
79 buffer = kmalloc(len, GFP_KERNEL);
80 if (unlikely(!buffer))
83 /* TODO: this is very frequent pattern, make it a separate
85 err = jffs2_flash_read(c, ofs, len, &retlen, buffer);
87 JFFS2_ERROR("can not read %d bytes from 0x%08x, error code: %d.\n", len, ofs, err);
92 JFFS2_ERROR("short read at %#08x: %zd instead of %d.\n", ofs, retlen, len);
98 /* Continue calculating CRC */
99 crc = crc32(tn->partial_crc, buffer, len);
104 c->mtd->unpoint(c->mtd, ofs, len);
107 if (crc != tn->data_crc) {
108 JFFS2_NOTICE("wrong data CRC in data node at 0x%08x: read %#08x, calculated %#08x.\n",
109 ref_offset(ref), tn->data_crc, crc);
114 jeb = &c->blocks[ref->flash_offset / c->sector_size];
115 len = ref_totlen(c, jeb, ref);
116 /* If it should be REF_NORMAL, it'll get marked as such when
117 we build the fragtree, shortly. No need to worry about GC
118 moving it while it's marked REF_PRISTINE -- GC won't happen
119 till we've finished checking every inode anyway. */
120 ref->flash_offset |= REF_PRISTINE;
122 * Mark the node as having been checked and fix the
123 * accounting accordingly.
125 spin_lock(&c->erase_completion_lock);
126 jeb->used_size += len;
127 jeb->unchecked_size -= len;
129 c->unchecked_size -= len;
130 jffs2_dbg_acct_paranoia_check_nolock(c, jeb);
131 spin_unlock(&c->erase_completion_lock);
140 c->mtd->unpoint(c->mtd, ofs, len);
146 * Helper function for jffs2_add_older_frag_to_fragtree().
148 * Checks the node if we are in the checking stage.
150 static int check_tn_node(struct jffs2_sb_info *c, struct jffs2_tmp_dnode_info *tn)
154 BUG_ON(ref_obsolete(tn->fn->raw));
156 /* We only check the data CRC of unchecked nodes */
157 if (ref_flags(tn->fn->raw) != REF_UNCHECKED)
160 dbg_readinode("check node %#04x-%#04x, phys offs %#08x\n",
161 tn->fn->ofs, tn->fn->ofs + tn->fn->size, ref_offset(tn->fn->raw));
163 ret = check_node_data(c, tn);
164 if (unlikely(ret < 0)) {
165 JFFS2_ERROR("check_node_data() returned error: %d.\n",
167 } else if (unlikely(ret > 0)) {
168 dbg_readinode("CRC error, mark it obsolete.\n");
169 jffs2_mark_node_obsolete(c, tn->fn->raw);
175 static struct jffs2_tmp_dnode_info *jffs2_lookup_tn(struct rb_root *tn_root, uint32_t offset)
177 struct rb_node *next;
178 struct jffs2_tmp_dnode_info *tn = NULL;
180 dbg_readinode("root %p, offset %d\n", tn_root, offset);
182 next = tn_root->rb_node;
185 tn = rb_entry(next, struct jffs2_tmp_dnode_info, rb);
187 if (tn->fn->ofs < offset)
188 next = tn->rb.rb_right;
189 else if (tn->fn->ofs >= offset)
190 next = tn->rb.rb_left;
199 static void jffs2_kill_tn(struct jffs2_sb_info *c, struct jffs2_tmp_dnode_info *tn)
201 jffs2_mark_node_obsolete(c, tn->fn->raw);
202 jffs2_free_full_dnode(tn->fn);
203 jffs2_free_tmp_dnode_info(tn);
206 * This function is used when we read an inode. Data nodes arrive in
207 * arbitrary order -- they may be older or newer than the nodes which
208 * are already in the tree. Where overlaps occur, the older node can
209 * be discarded as long as the newer passes the CRC check. We don't
210 * bother to keep track of holes in this rbtree, and neither do we deal
211 * with frags -- we can have multiple entries starting at the same
212 * offset, and the one with the smallest length will come first in the
215 * Returns 0 if the node was handled (including marking it obsolete)
216 * < 0 an if error occurred
218 static int jffs2_add_tn_to_tree(struct jffs2_sb_info *c,
219 struct jffs2_readinode_info *rii,
220 struct jffs2_tmp_dnode_info *tn)
222 uint32_t fn_end = tn->fn->ofs + tn->fn->size;
223 struct jffs2_tmp_dnode_info *this, *ptn;
225 dbg_readinode("insert fragment %#04x-%#04x, ver %u at %08x\n", tn->fn->ofs, fn_end, tn->version, ref_offset(tn->fn->raw));
227 /* If a node has zero dsize, we only have to keep if it if it might be the
228 node with highest version -- i.e. the one which will end up as f->metadata.
229 Note that such nodes won't be REF_UNCHECKED since there are no data to
233 if (rii->mdata_tn->version < tn->version) {
234 /* We had a candidate mdata node already */
235 dbg_readinode("kill old mdata with ver %d\n", rii->mdata_tn->version);
236 jffs2_kill_tn(c, rii->mdata_tn);
238 dbg_readinode("kill new mdata with ver %d (older than existing %d\n",
239 tn->version, rii->mdata_tn->version);
240 jffs2_kill_tn(c, tn);
245 dbg_readinode("keep new mdata with ver %d\n", tn->version);
249 /* Find the earliest node which _may_ be relevant to this one */
250 this = jffs2_lookup_tn(&rii->tn_root, tn->fn->ofs);
252 /* If the node is coincident with another at a lower address,
253 back up until the other node is found. It may be relevant */
254 while (this->overlapped) {
258 * We killed a node which set the overlapped
259 * flags during the scan. Fix it up.
261 this->overlapped = 0;
266 dbg_readinode("'this' found %#04x-%#04x (%s)\n", this->fn->ofs, this->fn->ofs + this->fn->size, this->fn ? "data" : "hole");
270 if (this->fn->ofs > fn_end)
272 dbg_readinode("Ponder this ver %d, 0x%x-0x%x\n",
273 this->version, this->fn->ofs, this->fn->size);
275 if (this->version == tn->version) {
276 /* Version number collision means REF_PRISTINE GC. Accept either of them
277 as long as the CRC is correct. Check the one we have already... */
278 if (!check_tn_node(c, this)) {
279 /* The one we already had was OK. Keep it and throw away the new one */
280 dbg_readinode("Like old node. Throw away new\n");
281 jffs2_kill_tn(c, tn);
284 /* Who cares if the new one is good; keep it for now anyway. */
285 dbg_readinode("Like new node. Throw away old\n");
286 rb_replace_node(&this->rb, &tn->rb, &rii->tn_root);
287 jffs2_kill_tn(c, this);
288 /* Same overlapping from in front and behind */
292 if (this->version < tn->version &&
293 this->fn->ofs >= tn->fn->ofs &&
294 this->fn->ofs + this->fn->size <= fn_end) {
295 /* New node entirely overlaps 'this' */
296 if (check_tn_node(c, tn)) {
297 dbg_readinode("new node bad CRC\n");
298 jffs2_kill_tn(c, tn);
301 /* ... and is good. Kill 'this' and any subsequent nodes which are also overlapped */
302 while (this && this->fn->ofs + this->fn->size <= fn_end) {
303 struct jffs2_tmp_dnode_info *next = tn_next(this);
304 if (this->version < tn->version) {
305 tn_erase(this, &rii->tn_root);
306 dbg_readinode("Kill overlapped ver %d, 0x%x-0x%x\n",
307 this->version, this->fn->ofs,
308 this->fn->ofs+this->fn->size);
309 jffs2_kill_tn(c, this);
313 dbg_readinode("Done killing overlapped nodes\n");
316 if (this->version > tn->version &&
317 this->fn->ofs <= tn->fn->ofs &&
318 this->fn->ofs+this->fn->size >= fn_end) {
319 /* New node entirely overlapped by 'this' */
320 if (!check_tn_node(c, this)) {
321 dbg_readinode("Good CRC on old node. Kill new\n");
322 jffs2_kill_tn(c, tn);
325 /* ... but 'this' was bad. Replace it... */
326 dbg_readinode("Bad CRC on old overlapping node. Kill it\n");
327 tn_erase(this, &rii->tn_root);
328 jffs2_kill_tn(c, this);
332 this = tn_next(this);
335 /* We neither completely obsoleted nor were completely
336 obsoleted by an earlier node. Insert into the tree */
338 struct rb_node *parent;
339 struct rb_node **link = &rii->tn_root.rb_node;
340 struct jffs2_tmp_dnode_info *insert_point = NULL;
344 insert_point = rb_entry(parent, struct jffs2_tmp_dnode_info, rb);
345 if (tn->fn->ofs > insert_point->fn->ofs)
346 link = &insert_point->rb.rb_right;
347 else if (tn->fn->ofs < insert_point->fn->ofs ||
348 tn->fn->size < insert_point->fn->size)
349 link = &insert_point->rb.rb_left;
351 link = &insert_point->rb.rb_right;
353 rb_link_node(&tn->rb, &insert_point->rb, link);
354 rb_insert_color(&tn->rb, &rii->tn_root);
357 /* If there's anything behind that overlaps us, note it */
361 if (this->fn->ofs + this->fn->size > tn->fn->ofs) {
362 dbg_readinode("Node is overlapped by %p (v %d, 0x%x-0x%x)\n",
363 this, this->version, this->fn->ofs,
364 this->fn->ofs+this->fn->size);
368 if (!this->overlapped)
374 * We killed a node which set the overlapped
375 * flags during the scan. Fix it up.
377 this->overlapped = 0;
384 /* If the new node overlaps anything ahead, note it */
386 while (this && this->fn->ofs < fn_end) {
387 this->overlapped = 1;
388 dbg_readinode("Node ver %d, 0x%x-0x%x is overlapped\n",
389 this->version, this->fn->ofs,
390 this->fn->ofs+this->fn->size);
391 this = tn_next(this);
396 /* Trivial function to remove the last node in the tree. Which by definition
397 has no right-hand -- so can be removed just by making its only child (if
398 any) take its place under its parent. */
399 static void eat_last(struct rb_root *root, struct rb_node *node)
401 struct rb_node *parent = rb_parent(node);
402 struct rb_node **link;
405 BUG_ON(node->rb_right);
408 link = &root->rb_node;
409 else if (node == parent->rb_left)
410 link = &parent->rb_left;
412 link = &parent->rb_right;
414 *link = node->rb_left;
415 /* Colour doesn't matter now. Only the parent pointer. */
417 node->rb_left->rb_parent_color = node->rb_parent_color;
420 /* We put this in reverse order, so we can just use eat_last */
421 static void ver_insert(struct rb_root *ver_root, struct jffs2_tmp_dnode_info *tn)
423 struct rb_node **link = &ver_root->rb_node;
424 struct rb_node *parent = NULL;
425 struct jffs2_tmp_dnode_info *this_tn;
429 this_tn = rb_entry(parent, struct jffs2_tmp_dnode_info, rb);
431 if (tn->version > this_tn->version)
432 link = &parent->rb_left;
434 link = &parent->rb_right;
436 dbg_readinode("Link new node at %p (root is %p)\n", link, ver_root);
437 rb_link_node(&tn->rb, parent, link);
438 rb_insert_color(&tn->rb, ver_root);
441 /* Build final, normal fragtree from tn tree. It doesn't matter which order
442 we add nodes to the real fragtree, as long as they don't overlap. And
443 having thrown away the majority of overlapped nodes as we went, there
444 really shouldn't be many sets of nodes which do overlap. If we start at
445 the end, we can use the overlap markers -- we can just eat nodes which
446 aren't overlapped, and when we encounter nodes which _do_ overlap we
447 sort them all into a temporary tree in version order before replaying them. */
448 static int jffs2_build_inode_fragtree(struct jffs2_sb_info *c,
449 struct jffs2_inode_info *f,
450 struct jffs2_readinode_info *rii)
452 struct jffs2_tmp_dnode_info *pen, *last, *this;
453 struct rb_root ver_root = RB_ROOT;
454 uint32_t high_ver = 0;
457 dbg_readinode("potential mdata is ver %d at %p\n", rii->mdata_tn->version, rii->mdata_tn);
458 high_ver = rii->mdata_tn->version;
459 rii->latest_ref = rii->mdata_tn->fn->raw;
461 #ifdef JFFS2_DBG_READINODE_MESSAGES
462 this = tn_last(&rii->tn_root);
464 dbg_readinode("tn %p ver %d range 0x%x-0x%x ov %d\n", this, this->version, this->fn->ofs,
465 this->fn->ofs+this->fn->size, this->overlapped);
466 this = tn_prev(this);
469 pen = tn_last(&rii->tn_root);
470 while ((last = pen)) {
473 eat_last(&rii->tn_root, &last->rb);
474 ver_insert(&ver_root, last);
476 if (unlikely(last->overlapped)) {
480 * We killed a node which set the overlapped
481 * flags during the scan. Fix it up.
483 last->overlapped = 0;
486 /* Now we have a bunch of nodes in reverse version
487 order, in the tree at ver_root. Most of the time,
488 there'll actually be only one node in the 'tree',
490 this = tn_last(&ver_root);
493 struct jffs2_tmp_dnode_info *vers_next;
495 vers_next = tn_prev(this);
496 eat_last(&ver_root, &this->rb);
497 if (check_tn_node(c, this)) {
498 dbg_readinode("node ver %d, 0x%x-0x%x failed CRC\n",
499 this->version, this->fn->ofs,
500 this->fn->ofs+this->fn->size);
501 jffs2_kill_tn(c, this);
503 if (this->version > high_ver) {
504 /* Note that this is different from the other
505 highest_version, because this one is only
506 counting _valid_ nodes which could give the
507 latest inode metadata */
508 high_ver = this->version;
509 rii->latest_ref = this->fn->raw;
511 dbg_readinode("Add %p (v %d, 0x%x-0x%x, ov %d) to fragtree\n",
512 this, this->version, this->fn->ofs,
513 this->fn->ofs+this->fn->size, this->overlapped);
515 ret = jffs2_add_full_dnode_to_inode(c, f, this->fn);
517 /* Free the nodes in vers_root; let the caller
518 deal with the rest */
519 JFFS2_ERROR("Add node to tree failed %d\n", ret);
521 vers_next = tn_prev(this);
522 if (check_tn_node(c, this))
523 jffs2_mark_node_obsolete(c, this->fn->raw);
524 jffs2_free_full_dnode(this->fn);
525 jffs2_free_tmp_dnode_info(this);
529 eat_last(&ver_root, &vers_next->rb);
533 jffs2_free_tmp_dnode_info(this);
541 static void jffs2_free_tmp_dnode_info_list(struct rb_root *list)
543 struct rb_node *this;
544 struct jffs2_tmp_dnode_info *tn;
546 this = list->rb_node;
548 /* Now at bottom of tree */
551 this = this->rb_left;
552 else if (this->rb_right)
553 this = this->rb_right;
555 tn = rb_entry(this, struct jffs2_tmp_dnode_info, rb);
556 jffs2_free_full_dnode(tn->fn);
557 jffs2_free_tmp_dnode_info(tn);
559 this = rb_parent(this);
563 if (this->rb_left == &tn->rb)
564 this->rb_left = NULL;
565 else if (this->rb_right == &tn->rb)
566 this->rb_right = NULL;
570 list->rb_node = NULL;
573 static void jffs2_free_full_dirent_list(struct jffs2_full_dirent *fd)
575 struct jffs2_full_dirent *next;
579 jffs2_free_full_dirent(fd);
584 /* Returns first valid node after 'ref'. May return 'ref' */
585 static struct jffs2_raw_node_ref *jffs2_first_valid_node(struct jffs2_raw_node_ref *ref)
587 while (ref && ref->next_in_ino) {
588 if (!ref_obsolete(ref))
590 dbg_noderef("node at 0x%08x is obsoleted. Ignoring.\n", ref_offset(ref));
591 ref = ref->next_in_ino;
597 * Helper function for jffs2_get_inode_nodes().
598 * It is called every time an directory entry node is found.
600 * Returns: 0 on success;
601 * negative error code on failure.
603 static inline int read_direntry(struct jffs2_sb_info *c, struct jffs2_raw_node_ref *ref,
604 struct jffs2_raw_dirent *rd, size_t read,
605 struct jffs2_readinode_info *rii)
607 struct jffs2_full_dirent *fd;
610 /* Obsoleted. This cannot happen, surely? dwmw2 20020308 */
611 BUG_ON(ref_obsolete(ref));
613 crc = crc32(0, rd, sizeof(*rd) - 8);
614 if (unlikely(crc != je32_to_cpu(rd->node_crc))) {
615 JFFS2_NOTICE("header CRC failed on dirent node at %#08x: read %#08x, calculated %#08x\n",
616 ref_offset(ref), je32_to_cpu(rd->node_crc), crc);
617 jffs2_mark_node_obsolete(c, ref);
621 /* If we've never checked the CRCs on this node, check them now */
622 if (ref_flags(ref) == REF_UNCHECKED) {
623 struct jffs2_eraseblock *jeb;
627 if (unlikely(PAD((rd->nsize + sizeof(*rd))) != PAD(je32_to_cpu(rd->totlen)))) {
628 JFFS2_ERROR("illegal nsize in node at %#08x: nsize %#02x, totlen %#04x\n",
629 ref_offset(ref), rd->nsize, je32_to_cpu(rd->totlen));
630 jffs2_mark_node_obsolete(c, ref);
634 jeb = &c->blocks[ref->flash_offset / c->sector_size];
635 len = ref_totlen(c, jeb, ref);
637 spin_lock(&c->erase_completion_lock);
638 jeb->used_size += len;
639 jeb->unchecked_size -= len;
641 c->unchecked_size -= len;
642 ref->flash_offset = ref_offset(ref) | dirent_node_state(rd);
643 spin_unlock(&c->erase_completion_lock);
646 fd = jffs2_alloc_full_dirent(rd->nsize + 1);
651 fd->version = je32_to_cpu(rd->version);
652 fd->ino = je32_to_cpu(rd->ino);
655 if (fd->version > rii->highest_version)
656 rii->highest_version = fd->version;
658 /* Pick out the mctime of the latest dirent */
659 if(fd->version > rii->mctime_ver && je32_to_cpu(rd->mctime)) {
660 rii->mctime_ver = fd->version;
661 rii->latest_mctime = je32_to_cpu(rd->mctime);
665 * Copy as much of the name as possible from the raw
666 * dirent we've already read from the flash.
668 if (read > sizeof(*rd))
669 memcpy(&fd->name[0], &rd->name[0],
670 min_t(uint32_t, rd->nsize, (read - sizeof(*rd)) ));
672 /* Do we need to copy any more of the name directly from the flash? */
673 if (rd->nsize + sizeof(*rd) > read) {
676 int already = read - sizeof(*rd);
678 err = jffs2_flash_read(c, (ref_offset(ref)) + read,
679 rd->nsize - already, &read, &fd->name[already]);
680 if (unlikely(read != rd->nsize - already) && likely(!err))
684 JFFS2_ERROR("read remainder of name: error %d\n", err);
685 jffs2_free_full_dirent(fd);
690 fd->nhash = full_name_hash(fd->name, rd->nsize);
692 fd->name[rd->nsize] = '\0';
695 * Wheee. We now have a complete jffs2_full_dirent structure, with
696 * the name in it and everything. Link it into the list
698 jffs2_add_fd_to_list(c, fd, &rii->fds);
704 * Helper function for jffs2_get_inode_nodes().
705 * It is called every time an inode node is found.
707 * Returns: 0 on success (possibly after marking a bad node obsolete);
708 * negative error code on failure.
710 static inline int read_dnode(struct jffs2_sb_info *c, struct jffs2_raw_node_ref *ref,
711 struct jffs2_raw_inode *rd, int rdlen,
712 struct jffs2_readinode_info *rii)
714 struct jffs2_tmp_dnode_info *tn;
719 /* Obsoleted. This cannot happen, surely? dwmw2 20020308 */
720 BUG_ON(ref_obsolete(ref));
722 crc = crc32(0, rd, sizeof(*rd) - 8);
723 if (unlikely(crc != je32_to_cpu(rd->node_crc))) {
724 JFFS2_NOTICE("node CRC failed on dnode at %#08x: read %#08x, calculated %#08x\n",
725 ref_offset(ref), je32_to_cpu(rd->node_crc), crc);
726 jffs2_mark_node_obsolete(c, ref);
730 tn = jffs2_alloc_tmp_dnode_info();
732 JFFS2_ERROR("failed to allocate tn (%zu bytes).\n", sizeof(*tn));
737 csize = je32_to_cpu(rd->csize);
739 /* If we've never checked the CRCs on this node, check them now */
740 if (ref_flags(ref) == REF_UNCHECKED) {
743 if (unlikely(je32_to_cpu(rd->offset) > je32_to_cpu(rd->isize)) ||
744 unlikely(PAD(je32_to_cpu(rd->csize) + sizeof(*rd)) != PAD(je32_to_cpu(rd->totlen)))) {
745 JFFS2_WARNING("inode node header CRC is corrupted at %#08x\n", ref_offset(ref));
746 jffs2_dbg_dump_node(c, ref_offset(ref));
747 jffs2_mark_node_obsolete(c, ref);
751 if (jffs2_is_writebuffered(c) && csize != 0) {
752 /* At this point we are supposed to check the data CRC
753 * of our unchecked node. But thus far, we do not
754 * know whether the node is valid or obsolete. To
755 * figure this out, we need to walk all the nodes of
756 * the inode and build the inode fragtree. We don't
757 * want to spend time checking data of nodes which may
758 * later be found to be obsolete. So we put off the full
759 * data CRC checking until we have read all the inode
760 * nodes and have started building the fragtree.
762 * The fragtree is being built starting with nodes
763 * having the highest version number, so we'll be able
764 * to detect whether a node is valid (i.e., it is not
765 * overlapped by a node with higher version) or not.
766 * And we'll be able to check only those nodes, which
769 * Of course, this optimization only makes sense in case
770 * of NAND flashes (or other flashes with
771 * !jffs2_can_mark_obsolete()), since on NOR flashes
772 * nodes are marked obsolete physically.
774 * Since NAND flashes (or other flashes with
775 * jffs2_is_writebuffered(c)) are anyway read by
776 * fractions of c->wbuf_pagesize, and we have just read
777 * the node header, it is likely that the starting part
778 * of the node data is also read when we read the
779 * header. So we don't mind to check the CRC of the
780 * starting part of the data of the node now, and check
781 * the second part later (in jffs2_check_node_data()).
782 * Of course, we will not need to re-read and re-check
783 * the NAND page which we have just read. This is why we
784 * read the whole NAND page at jffs2_get_inode_nodes(),
785 * while we needed only the node header.
789 /* 'buf' will point to the start of data */
790 buf = (unsigned char *)rd + sizeof(*rd);
791 /* len will be the read data length */
792 len = min_t(uint32_t, rdlen - sizeof(*rd), csize);
793 tn->partial_crc = crc32(0, buf, len);
795 dbg_readinode("Calculates CRC (%#08x) for %d bytes, csize %d\n", tn->partial_crc, len, csize);
797 /* If we actually calculated the whole data CRC
798 * and it is wrong, drop the node. */
799 if (len >= csize && unlikely(tn->partial_crc != je32_to_cpu(rd->data_crc))) {
800 JFFS2_NOTICE("wrong data CRC in data node at 0x%08x: read %#08x, calculated %#08x.\n",
801 ref_offset(ref), tn->partial_crc, je32_to_cpu(rd->data_crc));
802 jffs2_mark_node_obsolete(c, ref);
806 } else if (csize == 0) {
808 * We checked the header CRC. If the node has no data, adjust
809 * the space accounting now. For other nodes this will be done
810 * later either when the node is marked obsolete or when its
813 struct jffs2_eraseblock *jeb;
815 dbg_readinode("the node has no data.\n");
816 jeb = &c->blocks[ref->flash_offset / c->sector_size];
817 len = ref_totlen(c, jeb, ref);
819 spin_lock(&c->erase_completion_lock);
820 jeb->used_size += len;
821 jeb->unchecked_size -= len;
823 c->unchecked_size -= len;
824 ref->flash_offset = ref_offset(ref) | REF_NORMAL;
825 spin_unlock(&c->erase_completion_lock);
829 tn->fn = jffs2_alloc_full_dnode();
831 JFFS2_ERROR("alloc fn failed\n");
836 tn->version = je32_to_cpu(rd->version);
837 tn->fn->ofs = je32_to_cpu(rd->offset);
838 tn->data_crc = je32_to_cpu(rd->data_crc);
843 if (tn->version > rii->highest_version)
844 rii->highest_version = tn->version;
846 /* There was a bug where we wrote hole nodes out with
847 csize/dsize swapped. Deal with it */
848 if (rd->compr == JFFS2_COMPR_ZERO && !je32_to_cpu(rd->dsize) && csize)
849 tn->fn->size = csize;
850 else // normal case...
851 tn->fn->size = je32_to_cpu(rd->dsize);
853 dbg_readinode2("dnode @%08x: ver %u, offset %#04x, dsize %#04x, csize %#04x\n",
854 ref_offset(ref), je32_to_cpu(rd->version),
855 je32_to_cpu(rd->offset), je32_to_cpu(rd->dsize), csize);
857 ret = jffs2_add_tn_to_tree(c, rii, tn);
860 jffs2_free_full_dnode(tn->fn);
862 jffs2_free_tmp_dnode_info(tn);
865 #ifdef JFFS2_DBG_READINODE2_MESSAGES
866 dbg_readinode2("After adding ver %d:\n", je32_to_cpu(rd->version));
867 tn = tn_first(&rii->tn_root);
869 dbg_readinode2("%p: v %d r 0x%x-0x%x ov %d\n",
870 tn, tn->version, tn->fn->ofs,
871 tn->fn->ofs+tn->fn->size, tn->overlapped);
879 * Helper function for jffs2_get_inode_nodes().
880 * It is called every time an unknown node is found.
882 * Returns: 0 on success;
883 * negative error code on failure.
885 static inline int read_unknown(struct jffs2_sb_info *c, struct jffs2_raw_node_ref *ref, struct jffs2_unknown_node *un)
887 /* We don't mark unknown nodes as REF_UNCHECKED */
888 if (ref_flags(ref) == REF_UNCHECKED) {
889 JFFS2_ERROR("REF_UNCHECKED but unknown node at %#08x\n",
891 JFFS2_ERROR("Node is {%04x,%04x,%08x,%08x}. Please report this error.\n",
892 je16_to_cpu(un->magic), je16_to_cpu(un->nodetype),
893 je32_to_cpu(un->totlen), je32_to_cpu(un->hdr_crc));
894 jffs2_mark_node_obsolete(c, ref);
898 un->nodetype = cpu_to_je16(JFFS2_NODE_ACCURATE | je16_to_cpu(un->nodetype));
900 switch(je16_to_cpu(un->nodetype) & JFFS2_COMPAT_MASK) {
902 case JFFS2_FEATURE_INCOMPAT:
903 JFFS2_ERROR("unknown INCOMPAT nodetype %#04X at %#08x\n",
904 je16_to_cpu(un->nodetype), ref_offset(ref));
909 case JFFS2_FEATURE_ROCOMPAT:
910 JFFS2_ERROR("unknown ROCOMPAT nodetype %#04X at %#08x\n",
911 je16_to_cpu(un->nodetype), ref_offset(ref));
912 BUG_ON(!(c->flags & JFFS2_SB_FLAG_RO));
915 case JFFS2_FEATURE_RWCOMPAT_COPY:
916 JFFS2_NOTICE("unknown RWCOMPAT_COPY nodetype %#04X at %#08x\n",
917 je16_to_cpu(un->nodetype), ref_offset(ref));
920 case JFFS2_FEATURE_RWCOMPAT_DELETE:
921 JFFS2_NOTICE("unknown RWCOMPAT_DELETE nodetype %#04X at %#08x\n",
922 je16_to_cpu(un->nodetype), ref_offset(ref));
923 jffs2_mark_node_obsolete(c, ref);
931 * Helper function for jffs2_get_inode_nodes().
932 * The function detects whether more data should be read and reads it if yes.
934 * Returns: 0 on succes;
935 * negative error code on failure.
937 static int read_more(struct jffs2_sb_info *c, struct jffs2_raw_node_ref *ref,
938 int needed_len, int *rdlen, unsigned char *buf)
940 int err, to_read = needed_len - *rdlen;
944 if (jffs2_is_writebuffered(c)) {
945 int rem = to_read % c->wbuf_pagesize;
948 to_read += c->wbuf_pagesize - rem;
951 /* We need to read more data */
952 offs = ref_offset(ref) + *rdlen;
954 dbg_readinode("read more %d bytes\n", to_read);
956 err = jffs2_flash_read(c, offs, to_read, &retlen, buf + *rdlen);
958 JFFS2_ERROR("can not read %d bytes from 0x%08x, "
959 "error code: %d.\n", to_read, offs, err);
963 if (retlen < to_read) {
964 JFFS2_ERROR("short read at %#08x: %zu instead of %d.\n",
965 offs, retlen, to_read);
973 /* Get tmp_dnode_info and full_dirent for all non-obsolete nodes associated
974 with this ino. Perform a preliminary ordering on data nodes, throwing away
975 those which are completely obsoleted by newer ones. The naïve approach we
976 use to take of just returning them _all_ in version order will cause us to
977 run out of memory in certain degenerate cases. */
978 static int jffs2_get_inode_nodes(struct jffs2_sb_info *c, struct jffs2_inode_info *f,
979 struct jffs2_readinode_info *rii)
981 struct jffs2_raw_node_ref *ref, *valid_ref;
982 unsigned char *buf = NULL;
983 union jffs2_node_union *node;
989 dbg_readinode("ino #%u\n", f->inocache->ino);
991 /* FIXME: in case of NOR and available ->point() this
992 * needs to be fixed. */
993 len = sizeof(union jffs2_node_union) + c->wbuf_pagesize;
994 buf = kmalloc(len, GFP_KERNEL);
998 spin_lock(&c->erase_completion_lock);
999 valid_ref = jffs2_first_valid_node(f->inocache->nodes);
1000 if (!valid_ref && f->inocache->ino != 1)
1001 JFFS2_WARNING("Eep. No valid nodes for ino #%u.\n", f->inocache->ino);
1003 /* We can hold a pointer to a non-obsolete node without the spinlock,
1004 but _obsolete_ nodes may disappear at any time, if the block
1005 they're in gets erased. So if we mark 'ref' obsolete while we're
1006 not holding the lock, it can go away immediately. For that reason,
1007 we find the next valid node first, before processing 'ref'.
1010 valid_ref = jffs2_first_valid_node(ref->next_in_ino);
1011 spin_unlock(&c->erase_completion_lock);
1016 * At this point we don't know the type of the node we're going
1017 * to read, so we do not know the size of its header. In order
1018 * to minimize the amount of flash IO we assume the header is
1019 * of size = JFFS2_MIN_NODE_HEADER.
1021 len = JFFS2_MIN_NODE_HEADER;
1022 if (jffs2_is_writebuffered(c)) {
1026 * We are about to read JFFS2_MIN_NODE_HEADER bytes,
1027 * but this flash has some minimal I/O unit. It is
1028 * possible that we'll need to read more soon, so read
1029 * up to the next min. I/O unit, in order not to
1030 * re-read the same min. I/O unit twice.
1032 end = ref_offset(ref) + len;
1033 rem = end % c->wbuf_pagesize;
1035 end += c->wbuf_pagesize - rem;
1036 len = end - ref_offset(ref);
1039 dbg_readinode("read %d bytes at %#08x(%d).\n", len, ref_offset(ref), ref_flags(ref));
1041 /* FIXME: point() */
1042 err = jffs2_flash_read(c, ref_offset(ref), len, &retlen, buf);
1044 JFFS2_ERROR("can not read %d bytes from 0x%08x, " "error code: %d.\n", len, ref_offset(ref), err);
1049 JFFS2_ERROR("short read at %#08x: %zu instead of %d.\n", ref_offset(ref), retlen, len);
1054 node = (union jffs2_node_union *)buf;
1056 /* No need to mask in the valid bit; it shouldn't be invalid */
1057 if (je32_to_cpu(node->u.hdr_crc) != crc32(0, node, sizeof(node->u)-4)) {
1058 JFFS2_NOTICE("Node header CRC failed at %#08x. {%04x,%04x,%08x,%08x}\n",
1059 ref_offset(ref), je16_to_cpu(node->u.magic),
1060 je16_to_cpu(node->u.nodetype),
1061 je32_to_cpu(node->u.totlen),
1062 je32_to_cpu(node->u.hdr_crc));
1063 jffs2_dbg_dump_node(c, ref_offset(ref));
1064 jffs2_mark_node_obsolete(c, ref);
1067 if (je16_to_cpu(node->u.magic) != JFFS2_MAGIC_BITMASK) {
1068 /* Not a JFFS2 node, whinge and move on */
1069 JFFS2_NOTICE("Wrong magic bitmask 0x%04x in node header at %#08x.\n",
1070 je16_to_cpu(node->u.magic), ref_offset(ref));
1071 jffs2_mark_node_obsolete(c, ref);
1075 switch (je16_to_cpu(node->u.nodetype)) {
1077 case JFFS2_NODETYPE_DIRENT:
1079 if (JFFS2_MIN_NODE_HEADER < sizeof(struct jffs2_raw_dirent) &&
1080 len < sizeof(struct jffs2_raw_dirent)) {
1081 err = read_more(c, ref, sizeof(struct jffs2_raw_dirent), &len, buf);
1086 err = read_direntry(c, ref, &node->d, retlen, rii);
1092 case JFFS2_NODETYPE_INODE:
1094 if (JFFS2_MIN_NODE_HEADER < sizeof(struct jffs2_raw_inode) &&
1095 len < sizeof(struct jffs2_raw_inode)) {
1096 err = read_more(c, ref, sizeof(struct jffs2_raw_inode), &len, buf);
1101 err = read_dnode(c, ref, &node->i, len, rii);
1108 if (JFFS2_MIN_NODE_HEADER < sizeof(struct jffs2_unknown_node) &&
1109 len < sizeof(struct jffs2_unknown_node)) {
1110 err = read_more(c, ref, sizeof(struct jffs2_unknown_node), &len, buf);
1115 err = read_unknown(c, ref, &node->u);
1121 spin_lock(&c->erase_completion_lock);
1124 spin_unlock(&c->erase_completion_lock);
1127 f->highest_version = rii->highest_version;
1129 dbg_readinode("nodes of inode #%u were read, the highest version is %u, latest_mctime %u, mctime_ver %u.\n",
1130 f->inocache->ino, rii->highest_version, rii->latest_mctime,
1135 jffs2_free_tmp_dnode_info_list(&rii->tn_root);
1136 jffs2_free_full_dirent_list(rii->fds);
1142 static int jffs2_do_read_inode_internal(struct jffs2_sb_info *c,
1143 struct jffs2_inode_info *f,
1144 struct jffs2_raw_inode *latest_node)
1146 struct jffs2_readinode_info rii;
1147 uint32_t crc, new_size;
1151 dbg_readinode("ino #%u pino/nlink is %d\n", f->inocache->ino,
1152 f->inocache->pino_nlink);
1154 memset(&rii, 0, sizeof(rii));
1156 /* Grab all nodes relevant to this ino */
1157 ret = jffs2_get_inode_nodes(c, f, &rii);
1160 JFFS2_ERROR("cannot read nodes for ino %u, returned error is %d\n", f->inocache->ino, ret);
1161 if (f->inocache->state == INO_STATE_READING)
1162 jffs2_set_inocache_state(c, f->inocache, INO_STATE_CHECKEDABSENT);
1166 ret = jffs2_build_inode_fragtree(c, f, &rii);
1168 JFFS2_ERROR("Failed to build final fragtree for inode #%u: error %d\n",
1169 f->inocache->ino, ret);
1170 if (f->inocache->state == INO_STATE_READING)
1171 jffs2_set_inocache_state(c, f->inocache, INO_STATE_CHECKEDABSENT);
1172 jffs2_free_tmp_dnode_info_list(&rii.tn_root);
1173 /* FIXME: We could at least crc-check them all */
1175 jffs2_free_full_dnode(rii.mdata_tn->fn);
1176 jffs2_free_tmp_dnode_info(rii.mdata_tn);
1177 rii.mdata_tn = NULL;
1183 if (rii.mdata_tn->fn->raw == rii.latest_ref) {
1184 f->metadata = rii.mdata_tn->fn;
1185 jffs2_free_tmp_dnode_info(rii.mdata_tn);
1187 jffs2_kill_tn(c, rii.mdata_tn);
1189 rii.mdata_tn = NULL;
1194 jffs2_dbg_fragtree_paranoia_check_nolock(f);
1196 if (unlikely(!rii.latest_ref)) {
1197 /* No data nodes for this inode. */
1198 if (f->inocache->ino != 1) {
1199 JFFS2_WARNING("no data nodes found for ino #%u\n", f->inocache->ino);
1201 if (f->inocache->state == INO_STATE_READING)
1202 jffs2_set_inocache_state(c, f->inocache, INO_STATE_CHECKEDABSENT);
1205 JFFS2_NOTICE("but it has children so we fake some modes for it\n");
1207 latest_node->mode = cpu_to_jemode(S_IFDIR|S_IRUGO|S_IWUSR|S_IXUGO);
1208 latest_node->version = cpu_to_je32(0);
1209 latest_node->atime = latest_node->ctime = latest_node->mtime = cpu_to_je32(0);
1210 latest_node->isize = cpu_to_je32(0);
1211 latest_node->gid = cpu_to_je16(0);
1212 latest_node->uid = cpu_to_je16(0);
1213 if (f->inocache->state == INO_STATE_READING)
1214 jffs2_set_inocache_state(c, f->inocache, INO_STATE_PRESENT);
1218 ret = jffs2_flash_read(c, ref_offset(rii.latest_ref), sizeof(*latest_node), &retlen, (void *)latest_node);
1219 if (ret || retlen != sizeof(*latest_node)) {
1220 JFFS2_ERROR("failed to read from flash: error %d, %zd of %zd bytes read\n",
1221 ret, retlen, sizeof(*latest_node));
1222 /* FIXME: If this fails, there seems to be a memory leak. Find it. */
1223 mutex_unlock(&f->sem);
1224 jffs2_do_clear_inode(c, f);
1225 return ret?ret:-EIO;
1228 crc = crc32(0, latest_node, sizeof(*latest_node)-8);
1229 if (crc != je32_to_cpu(latest_node->node_crc)) {
1230 JFFS2_ERROR("CRC failed for read_inode of inode %u at physical location 0x%x\n",
1231 f->inocache->ino, ref_offset(rii.latest_ref));
1232 mutex_unlock(&f->sem);
1233 jffs2_do_clear_inode(c, f);
1237 switch(jemode_to_cpu(latest_node->mode) & S_IFMT) {
1239 if (rii.mctime_ver > je32_to_cpu(latest_node->version)) {
1240 /* The times in the latest_node are actually older than
1241 mctime in the latest dirent. Cheat. */
1242 latest_node->ctime = latest_node->mtime = cpu_to_je32(rii.latest_mctime);
1248 /* If it was a regular file, truncate it to the latest node's isize */
1249 new_size = jffs2_truncate_fragtree(c, &f->fragtree, je32_to_cpu(latest_node->isize));
1250 if (new_size != je32_to_cpu(latest_node->isize)) {
1251 JFFS2_WARNING("Truncating ino #%u to %d bytes failed because it only had %d bytes to start with!\n",
1252 f->inocache->ino, je32_to_cpu(latest_node->isize), new_size);
1253 latest_node->isize = cpu_to_je32(new_size);
1258 /* Hack to work around broken isize in old symlink code.
1259 Remove this when dwmw2 comes to his senses and stops
1260 symlinks from being an entirely gratuitous special
1262 if (!je32_to_cpu(latest_node->isize))
1263 latest_node->isize = latest_node->dsize;
1265 if (f->inocache->state != INO_STATE_CHECKING) {
1266 /* Symlink's inode data is the target path. Read it and
1267 * keep in RAM to facilitate quick follow symlink
1269 f->target = kmalloc(je32_to_cpu(latest_node->csize) + 1, GFP_KERNEL);
1271 JFFS2_ERROR("can't allocate %d bytes of memory for the symlink target path cache\n", je32_to_cpu(latest_node->csize));
1272 mutex_unlock(&f->sem);
1273 jffs2_do_clear_inode(c, f);
1277 ret = jffs2_flash_read(c, ref_offset(rii.latest_ref) + sizeof(*latest_node),
1278 je32_to_cpu(latest_node->csize), &retlen, (char *)f->target);
1280 if (ret || retlen != je32_to_cpu(latest_node->csize)) {
1281 if (retlen != je32_to_cpu(latest_node->csize))
1285 mutex_unlock(&f->sem);
1286 jffs2_do_clear_inode(c, f);
1290 f->target[je32_to_cpu(latest_node->csize)] = '\0';
1291 dbg_readinode("symlink's target '%s' cached\n", f->target);
1294 /* fall through... */
1298 /* Certain inode types should have only one data node, and it's
1299 kept as the metadata node */
1301 JFFS2_ERROR("Argh. Special inode #%u with mode 0%o had metadata node\n",
1302 f->inocache->ino, jemode_to_cpu(latest_node->mode));
1303 mutex_unlock(&f->sem);
1304 jffs2_do_clear_inode(c, f);
1307 if (!frag_first(&f->fragtree)) {
1308 JFFS2_ERROR("Argh. Special inode #%u with mode 0%o has no fragments\n",
1309 f->inocache->ino, jemode_to_cpu(latest_node->mode));
1310 mutex_unlock(&f->sem);
1311 jffs2_do_clear_inode(c, f);
1314 /* ASSERT: f->fraglist != NULL */
1315 if (frag_next(frag_first(&f->fragtree))) {
1316 JFFS2_ERROR("Argh. Special inode #%u with mode 0x%x had more than one node\n",
1317 f->inocache->ino, jemode_to_cpu(latest_node->mode));
1318 /* FIXME: Deal with it - check crc32, check for duplicate node, check times and discard the older one */
1319 mutex_unlock(&f->sem);
1320 jffs2_do_clear_inode(c, f);
1323 /* OK. We're happy */
1324 f->metadata = frag_first(&f->fragtree)->node;
1325 jffs2_free_node_frag(frag_first(&f->fragtree));
1326 f->fragtree = RB_ROOT;
1329 if (f->inocache->state == INO_STATE_READING)
1330 jffs2_set_inocache_state(c, f->inocache, INO_STATE_PRESENT);
1335 /* Scan the list of all nodes present for this ino, build map of versions, etc. */
1336 int jffs2_do_read_inode(struct jffs2_sb_info *c, struct jffs2_inode_info *f,
1337 uint32_t ino, struct jffs2_raw_inode *latest_node)
1339 dbg_readinode("read inode #%u\n", ino);
1342 spin_lock(&c->inocache_lock);
1343 f->inocache = jffs2_get_ino_cache(c, ino);
1346 /* Check its state. We may need to wait before we can use it */
1347 switch(f->inocache->state) {
1348 case INO_STATE_UNCHECKED:
1349 case INO_STATE_CHECKEDABSENT:
1350 f->inocache->state = INO_STATE_READING;
1353 case INO_STATE_CHECKING:
1355 /* If it's in either of these states, we need
1356 to wait for whoever's got it to finish and
1358 dbg_readinode("waiting for ino #%u in state %d\n", ino, f->inocache->state);
1359 sleep_on_spinunlock(&c->inocache_wq, &c->inocache_lock);
1360 goto retry_inocache;
1362 case INO_STATE_READING:
1363 case INO_STATE_PRESENT:
1364 /* Eep. This should never happen. It can
1365 happen if Linux calls read_inode() again
1366 before clear_inode() has finished though. */
1367 JFFS2_ERROR("Eep. Trying to read_inode #%u when it's already in state %d!\n", ino, f->inocache->state);
1368 /* Fail. That's probably better than allowing it to succeed */
1376 spin_unlock(&c->inocache_lock);
1378 if (!f->inocache && ino == 1) {
1379 /* Special case - no root inode on medium */
1380 f->inocache = jffs2_alloc_inode_cache();
1382 JFFS2_ERROR("cannot allocate inocache for root inode\n");
1385 dbg_readinode("creating inocache for root inode\n");
1386 memset(f->inocache, 0, sizeof(struct jffs2_inode_cache));
1387 f->inocache->ino = f->inocache->pino_nlink = 1;
1388 f->inocache->nodes = (struct jffs2_raw_node_ref *)f->inocache;
1389 f->inocache->state = INO_STATE_READING;
1390 jffs2_add_ino_cache(c, f->inocache);
1393 JFFS2_ERROR("requestied to read an nonexistent ino %u\n", ino);
1397 return jffs2_do_read_inode_internal(c, f, latest_node);
1400 int jffs2_do_crccheck_inode(struct jffs2_sb_info *c, struct jffs2_inode_cache *ic)
1402 struct jffs2_raw_inode n;
1403 struct jffs2_inode_info *f = kzalloc(sizeof(*f), GFP_KERNEL);
1409 mutex_init(&f->sem);
1410 mutex_lock(&f->sem);
1413 ret = jffs2_do_read_inode_internal(c, f, &n);
1415 mutex_unlock(&f->sem);
1416 jffs2_do_clear_inode(c, f);
1422 void jffs2_do_clear_inode(struct jffs2_sb_info *c, struct jffs2_inode_info *f)
1424 struct jffs2_full_dirent *fd, *fds;
1428 jffs2_xattr_delete_inode(c, f->inocache);
1429 mutex_lock(&f->sem);
1430 deleted = f->inocache && !f->inocache->pino_nlink;
1432 if (f->inocache && f->inocache->state != INO_STATE_CHECKING)
1433 jffs2_set_inocache_state(c, f->inocache, INO_STATE_CLEARING);
1437 jffs2_mark_node_obsolete(c, f->metadata->raw);
1438 jffs2_free_full_dnode(f->metadata);
1441 jffs2_kill_fragtree(&f->fragtree, deleted?c:NULL);
1452 jffs2_free_full_dirent(fd);
1455 if (f->inocache && f->inocache->state != INO_STATE_CHECKING) {
1456 jffs2_set_inocache_state(c, f->inocache, INO_STATE_CHECKEDABSENT);
1457 if (f->inocache->nodes == (void *)f->inocache)
1458 jffs2_del_ino_cache(c, f->inocache);
1461 mutex_unlock(&f->sem);