/*
Copyright (c) 2005, 2006, 2008, 2012 Rocky Bernstein <rocky@cpan.org>
Copyright (c) 2001-2002 Ben Fennema <bfennema@falcon.csc.calpoly.edu>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/*
* Some portions taken from FreeBSD ecma167-udf.h which states:
* Copyright (c) 2001, 2002 Scott Long <scottl@freebsd.org>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
/*!
* \file ecma_167.h
*
* \brief Definitions based on ECMA-167 3rd edition (June 1997)
* See http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-167.pdf
*/
#ifndef CDIO_ECMA_167_H
#define CDIO_ECMA_167_H 1
#include <cdio/types.h>
/**
Imagine the below enum values as \#define'd values rather than
distinct values of an enum.
*/
typedef enum {
VSD_STD_ID_SIZE = 5, /** Volume Structure Descriptor (ECMA 167r3
2/9.1) */
UDF_REGID_ID_SIZE = 23, /**< See identifier (ECMA 167r3 1/7.4) */
UDF_VOLID_SIZE = 32,
UDF_FID_SIZE = 38,
UDF_VOLSET_ID_SIZE = 128
} ecma_167_enum1_t ;
/** Tag Identifier (ECMA 167r3 3/7.2.1) */
typedef enum {
TAGID_PRI_VOL = 0x0001,
TAGID_ANCHOR = 0x0002,
TAGID_VOL = 0x0003,
TAGID_IMP_VOL = 0x0004,
TAGID_PARTITION = 0x0005,
TAGID_LOGVOL = 0x0006,
TAGID_UNALLOC_SPACE = 0x0007,
TAGID_TERM = 0x0008,
TAGID_LOGVOL_INTEGRITY = 0x0009,
TAGID_FSD = 0x0100,
TAGID_FID = 0x0101,
TAGID_AED = 0x0102,
TAGID_IE = 0x0103,
TAGID_TE = 0x0104,
TAGID_FILE_ENTRY = 0x0105,
TAGID_EAHD = 0x0106,
TAGID_USE = 0x0107,
TAGID_SBD = 0x0108,
TAGID_PIE = 0x0109,
TAGID_EFE = 0x010A,
} tag_id_t ;
/** Character Set Type (ECMA 167r3 1/7.2.1.1) */
typedef enum {
CHARSPEC_TYPE_CS0 = 0x00, /**< Section 1/7.2.2 */
CHARSPEC_TYPE_CS1 = 0x01, /**< Section 1/7.2.3 */
CHARSPEC_TYPE_CS2 = 0x02, /**< Section 1/7.2.4 */
CHARSPEC_TYPE_CS3 = 0x03, /**< Section 1/7.2.5 */
CHARSPEC_TYPE_CS4 = 0x04, /**< Section 1/7.2.6 */
CHARSPEC_TYPE_CS5 = 0x05, /**< Section 1/7.2.7 */
CHARSPEC_TYPE_CS6 = 0x06, /**< Section 1/7.2.8 */
CHARSPEC_TYPE_CS7 = 0x07, /**< Section 1/7.2.9 */
CHARSPEC_TYPE_CS8 = 0x08, /**< Section 1/7.2.10 */
} udf_charspec_enum_t;
typedef uint8_t udf_Uint8_t; /*! Section 1/7/1.1 */
typedef uint16_t udf_Uint16_t; /*! Section 1/7.1.3 */
typedef uint32_t udf_Uint32_t; /*! Section 1/7.1.5 */
typedef uint64_t udf_Uint64_t; /*! Section 1/7.1.7 */
typedef char udf_dstring; /*! Section 1/7.1.12 */
#define UDF_LENGTH_MASK 0x3fffffff
PRAGMA_BEGIN_PACKED
/** Character set specification (ECMA 167r3 1/7.2.1) */
struct udf_charspec_s
{
udf_Uint8_t charset_type;
udf_Uint8_t charset_info[63];
} GNUC_PACKED;
typedef struct udf_charspec_s udf_charspec_t;
/** Timestamp (ECMA 167r3 1/7.3) */
struct udf_timestamp_s
{
udf_Uint16_t type_tz;
udf_Uint16_t year;
udf_Uint8_t month;
udf_Uint8_t day;
udf_Uint8_t hour;
udf_Uint8_t minute;
udf_Uint8_t second;
udf_Uint8_t centiseconds;
udf_Uint8_t hundreds_of_microseconds;
udf_Uint8_t microseconds;
} GNUC_PACKED;
typedef struct udf_timestamp_s udf_timestamp_t;
/** Type and Time Zone (ECMA 167r3 1/7.3.1)
Imagine the below enum values as \#define'd values rather than
distinct values of an enum.
*/
typedef enum {
TIMESTAMP_TYPE_CUT = 0x0000,
TIMESTAMP_TYPE_LOCAL = 0x1000,
TIMESTAMP_TYPE_AGREEMENT = 0x2000,
TIMESTAMP_TYPE_MASK = 0xF000,
TIMESTAMP_TIMEZONE_MASK = 0x0FFF,
} ecma_167_timezone_enum_t ;
#define TIMESTAMP_TYPE_MASK 0xF000
#define TIMESTAMP_TYPE_CUT 0x0000
#define TIMESTAMP_TYPE_LOCAL 0x1000
#define TIMESTAMP_TYPE_AGREEMENT 0x2000
#define TIMESTAMP_TIMEZONE_MASK 0x0FFF
struct udf_id_suffix_s
{
udf_Uint16_t udf_revision;
udf_Uint8_t os_class;
udf_Uint8_t os_identifier;
udf_Uint8_t reserved[4];
} GNUC_PACKED;
typedef struct udf_id_suffix_s udf_id_suffix_t;
/** Entity identifier (ECMA 167r3 1/7.4) */
struct udf_regid_s
{
udf_Uint8_t flags;
udf_Uint8_t id[UDF_REGID_ID_SIZE];
udf_id_suffix_t id_suffix;
} GNUC_PACKED;
typedef struct udf_regid_s udf_regid_t;
/** Flags (ECMA 167r3 1/7.4.1) */
#define ENTITYID_FLAGS_DIRTY 0x00
#define ENTITYID_FLAGS_PROTECTED 0x01
/** Volume Structure Descriptor (ECMA 167r3 2/9.1) */
struct vol_struct_desc_s
{
udf_Uint8_t struct_type;
udf_Uint8_t std_id[VSD_STD_ID_SIZE];
udf_Uint8_t struct_version;
udf_Uint8_t struct_data[2041];
} GNUC_PACKED;
/** Standard Identifier (EMCA 167r2 2/9.1.2) */
#define VSD_STD_ID_NSR02 "NSR02" /* (3/9.1) */
/** Standard Identifier (ECMA 167r3 2/9.1.2) */
/* The below const definitions are to faciltate debugging of the
values #define'd below. */
extern const char VSD_STD_ID_BEA01[sizeof("BEA01")-1];
extern const char VSD_STD_ID_BOOT2[sizeof("BOOT2")-1];
extern const char VSD_STD_ID_CD001[sizeof("CD001")-1];
extern const char VSD_STD_ID_CDW01[sizeof("CDW02")-1];
extern const char VSD_STD_ID_NSR03[sizeof("NSR03")-1];
extern const char VSD_STD_ID_TEA01[sizeof("TEA01")-1];
#define VSD_STD_ID_BEA01 "BEA01" /**< ECMA-167 2/9.2 */
#define VSD_STD_ID_BOOT2 "BOOT2" /**< ECMA-167 2/9.4 */
#define VSD_STD_ID_CD001 "CD001" /**< ECMA-119 */
#define VSD_STD_ID_CDW02 "CDW02" /**< ECMA-168 */
#define VSD_STD_ID_NSR02 "NSR02" /**< ECMA-167, 3/9.1
NOTE: ECMA-167, 2nd edition */
#define VSD_STD_ID_NSR03 "NSR03" /**< ECMA-167 3/9.1 */
#define VSD_STD_ID_TEA01 "TEA01" /**< ECMA-168 2/9.3 */
/** Beginning Extended Area Descriptor (ECMA 167r3 2/9.2) */
struct beginning_extended_area_desc_s
{
udf_Uint8_t struct_type;
udf_Uint8_t std_id[VSD_STD_ID_SIZE];
udf_Uint8_t struct_version;
udf_Uint8_t struct_data[2041];
} GNUC_PACKED;
/** Terminating Extended Area Descriptor (ECMA 167r3 2/9.3) */
struct terminating_extended_area_desc_s
{
udf_Uint8_t struct_type;
udf_Uint8_t std_id[VSD_STD_ID_SIZE];
udf_Uint8_t struct_version;
udf_Uint8_t struct_data[2041];
} GNUC_PACKED;
/** Boot Descriptor (ECMA 167r3 2/9.4) */
struct boot_desc_s
{
udf_Uint8_t struct_type;
udf_Uint8_t std_ident[VSD_STD_ID_SIZE];
udf_Uint8_t struct_version;
udf_Uint8_t reserved1;
udf_regid_t arch_type;
udf_regid_t boot_ident;
udf_Uint32_t bool_ext_location;
udf_Uint32_t bool_ext_length;
udf_Uint64_t load_address;
udf_Uint64_t start_address;
udf_timestamp_t desc_creation_time;
udf_Uint16_t flags;
udf_Uint8_t reserved2[32];
udf_Uint8_t boot_use[1906];
} GNUC_PACKED;
/** Flags (ECMA 167r3 2/9.4.12) */
#define BOOT_FLAGS_ERASE 0x01
/** Extent Descriptor (ECMA 167r3 3/7.1) */
struct udf_extent_ad_s
{
udf_Uint32_t len;
udf_Uint32_t loc;
} GNUC_PACKED;
typedef struct udf_extent_ad_s udf_extent_ad_t;
/** Descriptor Tag (ECMA 167r3 3/7.2) */
struct udf_tag_s
{
udf_Uint16_t id;
udf_Uint16_t desc_version;
udf_Uint8_t cksum;
udf_Uint8_t reserved;
udf_Uint16_t i_serial;
udf_Uint16_t desc_CRC;
udf_Uint16_t desc_CRC_len;
udf_Uint32_t loc;
} GNUC_PACKED;
typedef struct udf_tag_s udf_tag_t;
/** NSR Descriptor (ECMA 167r3 3/9.1) */
struct NSR_desc_s
{
udf_Uint8_t struct_type;
udf_Uint8_t std_id[VSD_STD_ID_SIZE];
udf_Uint8_t struct_version;
udf_Uint8_t reserved;
udf_Uint8_t struct_data[2040];
} GNUC_PACKED;
/** Primary Volume Descriptor (ECMA 167r3 3/10.1) */
struct udf_pvd_s
{
udf_tag_t tag;
udf_Uint32_t vol_desc_seq_num;
udf_Uint32_t primary_vol_desc_num;
udf_dstring vol_ident[UDF_VOLID_SIZE];
udf_Uint16_t vol_seq_num;
udf_Uint16_t max_vol_seqnum;
udf_Uint16_t interchange_lvl;
udf_Uint16_t max_interchange_lvl;
udf_Uint32_t charset_list;
udf_Uint32_t max_charset_list;
udf_dstring volset_id[UDF_VOLSET_ID_SIZE];
udf_charspec_t desc_charset;
udf_charspec_t explanatory_charset;
udf_extent_ad_t vol_abstract;
udf_extent_ad_t vol_copyright;
udf_regid_t app_ident;
udf_timestamp_t recording_time;
udf_regid_t imp_ident;
udf_Uint8_t imp_use[64];
udf_Uint32_t predecessor_vol_desc_seq_location;
udf_Uint16_t flags;
udf_Uint8_t reserved[22];
} GNUC_PACKED;
typedef struct udf_pvd_s udf_pvd_t;
/** Flags (ECMA 167r3 3/10.1.21) */
#define PVD_FLAGS_VSID_COMMON 0x0001
/** Anchor Volume Descriptor Pointer (ECMA 167r3 3/10.2) */
struct anchor_vol_desc_ptr_s
{
udf_tag_t tag;
udf_extent_ad_t main_vol_desc_seq_ext;
udf_extent_ad_t reserve_vol_desc_seq_ext;
udf_Uint8_t reserved[480];
} GNUC_PACKED;
typedef struct anchor_vol_desc_ptr_s anchor_vol_desc_ptr_t;
/** Volume Descriptor Pointer (ECMA 167r3 3/10.3) */
struct vol_desc_ptr_s
{
udf_tag_t tag;
udf_Uint32_t vol_desc_seq_num;
udf_extent_ad_t next_vol_desc_set_ext;
udf_Uint8_t reserved[484];
} GNUC_PACKED;
/** Implementation Use Volume Descriptor (ECMA 167r3 3/10.4) */
struct imp_use_vol_desc_s
{
udf_tag_t tag;
udf_Uint32_t vol_desc_seq_num;
udf_regid_t imp_id;
udf_Uint8_t imp_use[460];
} GNUC_PACKED;
/** Partition Descriptor (ECMA 167r3 3/10.5) */
struct partition_desc_s
{
udf_tag_t tag;
udf_Uint32_t vol_desc_seq_num;
udf_Uint16_t flags;
udf_Uint16_t number; /**< Partition number */
udf_regid_t contents;
udf_Uint8_t contents_use[128];
udf_Uint32_t access_type;
udf_Uint32_t start_loc;
udf_Uint32_t part_len;
udf_regid_t imp_id;
udf_Uint8_t imp_use[128];
udf_Uint8_t reserved[156];
} GNUC_PACKED;
typedef struct partition_desc_s partition_desc_t;
/** Partition Flags (ECMA 167r3 3/10.5.3) */
#define PD_PARTITION_FLAGS_ALLOC 0x0001
/** Partition Contents (ECMA 167r2 3/10.5.3) */
#define PD_PARTITION_CONTENTS_NSR02 "+NSR02"
/** Partition Contents (ECMA 167r3 3/10.5.5) */
#define PD_PARTITION_CONTENTS_FDC01 "+FDC01"
#define PD_PARTITION_CONTENTS_CD001 "+CD001"
#define PD_PARTITION_CONTENTS_CDW02 "+CDW02"
#define PD_PARTITION_CONTENTS_NSR03 "+NSR03"
/** Access Type (ECMA 167r3 3/10.5.7) */
#define PD_ACCESS_TYPE_NONE 0x00000000
#define PD_ACCESS_TYPE_READ_ONLY 0x00000001
#define PD_ACCESS_TYPE_WRITE_ONCE 0x00000002
#define PD_ACCESS_TYPE_REWRITABLE 0x00000003
#define PD_ACCESS_TYPE_OVERWRITABLE 0x00000004
/** Recorded Address (ECMA 167r3 4/7.1) */
struct udf_lb_addr_s
{
udf_Uint32_t lba;
udf_Uint16_t partitionReferenceNum;
} GNUC_PACKED;
typedef struct udf_lb_addr_s udf_lb_addr_t;
/** Short Allocation Descriptor (ECMA 167r3 4/14.14.1) */
struct udf_short_ad_s
{
udf_Uint32_t len;
udf_Uint32_t pos;
} GNUC_PACKED;
typedef struct udf_short_ad_s udf_short_ad_t;
/** Long Allocation Descriptor (ECMA 167r3 4/14.14.2) */
struct udf_long_ad_s
{
udf_Uint32_t len;
udf_lb_addr_t loc;
udf_Uint8_t imp_use[6];
} GNUC_PACKED;
typedef struct udf_long_ad_s udf_long_ad_t;
/** Logical Volume Descriptor (ECMA 167r3 3/10.6) */
struct logical_vol_desc_s
{
udf_tag_t tag;
udf_Uint32_t seq_num;
udf_charspec_t desc_charset;
udf_dstring logvol_id[128];
udf_Uint32_t logical_blocksize;
udf_regid_t domain_id;
union {
udf_long_ad_t fsd_loc;
udf_Uint8_t logvol_content_use[16];
} lvd_use;
udf_Uint8_t logvol_contents_use[16];
udf_Uint32_t maptable_len;
udf_Uint32_t i_partition_maps;
udf_regid_t imp_id;
udf_Uint8_t imp_use[128];
udf_extent_ad_t integrity_seq_ext;
udf_Uint8_t partition_maps[0];
} GNUC_PACKED;
typedef struct logical_vol_desc_s logical_vol_desc_t;
/** Generic Partition Map (ECMA 167r3 3/10.7.1) */
struct generic_partition_map
{
udf_Uint8_t partition_map_type;
udf_Uint8_t partition_map_length;
udf_Uint8_t partition_mapping[0];
} GNUC_PACKED;
/** Partition Map Type (ECMA 167r3 3/10.7.1.1) */
#define GP_PARTITION_MAP_TYPE_UNDEF 0x00
#define GP_PARTIITON_MAP_TYPE_1 0x01
#define GP_PARTITION_MAP_TYPE_2 0x02
/** Type 1 Partition Map (ECMA 167r3 3/10.7.2) */
struct generic_partition_map1
{
udf_Uint8_t partition_map_type;
udf_Uint8_t partition_map_length;
udf_Uint16_t vol_seq_num;
udf_Uint16_t i_partition;
} GNUC_PACKED;
/** Type 2 Partition Map (ECMA 167r3 3/10.7.3) */
struct generic_partition_map2
{
udf_Uint8_t partition_map_type;
udf_Uint8_t partition_map_length;
udf_Uint8_t partition_id[62];
} GNUC_PACKED;
/** Unallocated Space Descriptor (ECMA 167r3 3/10.8) */
struct unalloc_space_desc_s
{
udf_tag_t tag;
udf_Uint32_t vol_desc_seq_num;
udf_Uint32_t i_alloc_descs;
udf_extent_ad_t allocDescs[0];
} GNUC_PACKED;
/** Terminating Descriptor (ECMA 167r3 3/10.9) */
struct terminating_desc_s
{
udf_tag_t tag;
udf_Uint8_t reserved[496];
} GNUC_PACKED;
/** Logical Volume Integrity Descriptor (ECMA 167r3 3/10.10) */
struct logvol_integrity_desc_s
{
udf_tag_t tag;
udf_timestamp_t recording_time;
udf_Uint32_t integrity_type;
udf_extent_ad_t next_integrity_ext;
udf_Uint8_t logvol_contents_use[32];
udf_Uint32_t i_partitions;
union { /* Same MSVC workaround as with struct udf_fileid_desc_s */
udf_Uint32_t imp_use_len;
struct {
udf_Uint32_t unused;
udf_Uint32_t data[0];
} freespace_table;
struct {
udf_Uint32_t unused;
udf_Uint32_t data[0];
} size_table;
struct {
udf_Uint32_t unused;
udf_Uint32_t data[0];
} imp_use;
} u;
} GNUC_PACKED;
/** Integrity Type (ECMA 167r3 3/10.10.3) */
#define LVID_INTEGRITY_TYPE_OPEN 0x00000000
#define LVID_INTEGRITY_TYPE_CLOSE 0x00000001
/** Extended Allocation Descriptor (ECMA 167r3 4/14.14.3) */
struct udf_ext_ad_s
{
udf_Uint32_t len;
udf_Uint32_t recorded_len;
udf_Uint32_t information_len;
udf_lb_addr_t ext_loc;
} GNUC_PACKED;
typedef struct udf_ext_ad_s udf_ext_ad_t;
/** Descriptor Tag (ECMA 167r3 4/7.2 - See 3/7.2) */
/** Tag Identifier (ECMA 167r3 4/7.2.1) */
/** File Set Descriptor (ECMA 167r3 4/14.1) */
struct udf_fsd_s
{
udf_tag_t tag;
udf_timestamp_t recording_time;
udf_Uint16_t interchange_lvl;
udf_Uint16_t maxInterchange_lvl;
udf_Uint32_t charset_list;
udf_Uint32_t max_charset_list;
udf_Uint32_t fileset_num;
udf_Uint32_t udf_fsd_num;
udf_charspec_t logical_vol_id_charset;
udf_dstring logical_vol_id[128];
udf_charspec_t fileset_charset;
udf_dstring fileSet_id[32];
udf_dstring copyright_file_id[32];
udf_dstring abstract_file_id[32];
udf_long_ad_t root_icb;
udf_regid_t domain_id;
udf_long_ad_t next_ext;
udf_long_ad_t stream_directory_ICB;
udf_Uint8_t reserved[32];
} GNUC_PACKED;
typedef struct udf_fsd_s udf_fsd_t;
/** Partition Header Descriptor (ECMA 167r3 4/14.3) */
struct partition_header_desc_s
{
udf_short_ad_t unalloc_space_table;
udf_short_ad_t unalloc_space_bitmap;
udf_short_ad_t partition_integrity_table;
udf_short_ad_t freed_space_table;
udf_short_ad_t freed_space_bitmap;
udf_Uint8_t reserved[88];
} GNUC_PACKED;
typedef struct partition_header_desc_s partition_header_desc_t;
/** File Identifier Descriptor (ECMA 167r3 4/14.4) */
struct udf_fileid_desc_s
{
udf_tag_t tag;
udf_Uint16_t file_version_num;
udf_Uint8_t file_characteristics;
udf_Uint8_t i_file_id;
udf_long_ad_t icb;
/* MSVC workaround for multiple zero sized arrays
Unlike what is the case with GNU, and against logic, an union of zero
sized arrays in the Microsoft world is not zero bytes but one byte!
Thus, for sizeof() to be consistent across platforms, we must use an
ugly workaround that attaches the union to the last non-zero member. */
union {
udf_Uint16_t i_imp_use;
struct {
udf_Uint16_t unused;
udf_Uint8_t data[0];
} imp_use;
struct {
udf_Uint16_t unused;
udf_Uint8_t data[0];
} file_id;
struct {
udf_Uint16_t unused;
udf_Uint8_t data[0];
} padding;
} u;
} GNUC_PACKED;
typedef struct udf_fileid_desc_s udf_fileid_desc_t;
/** File Characteristics (ECMA 167r3 4/14.4.3)
Imagine the below enumeration values are \#defines to be used in a
bitmask rather than distinct values of an enum.
*/
typedef enum {
UDF_FILE_HIDDEN = (1 << 0),
UDF_FILE_DIRECTORY = (1 << 1),
UDF_FILE_DELETED = (1 << 2),
UDF_FILE_PARENT = (1 << 3),
UDF_FILE_METADATA = (1 << 4)
} file_characteristics_t;
/** Allocation Ext Descriptor (ECMA 167r3 4/14.5) */
struct allocExtDesc
{
udf_tag_t tag;
udf_Uint32_t previous_alloc_ext_loc;
udf_Uint32_t i_alloc_descs;
} GNUC_PACKED;
/** ICB Tag (ECMA 167r3 4/14.6) */
struct udf_icbtag_s
{
udf_Uint32_t prev_num_dirs;
udf_Uint16_t strat_type;
udf_Uint16_t strat_param;
udf_Uint16_t max_num_entries;
udf_Uint8_t reserved;
udf_Uint8_t file_type;
udf_lb_addr_t parent_ICB;
udf_Uint16_t flags;
} GNUC_PACKED;
typedef struct udf_icbtag_s udf_icbtag_t;
#define UDF_ICB_TAG_FLAGS_SETUID 0x40
#define UDF_ICB_TAG_FLAGS_SETGID 0x80
#define UDF_ICB_TAG_FLAGS_STICKY 0x100
/** Strategy Type (ECMA 167r3 4/14.6.2) which helpfully points
largely to 4/A.x */
#define ICBTAG_STRATEGY_TYPE_UNDEF 0x0000
#define ICBTAG_STRATEGY_TYPE_1 0x0001 /**< 4/A.2 Direct entries Uint16 */
#define ICBTAG_STRATEGY_TYPE_2 0x0002 /**< 4/A.3 List of ICB direct entries */
#define ICBTAG_STRATEGY_TYPE_3 0x0003 /**< 4/A.4 */
#define ICBTAG_STRATEGY_TYPE_4 0x0004 /**< 4/A.5 Hierarchy having one
single ICB with one direct entry.
This is what's most often used.
*/
/** File Type (ECMA 167r3 4/14.6.6)
Imagine the below enum values as \#define'd values rather than
distinct values of an enum.
*/
typedef enum {
ICBTAG_FILE_TYPE_UNDEF = 0x00,
ICBTAG_FILE_TYPE_USE = 0x01,
ICBTAG_FILE_TYPE_PIE = 0x02,
ICBTAG_FILE_TYPE_IE = 0x03,
ICBTAG_FILE_TYPE_DIRECTORY = 0x04,
ICBTAG_FILE_TYPE_REGULAR = 0x05,
ICBTAG_FILE_TYPE_BLOCK = 0x06,
ICBTAG_FILE_TYPE_CHAR = 0x07,
ICBTAG_FILE_TYPE_EA = 0x08,
ICBTAG_FILE_TYPE_FIFO = 0x09,
ICBTAG_FILE_TYPE_SOCKET = 0x0A,
ICBTAG_FILE_TYPE_TE = 0x0B,
ICBTAG_FILE_TYPE_SYMLINK = 0x0C,
ICBTAG_FILE_TYPE_STREAMDIR = 0x0D
} icbtag_file_type_enum_t;
/** Flags (ECMA 167r3 4/14.6.8) */
typedef enum {
ICBTAG_FLAG_AD_MASK = 0x0007, /**< "&" this to get below address
flags */
ICBTAG_FLAG_AD_SHORT = 0x0000, /**< The allocation descriptor
field is filled with
short_ad's. If the
offset is beyond the
current extent, look for
the next extent. */
ICBTAG_FLAG_AD_LONG = 0x0001, /**< The allocation descriptor
field is filled with
long_ad's If the offset
is beyond the current
extent, look for the next
extent. */
ICBTAG_FLAG_AD_EXTENDED = 0x0002,
ICBTAG_FLAG_AD_IN_ICB = 0x0003, /**< This type means that the
file *data* is stored in
the allocation descriptor
field of the file entry. */
ICBTAG_FLAG_SORTED = 0x0008,
ICBTAG_FLAG_NONRELOCATABLE = 0x0010,
ICBTAG_FLAG_ARCHIVE = 0x0020,
ICBTAG_FLAG_SETUID = 0x0040,
ICBTAG_FLAG_SETGID = 0x0080,
ICBTAG_FLAG_STICKY = 0x0100,
ICBTAG_FLAG_CONTIGUOUS = 0x0200,
ICBTAG_FLAG_SYSTEM = 0x0400,
ICBTAG_FLAG_TRANSFORMED = 0x0800,
ICBTAG_FLAG_MULTIVERSIONS = 0x1000,
ICBTAG_FLAG_STREAM = 0x2000
} icbtag_flag_enum_t;
/** Indirect Entry (ECMA 167r3 4/14.7) */
struct indirect_entry_s
{
udf_tag_t tag;
udf_icbtag_t icb_tag;
udf_long_ad_t indirect_ICB;
} GNUC_PACKED;
/** Terminal Entry (ECMA 167r3 4/14.8) */
struct terminal_entry_s
{
udf_tag_t tag;
udf_icbtag_t icb_tag;
} GNUC_PACKED;
/** File Entry (ECMA 167r3 4/14.9) */
struct udf_file_entry_s
{
udf_tag_t tag;
udf_icbtag_t icb_tag; /**< 4/14.9.2 */
udf_Uint32_t uid; /**< 4/14.9.3 */
udf_Uint32_t gid; /**< 4/14.9.4 */
udf_Uint32_t permissions; /**< 4/14.9.5 */
udf_Uint16_t link_count; /**< 4/14.9.6 */
udf_Uint8_t rec_format; /**< 4/14.9.7 */
udf_Uint8_t rec_disp_attr; /**< 4/14.9.8 */
udf_Uint32_t rec_len; /**< 4/14.9.9 */
udf_Uint64_t info_len; /**< 4/14.9.10 */
udf_Uint64_t logblks_recorded; /**< 4/14.9.11 */
udf_timestamp_t access_time; /**< 4/14.9.12 - last access to
any stream of file prior to
recording file entry */
udf_timestamp_t modification_time; /**< 4/14.9.13 - last access to
modification to any stream of
file */
udf_timestamp_t attribute_time;
udf_Uint32_t checkpoint;
udf_long_ad_t ext_attr_ICB;
udf_regid_t imp_id;
udf_Uint64_t unique_ID;
udf_Uint32_t i_extended_attr;
udf_Uint32_t i_alloc_descs;
/* The following union allows file entry reuse without worrying
about overflows, by ensuring the struct is always the
maximum possible size allowed by the specs: one UDF block. */
union {
udf_Uint8_t ext_attr[0];
udf_Uint8_t alloc_descs[0];
udf_Uint8_t pad_to_one_block[2048-176];
} u;
} GNUC_PACKED;
typedef struct udf_file_entry_s udf_file_entry_t;
#define UDF_FENTRY_SIZE 176
#define UDF_FENTRY_PERM_USER_MASK 0x07
#define UDF_FENTRY_PERM_GRP_MASK 0xE0
#define UDF_FENTRY_PERM_OWNER_MASK 0x1C00
/** Permissions (ECMA 167r3 4/14.9.5) */
#define FE_PERM_O_EXEC 0x00000001U
#define FE_PERM_O_WRITE 0x00000002U
#define FE_PERM_O_READ 0x00000004U
#define FE_PERM_O_CHATTR 0x00000008U
#define FE_PERM_O_DELETE 0x00000010U
#define FE_PERM_G_EXEC 0x00000020U
#define FE_PERM_G_WRITE 0x00000040U
#define FE_PERM_G_READ 0x00000080U
#define FE_PERM_G_CHATTR 0x00000100U
#define FE_PERM_G_DELETE 0x00000200U
#define FE_PERM_U_EXEC 0x00000400U
#define FE_PERM_U_WRITE 0x00000800U
#define FE_PERM_U_READ 0x00001000U
#define FE_PERM_U_CHATTR 0x00002000U
#define FE_PERM_U_DELETE 0x00004000U
/** Record Format (ECMA 167r3 4/14.9.7) */
#define FE_RECORD_FMT_UNDEF 0x00
#define FE_RECORD_FMT_FIXED_PAD 0x01
#define FE_RECORD_FMT_FIXED 0x02
#define FE_RECORD_FMT_VARIABLE8 0x03
#define FE_RECORD_FMT_VARIABLE16 0x04
#define FE_RECORD_FMT_VARIABLE16_MSB 0x05
#define FE_RECORD_FMT_VARIABLE32 0x06
#define FE_RECORD_FMT_PRINT 0x07
#define FE_RECORD_FMT_LF 0x08
#define FE_RECORD_FMT_CR 0x09
#define FE_RECORD_FMT_CRLF 0x0A
#define FE_RECORD_FMT_LFCR 0x0B
/** Record Display Attributes (ECMA 167r3 4/14.9.8) */
#define FE_RECORD_DISPLAY_ATTR_UNDEF 0x00
#define FE_RECORD_DISPLAY_ATTR_1 0x01
#define FE_RECORD_DISPLAY_ATTR_2 0x02
#define FE_RECORD_DISPLAY_ATTR_3 0x03
/** Extended Attribute Header Descriptor (ECMA 167r3 4/14.10.1) */
struct extended_attr_header_desc_s
{
udf_tag_t tag;
udf_Uint32_t imp_attr_location;
udf_Uint32_t app_attr_location;
} GNUC_PACKED;
/** Generic Format (ECMA 167r3 4/14.10.2) */
struct generic_format_s
{
udf_Uint32_t attr_type;
udf_Uint8_t attr_subtype;
udf_Uint8_t reserved[3];
udf_Uint32_t attrLength;
udf_Uint8_t attrData[0];
} GNUC_PACKED;
/** Character Set Information (ECMA 167r3 4/14.10.3) */
struct charSet_info_s
{
udf_Uint32_t attr_type;
udf_Uint8_t attr_subtype;
udf_Uint8_t reserved[3];
udf_Uint32_t attrLength;
udf_Uint32_t escapeSeqLength;
udf_Uint8_t charSetType;
udf_Uint8_t escapeSeq[0];
} GNUC_PACKED;
/* Alternate Permissions (ECMA 167r3 4/14.10.4) */
struct alt_perms_s
{
udf_Uint32_t attr_type;
udf_Uint8_t attr_subtype;
udf_Uint8_t reserved[3];
udf_Uint32_t attrLength;
udf_Uint16_t owner_id;
udf_Uint16_t group_id;
udf_Uint16_t permission;
} GNUC_PACKED;
/** File Times Extended Attribute (ECMA 167r3 4/14.10.5) */
struct filetimes_ext_attr_s
{
udf_Uint32_t attr_type;
udf_Uint8_t attr_subtype;
udf_Uint8_t reserved[3];
udf_Uint32_t attrLength;
udf_Uint32_t dataLength;
udf_Uint32_t fileTimeExistence;
udf_Uint8_t fileTimes;
} GNUC_PACKED;
/** FileTimeExistence (ECMA 167r3 4/14.10.5.6) */
#define FTE_CREATION 0x00000001
#define FTE_DELETION 0x00000004
#define FTE_EFFECTIVE 0x00000008
#define FTE_BACKUP 0x00000002
/** Information Times Extended Attribute (ECMA 167r3 4/14.10.6) */
struct infoTimesExtAttr
{
udf_Uint32_t attr_type;
udf_Uint8_t attr_subtype;
udf_Uint8_t reserved[3];
udf_Uint32_t attrLength;
udf_Uint32_t dataLength;
udf_Uint32_t infoTimeExistence;
udf_Uint8_t infoTimes[0];
} GNUC_PACKED;
/** Device Specification (ECMA 167r3 4/14.10.7) */
struct deviceSpec
{
udf_Uint32_t attr_type;
udf_Uint8_t attr_subtype;
udf_Uint8_t reserved[3];
udf_Uint32_t attrLength;
udf_Uint32_t imp_useLength;
udf_Uint32_t majorDevice_id;
udf_Uint32_t minorDevice_id;
udf_Uint8_t imp_use[0];
} GNUC_PACKED;
/** Implementation Use Extended Attr (ECMA 167r3 4/14.10.8) */
struct impUseExtAttr
{
udf_Uint32_t attr_type;
udf_Uint8_t attr_subtype;
udf_Uint8_t reserved[3];
udf_Uint32_t attrLength;
udf_Uint32_t imp_useLength;
udf_regid_t imp_id;
udf_Uint8_t imp_use[0];
} GNUC_PACKED;
/** Application Use Extended Attribute (ECMA 167r3 4/14.10.9) */
struct appUseExtAttr
{
udf_Uint32_t attr_type;
udf_Uint8_t attr_subtype;
udf_Uint8_t reserved[3];
udf_Uint32_t attrLength;
udf_Uint32_t appUseLength;
udf_regid_t app_id;
udf_Uint8_t appUse[0];
} GNUC_PACKED;
#define EXTATTR_CHAR_SET 1
#define EXTATTR_ALT_PERMS 3
#define EXTATTR_FILE_TIMES 5
#define EXTATTR_INFO_TIMES 6
#define EXTATTR_DEV_SPEC 12
#define EXTATTR_IMP_USE 2048
#define EXTATTR_APP_USE 65536
/** Unallocated Space Entry (ECMA 167r3 4/14.11) */
struct unallocSpaceEntry
{
udf_tag_t tag;
udf_icbtag_t icb_tag;
udf_Uint32_t lengthAllocDescs;
udf_Uint8_t allocDescs[0];
} GNUC_PACKED;
/** Space Bitmap Descriptor (ECMA 167r3 4/14.12) */
struct spaceBitmapDesc
{
udf_tag_t tag;
udf_Uint32_t i_bits;
udf_Uint32_t i_bytes;
udf_Uint8_t bitmap[0];
} GNUC_PACKED;
/** Partition Integrity Entry (ECMA 167r3 4/14.13) */
struct partitionIntegrityEntry
{
udf_tag_t tag;
udf_icbtag_t icb_tag;
udf_timestamp_t recording_time;
udf_Uint8_t integrityType;
udf_Uint8_t reserved[175];
udf_regid_t imp_id;
udf_Uint8_t imp_use[256];
} GNUC_PACKED;
/** Short Allocation Descriptor (ECMA 167r3 4/14.14.1) */
/** Extent Length (ECMA 167r3 4/14.14.1.1) */
#define EXT_RECORDED_ALLOCATED 0x00000000
#define EXT_NOT_RECORDED_ALLOCATED 0x40000000
#define EXT_NOT_RECORDED_NOT_ALLOCATED 0x80000000
#define EXT_NEXT_EXTENT_ALLOCDECS 0xC0000000
/** Long Allocation Descriptor (ECMA 167r3 4/14.14.2) */
/** Extended Allocation Descriptor (ECMA 167r3 4/14.14.3) */
/** Logical Volume Header Descriptor (ECMA 167r3 4/14.15) */
struct logical_vol_header_desc_s
{
udf_Uint64_t uniqueID;
udf_Uint8_t reserved[24];
} GNUC_PACKED;
typedef struct logical_vol_header_desc_s logical_vol_header_desc_t;
/** Path Component (ECMA 167r3 4/14.16.1) */
struct pathComponent
{
udf_Uint8_t component_type;
udf_Uint8_t lengthComponent_id;
udf_Uint16_t componentFileVersionNum;
udf_dstring component_id[0];
} GNUC_PACKED;
/** File Entry (ECMA 167r3 4/14.17) */
struct extended_file_entry
{
udf_tag_t tag; /**< 4/14.17.1 - id = 266 */
udf_icbtag_t icb_tag; /**< 4/14.17.2 & 4/14.9.2 */
udf_Uint32_t uid; /**< 4/14.17.3 & 4/14.9.3 */
udf_Uint32_t gid; /**< 4/14.17.4 & 4/14.9.4 */
udf_Uint32_t permissions; /**< 4/14.17.5 & 4/14.9.5 */
udf_Uint16_t link_count; /**< 4/14.17.6 & 4/14.9.6 */
udf_Uint8_t rec_format; /**< 4/14.17.7 & 4/14.9.7 */
udf_Uint8_t rec_display_attr; /**< 4/14.17.8 & 4/14.9.8 */
udf_Uint32_t record_len; /**< 4/14.17.9 & 4/14.9.9 */
udf_Uint64_t info_len; /**< 4/14.17.10 & 4/14.9.10 */
udf_Uint64_t object_size; /**< 4/14.17.11 */
udf_Uint64_t logblks_recorded; /**< 4/14.17.12 & 4/14.9.11 */
udf_timestamp_t access_time; /**< 4/14.17.13 & 4/14.9.12 - last
access to any stream of file */
udf_timestamp_t modification_time; /**< 4/14.17.14 & 4/14.9.13 - last
modification to any stream of
file*/
udf_timestamp_t create_time; /**< 4/14.17.15 */
udf_timestamp_t attribute_time; /**< 4/14.17.16 & 4/14.9.14 -
most recent create or modify
time */
udf_Uint32_t checkpoint;
udf_Uint32_t reserved; /**< #00 bytes */
udf_long_ad_t ext_attr_ICB;
udf_long_ad_t stream_directory_ICB;
udf_regid_t imp_id;
udf_Uint64_t unique_ID;
udf_Uint32_t length_extended_attr;
udf_Uint32_t length_alloc_descs;
union { /* MSVC workaround for multiple zero sized arrays */
udf_Uint8_t ext_attr[0];
udf_Uint8_t alloc_descs[0];
udf_Uint8_t pad_to_one_block[2048-216];
} u;
} GNUC_PACKED;
PRAGMA_END_PACKED
/** The below variables are trickery to force the above enum symbol
values to be recorded in debug symbol tables. They are used to
allow one refer to the enumeration value names in the typedefs
above in a debugger and in debugger expressions.
*/
extern tag_id_t debug_tagid;
extern file_characteristics_t debug_file_characteristics;
extern icbtag_file_type_enum_t debug_icbtag_file_type_enum;
extern icbtag_flag_enum_t debug_flag_enum;
extern ecma_167_enum1_t debug_ecma_167_enum1;
extern ecma_167_timezone_enum_t debug_ecma_167_timezone_enum;
#endif /* CDIO_ECMA_167_H */