yaffs_packedtags2.c

   1 /*
   2  * YAFFS: Yet Another Flash File System. A NAND-flash specific file system.
   3  *
   4  * Copyright (C) 2002-2018 Aleph One Ltd.
   5  *
   6  * Created by Charles Manning <charles@aleph1.co.uk>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 as
  10  * published by the Free Software Foundation.
  11  */
  12
  13 #include "yaffs_packedtags2.h"
  14 #include "yportenv.h"
  15 #include "yaffs_trace.h"
  16 #include "yaffs_endian.h"
  17
  18 /* This code packs a set of extended tags into a binary structure for
  19  * NAND storage
  20  */
  21
  22 /* Some of the information is "extra" struff which can be packed in to
  23  * speed scanning
  24  * This is defined by having the EXTRA_HEADER_INFO_FLAG set.
  25  */
  26
  27 /* Extra flags applied to chunk_id */
  28
  29 #define EXTRA_HEADER_INFO_FLAG  0x80000000
  30 #define EXTRA_SHRINK_FLAG       0x40000000
  31 #define EXTRA_SHADOWS_FLAG      0x20000000
  32 #define EXTRA_SPARE_FLAGS       0x10000000
  33
  34 #define ALL_EXTRA_FLAGS         0xf0000000
  35
  36 /* Also, the top 4 bits of the object Id are set to the object type. */
  37 #define EXTRA_OBJECT_TYPE_SHIFT (28)
  38 #define EXTRA_OBJECT_TYPE_MASK  ((0x0f) << EXTRA_OBJECT_TYPE_SHIFT)
  39
  40 static void yaffs_dump_packed_tags2_tags_only(
  41                                 const struct yaffs_packed_tags2_tags_only *ptt)
  42 {
  43         yaffs_trace(YAFFS_TRACE_MTD,
  44                 "packed tags obj %d chunk %d byte %d seq %d",
  45                 ptt->obj_id, ptt->chunk_id, ptt->n_bytes, ptt->seq_number);
  46 }
  47
  48 static void yaffs_dump_packed_tags2(const struct yaffs_packed_tags2 *pt)
  49 {
  50         yaffs_dump_packed_tags2_tags_only(&pt->t);
  51 }
  52
  53 static void yaffs_dump_tags2(const struct yaffs_ext_tags *t)
  54 {
  55         yaffs_trace(YAFFS_TRACE_MTD,
  56                 "ext.tags eccres %d blkbad %d chused %d obj %d chunk%d byte %d del %d ser %d seq %d",
  57                 t->ecc_result, t->block_bad, t->chunk_used, t->obj_id,
  58                 t->chunk_id, t->n_bytes, t->is_deleted, t->serial_number,
  59                 t->seq_number);
  60
  61 }
  62
  63 static int yaffs_check_tags_extra_packable(const struct yaffs_ext_tags *t)
  64 {
  65         if (t->chunk_id != 0 || !t->extra_available)
  66                 return 0;
  67
  68         /* Check if the file size is too long to store */
  69         if (t->extra_obj_type == YAFFS_OBJECT_TYPE_FILE &&
  70             (t->extra_file_size >> 31) != 0)
  71                 return 0;
  72         return 1;
  73 }
  74
  75 void yaffs_pack_tags2_tags_only(struct yaffs_dev *dev,
  76                                 struct yaffs_packed_tags2_tags_only *ptt,
  77                                 const struct yaffs_ext_tags *t)
  78 {
  79         ptt->chunk_id = t->chunk_id;
  80         ptt->seq_number = t->seq_number;
  81         ptt->n_bytes = t->n_bytes;
  82         ptt->obj_id = t->obj_id;
  83
  84         /* Only store extra tags for object headers.
  85          * If it is a file then only store  if the file size is short\
  86          * enough to fit.
  87          */
  88         if (yaffs_check_tags_extra_packable(t)) {
  89                 /* Store the extra header info instead */
  90                 /* We save the parent object in the chunk_id */
  91                 ptt->chunk_id = EXTRA_HEADER_INFO_FLAG | t->extra_parent_id;
  92                 if (t->extra_is_shrink)
  93                         ptt->chunk_id |= EXTRA_SHRINK_FLAG;
  94                 if (t->extra_shadows)
  95                         ptt->chunk_id |= EXTRA_SHADOWS_FLAG;
  96
  97                 ptt->obj_id &= ~EXTRA_OBJECT_TYPE_MASK;
  98                 ptt->obj_id |= (t->extra_obj_type << EXTRA_OBJECT_TYPE_SHIFT);
  99
 100                 if (t->extra_obj_type == YAFFS_OBJECT_TYPE_HARDLINK)
 101                         ptt->n_bytes = t->extra_equiv_id;
 102                 else if (t->extra_obj_type == YAFFS_OBJECT_TYPE_FILE)
 103                         ptt->n_bytes = (unsigned) t->extra_file_size;
 104                 else
 105                         ptt->n_bytes = 0;
 106         }
 107
 108         yaffs_dump_packed_tags2_tags_only(ptt);
 109         yaffs_dump_tags2(t);
 110         yaffs_do_endian_packed_tags2(dev, ptt);
 111 }
 112
 113 void yaffs_pack_tags2(struct yaffs_dev *dev,
 114                       struct yaffs_packed_tags2 *pt,
 115                       const struct yaffs_ext_tags *t, int tags_ecc)
 116 {
 117         yaffs_pack_tags2_tags_only(dev, &pt->t, t);
 118
 119         if (tags_ecc)
 120                 yaffs_ecc_calc_other((unsigned char *)&pt->t,
 121                                     sizeof(struct yaffs_packed_tags2_tags_only),
 122                                     &pt->ecc);
 123 }
 124
 125 void yaffs_unpack_tags2_tags_only(struct yaffs_dev *dev,
 126                                   struct yaffs_ext_tags *t,
 127                                   struct yaffs_packed_tags2_tags_only *ptt_ptr)
 128 {
 129         struct yaffs_packed_tags2_tags_only ptt_copy = *ptt_ptr;
 130
 131         memset(t, 0, sizeof(struct yaffs_ext_tags));
 132
 133         if (ptt_copy.seq_number == 0xffffffff)
 134                 return;
 135
 136         yaffs_do_endian_packed_tags2(dev, &ptt_copy);
 137
 138         t->block_bad = 0;
 139         t->chunk_used = 1;
 140         t->obj_id = ptt_copy.obj_id;
 141         t->chunk_id = ptt_copy.chunk_id;
 142         t->n_bytes = ptt_copy.n_bytes;
 143         t->is_deleted = 0;
 144         t->serial_number = 0;
 145         t->seq_number = ptt_copy.seq_number;
 146
 147         /* Do extra header info stuff */
 148         if (ptt_copy.chunk_id & EXTRA_HEADER_INFO_FLAG) {
 149                 t->chunk_id = 0;
 150                 t->n_bytes = 0;
 151
 152                 t->extra_available = 1;
 153                 t->extra_parent_id = ptt_copy.chunk_id & (~(ALL_EXTRA_FLAGS));
 154                 t->extra_is_shrink = ptt_copy.chunk_id & EXTRA_SHRINK_FLAG ? 1 : 0;
 155                 t->extra_shadows = ptt_copy.chunk_id & EXTRA_SHADOWS_FLAG ? 1 : 0;
 156                 t->extra_obj_type = ptt_copy.obj_id >> EXTRA_OBJECT_TYPE_SHIFT;
 157                 t->obj_id &= ~EXTRA_OBJECT_TYPE_MASK;
 158
 159                 if (t->extra_obj_type == YAFFS_OBJECT_TYPE_HARDLINK)
 160                         t->extra_equiv_id = ptt_copy.n_bytes;
 161                 else
 162                         t->extra_file_size = ptt_copy.n_bytes;
 163         }
 164         yaffs_dump_packed_tags2_tags_only(ptt_ptr);
 165         yaffs_dump_tags2(t);
 166 }
 167
 168 void yaffs_unpack_tags2(struct yaffs_dev *dev,
 169                         struct yaffs_ext_tags *t,
 170                         struct yaffs_packed_tags2 *pt,
 171                         int tags_ecc)
 172 {
 173         enum yaffs_ecc_result ecc_result = YAFFS_ECC_RESULT_NO_ERROR;
 174
 175         if (pt->t.seq_number != 0xffffffff && tags_ecc) {
 176                 /* Chunk is in use and we need to do ECC */
 177
 178                 struct yaffs_ecc_other ecc;
 179                 int result;
 180                 yaffs_ecc_calc_other((unsigned char *)&pt->t,
 181                                 sizeof(struct yaffs_packed_tags2_tags_only),
 182                                 &ecc);
 183                 result =
 184                     yaffs_ecc_correct_other((unsigned char *)&pt->t,
 185                                 sizeof(struct yaffs_packed_tags2_tags_only),
 186                                 &pt->ecc, &ecc);
 187                 switch (result) {
 188                 case 0:
 189                         ecc_result = YAFFS_ECC_RESULT_NO_ERROR;
 190                         break;
 191                 case 1:
 192                         ecc_result = YAFFS_ECC_RESULT_FIXED;
 193                         break;
 194                 case -1:
 195                         ecc_result = YAFFS_ECC_RESULT_UNFIXED;
 196                         break;
 197                 default:
 198                         ecc_result = YAFFS_ECC_RESULT_UNKNOWN;
 199                 }
 200         }
 201         yaffs_unpack_tags2_tags_only(dev, t, &pt->t);
 202
 203         t->ecc_result = ecc_result;
 204
 205         yaffs_dump_packed_tags2(pt);
 206         yaffs_dump_tags2(t);
 207 }