2 * JFFS2 -- Journalling Flash File System, Version 2.
4 * Copyright (C) 2004 Ferenc Havasi <havasi@inf.u-szeged.hu>,
5 * Zoltan Sogor <weth@inf.u-szeged.hu>,
6 * Patrik Kluba <pajko@halom.u-szeged.hu>,
7 * University of Szeged, Hungary
9 * For licensing information, see the file 'LICENCE' in this directory.
11 * $Id: summary.c,v 1.1 2005/09/07 08:34:54 havasi Exp $
15 #include <linux/kernel.h>
16 #include <linux/sched.h>
17 #include <linux/slab.h>
18 #include <linux/mtd/mtd.h>
19 #include <linux/pagemap.h>
20 #include <linux/crc32.h>
21 #include <linux/compiler.h>
22 #include <linux/vmalloc.h>
26 int jffs2_sum_init(struct jffs2_sb_info *c)
28 c->summary = kmalloc(sizeof(struct jffs2_summary), GFP_KERNEL);
31 JFFS2_WARNING("Can't allocate memory for summary information!\n");
35 memset(c->summary, 0, sizeof(struct jffs2_summary));
37 c->summary->sum_buf = vmalloc(c->sector_size);
39 if (!c->summary->sum_buf) {
40 JFFS2_WARNING("Can't allocate buffer for writing out summary information!\n");
44 JFFS2_DBG_SUMMARY("returned succesfully\n");
49 void jffs2_sum_exit(struct jffs2_sb_info *c)
51 JFFS2_DBG_SUMMARY("called\n");
53 jffs2_sum_disable_collecting(c->summary);
55 vfree(c->summary->sum_buf);
56 c->summary->sum_buf = NULL;
62 static int jffs2_sum_add_mem(struct jffs2_summary *s, union jffs2_sum_mem *item)
64 if (!s->sum_list_head)
65 s->sum_list_head = (union jffs2_sum_mem *) item;
67 s->sum_list_tail->u.next = (union jffs2_sum_mem *) item;
68 s->sum_list_tail = (union jffs2_sum_mem *) item;
70 switch (je16_to_cpu(item->u.nodetype)) {
71 case JFFS2_NODETYPE_INODE:
72 s->sum_size += JFFS2_SUMMARY_INODE_SIZE;
74 JFFS2_DBG_SUMMARY("inode (%u) added to summary\n",
75 je32_to_cpu(item->i.inode));
77 case JFFS2_NODETYPE_DIRENT:
78 s->sum_size += JFFS2_SUMMARY_DIRENT_SIZE(item->d.nsize);
80 JFFS2_DBG_SUMMARY("dirent (%u) added to summary\n",
81 je32_to_cpu(item->d.ino));
84 JFFS2_WARNING("UNKNOWN node type %u\n",
85 je16_to_cpu(item->u.nodetype));
92 /* The following 3 functions are called from scan.c to collect summary info for not closed jeb */
94 int jffs2_sum_add_padding_mem(struct jffs2_summary *s, uint32_t size)
96 JFFS2_DBG_SUMMARY("called with %u\n", size);
97 s->sum_padded += size;
101 int jffs2_sum_add_inode_mem(struct jffs2_summary *s, struct jffs2_raw_inode *ri,
104 struct jffs2_sum_inode_mem *temp = kmalloc(sizeof(struct jffs2_sum_inode_mem), GFP_KERNEL);
109 temp->nodetype = ri->nodetype;
110 temp->inode = ri->ino;
111 temp->version = ri->version;
112 temp->offset = cpu_to_je32(ofs); /* relative offset from the begining of the jeb */
113 temp->totlen = ri->totlen;
116 return jffs2_sum_add_mem(s, (union jffs2_sum_mem *)temp);
119 int jffs2_sum_add_dirent_mem(struct jffs2_summary *s, struct jffs2_raw_dirent *rd,
122 struct jffs2_sum_dirent_mem *temp =
123 kmalloc(sizeof(struct jffs2_sum_dirent_mem) + rd->nsize, GFP_KERNEL);
128 temp->nodetype = rd->nodetype;
129 temp->totlen = rd->totlen;
130 temp->offset = cpu_to_je32(ofs); /* relative from the begining of the jeb */
131 temp->pino = rd->pino;
132 temp->version = rd->version;
134 temp->nsize = rd->nsize;
135 temp->type = rd->type;
138 memcpy(temp->name, rd->name, rd->nsize);
140 return jffs2_sum_add_mem(s, (union jffs2_sum_mem *)temp);
143 /* Cleanup every collected summary information */
145 static void jffs2_sum_clean_collected(struct jffs2_summary *s)
147 union jffs2_sum_mem *temp;
149 if (!s->sum_list_head) {
150 JFFS2_DBG_SUMMARY("already empty\n");
152 while (s->sum_list_head) {
153 temp = s->sum_list_head;
154 s->sum_list_head = s->sum_list_head->u.next;
157 s->sum_list_tail = NULL;
162 void jffs2_sum_reset_collected(struct jffs2_summary *s)
164 JFFS2_DBG_SUMMARY("called\n");
165 jffs2_sum_clean_collected(s);
169 void jffs2_sum_disable_collecting(struct jffs2_summary *s)
171 JFFS2_DBG_SUMMARY("called\n");
172 jffs2_sum_clean_collected(s);
173 s->sum_size = JFFS2_SUMMARY_NOSUM_SIZE;
176 int jffs2_sum_is_disabled(struct jffs2_summary *s)
178 return (s->sum_size == JFFS2_SUMMARY_NOSUM_SIZE);
181 /* Move the collected summary information into sb (called from scan.c) */
183 void jffs2_sum_move_collected(struct jffs2_sb_info *c, struct jffs2_summary *s)
185 JFFS2_DBG_SUMMARY("oldsize=0x%x oldnum=%u => newsize=0x%x newnum=%u\n",
186 c->summary->sum_size, c->summary->sum_num,
187 s->sum_size, s->sum_num);
189 c->summary->sum_size = s->sum_size;
190 c->summary->sum_num = s->sum_num;
191 c->summary->sum_padded = s->sum_padded;
192 c->summary->sum_list_head = s->sum_list_head;
193 c->summary->sum_list_tail = s->sum_list_tail;
195 s->sum_list_head = s->sum_list_tail = NULL;
198 /* Called from wbuf.c to collect writed node info */
200 int jffs2_sum_add_kvec(struct jffs2_sb_info *c, const struct kvec *invecs,
201 unsigned long count, uint32_t ofs)
203 union jffs2_node_union *node;
204 struct jffs2_eraseblock *jeb;
206 node = invecs[0].iov_base;
207 jeb = &c->blocks[ofs / c->sector_size];
210 switch (je16_to_cpu(node->u.nodetype)) {
211 case JFFS2_NODETYPE_INODE: {
212 struct jffs2_sum_inode_mem *temp =
213 kmalloc(sizeof(struct jffs2_sum_inode_mem), GFP_KERNEL);
218 temp->nodetype = node->i.nodetype;
219 temp->inode = node->i.ino;
220 temp->version = node->i.version;
221 temp->offset = cpu_to_je32(ofs);
222 temp->totlen = node->i.totlen;
225 return jffs2_sum_add_mem(c->summary, (union jffs2_sum_mem *)temp);
228 case JFFS2_NODETYPE_DIRENT: {
229 struct jffs2_sum_dirent_mem *temp =
230 kmalloc(sizeof(struct jffs2_sum_dirent_mem) + node->d.nsize, GFP_KERNEL);
235 temp->nodetype = node->d.nodetype;
236 temp->totlen = node->d.totlen;
237 temp->offset = cpu_to_je32(ofs);
238 temp->pino = node->d.pino;
239 temp->version = node->d.version;
240 temp->ino = node->d.ino;
241 temp->nsize = node->d.nsize;
242 temp->type = node->d.type;
247 memcpy(temp->name,node->d.name,node->d.nsize);
251 memcpy(temp->name,invecs[1].iov_base,node->d.nsize);
255 BUG(); /* impossible count value */
259 return jffs2_sum_add_mem(c->summary, (union jffs2_sum_mem *)temp);
262 case JFFS2_NODETYPE_PADDING:
263 JFFS2_DBG_SUMMARY("node PADDING\n");
264 c->summary->sum_padded += je32_to_cpu(node->u.totlen);
267 case JFFS2_NODETYPE_CLEANMARKER:
268 JFFS2_DBG_SUMMARY("node CLEANMARKER\n");
271 case JFFS2_NODETYPE_SUMMARY:
272 JFFS2_DBG_SUMMARY("node SUMMARY\n");
276 /* If you implement a new node type you should also implement
277 summary support for it or disable summary.
286 JFFS2_WARNING("MEMORY ALLOCATION ERROR!");
291 /* Process the stored summary information - helper function for jffs2_sum_scan_sumnode() */
293 static int jffs2_sum_process_sum_data(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb,
294 struct jffs2_summary_node *summary, uint32_t *pseudo_random)
296 struct jffs2_raw_node_ref *raw;
297 struct jffs2_inode_cache *ic;
298 struct jffs2_full_dirent *fd;
304 for (i=0; i<je32_to_cpu(summary->sum_num); i++) {
305 JFFS2_DBG_SUMMARY("processing summary index %d\n", i);
307 switch (je16_to_cpu(((struct jffs2_sum_unknown_flash *)sp)->nodetype)) {
308 case JFFS2_NODETYPE_INODE: {
309 struct jffs2_sum_inode_flash *spi;
312 ino = je32_to_cpu(spi->inode);
314 JFFS2_DBG_SUMMARY("Inode at 0x%08x\n",
315 jeb->offset + je32_to_cpu(spi->offset));
317 raw = jffs2_alloc_raw_node_ref();
319 JFFS2_NOTICE("allocation of node reference failed\n");
324 ic = jffs2_scan_make_ino_cache(c, ino);
326 JFFS2_NOTICE("scan_make_ino_cache failed\n");
327 jffs2_free_raw_node_ref(raw);
332 raw->flash_offset = (jeb->offset + je32_to_cpu(spi->offset)) | REF_UNCHECKED;
333 raw->__totlen = PAD(je32_to_cpu(spi->totlen));
334 raw->next_phys = NULL;
335 raw->next_in_ino = ic->nodes;
338 if (!jeb->first_node)
339 jeb->first_node = raw;
341 jeb->last_node->next_phys = raw;
342 jeb->last_node = raw;
343 *pseudo_random += je32_to_cpu(spi->version);
345 UNCHECKED_SPACE(PAD(je32_to_cpu(spi->totlen)));
347 sp += JFFS2_SUMMARY_INODE_SIZE;
352 case JFFS2_NODETYPE_DIRENT: {
353 struct jffs2_sum_dirent_flash *spd;
356 JFFS2_DBG_SUMMARY("Dirent at 0x%08x\n",
357 jeb->offset + je32_to_cpu(spd->offset));
359 fd = jffs2_alloc_full_dirent(spd->nsize+1);
365 memcpy(&fd->name, spd->name, spd->nsize);
366 fd->name[spd->nsize] = 0;
368 raw = jffs2_alloc_raw_node_ref();
370 jffs2_free_full_dirent(fd);
371 JFFS2_NOTICE("allocation of node reference failed\n");
376 ic = jffs2_scan_make_ino_cache(c, je32_to_cpu(spd->pino));
378 jffs2_free_full_dirent(fd);
379 jffs2_free_raw_node_ref(raw);
384 raw->__totlen = PAD(je32_to_cpu(spd->totlen));
385 raw->flash_offset = (jeb->offset + je32_to_cpu(spd->offset)) | REF_PRISTINE;
386 raw->next_phys = NULL;
387 raw->next_in_ino = ic->nodes;
389 if (!jeb->first_node)
390 jeb->first_node = raw;
392 jeb->last_node->next_phys = raw;
393 jeb->last_node = raw;
397 fd->version = je32_to_cpu(spd->version);
398 fd->ino = je32_to_cpu(spd->ino);
399 fd->nhash = full_name_hash(fd->name, spd->nsize);
400 fd->type = spd->type;
401 USED_SPACE(PAD(je32_to_cpu(spd->totlen)));
402 jffs2_add_fd_to_list(c, fd, &ic->scan_dents);
404 *pseudo_random += je32_to_cpu(spd->version);
406 sp += JFFS2_SUMMARY_DIRENT_SIZE(spd->nsize);
412 JFFS2_WARNING("Unsupported node type found in summary! Exiting...");
423 /* Process the summary node - called from jffs2_scan_eraseblock() */
425 int jffs2_sum_scan_sumnode(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb,
426 uint32_t ofs, uint32_t *pseudo_random)
428 struct jffs2_unknown_node crcnode;
429 struct jffs2_raw_node_ref *cache_ref;
430 struct jffs2_summary_node *summary;
434 sumsize = c->sector_size - ofs;
437 JFFS2_DBG_SUMMARY("summary found for 0x%08x at 0x%08x (0x%x bytes)\n",
438 jeb->offset, ofs, sumsize);
440 summary = kmalloc(sumsize, GFP_KERNEL);
446 ret = jffs2_fill_scan_buf(c, (unsigned char *)summary, ofs, sumsize);
453 /* OK, now check for node validity and CRC */
454 crcnode.magic = cpu_to_je16(JFFS2_MAGIC_BITMASK);
455 crcnode.nodetype = cpu_to_je16(JFFS2_NODETYPE_SUMMARY);
456 crcnode.totlen = summary->totlen;
457 crc = crc32(0, &crcnode, sizeof(crcnode)-4);
459 if (je32_to_cpu(summary->hdr_crc) != crc) {
460 JFFS2_DBG_SUMMARY("Summary node header is corrupt (bad CRC or "
461 "no summary at all)\n");
465 if (je32_to_cpu(summary->totlen) != sumsize) {
466 JFFS2_DBG_SUMMARY("Summary node is corrupt (wrong erasesize?)\n");
470 crc = crc32(0, summary, sizeof(struct jffs2_summary_node)-8);
472 if (je32_to_cpu(summary->node_crc) != crc) {
473 JFFS2_DBG_SUMMARY("Summary node is corrupt (bad CRC)\n");
477 crc = crc32(0, summary->sum, sumsize - sizeof(struct jffs2_summary_node));
479 if (je32_to_cpu(summary->sum_crc) != crc) {
480 JFFS2_DBG_SUMMARY("Summary node data is corrupt (bad CRC)\n");
484 if ( je32_to_cpu(summary->cln_mkr) ) {
486 JFFS2_DBG_SUMMARY("Summary : CLEANMARKER node \n");
488 if (je32_to_cpu(summary->cln_mkr) != c->cleanmarker_size) {
489 JFFS2_DBG_SUMMARY("CLEANMARKER node has totlen 0x%x != normal 0x%x\n",
490 je32_to_cpu(summary->cln_mkr), c->cleanmarker_size);
491 UNCHECKED_SPACE(PAD(je32_to_cpu(summary->cln_mkr)));
492 } else if (jeb->first_node) {
493 JFFS2_DBG_SUMMARY("CLEANMARKER node not first node in block "
494 "(0x%08x)\n", jeb->offset);
495 UNCHECKED_SPACE(PAD(je32_to_cpu(summary->cln_mkr)));
497 struct jffs2_raw_node_ref *marker_ref = jffs2_alloc_raw_node_ref();
500 JFFS2_NOTICE("Failed to allocate node ref for clean marker\n");
505 marker_ref->next_in_ino = NULL;
506 marker_ref->next_phys = NULL;
507 marker_ref->flash_offset = jeb->offset | REF_NORMAL;
508 marker_ref->__totlen = je32_to_cpu(summary->cln_mkr);
509 jeb->first_node = jeb->last_node = marker_ref;
511 USED_SPACE( PAD(je32_to_cpu(summary->cln_mkr)) );
515 if (je32_to_cpu(summary->padded)) {
516 DIRTY_SPACE(je32_to_cpu(summary->padded));
519 ret = jffs2_sum_process_sum_data(c, jeb, summary, pseudo_random);
523 /* for PARANOIA_CHECK */
524 cache_ref = jffs2_alloc_raw_node_ref();
527 JFFS2_NOTICE("Failed to allocate node ref for cache\n");
531 cache_ref->next_in_ino = NULL;
532 cache_ref->next_phys = NULL;
533 cache_ref->flash_offset = ofs | REF_NORMAL;
534 cache_ref->__totlen = sumsize;
536 if (!jeb->first_node)
537 jeb->first_node = cache_ref;
539 jeb->last_node->next_phys = cache_ref;
540 jeb->last_node = cache_ref;
544 jeb->wasted_size += jeb->free_size;
545 c->wasted_size += jeb->free_size;
546 c->free_size -= jeb->free_size;
549 return jffs2_scan_classify_jeb(c, jeb);
552 JFFS2_WARNING("Summary node crc error, skipping summary information.\n");
557 /* Write summary data to flash - helper function for jffs2_sum_write_sumnode() */
559 static int jffs2_sum_write_data(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb,
560 uint32_t infosize, uint32_t datasize, int padsize)
562 struct jffs2_summary_node isum;
563 union jffs2_sum_mem *temp;
564 struct jffs2_sum_marker *sm;
570 memset(c->summary->sum_buf, 0xff, datasize);
571 memset(&isum, 0, sizeof(isum));
573 isum.magic = cpu_to_je16(JFFS2_MAGIC_BITMASK);
574 isum.nodetype = cpu_to_je16(JFFS2_NODETYPE_SUMMARY);
575 isum.totlen = cpu_to_je32(infosize);
576 isum.hdr_crc = cpu_to_je32(crc32(0, &isum, sizeof(struct jffs2_unknown_node) - 4));
577 isum.padded = cpu_to_je32(c->summary->sum_padded);
578 isum.cln_mkr = cpu_to_je32(c->cleanmarker_size);
579 isum.sum_num = cpu_to_je32(c->summary->sum_num);
580 wpage = c->summary->sum_buf;
582 while (c->summary->sum_num) {
584 switch (je16_to_cpu(c->summary->sum_list_head->u.nodetype)) {
585 case JFFS2_NODETYPE_INODE: {
586 struct jffs2_sum_inode_flash *sino_ptr = wpage;
588 sino_ptr->nodetype = c->summary->sum_list_head->i.nodetype;
589 sino_ptr->inode = c->summary->sum_list_head->i.inode;
590 sino_ptr->version = c->summary->sum_list_head->i.version;
591 sino_ptr->offset = c->summary->sum_list_head->i.offset;
592 sino_ptr->totlen = c->summary->sum_list_head->i.totlen;
594 wpage += JFFS2_SUMMARY_INODE_SIZE;
599 case JFFS2_NODETYPE_DIRENT: {
600 struct jffs2_sum_dirent_flash *sdrnt_ptr = wpage;
602 sdrnt_ptr->nodetype = c->summary->sum_list_head->d.nodetype;
603 sdrnt_ptr->totlen = c->summary->sum_list_head->d.totlen;
604 sdrnt_ptr->offset = c->summary->sum_list_head->d.offset;
605 sdrnt_ptr->pino = c->summary->sum_list_head->d.pino;
606 sdrnt_ptr->version = c->summary->sum_list_head->d.version;
607 sdrnt_ptr->ino = c->summary->sum_list_head->d.ino;
608 sdrnt_ptr->nsize = c->summary->sum_list_head->d.nsize;
609 sdrnt_ptr->type = c->summary->sum_list_head->d.type;
611 memcpy(sdrnt_ptr->name, c->summary->sum_list_head->d.name,
612 c->summary->sum_list_head->d.nsize);
614 wpage += JFFS2_SUMMARY_DIRENT_SIZE(c->summary->sum_list_head->d.nsize);
620 BUG(); /* unknown node in summary information */
624 temp = c->summary->sum_list_head;
625 c->summary->sum_list_head = c->summary->sum_list_head->u.next;
628 c->summary->sum_num--;
631 jffs2_sum_reset_collected(c->summary);
636 sm->offset = cpu_to_je32(c->sector_size - jeb->free_size);
637 sm->magic = cpu_to_je32(JFFS2_SUM_MAGIC);
639 isum.sum_crc = cpu_to_je32(crc32(0, c->summary->sum_buf, datasize));
640 isum.node_crc = cpu_to_je32(crc32(0, &isum, sizeof(isum) - 8));
642 vecs[0].iov_base = &isum;
643 vecs[0].iov_len = sizeof(isum);
644 vecs[1].iov_base = c->summary->sum_buf;
645 vecs[1].iov_len = datasize;
647 JFFS2_DBG_SUMMARY("JFFS2: writing out data to flash to pos : 0x%08x\n",
648 jeb->offset + c->sector_size - jeb->free_size);
650 spin_unlock(&c->erase_completion_lock);
651 ret = jffs2_flash_writev(c, vecs, 2, jeb->offset + c->sector_size -
652 jeb->free_size, &retlen, 0);
653 spin_lock(&c->erase_completion_lock);
656 if (ret || (retlen != infosize)) {
657 JFFS2_WARNING("Write of %zd bytes at 0x%08x failed. returned %d, retlen %zd\n",
658 infosize, jeb->offset + c->sector_size - jeb->free_size, ret, retlen);
660 c->summary->sum_size = JFFS2_SUMMARY_NOSUM_SIZE;
661 WASTED_SPACE(infosize);
669 /* Write out summary information - called from jffs2_do_reserve_space */
671 int jffs2_sum_write_sumnode(struct jffs2_sb_info *c)
673 struct jffs2_raw_node_ref *summary_ref;
674 int datasize, infosize, padsize, ret;
675 struct jffs2_eraseblock *jeb;
677 JFFS2_DBG_SUMMARY("called\n");
681 if (!c->summary->sum_num || !c->summary->sum_list_head) {
682 JFFS2_WARNING("Empty summary info!!!\n");
686 datasize = c->summary->sum_size + sizeof(struct jffs2_sum_marker);
687 infosize = sizeof(struct jffs2_summary_node) + datasize;
688 padsize = jeb->free_size - infosize;
692 /* Is there enough space for summary? */
694 /* don't try to write out summary for this jeb */
695 jffs2_sum_disable_collecting(c->summary);
697 JFFS2_WARNING("Not enough space for summary, padsize = %d\n", padsize);
701 ret = jffs2_sum_write_data(c, jeb, infosize, datasize, padsize);
703 return 0; /* can't write out summary, block is marked as NOSUM_SIZE */
705 /* for ACCT_PARANOIA_CHECK */
706 spin_unlock(&c->erase_completion_lock);
707 summary_ref = jffs2_alloc_raw_node_ref();
708 spin_lock(&c->erase_completion_lock);
711 JFFS2_NOTICE("Failed to allocate node ref for summary\n");
715 summary_ref->next_in_ino = NULL;
716 summary_ref->next_phys = NULL;
717 summary_ref->flash_offset = (jeb->offset + c->sector_size - jeb->free_size) | REF_NORMAL;
718 summary_ref->__totlen = infosize;
720 if (!jeb->first_node)
721 jeb->first_node = summary_ref;
723 jeb->last_node->next_phys = summary_ref;
724 jeb->last_node = summary_ref;
726 USED_SPACE(infosize);