OSDN Git Service

Rename real_size to valid_size and add comment about this field.
[android-x86/external-exfat.git] / libexfat / node.c
index 7367f19..8dd946f 100644 (file)
@@ -44,27 +44,47 @@ struct exfat_node* exfat_get_node(struct exfat_node* node)
 
 void exfat_put_node(struct exfat* ef, struct exfat_node* node)
 {
-       if (--node->references < 0)
+       char buffer[UTF8_BYTES(EXFAT_NAME_MAX) + 1];
+
+       --node->references;
+       if (node->references < 0)
        {
-               char buffer[UTF8_BYTES(EXFAT_NAME_MAX) + 1];
                exfat_get_name(node, buffer, sizeof(buffer) - 1);
-               exfat_bug("reference counter of `%s' is below zero", buffer);
+               exfat_bug("reference counter of '%s' is below zero", buffer);
        }
-
-       if (node->references == 0)
+       else if (node->references == 0 && node != ef->root)
        {
-               exfat_flush_node(ef, node);
-               if (node->flags & EXFAT_ATTRIB_UNLINKED)
+               if (node->flags & EXFAT_ATTRIB_DIRTY)
                {
-                       /* free all clusters and node structure itself */
-                       exfat_truncate(ef, node, 0, true);
-                       free(node);
+                       exfat_get_name(node, buffer, sizeof(buffer) - 1);
+                       exfat_warn("dirty node '%s' with zero references", buffer);
                }
-               exfat_flush(ef);
        }
 }
 
 /**
+ * This function must be called on rmdir and unlink (after the last
+ * exfat_put_node()) to free clusters.
+ */
+int exfat_cleanup_node(struct exfat* ef, struct exfat_node* node)
+{
+       int rc = 0;
+
+       if (node->references != 0)
+               exfat_bug("unable to cleanup a node with %d references",
+                               node->references);
+
+       if (node->flags & EXFAT_ATTRIB_UNLINKED)
+       {
+               /* free all clusters and node structure itself */
+               rc = exfat_truncate(ef, node, 0, true);
+               /* free the node even in case of error or its memory will be lost */
+               free(node);
+       }
+       return rc;
+}
+
+/**
  * Cluster + offset from the beginning of the directory to absolute offset.
  */
 static off_t co2o(struct exfat* ef, cluster_t cluster, off_t offset)
@@ -173,6 +193,40 @@ static const struct exfat_entry* get_entry_ptr(const struct exfat* ef,
                        (it->chunk + it->offset % CLUSTER_SIZE(*ef->sb));
 }
 
+static bool check_node(const struct exfat_node* node, uint16_t actual_checksum,
+               uint16_t reference_checksum, uint64_t valid_size)
+{
+       char buffer[UTF8_BYTES(EXFAT_NAME_MAX) + 1];
+
+       /*
+          Validate checksum first. If it's invalid all other fields probably
+          contain just garbage.
+       */
+       if (actual_checksum != reference_checksum)
+       {
+               exfat_get_name(node, buffer, sizeof(buffer) - 1);
+               exfat_error("'%s' has invalid checksum (%#hx != %#hx)", buffer,
+                               actual_checksum, reference_checksum);
+               return false;
+       }
+
+       /*
+          exFAT does not support sparse files but allows files with uninitialized
+          clusters. For such files valid_size means initialized data size and
+          cannot be greater than file size. See SetFileValidData() function
+          description in MSDN.
+       */
+       if (valid_size > node->size)
+       {
+               exfat_get_name(node, buffer, sizeof(buffer) - 1);
+               exfat_error("'%s' has valid size (%"PRIu64") greater than size "
+                               "(%"PRIu64")", buffer, valid_size, node->size);
+               return false;
+       }
+
+       return true;
+}
+
 /*
  * Reads one entry in directory at position pointed by iterator and fills
  * node structure.
@@ -192,7 +246,7 @@ static int readdir(struct exfat* ef, const struct exfat_node* parent,
        le16_t* namep = NULL;
        uint16_t reference_checksum = 0;
        uint16_t actual_checksum = 0;
-       uint64_t real_size = 0;
+       uint64_t valid_size = 0;
 
        *node = NULL;
 
@@ -263,7 +317,7 @@ static int readdir(struct exfat* ef, const struct exfat_node* parent,
                        }
                        init_node_meta2(*node, meta2);
                        actual_checksum = exfat_add_checksum(entry, actual_checksum);
-                       real_size = le64_to_cpu(meta2->real_size);
+                       valid_size = le64_to_cpu(meta2->valid_size);
                        /* empty files must be marked as non-contiguous */
                        if ((*node)->size == 0 && (meta2->flags & EXFAT_FLAG_CONTIGUOUS))
                        {
@@ -298,36 +352,9 @@ static int readdir(struct exfat* ef, const struct exfat_node* parent,
                        namep += EXFAT_ENAME_MAX;
                        if (--continuations == 0)
                        {
-                               /*
-                                  There are two fields that contain file size. Maybe they
-                                  plan to add compression support in the future and one of
-                                  those fields is visible (uncompressed) size and the other
-                                  is real (compressed) size. Anyway, currently it looks like
-                                  exFAT does not support compression and both fields must be
-                                  equal.
-
-                                  There is an exception though: pagefile.sys (its real_size
-                                  is always 0).
-                               */
-                               if (real_size != (*node)->size)
-                               {
-                                       char buffer[UTF8_BYTES(EXFAT_NAME_MAX) + 1];
-
-                                       exfat_get_name(*node, buffer, sizeof(buffer) - 1);
-                                       exfat_error("`%s' real size does not equal to size "
-                                                       "(%"PRIu64" != %"PRIu64")", buffer,
-                                                       real_size, (*node)->size);
-                                       goto error;
-                               }
-                               if (actual_checksum != reference_checksum)
-                               {
-                                       char buffer[UTF8_BYTES(EXFAT_NAME_MAX) + 1];
-
-                                       exfat_get_name(*node, buffer, sizeof(buffer) - 1);
-                                       exfat_error("`%s' has invalid checksum (0x%hx != 0x%hx)",
-                                                       buffer, actual_checksum, reference_checksum);
+                               if (!check_node(*node, actual_checksum, reference_checksum,
+                                               valid_size))
                                        goto error;
-                               }
                                if (fetch_next_entry(ef, parent, it) != 0)
                                        goto error;
                                return 0; /* entry completed */
@@ -516,6 +543,8 @@ static void tree_detach(struct exfat_node* node)
 
 static void reset_cache(struct exfat* ef, struct exfat_node* node)
 {
+       char buffer[UTF8_BYTES(EXFAT_NAME_MAX) + 1];
+
        while (node->child)
        {
                struct exfat_node* p = node->child;
@@ -526,11 +555,15 @@ static void reset_cache(struct exfat* ef, struct exfat_node* node)
        node->flags &= ~EXFAT_ATTRIB_CACHED;
        if (node->references != 0)
        {
-               char buffer[UTF8_BYTES(EXFAT_NAME_MAX) + 1];
                exfat_get_name(node, buffer, sizeof(buffer) - 1);
-               exfat_warn("non-zero reference counter (%d) for `%s'",
+               exfat_warn("non-zero reference counter (%d) for '%s'",
                                node->references, buffer);
        }
+       if (node != ef->root && (node->flags & EXFAT_ATTRIB_DIRTY))
+       {
+               exfat_get_name(node, buffer, sizeof(buffer) - 1);
+               exfat_bug("node '%s' is dirty", buffer);
+       }
        while (node->references)
                exfat_put_node(ef, node);
 }
@@ -540,16 +573,24 @@ void exfat_reset_cache(struct exfat* ef)
        reset_cache(ef, ef->root);
 }
 
-static void next_entry(struct exfat* ef, const struct exfat_node* parent,
+static bool next_entry(struct exfat* ef, const struct exfat_node* parent,
                cluster_t* cluster, off_t* offset)
 {
        *offset += sizeof(struct exfat_entry);
        if (*offset % CLUSTER_SIZE(*ef->sb) == 0)
-               /* next cluster cannot be invalid */
+       {
                *cluster = exfat_next_cluster(ef, parent, *cluster);
+               if (CLUSTER_INVALID(*cluster))
+               {
+                       exfat_error("invalid cluster %#x while getting next entry",
+                                       *cluster);
+                       return false;
+               }
+       }
+       return true;
 }
 
-void exfat_flush_node(struct exfat* ef, struct exfat_node* node)
+int exfat_flush_node(struct exfat* ef, struct exfat_node* node)
 {
        cluster_t cluster;
        off_t offset;
@@ -558,35 +599,40 @@ void exfat_flush_node(struct exfat* ef, struct exfat_node* node)
        struct exfat_entry_meta2 meta2;
 
        if (!(node->flags & EXFAT_ATTRIB_DIRTY))
-               return; /* no need to flush */
+               return 0; /* no need to flush */
 
        if (ef->ro)
                exfat_bug("unable to flush node to read-only FS");
 
        if (node->parent == NULL)
-               return; /* do not flush unlinked node */
+               return 0; /* do not flush unlinked node */
 
        cluster = node->entry_cluster;
        offset = node->entry_offset;
        meta1_offset = co2o(ef, cluster, offset);
-       next_entry(ef, node->parent, &cluster, &offset);
+       if (!next_entry(ef, node->parent, &cluster, &offset))
+               return -EIO;
        meta2_offset = co2o(ef, cluster, offset);
 
-       /* FIXME handle I/O error */
        if (exfat_pread(ef->dev, &meta1, sizeof(meta1), meta1_offset) < 0)
-               exfat_bug("failed to read meta1 entry on flush");
+       {
+               exfat_error("failed to read meta1 entry on flush");
+               return -EIO;
+       }
        if (meta1.type != EXFAT_ENTRY_FILE)
                exfat_bug("invalid type of meta1: 0x%hhx", meta1.type);
        meta1.attrib = cpu_to_le16(node->flags);
        exfat_unix2exfat(node->mtime, &meta1.mdate, &meta1.mtime, &meta1.mtime_cs);
        exfat_unix2exfat(node->atime, &meta1.adate, &meta1.atime, NULL);
 
-       /* FIXME handle I/O error */
        if (exfat_pread(ef->dev, &meta2, sizeof(meta2), meta2_offset) < 0)
-               exfat_bug("failed to read meta2 entry on flush");
+       {
+               exfat_error("failed to read meta2 entry on flush");
+               return -EIO;
+       }
        if (meta2.type != EXFAT_ENTRY_FILE_INFO)
                exfat_bug("invalid type of meta2: 0x%hhx", meta2.type);
-       meta2.size = meta2.real_size = cpu_to_le64(node->size);
+       meta2.size = meta2.valid_size = cpu_to_le64(node->size);
        meta2.start_cluster = cpu_to_le32(node->start_cluster);
        meta2.flags = EXFAT_FLAG_ALWAYS1;
        /* empty files must not be marked as contiguous */
@@ -596,17 +642,22 @@ void exfat_flush_node(struct exfat* ef, struct exfat_node* node)
 
        meta1.checksum = exfat_calc_checksum(&meta1, &meta2, node->name);
 
-       /* FIXME handle I/O error */
        if (exfat_pwrite(ef->dev, &meta1, sizeof(meta1), meta1_offset) < 0)
-               exfat_bug("failed to write meta1 entry on flush");
-       /* FIXME handle I/O error */
+       {
+               exfat_error("failed to write meta1 entry on flush");
+               return -EIO;
+       }
        if (exfat_pwrite(ef->dev, &meta2, sizeof(meta2), meta2_offset) < 0)
-               exfat_bug("failed to write meta2 entry on flush");
+       {
+               exfat_error("failed to write meta2 entry on flush");
+               return -EIO;
+       }
 
        node->flags &= ~EXFAT_ATTRIB_DIRTY;
+       return 0;
 }
 
-static void erase_entry(struct exfat* ef, struct exfat_node* node)
+static bool erase_entry(struct exfat* ef, struct exfat_node* node)
 {
        cluster_t cluster = node->entry_cluster;
        off_t offset = node->entry_offset;
@@ -614,25 +665,34 @@ static void erase_entry(struct exfat* ef, struct exfat_node* node)
        uint8_t entry_type;
 
        entry_type = EXFAT_ENTRY_FILE & ~EXFAT_ENTRY_VALID;
-       /* FIXME handle I/O error */
        if (exfat_pwrite(ef->dev, &entry_type, 1, co2o(ef, cluster, offset)) < 0)
-               exfat_bug("failed to erase meta1 entry");
+       {
+               exfat_error("failed to erase meta1 entry");
+               return false;
+       }
 
-       next_entry(ef, node->parent, &cluster, &offset);
+       if (!next_entry(ef, node->parent, &cluster, &offset))
+               return false;
        entry_type = EXFAT_ENTRY_FILE_INFO & ~EXFAT_ENTRY_VALID;
-       /* FIXME handle I/O error */
        if (exfat_pwrite(ef->dev, &entry_type, 1, co2o(ef, cluster, offset)) < 0)
-               exfat_bug("failed to erase meta2 entry");
+       {
+               exfat_error("failed to erase meta2 entry");
+               return false;
+       }
 
        while (name_entries--)
        {
-               next_entry(ef, node->parent, &cluster, &offset);
+               if (!next_entry(ef, node->parent, &cluster, &offset))
+                       return false;
                entry_type = EXFAT_ENTRY_FILE_NAME & ~EXFAT_ENTRY_VALID;
-               /* FIXME handle I/O error */
                if (exfat_pwrite(ef->dev, &entry_type, 1,
                                co2o(ef, cluster, offset)) < 0)
-                       exfat_bug("failed to erase name entry");
+               {
+                       exfat_error("failed to erase name entry");
+                       return false;
+               }
        }
+       return true;
 }
 
 static int shrink_directory(struct exfat* ef, struct exfat_node* dir,
@@ -642,7 +702,6 @@ static int shrink_directory(struct exfat* ef, struct exfat_node* dir,
        const struct exfat_node* last_node;
        uint64_t entries = 0;
        uint64_t new_size;
-       int rc;
 
        if (!(dir->flags & EXFAT_ATTRIB_DIR))
                exfat_bug("attempted to shrink a file");
@@ -678,10 +737,7 @@ static int shrink_directory(struct exfat* ef, struct exfat_node* dir,
                new_size = CLUSTER_SIZE(*ef->sb);
        if (new_size == dir->size)
                return 0;
-       rc = exfat_truncate(ef, dir, new_size, true);
-       if (rc != 0)
-               return rc;
-       return 0;
+       return exfat_truncate(ef, dir, new_size, true);
 }
 
 static int delete(struct exfat* ef, struct exfat_node* node)
@@ -691,13 +747,23 @@ static int delete(struct exfat* ef, struct exfat_node* node)
        int rc;
 
        exfat_get_node(parent);
-       erase_entry(ef, node);
+       if (!erase_entry(ef, node))
+       {
+               exfat_put_node(ef, parent);
+               return -EIO;
+       }
        exfat_update_mtime(parent);
        tree_detach(node);
        rc = shrink_directory(ef, parent, deleted_offset);
-       exfat_put_node(ef, parent);
-       /* file clusters will be freed when node reference counter becomes 0 */
        node->flags |= EXFAT_ATTRIB_UNLINKED;
+       if (rc != 0)
+       {
+               exfat_flush_node(ef, parent);
+               exfat_put_node(ef, parent);
+               return rc;
+       }
+       rc = exfat_flush_node(ef, parent);
+       exfat_put_node(ef, parent);
        return rc;
 }
 
@@ -710,10 +776,14 @@ int exfat_unlink(struct exfat* ef, struct exfat_node* node)
 
 int exfat_rmdir(struct exfat* ef, struct exfat_node* node)
 {
+       int rc;
+
        if (!(node->flags & EXFAT_ATTRIB_DIR))
                return -ENOTDIR;
        /* check that directory is empty */
-       exfat_cache_directory(ef, node);
+       rc = exfat_cache_directory(ef, node);
+       if (rc != 0)
+               return rc;
        if (node->child)
                return -ENOTEMPTY;
        return delete(ef, node);
@@ -814,7 +884,8 @@ static int write_entry(struct exfat* ef, struct exfat_node* dir,
                exfat_error("failed to write meta1 entry");
                return -EIO;
        }
-       next_entry(ef, dir, &cluster, &offset);
+       if (!next_entry(ef, dir, &cluster, &offset))
+               return -EIO;
        if (exfat_pwrite(ef->dev, &meta2, sizeof(meta2),
                        co2o(ef, cluster, offset)) < 0)
        {
@@ -827,7 +898,8 @@ static int write_entry(struct exfat* ef, struct exfat_node* dir,
                memcpy(name_entry.name, node->name + i * EXFAT_ENAME_MAX,
                                MIN(EXFAT_ENAME_MAX, EXFAT_NAME_MAX - i * EXFAT_ENAME_MAX) *
                                sizeof(le16_t));
-               next_entry(ef, dir, &cluster, &offset);
+               if (!next_entry(ef, dir, &cluster, &offset))
+                       return -EIO;
                if (exfat_pwrite(ef->dev, &name_entry, sizeof(name_entry),
                                co2o(ef, cluster, offset)) < 0)
                {
@@ -871,6 +943,12 @@ static int create(struct exfat* ef, const char* path, uint16_t attrib)
                return rc;
        }
        rc = write_entry(ef, dir, name, cluster, offset, attrib);
+       if (rc != 0)
+       {
+               exfat_put_node(ef, dir);
+               return rc;
+       }
+       rc = exfat_flush_node(ef, dir);
        exfat_put_node(ef, dir);
        return rc;
 }
@@ -899,6 +977,13 @@ int exfat_mkdir(struct exfat* ef, const char* path)
                exfat_put_node(ef, node);
                return rc;
        }
+       rc = exfat_flush_node(ef, node);
+       if (rc != 0)
+       {
+               delete(ef, node);
+               exfat_put_node(ef, node);
+               return rc;
+       }
        exfat_put_node(ef, node);
        return 0;
 }
@@ -921,7 +1006,8 @@ static int rename_entry(struct exfat* ef, struct exfat_node* dir,
                exfat_error("failed to read meta1 entry on rename");
                return -EIO;
        }
-       next_entry(ef, node->parent, &old_cluster, &old_offset);
+       if (!next_entry(ef, node->parent, &old_cluster, &old_offset))
+               return -EIO;
        if (exfat_pread(ef->dev, &meta2, sizeof(meta2),
                        co2o(ef, old_cluster, old_offset)) < 0)
        {
@@ -933,7 +1019,8 @@ static int rename_entry(struct exfat* ef, struct exfat_node* dir,
        meta2.name_length = name_length;
        meta1.checksum = exfat_calc_checksum(&meta1, &meta2, name);
 
-       erase_entry(ef, node);
+       if (!erase_entry(ef, node))
+               return -EIO;
 
        node->entry_cluster = new_cluster;
        node->entry_offset = new_offset;
@@ -944,7 +1031,8 @@ static int rename_entry(struct exfat* ef, struct exfat_node* dir,
                exfat_error("failed to write meta1 entry on rename");
                return -EIO;
        }
-       next_entry(ef, dir, &new_cluster, &new_offset);
+       if (!next_entry(ef, dir, &new_cluster, &new_offset))
+               return -EIO;
        if (exfat_pwrite(ef->dev, &meta2, sizeof(meta2),
                        co2o(ef, new_cluster, new_offset)) < 0)
        {
@@ -957,7 +1045,8 @@ static int rename_entry(struct exfat* ef, struct exfat_node* dir,
                struct exfat_entry_name name_entry = {EXFAT_ENTRY_FILE_NAME, 0};
                memcpy(name_entry.name, name + i * EXFAT_ENAME_MAX,
                                EXFAT_ENAME_MAX * sizeof(le16_t));
-               next_entry(ef, dir, &new_cluster, &new_offset);
+               if (!next_entry(ef, dir, &new_cluster, &new_offset))
+                       return -EIO;
                if (exfat_pwrite(ef->dev, &name_entry, sizeof(name_entry),
                                co2o(ef, new_cluster, new_offset)) < 0)
                {
@@ -1051,7 +1140,7 @@ int exfat_rename(struct exfat* ef, const char* old_path, const char* new_path)
        rc = rename_entry(ef, dir, node, name, cluster, offset);
        exfat_put_node(ef, dir);
        exfat_put_node(ef, node);
-       return 0;
+       return rc;
 }
 
 void exfat_utimes(struct exfat_node* node, const struct timespec tv[2])