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.4 2005/09/26 11:37:21 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");
45 dbg_summary("returned succesfully\n");
50 void jffs2_sum_exit(struct jffs2_sb_info *c)
52 dbg_summary("called\n");
54 jffs2_sum_disable_collecting(c->summary);
56 vfree(c->summary->sum_buf);
57 c->summary->sum_buf = NULL;
63 static int jffs2_sum_add_mem(struct jffs2_summary *s, union jffs2_sum_mem *item)
65 if (!s->sum_list_head)
66 s->sum_list_head = (union jffs2_sum_mem *) item;
68 s->sum_list_tail->u.next = (union jffs2_sum_mem *) item;
69 s->sum_list_tail = (union jffs2_sum_mem *) item;
71 switch (je16_to_cpu(item->u.nodetype)) {
72 case JFFS2_NODETYPE_INODE:
73 s->sum_size += JFFS2_SUMMARY_INODE_SIZE;
75 dbg_summary("inode (%u) added to summary\n",
76 je32_to_cpu(item->i.inode));
78 case JFFS2_NODETYPE_DIRENT:
79 s->sum_size += JFFS2_SUMMARY_DIRENT_SIZE(item->d.nsize);
81 dbg_summary("dirent (%u) added to summary\n",
82 je32_to_cpu(item->d.ino));
85 JFFS2_WARNING("UNKNOWN node type %u\n",
86 je16_to_cpu(item->u.nodetype));
93 /* The following 3 functions are called from scan.c to collect summary info for not closed jeb */
95 int jffs2_sum_add_padding_mem(struct jffs2_summary *s, uint32_t size)
97 dbg_summary("called with %u\n", size);
98 s->sum_padded += size;
102 int jffs2_sum_add_inode_mem(struct jffs2_summary *s, struct jffs2_raw_inode *ri,
105 struct jffs2_sum_inode_mem *temp = kmalloc(sizeof(struct jffs2_sum_inode_mem), GFP_KERNEL);
110 temp->nodetype = ri->nodetype;
111 temp->inode = ri->ino;
112 temp->version = ri->version;
113 temp->offset = cpu_to_je32(ofs); /* relative offset from the begining of the jeb */
114 temp->totlen = ri->totlen;
117 return jffs2_sum_add_mem(s, (union jffs2_sum_mem *)temp);
120 int jffs2_sum_add_dirent_mem(struct jffs2_summary *s, struct jffs2_raw_dirent *rd,
123 struct jffs2_sum_dirent_mem *temp =
124 kmalloc(sizeof(struct jffs2_sum_dirent_mem) + rd->nsize, GFP_KERNEL);
129 temp->nodetype = rd->nodetype;
130 temp->totlen = rd->totlen;
131 temp->offset = cpu_to_je32(ofs); /* relative from the begining of the jeb */
132 temp->pino = rd->pino;
133 temp->version = rd->version;
135 temp->nsize = rd->nsize;
136 temp->type = rd->type;
139 memcpy(temp->name, rd->name, rd->nsize);
141 return jffs2_sum_add_mem(s, (union jffs2_sum_mem *)temp);
144 /* Cleanup every collected summary information */
146 static void jffs2_sum_clean_collected(struct jffs2_summary *s)
148 union jffs2_sum_mem *temp;
150 if (!s->sum_list_head) {
151 dbg_summary("already empty\n");
153 while (s->sum_list_head) {
154 temp = s->sum_list_head;
155 s->sum_list_head = s->sum_list_head->u.next;
158 s->sum_list_tail = NULL;
163 void jffs2_sum_reset_collected(struct jffs2_summary *s)
165 dbg_summary("called\n");
166 jffs2_sum_clean_collected(s);
170 void jffs2_sum_disable_collecting(struct jffs2_summary *s)
172 dbg_summary("called\n");
173 jffs2_sum_clean_collected(s);
174 s->sum_size = JFFS2_SUMMARY_NOSUM_SIZE;
177 int jffs2_sum_is_disabled(struct jffs2_summary *s)
179 return (s->sum_size == JFFS2_SUMMARY_NOSUM_SIZE);
182 /* Move the collected summary information into sb (called from scan.c) */
184 void jffs2_sum_move_collected(struct jffs2_sb_info *c, struct jffs2_summary *s)
186 dbg_summary("oldsize=0x%x oldnum=%u => newsize=0x%x newnum=%u\n",
187 c->summary->sum_size, c->summary->sum_num,
188 s->sum_size, s->sum_num);
190 c->summary->sum_size = s->sum_size;
191 c->summary->sum_num = s->sum_num;
192 c->summary->sum_padded = s->sum_padded;
193 c->summary->sum_list_head = s->sum_list_head;
194 c->summary->sum_list_tail = s->sum_list_tail;
196 s->sum_list_head = s->sum_list_tail = NULL;
199 /* Called from wbuf.c to collect writed node info */
201 int jffs2_sum_add_kvec(struct jffs2_sb_info *c, const struct kvec *invecs,
202 unsigned long count, uint32_t ofs)
204 union jffs2_node_union *node;
205 struct jffs2_eraseblock *jeb;
207 node = invecs[0].iov_base;
208 jeb = &c->blocks[ofs / c->sector_size];
211 switch (je16_to_cpu(node->u.nodetype)) {
212 case JFFS2_NODETYPE_INODE: {
213 struct jffs2_sum_inode_mem *temp =
214 kmalloc(sizeof(struct jffs2_sum_inode_mem), GFP_KERNEL);
219 temp->nodetype = node->i.nodetype;
220 temp->inode = node->i.ino;
221 temp->version = node->i.version;
222 temp->offset = cpu_to_je32(ofs);
223 temp->totlen = node->i.totlen;
226 return jffs2_sum_add_mem(c->summary, (union jffs2_sum_mem *)temp);
229 case JFFS2_NODETYPE_DIRENT: {
230 struct jffs2_sum_dirent_mem *temp =
231 kmalloc(sizeof(struct jffs2_sum_dirent_mem) + node->d.nsize, GFP_KERNEL);
236 temp->nodetype = node->d.nodetype;
237 temp->totlen = node->d.totlen;
238 temp->offset = cpu_to_je32(ofs);
239 temp->pino = node->d.pino;
240 temp->version = node->d.version;
241 temp->ino = node->d.ino;
242 temp->nsize = node->d.nsize;
243 temp->type = node->d.type;
248 memcpy(temp->name,node->d.name,node->d.nsize);
252 memcpy(temp->name,invecs[1].iov_base,node->d.nsize);
256 BUG(); /* impossible count value */
260 return jffs2_sum_add_mem(c->summary, (union jffs2_sum_mem *)temp);
263 case JFFS2_NODETYPE_PADDING:
264 dbg_summary("node PADDING\n");
265 c->summary->sum_padded += je32_to_cpu(node->u.totlen);
268 case JFFS2_NODETYPE_CLEANMARKER:
269 dbg_summary("node CLEANMARKER\n");
272 case JFFS2_NODETYPE_SUMMARY:
273 dbg_summary("node SUMMARY\n");
277 /* If you implement a new node type you should also implement
278 summary support for it or disable summary.
287 JFFS2_WARNING("MEMORY ALLOCATION ERROR!");
292 /* Process the stored summary information - helper function for jffs2_sum_scan_sumnode() */
294 static int jffs2_sum_process_sum_data(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb,
295 struct jffs2_raw_summary *summary, uint32_t *pseudo_random)
297 struct jffs2_raw_node_ref *raw;
298 struct jffs2_inode_cache *ic;
299 struct jffs2_full_dirent *fd;
305 for (i=0; i<je32_to_cpu(summary->sum_num); i++) {
306 dbg_summary("processing summary index %d\n", i);
308 switch (je16_to_cpu(((struct jffs2_sum_unknown_flash *)sp)->nodetype)) {
309 case JFFS2_NODETYPE_INODE: {
310 struct jffs2_sum_inode_flash *spi;
313 ino = je32_to_cpu(spi->inode);
315 dbg_summary("Inode at 0x%08x\n",
316 jeb->offset + je32_to_cpu(spi->offset));
318 raw = jffs2_alloc_raw_node_ref();
320 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);
331 raw->flash_offset = (jeb->offset + je32_to_cpu(spi->offset)) | REF_UNCHECKED;
332 raw->__totlen = PAD(je32_to_cpu(spi->totlen));
333 raw->next_phys = NULL;
334 raw->next_in_ino = ic->nodes;
337 if (!jeb->first_node)
338 jeb->first_node = raw;
340 jeb->last_node->next_phys = raw;
341 jeb->last_node = raw;
342 *pseudo_random += je32_to_cpu(spi->version);
344 UNCHECKED_SPACE(PAD(je32_to_cpu(spi->totlen)));
346 sp += JFFS2_SUMMARY_INODE_SIZE;
351 case JFFS2_NODETYPE_DIRENT: {
352 struct jffs2_sum_dirent_flash *spd;
355 dbg_summary("Dirent at 0x%08x\n",
356 jeb->offset + je32_to_cpu(spd->offset));
358 fd = jffs2_alloc_full_dirent(spd->nsize+1);
362 memcpy(&fd->name, spd->name, spd->nsize);
363 fd->name[spd->nsize] = 0;
365 raw = jffs2_alloc_raw_node_ref();
367 jffs2_free_full_dirent(fd);
368 JFFS2_NOTICE("allocation of node reference failed\n");
372 ic = jffs2_scan_make_ino_cache(c, je32_to_cpu(spd->pino));
374 jffs2_free_full_dirent(fd);
375 jffs2_free_raw_node_ref(raw);
379 raw->__totlen = PAD(je32_to_cpu(spd->totlen));
380 raw->flash_offset = (jeb->offset + je32_to_cpu(spd->offset)) | REF_PRISTINE;
381 raw->next_phys = NULL;
382 raw->next_in_ino = ic->nodes;
384 if (!jeb->first_node)
385 jeb->first_node = raw;
387 jeb->last_node->next_phys = raw;
388 jeb->last_node = raw;
392 fd->version = je32_to_cpu(spd->version);
393 fd->ino = je32_to_cpu(spd->ino);
394 fd->nhash = full_name_hash(fd->name, spd->nsize);
395 fd->type = spd->type;
396 USED_SPACE(PAD(je32_to_cpu(spd->totlen)));
397 jffs2_add_fd_to_list(c, fd, &ic->scan_dents);
399 *pseudo_random += je32_to_cpu(spd->version);
401 sp += JFFS2_SUMMARY_DIRENT_SIZE(spd->nsize);
407 JFFS2_WARNING("Unsupported node type found in summary! Exiting...");
416 /* Process the summary node - called from jffs2_scan_eraseblock() */
417 int jffs2_sum_scan_sumnode(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb,
418 struct jffs2_raw_summary *summary, uint32_t sumsize,
419 uint32_t *pseudo_random)
421 struct jffs2_unknown_node crcnode;
422 struct jffs2_raw_node_ref *cache_ref;
426 ofs = jeb->offset + c->sector_size - sumsize;
428 dbg_summary("summary found for 0x%08x at 0x%08x (0x%x bytes)\n",
429 jeb->offset, ofs, sumsize);
431 /* OK, now check for node validity and CRC */
432 crcnode.magic = cpu_to_je16(JFFS2_MAGIC_BITMASK);
433 crcnode.nodetype = cpu_to_je16(JFFS2_NODETYPE_SUMMARY);
434 crcnode.totlen = summary->totlen;
435 crc = crc32(0, &crcnode, sizeof(crcnode)-4);
437 if (je32_to_cpu(summary->hdr_crc) != crc) {
438 dbg_summary("Summary node header is corrupt (bad CRC or "
439 "no summary at all)\n");
443 if (je32_to_cpu(summary->totlen) != sumsize) {
444 dbg_summary("Summary node is corrupt (wrong erasesize?)\n");
448 crc = crc32(0, summary, sizeof(struct jffs2_raw_summary)-8);
450 if (je32_to_cpu(summary->node_crc) != crc) {
451 dbg_summary("Summary node is corrupt (bad CRC)\n");
455 crc = crc32(0, summary->sum, sumsize - sizeof(struct jffs2_raw_summary));
457 if (je32_to_cpu(summary->sum_crc) != crc) {
458 dbg_summary("Summary node data is corrupt (bad CRC)\n");
462 if ( je32_to_cpu(summary->cln_mkr) ) {
464 dbg_summary("Summary : CLEANMARKER node \n");
466 if (je32_to_cpu(summary->cln_mkr) != c->cleanmarker_size) {
467 dbg_summary("CLEANMARKER node has totlen 0x%x != normal 0x%x\n",
468 je32_to_cpu(summary->cln_mkr), c->cleanmarker_size);
469 UNCHECKED_SPACE(PAD(je32_to_cpu(summary->cln_mkr)));
470 } else if (jeb->first_node) {
471 dbg_summary("CLEANMARKER node not first node in block "
472 "(0x%08x)\n", jeb->offset);
473 UNCHECKED_SPACE(PAD(je32_to_cpu(summary->cln_mkr)));
475 struct jffs2_raw_node_ref *marker_ref = jffs2_alloc_raw_node_ref();
478 JFFS2_NOTICE("Failed to allocate node ref for clean marker\n");
482 marker_ref->next_in_ino = NULL;
483 marker_ref->next_phys = NULL;
484 marker_ref->flash_offset = jeb->offset | REF_NORMAL;
485 marker_ref->__totlen = je32_to_cpu(summary->cln_mkr);
486 jeb->first_node = jeb->last_node = marker_ref;
488 USED_SPACE( PAD(je32_to_cpu(summary->cln_mkr)) );
492 if (je32_to_cpu(summary->padded)) {
493 DIRTY_SPACE(je32_to_cpu(summary->padded));
496 ret = jffs2_sum_process_sum_data(c, jeb, summary, pseudo_random);
500 /* for PARANOIA_CHECK */
501 cache_ref = jffs2_alloc_raw_node_ref();
504 JFFS2_NOTICE("Failed to allocate node ref for cache\n");
508 cache_ref->next_in_ino = NULL;
509 cache_ref->next_phys = NULL;
510 cache_ref->flash_offset = ofs | REF_NORMAL;
511 cache_ref->__totlen = sumsize;
513 if (!jeb->first_node)
514 jeb->first_node = cache_ref;
516 jeb->last_node->next_phys = cache_ref;
517 jeb->last_node = cache_ref;
521 jeb->wasted_size += jeb->free_size;
522 c->wasted_size += jeb->free_size;
523 c->free_size -= jeb->free_size;
526 return jffs2_scan_classify_jeb(c, jeb);
529 JFFS2_WARNING("Summary node crc error, skipping summary information.\n");
534 /* Write summary data to flash - helper function for jffs2_sum_write_sumnode() */
536 static int jffs2_sum_write_data(struct jffs2_sb_info *c, struct jffs2_eraseblock *jeb,
537 uint32_t infosize, uint32_t datasize, int padsize)
539 struct jffs2_raw_summary isum;
540 union jffs2_sum_mem *temp;
541 struct jffs2_sum_marker *sm;
547 memset(c->summary->sum_buf, 0xff, datasize);
548 memset(&isum, 0, sizeof(isum));
550 isum.magic = cpu_to_je16(JFFS2_MAGIC_BITMASK);
551 isum.nodetype = cpu_to_je16(JFFS2_NODETYPE_SUMMARY);
552 isum.totlen = cpu_to_je32(infosize);
553 isum.hdr_crc = cpu_to_je32(crc32(0, &isum, sizeof(struct jffs2_unknown_node) - 4));
554 isum.padded = cpu_to_je32(c->summary->sum_padded);
555 isum.cln_mkr = cpu_to_je32(c->cleanmarker_size);
556 isum.sum_num = cpu_to_je32(c->summary->sum_num);
557 wpage = c->summary->sum_buf;
559 while (c->summary->sum_num) {
560 temp = c->summary->sum_list_head;
562 switch (je16_to_cpu(temp->u.nodetype)) {
563 case JFFS2_NODETYPE_INODE: {
564 struct jffs2_sum_inode_flash *sino_ptr = wpage;
566 sino_ptr->nodetype = temp->i.nodetype;
567 sino_ptr->inode = temp->i.inode;
568 sino_ptr->version = temp->i.version;
569 sino_ptr->offset = temp->i.offset;
570 sino_ptr->totlen = temp->i.totlen;
572 wpage += JFFS2_SUMMARY_INODE_SIZE;
577 case JFFS2_NODETYPE_DIRENT: {
578 struct jffs2_sum_dirent_flash *sdrnt_ptr = wpage;
580 sdrnt_ptr->nodetype = temp->d.nodetype;
581 sdrnt_ptr->totlen = temp->d.totlen;
582 sdrnt_ptr->offset = temp->d.offset;
583 sdrnt_ptr->pino = temp->d.pino;
584 sdrnt_ptr->version = temp->d.version;
585 sdrnt_ptr->ino = temp->d.ino;
586 sdrnt_ptr->nsize = temp->d.nsize;
587 sdrnt_ptr->type = temp->d.type;
589 memcpy(sdrnt_ptr->name, temp->d.name,
592 wpage += JFFS2_SUMMARY_DIRENT_SIZE(temp->d.nsize);
598 BUG(); /* unknown node in summary information */
602 c->summary->sum_list_head = temp->u.next;
605 c->summary->sum_num--;
608 jffs2_sum_reset_collected(c->summary);
613 sm->offset = cpu_to_je32(c->sector_size - jeb->free_size);
614 sm->magic = cpu_to_je32(JFFS2_SUM_MAGIC);
616 isum.sum_crc = cpu_to_je32(crc32(0, c->summary->sum_buf, datasize));
617 isum.node_crc = cpu_to_je32(crc32(0, &isum, sizeof(isum) - 8));
619 vecs[0].iov_base = &isum;
620 vecs[0].iov_len = sizeof(isum);
621 vecs[1].iov_base = c->summary->sum_buf;
622 vecs[1].iov_len = datasize;
624 dbg_summary("JFFS2: writing out data to flash to pos : 0x%08x\n",
625 jeb->offset + c->sector_size - jeb->free_size);
627 spin_unlock(&c->erase_completion_lock);
628 ret = jffs2_flash_writev(c, vecs, 2, jeb->offset + c->sector_size -
629 jeb->free_size, &retlen, 0);
630 spin_lock(&c->erase_completion_lock);
633 if (ret || (retlen != infosize)) {
634 JFFS2_WARNING("Write of %u bytes at 0x%08x failed. returned %d, retlen %zd\n",
635 infosize, jeb->offset + c->sector_size - jeb->free_size, ret, retlen);
637 c->summary->sum_size = JFFS2_SUMMARY_NOSUM_SIZE;
638 WASTED_SPACE(infosize);
646 /* Write out summary information - called from jffs2_do_reserve_space */
648 int jffs2_sum_write_sumnode(struct jffs2_sb_info *c)
650 struct jffs2_raw_node_ref *summary_ref;
651 int datasize, infosize, padsize, ret;
652 struct jffs2_eraseblock *jeb;
654 dbg_summary("called\n");
658 if (!c->summary->sum_num || !c->summary->sum_list_head) {
659 JFFS2_WARNING("Empty summary info!!!\n");
663 datasize = c->summary->sum_size + sizeof(struct jffs2_sum_marker);
664 infosize = sizeof(struct jffs2_raw_summary) + datasize;
665 padsize = jeb->free_size - infosize;
669 /* Is there enough space for summary? */
671 /* don't try to write out summary for this jeb */
672 jffs2_sum_disable_collecting(c->summary);
674 JFFS2_WARNING("Not enough space for summary, padsize = %d\n", padsize);
678 ret = jffs2_sum_write_data(c, jeb, infosize, datasize, padsize);
680 return 0; /* can't write out summary, block is marked as NOSUM_SIZE */
682 /* for ACCT_PARANOIA_CHECK */
683 spin_unlock(&c->erase_completion_lock);
684 summary_ref = jffs2_alloc_raw_node_ref();
685 spin_lock(&c->erase_completion_lock);
688 JFFS2_NOTICE("Failed to allocate node ref for summary\n");
692 summary_ref->next_in_ino = NULL;
693 summary_ref->next_phys = NULL;
694 summary_ref->flash_offset = (jeb->offset + c->sector_size - jeb->free_size) | REF_NORMAL;
695 summary_ref->__totlen = infosize;
697 if (!jeb->first_node)
698 jeb->first_node = summary_ref;
700 jeb->last_node->next_phys = summary_ref;
701 jeb->last_node = summary_ref;
703 USED_SPACE(infosize);