Features/QED

Specification

The file format looks like this:

+---------+---------+---------+-----+
| extent0 | extent1 | extent1 | ... |
+---------+---------+---------+-----+

The first extent contains a header. The header contains information about the first data extent. A data extent may be a data cluster, an L2, or an L1 table. L1 and L2 tables are composed of one or more contiguous extents.

Header

Header {
    uint32_t magic;               /* QED\0 */

    uint32_t cluster_size;        /* in bytes */
    uint32_t table_size;          /* table size, in clusters */
    uint32_t first_cluster;       /* in clusters */

    uint64_t features;            /* format feature bits */
    uint64_t compat_features;     /* compat feature bits */
    uint64_t l1_table_offset;     /* L1 table offset, in clusters */
    uint64_t image_size;          /* total image size, in clusters */

    /* if (features & QED_F_BACKING_FILE) */
    uint32_t backing_file_offset; /* in bytes from start of header */
    uint32_t backing_file_size;   /* in bytes */

    /* if (compat_features & QED_CF_BACKING_FORMAT) */
    uint32_t backing_fmt_offset;  /* in bytes from start of header */
    uint32_t backing_fmt_size;    /* in bytes */
}

Extent table

#define TABLE_NOFFSETS (table_size * cluster_size / sizeof(uint64_t))
 
Table {
    uint64_t offsets[TABLE_NOFFSETS];
}

The extent tables are organized as follows:

                   +----------+
                   | L1 table |
                   +----------+
              ,------'  |  '------.
         +----------+   |    +----------+
         | L2 table |  ...   | L2 table |
         +----------+        +----------+
     ,------'  |  '------.
+----------+   |    +----------+
|   Data   |  ...   |   Data   |
+----------+        +----------+

The table_size field allows tables to be multiples of the cluster size. For example, cluster_size=64 KB and table_size=4 results in 256 KB tables.

Operations

Read

1. If L2 table is not present in L1, read from backing image.
2. If data cluster is not present in L2, read from backing image.
3. Otherwise read data from cluster.

Write

1. If L2 table is not present in L1, allocate new cluster and L2. Perform L2 and L1 link after writing data.
2. If data cluster is not present in L2, allocate new cluster. Perform L1 link after writing data.
3. Otherwise overwrite data cluster.

The L2 link should be made after the data is in place on storage. However, when no ordering is enforced the worst case scenario is an L2 link to an unwritten cluster.

The L1 link must be made after the L2 cluster is in place on storage. If the order is reversed then the L1 table may point to a bogus L2 table. (Is this a problem since clusters are allocated at the end of the file?)

Grow

1. If table_size * TABLE_NOFFSETS < new_image_size, fail -EOVERFLOW. The L1 table is not big enough.
2. Write new image_size header field.

Data integrity

Write

Writes that complete before a flush must be stable when the flush completes.

If storage is interrupted (e.g. power outage) then writes in progress may be lost, stable, or partially completed. The storage must not be otherwise corrupted or inaccessible after it is restarted.