libisofs 1.5.6
Data Structures | Macros | Typedefs | Enumerations | Functions | Variables
libisofs.h File Reference
#include <sys/stat.h>
#include <stdlib.h>
#include <fcntl.h>

Go to the source code of this file.

Data Structures

struct  iso_file_section
 File section in an old image. More...
 
struct  iso_data_source
 Data source used by libisofs for reading an existing image. More...
 
struct  iso_filesystem
 An IsoFilesystem is a handler for a source of files, or a "filesystem". More...
 
struct  IsoFileSource_Iface
 Interface definition for an IsoFileSource. More...
 
struct  iso_file_source
 An IsoFile Source is a POSIX abstraction of a file. More...
 
struct  IsoStream_Iface
 Interface definition for IsoStream methods. More...
 
struct  iso_stream
 Representation of file contents as a stream of bytes. More...
 
struct  iso_external_filter_command
 Representation of an external program that shall serve as filter for an IsoStream. More...
 
struct  iso_zisofs_ctrl
 Parameter set for iso_zisofs_set_params(). More...
 
struct  iso_hfsplus_xinfo_data
 HFS+ attributes which may be attached to IsoNode objects as data parameter of iso_node_add_xinfo(). More...
 

Macros

#define iso_lib_header_version_major   1
 The following two functions and three macros are utilities to help ensuring version match of application, compile time header, and runtime library.
 
#define iso_lib_header_version_minor   5
 
#define iso_lib_header_version_micro   6
 
#define ISO_NODE_IS_DIR(n)   (iso_node_get_type(n) == LIBISO_DIR)
 
#define ISO_NODE_IS_FILE(n)   (iso_node_get_type(n) == LIBISO_FILE)
 
#define ISO_NODE_IS_SYMLINK(n)   (iso_node_get_type(n) == LIBISO_SYMLINK)
 
#define ISO_NODE_IS_SPECIAL(n)   (iso_node_get_type(n) == LIBISO_SPECIAL)
 
#define ISO_NODE_IS_BOOTCAT(n)   (iso_node_get_type(n) == LIBISO_BOOT)
 
#define ISO_DIR(n)   ((IsoDir*)(ISO_NODE_IS_DIR(n) ? n : NULL))
 
#define ISO_FILE(n)   ((IsoFile*)(ISO_NODE_IS_FILE(n) ? n : NULL))
 
#define ISO_SYMLINK(n)   ((IsoSymlink*)(ISO_NODE_IS_SYMLINK(n) ? n : NULL))
 
#define ISO_SPECIAL(n)   ((IsoSpecial*)(ISO_NODE_IS_SPECIAL(n) ? n : NULL))
 
#define ISO_NODE(n)   ((IsoNode*)n)
 
#define iso_libjte_req_major   2
 The minimum version of libjte to be used with this version of libisofs at compile time.
 
#define iso_libjte_req_minor   0
 
#define iso_libjte_req_micro   0
 
#define ISO_MAX_SYSAREA_LINE_LENGTH   4096
 The maximum length of a single line in the output of function iso_image_report_system_area() and iso_image_report_el_torito().
 
#define ISO_SYSAREA_REPORT_DOC
 Texts which describe the output format of iso_image_report_system_area().
 
#define ISO_SYSAREA_REPORT_DOC_MBR
 
#define ISO_SYSAREA_REPORT_DOC_GPT1
 
#define ISO_SYSAREA_REPORT_DOC_GPT2
 
#define ISO_SYSAREA_REPORT_DOC_APM
 
#define ISO_SYSAREA_REPORT_DOC_MIPS
 
#define ISO_SYSAREA_REPORT_DOC_SUN
 
#define ISO_SYSAREA_REPORT_DOC_HPPA
 
#define ISO_SYSAREA_REPORT_DOC_ALPHA
 
#define ISO_ELTORITO_REPORT_DOC
 Text which describes the output format of iso_image_report_el_torito().
 
#define LIBISO_MAX_LINK_DEPTH   100
 
#define ISO_MSGS_MESSAGE_LEN   4096
 
#define Libisofs_default_path_maX   4096
 
#define ISO_SUCCESS   1
 successfully execution
 
#define ISO_NONE   0
 special return value, it could be or not an error depending on the context.
 
#define ISO_CANCELED   0xE830FFFF
 Operation canceled (FAILURE,HIGH, -1)
 
#define ISO_FATAL_ERROR   0xF030FFFE
 Unknown or unexpected fatal error (FATAL,HIGH, -2)
 
#define ISO_ERROR   0xE830FFFD
 Unknown or unexpected error (FAILURE,HIGH, -3)
 
#define ISO_ASSERT_FAILURE   0xF030FFFC
 Internal programming error.
 
#define ISO_NULL_POINTER   0xE830FFFB
 NULL pointer as value for an arg.
 
#define ISO_OUT_OF_MEM   0xF030FFFA
 Memory allocation error (FATAL,HIGH, -6)
 
#define ISO_INTERRUPTED   0xF030FFF9
 Interrupted by a signal (FATAL,HIGH, -7)
 
#define ISO_WRONG_ARG_VALUE   0xE830FFF8
 Invalid parameter value (FAILURE,HIGH, -8)
 
#define ISO_THREAD_ERROR   0xF030FFF7
 Can't create a needed thread (FATAL,HIGH, -9)
 
#define ISO_WRITE_ERROR   0xE830FFF6
 Write error (FAILURE,HIGH, -10)
 
#define ISO_BUF_READ_ERROR   0xE830FFF5
 Buffer read error (FAILURE,HIGH, -11)
 
#define ISO_NODE_ALREADY_ADDED   0xE830FFC0
 Trying to add to a dir a node already added to a dir (FAILURE,HIGH, -64)
 
#define ISO_NODE_NAME_NOT_UNIQUE   0xE830FFBF
 Node with same name already exists (FAILURE,HIGH, -65)
 
#define ISO_NODE_NOT_ADDED_TO_DIR   0xE830FFBE
 Trying to remove a node that was not added to dir (FAILURE,HIGH, -65)
 
#define ISO_NODE_DOESNT_EXIST   0xE830FFBD
 A requested node does not exist (FAILURE,HIGH, -66)
 
#define ISO_IMAGE_ALREADY_BOOTABLE   0xE830FFBC
 Try to set the boot image of an already bootable image (FAILURE,HIGH, -67)
 
#define ISO_BOOT_IMAGE_NOT_VALID   0xE830FFBB
 Trying to use an invalid file as boot image (FAILURE,HIGH, -68)
 
#define ISO_BOOT_IMAGE_OVERFLOW   0xE830FFBA
 Too many boot images (FAILURE,HIGH, -69)
 
#define ISO_BOOT_NO_CATALOG   0xE830FFB9
 No boot catalog created yet ((FAILURE,HIGH, -70)
 
#define ISO_FILE_ERROR   0xE830FF80
 Error on file operation (FAILURE,HIGH, -128) (take a look at more specified error codes below)
 
#define ISO_FILE_ALREADY_OPENED   0xE830FF7F
 Trying to open an already opened file (FAILURE,HIGH, -129)
 
#define ISO_FILE_ALREADY_OPENNED   0xE830FF7F
 
#define ISO_FILE_ACCESS_DENIED   0xE830FF7E
 Access to file is not allowed (FAILURE,HIGH, -130)
 
#define ISO_FILE_BAD_PATH   0xE830FF7D
 Incorrect path to file (FAILURE,HIGH, -131)
 
#define ISO_FILE_DOESNT_EXIST   0xE830FF7C
 The file does not exist in the filesystem (FAILURE,HIGH, -132)
 
#define ISO_FILE_NOT_OPENED   0xE830FF7B
 Trying to read or close a file not opened (FAILURE,HIGH, -133)
 
#define ISO_FILE_NOT_OPENNED   ISO_FILE_NOT_OPENED
 
#define ISO_FILE_IS_DIR   0xE830FF7A
 Directory used where no dir is expected (FAILURE,HIGH, -134)
 
#define ISO_FILE_READ_ERROR   0xE830FF79
 Read error (FAILURE,HIGH, -135)
 
#define ISO_FILE_IS_NOT_DIR   0xE830FF78
 Not dir used where a dir is expected (FAILURE,HIGH, -136)
 
#define ISO_FILE_IS_NOT_SYMLINK   0xE830FF77
 Not symlink used where a symlink is expected (FAILURE,HIGH, -137)
 
#define ISO_FILE_SEEK_ERROR   0xE830FF76
 Can't seek to specified location (FAILURE,HIGH, -138)
 
#define ISO_FILE_IGNORED   0xD020FF75
 File not supported in ECMA-119 tree and thus ignored (WARNING,MEDIUM, -139)
 
#define ISO_FILE_TOO_BIG   0xE830FF74
 
#define ISO_FILE_CANT_WRITE   0xE430FF73
 
#define ISO_FILENAME_WRONG_CHARSET   0xD020FF72
 
#define ISO_FILENAME_WRONG_CHARSET_OLD   0xC020FF72
 
#define ISO_FILE_CANT_ADD   0xE030FF71
 
#define ISO_FILE_IMGPATH_WRONG   0xD020FF70
 File path break specification constraints and will be ignored (WARNING,MEDIUM, -144)
 
#define ISO_FILE_OFFSET_TOO_BIG   0xE830FF6A
 Offset greater than file size (FAILURE,HIGH, -150)
 
#define ISO_CHARSET_CONV_ERROR   0xE830FF00
 Charset conversion error (FAILURE,HIGH, -256)
 
#define ISO_MANGLE_TOO_MUCH_FILES   0xE830FEFF
 Too many files to mangle, i.e.
 
#define ISO_WRONG_PVD   0xE830FEC0
 Wrong or damaged Primary Volume Descriptor (FAILURE,HIGH, -320) This could mean that the file is not a valid ISO image.
 
#define ISO_WRONG_RR   0xE030FEBF
 Wrong or damaged RR entry (SORRY,HIGH, -321)
 
#define ISO_UNSUPPORTED_RR   0xE030FEBE
 Unsupported RR feature (SORRY,HIGH, -322)
 
#define ISO_WRONG_ECMA119   0xE830FEBD
 Wrong or damaged ECMA-119 (FAILURE,HIGH, -323)
 
#define ISO_UNSUPPORTED_ECMA119   0xE830FEBC
 Unsupported ECMA-119 feature (FAILURE,HIGH, -324)
 
#define ISO_WRONG_EL_TORITO   0xD030FEBB
 Wrong or damaged El-Torito catalog (WARN,HIGH, -325)
 
#define ISO_UNSUPPORTED_EL_TORITO   0xD030FEBA
 Unsupported El-Torito feature (WARN,HIGH, -326)
 
#define ISO_ISOLINUX_CANT_PATCH   0xE030FEB9
 Can't patch an isolinux boot image (SORRY,HIGH, -327)
 
#define ISO_UNSUPPORTED_SUSP   0xE030FEB8
 Unsupported SUSP feature (SORRY,HIGH, -328)
 
#define ISO_WRONG_RR_WARN   0xD030FEB7
 Error on a RR entry that can be ignored (WARNING,HIGH, -329)
 
#define ISO_SUSP_UNHANDLED   0xC020FEB6
 Error on a RR entry that can be ignored (HINT,MEDIUM, -330)
 
#define ISO_SUSP_MULTIPLE_ER   0xD030FEB5
 Multiple ER SUSP entries found (WARNING,HIGH, -331)
 
#define ISO_UNSUPPORTED_VD   0xC020FEB4
 Unsupported volume descriptor found (HINT,MEDIUM, -332)
 
#define ISO_EL_TORITO_WARN   0xD030FEB3
 El-Torito related warning (WARNING,HIGH, -333)
 
#define ISO_IMAGE_WRITE_CANCELED   0xE430FEB2
 Image write cancelled (MISHAP,HIGH, -334)
 
#define ISO_EL_TORITO_HIDDEN   0xD030FEB1
 El-Torito image is hidden (WARNING,HIGH, -335)
 
#define ISO_AAIP_IGNORED   0xB030FEB0
 AAIP info with ACL or xattr in ISO image will be ignored (NOTE, HIGH, -336)
 
#define ISO_AAIP_BAD_ACL   0xE830FEAF
 Error with decoding ACL from AAIP info (FAILURE, HIGH, -337)
 
#define ISO_AAIP_BAD_ACL_TEXT   0xE830FEAE
 Error with encoding ACL for AAIP (FAILURE, HIGH, -338)
 
#define ISO_AAIP_NOT_ENABLED   0xE830FEAD
 AAIP processing for ACL or xattr not enabled at compile time (FAILURE, HIGH, -339)
 
#define ISO_AAIP_BAD_AASTRING   0xE830FEAC
 Error with decoding AAIP info for ACL or xattr (FAILURE, HIGH, -340)
 
#define ISO_AAIP_NO_GET_LOCAL   0xE830FEAB
 Error with reading ACL or xattr from local file (FAILURE, HIGH, -341)
 
#define ISO_AAIP_NO_GET_LOCAL_S   0xE030FEAB
 Error with reading ACL or xattr from local file (SORRY, HIGH, -341)
 
#define ISO_AAIP_NO_SET_LOCAL   0xE830FEAA
 Error with attaching ACL or xattr to local file (FAILURE, HIGH, -342)
 
#define ISO_AAIP_NO_SET_LOCAL_S   0xE030FEAA
 Error with attaching ACL or xattr to local file (SORRY, HIGH, -342)
 
#define ISO_AAIP_NON_USER_NAME   0xE830FEA9
 Unallowed attempt to set an xattr with non-userspace name (FAILURE, HIGH, -343)
 
#define ISO_EXTF_TOO_OFTEN   0xE830FEA8
 Too many references on a single IsoExternalFilterCommand (FAILURE, HIGH, -344)
 
#define ISO_ZLIB_NOT_ENABLED   0xE830FEA7
 Use of zlib was not enabled at compile time (FAILURE, HIGH, -345)
 
#define ISO_ZISOFS_TOO_LARGE   0xE830FEA6
 File too large.
 
#define ISO_FILTER_WRONG_INPUT   0xE830FEA5
 Filter input differs from previous run (FAILURE, HIGH, -347)
 
#define ISO_ZLIB_COMPR_ERR   0xE830FEA4
 zlib compression/decompression error (FAILURE, HIGH, -348)
 
#define ISO_ZISOFS_WRONG_INPUT   0xE830FEA3
 Input stream is not in a supported zisofs format (FAILURE, HIGH, -349)
 
#define ISO_ZISOFS_PARAM_LOCK   0xE830FEA2
 Cannot set global zisofs parameters while filters exist (FAILURE, HIGH, -350)
 
#define ISO_ZLIB_EARLY_EOF   0xE830FEA1
 Premature EOF of zlib input stream (FAILURE, HIGH, -351)
 
#define ISO_MD5_AREA_CORRUPTED   0xD030FEA0
 Checksum area or checksum tag appear corrupted (WARNING,HIGH, -352)
 
#define ISO_MD5_TAG_MISMATCH   0xE830FE9F
 Checksum mismatch between checksum tag and data blocks (FAILURE, HIGH, -353)
 
#define ISO_SB_TREE_CORRUPTED   0xE830FE9E
 Checksum mismatch in System Area, Volume Descriptors, or directory tree.
 
#define ISO_MD5_TAG_UNEXPECTED   0xD030FE9D
 Unexpected checksum tag type encountered.
 
#define ISO_MD5_TAG_MISPLACED   0xD030FE9C
 Misplaced checksum tag encountered.
 
#define ISO_MD5_TAG_OTHER_RANGE   0xD030FE9B
 Checksum tag with unexpected address range encountered.
 
#define ISO_MD5_STREAM_CHANGE   0xE430FE9A
 Detected file content changes while it was written into the image.
 
#define ISO_SCDBACKUP_TAG_NOT_0   0xD030FE99
 Session does not start at LBA 0.
 
#define ISO_OVWRT_MS_TOO_SMALL   0xE830FE98
 The setting of iso_write_opts_set_ms_block() leaves not enough room for the prescibed size of iso_write_opts_set_overwrite_buf().
 
#define ISO_PART_OFFST_TOO_SMALL   0xE830FE97
 The partition offset is not 0 and leaves not not enough room for system area, volume descriptors, and checksum tags of the first tree.
 
#define ISO_OVWRT_FIFO_TOO_SMALL   0xE830FE96
 The ring buffer is smaller than 64 kB + partition offset.
 
#define ISO_LIBJTE_NOT_ENABLED   0xE830FE95
 Use of libjte was not enabled at compile time (FAILURE, HIGH, -363)
 
#define ISO_LIBJTE_START_FAILED   0xE830FE94
 Failed to start up Jigdo Template Extraction (FAILURE, HIGH, -364)
 
#define ISO_LIBJTE_END_FAILED   0xE830FE93
 Failed to finish Jigdo Template Extraction (FAILURE, HIGH, -365)
 
#define ISO_LIBJTE_FILE_FAILED   0xE430FE92
 Failed to process file for Jigdo Template Extraction (MISHAP, HIGH, -366)
 
#define ISO_BOOT_TOO_MANY_MIPS   0xE830FE91
 Too many MIPS Big Endian boot files given (max.
 
#define ISO_BOOT_FILE_MISSING   0xE430FE90
 Boot file missing in image (MISHAP, HIGH, -368)
 
#define ISO_BAD_PARTITION_NO   0xE830FE8F
 Partition number out of range (FAILURE, HIGH, -369)
 
#define ISO_BAD_PARTITION_FILE   0xE830FE8E
 Cannot open data file for appended partition (FAILURE, HIGH, -370)
 
#define ISO_NON_MBR_SYS_AREA   0xE830FE8D
 May not combine MBR partition with non-MBR system area (FAILURE, HIGH, -371)
 
#define ISO_DISPLACE_ROLLOVER   0xE830FE8C
 Displacement offset leads outside 32 bit range (FAILURE, HIGH, -372)
 
#define ISO_NAME_NEEDS_TRANSL   0xE830FE8B
 File name cannot be written into ECMA-119 untranslated (FAILURE, HIGH, -373)
 
#define ISO_STREAM_NO_CLONE   0xE830FE8A
 Data file input stream object offers no cloning method (FAILURE, HIGH, -374)
 
#define ISO_XINFO_NO_CLONE   0xE830FE89
 Extended information class offers no cloning method (FAILURE, HIGH, -375)
 
#define ISO_MD5_TAG_COPIED   0xD030FE88
 Found copied superblock checksum tag (WARNING, HIGH, -376)
 
#define ISO_RR_NAME_TOO_LONG   0xE830FE87
 Rock Ridge leaf name too long (FAILURE, HIGH, -377)
 
#define ISO_RR_NAME_RESERVED   0xE830FE86
 Reserved Rock Ridge leaf name (FAILURE, HIGH, -378)
 
#define ISO_RR_PATH_TOO_LONG   0xE830FE85
 Rock Ridge path too long (FAILURE, HIGH, -379)
 
#define ISO_AAIP_BAD_ATTR_NAME   0xE830FE84
 Attribute name cannot be represented (FAILURE, HIGH, -380)
 
#define ISO_AAIP_ACL_MULT_OBJ   0xE830FE83
 ACL text contains multiple entries of user::, group::, other:: (FAILURE, HIGH, -381)

 
#define ISO_SECT_SCATTERED   0xE830FE82
 File sections do not form consecutive array of blocks (FAILURE, HIGH, -382)
 
#define ISO_BOOT_TOO_MANY_APM   0xE830FE81
 Too many Apple Partition Map entries requested (FAILURE, HIGH, -383)
 
#define ISO_BOOT_APM_OVERLAP   0xE830FE80
 Overlapping Apple Partition Map entries requested (FAILURE, HIGH, -384)
 
#define ISO_BOOT_TOO_MANY_GPT   0xE830FE7F
 Too many GPT entries requested (FAILURE, HIGH, -385)
 
#define ISO_BOOT_GPT_OVERLAP   0xE830FE7E
 Overlapping GPT entries requested (FAILURE, HIGH, -386)
 
#define ISO_BOOT_TOO_MANY_MBR   0xE830FE7D
 Too many MBR partition entries requested (FAILURE, HIGH, -387)
 
#define ISO_BOOT_MBR_OVERLAP   0xE830FE7C
 Overlapping MBR partition entries requested (FAILURE, HIGH, -388)
 
#define ISO_BOOT_MBR_COLLISION   0xE830FE7B
 Attempt to use an MBR partition entry twice (FAILURE, HIGH, -389)
 
#define ISO_BOOT_NO_EFI_ELTO   0xE830FE7A
 No suitable El Torito EFI boot image for exposure as GPT partition (FAILURE, HIGH, -390)
 
#define ISO_BOOT_HFSP_BAD_BSIZE   0xE830FE79
 Not a supported HFS+ or APM block size (FAILURE, HIGH, -391)
 
#define ISO_BOOT_APM_GPT_BSIZE   0xE830FE78
 APM block size prevents coexistence with GPT (FAILURE, HIGH, -392)
 
#define ISO_HFSP_NO_MANGLE   0xE830FE77
 Name collision in HFS+, mangling not possible (FAILURE, HIGH, -393)
 
#define ISO_DEAD_SYMLINK   0xE830FE76
 Symbolic link cannot be resolved (FAILURE, HIGH, -394)
 
#define ISO_DEEP_SYMLINK   0xE830FE75
 Too many chained symbolic links (FAILURE, HIGH, -395)
 
#define ISO_BAD_ISO_FILETYPE   0xE830FE74
 Unrecognized file type in ISO image (FAILURE, HIGH, -396)
 
#define ISO_NAME_NOT_UCS2   0xD030FE73
 Filename not suitable for character set UCS-2 (WARNING, HIGH, -397)
 
#define ISO_IMPORT_COLLISION   0xD030FE72
 File name collision during ISO image import (WARNING, HIGH, -398)
 
#define ISO_HPPA_PALO_INCOMPL   0xE830FE71
 Incomplete HP-PA PALO boot parameters (FAILURE, HIGH, -399)
 
#define ISO_HPPA_PALO_OFLOW   0xE830FE70
 HP-PA PALO boot address exceeds 2 GB (FAILURE, HIGH, -400)
 
#define ISO_HPPA_PALO_NOTREG   0xE830FE6F
 HP-PA PALO file is not a data file (FAILURE, HIGH, -401)
 
#define ISO_HPPA_PALO_CMDLEN   0xE830FE6E
 HP-PA PALO command line too long (FAILURE, HIGH, -402)
 
#define ISO_SYSAREA_PROBLEMS   0xD030FE6D
 Problems encountered during inspection of System Area (WARN, HIGH, -403)
 
#define ISO_INQ_SYSAREA_PROP   0xE830FE6C
 Unrecognized inquiry for system area property (FAILURE, HIGH, -404)
 
#define ISO_ALPHA_BOOT_NOTREG   0xE830FE6B
 DEC Alpha Boot Loader file is not a data file (FAILURE, HIGH, -405)
 
#define ISO_NO_KEPT_DATA_SRC   0xD030FE6A
 No data source of imported ISO image available (WARNING, HIGH, -406)
 
#define ISO_MALFORMED_READ_INTVL   0xE830FE69
 Malformed description string for interval reader (FAILURE, HIGH, -407)
 
#define ISO_INTVL_READ_PROBLEM   0xD030FE68
 Unreadable file, premature EOF, or failure to seek for interval reader (WARNING, HIGH, -408)
 
#define ISO_NOT_REPRODUCIBLE   0xB030FE67
 Cannot arrange content of data files in surely reproducible way (NOTE, HIGH, -409)
 
#define ISO_PATCH_FILTERED_BOOT   0xE830FE66
 May not write boot info into filtered stream of boot image (FAILURE, HIGH, -410)
 
#define ISO_PATCH_OVERSIZED_BOOT   0xE830FE65
 Boot image to large to buffer for writing boot info (FAILURE, HIGH, -411)
 
#define ISO_RR_NAME_TRUNCATED   0xD030FE64
 File name had to be truncated and MD5 marked (WARNING, HIGH, -412)
 
#define ISO_TRUNCATE_ISOFSNT   0xB030FE63
 File name truncation length changed by loaded image info (NOTE, HIGH, -413)
 
#define ISO_GENERAL_NOTE   0xB030FE62
 General note (NOTE, HIGH, -414)
 
#define ISO_BAD_FSRC_FILETYPE   0xE030FE61
 Unrecognized file type of IsoFileSrc object (SORRY, HIGH, -415)
 
#define ISO_GPT_NO_VOL_UUID   0xE830FE60
 Cannot derive GPT GUID from undefined pseudo-UUID volume timestamp (FAILURE, HIGH, -416)
 
#define ISO_BAD_GPT_GUID_MODE   0xE830FE5F
 Unrecognized GPT disk GUID setup mode (FAILURE, HIGH, -417)
 
#define ISO_NO_ROOT_DIR   0xF030FE5E
 Unable to obtain root directory (FATAL,HIGH, -418)
 
#define ISO_SUSP_WRONG_CE_SIZE   0xE830FE5D
 Zero sized, oversized, or mislocated SUSP CE area found (FAILURE, HIGH, -419)
 
#define ISO_MULTI_OVER_IMPORTED   0xE830FE5C
 Multi-session would overwrite imported_iso interval (FAILURE, HIGH, -420)
 
#define ISO_ELTO_EFI_HIDDEN   0xB030FE5B
 El-Torito EFI image is hidden (NOTE,HIGH, -421)
 
#define ISO_HFSPLUS_TOO_MANY_FILES   0xE830FE5A
 Too many files in HFS+ directory tree (FAILURE, HIGH, -422)
 
#define ISO_ZISOFS_TOO_MANY_PTR   0xE830FE59
 Too many zisofs block pointers needed overall (FAILURE, HIGH, -423)
 
#define ISO_ZISOFS_BPT_UNDERRUN   0xD020FE58
 Prevented zisofs block pointer counter underrun (WARNING,MEDIUM, -424)
 
#define ISO_ZISOFS_UNKNOWN_SIZE   0xE830FE57
 Cannot obtain size of zisofs compressed stream (FAILURE, HIGH, -425)
 
#define ISO_UNDEF_READ_FEATURE   0xE030FE56
 Undefined IsoReadImageFeatures name (SORRY, HIGH, -426)
 
#define ISO_TOO_MANY_CE   0xE830FE55
 Too many CE entries for single file (FAILURE,HIGH, -427)
 
#define ISO_TOO_MANY_CE_FOR_LINUX   0xD030FE54
 Too many CE entries for single file when mounted by Linux (WARNING,HIGH, -428)
 
#define ISO_CE_REMOVING_ATTR   0xD030FE53
 Too many CE entries for single file, omitting attributes (WARNING,HIGH, -429)
 
#define ISO_DATA_SOURCE_SORRY   0xE030FCFF
 Read error occurred with IsoDataSource (SORRY,HIGH, -513)
 
#define ISO_DATA_SOURCE_MISHAP   0xE430FCFF
 Read error occurred with IsoDataSource (MISHAP,HIGH, -513)
 
#define ISO_DATA_SOURCE_FAILURE   0xE830FCFF
 Read error occurred with IsoDataSource (FAILURE,HIGH, -513)
 
#define ISO_DATA_SOURCE_FATAL   0xF030FCFF
 Read error occurred with IsoDataSource (FATAL,HIGH, -513)
 

Typedefs

typedef struct Iso_Image IsoImage
 Context for image creation.
 
typedef struct Iso_Node IsoNode
 
typedef struct Iso_Dir IsoDir
 A directory in the iso tree.
 
typedef struct Iso_Symlink IsoSymlink
 A symbolic link in the iso tree.
 
typedef struct Iso_File IsoFile
 A regular file in the iso tree.
 
typedef struct Iso_Special IsoSpecial
 An special file in the iso tree.
 
typedef struct Iso_Dir_Iter IsoDirIter
 Context for iterate on directory children.
 
typedef struct el_torito_boot_image ElToritoBootImage
 It represents an El-Torito boot image.
 
typedef struct Iso_Boot IsoBoot
 An special type of IsoNode that acts as a placeholder for an El-Torito boot catalog.
 
typedef struct iso_write_opts IsoWriteOpts
 Options for image written.
 
typedef struct iso_read_opts IsoReadOpts
 Options for image reading or import.
 
typedef struct iso_data_source IsoDataSource
 Source for image reading.
 
typedef struct iso_read_image_features IsoReadImageFeatures
 Return information for image.
 
typedef struct iso_file_source IsoFileSource
 POSIX abstraction for source files.
 
typedef struct iso_filesystem IsoFilesystem
 Abstract for source filesystems.
 
typedef struct IsoFileSource_Iface IsoFileSourceIface
 Interface that defines the operations (methods) available for an IsoFileSource.
 
typedef IsoFilesystem IsoImageFilesystem
 IsoFilesystem implementation to deal with ISO images, and to offer a way to access specific information of the image, such as several volume attributes, extensions being used, El-Torito artifacts...
 
typedef struct iso_stream IsoStream
 Representation of file contents.
 
typedef struct IsoStream_Iface IsoStreamIface
 Interface that defines the operations (methods) available for an IsoStream.
 
typedef int(* iso_node_xinfo_func) (void *data, int flag)
 Class of functions to handle particular extended information.
 
typedef int(* iso_node_xinfo_cloner) (void *old_data, void **new_data, int flag)
 Class of functions to clone extended information.
 
typedef struct iso_find_condition IsoFindCondition
 
typedef struct iso_external_filter_command IsoExternalFilterCommand
 

Enumerations

enum  IsoNodeType {
  LIBISO_DIR , LIBISO_FILE , LIBISO_SYMLINK , LIBISO_SPECIAL ,
  LIBISO_BOOT
}
 The type of an IsoNode. More...
 
enum  IsoHideNodeFlag {
  LIBISO_HIDE_ON_RR = 1 << 0 , LIBISO_HIDE_ON_JOLIET = 1 << 1 , LIBISO_HIDE_ON_1999 = 1 << 2 , LIBISO_HIDE_ON_HFSPLUS = 1 << 4 ,
  LIBISO_HIDE_ON_FAT = 1 << 5 , LIBISO_HIDE_BUT_WRITE = 1 << 3
}
 Flag used to hide a file in the RR/ISO or Joliet tree. More...
 
enum  eltorito_boot_media_type { ELTORITO_FLOPPY_EMUL , ELTORITO_HARD_DISC_EMUL , ELTORITO_NO_EMUL }
 El-Torito bootable image type. More...
 
enum  iso_replace_mode {
  ISO_REPLACE_NEVER , ISO_REPLACE_ALWAYS , ISO_REPLACE_IF_SAME_TYPE , ISO_REPLACE_IF_SAME_TYPE_AND_NEWER ,
  ISO_REPLACE_IF_NEWER
}
 Replace mode used when adding a node to a directory. More...
 
enum  iso_find_comparisons {
  ISO_FIND_COND_GREATER , ISO_FIND_COND_GREATER_OR_EQUAL , ISO_FIND_COND_EQUAL , ISO_FIND_COND_LESS ,
  ISO_FIND_COND_LESS_OR_EQUAL
}
 Possible comparison between IsoNode and given conditions. More...
 
enum  IsoHfsplusBlessings {
  ISO_HFSPLUS_BLESS_PPC_BOOTDIR , ISO_HFSPLUS_BLESS_INTEL_BOOTFILE , ISO_HFSPLUS_BLESS_SHOWFOLDER , ISO_HFSPLUS_BLESS_OS9_FOLDER ,
  ISO_HFSPLUS_BLESS_OSX_FOLDER , ISO_HFSPLUS_BLESS_MAX
}
 HFS+ blessings are relationships between HFS+ enhanced ISO images and particular files in such images. More...
 

Functions

void iso_lib_version (int *major, int *minor, int *micro)
 Get version of the libisofs library at runtime.
 
int iso_lib_is_compatible (int major, int minor, int micro)
 Check at runtime if the library is ABI compatible with the given version.
 
int iso_init ()
 Initialize libisofs.
 
int iso_init_with_flag (int flag)
 Initialize libisofs.
 
void iso_finish ()
 Finalize libisofs.
 
int iso_set_local_charset (char *name, int flag)
 Override the reply of libc function nl_langinfo(CODESET) which may or may not give the name of the character set which is in effect for your environment.
 
char * iso_get_local_charset (int flag)
 Obtain the local charset as currently assumed by libisofs.
 
int iso_nowtime (time_t *now, int flag)
 Inquire and maybe define the time which is considered to be "now" and used for timestamps of freshly created ISO nodes and as default of image timestamps.
 
int iso_image_new (const char *name, IsoImage **image)
 Create a new image, empty.
 
void iso_image_set_ignore_aclea (IsoImage *image, int what)
 Control whether ACL and xattr will be imported from external filesystems (typically the local POSIX filesystem) when new nodes get inserted.
 
int iso_image_get_ignore_aclea (IsoImage *image)
 Obtain the current setting of iso_image_set_ignore_aclea().
 
int iso_write_opts_new (IsoWriteOpts **opts, int profile)
 Creates an IsoWriteOpts for writing an image.
 
void iso_write_opts_free (IsoWriteOpts *opts)
 Free an IsoWriteOpts previously allocated with iso_write_opts_new().
 
int iso_write_opts_set_will_cancel (IsoWriteOpts *opts, int will_cancel)
 Announce that only the image size is desired, that the struct burn_source which is set to consume the image output stream will stay inactive, and that the write thread will be cancelled anyway by the .cancel() method of the struct burn_source.
 
int iso_write_opts_set_iso_level (IsoWriteOpts *opts, int level)
 Set the ISO-9960 level to write at.
 
int iso_write_opts_set_rockridge (IsoWriteOpts *opts, int enable)
 Whether to use or not Rock Ridge extensions.
 
int iso_write_opts_set_joliet (IsoWriteOpts *opts, int enable)
 Whether to add the non-standard Joliet extension to the image.
 
int iso_write_opts_set_hfsplus (IsoWriteOpts *opts, int enable)
 Whether to add a HFS+ filesystem to the image which points to the same file content as the other directory trees.
 
int iso_write_opts_set_fat (IsoWriteOpts *opts, int enable)
 

‍Production of FAT32 is not implemented yet.


 
int iso_write_opts_set_hfsp_serial_number (IsoWriteOpts *opts, uint8_t serial_number[8])
 Supply a serial number for the HFS+ extension of the emerging image.
 
int iso_write_opts_set_hfsp_block_size (IsoWriteOpts *opts, int hfsp_block_size, int apm_block_size)
 Set the block size for Apple Partition Map and for HFS+.
 
int iso_write_opts_set_iso1999 (IsoWriteOpts *opts, int enable)
 Whether to use newer ISO-9660:1999 version.
 
int iso_write_opts_set_hardlinks (IsoWriteOpts *opts, int enable)
 Control generation of non-unique inode numbers for the emerging image.
 
int iso_write_opts_set_aaip (IsoWriteOpts *opts, int enable)
 Control writing of AAIP information for ACL and xattr.
 
int iso_write_opts_set_old_empty (IsoWriteOpts *opts, int enable)
 Use this only if you need to reproduce a suboptimal behavior of older versions of libisofs.
 
int iso_write_opts_set_untranslated_name_len (IsoWriteOpts *opts, int len)
 Caution: This option breaks any assumptions about names that are supported by ECMA-119 specifications.
 
int iso_write_opts_set_allow_dir_id_ext (IsoWriteOpts *opts, int allow)
 Convert directory names for ECMA-119 similar to other file names, but do not force a dot or add a version number.
 
int iso_write_opts_set_omit_version_numbers (IsoWriteOpts *opts, int omit)
 Omit the version number (";1") at the end of the ISO-9660 identifiers.
 
int iso_write_opts_set_allow_deep_paths (IsoWriteOpts *opts, int allow)
 Allow ISO-9660 directory hierarchy to be deeper than 8 levels.
 
int iso_write_opts_set_rr_reloc (IsoWriteOpts *opts, char *name, int flags)
 This call describes the directory where to store Rock Ridge relocated directories.
 
int iso_write_opts_set_allow_longer_paths (IsoWriteOpts *opts, int allow)
 Allow path in the ISO-9660 tree to have more than 255 characters.
 
int iso_write_opts_set_max_37_char_filenames (IsoWriteOpts *opts, int allow)
 Allow a single file or directory identifier to have up to 37 characters.
 
int iso_write_opts_set_no_force_dots (IsoWriteOpts *opts, int no)
 ISO-9660 forces filenames to have a ".", that separates file name from extension.
 
int iso_write_opts_set_allow_lowercase (IsoWriteOpts *opts, int allow)
 Allow lowercase characters in ISO-9660 filenames.
 
int iso_write_opts_set_allow_full_ascii (IsoWriteOpts *opts, int allow)
 Allow all 8-bit characters to appear on an ISO-9660 filename.
 
int iso_write_opts_set_allow_7bit_ascii (IsoWriteOpts *opts, int allow)
 If not iso_write_opts_set_allow_full_ascii() is set to 1: Allow all 7-bit characters that would be allowed by allow_full_ascii, but map lowercase to uppercase if iso_write_opts_set_allow_lowercase() is not set to 1.
 
int iso_write_opts_set_relaxed_vol_atts (IsoWriteOpts *opts, int allow)
 Allow all characters to be part of Volume and Volset identifiers on the Primary Volume Descriptor.
 
int iso_write_opts_set_joliet_longer_paths (IsoWriteOpts *opts, int allow)
 Allow paths in the Joliet tree to have more than 240 characters.
 
int iso_write_opts_set_joliet_long_names (IsoWriteOpts *opts, int allow)
 Allow leaf names in the Joliet tree to have up to 103 characters.
 
int iso_write_opts_set_joliet_utf16 (IsoWriteOpts *opts, int allow)
 Use character set UTF-16BE with Joliet, which is a superset of the actually prescribed character set UCS-2.
 
int iso_write_opts_set_rrip_version_1_10 (IsoWriteOpts *opts, int oldvers)
 Write Rock Ridge info as of specification RRIP-1.10 rather than RRIP-1.12: signature "RRIP_1991A" rather than "IEEE_1282", field PX without file serial number.
 
int iso_write_opts_set_rrip_1_10_px_ino (IsoWriteOpts *opts, int enable)
 Write field PX with file serial number (i.e.
 
int iso_write_opts_set_aaip_susp_1_10 (IsoWriteOpts *opts, int oldvers)
 Write AAIP as extension according to SUSP 1.10 rather than SUSP 1.12.
 
int iso_write_opts_set_dir_rec_mtime (IsoWriteOpts *opts, int allow)
 Store as ECMA-119 Directory Record timestamp the mtime of the source node rather than the image creation time.
 
int iso_write_opts_set_sort_files (IsoWriteOpts *opts, int sort)
 Whether to sort files based on their weight.
 
int iso_write_opts_set_record_md5 (IsoWriteOpts *opts, int session, int files)
 Whether to compute and record MD5 checksums for the whole session and/or for each single IsoFile object.
 
int iso_write_opts_set_scdbackup_tag (IsoWriteOpts *opts, char *name, char *timestamp, char *tag_written)
 Set the parameters "name" and "timestamp" for a scdbackup checksum tag.
 
int iso_write_opts_set_replace_mode (IsoWriteOpts *opts, int dir_mode, int file_mode, int uid, int gid)
 Whether to set default values for files and directory permissions, gid and uid.
 
int iso_write_opts_set_default_dir_mode (IsoWriteOpts *opts, mode_t dir_mode)
 Set the mode to use on dirs when you set the replace_mode of dirs to 2.
 
int iso_write_opts_set_default_file_mode (IsoWriteOpts *opts, mode_t file_mode)
 Set the mode to use on files when you set the replace_mode of files to 2.
 
int iso_write_opts_set_default_uid (IsoWriteOpts *opts, uid_t uid)
 Set the uid to use when you set the replace_uid to 2.
 
int iso_write_opts_set_default_gid (IsoWriteOpts *opts, gid_t gid)
 Set the gid to use when you set the replace_gid to 2.
 
int iso_write_opts_set_replace_timestamps (IsoWriteOpts *opts, int replace)
 0 to use IsoNode timestamps, 1 to use recording time, 2 to use values from timestamp field.
 
int iso_write_opts_set_default_timestamp (IsoWriteOpts *opts, time_t timestamp)
 Set the timestamp to use when you set the replace_timestamps to 2.
 
int iso_write_opts_set_always_gmt (IsoWriteOpts *opts, int gmt)
 Whether to always record timestamps in GMT.
 
int iso_write_opts_set_output_charset (IsoWriteOpts *opts, const char *charset)
 Set the charset to use for the RR names of the files that will be created on the image.
 
int iso_write_opts_set_appendable (IsoWriteOpts *opts, int append)
 Set the type of image creation in case there was already an existing image imported.
 
int iso_write_opts_set_ms_block (IsoWriteOpts *opts, uint32_t ms_block)
 Set the start block of the image.
 
int iso_write_opts_set_overwrite_buf (IsoWriteOpts *opts, uint8_t *overwrite)
 Sets the buffer where to store the descriptors which shall be written at the beginning of an overwritable media to point to the newly written image.
 
int iso_write_opts_set_fifo_size (IsoWriteOpts *opts, size_t fifo_size)
 Set the size, in number of blocks, of the ring buffer used between the writer thread and the burn_source.
 
int iso_write_opts_set_system_area (IsoWriteOpts *opts, char data[32768], int options, int flag)
 
int iso_write_opts_set_disc_label (IsoWriteOpts *opts, char *label)
 Set a name for the system area.
 
int iso_write_opts_set_pvd_times (IsoWriteOpts *opts, time_t vol_creation_time, time_t vol_modification_time, time_t vol_expiration_time, time_t vol_effective_time, char *vol_uuid)
 Explicitly set the four timestamps of the emerging Primary Volume Descriptor and in the volume descriptors of Joliet and ISO 9660:1999, if those are to be generated.
 
int iso_write_opts_set_part_offset (IsoWriteOpts *opts, uint32_t block_offset_2k, int secs_512_per_head, int heads_per_cyl)
 
int iso_write_opts_attach_jte (IsoWriteOpts *opts, void *libjte_handle)
 Associate a libjte environment object to the upcoming write run.
 
int iso_write_opts_detach_jte (IsoWriteOpts *opts, void **libjte_handle)
 Remove eventual association to a libjte environment handle.
 
int iso_write_opts_set_tail_blocks (IsoWriteOpts *opts, uint32_t num_blocks)
 Cause a number of blocks with zero bytes to be written after the payload data, but before the eventual checksum data.
 
int iso_interval_reader_new (IsoImage *img, char *path, struct iso_interval_reader **ivr, off_t *byte_count, int flag)
 Create an interval reader object.
 
int iso_interval_reader_destroy (struct iso_interval_reader **ivr, int flag)
 Dispose an interval reader object.
 
int iso_interval_reader_read (struct iso_interval_reader *ivr, uint8_t *buf, int *buf_fill, int flag)
 Read the next block of 2048 bytes from an interval reader object.
 
int iso_write_opts_set_prep_img (IsoWriteOpts *opts, char *image_path, int flag)
 Copy a data file from the local filesystem into the emerging ISO image.
 
int iso_write_opts_set_efi_bootp (IsoWriteOpts *opts, char *image_path, int flag)
 Copy a data file from the local filesystem into the emerging ISO image.
 
int iso_write_opts_set_gpt_guid (IsoWriteOpts *opts, uint8_t guid[16], int mode)
 Control whether the emerging GPT gets a pseudo-randomly generated disk GUID or whether it gets a user supplied GUID.
 
int iso_write_opts_set_max_ce_entries (IsoWriteOpts *opts, uint32_t num, int flag)
 Set the maximum number of SUSP CE entries and thus continuation areas.
 
void iso_generate_gpt_guid (uint8_t guid[16])
 Generate a pseudo-random GUID suitable for iso_write_opts_set_gpt_guid().
 
int iso_write_opts_set_partition_img (IsoWriteOpts *opts, int partition_number, uint8_t partition_type, char *image_path, int flag)
 Cause an arbitrary data file to be appended to the ISO image and to be described by a partition table entry in an MBR or SUN Disk Label at the start of the ISO image.
 
int iso_write_opts_set_appended_as_gpt (IsoWriteOpts *opts, int gpt)
 Control whether partitions created by iso_write_opts_set_partition_img() are to be represented in MBR or as GPT partitions.
 
int iso_write_opts_set_part_type_guid (IsoWriteOpts *opts, int partition_number, uint8_t guid[16], int valid)
 Set the GPT Type GUID for a partition defined by iso_write_opts_set_partition_img().
 
int iso_write_opts_set_appended_as_apm (IsoWriteOpts *opts, int apm)
 Control whether partitions created by iso_write_opts_set_partition_img() are to be represented in Apple Partition Map.
 
int iso_write_opts_set_part_like_isohybrid (IsoWriteOpts *opts, int alike)
 Control whether bits 2 to 8 of el_torito_set_isolinux_options() shall apply even if not isohybrid MBR patching is enabled (bit1 of parameter options of iso_write_opts_set_system_area()):
 
int iso_write_opts_set_iso_mbr_part_type (IsoWriteOpts *opts, int part_type)
 Set the partition type of the MBR partition which represents the ISO filesystem or at least protects it.
 
int iso_write_opts_set_iso_type_guid (IsoWriteOpts *opts, uint8_t guid[16], int valid)
 Set the GPT Type GUID for the partition which represents the ISO 9660 filesystem, if such a partition emerges in GPT.
 
int iso_write_opts_get_data_start (IsoWriteOpts *opts, uint32_t *data_start, int flag)
 Inquire the start address of the file data blocks after having used IsoWriteOpts with iso_image_create_burn_source().
 
int iso_image_update_sizes (IsoImage *image)
 Update the sizes of all files added to image.
 
int iso_image_create_burn_source (IsoImage *image, IsoWriteOpts *opts, struct burn_source **burn_src)
 Create a burn_source and a thread which immediately begins to generate the image.
 
int iso_image_generator_is_running (IsoImage *image)
 Inquire whether the image generator thread is still at work.
 
int iso_read_opts_new (IsoReadOpts **opts, int profile)
 Creates an IsoReadOpts for reading an existent image.
 
void iso_read_opts_free (IsoReadOpts *opts)
 Free an IsoReadOpts previously allocated with iso_read_opts_new().
 
int iso_read_opts_set_start_block (IsoReadOpts *opts, uint32_t block)
 Set the block where the image begins.
 
int iso_read_opts_set_no_rockridge (IsoReadOpts *opts, int norr)
 Do not read Rock Ridge extensions.
 
int iso_read_opts_set_no_joliet (IsoReadOpts *opts, int nojoliet)
 Do not read Joliet extensions.
 
int iso_read_opts_set_no_iso1999 (IsoReadOpts *opts, int noiso1999)
 Do not read ISO 9660:1999 enhanced tree.
 
int iso_read_opts_set_no_aaip (IsoReadOpts *opts, int noaaip)
 Control reading of AAIP information about ACL and xattr when loading existing images.
 
int iso_read_opts_set_no_md5 (IsoReadOpts *opts, int no_md5)
 Control reading of an array of MD5 checksums which is eventually stored at the end of a session.
 
int iso_read_opts_set_new_inos (IsoReadOpts *opts, int new_inos)
 Control discarding of eventual inode numbers from existing images.
 
int iso_read_opts_set_preferjoliet (IsoReadOpts *opts, int preferjoliet)
 Whether to prefer Joliet over RR.
 
int iso_read_opts_set_ecma119_map (IsoReadOpts *opts, int ecma119_map)
 How to convert file names if neither Rock Ridge nor Joliet names are present and acceptable.
 
int iso_read_opts_set_joliet_map (IsoReadOpts *opts, int joliet_map)
 How to convert Joliet file names.
 
int iso_read_opts_set_default_uid (IsoReadOpts *opts, uid_t uid)
 Set default uid for files when RR extensions are not present.
 
int iso_read_opts_set_default_gid (IsoReadOpts *opts, gid_t gid)
 Set default gid for files when RR extensions are not present.
 
int iso_read_opts_set_default_permissions (IsoReadOpts *opts, mode_t file_perm, mode_t dir_perm)
 Set default permissions for files when RR extensions are not present.
 
int iso_read_opts_set_input_charset (IsoReadOpts *opts, const char *charset)
 Set the input charset of the file names on the image.
 
int iso_read_opts_auto_input_charset (IsoReadOpts *opts, int mode)
 Enable or disable methods to automatically choose an input charset.
 
int iso_read_opts_load_system_area (IsoReadOpts *opts, int mode)
 Enable or disable loading of the first 32768 bytes of the session.
 
int iso_read_opts_keep_import_src (IsoReadOpts *opts, int mode)
 Control whether to keep a reference to the IsoDataSource object which allows access to the blocks of the imported ISO 9660 filesystem.
 
int iso_image_import (IsoImage *image, IsoDataSource *src, IsoReadOpts *opts, IsoReadImageFeatures **features)
 Import a previous session or image, for growing or modify.
 
int iso_assess_written_features (IsoDataSource *src, IsoReadOpts *opts, IsoReadImageFeatures **features, IsoWriteOpts **write_opts)
 Assess features of the importable directory trees of src and an estimation of the write options which would cause the recognized features.
 
void iso_read_image_features_destroy (IsoReadImageFeatures *f)
 Destroy an IsoReadImageFeatures object obtained with iso_image_import() or iso_assess_written_features().
 
uint32_t iso_read_image_features_get_size (IsoReadImageFeatures *f)
 Get the size (in 2048 byte block) of the image, as reported in the PVM.
 
int iso_read_image_features_has_rockridge (IsoReadImageFeatures *f)
 Whether RockRidge extensions are present in the image imported.
 
int iso_read_image_features_has_joliet (IsoReadImageFeatures *f)
 Whether Joliet extensions are present in the image imported.
 
int iso_read_image_features_has_iso1999 (IsoReadImageFeatures *f)
 Whether the image is recorded according to ISO 9660:1999, i.e.
 
int iso_read_image_features_has_eltorito (IsoReadImageFeatures *f)
 Whether El-Torito boot record is present present in the image imported.
 
int iso_read_image_features_tree_loaded (IsoReadImageFeatures *f)
 Tells what directory tree was loaded: 0= ISO 9660 , 1 = Joliet , 2 = ISO 9660:1999.
 
int iso_read_image_features_rr_loaded (IsoReadImageFeatures *f)
 Tells whether Rock Ridge information was used while loading the tree: 1= yes, 0= no.
 
int iso_read_image_feature_named (IsoReadImageFeatures *f, char *name, char **text, int *type, int64_t *num_value, void **pt_value, size_t *pt_size)
 Get a named feature as text, num_value, or pt_value depending on its type.
 
int iso_read_image_features_text (IsoReadImageFeatures *f, int with_values, char **feature_text)
 Get all validly assessed named features as one single 0-terminated string consisting of single lines for each feature.
 
void iso_image_ref (IsoImage *image)
 Increments the reference counting of the given image.
 
void iso_image_unref (IsoImage *image)
 Decrements the reference counting of the given image.
 
int iso_image_attach_data (IsoImage *image, void *data, void(*give_up)(void *))
 Attach user defined data to the image.
 
void * iso_image_get_attached_data (IsoImage *image)
 The the data previously attached with iso_image_attach_data()
 
int iso_image_set_truncate_mode (IsoImage *img, int mode, int length)
 Set the name truncation mode and the maximum name length for nodes from image importing, creation of new IsoNode objects, and name changing image manipulations.
 
int iso_image_get_truncate_mode (IsoImage *img, int *mode, int *length)
 Inquire the current setting of iso_image_set_truncate_mode().
 
int iso_truncate_leaf_name (int mode, int length, char *name, int flag)
 Immediately apply the given truncate mode and length to the given string.
 
IsoDiriso_image_get_root (const IsoImage *image)
 Get the root directory of the image.
 
void iso_image_set_volset_id (IsoImage *image, const char *volset_id)
 Fill in the volset identifier for a image.
 
const char * iso_image_get_volset_id (const IsoImage *image)
 Get the volset identifier.
 
void iso_image_set_volume_id (IsoImage *image, const char *volume_id)
 Fill in the volume identifier for a image.
 
const char * iso_image_get_volume_id (const IsoImage *image)
 Get the volume identifier.
 
void iso_image_set_publisher_id (IsoImage *image, const char *publisher_id)
 Fill in the publisher for a image.
 
const char * iso_image_get_publisher_id (const IsoImage *image)
 Get the publisher of a image.
 
void iso_image_set_data_preparer_id (IsoImage *image, const char *data_preparer_id)
 Fill in the data preparer for a image.
 
const char * iso_image_get_data_preparer_id (const IsoImage *image)
 Get the data preparer of a image.
 
void iso_image_set_system_id (IsoImage *image, const char *system_id)
 Fill in the system id for a image.
 
const char * iso_image_get_system_id (const IsoImage *image)
 Get the system id of a image.
 
void iso_image_set_application_id (IsoImage *image, const char *application_id)
 Fill in the application id for a image.
 
const char * iso_image_get_application_id (const IsoImage *image)
 Get the application id of a image.
 
void iso_image_set_copyright_file_id (IsoImage *image, const char *copyright_file_id)
 Fill copyright information for the image.
 
const char * iso_image_get_copyright_file_id (const IsoImage *image)
 Get the copyright information of a image.
 
void iso_image_set_abstract_file_id (IsoImage *image, const char *abstract_file_id)
 Fill abstract information for the image.
 
const char * iso_image_get_abstract_file_id (const IsoImage *image)
 Get the abstract information of a image.
 
void iso_image_set_biblio_file_id (IsoImage *image, const char *biblio_file_id)
 Fill biblio information for the image.
 
const char * iso_image_get_biblio_file_id (const IsoImage *image)
 Get the biblio information of a image.
 
void iso_image_set_app_use (IsoImage *image, const char *app_use_data, int count)
 Fill Application Use field of the Primary Volume Descriptor.
 
const char * iso_image_get_app_use (IsoImage *image)
 Get the current setting for the Application Use field of the Primary Volume Descriptor.
 
int iso_image_get_pvd_times (IsoImage *image, char **creation_time, char **modification_time, char **expiration_time, char **effective_time)
 Get the four timestamps from the Primary Volume Descriptor of the imported ISO image.
 
int iso_image_set_boot_image (IsoImage *image, const char *image_path, enum eltorito_boot_media_type type, const char *catalog_path, ElToritoBootImage **boot)
 Create a new set of El-Torito bootable images by adding a boot catalog and the default boot image.
 
int iso_image_add_boot_image (IsoImage *image, const char *image_path, enum eltorito_boot_media_type type, int flag, ElToritoBootImage **boot)
 Add a further boot image to the set of El-Torito bootable images.
 
int iso_image_get_boot_image (IsoImage *image, ElToritoBootImage **boot, IsoFile **imgnode, IsoBoot **catnode)
 Get the El-Torito boot catalog and the default boot image of an ISO image.
 
int iso_image_get_bootcat (IsoImage *image, IsoBoot **catnode, uint32_t *lba, char **content, off_t *size)
 Get detailed information about the boot catalog that was loaded from an ISO image.
 
int iso_image_get_all_boot_imgs (IsoImage *image, int *num_boots, ElToritoBootImage ***boots, IsoFile ***bootnodes, int flag)
 Get all El-Torito boot images of an ISO image.
 
void iso_image_remove_boot_image (IsoImage *image)
 Removes all El-Torito boot images from the ISO image.
 
int iso_image_set_boot_catalog_weight (IsoImage *image, int sort_weight)
 Sets the sort weight of the boot catalog that is attached to an IsoImage.
 
int iso_image_set_boot_catalog_hidden (IsoImage *image, int hide_attrs)
 Hides the boot catalog file from directory trees.
 
int el_torito_get_boot_media_type (ElToritoBootImage *bootimg, enum eltorito_boot_media_type *media_type)
 Get the boot media type as of parameter "type" of iso_image_set_boot_image() or iso_image_add_boot_image().
 
int el_torito_set_boot_platform_id (ElToritoBootImage *bootimg, uint8_t id)
 Sets the platform ID of the boot image.
 
int el_torito_get_boot_platform_id (ElToritoBootImage *bootimg)
 Get the platform ID value.
 
void el_torito_set_load_seg (ElToritoBootImage *bootimg, short segment)
 Sets the load segment for the initial boot image.
 
int el_torito_get_load_seg (ElToritoBootImage *bootimg)
 Get the load segment value.
 
void el_torito_set_load_size (ElToritoBootImage *bootimg, short sectors)
 Sets the number of sectors (512b) to be load at load segment during the initial boot procedure.
 
int el_torito_get_load_size (ElToritoBootImage *bootimg)
 Get the load size.
 
void el_torito_set_full_load (ElToritoBootImage *bootimg, int mode)
 State that the load size shall be the size of the boot image automatically.
 
int el_torito_get_full_load (ElToritoBootImage *bootimg)
 Inquire the setting of el_torito_set_full_load().
 
void el_torito_set_no_bootable (ElToritoBootImage *bootimg)
 Marks the specified boot image as not bootable.
 
int el_torito_get_bootable (ElToritoBootImage *bootimg)
 Get the bootability flag.
 
int el_torito_set_id_string (ElToritoBootImage *bootimg, uint8_t id_string[28])
 Set the id_string of the Validation Entry or Sector Header Entry which will govern the boot image Section Entry in the El Torito Catalog.
 
int el_torito_get_id_string (ElToritoBootImage *bootimg, uint8_t id_string[28])
 Get the id_string as of el_torito_set_id_string().
 
int el_torito_set_selection_crit (ElToritoBootImage *bootimg, uint8_t crit[20])
 Set the Selection Criteria of a boot image.
 
int el_torito_get_selection_crit (ElToritoBootImage *bootimg, uint8_t crit[20])
 Get the Selection Criteria bytes as of el_torito_set_selection_crit().
 
int el_torito_seems_boot_info_table (ElToritoBootImage *bootimg, int flag)
 Makes a guess whether the boot image was patched by a boot information table.
 
int el_torito_set_isolinux_options (ElToritoBootImage *bootimg, int options, int flag)
 Specifies options for ISOLINUX or GRUB boot images.
 
int el_torito_get_isolinux_options (ElToritoBootImage *bootimg, int flag)
 Get the options as of el_torito_set_isolinux_options().
 
void el_torito_patch_isolinux_image (ElToritoBootImage *bootimg)
 Deprecated: Specifies that this image needs to be patched.
 
int iso_image_get_system_area (IsoImage *img, char data[32768], int *options, int flag)
 Obtain a copy of the eventually loaded first 32768 bytes of the imported session, the System Area.
 
int iso_image_report_system_area (IsoImage *image, char ***reply, int *line_count, int flag)
 Obtain an array of texts describing the detected properties of the eventually loaded System Area.
 
int iso_image_report_el_torito (IsoImage *image, char ***reply, int *line_count, int flag)
 Obtain an array of texts describing the detected properties of the eventually loaded El Torito boot information.
 
uint32_t iso_crc32_gpt (unsigned char *data, int count, int flag)
 Compute a CRC number as expected in the GPT main and backup header blocks.
 
int iso_image_add_mips_boot_file (IsoImage *image, char *path, int flag)
 Add a MIPS boot file path to the image.
 
int iso_image_get_mips_boot_files (IsoImage *image, char *paths[15], int flag)
 Obtain the number of added MIPS Big Endian boot files and pointers to their paths in the ISO 9660 Rock Ridge tree.
 
int iso_image_give_up_mips_boot (IsoImage *image, int flag)
 Clear the list of MIPS Big Endian boot file paths.
 
int iso_image_set_sparc_core (IsoImage *img, IsoFile *sparc_core, int flag)
 Designate a data file in the ISO image of which the position and size shall be written after the SUN Disk Label.
 
int iso_image_get_sparc_core (IsoImage *img, IsoFile **sparc_core, int flag)
 Obtain the current setting of iso_image_set_sparc_core().
 
int iso_image_set_hppa_palo (IsoImage *img, char *cmdline, char *bootloader, char *kernel_32, char *kernel_64, char *ramdisk, int flag)
 Define a command line and submit the paths of four mandatory files for production of a HP-PA PALO boot sector for PA-RISC machines.
 
int iso_image_get_hppa_palo (IsoImage *img, char **cmdline, char **bootloader, char **kernel_32, char **kernel_64, char **ramdisk)
 Inquire the current settings of iso_image_set_hppa_palo().
 
int iso_image_set_alpha_boot (IsoImage *img, char *boot_loader_path, int flag)
 Submit the path of the DEC Alpha Secondary Bootstrap Loader file.
 
int iso_image_get_alpha_boot (IsoImage *img, char **boot_loader_path)
 Inquire the path submitted by iso_image_set_alpha_boot() Do not free() the returned pointer.
 
void iso_node_ref (IsoNode *node)
 Increments the reference counting of the given node.
 
void iso_node_unref (IsoNode *node)
 Decrements the reference counting of the given node.
 
enum IsoNodeType iso_node_get_type (IsoNode *node)
 Get the type of an IsoNode.
 
int iso_node_add_xinfo (IsoNode *node, iso_node_xinfo_func proc, void *data)
 Add extended information to the given node.
 
int iso_node_remove_xinfo (IsoNode *node, iso_node_xinfo_func proc)
 Remove the given extended info (defined by the proc function) from the given node.
 
int iso_node_remove_all_xinfo (IsoNode *node, int flag)
 Remove all extended information from the given node.
 
int iso_node_get_xinfo (IsoNode *node, iso_node_xinfo_func proc, void **data)
 Get the given extended info (defined by the proc function) from the given node.
 
int iso_node_get_next_xinfo (IsoNode *node, void **handle, iso_node_xinfo_func *proc, void **data)
 Get the next pair of function pointer and data of an iteration of the list of extended information.
 
int iso_node_xinfo_make_clonable (iso_node_xinfo_func proc, iso_node_xinfo_cloner cloner, int flag)
 Associate a iso_node_xinfo_cloner to a particular class of extended information in order to make it clonable.
 
int iso_node_xinfo_get_cloner (iso_node_xinfo_func proc, iso_node_xinfo_cloner *cloner, int flag)
 Inquire the registered cloner function for a particular class of extended information.
 
int iso_image_set_node_name (IsoImage *image, IsoNode *node, const char *name, int flag)
 Set the name of a node.
 
int iso_node_set_name (IsoNode *node, const char *name)
 
const char * iso_node_get_name (const IsoNode *node)
 Get the name of a node.
 
void iso_node_set_permissions (IsoNode *node, mode_t mode)
 Set the permissions for the node.
 
mode_t iso_node_get_permissions (const IsoNode *node)
 Get the permissions for the node.
 
mode_t iso_node_get_mode (const IsoNode *node)
 Get the mode of the node, both permissions and file type, as specified in 'man 2 stat'.
 
void iso_node_set_uid (IsoNode *node, uid_t uid)
 Set the user id for the node.
 
uid_t iso_node_get_uid (const IsoNode *node)
 Get the user id of the node.
 
void iso_node_set_gid (IsoNode *node, gid_t gid)
 Set the group id for the node.
 
gid_t iso_node_get_gid (const IsoNode *node)
 Get the group id of the node.
 
void iso_node_set_mtime (IsoNode *node, time_t time)
 Set the time of last modification of the file.
 
time_t iso_node_get_mtime (const IsoNode *node)
 Get the time of last modification of the file.
 
void iso_node_set_atime (IsoNode *node, time_t time)
 Set the time of last access to the file.
 
time_t iso_node_get_atime (const IsoNode *node)
 Get the time of last access to the file.
 
void iso_node_set_ctime (IsoNode *node, time_t time)
 Set the time of last status change of the file.
 
time_t iso_node_get_ctime (const IsoNode *node)
 Get the time of last status change of the file.
 
void iso_node_set_hidden (IsoNode *node, int hide_attrs)
 Set whether the node will be hidden in the directory trees of RR/ISO 9660, or of Joliet (if enabled at all), or of ISO-9660:1999 (if enabled at all).
 
int iso_node_get_hidden (IsoNode *node)
 Get the hide_attrs as eventually set by iso_node_set_hidden().
 
int iso_node_cmp_ino (IsoNode *n1, IsoNode *n2, int flag)
 Compare two nodes whether they are based on the same input and can be considered as hardlinks to the same file objects.
 
int iso_dir_add_node (IsoDir *dir, IsoNode *child, enum iso_replace_mode replace)
 Add a new node to a dir.
 
int iso_image_dir_get_node (IsoImage *image, IsoDir *dir, const char *name, IsoNode **node, int flag)
 Locate a node inside a given dir.
 
int iso_dir_get_node (IsoDir *dir, const char *name, IsoNode **node)
 
int iso_dir_get_children_count (IsoDir *dir)
 Get the number of children of a directory.
 
int iso_node_take (IsoNode *node)
 Removes a child from a directory.
 
int iso_node_remove (IsoNode *node)
 Removes a child from a directory and free (unref) it.
 
IsoDiriso_node_get_parent (IsoNode *node)
 
int iso_dir_get_children (const IsoDir *dir, IsoDirIter **iter)
 Get an iterator for the children of the given dir.
 
int iso_dir_iter_next (IsoDirIter *iter, IsoNode **node)
 Get the next child.
 
int iso_dir_iter_has_next (IsoDirIter *iter)
 Check if there're more children.
 
void iso_dir_iter_free (IsoDirIter *iter)
 Free a dir iterator.
 
int iso_dir_iter_take (IsoDirIter *iter)
 Removes a child from a directory during an iteration, without freeing it.
 
int iso_dir_iter_remove (IsoDirIter *iter)
 Removes a child from a directory during an iteration and unref() it.
 
int iso_node_remove_tree (IsoNode *node, IsoDirIter *boss_iter)
 Removes a node by iso_node_remove() or iso_dir_iter_remove().
 
IsoFindConditioniso_new_find_conditions_name (const char *wildcard)
 Create a new condition that checks if the node name matches the given wildcard.
 
IsoFindConditioniso_new_find_conditions_mode (mode_t mask)
 Create a new condition that checks the node mode against a mode mask.
 
IsoFindConditioniso_new_find_conditions_gid (gid_t gid)
 Create a new condition that checks the node gid.
 
IsoFindConditioniso_new_find_conditions_uid (uid_t uid)
 Create a new condition that checks the node uid.
 
IsoFindConditioniso_new_find_conditions_atime (time_t time, enum iso_find_comparisons comparison)
 Create a new condition that checks the time of last access.
 
IsoFindConditioniso_new_find_conditions_mtime (time_t time, enum iso_find_comparisons comparison)
 Create a new condition that checks the time of last modification.
 
IsoFindConditioniso_new_find_conditions_ctime (time_t time, enum iso_find_comparisons comparison)
 Create a new condition that checks the time of last status change.
 
IsoFindConditioniso_new_find_conditions_and (IsoFindCondition *a, IsoFindCondition *b)
 Create a new condition that check if the two given conditions are valid.
 
IsoFindConditioniso_new_find_conditions_or (IsoFindCondition *a, IsoFindCondition *b)
 Create a new condition that check if at least one the two given conditions is valid.
 
IsoFindConditioniso_new_find_conditions_not (IsoFindCondition *negate)
 Create a new condition that check if the given conditions is false.
 
int iso_dir_find_children (IsoDir *dir, IsoFindCondition *cond, IsoDirIter **iter)
 Find all directory children that match the given condition.
 
const char * iso_symlink_get_dest (const IsoSymlink *link)
 Get the destination of a node.
 
int iso_symlink_set_dest (IsoSymlink *link, const char *dest)
 Set the destination of a symbolic.
 
void iso_node_set_sort_weight (IsoNode *node, int w)
 Sets the order in which a node will be written on image.
 
int iso_file_get_sort_weight (IsoFile *file)
 Get the sort weight of a file.
 
off_t iso_file_get_size (IsoFile *file)
 Get the size of the file, in bytes.
 
dev_t iso_special_get_dev (IsoSpecial *special)
 Get the device id (major/minor numbers) of the given block or character device file.
 
IsoStreamiso_file_get_stream (IsoFile *file)
 Get the IsoStream that represents the contents of the given IsoFile.
 
int iso_file_get_old_image_lba (IsoFile *file, uint32_t *lba, int flag)
 Get the block lba of a file node, if it was imported from an old image.
 
int iso_file_get_old_image_sections (IsoFile *file, int *section_count, struct iso_file_section **sections, int flag)
 Get the start addresses and the sizes of the data extents of a file node if it was imported from an old image.
 
int iso_node_get_old_image_lba (IsoNode *node, uint32_t *lba, int flag)
 
int iso_image_add_new_dir (IsoImage *image, IsoDir *parent, const char *name, IsoDir **dir)
 Add a new directory to the iso tree.
 
int iso_tree_add_new_dir (IsoDir *parent, const char *name, IsoDir **dir)
 
int iso_image_add_new_file (IsoImage *image, IsoDir *parent, const char *name, IsoStream *stream, IsoFile **file)
 Add a new regular file to the iso tree.
 
int iso_tree_add_new_file (IsoDir *parent, const char *name, IsoStream *stream, IsoFile **file)
 
int iso_memory_stream_new (unsigned char *buf, size_t size, IsoStream **stream)
 Create an IsoStream object from content which is stored in a dynamically allocated memory buffer.
 
int iso_image_add_new_symlink (IsoImage *image, IsoDir *parent, const char *name, const char *dest, IsoSymlink **link)
 Add a new symbolic link to the directory tree.
 
int iso_tree_add_new_symlink (IsoDir *parent, const char *name, const char *dest, IsoSymlink **link)
 
int iso_image_add_new_special (IsoImage *image, IsoDir *parent, const char *name, mode_t mode, dev_t dev, IsoSpecial **special)
 Add a new special file to the directory tree.
 
int iso_tree_add_new_special (IsoDir *parent, const char *name, mode_t mode, dev_t dev, IsoSpecial **special)
 
void iso_tree_set_follow_symlinks (IsoImage *image, int follow)
 Set whether to follow or not symbolic links when added a file from a source to IsoImage.
 
int iso_tree_get_follow_symlinks (IsoImage *image)
 Get current setting for follow_symlinks.
 
void iso_tree_set_ignore_hidden (IsoImage *image, int skip)
 Set whether to skip or not disk files with names beginning by '.
 
int iso_tree_get_ignore_hidden (IsoImage *image)
 Get current setting for ignore_hidden.
 
void iso_tree_set_replace_mode (IsoImage *image, enum iso_replace_mode mode)
 Set the replace mode, that defines the behavior of libisofs when adding a node whit the same name that an existent one, during a recursive directory addition.
 
enum iso_replace_mode iso_tree_get_replace_mode (IsoImage *image)
 Get current setting for replace_mode.
 
void iso_tree_set_ignore_special (IsoImage *image, int skip)
 Set whether to skip or not special files.
 
int iso_tree_get_ignore_special (IsoImage *image)
 Get current setting for ignore_special.
 
int iso_tree_add_exclude (IsoImage *image, const char *path)
 Add a excluded path.
 
int iso_tree_remove_exclude (IsoImage *image, const char *path)
 Remove a previously added exclude.
 
void iso_tree_set_report_callback (IsoImage *image, int(*report)(IsoImage *, IsoFileSource *))
 Set a callback function that libisofs will call for each file that is added to the given image by a recursive addition function.
 
int iso_tree_add_node (IsoImage *image, IsoDir *parent, const char *path, IsoNode **node)
 Add a new node to the image tree, from an existing file.
 
int iso_tree_add_new_node (IsoImage *image, IsoDir *parent, const char *name, const char *path, IsoNode **node)
 This is a more versatile form of iso_tree_add_node which allows to set the node name in ISO image already when it gets added.
 
int iso_tree_add_new_cut_out_node (IsoImage *image, IsoDir *parent, const char *name, const char *path, off_t offset, off_t size, IsoNode **node)
 Add a new node to the image tree with the given name that must not exist on dir.
 
int iso_image_tree_clone (IsoImage *image, IsoNode *node, IsoDir *new_parent, char *new_name, IsoNode **new_node, int flag)
 Create a copy of the given node under a different path.
 
int iso_tree_clone (IsoNode *node, IsoDir *new_parent, char *new_name, IsoNode **new_node, int flag)
 
int iso_tree_add_dir_rec (IsoImage *image, IsoDir *parent, const char *dir)
 Add the contents of a dir to a given directory of the iso tree.
 
int iso_image_was_blind_attrs (IsoImage *image, int flag)
 Inquire whether some local filesystem xattr namespace could not be explored during node building.This may happen due to lack of administrator privileges e.g.
 
int iso_image_path_to_node (IsoImage *image, const char *path, IsoNode **node)
 Locate a node by its absolute path in the image.
 
int iso_tree_path_to_node (IsoImage *image, const char *path, IsoNode **node)
 
char * iso_tree_get_node_path (IsoNode *node)
 Get the absolute path on image of the given node.
 
int iso_tree_resolve_symlink (IsoImage *img, IsoSymlink *sym, IsoNode **res, int *depth, int flag)
 Get the destination node of a symbolic link within the IsoImage.
 
void iso_data_source_ref (IsoDataSource *src)
 Increments the reference counting of the given IsoDataSource.
 
void iso_data_source_unref (IsoDataSource *src)
 Decrements the reference counting of the given IsoDataSource, freeing it if refcount reach 0.
 
int iso_data_source_new_from_file (const char *path, IsoDataSource **src)
 Create a new IsoDataSource from a local file.
 
int iso_ring_buffer_get_status (struct burn_source *b, size_t *size, size_t *free_bytes)
 Get the status of the buffer used by a burn_source.
 
int iso_set_msgs_severities (char *queue_severity, char *print_severity, char *print_id)
 Control queueing and stderr printing of messages from libisofs.
 
int iso_obtain_msgs (char *minimum_severity, int *error_code, int *imgid, char msg_text[], char severity[])
 Obtain the oldest pending libisofs message from the queue which has at least the given minimum_severity.
 
int iso_msgs_submit (int error_code, char msg_text[], int os_errno, char severity[], int origin)
 Submit a message to the libisofs queueing system.
 
int iso_text_to_sev (char *severity_name, int *severity_number)
 Convert a severity name into a severity number, which gives the severity rank of the name.
 
int iso_sev_to_text (int severity_number, char **severity_name)
 Convert a severity number into a severity name.
 
int iso_image_get_msg_id (IsoImage *image)
 Get the id of an IsoImage, used for message reporting.
 
const char * iso_error_to_msg (int errcode)
 Get a textual description of a libisofs error.
 
int iso_error_get_severity (int e)
 Get the severity of a given error code.
 
int iso_error_get_priority (int e)
 Get the priority of a given error.
 
int iso_error_get_code (int e)
 Get the message queue code of a libisofs error.
 
int iso_set_abort_severity (char *severity)
 Set the minimum error severity that causes a libisofs operation to be aborted as soon as possible.
 
void * iso_get_messenger ()
 Return the messenger object handle used by libisofs.
 
void iso_file_source_ref (IsoFileSource *src)
 Take a ref to the given IsoFileSource.
 
void iso_file_source_unref (IsoFileSource *src)
 Drop your ref to the given IsoFileSource, eventually freeing the associated system resources.
 
char * iso_file_source_get_path (IsoFileSource *src)
 Get the absolute path in the filesystem this file source belongs to.
 
char * iso_file_source_get_name (IsoFileSource *src)
 Get the name of the file, with the dir component of the path.
 
int iso_file_source_lstat (IsoFileSource *src, struct stat *info)
 Get information about the file.
 
int iso_file_source_access (IsoFileSource *src)
 Check if the process has access to read file contents.
 
int iso_file_source_stat (IsoFileSource *src, struct stat *info)
 Get information about the file.
 
int iso_file_source_open (IsoFileSource *src)
 Opens the source.
 
int iso_file_source_close (IsoFileSource *src)
 Close a previously opened file.
 
int iso_file_source_read (IsoFileSource *src, void *buf, size_t count)
 Attempts to read up to count bytes from the given source into the buffer starting at buf.
 
off_t iso_file_source_lseek (IsoFileSource *src, off_t offset, int flag)
 Repositions the offset of the given IsoFileSource (must be opened) to the given offset according to the value of flag.
 
int iso_file_source_readdir (IsoFileSource *src, IsoFileSource **child)
 Read a directory.
 
int iso_file_source_readlink (IsoFileSource *src, char *buf, size_t bufsiz)
 Read the destination of a symlink.
 
int iso_file_source_get_aa_string (IsoFileSource *src, unsigned char **aa_string, int flag)
 Get the AAIP string with encoded ACL and xattr.
 
IsoFilesystemiso_file_source_get_filesystem (IsoFileSource *src)
 Get the filesystem for this source.
 
void iso_filesystem_ref (IsoFilesystem *fs)
 Take a ref to the given IsoFilesystem.
 
void iso_filesystem_unref (IsoFilesystem *fs)
 Drop your ref to the given IsoFilesystem, evetually freeing associated resources.
 
int iso_image_filesystem_new (IsoDataSource *src, IsoReadOpts *opts, int msgid, IsoImageFilesystem **fs)
 Create a new IsoFilesystem to access a existent ISO image.
 
const char * iso_image_fs_get_volset_id (IsoImageFilesystem *fs)
 Get the volset identifier for an existent image.
 
const char * iso_image_fs_get_volume_id (IsoImageFilesystem *fs)
 Get the volume identifier for an existent image.
 
const char * iso_image_fs_get_publisher_id (IsoImageFilesystem *fs)
 Get the publisher identifier for an existent image.
 
const char * iso_image_fs_get_data_preparer_id (IsoImageFilesystem *fs)
 Get the data preparer identifier for an existent image.
 
const char * iso_image_fs_get_system_id (IsoImageFilesystem *fs)
 Get the system identifier for an existent image.
 
const char * iso_image_fs_get_application_id (IsoImageFilesystem *fs)
 Get the application identifier for an existent image.
 
const char * iso_image_fs_get_copyright_file_id (IsoImageFilesystem *fs)
 Get the copyright file identifier for an existent image.
 
const char * iso_image_fs_get_abstract_file_id (IsoImageFilesystem *fs)
 Get the abstract file identifier for an existent image.
 
const char * iso_image_fs_get_biblio_file_id (IsoImageFilesystem *fs)
 Get the biblio file identifier for an existent image.
 
void iso_stream_ref (IsoStream *stream)
 Increment reference count of an IsoStream.
 
void iso_stream_unref (IsoStream *stream)
 Decrement reference count of an IsoStream, and eventually free it if refcount reach 0.
 
int iso_stream_open (IsoStream *stream)
 Opens the given stream.
 
int iso_stream_close (IsoStream *stream)
 Close a previously opened IsoStream.
 
off_t iso_stream_get_size (IsoStream *stream)
 Get the size of a given stream.
 
int iso_stream_read (IsoStream *stream, void *buf, size_t count)
 Attempts to read up to count bytes from the given stream into the buffer starting at buf.
 
int iso_stream_is_repeatable (IsoStream *stream)
 Whether the given IsoStream can be read several times, with the same results.
 
int iso_stream_update_size (IsoStream *stream)
 Updates the size of the IsoStream with the current size of the underlying source.
 
void iso_stream_get_id (IsoStream *stream, unsigned int *fs_id, dev_t *dev_id, ino_t *ino_id)
 Get an unique identifier for a given IsoStream.
 
char * iso_stream_get_source_path (IsoStream *stream, int flag)
 Try to get eventual source path string of a stream.
 
int iso_stream_cmp_ino (IsoStream *s1, IsoStream *s2, int flag)
 Compare two streams whether they are based on the same input and will produce the same output.
 
int iso_stream_clone (IsoStream *old_stream, IsoStream **new_stream, int flag)
 Produce a copy of a stream.
 
int aaip_xinfo_func (void *data, int flag)
 Function to identify and manage AAIP strings as xinfo of IsoNode.
 
int aaip_xinfo_cloner (void *old_data, void **new_data, int flag)
 The iso_node_xinfo_cloner function which gets associated to aaip_xinfo_func by iso_init() or iso_init_with_flag() via iso_node_xinfo_make_clonable().
 
int iso_node_get_acl_text (IsoNode *node, char **access_text, char **default_text, int flag)
 Get the eventual ACLs which are associated with the node.
 
int iso_node_set_acl_text (IsoNode *node, char *access_text, char *default_text, int flag)
 Set the ACLs of the given node to the lists in parameters access_text and default_text or delete them.
 
mode_t iso_node_get_perms_wo_acl (const IsoNode *node)
 Like iso_node_get_permissions but reflecting ACL entry "group::" in S_IRWXG rather than ACL entry "mask::".
 
int iso_node_get_attrs (IsoNode *node, size_t *num_attrs, char ***names, size_t **value_lengths, char ***values, int flag)
 Get the list of xattr which is associated with the node.
 
int iso_node_lookup_attr (IsoNode *node, char *name, size_t *value_length, char **value, int flag)
 Obtain the value of a particular xattr name.
 
int iso_node_set_attrs (IsoNode *node, size_t num_attrs, char **names, size_t *value_lengths, char **values, int flag)
 Set the list of xattr which is associated with the node.
 
int iso_local_attr_support (int flag)
 libisofs has an internal system dependent adapter to ACL and xattr operations.
 
int iso_local_get_acl_text (char *disk_path, char **text, int flag)
 Get an ACL of the given file in the local filesystem in long text form.
 
int iso_local_set_acl_text (char *disk_path, char *text, int flag)
 Set the ACL of the given file in the local filesystem to a given list in long text form.
 
int iso_local_get_perms_wo_acl (char *disk_path, mode_t *st_mode, int flag)
 Obtain permissions of a file in the local filesystem which shall reflect ACL entry "group::" in S_IRWXG rather than ACL entry "mask::".
 
int iso_local_get_attrs (char *disk_path, size_t *num_attrs, char ***names, size_t **value_lengths, char ***values, int flag)
 Get xattr and non-trivial ACLs of the given file in the local filesystem.
 
int iso_local_set_attrs_errno (char *disk_path, size_t num_attrs, char **names, size_t *value_lengths, char **values, int *errnos, int flag)
 Attach a list of xattr and ACLs to the given file in the local filesystem.
 
int iso_local_set_attrs (char *disk_path, size_t num_attrs, char **names, size_t *value_lengths, char **values, int flag)
 Older version of iso_local_set_attrs_errno() without the errnos array.
 
int iso_file_remove_filter (IsoFile *file, int flag)
 Delete the top filter stream from a data file.
 
IsoStreamiso_stream_get_input_stream (IsoStream *stream, int flag)
 Obtain the eventual input stream of a filter stream.
 
int iso_file_add_external_filter (IsoFile *file, IsoExternalFilterCommand *cmd, int flag)
 Install an external filter command on top of the content stream of a data file.
 
int iso_stream_get_external_filter (IsoStream *stream, IsoExternalFilterCommand **cmd, int flag)
 Obtain the IsoExternalFilterCommand which is eventually associated with the given stream.
 
int iso_file_add_zisofs_filter (IsoFile *file, int flag)
 Install a zisofs filter on top of the content stream of a data file.
 
int iso_stream_get_zisofs_par (IsoStream *stream, int *stream_type, uint8_t zisofs_algo[2], uint8_t *algo_num, int *block_size_log2, int flag)
 Obtain the parameters of a zisofs filter stream.
 
int iso_stream_zisofs_discard_bpt (IsoStream *stream, int flag)
 Discard the buffered zisofs compression block pointers of a stream, if the stream is a zisofs compression stream and not currently opened.
 
int iso_image_zisofs_discard_bpt (IsoImage *image, int flag)
 Discard all buffered zisofs compression block pointers of streams in the given image, which are zisofs compression streams and not currently opened.
 
int iso_zisofs_get_refcounts (off_t *ziso_count, off_t *osiz_count, int flag)
 Inquire the number of zisofs compression and uncompression filters which are in use.
 
int iso_zisofs_set_params (struct iso_zisofs_ctrl *params, int flag)
 Set the global parameters for zisofs filtering.
 
int iso_zisofs_get_params (struct iso_zisofs_ctrl *params, int flag)
 Get the current global parameters for zisofs filtering.
 
int iso_zisofs_ctrl_susp_z2 (int enable)
 Enable or disable the production of "Z2" SUSP entries instead of "ZF" entries for zisofs2 compressed files.
 
int iso_node_zf_by_magic (IsoNode *node, int flag)
 Check for the given node or for its subtree whether the data file content effectively bears zisofs file headers and eventually mark the outcome by an xinfo data record if not already marked by a zisofs compressor filter.
 
int iso_file_add_gzip_filter (IsoFile *file, int flag)
 Install a gzip or gunzip filter on top of the content stream of a data file.
 
int iso_gzip_get_refcounts (off_t *gzip_count, off_t *gunzip_count, int flag)
 Inquire the number of gzip compression and uncompression filters which are in use.
 
int iso_image_get_session_md5 (IsoImage *image, uint32_t *start_lba, uint32_t *end_lba, char md5[16], int flag)
 Obtain the recorded MD5 checksum of the session which was loaded as ISO image.
 
int iso_file_get_md5 (IsoImage *image, IsoFile *file, char md5[16], int flag)
 Eventually obtain the recorded MD5 checksum of a data file from the loaded ISO image.
 
int iso_file_make_md5 (IsoFile *file, int flag)
 Read the content of an IsoFile object, compute its MD5 and attach it to the IsoFile.
 
int iso_util_decode_md5_tag (char data[2048], int *tag_type, uint32_t *pos, uint32_t *range_start, uint32_t *range_size, uint32_t *next_tag, char md5[16], int flag)
 Check a data block whether it is a libisofs session checksum tag and eventually obtain its recorded parameters.
 
int iso_md5_start (void **md5_context)
 Create a MD5 computation context and hand out an opaque handle.
 
int iso_md5_compute (void *md5_context, char *data, int datalen)
 Advance the computation of a MD5 checksum by a chunk of data bytes.
 
int iso_md5_clone (void *old_md5_context, void **new_md5_context)
 Create a MD5 computation context as clone of an existing one.
 
int iso_md5_end (void **md5_context, char result[16])
 Obtain the MD5 checksum from a MD5 computation context and dispose this context.
 
int iso_md5_match (char first_md5[16], char second_md5[16])
 Inquire whether two MD5 checksums match.
 
int iso_hfsplus_xinfo_func (void *data, int flag)
 The function that is used to mark struct iso_hfsplus_xinfo_data at IsoNodes and finally disposes such structs when their IsoNodes get disposed.
 
struct iso_hfsplus_xinfo_dataiso_hfsplus_xinfo_new (int flag)
 Create an instance of struct iso_hfsplus_xinfo_new().
 
int iso_image_hfsplus_bless (IsoImage *img, enum IsoHfsplusBlessings blessing, IsoNode *node, int flag)
 Issue a blessing to a particular IsoNode.
 
int iso_image_hfsplus_get_blessed (IsoImage *img, IsoNode ***blessed_nodes, int *bless_max, int flag)
 Get the array of nodes which are currently blessed.
 
int iso_conv_name_chars (IsoWriteOpts *opts, char *name, size_t name_len, char **result, size_t *result_len, int flag)
 Convert the characters in name from local charset to another charset or convert name to the representation of a particular ISO image name space.
 

Variables

unsigned int iso_fs_global_id
 See IsoFilesystem->get_id() for info about this.
 
ino_t serial_id
 Serial number to be used when you can't get a valid id for a Stream by other means.
 

Macro Definition Documentation

◆ ISO_AAIP_ACL_MULT_OBJ

#define ISO_AAIP_ACL_MULT_OBJ   0xE830FE83

ACL text contains multiple entries of user::, group::, other:: (FAILURE, HIGH, -381)

Definition at line 9289 of file libisofs.h.

◆ ISO_AAIP_BAD_AASTRING

#define ISO_AAIP_BAD_AASTRING   0xE830FEAC

Error with decoding AAIP info for ACL or xattr (FAILURE, HIGH, -340)

Definition at line 9112 of file libisofs.h.

◆ ISO_AAIP_BAD_ACL

#define ISO_AAIP_BAD_ACL   0xE830FEAF

Error with decoding ACL from AAIP info (FAILURE, HIGH, -337)

Definition at line 9102 of file libisofs.h.

◆ ISO_AAIP_BAD_ACL_TEXT

#define ISO_AAIP_BAD_ACL_TEXT   0xE830FEAE

Error with encoding ACL for AAIP (FAILURE, HIGH, -338)

Definition at line 9105 of file libisofs.h.

◆ ISO_AAIP_BAD_ATTR_NAME

#define ISO_AAIP_BAD_ATTR_NAME   0xE830FE84

Attribute name cannot be represented (FAILURE, HIGH, -380)

Definition at line 9285 of file libisofs.h.

◆ ISO_AAIP_IGNORED

#define ISO_AAIP_IGNORED   0xB030FEB0

AAIP info with ACL or xattr in ISO image will be ignored (NOTE, HIGH, -336)

Definition at line 9099 of file libisofs.h.

◆ ISO_AAIP_NO_GET_LOCAL

#define ISO_AAIP_NO_GET_LOCAL   0xE830FEAB

Error with reading ACL or xattr from local file (FAILURE, HIGH, -341)

Definition at line 9115 of file libisofs.h.

◆ ISO_AAIP_NO_GET_LOCAL_S

#define ISO_AAIP_NO_GET_LOCAL_S   0xE030FEAB

Error with reading ACL or xattr from local file (SORRY, HIGH, -341)

Definition at line 9117 of file libisofs.h.

◆ ISO_AAIP_NO_SET_LOCAL

#define ISO_AAIP_NO_SET_LOCAL   0xE830FEAA

Error with attaching ACL or xattr to local file (FAILURE, HIGH, -342)

Definition at line 9120 of file libisofs.h.

◆ ISO_AAIP_NO_SET_LOCAL_S

#define ISO_AAIP_NO_SET_LOCAL_S   0xE030FEAA

Error with attaching ACL or xattr to local file (SORRY, HIGH, -342)

Definition at line 9122 of file libisofs.h.

◆ ISO_AAIP_NON_USER_NAME

#define ISO_AAIP_NON_USER_NAME   0xE830FEA9

Unallowed attempt to set an xattr with non-userspace name (FAILURE, HIGH, -343)

Definition at line 9126 of file libisofs.h.

◆ ISO_AAIP_NOT_ENABLED

#define ISO_AAIP_NOT_ENABLED   0xE830FEAD

AAIP processing for ACL or xattr not enabled at compile time (FAILURE, HIGH, -339)

Definition at line 9109 of file libisofs.h.

◆ ISO_ALPHA_BOOT_NOTREG

#define ISO_ALPHA_BOOT_NOTREG   0xE830FE6B

DEC Alpha Boot Loader file is not a data file (FAILURE, HIGH, -405)

Definition at line 9363 of file libisofs.h.

◆ ISO_ASSERT_FAILURE

#define ISO_ASSERT_FAILURE   0xF030FFFC

Internal programming error.

Please report this bug (FATAL,HIGH, -4)

Definition at line 8910 of file libisofs.h.

◆ ISO_BAD_FSRC_FILETYPE

#define ISO_BAD_FSRC_FILETYPE   0xE030FE61

Unrecognized file type of IsoFileSrc object (SORRY, HIGH, -415)

Definition at line 9398 of file libisofs.h.

◆ ISO_BAD_GPT_GUID_MODE

#define ISO_BAD_GPT_GUID_MODE   0xE830FE5F

Unrecognized GPT disk GUID setup mode (FAILURE, HIGH, -417)

Definition at line 9406 of file libisofs.h.

◆ ISO_BAD_ISO_FILETYPE

#define ISO_BAD_ISO_FILETYPE   0xE830FE74

Unrecognized file type in ISO image (FAILURE, HIGH, -396)

Definition at line 9336 of file libisofs.h.

◆ ISO_BAD_PARTITION_FILE

#define ISO_BAD_PARTITION_FILE   0xE830FE8E

Cannot open data file for appended partition (FAILURE, HIGH, -370)

Definition at line 9251 of file libisofs.h.

◆ ISO_BAD_PARTITION_NO

#define ISO_BAD_PARTITION_NO   0xE830FE8F

Partition number out of range (FAILURE, HIGH, -369)

Definition at line 9248 of file libisofs.h.

◆ ISO_BOOT_APM_GPT_BSIZE

#define ISO_BOOT_APM_GPT_BSIZE   0xE830FE78

APM block size prevents coexistence with GPT (FAILURE, HIGH, -392)

Definition at line 9324 of file libisofs.h.

◆ ISO_BOOT_APM_OVERLAP

#define ISO_BOOT_APM_OVERLAP   0xE830FE80

Overlapping Apple Partition Map entries requested (FAILURE, HIGH, -384)

Definition at line 9299 of file libisofs.h.

◆ ISO_BOOT_FILE_MISSING

#define ISO_BOOT_FILE_MISSING   0xE430FE90

Boot file missing in image (MISHAP, HIGH, -368)

Definition at line 9245 of file libisofs.h.

◆ ISO_BOOT_GPT_OVERLAP

#define ISO_BOOT_GPT_OVERLAP   0xE830FE7E

Overlapping GPT entries requested (FAILURE, HIGH, -386)

Definition at line 9305 of file libisofs.h.

◆ ISO_BOOT_HFSP_BAD_BSIZE

#define ISO_BOOT_HFSP_BAD_BSIZE   0xE830FE79

Not a supported HFS+ or APM block size (FAILURE, HIGH, -391)

Definition at line 9321 of file libisofs.h.

◆ ISO_BOOT_IMAGE_NOT_VALID

#define ISO_BOOT_IMAGE_NOT_VALID   0xE830FFBB

Trying to use an invalid file as boot image (FAILURE,HIGH, -68)

Definition at line 8953 of file libisofs.h.

◆ ISO_BOOT_IMAGE_OVERFLOW

#define ISO_BOOT_IMAGE_OVERFLOW   0xE830FFBA

Too many boot images (FAILURE,HIGH, -69)

Definition at line 8956 of file libisofs.h.

◆ ISO_BOOT_MBR_COLLISION

#define ISO_BOOT_MBR_COLLISION   0xE830FE7B

Attempt to use an MBR partition entry twice (FAILURE, HIGH, -389)

Definition at line 9314 of file libisofs.h.

◆ ISO_BOOT_MBR_OVERLAP

#define ISO_BOOT_MBR_OVERLAP   0xE830FE7C

Overlapping MBR partition entries requested (FAILURE, HIGH, -388)

Definition at line 9311 of file libisofs.h.

◆ ISO_BOOT_NO_CATALOG

#define ISO_BOOT_NO_CATALOG   0xE830FFB9

No boot catalog created yet ((FAILURE,HIGH, -70)

Definition at line 8959 of file libisofs.h.

◆ ISO_BOOT_NO_EFI_ELTO

#define ISO_BOOT_NO_EFI_ELTO   0xE830FE7A

No suitable El Torito EFI boot image for exposure as GPT partition (FAILURE, HIGH, -390)

Definition at line 9318 of file libisofs.h.

◆ ISO_BOOT_TOO_MANY_APM

#define ISO_BOOT_TOO_MANY_APM   0xE830FE81

Too many Apple Partition Map entries requested (FAILURE, HIGH, -383)

Definition at line 9296 of file libisofs.h.

◆ ISO_BOOT_TOO_MANY_GPT

#define ISO_BOOT_TOO_MANY_GPT   0xE830FE7F

Too many GPT entries requested (FAILURE, HIGH, -385)

Definition at line 9302 of file libisofs.h.

◆ ISO_BOOT_TOO_MANY_MBR

#define ISO_BOOT_TOO_MANY_MBR   0xE830FE7D

Too many MBR partition entries requested (FAILURE, HIGH, -387)

Definition at line 9308 of file libisofs.h.

◆ ISO_BOOT_TOO_MANY_MIPS

#define ISO_BOOT_TOO_MANY_MIPS   0xE830FE91

Too many MIPS Big Endian boot files given (max.

15) (FAILURE, HIGH, -367)

Definition at line 9242 of file libisofs.h.

◆ ISO_BUF_READ_ERROR

#define ISO_BUF_READ_ERROR   0xE830FFF5

Buffer read error (FAILURE,HIGH, -11)

Definition at line 8933 of file libisofs.h.

◆ ISO_CANCELED

#define ISO_CANCELED   0xE830FFFF

Operation canceled (FAILURE,HIGH, -1)

Definition at line 8901 of file libisofs.h.

◆ ISO_CE_REMOVING_ATTR

#define ISO_CE_REMOVING_ATTR   0xD030FE53

Too many CE entries for single file, omitting attributes (WARNING,HIGH, -429)

Definition at line 9446 of file libisofs.h.

◆ ISO_CHARSET_CONV_ERROR

#define ISO_CHARSET_CONV_ERROR   0xE830FF00

Charset conversion error (FAILURE,HIGH, -256)

Definition at line 9035 of file libisofs.h.

◆ ISO_DATA_SOURCE_FAILURE

#define ISO_DATA_SOURCE_FAILURE   0xE830FCFF

Read error occurred with IsoDataSource (FAILURE,HIGH, -513)

Definition at line 9465 of file libisofs.h.

◆ ISO_DATA_SOURCE_FATAL

#define ISO_DATA_SOURCE_FATAL   0xF030FCFF

Read error occurred with IsoDataSource (FATAL,HIGH, -513)

Definition at line 9468 of file libisofs.h.

◆ ISO_DATA_SOURCE_MISHAP

#define ISO_DATA_SOURCE_MISHAP   0xE430FCFF

Read error occurred with IsoDataSource (MISHAP,HIGH, -513)

Definition at line 9462 of file libisofs.h.

◆ ISO_DATA_SOURCE_SORRY

#define ISO_DATA_SOURCE_SORRY   0xE030FCFF

Read error occurred with IsoDataSource (SORRY,HIGH, -513)

Definition at line 9459 of file libisofs.h.

◆ ISO_DEAD_SYMLINK

#define ISO_DEAD_SYMLINK   0xE830FE76

Symbolic link cannot be resolved (FAILURE, HIGH, -394)

Definition at line 9330 of file libisofs.h.

◆ ISO_DEEP_SYMLINK

#define ISO_DEEP_SYMLINK   0xE830FE75

Too many chained symbolic links (FAILURE, HIGH, -395)

Definition at line 9333 of file libisofs.h.

◆ ISO_DIR

#define ISO_DIR ( n)    ((IsoDir*)(ISO_NODE_IS_DIR(n) ? n : NULL))

Definition at line 244 of file libisofs.h.

◆ ISO_DISPLACE_ROLLOVER

#define ISO_DISPLACE_ROLLOVER   0xE830FE8C

Displacement offset leads outside 32 bit range (FAILURE, HIGH, -372)

Definition at line 9258 of file libisofs.h.

◆ ISO_EL_TORITO_HIDDEN

#define ISO_EL_TORITO_HIDDEN   0xD030FEB1

El-Torito image is hidden (WARNING,HIGH, -335)

Definition at line 9094 of file libisofs.h.

◆ ISO_EL_TORITO_WARN

#define ISO_EL_TORITO_WARN   0xD030FEB3

El-Torito related warning (WARNING,HIGH, -333)

Definition at line 9088 of file libisofs.h.

◆ ISO_ELTO_EFI_HIDDEN

#define ISO_ELTO_EFI_HIDDEN   0xB030FE5B

El-Torito EFI image is hidden (NOTE,HIGH, -421)

Definition at line 9420 of file libisofs.h.

◆ ISO_ELTORITO_REPORT_DOC

#define ISO_ELTORITO_REPORT_DOC

Text which describes the output format of iso_image_report_el_torito().

It is publicly defined here only as part of the API description. Do not use it as macro in your application but rather call iso_image_report_el_torito() with flag bit0.

Definition at line 4673 of file libisofs.h.

4673#define ISO_ELTORITO_REPORT_DOC \
4674"Report format for recognized El Torito boot information.", \
4675"", \
4676"No text will be reported if no El Torito information was found.", \
4677"Else there will be at least these three lines", \
4678" El Torito catalog : decimal decimal", \
4679" tells the block address and number of 2048-blocks of the boot catalog.", \
4680" El Torito images : N Pltf B Emul Ld_seg Hdpt Ldsiz LBA", \
4681" is the headline of the boot image list.", \
4682" El Torito boot img : X word char word hex hex decimal decimal", \
4683" tells about boot image number X:", \
4684" - Platform Id: \"BIOS\", \"PPC\", \"Mac\", \"UEFI\" or a hex number.", \
4685" - Bootability: either \"y\" or \"n\".", \
4686" - Emulation: \"none\", \"fd1.2\", \"fd1.4\", \"fd2.8\", \"hd\"", \
4687" for no emulation, three floppy MB sizes, hard disk.", \
4688" - Load Segment: start offset in boot image. 0x0000 means 0x07c0.", \
4689" - Hard disk emulation partition type: MBR partition type code.", \
4690" - Load size: number of 512-blocks to load with emulation mode \"none\".", \
4691" - LBA: start block number in ISO filesystem (2048-block).", \
4692"", \
4693"The following lines appear conditionally:", \
4694" El Torito cat path : iso_rr_path", \
4695" tells the path to the data file in the ISO image which belongs to", \
4696" the block address where the boot catalog starts.", \
4697" (This line is not reported if no path points to that block.)", \
4698" El Torito img path : X iso_rr_path", \
4699" tells the path to the data file in the ISO image which belongs to", \
4700" the block address given by LBA of boot image X.", \
4701" (This line is not reported if no path points to that block.)", \
4702" El Torito img opts : X word ... word", \
4703" tells the presence of extra features:", \
4704" \"boot-info-table\" image got boot info table patching.", \
4705" \"isohybrid-suitable\" image is suitable for ISOLINUX isohybrid MBR.", \
4706" \"grub2-boot-info\" image got GRUB2 boot info patching.", \
4707" (This line is not reported if no such options were detected.)", \
4708" El Torito id string: X hex_digits", \
4709" tells the id string of the catalog section which hosts boot image X.", \
4710" (This line is not reported if the id string is all zero.)", \
4711" El Torito sel crit : X hex_digits", \
4712" tells the selection criterion of boot image X.", \
4713" (This line is not reported if the criterion is all zero.)", \
4714" El Torito img blks : X decimal", \
4715" gives an upper limit of the number of 2048-blocks in the boot image", \
4716" if it is not accessible via a path in the ISO directory tree.", \
4717" The boot image is supposed to end before the start block of any", \
4718" other entity of the ISO filesystem.", \
4719" (This line is not reported if no limiting entity is found.)", \
4720" El Torito hdsiz/512: X decimal", \
4721" gives with a boot image of emulation type \"hd\" the lowest block", \
4722" number which is above any partition end in the boot image's MBR", \
4723" partition table. This can be considered the claimed size of the", \
4724" emulated hard disk given in blocks of 512 bytes.", \
4725" (This line is not reported if no partition is found in the image.)", \
4726""

◆ ISO_ERROR

#define ISO_ERROR   0xE830FFFD

Unknown or unexpected error (FAILURE,HIGH, -3)

Definition at line 8907 of file libisofs.h.

◆ ISO_EXTF_TOO_OFTEN

#define ISO_EXTF_TOO_OFTEN   0xE830FEA8

Too many references on a single IsoExternalFilterCommand (FAILURE, HIGH, -344)

Definition at line 9130 of file libisofs.h.

◆ ISO_FATAL_ERROR

#define ISO_FATAL_ERROR   0xF030FFFE

Unknown or unexpected fatal error (FATAL,HIGH, -2)

Definition at line 8904 of file libisofs.h.

◆ ISO_FILE

#define ISO_FILE ( n)    ((IsoFile*)(ISO_NODE_IS_FILE(n) ? n : NULL))

Definition at line 245 of file libisofs.h.

◆ ISO_FILE_ACCESS_DENIED

#define ISO_FILE_ACCESS_DENIED   0xE830FF7E

Access to file is not allowed (FAILURE,HIGH, -130)

Definition at line 8975 of file libisofs.h.

◆ ISO_FILE_ALREADY_OPENED

#define ISO_FILE_ALREADY_OPENED   0xE830FF7F

Trying to open an already opened file (FAILURE,HIGH, -129)

Definition at line 8969 of file libisofs.h.

◆ ISO_FILE_ALREADY_OPENNED

#define ISO_FILE_ALREADY_OPENNED   0xE830FF7F

Definition at line 8972 of file libisofs.h.

◆ ISO_FILE_BAD_PATH

#define ISO_FILE_BAD_PATH   0xE830FF7D

Incorrect path to file (FAILURE,HIGH, -131)

Definition at line 8978 of file libisofs.h.

◆ ISO_FILE_CANT_ADD

#define ISO_FILE_CANT_ADD   0xE030FF71

Definition at line 9019 of file libisofs.h.

◆ ISO_FILE_CANT_WRITE

#define ISO_FILE_CANT_WRITE   0xE430FF73

Definition at line 9011 of file libisofs.h.

◆ ISO_FILE_DOESNT_EXIST

#define ISO_FILE_DOESNT_EXIST   0xE830FF7C

The file does not exist in the filesystem (FAILURE,HIGH, -132)

Definition at line 8981 of file libisofs.h.

◆ ISO_FILE_ERROR

#define ISO_FILE_ERROR   0xE830FF80

Error on file operation (FAILURE,HIGH, -128) (take a look at more specified error codes below)

Definition at line 8966 of file libisofs.h.

◆ ISO_FILE_IGNORED

#define ISO_FILE_IGNORED   0xD020FF75

File not supported in ECMA-119 tree and thus ignored (WARNING,MEDIUM, -139)

Definition at line 9005 of file libisofs.h.

◆ ISO_FILE_IMGPATH_WRONG

#define ISO_FILE_IMGPATH_WRONG   0xD020FF70

File path break specification constraints and will be ignored (WARNING,MEDIUM, -144)

Definition at line 9025 of file libisofs.h.

◆ ISO_FILE_IS_DIR

#define ISO_FILE_IS_DIR   0xE830FF7A

Directory used where no dir is expected (FAILURE,HIGH, -134)

Definition at line 8990 of file libisofs.h.

◆ ISO_FILE_IS_NOT_DIR

#define ISO_FILE_IS_NOT_DIR   0xE830FF78

Not dir used where a dir is expected (FAILURE,HIGH, -136)

Definition at line 8996 of file libisofs.h.

◆ ISO_FILE_IS_NOT_SYMLINK

#define ISO_FILE_IS_NOT_SYMLINK   0xE830FF77

Not symlink used where a symlink is expected (FAILURE,HIGH, -137)

Definition at line 8999 of file libisofs.h.

◆ ISO_FILE_NOT_OPENED

#define ISO_FILE_NOT_OPENED   0xE830FF7B

Trying to read or close a file not opened (FAILURE,HIGH, -133)

Definition at line 8984 of file libisofs.h.

◆ ISO_FILE_NOT_OPENNED

#define ISO_FILE_NOT_OPENNED   ISO_FILE_NOT_OPENED

Definition at line 8987 of file libisofs.h.

◆ ISO_FILE_OFFSET_TOO_BIG

#define ISO_FILE_OFFSET_TOO_BIG   0xE830FF6A

Offset greater than file size (FAILURE,HIGH, -150)

Since
0.6.4

Definition at line 9031 of file libisofs.h.

◆ ISO_FILE_READ_ERROR

#define ISO_FILE_READ_ERROR   0xE830FF79

Read error (FAILURE,HIGH, -135)

Definition at line 8993 of file libisofs.h.

◆ ISO_FILE_SEEK_ERROR

#define ISO_FILE_SEEK_ERROR   0xE830FF76

Can't seek to specified location (FAILURE,HIGH, -138)

Definition at line 9002 of file libisofs.h.

◆ ISO_FILE_TOO_BIG

#define ISO_FILE_TOO_BIG   0xE830FF74

Definition at line 9008 of file libisofs.h.

◆ ISO_FILENAME_WRONG_CHARSET

#define ISO_FILENAME_WRONG_CHARSET   0xD020FF72

Definition at line 9014 of file libisofs.h.

◆ ISO_FILENAME_WRONG_CHARSET_OLD

#define ISO_FILENAME_WRONG_CHARSET_OLD   0xC020FF72

Definition at line 9016 of file libisofs.h.

◆ ISO_FILTER_WRONG_INPUT

#define ISO_FILTER_WRONG_INPUT   0xE830FEA5

Filter input differs from previous run (FAILURE, HIGH, -347)

Definition at line 9139 of file libisofs.h.

◆ ISO_GENERAL_NOTE

#define ISO_GENERAL_NOTE   0xB030FE62

General note (NOTE, HIGH, -414)

Definition at line 9395 of file libisofs.h.

◆ ISO_GPT_NO_VOL_UUID

#define ISO_GPT_NO_VOL_UUID   0xE830FE60

Cannot derive GPT GUID from undefined pseudo-UUID volume timestamp (FAILURE, HIGH, -416)

Definition at line 9402 of file libisofs.h.

◆ ISO_HFSP_NO_MANGLE

#define ISO_HFSP_NO_MANGLE   0xE830FE77

Name collision in HFS+, mangling not possible (FAILURE, HIGH, -393)

Definition at line 9327 of file libisofs.h.

◆ ISO_HFSPLUS_TOO_MANY_FILES

#define ISO_HFSPLUS_TOO_MANY_FILES   0xE830FE5A

Too many files in HFS+ directory tree (FAILURE, HIGH, -422)

Definition at line 9423 of file libisofs.h.

◆ ISO_HPPA_PALO_CMDLEN

#define ISO_HPPA_PALO_CMDLEN   0xE830FE6E

HP-PA PALO command line too long (FAILURE, HIGH, -402)

Definition at line 9354 of file libisofs.h.

◆ ISO_HPPA_PALO_INCOMPL

#define ISO_HPPA_PALO_INCOMPL   0xE830FE71

Incomplete HP-PA PALO boot parameters (FAILURE, HIGH, -399)

Definition at line 9345 of file libisofs.h.

◆ ISO_HPPA_PALO_NOTREG

#define ISO_HPPA_PALO_NOTREG   0xE830FE6F

HP-PA PALO file is not a data file (FAILURE, HIGH, -401)

Definition at line 9351 of file libisofs.h.

◆ ISO_HPPA_PALO_OFLOW

#define ISO_HPPA_PALO_OFLOW   0xE830FE70

HP-PA PALO boot address exceeds 2 GB (FAILURE, HIGH, -400)

Definition at line 9348 of file libisofs.h.

◆ ISO_IMAGE_ALREADY_BOOTABLE

#define ISO_IMAGE_ALREADY_BOOTABLE   0xE830FFBC

Try to set the boot image of an already bootable image (FAILURE,HIGH, -67)

Definition at line 8950 of file libisofs.h.

◆ ISO_IMAGE_WRITE_CANCELED

#define ISO_IMAGE_WRITE_CANCELED   0xE430FEB2

Image write cancelled (MISHAP,HIGH, -334)

Definition at line 9091 of file libisofs.h.

◆ ISO_IMPORT_COLLISION

#define ISO_IMPORT_COLLISION   0xD030FE72

File name collision during ISO image import (WARNING, HIGH, -398)

Definition at line 9342 of file libisofs.h.

◆ ISO_INQ_SYSAREA_PROP

#define ISO_INQ_SYSAREA_PROP   0xE830FE6C

Unrecognized inquiry for system area property (FAILURE, HIGH, -404)

Definition at line 9360 of file libisofs.h.

◆ ISO_INTERRUPTED

#define ISO_INTERRUPTED   0xF030FFF9

Interrupted by a signal (FATAL,HIGH, -7)

Definition at line 8921 of file libisofs.h.

◆ ISO_INTVL_READ_PROBLEM

#define ISO_INTVL_READ_PROBLEM   0xD030FE68

Unreadable file, premature EOF, or failure to seek for interval reader (WARNING, HIGH, -408)

Definition at line 9373 of file libisofs.h.

◆ ISO_ISOLINUX_CANT_PATCH

#define ISO_ISOLINUX_CANT_PATCH   0xE030FEB9

Can't patch an isolinux boot image (SORRY,HIGH, -327)

Definition at line 9070 of file libisofs.h.

◆ iso_lib_header_version_major

#define iso_lib_header_version_major   1

The following two functions and three macros are utilities to help ensuring version match of application, compile time header, and runtime library.

These three release version numbers tell the revision of this header file and of the API it describes. They are memorized by applications at compile time. They must show the same values as these symbols in ./configure.ac LIBISOFS_MAJOR_VERSION=... LIBISOFS_MINOR_VERSION=... LIBISOFS_MICRO_VERSION=... Note to anybody who does own work inside libisofs: Any change of configure.ac or libisofs.h has to keep up this equality !

Before usage of these macros on your code, please read the usage discussion below.

Since
0.6.2

Definition at line 95 of file libisofs.h.

◆ iso_lib_header_version_micro

#define iso_lib_header_version_micro   6

Definition at line 97 of file libisofs.h.

◆ iso_lib_header_version_minor

#define iso_lib_header_version_minor   5

Definition at line 96 of file libisofs.h.

◆ ISO_LIBJTE_END_FAILED

#define ISO_LIBJTE_END_FAILED   0xE830FE93

Failed to finish Jigdo Template Extraction (FAILURE, HIGH, -365)

Definition at line 9235 of file libisofs.h.

◆ ISO_LIBJTE_FILE_FAILED

#define ISO_LIBJTE_FILE_FAILED   0xE430FE92

Failed to process file for Jigdo Template Extraction (MISHAP, HIGH, -366)

Definition at line 9239 of file libisofs.h.

◆ ISO_LIBJTE_NOT_ENABLED

#define ISO_LIBJTE_NOT_ENABLED   0xE830FE95

Use of libjte was not enabled at compile time (FAILURE, HIGH, -363)

Definition at line 9229 of file libisofs.h.

◆ iso_libjte_req_major

#define iso_libjte_req_major   2

The minimum version of libjte to be used with this version of libisofs at compile time.

The use of libjte is optional and depends on configure tests. It can be prevented by ./configure option –disable-libjte .

Since
0.6.38

Definition at line 2406 of file libisofs.h.

◆ iso_libjte_req_micro

#define iso_libjte_req_micro   0

Definition at line 2408 of file libisofs.h.

◆ iso_libjte_req_minor

#define iso_libjte_req_minor   0

Definition at line 2407 of file libisofs.h.

◆ ISO_LIBJTE_START_FAILED

#define ISO_LIBJTE_START_FAILED   0xE830FE94

Failed to start up Jigdo Template Extraction (FAILURE, HIGH, -364)

Definition at line 9232 of file libisofs.h.

◆ ISO_MALFORMED_READ_INTVL

#define ISO_MALFORMED_READ_INTVL   0xE830FE69

Malformed description string for interval reader (FAILURE, HIGH, -407)

Definition at line 9369 of file libisofs.h.

◆ ISO_MANGLE_TOO_MUCH_FILES

#define ISO_MANGLE_TOO_MUCH_FILES   0xE830FEFF

Too many files to mangle, i.e.

we cannot guarantee unique file names (FAILURE,HIGH, -257)

Definition at line 9041 of file libisofs.h.

◆ ISO_MAX_SYSAREA_LINE_LENGTH

#define ISO_MAX_SYSAREA_LINE_LENGTH   4096

The maximum length of a single line in the output of function iso_image_report_system_area() and iso_image_report_el_torito().

This number includes the trailing 0.

Since
1.3.8

Definition at line 4410 of file libisofs.h.

◆ ISO_MD5_AREA_CORRUPTED

#define ISO_MD5_AREA_CORRUPTED   0xD030FEA0

Checksum area or checksum tag appear corrupted (WARNING,HIGH, -352)

Since
0.6.22

Definition at line 9158 of file libisofs.h.

◆ ISO_MD5_STREAM_CHANGE

#define ISO_MD5_STREAM_CHANGE   0xE430FE9A

Detected file content changes while it was written into the image.

(MISHAP, HIGH, -358)

Since
0.6.22

Definition at line 9198 of file libisofs.h.

◆ ISO_MD5_TAG_COPIED

#define ISO_MD5_TAG_COPIED   0xD030FE88

Found copied superblock checksum tag (WARNING, HIGH, -376)

Definition at line 9273 of file libisofs.h.

◆ ISO_MD5_TAG_MISMATCH

#define ISO_MD5_TAG_MISMATCH   0xE830FE9F

Checksum mismatch between checksum tag and data blocks (FAILURE, HIGH, -353)

Since
0.6.22

Definition at line 9165 of file libisofs.h.

◆ ISO_MD5_TAG_MISPLACED

#define ISO_MD5_TAG_MISPLACED   0xD030FE9C

Misplaced checksum tag encountered.

(WARNING, HIGH, -356)

Since
0.6.22

Definition at line 9184 of file libisofs.h.

◆ ISO_MD5_TAG_OTHER_RANGE

#define ISO_MD5_TAG_OTHER_RANGE   0xD030FE9B

Checksum tag with unexpected address range encountered.

(WARNING, HIGH, -357)

Since
0.6.22

Definition at line 9191 of file libisofs.h.

◆ ISO_MD5_TAG_UNEXPECTED

#define ISO_MD5_TAG_UNEXPECTED   0xD030FE9D

Unexpected checksum tag type encountered.

(WARNING, HIGH, -355)

Since
0.6.22

Definition at line 9178 of file libisofs.h.

◆ ISO_MSGS_MESSAGE_LEN

#define ISO_MSGS_MESSAGE_LEN   4096

Definition at line 6818 of file libisofs.h.

◆ ISO_MULTI_OVER_IMPORTED

#define ISO_MULTI_OVER_IMPORTED   0xE830FE5C

Multi-session would overwrite imported_iso interval (FAILURE, HIGH, -420)

Definition at line 9417 of file libisofs.h.

◆ ISO_NAME_NEEDS_TRANSL

#define ISO_NAME_NEEDS_TRANSL   0xE830FE8B

File name cannot be written into ECMA-119 untranslated (FAILURE, HIGH, -373)

Definition at line 9262 of file libisofs.h.

◆ ISO_NAME_NOT_UCS2

#define ISO_NAME_NOT_UCS2   0xD030FE73

Filename not suitable for character set UCS-2 (WARNING, HIGH, -397)

Definition at line 9339 of file libisofs.h.

◆ ISO_NO_KEPT_DATA_SRC

#define ISO_NO_KEPT_DATA_SRC   0xD030FE6A

No data source of imported ISO image available (WARNING, HIGH, -406)

Definition at line 9366 of file libisofs.h.

◆ ISO_NO_ROOT_DIR

#define ISO_NO_ROOT_DIR   0xF030FE5E

Unable to obtain root directory (FATAL,HIGH, -418)

Definition at line 9409 of file libisofs.h.

◆ ISO_NODE

#define ISO_NODE ( n)    ((IsoNode*)n)

Definition at line 249 of file libisofs.h.

◆ ISO_NODE_ALREADY_ADDED

#define ISO_NODE_ALREADY_ADDED   0xE830FFC0

Trying to add to a dir a node already added to a dir (FAILURE,HIGH, -64)

Definition at line 8936 of file libisofs.h.

◆ ISO_NODE_DOESNT_EXIST

#define ISO_NODE_DOESNT_EXIST   0xE830FFBD

A requested node does not exist (FAILURE,HIGH, -66)

Definition at line 8945 of file libisofs.h.

◆ ISO_NODE_IS_BOOTCAT

#define ISO_NODE_IS_BOOTCAT ( n)    (iso_node_get_type(n) == LIBISO_BOOT)

Definition at line 241 of file libisofs.h.

◆ ISO_NODE_IS_DIR

#define ISO_NODE_IS_DIR ( n)    (iso_node_get_type(n) == LIBISO_DIR)

Definition at line 237 of file libisofs.h.

◆ ISO_NODE_IS_FILE

#define ISO_NODE_IS_FILE ( n)    (iso_node_get_type(n) == LIBISO_FILE)

Definition at line 238 of file libisofs.h.

◆ ISO_NODE_IS_SPECIAL

#define ISO_NODE_IS_SPECIAL ( n)    (iso_node_get_type(n) == LIBISO_SPECIAL)

Definition at line 240 of file libisofs.h.

◆ ISO_NODE_IS_SYMLINK

#define ISO_NODE_IS_SYMLINK ( n)    (iso_node_get_type(n) == LIBISO_SYMLINK)

Definition at line 239 of file libisofs.h.

◆ ISO_NODE_NAME_NOT_UNIQUE

#define ISO_NODE_NAME_NOT_UNIQUE   0xE830FFBF

Node with same name already exists (FAILURE,HIGH, -65)

Definition at line 8939 of file libisofs.h.

◆ ISO_NODE_NOT_ADDED_TO_DIR

#define ISO_NODE_NOT_ADDED_TO_DIR   0xE830FFBE

Trying to remove a node that was not added to dir (FAILURE,HIGH, -65)

Definition at line 8942 of file libisofs.h.

◆ ISO_NON_MBR_SYS_AREA

#define ISO_NON_MBR_SYS_AREA   0xE830FE8D

May not combine MBR partition with non-MBR system area (FAILURE, HIGH, -371)

Definition at line 9255 of file libisofs.h.

◆ ISO_NONE

#define ISO_NONE   0

special return value, it could be or not an error depending on the context.

Definition at line 8898 of file libisofs.h.

◆ ISO_NOT_REPRODUCIBLE

#define ISO_NOT_REPRODUCIBLE   0xB030FE67

Cannot arrange content of data files in surely reproducible way (NOTE, HIGH, -409)

Definition at line 9377 of file libisofs.h.

◆ ISO_NULL_POINTER

#define ISO_NULL_POINTER   0xE830FFFB

NULL pointer as value for an arg.

that doesn't allow NULL (FAILURE,HIGH, -5)

Definition at line 8915 of file libisofs.h.

◆ ISO_OUT_OF_MEM

#define ISO_OUT_OF_MEM   0xF030FFFA

Memory allocation error (FATAL,HIGH, -6)

Definition at line 8918 of file libisofs.h.

◆ ISO_OVWRT_FIFO_TOO_SMALL

#define ISO_OVWRT_FIFO_TOO_SMALL   0xE830FE96

The ring buffer is smaller than 64 kB + partition offset.

(FAILURE, HIGH, -362)

Definition at line 9226 of file libisofs.h.

◆ ISO_OVWRT_MS_TOO_SMALL

#define ISO_OVWRT_MS_TOO_SMALL   0xE830FE98

The setting of iso_write_opts_set_ms_block() leaves not enough room for the prescibed size of iso_write_opts_set_overwrite_buf().

(FAILURE, HIGH, -360)

Since
0.6.36

Definition at line 9213 of file libisofs.h.

◆ ISO_PART_OFFST_TOO_SMALL

#define ISO_PART_OFFST_TOO_SMALL   0xE830FE97

The partition offset is not 0 and leaves not not enough room for system area, volume descriptors, and checksum tags of the first tree.

(FAILURE, HIGH, -361)

Definition at line 9220 of file libisofs.h.

◆ ISO_PATCH_FILTERED_BOOT

#define ISO_PATCH_FILTERED_BOOT   0xE830FE66

May not write boot info into filtered stream of boot image (FAILURE, HIGH, -410)

Definition at line 9381 of file libisofs.h.

◆ ISO_PATCH_OVERSIZED_BOOT

#define ISO_PATCH_OVERSIZED_BOOT   0xE830FE65

Boot image to large to buffer for writing boot info (FAILURE, HIGH, -411)

Definition at line 9385 of file libisofs.h.

◆ ISO_RR_NAME_RESERVED

#define ISO_RR_NAME_RESERVED   0xE830FE86

Reserved Rock Ridge leaf name (FAILURE, HIGH, -378)

Definition at line 9279 of file libisofs.h.

◆ ISO_RR_NAME_TOO_LONG

#define ISO_RR_NAME_TOO_LONG   0xE830FE87

Rock Ridge leaf name too long (FAILURE, HIGH, -377)

Definition at line 9276 of file libisofs.h.

◆ ISO_RR_NAME_TRUNCATED

#define ISO_RR_NAME_TRUNCATED   0xD030FE64

File name had to be truncated and MD5 marked (WARNING, HIGH, -412)

Definition at line 9388 of file libisofs.h.

◆ ISO_RR_PATH_TOO_LONG

#define ISO_RR_PATH_TOO_LONG   0xE830FE85

Rock Ridge path too long (FAILURE, HIGH, -379)

Definition at line 9282 of file libisofs.h.

◆ ISO_SB_TREE_CORRUPTED

#define ISO_SB_TREE_CORRUPTED   0xE830FE9E

Checksum mismatch in System Area, Volume Descriptors, or directory tree.

(FAILURE, HIGH, -354)

Since
0.6.22

Definition at line 9172 of file libisofs.h.

◆ ISO_SCDBACKUP_TAG_NOT_0

#define ISO_SCDBACKUP_TAG_NOT_0   0xD030FE99

Session does not start at LBA 0.

scdbackup checksum tag not written. (WARNING, HIGH, -359)

Since
0.6.24

Definition at line 9205 of file libisofs.h.

◆ ISO_SECT_SCATTERED

#define ISO_SECT_SCATTERED   0xE830FE82

File sections do not form consecutive array of blocks (FAILURE, HIGH, -382)

Definition at line 9293 of file libisofs.h.

◆ ISO_SPECIAL

#define ISO_SPECIAL ( n)    ((IsoSpecial*)(ISO_NODE_IS_SPECIAL(n) ? n : NULL))

Definition at line 247 of file libisofs.h.

◆ ISO_STREAM_NO_CLONE

#define ISO_STREAM_NO_CLONE   0xE830FE8A

Data file input stream object offers no cloning method (FAILURE, HIGH, -374)

Definition at line 9266 of file libisofs.h.

◆ ISO_SUCCESS

#define ISO_SUCCESS   1

successfully execution

Definition at line 8892 of file libisofs.h.

◆ ISO_SUSP_MULTIPLE_ER

#define ISO_SUSP_MULTIPLE_ER   0xD030FEB5

Multiple ER SUSP entries found (WARNING,HIGH, -331)

Definition at line 9082 of file libisofs.h.

◆ ISO_SUSP_UNHANDLED

#define ISO_SUSP_UNHANDLED   0xC020FEB6

Error on a RR entry that can be ignored (HINT,MEDIUM, -330)

Definition at line 9079 of file libisofs.h.

◆ ISO_SUSP_WRONG_CE_SIZE

#define ISO_SUSP_WRONG_CE_SIZE   0xE830FE5D

Zero sized, oversized, or mislocated SUSP CE area found (FAILURE, HIGH, -419)

Definition at line 9413 of file libisofs.h.

◆ ISO_SYMLINK

#define ISO_SYMLINK ( n)    ((IsoSymlink*)(ISO_NODE_IS_SYMLINK(n) ? n : NULL))

Definition at line 246 of file libisofs.h.

◆ ISO_SYSAREA_PROBLEMS

#define ISO_SYSAREA_PROBLEMS   0xD030FE6D

Problems encountered during inspection of System Area (WARN, HIGH, -403)

Definition at line 9357 of file libisofs.h.

◆ ISO_SYSAREA_REPORT_DOC

#define ISO_SYSAREA_REPORT_DOC
Value:
\
"Report format for recognized System Area data.", \
"", \
"No text will be reported if no System Area was loaded or if it was", \
"entirely filled with 0-bytes.", \
"Else there will be at least these three lines:", \
" System area options: hex", \
" see libisofs.h, parameter of iso_write_opts_set_system_area().", \
" System area summary: word ... word", \
" human readable interpretation of system area options and other info", \
" The words are from the set:", \
" { MBR, CHRP, PReP, GPT, APM, MIPS-Big-Endian, MIPS-Little-Endian,", \
" SUN-SPARC-Disk-Label, HP-PA-PALO, DEC-Alpha, ", \
" protective-msdos-label, isohybrid, grub2-mbr,", \
" cyl-align-{auto,on,off,all}, not-recognized, }", \
" The acronyms indicate boot data for particular hardware/firmware.", \
" protective-msdos-label is an MBR conformant to specs of GPT.", \
" isohybrid is an MBR implementing ISOLINUX isohybrid functionality.", \
" grub2-mbr is an MBR with GRUB2 64 bit address patching.", \
" cyl-align-on indicates that the ISO image MBR partition ends at a", \
" cylinder boundary. cyl-align-all means that more MBR partitions", \
" exist and all end at a cylinder boundary.", \
" not-recognized tells about unrecognized non-zero system area data.", \
" ISO image size/512 : decimal", \
" size of ISO image in block units of 512 bytes.", \
""

Texts which describe the output format of iso_image_report_system_area().

They are publicly defined here only as part of the API description. Do not use these macros in your application but rather call iso_image_report_system_area() with flag bit0.

Definition at line 4418 of file libisofs.h.

4418#define ISO_SYSAREA_REPORT_DOC \
4419\
4420"Report format for recognized System Area data.", \
4421"", \
4422"No text will be reported if no System Area was loaded or if it was", \
4423"entirely filled with 0-bytes.", \
4424"Else there will be at least these three lines:", \
4425" System area options: hex", \
4426" see libisofs.h, parameter of iso_write_opts_set_system_area().", \
4427" System area summary: word ... word", \
4428" human readable interpretation of system area options and other info", \
4429" The words are from the set:", \
4430" { MBR, CHRP, PReP, GPT, APM, MIPS-Big-Endian, MIPS-Little-Endian,", \
4431" SUN-SPARC-Disk-Label, HP-PA-PALO, DEC-Alpha, ", \
4432" protective-msdos-label, isohybrid, grub2-mbr,", \
4433" cyl-align-{auto,on,off,all}, not-recognized, }", \
4434" The acronyms indicate boot data for particular hardware/firmware.", \
4435" protective-msdos-label is an MBR conformant to specs of GPT.", \
4436" isohybrid is an MBR implementing ISOLINUX isohybrid functionality.", \
4437" grub2-mbr is an MBR with GRUB2 64 bit address patching.", \
4438" cyl-align-on indicates that the ISO image MBR partition ends at a", \
4439" cylinder boundary. cyl-align-all means that more MBR partitions", \
4440" exist and all end at a cylinder boundary.", \
4441" not-recognized tells about unrecognized non-zero system area data.", \
4442" ISO image size/512 : decimal", \
4443" size of ISO image in block units of 512 bytes.", \
4444""

◆ ISO_SYSAREA_REPORT_DOC_ALPHA

#define ISO_SYSAREA_REPORT_DOC_ALPHA
Value:
"If a DEC Alpha SRM boot sector is present:", \
" DEC Alpha ldr size : decimal", \
" tells the number of 512-byte blocks in DEC Alpha Secondary Bootstrap", \
" Loader file.", \
" DEC Alpha ldr adr : decimal", \
" tells the start of the loader file in units of 512-byte blocks.", \
" DEC Alpha ldr path : path", \
" tells the path of a file in the ISO image which starts at the loader", \
" start address."

Definition at line 4618 of file libisofs.h.

4618#define ISO_SYSAREA_REPORT_DOC_ALPHA \
4619"If a DEC Alpha SRM boot sector is present:", \
4620" DEC Alpha ldr size : decimal", \
4621" tells the number of 512-byte blocks in DEC Alpha Secondary Bootstrap", \
4622" Loader file.", \
4623" DEC Alpha ldr adr : decimal", \
4624" tells the start of the loader file in units of 512-byte blocks.", \
4625" DEC Alpha ldr path : path", \
4626" tells the path of a file in the ISO image which starts at the loader", \
4627" start address."

◆ ISO_SYSAREA_REPORT_DOC_APM

#define ISO_SYSAREA_REPORT_DOC_APM
Value:
\
"Apple partition map can coexist with MBR and GPT:", \
" APM : N Info", \
" headline for human readers.", \
" APM block size : decimal", \
" block size of Apple Partition Map. 512 or 2048. This applies to", \
" start address and size of all partitions in the APM.", \
" APM gap fillers : decimal", \
" tells the number of partitions with name \"Gap[0-9[0-9]]\" and type", \
" \"ISO9660_data\".", \
" APM partition name : X text", \
" the name of partition X. Up to 32 characters.", \
" APM partition type : X text", \
" the type string of partition X. Up to 32 characters.", \
" APM start and size : X decimal decimal", \
" start block and number of blocks of partition X.", \
" APM partition path : X path", \
" the path of a file in the ISO image which begins at the partition", \
" start block of partition X.", \
""

Definition at line 4532 of file libisofs.h.

4532#define ISO_SYSAREA_REPORT_DOC_APM \
4533\
4534"Apple partition map can coexist with MBR and GPT:", \
4535" APM : N Info", \
4536" headline for human readers.", \
4537" APM block size : decimal", \
4538" block size of Apple Partition Map. 512 or 2048. This applies to", \
4539" start address and size of all partitions in the APM.", \
4540" APM gap fillers : decimal", \
4541" tells the number of partitions with name \"Gap[0-9[0-9]]\" and type", \
4542" \"ISO9660_data\".", \
4543" APM partition name : X text", \
4544" the name of partition X. Up to 32 characters.", \
4545" APM partition type : X text", \
4546" the type string of partition X. Up to 32 characters.", \
4547" APM start and size : X decimal decimal", \
4548" start block and number of blocks of partition X.", \
4549" APM partition path : X path", \
4550" the path of a file in the ISO image which begins at the partition", \
4551" start block of partition X.", \
4552""

◆ ISO_SYSAREA_REPORT_DOC_GPT1

#define ISO_SYSAREA_REPORT_DOC_GPT1

Definition at line 4468 of file libisofs.h.

4468#define ISO_SYSAREA_REPORT_DOC_GPT1 \
4469\
4470"GUID Partition Table can coexist with MBR:", \
4471" GPT : N Info", \
4472" headline for GPT partition table. The fields are too wide for a", \
4473" neat table. So they are listed with a partition number and a text.", \
4474" GPT CRC should be : <hex> to match first 92 GPT header block bytes", \
4475" GPT CRC found : <hex> matches all 512 bytes of GPT header block", \
4476" libisofs-1.2.4 to 1.2.8 had a bug with the GPT header CRC. So", \
4477" libisofs is willing to recognize GPT with the buggy CRC. These", \
4478" two lines inform that most partition editors will not accept it.", \
4479" GPT array CRC wrong: should be <hex>, found <hex>", \
4480" GPT entry arrays are accepted even if their CRC does not match.", \
4481" In this case, both CRCs are reported by this line.", \
4482" GPT backup problems: text", \
4483" reports about inconsistencies between main GPT and backup GPT.", \
4484" The statements are comma separated:", \
4485" Implausible header LBA <decimal>", \
4486" Cannot read header block at 2k LBA <decimal>", \
4487" Not a GPT 1.0 header of 92 bytes for 128 bytes per entry", \
4488" Head CRC <hex> wrong. Should be <hex>", \
4489" Head CRC <hex> wrong. Should be <hex>. Matches all 512 block bytes", \
4490" Disk GUID differs (<hex_digits>)", \
4491" Cannot read array block at 2k LBA <decimal>", \
4492" Array CRC <hex> wrong. Should be <hex>", \
4493" Entries differ for partitions <decimal> [... <decimal>]", \
4494" GPT disk GUID : hex_digits", \
4495" 32 hex digits giving the byte string of the disk's GUID", \
4496" GPT entry array : decimal decimal word", \
4497" start block of partition entry array and number of entries. 512 bytes", \
4498" per block. The word may be \"separated\" if partitions are disjoint,", \
4499" \"overlapping\" if they are not. In future there may be \"nested\"", \
4500" as special case where all overlapping partitions are superset and", \
4501" subset, and \"covering\" as special case of disjoint partitions", \
4502" covering the whole GPT block range for partitions.", \
4503" GPT lba range : decimal decimal decimal", \
4504" addresses of first payload block, last payload block, and of the", \
4505" GPT backup header block. 512 bytes per block." \
4506

◆ ISO_SYSAREA_REPORT_DOC_GPT2

#define ISO_SYSAREA_REPORT_DOC_GPT2
Value:
\
" GPT partition name : X hex_digits", \
" up to 144 hex digits giving the UTF-16LE name byte string of", \
" partition X. Trailing 16 bit 0-characters are omitted.", \
" GPT partname local : X text", \
" the name of partition X converted to the local character set.", \
" This line may be missing if the name cannot be converted, or is", \
" empty.", \
" GPT partition GUID : X hex_digits", \
" 32 hex digits giving the byte string of the GUID of partition X.", \
" GPT type GUID : X hex_digits", \
" 32 hex digits giving the byte string of the type GUID of partition X.", \
" GPT partition flags: X hex", \
" 64 flag bits of partition X in hex representation.", \
" Known bit meanings are:", \
" bit0 = \"System Partition\" Do not alter.", \
" bit2 = Legacy BIOS bootable (MBR partition type 0x80)", \
" bit60= read-only", \
" GPT start and size : X decimal decimal", \
" start block and number of blocks of partition X. 512 bytes per block.", \
" GPT partition path : X path", \
" the path of a file in the ISO image which begins at the partition", \
" start block of partition X.", \
""

Definition at line 4507 of file libisofs.h.

4507#define ISO_SYSAREA_REPORT_DOC_GPT2 \
4508\
4509" GPT partition name : X hex_digits", \
4510" up to 144 hex digits giving the UTF-16LE name byte string of", \
4511" partition X. Trailing 16 bit 0-characters are omitted.", \
4512" GPT partname local : X text", \
4513" the name of partition X converted to the local character set.", \
4514" This line may be missing if the name cannot be converted, or is", \
4515" empty.", \
4516" GPT partition GUID : X hex_digits", \
4517" 32 hex digits giving the byte string of the GUID of partition X.", \
4518" GPT type GUID : X hex_digits", \
4519" 32 hex digits giving the byte string of the type GUID of partition X.", \
4520" GPT partition flags: X hex", \
4521" 64 flag bits of partition X in hex representation.", \
4522" Known bit meanings are:", \
4523" bit0 = \"System Partition\" Do not alter.", \
4524" bit2 = Legacy BIOS bootable (MBR partition type 0x80)", \
4525" bit60= read-only", \
4526" GPT start and size : X decimal decimal", \
4527" start block and number of blocks of partition X. 512 bytes per block.", \
4528" GPT partition path : X path", \
4529" the path of a file in the ISO image which begins at the partition", \
4530" start block of partition X.", \
4531""

◆ ISO_SYSAREA_REPORT_DOC_HPPA

#define ISO_SYSAREA_REPORT_DOC_HPPA
Value:
\
"If a HP-PA PALO boot sector version 4 or 5 is present:", \
" PALO header version: decimal", \
" tells the PALO header version: 4 or 5.", \
" HP-PA cmdline : text", \
" tells the command line for the kernels.", \
" HP-PA boot files : ByteAddr ByteSize Path", \
" headline for human readers.", \
" HP-PA 32-bit kernel: decimal decimal path", \
" tells start byte, byte count, and file path of the 32-bit kernel.", \
" HP-PA 64-bit kernel: decimal decimal path", \
" tells the same for the 64-bit kernel.", \
" HP-PA ramdisk : decimal decimal path", \
" tells the same for the ramdisk file.", \
" HP-PA bootloader : decimal decimal path", \
" tells the same for the bootloader file.", \
""

Definition at line 4600 of file libisofs.h.

4600#define ISO_SYSAREA_REPORT_DOC_HPPA \
4601\
4602"If a HP-PA PALO boot sector version 4 or 5 is present:", \
4603" PALO header version: decimal", \
4604" tells the PALO header version: 4 or 5.", \
4605" HP-PA cmdline : text", \
4606" tells the command line for the kernels.", \
4607" HP-PA boot files : ByteAddr ByteSize Path", \
4608" headline for human readers.", \
4609" HP-PA 32-bit kernel: decimal decimal path", \
4610" tells start byte, byte count, and file path of the 32-bit kernel.", \
4611" HP-PA 64-bit kernel: decimal decimal path", \
4612" tells the same for the 64-bit kernel.", \
4613" HP-PA ramdisk : decimal decimal path", \
4614" tells the same for the ramdisk file.", \
4615" HP-PA bootloader : decimal decimal path", \
4616" tells the same for the bootloader file.", \
4617""

◆ ISO_SYSAREA_REPORT_DOC_MBR

#define ISO_SYSAREA_REPORT_DOC_MBR
Value:
\
"If an MBR is detected, with at least one partition entry of non-zero size,", \
"then there may be:", \
" Partition offset : decimal", \
" if not 0 then a second ISO 9660 superblock was found to which", \
" MBR partition 1 or GPT partition 1 is pointing.", \
" MBR heads per cyl : decimal", \
" conversion factor between MBR C/H/S address and LBA. 0=inconsistent.", \
" MBR secs per head : decimal", \
" conversion factor between MBR C/H/S address and LBA. 0=inconsistent.", \
" MBR partition table: N Status Type Start Blocks", \
" headline for MBR partition table.", \
" MBR partition : X hex hex decimal decimal", \
" gives partition number, status byte, type byte, start block,", \
" and number of blocks. 512 bytes per block.", \
" MBR partition path : X path", \
" the path of a file in the ISO image which begins at the partition", \
" start block of partition X.", \
" PReP boot partition: decimal decimal", \
" gives start block and size of a PReP boot partition in ISO 9660", \
" block units of 2048 bytes.", \
""

Definition at line 4445 of file libisofs.h.

4445#define ISO_SYSAREA_REPORT_DOC_MBR \
4446\
4447"If an MBR is detected, with at least one partition entry of non-zero size,", \
4448"then there may be:", \
4449" Partition offset : decimal", \
4450" if not 0 then a second ISO 9660 superblock was found to which", \
4451" MBR partition 1 or GPT partition 1 is pointing.", \
4452" MBR heads per cyl : decimal", \
4453" conversion factor between MBR C/H/S address and LBA. 0=inconsistent.", \
4454" MBR secs per head : decimal", \
4455" conversion factor between MBR C/H/S address and LBA. 0=inconsistent.", \
4456" MBR partition table: N Status Type Start Blocks", \
4457" headline for MBR partition table.", \
4458" MBR partition : X hex hex decimal decimal", \
4459" gives partition number, status byte, type byte, start block,", \
4460" and number of blocks. 512 bytes per block.", \
4461" MBR partition path : X path", \
4462" the path of a file in the ISO image which begins at the partition", \
4463" start block of partition X.", \
4464" PReP boot partition: decimal decimal", \
4465" gives start block and size of a PReP boot partition in ISO 9660", \
4466" block units of 2048 bytes.", \
4467""

◆ ISO_SYSAREA_REPORT_DOC_MIPS

#define ISO_SYSAREA_REPORT_DOC_MIPS
Value:
\
"If a MIPS Big Endian Volume Header is detected, there may be:", \
" MIPS-BE volume dir : N Name Block Bytes", \
" headline for human readers.", \
" MIPS-BE boot entry : X upto8chr decimal decimal", \
" tells name, 512-byte block address, and byte count of boot entry X.", \
" MIPS-BE boot path : X path", \
" tells the path to the boot image file in the ISO image which belongs", \
" to the block address given by boot entry X.", \
"", \
"If a DEC Boot Block for MIPS Little Endian is detected, there may be:", \
" MIPS-LE boot map : LoadAddr ExecAddr SegmentSize SegmentStart", \
" headline for human readers.", \
" MIPS-LE boot params: decimal decimal decimal decimal", \
" tells four numbers which are originally derived from the ELF header", \
" of the boot file. The first two are counted in bytes, the other two", \
" are counted in blocks of 512 bytes.", \
" MIPS-LE boot path : path", \
" tells the path to the boot file in the ISO image which belongs to the", \
" address given by SegmentStart.", \
" MIPS-LE elf offset : decimal", \
" tells the relative 512-byte block offset inside the boot file:", \
" SegmentStart - FileStartBlock", \
""

Definition at line 4553 of file libisofs.h.

4553#define ISO_SYSAREA_REPORT_DOC_MIPS \
4554\
4555"If a MIPS Big Endian Volume Header is detected, there may be:", \
4556" MIPS-BE volume dir : N Name Block Bytes", \
4557" headline for human readers.", \
4558" MIPS-BE boot entry : X upto8chr decimal decimal", \
4559" tells name, 512-byte block address, and byte count of boot entry X.", \
4560" MIPS-BE boot path : X path", \
4561" tells the path to the boot image file in the ISO image which belongs", \
4562" to the block address given by boot entry X.", \
4563"", \
4564"If a DEC Boot Block for MIPS Little Endian is detected, there may be:", \
4565" MIPS-LE boot map : LoadAddr ExecAddr SegmentSize SegmentStart", \
4566" headline for human readers.", \
4567" MIPS-LE boot params: decimal decimal decimal decimal", \
4568" tells four numbers which are originally derived from the ELF header", \
4569" of the boot file. The first two are counted in bytes, the other two", \
4570" are counted in blocks of 512 bytes.", \
4571" MIPS-LE boot path : path", \
4572" tells the path to the boot file in the ISO image which belongs to the", \
4573" address given by SegmentStart.", \
4574" MIPS-LE elf offset : decimal", \
4575" tells the relative 512-byte block offset inside the boot file:", \
4576" SegmentStart - FileStartBlock", \
4577""

◆ ISO_SYSAREA_REPORT_DOC_SUN

#define ISO_SYSAREA_REPORT_DOC_SUN
Value:
\
"If a SUN SPARC Disk Label is present:", \
" SUN SPARC disklabel: text", \
" tells the disk label text.", \
" SUN SPARC secs/head: decimal", \
" tells the number of sectors per head.", \
" SUN SPARC heads/cyl: decimal", \
" tells the number of heads per cylinder.", \
" SUN SPARC partmap : N IdTag Perms StartCyl NumBlock", \
" headline for human readers.", \
" SUN SPARC partition: X hex hex decimal decimal", \
" gives partition number, type word, permission word, start cylinder,", \
" and number of of blocks. 512 bytes per block. Type word may be: ", \
" 0=unused, 2=root partition with boot, 4=user partition.", \
" Permission word is 0x10 = read-only.", \
" SPARC GRUB2 core : decimal decimal", \
" tells byte address and byte count of the GRUB2 SPARC core file.", \
" SPARC GRUB2 path : path", \
" tells the path to the data file in the ISO image which belongs to the", \
" address given by core.", \
""

Definition at line 4578 of file libisofs.h.

4578#define ISO_SYSAREA_REPORT_DOC_SUN \
4579\
4580"If a SUN SPARC Disk Label is present:", \
4581" SUN SPARC disklabel: text", \
4582" tells the disk label text.", \
4583" SUN SPARC secs/head: decimal", \
4584" tells the number of sectors per head.", \
4585" SUN SPARC heads/cyl: decimal", \
4586" tells the number of heads per cylinder.", \
4587" SUN SPARC partmap : N IdTag Perms StartCyl NumBlock", \
4588" headline for human readers.", \
4589" SUN SPARC partition: X hex hex decimal decimal", \
4590" gives partition number, type word, permission word, start cylinder,", \
4591" and number of of blocks. 512 bytes per block. Type word may be: ", \
4592" 0=unused, 2=root partition with boot, 4=user partition.", \
4593" Permission word is 0x10 = read-only.", \
4594" SPARC GRUB2 core : decimal decimal", \
4595" tells byte address and byte count of the GRUB2 SPARC core file.", \
4596" SPARC GRUB2 path : path", \
4597" tells the path to the data file in the ISO image which belongs to the", \
4598" address given by core.", \
4599""

◆ ISO_THREAD_ERROR

#define ISO_THREAD_ERROR   0xF030FFF7

Can't create a needed thread (FATAL,HIGH, -9)

Definition at line 8927 of file libisofs.h.

◆ ISO_TOO_MANY_CE

#define ISO_TOO_MANY_CE   0xE830FE55

Too many CE entries for single file (FAILURE,HIGH, -427)

Definition at line 9438 of file libisofs.h.

◆ ISO_TOO_MANY_CE_FOR_LINUX

#define ISO_TOO_MANY_CE_FOR_LINUX   0xD030FE54

Too many CE entries for single file when mounted by Linux (WARNING,HIGH, -428)

Definition at line 9442 of file libisofs.h.

◆ ISO_TRUNCATE_ISOFSNT

#define ISO_TRUNCATE_ISOFSNT   0xB030FE63

File name truncation length changed by loaded image info (NOTE, HIGH, -413)

Definition at line 9392 of file libisofs.h.

◆ ISO_UNDEF_READ_FEATURE

#define ISO_UNDEF_READ_FEATURE   0xE030FE56

Undefined IsoReadImageFeatures name (SORRY, HIGH, -426)

Definition at line 9435 of file libisofs.h.

◆ ISO_UNSUPPORTED_ECMA119

#define ISO_UNSUPPORTED_ECMA119   0xE830FEBC

Unsupported ECMA-119 feature (FAILURE,HIGH, -324)

Definition at line 9061 of file libisofs.h.

◆ ISO_UNSUPPORTED_EL_TORITO

#define ISO_UNSUPPORTED_EL_TORITO   0xD030FEBA

Unsupported El-Torito feature (WARN,HIGH, -326)

Definition at line 9067 of file libisofs.h.

◆ ISO_UNSUPPORTED_RR

#define ISO_UNSUPPORTED_RR   0xE030FEBE

Unsupported RR feature (SORRY,HIGH, -322)

Definition at line 9055 of file libisofs.h.

◆ ISO_UNSUPPORTED_SUSP

#define ISO_UNSUPPORTED_SUSP   0xE030FEB8

Unsupported SUSP feature (SORRY,HIGH, -328)

Definition at line 9073 of file libisofs.h.

◆ ISO_UNSUPPORTED_VD

#define ISO_UNSUPPORTED_VD   0xC020FEB4

Unsupported volume descriptor found (HINT,MEDIUM, -332)

Definition at line 9085 of file libisofs.h.

◆ ISO_WRITE_ERROR

#define ISO_WRITE_ERROR   0xE830FFF6

Write error (FAILURE,HIGH, -10)

Definition at line 8930 of file libisofs.h.

◆ ISO_WRONG_ARG_VALUE

#define ISO_WRONG_ARG_VALUE   0xE830FFF8

Invalid parameter value (FAILURE,HIGH, -8)

Definition at line 8924 of file libisofs.h.

◆ ISO_WRONG_ECMA119

#define ISO_WRONG_ECMA119   0xE830FEBD

Wrong or damaged ECMA-119 (FAILURE,HIGH, -323)

Definition at line 9058 of file libisofs.h.

◆ ISO_WRONG_EL_TORITO

#define ISO_WRONG_EL_TORITO   0xD030FEBB

Wrong or damaged El-Torito catalog (WARN,HIGH, -325)

Definition at line 9064 of file libisofs.h.

◆ ISO_WRONG_PVD

#define ISO_WRONG_PVD   0xE830FEC0

Wrong or damaged Primary Volume Descriptor (FAILURE,HIGH, -320) This could mean that the file is not a valid ISO image.

Definition at line 9049 of file libisofs.h.

◆ ISO_WRONG_RR

#define ISO_WRONG_RR   0xE030FEBF

Wrong or damaged RR entry (SORRY,HIGH, -321)

Definition at line 9052 of file libisofs.h.

◆ ISO_WRONG_RR_WARN

#define ISO_WRONG_RR_WARN   0xD030FEB7

Error on a RR entry that can be ignored (WARNING,HIGH, -329)

Definition at line 9076 of file libisofs.h.

◆ ISO_XINFO_NO_CLONE

#define ISO_XINFO_NO_CLONE   0xE830FE89

Extended information class offers no cloning method (FAILURE, HIGH, -375)

Definition at line 9270 of file libisofs.h.

◆ ISO_ZISOFS_BPT_UNDERRUN

#define ISO_ZISOFS_BPT_UNDERRUN   0xD020FE58

Prevented zisofs block pointer counter underrun (WARNING,MEDIUM, -424)

Definition at line 9429 of file libisofs.h.

◆ ISO_ZISOFS_PARAM_LOCK

#define ISO_ZISOFS_PARAM_LOCK   0xE830FEA2

Cannot set global zisofs parameters while filters exist (FAILURE, HIGH, -350)

Definition at line 9149 of file libisofs.h.

◆ ISO_ZISOFS_TOO_LARGE

#define ISO_ZISOFS_TOO_LARGE   0xE830FEA6

File too large.

Cannot apply zisofs filter. (FAILURE, HIGH, -346)

Definition at line 9136 of file libisofs.h.

◆ ISO_ZISOFS_TOO_MANY_PTR

#define ISO_ZISOFS_TOO_MANY_PTR   0xE830FE59

Too many zisofs block pointers needed overall (FAILURE, HIGH, -423)

Definition at line 9426 of file libisofs.h.

◆ ISO_ZISOFS_UNKNOWN_SIZE

#define ISO_ZISOFS_UNKNOWN_SIZE   0xE830FE57

Cannot obtain size of zisofs compressed stream (FAILURE, HIGH, -425)

Definition at line 9432 of file libisofs.h.

◆ ISO_ZISOFS_WRONG_INPUT

#define ISO_ZISOFS_WRONG_INPUT   0xE830FEA3

Input stream is not in a supported zisofs format (FAILURE, HIGH, -349)

Definition at line 9145 of file libisofs.h.

◆ ISO_ZLIB_COMPR_ERR

#define ISO_ZLIB_COMPR_ERR   0xE830FEA4

zlib compression/decompression error (FAILURE, HIGH, -348)

Definition at line 9142 of file libisofs.h.

◆ ISO_ZLIB_EARLY_EOF

#define ISO_ZLIB_EARLY_EOF   0xE830FEA1

Premature EOF of zlib input stream (FAILURE, HIGH, -351)

Definition at line 9152 of file libisofs.h.

◆ ISO_ZLIB_NOT_ENABLED

#define ISO_ZLIB_NOT_ENABLED   0xE830FEA7

Use of zlib was not enabled at compile time (FAILURE, HIGH, -345)

Definition at line 9133 of file libisofs.h.

◆ LIBISO_MAX_LINK_DEPTH

#define LIBISO_MAX_LINK_DEPTH   100

Definition at line 6762 of file libisofs.h.

◆ Libisofs_default_path_maX

#define Libisofs_default_path_maX   4096

Definition at line 7969 of file libisofs.h.

Typedef Documentation

◆ ElToritoBootImage

typedef struct el_torito_boot_image ElToritoBootImage

It represents an El-Torito boot image.

Since
0.6.2

Definition at line 284 of file libisofs.h.

◆ iso_node_xinfo_cloner

typedef int(* iso_node_xinfo_cloner) (void *old_data, void **new_data, int flag)

Class of functions to clone extended information.

A function instance gets associated to a particular iso_node_xinfo_func instance by function iso_node_xinfo_make_clonable(). This is a precondition to have IsoNode objects clonable which carry data for a particular iso_node_xinfo_func.

Parameters
old_dataData item to be cloned
new_dataShall return the cloned data item
flagUnused yet, submit 0 The function shall return ISO_XINFO_NO_CLONE on unknown flag bits.
Returns
> 0 number of allocated bytes 0 no size info is available < 0 error
Since
1.0.2

Definition at line 5137 of file libisofs.h.

◆ iso_node_xinfo_func

typedef int(* iso_node_xinfo_func) (void *data, int flag)

Class of functions to handle particular extended information.

A function instance acts as an identifier for the type of the information. Structs with same information type must use a pointer to the same function.

Parameters
dataAttached data
flagWhat to do with the data. At this time the following values are defined: -> 1 the data must be freed
Returns
1 in any case.
Since
0.6.4

Definition at line 5007 of file libisofs.h.

◆ IsoBoot

typedef struct Iso_Boot IsoBoot

An special type of IsoNode that acts as a placeholder for an El-Torito boot catalog.

Once written, it will appear as a regular file.

Since
0.6.2

Definition at line 292 of file libisofs.h.

◆ IsoDataSource

Source for image reading.

See also
struct iso_data_source
Since
0.6.2

Definition at line 396 of file libisofs.h.

◆ IsoDir

typedef struct Iso_Dir IsoDir

A directory in the iso tree.

It is an special type of IsoNode and can be casted to it in any case.

Since
0.6.2

Definition at line 183 of file libisofs.h.

◆ IsoDirIter

typedef struct Iso_Dir_Iter IsoDirIter

Context for iterate on directory children.

See also
iso_dir_get_children()
Since
0.6.2

Definition at line 277 of file libisofs.h.

◆ IsoExternalFilterCommand

Definition at line 8105 of file libisofs.h.

◆ IsoFile

typedef struct Iso_File IsoFile

A regular file in the iso tree.

It is an special type of IsoNode and can be casted to it in any case.

Since
0.6.2

Definition at line 199 of file libisofs.h.

◆ IsoFileSource

POSIX abstraction for source files.

See also
struct iso_file_source
Since
0.6.2

Definition at line 488 of file libisofs.h.

◆ IsoFileSourceIface

Interface that defines the operations (methods) available for an IsoFileSource.

See also
struct IsoFileSource_Iface
Since
0.6.2

Definition at line 505 of file libisofs.h.

◆ IsoFilesystem

typedef struct iso_filesystem IsoFilesystem

Abstract for source filesystems.

See also
struct iso_filesystem
Since
0.6.2

Definition at line 496 of file libisofs.h.

◆ IsoFindCondition

typedef struct iso_find_condition IsoFindCondition
Since
0.6.4

Definition at line 5660 of file libisofs.h.

◆ IsoImage

typedef struct Iso_Image IsoImage

Context for image creation.

It holds the files that will be added to image, and several options to control libisofs behavior.

Since
0.6.2

Definition at line 164 of file libisofs.h.

◆ IsoImageFilesystem

IsoFilesystem implementation to deal with ISO images, and to offer a way to access specific information of the image, such as several volume attributes, extensions being used, El-Torito artifacts...

Since
0.6.2

Definition at line 514 of file libisofs.h.

◆ IsoNode

typedef struct Iso_Node IsoNode

Definition at line 175 of file libisofs.h.

◆ IsoReadImageFeatures

typedef struct iso_read_image_features IsoReadImageFeatures

Return information for image.

This is optionally allocated by libisofs, as a way to inform user about the features of an existing image, such as extensions present, size, ...

See also
iso_image_import()
Since
0.6.2

Definition at line 480 of file libisofs.h.

◆ IsoReadOpts

typedef struct iso_read_opts IsoReadOpts

Options for image reading or import.

See also
iso_read_opts_new()
Since
0.6.2

Definition at line 388 of file libisofs.h.

◆ IsoSpecial

typedef struct Iso_Special IsoSpecial

An special file in the iso tree.

This is used to represent any POSIX file other that regular files, directories or symlinks, i.e.: socket, block and character devices, and fifos. It is an special type of IsoNode and can be casted to it in any case.

Since
0.6.2

Definition at line 209 of file libisofs.h.

◆ IsoStream

typedef struct iso_stream IsoStream

Representation of file contents.

It is an stream of bytes, functionally like a pipe.

Since
0.6.4

Definition at line 954 of file libisofs.h.

◆ IsoStreamIface

Interface that defines the operations (methods) available for an IsoStream.

See also
struct IsoStream_Iface
Since
0.6.4

Definition at line 963 of file libisofs.h.

◆ IsoSymlink

typedef struct Iso_Symlink IsoSymlink

A symbolic link in the iso tree.

It is an special type of IsoNode and can be casted to it in any case.

Since
0.6.2

Definition at line 191 of file libisofs.h.

◆ IsoWriteOpts

typedef struct iso_write_opts IsoWriteOpts

Options for image written.

See also
iso_write_opts_new()
Since
0.6.2

Definition at line 381 of file libisofs.h.

Enumeration Type Documentation

◆ eltorito_boot_media_type

El-Torito bootable image type.

Since
0.6.2
Enumerator
ELTORITO_FLOPPY_EMUL 
ELTORITO_HARD_DISC_EMUL 
ELTORITO_NO_EMUL 

Definition at line 334 of file libisofs.h.

334 {
338};
@ ELTORITO_HARD_DISC_EMUL
Definition libisofs.h:336
@ ELTORITO_FLOPPY_EMUL
Definition libisofs.h:335
@ ELTORITO_NO_EMUL
Definition libisofs.h:337

◆ iso_find_comparisons

Possible comparison between IsoNode and given conditions.

Since
0.6.4
Enumerator
ISO_FIND_COND_GREATER 
ISO_FIND_COND_GREATER_OR_EQUAL 
ISO_FIND_COND_EQUAL 
ISO_FIND_COND_LESS 
ISO_FIND_COND_LESS_OR_EQUAL 

Definition at line 5722 of file libisofs.h.

5722 {
5728};
@ ISO_FIND_COND_LESS
Definition libisofs.h:5726
@ ISO_FIND_COND_EQUAL
Definition libisofs.h:5725
@ ISO_FIND_COND_LESS_OR_EQUAL
Definition libisofs.h:5727
@ ISO_FIND_COND_GREATER_OR_EQUAL
Definition libisofs.h:5724
@ ISO_FIND_COND_GREATER
Definition libisofs.h:5723

◆ iso_replace_mode

Replace mode used when adding a node to a directory.

This controls how libisofs will act when you tried to add to a dir a file with the same name that an existing file.

Since
0.6.2
Enumerator
ISO_REPLACE_NEVER 

Never replace an existing node, and instead fail with ISO_NODE_NAME_NOT_UNIQUE.

ISO_REPLACE_ALWAYS 

Always replace the old node with the new.

ISO_REPLACE_IF_SAME_TYPE 

Replace with the new node if it is the same file type.

ISO_REPLACE_IF_SAME_TYPE_AND_NEWER 

Replace with the new node if it is the same file type and its ctime is newer than the old one.

ISO_REPLACE_IF_NEWER 

Replace with the new node if its ctime is newer than the old one.

Definition at line 347 of file libisofs.h.

347 {
348 /**
349 * Never replace an existing node, and instead fail with
350 * ISO_NODE_NAME_NOT_UNIQUE.
351 */
353 /**
354 * Always replace the old node with the new.
355 */
357 /**
358 * Replace with the new node if it is the same file type
359 */
361 /**
362 * Replace with the new node if it is the same file type and its ctime
363 * is newer than the old one.
364 */
366 /**
367 * Replace with the new node if its ctime is newer than the old one.
368 */
370 /*
371 * TODO #00006 define more values
372 * -if both are dirs, add contents (and what to do with conflicts?)
373 */
374};
@ ISO_REPLACE_IF_SAME_TYPE_AND_NEWER
Replace with the new node if it is the same file type and its ctime is newer than the old one.
Definition libisofs.h:365
@ ISO_REPLACE_ALWAYS
Always replace the old node with the new.
Definition libisofs.h:356
@ ISO_REPLACE_IF_NEWER
Replace with the new node if its ctime is newer than the old one.
Definition libisofs.h:369
@ ISO_REPLACE_IF_SAME_TYPE
Replace with the new node if it is the same file type.
Definition libisofs.h:360
@ ISO_REPLACE_NEVER
Never replace an existing node, and instead fail with ISO_NODE_NAME_NOT_UNIQUE.
Definition libisofs.h:352

◆ IsoHfsplusBlessings

HFS+ blessings are relationships between HFS+ enhanced ISO images and particular files in such images.

Except for ISO_HFSPLUS_BLESS_INTEL_BOOTFILE and ISO_HFSPLUS_BLESS_MAX, these files have to be directories. No file may have more than one blessing. Each blessing can only be issued to one file.

Since
1.2.4
Enumerator
ISO_HFSPLUS_BLESS_PPC_BOOTDIR 
ISO_HFSPLUS_BLESS_INTEL_BOOTFILE 
ISO_HFSPLUS_BLESS_SHOWFOLDER 
ISO_HFSPLUS_BLESS_OS9_FOLDER 
ISO_HFSPLUS_BLESS_OSX_FOLDER 
ISO_HFSPLUS_BLESS_MAX 

Definition at line 8758 of file libisofs.h.

8758 {
8759 /* The blessing that is issued by mkisofs option -hfs-bless. */
8761
8762 /* To be applied to a data file */
8764
8765 /* Further blessings for directories */
8769
8770 /* Not a blessing, but telling the number of blessings in this list */
8772};
@ ISO_HFSPLUS_BLESS_SHOWFOLDER
Definition libisofs.h:8766
@ ISO_HFSPLUS_BLESS_OSX_FOLDER
Definition libisofs.h:8768
@ ISO_HFSPLUS_BLESS_PPC_BOOTDIR
Definition libisofs.h:8760
@ ISO_HFSPLUS_BLESS_MAX
Definition libisofs.h:8771
@ ISO_HFSPLUS_BLESS_INTEL_BOOTFILE
Definition libisofs.h:8763
@ ISO_HFSPLUS_BLESS_OS9_FOLDER
Definition libisofs.h:8767

◆ IsoHideNodeFlag

Flag used to hide a file in the RR/ISO or Joliet tree.

See also
iso_node_set_hidden
Since
0.6.2
Enumerator
LIBISO_HIDE_ON_RR 

Hide the node in the ECMA-119 / RR tree.

LIBISO_HIDE_ON_JOLIET 

Hide the node in the Joliet tree, if Joliet extension are enabled.

LIBISO_HIDE_ON_1999 

Hide the node in the ISO-9660:1999 tree, if that format is enabled.

LIBISO_HIDE_ON_HFSPLUS 

Hide the node in the HFS+ tree, if that format is enabled.

Since
1.2.4
LIBISO_HIDE_ON_FAT 

Hide the node in the FAT tree, if that format is enabled.

Since
1.2.4
LIBISO_HIDE_BUT_WRITE 

With IsoNode and IsoBoot: Write data content even if the node is not visible in any tree.

With directory nodes : Write data content of IsoNode and IsoBoot in the directory's tree unless they are explicitly marked LIBISO_HIDE_ON_RR without LIBISO_HIDE_BUT_WRITE.

Since
0.6.34

Definition at line 300 of file libisofs.h.

300 {
301 /** Hide the node in the ECMA-119 / RR tree */
302 LIBISO_HIDE_ON_RR = 1 << 0,
303 /** Hide the node in the Joliet tree, if Joliet extension are enabled */
304 LIBISO_HIDE_ON_JOLIET = 1 << 1,
305 /** Hide the node in the ISO-9660:1999 tree, if that format is enabled */
306 LIBISO_HIDE_ON_1999 = 1 << 2,
307
308 /** Hide the node in the HFS+ tree, if that format is enabled.
309 @since 1.2.4
310 */
311 LIBISO_HIDE_ON_HFSPLUS = 1 << 4,
312
313 /** Hide the node in the FAT tree, if that format is enabled.
314 @since 1.2.4
315 */
316 LIBISO_HIDE_ON_FAT = 1 << 5,
317
318 /** With IsoNode and IsoBoot: Write data content even if the node is
319 * not visible in any tree.
320 * With directory nodes : Write data content of IsoNode and IsoBoot
321 * in the directory's tree unless they are
322 * explicitly marked LIBISO_HIDE_ON_RR
323 * without LIBISO_HIDE_BUT_WRITE.
324 * @since 0.6.34
325 */
326 LIBISO_HIDE_BUT_WRITE = 1 << 3
327};
@ LIBISO_HIDE_ON_JOLIET
Hide the node in the Joliet tree, if Joliet extension are enabled.
Definition libisofs.h:304
@ LIBISO_HIDE_BUT_WRITE
With IsoNode and IsoBoot: Write data content even if the node is not visible in any tree.
Definition libisofs.h:326
@ LIBISO_HIDE_ON_1999
Hide the node in the ISO-9660:1999 tree, if that format is enabled.
Definition libisofs.h:306
@ LIBISO_HIDE_ON_HFSPLUS
Hide the node in the HFS+ tree, if that format is enabled.
Definition libisofs.h:311
@ LIBISO_HIDE_ON_RR
Hide the node in the ECMA-119 / RR tree.
Definition libisofs.h:302
@ LIBISO_HIDE_ON_FAT
Hide the node in the FAT tree, if that format is enabled.
Definition libisofs.h:316

◆ IsoNodeType

The type of an IsoNode.

When an user gets an IsoNode from an image, (s)he can use iso_node_get_type() to get the current type of the node, and then cast to the appropriate subtype. For example:

... IsoNode *node; res = iso_dir_iter_next(iter, &node); if (res == 1 && iso_node_get_type(node) == LIBISO_DIR) { IsoDir *dir = (IsoDir *)node; ... }

Since
0.6.2
Enumerator
LIBISO_DIR 
LIBISO_FILE 
LIBISO_SYMLINK 
LIBISO_SPECIAL 
LIBISO_BOOT 

Definition at line 228 of file libisofs.h.

228 {
234};
@ LIBISO_BOOT
Definition libisofs.h:233
@ LIBISO_DIR
Definition libisofs.h:229
@ LIBISO_FILE
Definition libisofs.h:230
@ LIBISO_SYMLINK
Definition libisofs.h:231
@ LIBISO_SPECIAL
Definition libisofs.h:232

Function Documentation

◆ aaip_xinfo_cloner()

int aaip_xinfo_cloner ( void * old_data,
void ** new_data,
int flag )

The iso_node_xinfo_cloner function which gets associated to aaip_xinfo_func by iso_init() or iso_init_with_flag() via iso_node_xinfo_make_clonable().

Since
1.0.2

◆ aaip_xinfo_func()

int aaip_xinfo_func ( void * data,
int flag )

Function to identify and manage AAIP strings as xinfo of IsoNode.

An AAIP string contains the Attribute List with the xattr and ACL of a node in the image tree. It is formatted according to libisofs specification AAIP-2.0 and ready to be written into the System Use Area or Continuation Area of a directory entry in an ISO image.

Applications are not supposed to manipulate AAIP strings directly. They should rather make use of the appropriate iso_node_get_* and iso_node_set_* calls.

AAIP represents ACLs as xattr with empty name and AAIP-specific binary content. Local filesystems may represent ACLs as xattr with names like "system.posix_acl_access". libisofs does not interpret those local xattr representations of ACL directly but rather uses the ACL interface of the local system. By default the local xattr representations of ACL will not become part of the AAIP Attribute List via iso_local_get_attrs() and not be attached to local files via iso_local_set_attrs().

Since
0.6.14

◆ el_torito_get_boot_media_type()

int el_torito_get_boot_media_type ( ElToritoBootImage * bootimg,
enum eltorito_boot_media_type * media_type )

Get the boot media type as of parameter "type" of iso_image_set_boot_image() or iso_image_add_boot_image().

Parameters
bootimgThe image to inquire
media_typeReturns the media type
Returns
1 = ok , < 0 = error
Since
0.6.32

◆ el_torito_get_boot_platform_id()

int el_torito_get_boot_platform_id ( ElToritoBootImage * bootimg)

Get the platform ID value.

See el_torito_set_boot_platform_id().

Parameters
bootimgThe image to inquire
Returns
0 - 255 : The platform ID < 0 : error
Since
0.6.32

◆ el_torito_get_bootable()

int el_torito_get_bootable ( ElToritoBootImage * bootimg)

Get the bootability flag.

See el_torito_set_no_bootable().

Parameters
bootimgThe image to inquire
Returns
0 = not bootable, 1 = bootable , <0 = error
Since
0.6.32

◆ el_torito_get_full_load()

int el_torito_get_full_load ( ElToritoBootImage * bootimg)

Inquire the setting of el_torito_set_full_load().

Parameters
bootimgThe image to inquire
Returns
The mode set with el_torito_set_full_load().

◆ el_torito_get_id_string()

int el_torito_get_id_string ( ElToritoBootImage * bootimg,
uint8_t id_string[28] )

Get the id_string as of el_torito_set_id_string().

Parameters
bootimgThe image to inquire
id_stringReturns 28 bytes of id string
Returns
1 = ok , <0 = error
Since
0.6.32

◆ el_torito_get_isolinux_options()

int el_torito_get_isolinux_options ( ElToritoBootImage * bootimg,
int flag )

Get the options as of el_torito_set_isolinux_options().

Parameters
bootimgThe image to inquire
flagReserved for future usage, set to 0.
Returns
>= 0 returned option bits , <0 = error
Since
0.6.32

◆ el_torito_get_load_seg()

int el_torito_get_load_seg ( ElToritoBootImage * bootimg)

Get the load segment value.

See el_torito_set_load_seg().

Parameters
bootimgThe image to inquire
Returns
0 - 65535 : The load segment value < 0 : error
Since
0.6.32

◆ el_torito_get_load_size()

int el_torito_get_load_size ( ElToritoBootImage * bootimg)

Get the load size.

See el_torito_set_load_size().

Parameters
bootimgThe image to inquire
Returns
0 - 65535 : The load size value < 0 : error
Since
0.6.32

◆ el_torito_get_selection_crit()

int el_torito_get_selection_crit ( ElToritoBootImage * bootimg,
uint8_t crit[20] )

Get the Selection Criteria bytes as of el_torito_set_selection_crit().

Parameters
bootimgThe image to inquire
critReturns 20 bytes of type and data
Returns
1 = ok , <0 = error
Since
0.6.32

◆ el_torito_patch_isolinux_image()

void el_torito_patch_isolinux_image ( ElToritoBootImage * bootimg)

Deprecated: Specifies that this image needs to be patched.

This involves the writing of a 16 bytes boot information table at offset 8 of the boot image file. The original boot image file won't be modified. This is needed for isolinux boot images.

Since
0.6.2
Deprecated
Use el_torito_set_isolinux_options() instead

◆ el_torito_seems_boot_info_table()

int el_torito_seems_boot_info_table ( ElToritoBootImage * bootimg,
int flag )

Makes a guess whether the boot image was patched by a boot information table.

It is advisable to patch such boot images if their content gets copied to a new location. See el_torito_set_isolinux_options(). Note: The reply can be positive only if the boot image was imported from an existing ISO image.

Parameters
bootimgThe image to inquire
flagBitfield for control purposes: bit0 - bit3= mode 0 = inquire for classic boot info table as described in man mkisofs
Since
0.6.32 1 = inquire for GRUB2 boot info as of bit9 of options of el_torito_set_isolinux_options()
1.3.0
Returns
1 = seems to contain the inquired boot info, 0 = quite surely not
Since
0.6.32

◆ el_torito_set_boot_platform_id()

int el_torito_set_boot_platform_id ( ElToritoBootImage * bootimg,
uint8_t id )

Sets the platform ID of the boot image.

The Platform ID gets written into the boot catalog at byte 1 of the Validation Entry, or at byte 1 of a Section Header Entry. If Platform ID and ID String of two consecutive bootimages are the same

Parameters
bootimgThe image to manipulate.
idA Platform ID as of El Torito 1.0 : 0x00= 80x86, 0x01= PowerPC, 0x02= Mac Others : 0xef= EFI
Returns
1 ok , <=0 error
Since
0.6.32

◆ el_torito_set_full_load()

void el_torito_set_full_load ( ElToritoBootImage * bootimg,
int mode )

State that the load size shall be the size of the boot image automatically.

This overrides el_torito_set_load_size().

Parameters
bootimgThe image to to manipulate
mode0= use value of el_torito_set_load_size() 1= determine value from boot image

◆ el_torito_set_id_string()

int el_torito_set_id_string ( ElToritoBootImage * bootimg,
uint8_t id_string[28] )

Set the id_string of the Validation Entry or Sector Header Entry which will govern the boot image Section Entry in the El Torito Catalog.

Parameters
bootimgThe image to manipulate.
id_stringThe first boot image puts 24 bytes of ID string into the Validation Entry, where they shall "identify the manufacturer/developer of the CD-ROM". Further boot images put 28 bytes into their Section Header. El Torito 1.0 states that "If the BIOS understands the ID string, it may choose to boot the system using one of these entries in place of the INITIAL/DEFAULT entry." (The INITIAL/DEFAULT entry points to the first boot image.)
Returns
1 = ok , <0 = error
Since
0.6.32

◆ el_torito_set_isolinux_options()

int el_torito_set_isolinux_options ( ElToritoBootImage * bootimg,
int options,
int flag )

Specifies options for ISOLINUX or GRUB boot images.

This should only be used if the type of boot image is known.

Parameters
bootimgThe image to set options on
optionsbitmask style flag. The following values are defined:

bit0= Patch the boot info table of the boot image. This does the same as mkisofs option -boot-info-table. Needed for ISOLINUX or GRUB boot images with platform ID 0. The table is located at byte 8 of the boot image file. Its size is 56 bytes. The original boot image file on disk will not be modified.

One may use el_torito_seems_boot_info_table() for a qualified guess whether a boot info table is present in the boot image. If the result is 1 then it should get bit0 set if its content gets copied to a new LBA.

bit1= Generate a ISOLINUX isohybrid image with MBR.

Deprecated
since 31 Mar 2010: The author of syslinux, H. Peter Anvin requested that this feature shall not be used any more. He intends to cease

support for the MBR template that is included in libisofs.

A hybrid image is a boot image that boots from either CD/DVD media or from disk-like media, e.g. USB stick. For that you need isolinux.bin from SYSLINUX 3.72 or later. IMPORTANT: The application has to take care that the image on media gets padded up to the next full MB. Under seiveral circumstances it might get aligned automatically. But there is no warranty. bit2-7= Mentioning in isohybrid GPT 0= Do not mention in GPT 1= Mention as Basic Data partition. This cannot be combined with GPT partitions as of iso_write_opts_set_efi_bootp()

Since
1.2.4 2= Mention as HFS+ partition. This cannot be combined with HFS+ production by iso_write_opts_set_hfsplus().
1.2.4 Primary GPT and backup GPT get written if at least one ElToritoBootImage shall be mentioned. The first three mentioned GPT partitions get mirrored in the the partition table of the isohybrid MBR. They get type 0xfe. The MBR partition entry for PC-BIOS gets type 0x00 rather than 0x17. Often it is one of the further MBR partitions which actually gets used by EFI.
1.2.4 bit8= Mention in isohybrid Apple partition map APM get written if at least one ElToritoBootImage shall be mentioned. The ISOLINUX MBR must look suitable or else an error event will happen at image generation time.
1.2.4 bit9= GRUB2 boot info Patch the boot image file at byte 1012 with the 512-block address + 2. Two little endian 32-bit words. Low word first. This is combinable with bit0.
1.3.0
Parameters
flagReserved for future usage, set to 0.
Returns
1 success, < 0 on error
Since
0.6.12

◆ el_torito_set_load_seg()

void el_torito_set_load_seg ( ElToritoBootImage * bootimg,
short segment )

Sets the load segment for the initial boot image.

This is only for no emulation boot images, and is a NOP for other image types.

Parameters
bootimgThe image to to manipulate
segmentLoad segment address. The data type of this parameter is not fully suitable. You may submit negative numbers in the range ((short) 0x8000) to ((short) 0xffff) in order to express the non-negative numbers 0x8000 to 0xffff.
Since
0.6.2

◆ el_torito_set_load_size()

void el_torito_set_load_size ( ElToritoBootImage * bootimg,
short sectors )

Sets the number of sectors (512b) to be load at load segment during the initial boot procedure.

This is only for no emulation boot images, and is a NOP for other image types.

Parameters
bootimgThe image to to manipulate
sectorsNumber of 512-byte blocks to be loaded by the BIOS. The data type of this parameter is not fully suitable. You may submit negative numbers in the range ((short) 0x8000) to ((short) 0xffff) in order to express the non-negative numbers 0x8000 to 0xffff.
Since
0.6.2

◆ el_torito_set_no_bootable()

void el_torito_set_no_bootable ( ElToritoBootImage * bootimg)

Marks the specified boot image as not bootable.

Since
0.6.2

◆ el_torito_set_selection_crit()

int el_torito_set_selection_crit ( ElToritoBootImage * bootimg,
uint8_t crit[20] )

Set the Selection Criteria of a boot image.

Parameters
bootimgThe image to manipulate.
critThe first boot image has no selection criteria. They will be ignored. Further boot images put 1 byte of Selection Criteria Type and 19 bytes of data into their Section Entry. El Torito 1.0 states that "The format of the selection criteria is a function of the BIOS vendor. In the case of a foreign language BIOS three bytes would be used to identify the language". Type byte == 0 means "no criteria", type byte == 1 means "Language and Version Information (IBM)".
Returns
1 = ok , <0 = error
Since
0.6.32

◆ iso_assess_written_features()

int iso_assess_written_features ( IsoDataSource * src,
IsoReadOpts * opts,
IsoReadImageFeatures ** features,
IsoWriteOpts ** write_opts )

Assess features of the importable directory trees of src and an estimation of the write options which would cause the recognized features.

This goes deeper than the feature assessment of iso_image_import(), e.g. by inspecting file names.

For the parameters "src", "opts", and "features" see also the description of iso_image_import().

Parameters
srcData Source from which old image will be read.
optsOptions for image import. Settings about tree choice will be ignored.
featuresReturns the pointer to a newly allocated and filled IsoReadImageFeatures object. NULL is not allowed, other than with iso_image_import(). If *features is returned as non-NULL, then it should be freed with iso_read_image_features_destroy() when no more needed.
write_optsReturns the pointer to a newly allocated and filled IsoWriteOpts object. If *write_opts is returned as non-NULL, then it should be freed with iso_write_opts_free() when no more needed.
Returns
1 on success, < 0 on error
Since
1.5.6

◆ iso_conv_name_chars()

int iso_conv_name_chars ( IsoWriteOpts * opts,
char * name,
size_t name_len,
char ** result,
size_t * result_len,
int flag )

Convert the characters in name from local charset to another charset or convert name to the representation of a particular ISO image name space.

In the latter case it is assumed that the conversion result does not collide with any other converted name in the same directory. I.e. this function does not take into respect possible name changes due to collision handling.

Parameters
optsDefines output charset, UCS-2 versus UTF-16 for Joliet, and naming restrictions.
nameThe input text which shall be converted.
name_lenThe number of bytes in input text.
resultWill return the conversion result in case of success. Terminated by a trailing zero byte. Use free() to dispose it when no longer needed.
result_lenWill return the number of bytes in result (excluding trailing zero)
flagBitfield for control purposes. bit0-bit7= Name space 0= generic (output charset is used, no reserved characters, no length limits) 1= Rock Ridge (output charset is used) 2= Joliet (output charset gets overridden by UCS-2 or UTF-16) 3= ECMA-119 (output charset gets overridden by the dull ISO 9660 subset of ASCII) 4= HFS+ (output charset gets overridden by UTF-16BE) bit8= Treat input text as directory name (matters for Joliet and ECMA-119) bit9= Do not issue error messages bit15= Reverse operation (best to be done only with results of previous conversions)
Returns
1 means success, <0 means error
Since
1.3.6

◆ iso_crc32_gpt()

uint32_t iso_crc32_gpt ( unsigned char * data,
int count,
int flag )

Compute a CRC number as expected in the GPT main and backup header blocks.

The CRC at byte offset 88 is supposed to cover the array of partition entries. The CRC at byte offset 16 is supposed to cover the readily produced first 92 bytes of the header block while its bytes 16 to 19 are still set to 0. Block size is 512 bytes. Numbers are stored little-endian. See doc/boot_sectors.txt for the byte layout of GPT.

This might be helpful for applications which want to manipulate GPT directly. The function is in libisofs/system_area.c and self-contained. So if you want to copy+paste it under the license of that file: Be invited. Be warned that this implementation works bit-wise and thus is much slower than table-driven ones. For less than 32 KiB, it fully suffices, though.

Parameters
dataThe memory buffer with the data to sum up.
countNumber of bytes in data.
flagBitfield for control purposes. Submit 0.
Returns
The CRC of data.
Since
1.3.8

◆ iso_data_source_new_from_file()

int iso_data_source_new_from_file ( const char * path,
IsoDataSource ** src )

Create a new IsoDataSource from a local file.

This is suitable for accessing regular files or block devices with ISO images.

Parameters
pathThe absolute path of the file
srcWill be filled with the pointer to the newly created data source.
Returns
1 on success, < 0 on error.
Since
0.6.2

◆ iso_data_source_ref()

void iso_data_source_ref ( IsoDataSource * src)

Increments the reference counting of the given IsoDataSource.

Since
0.6.2

◆ iso_data_source_unref()

void iso_data_source_unref ( IsoDataSource * src)

Decrements the reference counting of the given IsoDataSource, freeing it if refcount reach 0.

Since
0.6.2

◆ iso_dir_add_node()

int iso_dir_add_node ( IsoDir * dir,
IsoNode * child,
enum iso_replace_mode replace )

Add a new node to a dir.

Note that this function don't add a new ref to the node, so you don't need to free it, it will be automatically freed when the dir is deleted. Of course, if you want to keep using the node after the dir life, you need to iso_node_ref() it.

Parameters
dirthe dir where to add the node
childthe node to add. You must ensure that the node hasn't previously added to other dir, and that the node name is unique inside the child. Otherwise this function will return a failure, and the child won't be inserted.
replaceif the dir already contains a node with the same name, whether to replace or not the old node with this.
Returns
number of nodes in dir if success, < 0 otherwise Possible errors: ISO_NULL_POINTER, if dir or child are NULL ISO_NODE_ALREADY_ADDED, if child is already added to other dir ISO_NODE_NAME_NOT_UNIQUE, a node with same name already exists ISO_WRONG_ARG_VALUE, if child == dir, or replace != (0,1)
Since
0.6.2

◆ iso_dir_find_children()

int iso_dir_find_children ( IsoDir * dir,
IsoFindCondition * cond,
IsoDirIter ** iter )

Find all directory children that match the given condition.

Parameters
dirDirectory where we will search children.
condCondition that the children must match in order to be returned. It will be free together with the iterator. Remember to delete it if this function return error.
iterIterator that returns only the children that match condition.
Returns
1 on success, < 0 on error
Since
0.6.4

◆ iso_dir_get_children()

int iso_dir_get_children ( const IsoDir * dir,
IsoDirIter ** iter )

Get an iterator for the children of the given dir.

You can iterate over the children with iso_dir_iter_next. When finished, you should free the iterator with iso_dir_iter_free. You must not delete a child of the same dir, using iso_node_take() or iso_node_remove(), while you're using the iterator. You can use iso_dir_iter_take() or iso_dir_iter_remove() instead.

You can use the iterator in the way like this

IsoDirIter *iter; IsoNode *node; if ( iso_dir_get_children(dir, &iter) != 1 ) { // handle error } while ( iso_dir_iter_next(iter, &node) == 1 ) { // do something with the child } iso_dir_iter_free(iter);

An iterator is intended to be used in a single iteration over the children of a dir. Thus, it should be treated as a temporary object, and free as soon as possible.

Returns
1 success, < 0 error Possible errors: ISO_NULL_POINTER, if dir or iter are NULL ISO_OUT_OF_MEM
Since
0.6.2

◆ iso_dir_get_children_count()

int iso_dir_get_children_count ( IsoDir * dir)

Get the number of children of a directory.

Returns
>= 0 number of items, < 0 error Possible errors: ISO_NULL_POINTER, if dir is NULL
Since
0.6.2

◆ iso_dir_get_node()

int iso_dir_get_node ( IsoDir * dir,
const char * name,
IsoNode ** node )
                       *** Deprecated ***
        In most cases use iso_image_dir_get_node() instead.

Locate a node inside a given dir without taking into respect name truncation mode of an IsoImage.

Parameters
dirThe dir where to look for the node.
nameThe name of the node
nodeLocation for a pointer to the node. See iso_image_get_node().
Returns
1 node found, 0 child has no such node, < 0 error Possible errors: ISO_NULL_POINTER, if dir or name are NULL
Since
0.6.2

◆ iso_dir_iter_free()

void iso_dir_iter_free ( IsoDirIter * iter)

Free a dir iterator.

Since
0.6.2

◆ iso_dir_iter_has_next()

int iso_dir_iter_has_next ( IsoDirIter * iter)

Check if there're more children.

Returns
1 dir has more elements, 0 no, < 0 error Possible errors: ISO_NULL_POINTER, if iter is NULL
Since
0.6.2

◆ iso_dir_iter_next()

int iso_dir_iter_next ( IsoDirIter * iter,
IsoNode ** node )

Get the next child.

Take care that the node is owned by its parent, and will be unref() when the parent is freed. If you want your own ref to it, call iso_node_ref() on it.

Returns
1 success, 0 if dir has no more elements, < 0 error Possible errors: ISO_NULL_POINTER, if node or iter are NULL ISO_ERROR, on wrong iter usage, usual caused by modiying the dir during iteration
Since
0.6.2

◆ iso_dir_iter_remove()

int iso_dir_iter_remove ( IsoDirIter * iter)

Removes a child from a directory during an iteration and unref() it.

Like iso_node_remove(), but to be used during a directory iteration. The node removed will be the one returned by the previous iteration.

It is not allowed to call this function twice without calling iso_dir_iter_next between the calls.

Returns
1 on success, < 0 error Possible errors: ISO_NULL_POINTER, if iter is NULL ISO_ERROR, on wrong iter usage, for example by calling this before iso_dir_iter_next.
Since
0.6.2

◆ iso_dir_iter_take()

int iso_dir_iter_take ( IsoDirIter * iter)

Removes a child from a directory during an iteration, without freeing it.

It's like iso_node_take(), but to be used during a directory iteration. The node removed will be the last returned by the iteration.

If you call this function twice without calling iso_dir_iter_next between them is not allowed and you will get an ISO_ERROR in second call.

Returns
1 on success, < 0 error Possible errors: ISO_NULL_POINTER, if iter is NULL ISO_ERROR, on wrong iter usage, for example by call this before iso_dir_iter_next.
Since
0.6.2

◆ iso_error_get_code()

int iso_error_get_code ( int e)

Get the message queue code of a libisofs error.

◆ iso_error_get_priority()

int iso_error_get_priority ( int e)

Get the priority of a given error.

Returns
0x00000000 -> ZERO 0x10000000 -> LOW 0x20000000 -> MEDIUM 0x30000000 -> HIGH
Since
0.6.2

◆ iso_error_get_severity()

int iso_error_get_severity ( int e)

Get the severity of a given error code.

Returns
0x10000000 -> DEBUG 0x20000000 -> UPDATE 0x30000000 -> NOTE 0x40000000 -> HINT 0x50000000 -> WARNING 0x60000000 -> SORRY 0x64000000 -> MISHAP 0x68000000 -> FAILURE 0x70000000 -> FATAL 0x71000000 -> ABORT
Since
0.6.2

◆ iso_error_to_msg()

const char * iso_error_to_msg ( int errcode)

Get a textual description of a libisofs error.

Since
0.6.2

◆ iso_file_add_external_filter()

int iso_file_add_external_filter ( IsoFile * file,
IsoExternalFilterCommand * cmd,
int flag )

Install an external filter command on top of the content stream of a data file.

The filter process must be repeatable. It will be run once by this call in order to cache the output size.

Parameters
fileThe data file node which shall show filtered content.
cmdThe external program and its arguments which shall do the filtering.
flagBitfield for control purposes, unused yet, submit 0.
Returns
1 on success, 2 if filter installation revoked (e.g. cmd.behavior bit1) <0 on error
Since
0.6.18

◆ iso_file_add_gzip_filter()

int iso_file_add_gzip_filter ( IsoFile * file,
int flag )

Install a gzip or gunzip filter on top of the content stream of a data file.

gzip is a compression format which is used by programs gzip and gunzip. The filter will not be installed if its output size is not smaller than the size of the input stream. This is only enabled if the use of libz was enabled at compile time.

Parameters
fileThe data file node which shall show filtered content.
flagBitfield for control purposes bit0= Do not install filter if the number of output blocks is not smaller than the number of input blocks. Block size is 2048. bit1= Install a decompression filter rather than one for compression. bit2= Only inquire availability of gzip filtering. file may be NULL. If available return 2, else return error. bit3= is reserved for internal use and will be forced to 0
Returns
1 on success, 2 if filter available but installation revoked <0 on error, e.g. ISO_ZLIB_NOT_ENABLED
Since
0.6.18

◆ iso_file_add_zisofs_filter()

int iso_file_add_zisofs_filter ( IsoFile * file,
int flag )

Install a zisofs filter on top of the content stream of a data file.

zisofs is a compression format which is decompressed by some Linux kernels. See also doc/zisofs_format.txt and doc/zisofs2_format.txt. The filter will not be installed if its output size is not smaller than the size of the input stream. This is only enabled if the use of libz was enabled at compile time.

Parameters
fileThe data file node which shall show filtered content.
flagBitfield for control purposes bit0= Do not install filter if the number of output blocks is not smaller than the number of input blocks. Block size is 2048. bit1= Install a decompression filter rather than one for compression. bit2= Only inquire availability of zisofs filtering. file may be NULL. If available return 2, else return error. bit3= is reserved for internal use and will be forced to 0
Returns
1 on success, 2 if filter available but installation revoked <0 on error, e.g. ISO_ZLIB_NOT_ENABLED
Since
0.6.18

◆ iso_file_get_md5()

int iso_file_get_md5 ( IsoImage * image,
IsoFile * file,
char md5[16],
int flag )

Eventually obtain the recorded MD5 checksum of a data file from the loaded ISO image.

Such a checksum may be stored with others in a contiguous array at the end of the loaded session. The data file eventually has an xattr "isofs.cx" which gives the index in that array.

Parameters
imageThe image from which file stems.
fileThe file object to inquire
md5Eventually returns 16 byte of MD5 checksum
flagBitfield for control purposes bit0= only determine return value, do not touch parameter md5
Returns
1= md5 found , 0= no md5 available , <0 indicates error
Since
0.6.22

◆ iso_file_get_old_image_lba()

int iso_file_get_old_image_lba ( IsoFile * file,
uint32_t * lba,
int flag )

Get the block lba of a file node, if it was imported from an old image.

Parameters
fileThe file
lbaWill be filled with the kba
flagReserved for future usage, submit 0
Returns
1 if lba is valid (file comes from old image and has only one section), 0 if file was newly added, i.e. it does not come from an old image, < 0 error, especially ISO_WRONG_ARG_VALUE if the file has more than one file section.
Since
0.6.4
Deprecated
Use iso_file_get_old_image_sections(), as this function does not work with multi-extend files.

◆ iso_file_get_old_image_sections()

int iso_file_get_old_image_sections ( IsoFile * file,
int * section_count,
struct iso_file_section ** sections,
int flag )

Get the start addresses and the sizes of the data extents of a file node if it was imported from an old image.

Parameters
fileThe file
section_countReturns the number of extent entries in sections array.
sectionsReturns the array of file sections if section_count > 0. In this case, apply free() to dispose it.
flagReserved for future usage, submit 0
Returns
1 if there are valid extents (file comes from old image), 0 if file was newly added, i.e. it does not come from an old image, < 0 error
Since
0.6.8

◆ iso_file_get_size()

off_t iso_file_get_size ( IsoFile * file)

Get the size of the file, in bytes.

Since
0.6.2

◆ iso_file_get_sort_weight()

int iso_file_get_sort_weight ( IsoFile * file)

Get the sort weight of a file.

Since
0.6.2

◆ iso_file_get_stream()

IsoStream * iso_file_get_stream ( IsoFile * file)

Get the IsoStream that represents the contents of the given IsoFile.

The stream may be a filter stream which itself get its input from a further stream. This may be inquired by iso_stream_get_input_stream().

If you iso_stream_open() the stream, iso_stream_close() it before image generation begins.

Returns
The IsoStream. No extra ref is added, so the IsoStream belongs to the IsoFile, and it may be freed together with it. Add your own ref with iso_stream_ref() if you need it.
Since
0.6.4

◆ iso_file_make_md5()

int iso_file_make_md5 ( IsoFile * file,
int flag )

Read the content of an IsoFile object, compute its MD5 and attach it to the IsoFile.

It can then be inquired by iso_file_get_md5() and will get written into the next session if this is enabled at write time and if the image write process does not compute an MD5 from content which it copies. So this call can be used to equip nodes from the old image with checksums or to make available checksums of newly added files before the session gets written.

Parameters
fileThe file object to read data from and to which to attach the checksum. If the file is from the imported image, then its most original stream will be checksummed. Else the eventual filter streams will get into effect.
flagBitfield for control purposes. Unused yet. Submit 0.
Returns
1= ok, MD5 is computed and attached , <0 indicates error
Since
0.6.22

◆ iso_file_remove_filter()

int iso_file_remove_filter ( IsoFile * file,
int flag )

Delete the top filter stream from a data file.

This is the most recent one which was added by iso_file_add_*_filter(). Caution: One should not do this while the IsoStream of the file is opened. For now there is no general way to determine this state. Filter stream implementations are urged to eventually call .close() inside method .free() . This will close the input stream too.

Parameters
fileThe data file node which shall get rid of one layer of content filtering.
flagBitfield for control purposes, unused yet, submit 0.
Returns
1 on success, 0 if no filter was present <0 on error
Since
0.6.18

◆ iso_file_source_access()

int iso_file_source_access ( IsoFileSource * src)

Check if the process has access to read file contents.

Note that this is not necessarily related with (l)stat functions. For example, in a filesystem implementation to deal with an ISO image, if the user has read access to the image it will be able to read all files inside it, despite of the particular permission of each file in the RR tree, that are what the above functions return.

Returns
1 if process has read access, < 0 on error Error codes: ISO_FILE_ACCESS_DENIED ISO_FILE_BAD_PATH ISO_FILE_DOESNT_EXIST ISO_OUT_OF_MEM ISO_FILE_ERROR ISO_NULL_POINTER
Since
0.6.2

◆ iso_file_source_close()

int iso_file_source_close ( IsoFileSource * src)

Close a previously opened file.

Returns
1 on success, < 0 on error Error codes: ISO_FILE_ERROR ISO_NULL_POINTER ISO_FILE_NOT_OPENED
Since
0.6.2

◆ iso_file_source_get_aa_string()

int iso_file_source_get_aa_string ( IsoFileSource * src,
unsigned char ** aa_string,
int flag )

Get the AAIP string with encoded ACL and xattr.

(Not to be confused with ECMA-119 Extended Attributes).

Parameters
srcThe file source object to be inquired.
aa_stringReturns a pointer to the AAIP string data. If no AAIP string is available, *aa_string becomes NULL. (See doc/susp_aaip_2_0.txt for the meaning of AAIP.) The caller is responsible for finally calling free() on non-NULL results.
flagBitfield for control purposes bit0= Transfer ownership of AAIP string data. src will free the eventual cached data and might not be able to produce it again. bit1= No need to get ACL (but no guarantee of exclusion) bit2= No need to get xattr (but no guarantee of exclusion) bit3= if not bit2: import all xattr namespaces from local filesystem, not only "user."
Since
1.5.0
Returns
1 means success (*aa_string == NULL is possible) <0 means failure and must b a valid libisofs error code (e.g. ISO_FILE_ERROR if no better one can be found).
Since
0.6.14

◆ iso_file_source_get_filesystem()

IsoFilesystem * iso_file_source_get_filesystem ( IsoFileSource * src)

Get the filesystem for this source.

No extra ref is added, so you must not unref the IsoFilesystem.

Returns
The filesystem, NULL on error
Since
0.6.2

◆ iso_file_source_get_name()

char * iso_file_source_get_name ( IsoFileSource * src)

Get the name of the file, with the dir component of the path.

Returns
the name of the file, it should be freed when no more needed.
Since
0.6.2

◆ iso_file_source_get_path()

char * iso_file_source_get_path ( IsoFileSource * src)

Get the absolute path in the filesystem this file source belongs to.

Returns
the path of the FileSource inside the filesystem, it should be freed when no more needed.
Since
0.6.2

◆ iso_file_source_lseek()

off_t iso_file_source_lseek ( IsoFileSource * src,
off_t offset,
int flag )

Repositions the offset of the given IsoFileSource (must be opened) to the given offset according to the value of flag.

Parameters
srcThe given source
offsetin bytes
flag0 The offset is set to offset bytes (SEEK_SET) 1 The offset is set to its current location plus offset bytes (SEEK_CUR) 2 The offset is set to the size of the file plus offset bytes (SEEK_END).
Returns
Absolute offset position on the file, or < 0 on error. Cast the returning value to int to get a valid libisofs error.
Since
0.6.4

◆ iso_file_source_lstat()

int iso_file_source_lstat ( IsoFileSource * src,
struct stat * info )

Get information about the file.

Returns
1 success, < 0 error Error codes: ISO_FILE_ACCESS_DENIED ISO_FILE_BAD_PATH ISO_FILE_DOESNT_EXIST ISO_OUT_OF_MEM ISO_FILE_ERROR ISO_NULL_POINTER
Since
0.6.2

◆ iso_file_source_open()

int iso_file_source_open ( IsoFileSource * src)

Opens the source.

Returns
1 on success, < 0 on error Error codes: ISO_FILE_ALREADY_OPENED ISO_FILE_ACCESS_DENIED ISO_FILE_BAD_PATH ISO_FILE_DOESNT_EXIST ISO_OUT_OF_MEM ISO_FILE_ERROR ISO_NULL_POINTER
Since
0.6.2

◆ iso_file_source_read()

int iso_file_source_read ( IsoFileSource * src,
void * buf,
size_t count )

Attempts to read up to count bytes from the given source into the buffer starting at buf.

The file src must be open() before calling this, and close() when no more needed. Not valid for dirs. On symlinks it reads the destination file.

Parameters
srcThe given source
bufPointer to a buffer of at least count bytes where the read data will be stored
countBytes to read
Returns
number of bytes read, 0 if EOF, < 0 on error Error codes: ISO_FILE_ERROR ISO_NULL_POINTER ISO_FILE_NOT_OPENED ISO_WRONG_ARG_VALUE -> if count == 0 ISO_FILE_IS_DIR ISO_OUT_OF_MEM ISO_INTERRUPTED
Since
0.6.2

◆ iso_file_source_readdir()

int iso_file_source_readdir ( IsoFileSource * src,
IsoFileSource ** child )

Read a directory.

Each call to this function will return a new child, until we reach the end of file (i.e, no more children), in that case it returns 0.

The dir must be open() before calling this, and close() when no more needed. Only valid for dirs.

Note that "." and ".." children MUST NOT BE returned.

Parameters
srcThe given source
childpointer to be filled with the given child. Undefined on error or OEF
Returns
1 on success, 0 if EOF (no more children), < 0 on error Error codes: ISO_FILE_ERROR ISO_NULL_POINTER ISO_FILE_NOT_OPENED ISO_FILE_IS_NOT_DIR ISO_OUT_OF_MEM
Since
0.6.2

◆ iso_file_source_readlink()

int iso_file_source_readlink ( IsoFileSource * src,
char * buf,
size_t bufsiz )

Read the destination of a symlink.

You don't need to open the file to call this.

Parameters
srcAn IsoFileSource corresponding to a symbolic link.
bufAllocated buffer of at least bufsiz bytes. The destination string will be copied there, and it will be 0-terminated if the return value indicates success or ISO_RR_PATH_TOO_LONG.
bufsizMaximum number of buf characters + 1. The string will be truncated if it is larger than bufsiz - 1 and ISO_RR_PATH_TOO_LONG. will be returned.
Returns
1 on success, < 0 on error Error codes: ISO_FILE_ERROR ISO_NULL_POINTER ISO_WRONG_ARG_VALUE -> if bufsiz <= 0 ISO_FILE_IS_NOT_SYMLINK ISO_OUT_OF_MEM ISO_FILE_BAD_PATH ISO_FILE_DOESNT_EXIST ISO_RR_PATH_TOO_LONG (
Since
1.0.6)
0.6.2

◆ iso_file_source_ref()

void iso_file_source_ref ( IsoFileSource * src)

Take a ref to the given IsoFileSource.

Since
0.6.2

◆ iso_file_source_stat()

int iso_file_source_stat ( IsoFileSource * src,
struct stat * info )

Get information about the file.

If the file is a symlink, the info returned refers to the destination.

Returns
1 success, < 0 error Error codes: ISO_FILE_ACCESS_DENIED ISO_FILE_BAD_PATH ISO_FILE_DOESNT_EXIST ISO_OUT_OF_MEM ISO_FILE_ERROR ISO_NULL_POINTER
Since
0.6.2

◆ iso_file_source_unref()

void iso_file_source_unref ( IsoFileSource * src)

Drop your ref to the given IsoFileSource, eventually freeing the associated system resources.

Since
0.6.2

◆ iso_filesystem_ref()

void iso_filesystem_ref ( IsoFilesystem * fs)

Take a ref to the given IsoFilesystem.

Since
0.6.2

◆ iso_filesystem_unref()

void iso_filesystem_unref ( IsoFilesystem * fs)

Drop your ref to the given IsoFilesystem, evetually freeing associated resources.

Since
0.6.2

◆ iso_finish()

void iso_finish ( )

Finalize libisofs.

Since
0.6.2

◆ iso_generate_gpt_guid()

void iso_generate_gpt_guid ( uint8_t guid[16])

Generate a pseudo-random GUID suitable for iso_write_opts_set_gpt_guid().

Parameters
guidWill be filled by 16 bytes of generated GUID.
Since
1.4.6

◆ iso_get_local_charset()

char * iso_get_local_charset ( int flag)

Obtain the local charset as currently assumed by libisofs.

The result points to internal memory. It is volatile and must not be altered.

Parameters
flagUnused yet. Submit 0.
Since
0.6.12

◆ iso_get_messenger()

void * iso_get_messenger ( )

Return the messenger object handle used by libisofs.

This handle may be used by related libraries to their own compatible messenger objects and thus to direct their messages to the libisofs message queue. See also: libburn, API function burn_set_messenger().

Returns
the handle. Do only use with compatible
Since
0.6.2

◆ iso_gzip_get_refcounts()

int iso_gzip_get_refcounts ( off_t * gzip_count,
off_t * gunzip_count,
int flag )

Inquire the number of gzip compression and uncompression filters which are in use.

Parameters
gzip_countWill return the number of currently installed compression filters.
gunzip_countWill return the number of currently installed uncompression filters.
flagBitfield for control purposes, unused yet, submit 0
Returns
1 on success, <0 on error
Since
0.6.18

◆ iso_hfsplus_xinfo_func()

int iso_hfsplus_xinfo_func ( void * data,
int flag )

The function that is used to mark struct iso_hfsplus_xinfo_data at IsoNodes and finally disposes such structs when their IsoNodes get disposed.

Usually an application does not call this function, but only uses it as parameter of xinfo calls like iso_node_add_xinfo() or iso_node_get_xinfo().

Since
1.2.4

◆ iso_hfsplus_xinfo_new()

struct iso_hfsplus_xinfo_data * iso_hfsplus_xinfo_new ( int flag)

Create an instance of struct iso_hfsplus_xinfo_new().

Parameters
flagBitfield for control purposes. Unused yet. Submit 0.
Returns
A pointer to the new object NULL indicates failure to allocate memory
Since
1.2.4

◆ iso_image_add_boot_image()

int iso_image_add_boot_image ( IsoImage * image,
const char * image_path,
enum eltorito_boot_media_type type,
int flag,
ElToritoBootImage ** boot )

Add a further boot image to the set of El-Torito bootable images.

This set has already to be created by iso_image_set_boot_image(). Up to 31 further boot images may be added.

Parameters
imageThe image to which the boot image shall be added. returns an error and the image remains unmodified.
image_pathThe absolute path of a IsoFile to be used as boot image or –interval:appended_partition_$number[start$start_size_$size]:... if type is ELTORITO_NO_EMUL. See iso_image_set_boot_image.
typeThe boot media type. See iso_image_set_boot_image.
flagBitfield for control purposes. Unused yet. Submit 0.
bootLocation where a pointer to the added boot image will be stored. See iso_image_set_boot_image
Returns
1 on success, < 0 on error ISO_BOOT_NO_CATALOG means iso_image_set_boot_image() was not called first.
Since
0.6.32

◆ iso_image_add_mips_boot_file()

int iso_image_add_mips_boot_file ( IsoImage * image,
char * path,
int flag )

Add a MIPS boot file path to the image.

Up to 15 such files can be written into a MIPS Big Endian Volume Header if this is enabled by value 1 in iso_write_opts_set_system_area() option bits 2 to 7. A single file can be written into a DEC Boot Block if this is enabled by value 2 in iso_write_opts_set_system_area() option bits 2 to 7. So only the first added file gets into effect with this system area type. The data files which shall serve as MIPS boot files have to be brought into the image by the normal means.

Parameters
imageThe image to be manipulated.
pathAbsolute path of the boot file in the ISO 9660 Rock Ridge tree.
flagBitfield for control purposes, unused yet, submit 0
Returns
1 on success, < 0 error
Since
0.6.38

◆ iso_image_add_new_dir()

int iso_image_add_new_dir ( IsoImage * image,
IsoDir * parent,
const char * name,
IsoDir ** dir )

Add a new directory to the iso tree.

Permissions, owner and hidden atts are taken from parent, you can modify them later.

Parameters
imageThe image object to which the new directory shall belong.
parentThe directory node where the new directory will be grafted in.
nameName for the new directory. If truncation mode is set to 1, an oversized name gets truncated before further processing. If a node with same name already exists on parent, this function fails with ISO_NODE_NAME_NOT_UNIQUE.
dirplace where to store a pointer to the newly created dir. No extra ref is added, so you will need to call iso_node_ref() if you really need it. You can pass NULL in this parameter if you don't need the pointer.
Returns
number of nodes in parent if success, < 0 otherwise Possible errors: ISO_NULL_POINTER, if parent or name are NULL ISO_NODE_NAME_NOT_UNIQUE, a node with same name already exists ISO_OUT_OF_MEM ISO_RR_NAME_TOO_LONG
Since
1.4.2

◆ iso_image_add_new_file()

int iso_image_add_new_file ( IsoImage * image,
IsoDir * parent,
const char * name,
IsoStream * stream,
IsoFile ** file )

Add a new regular file to the iso tree.

Permissions are set to 0444, owner and hidden atts are taken from parent. You can modify any of them later.

Parameters
imageThe image object to which the new file shall belong.
parentThe directory node where the new directory will be grafted in.
nameName for the new file. If truncation mode is set to 1, an oversized name gets truncated before further processing. If a node with same name already exists on parent, this function fails with ISO_NODE_NAME_NOT_UNIQUE.
streamIsoStream for the contents of the file. The reference will be taken by the newly created file, you will need to take an extra ref to it if you need it.
fileplace where to store a pointer to the newly created file. No extra ref is added, so you will need to call iso_node_ref() if you really need it. You can pass NULL in this parameter if you don't need the pointer
Returns
number of nodes in parent if success, < 0 otherwise Possible errors: ISO_NULL_POINTER, if parent, name or dest are NULL ISO_NODE_NAME_NOT_UNIQUE, a node with same name already exists ISO_OUT_OF_MEM ISO_RR_NAME_TOO_LONG
Since
1.4.2

◆ iso_image_add_new_special()

int iso_image_add_new_special ( IsoImage * image,
IsoDir * parent,
const char * name,
mode_t mode,
dev_t dev,
IsoSpecial ** special )

Add a new special file to the directory tree.

As far as libisofs concerns, a special file is a block device, a character device, a FIFO (named pipe) or a socket. You can choose the specific kind of file you want to add by setting mode properly (see man 2 stat).

Note that special files are only written to image when Rock Ridge extensions are enabled. Moreover, a special file is just a directory entry in the image tree, no data is written beyond that.

Owner and hidden atts are taken from parent. You can modify any of them later.

Parameters
imageThe image object to which the new special file shall belong.
parentThe directory node where the new special file will be grafted in.
nameName for the new special file. If truncation mode is set to 1, an oversized name gets truncated before further processing. If a node with same name already exists on parent, this function fails with ISO_NODE_NAME_NOT_UNIQUE.
modeFile type and permissions for the new node. Note that only the file types S_IFSOCK, S_IFBLK, S_IFCHR, and S_IFIFO are allowed. S_IFLNK, S_IFREG, or S_IFDIR are not.
devDevice ID, equivalent to the st_rdev field in man 2 stat.
specialPlace where to store a pointer to the newly created special file. No extra ref is added, so you will need to call iso_node_ref() if you really need it. You can pass NULL in this parameter if you don't need the pointer.
Returns
Number of nodes in parent if success, < 0 otherwise Possible errors: ISO_NULL_POINTER, if parent, name or dest are NULL ISO_NODE_NAME_NOT_UNIQUE, a node with same name already exists ISO_WRONG_ARG_VALUE if you select a incorrect mode ISO_OUT_OF_MEM ISO_RR_NAME_TOO_LONG
Since
1.4.2

◆ iso_image_add_new_symlink()

int iso_image_add_new_symlink ( IsoImage * image,
IsoDir * parent,
const char * name,
const char * dest,
IsoSymlink ** link )

Add a new symbolic link to the directory tree.

Permissions are set to 0777, owner and hidden atts are taken from parent. You can modify any of them later.

Parameters
imageThe image object to which the new directory shall belong.
parentThe directory node where the new symlink will be grafted in.
nameName for the new symlink. If truncation mode is set to 1, an oversized name gets truncated before further processing. If a node with same name already exists on parent, this function fails with ISO_NODE_NAME_NOT_UNIQUE.
destThe destination path of the link. The components of this path are not checked for being oversized.
linkPlace where to store a pointer to the newly created link. No extra ref is added, so you will need to call iso_node_ref() if you really need it. You can pass NULL in this parameter if you don't need the pointer
Returns
number of nodes in parent if success, < 0 otherwise Possible errors: ISO_NULL_POINTER, if parent, name or dest are NULL ISO_NODE_NAME_NOT_UNIQUE, a node with same name already exists ISO_OUT_OF_MEM ISO_RR_NAME_TOO_LONG
Since
1.4.2

◆ iso_image_attach_data()

int iso_image_attach_data ( IsoImage * image,
void * data,
void(*)(void *) give_up )

Attach user defined data to the image.

Use this if your application needs to store addition info together with the IsoImage. If the image already has data attached, the old data will be freed.

Parameters
imageThe image to which data shall be attached.
dataPointer to application defined data that will be attached to the image. You can pass NULL to remove any already attached data.
give_upFunction that will be called when the image does not need the data any more. It receives the data pointer as an argumente, and eventually causes data to be freed. It can be NULL if you don't need it.
Returns
1 on success, < 0 on error
Since
0.6.2

◆ iso_image_create_burn_source()

int iso_image_create_burn_source ( IsoImage * image,
IsoWriteOpts * opts,
struct burn_source ** burn_src )

Create a burn_source and a thread which immediately begins to generate the image.

That burn_source can be used with libburn as a data source for a track. A copy of its public declaration in libburn.h can be found further below in this text.

If image generation shall be aborted by the application program, then the .cancel() method of the burn_source must be called to end the generation thread: burn_src->cancel(burn_src);

Parameters
imageThe image to write.
optsThe options for image generation. All needed data will be copied, so you can free the given struct once this function returns.
burn_srcLocation where the pointer to the burn_source will be stored
Returns
1 on success, < 0 on error
Since
0.6.2

◆ iso_image_dir_get_node()

int iso_image_dir_get_node ( IsoImage * image,
IsoDir * dir,
const char * name,
IsoNode ** node,
int flag )

Locate a node inside a given dir.

The IsoImage context defines a maximum permissible name length and a mode how to react on oversized names. See iso_image_set_truncate_mode(). If the caller looks for an oversized name and image truncate mode is 1, then this call looks for the truncated name among the nodes of dir.

Parameters
imageThe image object to which dir belongs.
dirThe dir where to look for the node.
nameThe name of the node. (Will not be changed if truncation happens.)
nodeLocation for a pointer to the node, it will filled with NULL if the dir doesn't have a child with the given name. The node will be owned by the dir and shouldn't be unref(). Just call iso_node_ref() to get your own reference to the node. Note that you can pass NULL is the only thing you want to do is check if a node with such name already exists on dir.
flagBitfield for control purposes. bit0= do not truncate name but lookup exactly as given.
Returns
1 node found 0 no name truncation was needed, name not found in dir 2 name truncation happened, truncated name not found in dir < 0 error, see iso_dir_get_node().
Since
1.4.2

◆ iso_image_filesystem_new()

int iso_image_filesystem_new ( IsoDataSource * src,
IsoReadOpts * opts,
int msgid,
IsoImageFilesystem ** fs )

Create a new IsoFilesystem to access a existent ISO image.

Parameters
srcData source to access data.
optsImage read options
msgidAn image identifier, obtained with iso_image_get_msg_id(), used to associated messages issued by the filesystem implementation with an existent image. If you are not using this filesystem in relation with any image context, just use 0x1fffff as the value for this parameter.
fsWill be filled with a pointer to the filesystem that can be used to access image contents.
Returns
1 on success, < 0 on error
Since
0.6.2

◆ iso_image_fs_get_abstract_file_id()

const char * iso_image_fs_get_abstract_file_id ( IsoImageFilesystem * fs)

Get the abstract file identifier for an existent image.

The returned string belong to the IsoImageFilesystem and shouldn't be free() nor modified.

Since
0.6.2

◆ iso_image_fs_get_application_id()

const char * iso_image_fs_get_application_id ( IsoImageFilesystem * fs)

Get the application identifier for an existent image.

The returned string belong to the IsoImageFilesystem and shouldn't be free() nor modified.

Since
0.6.2

◆ iso_image_fs_get_biblio_file_id()

const char * iso_image_fs_get_biblio_file_id ( IsoImageFilesystem * fs)

Get the biblio file identifier for an existent image.

The returned string belong to the IsoImageFilesystem and shouldn't be free() nor modified.

Since
0.6.2

◆ iso_image_fs_get_copyright_file_id()

const char * iso_image_fs_get_copyright_file_id ( IsoImageFilesystem * fs)

Get the copyright file identifier for an existent image.

The returned string belong to the IsoImageFilesystem and shouldn't be free() nor modified.

Since
0.6.2

◆ iso_image_fs_get_data_preparer_id()

const char * iso_image_fs_get_data_preparer_id ( IsoImageFilesystem * fs)

Get the data preparer identifier for an existent image.

The returned string belong to the IsoImageFilesystem and shouldn't be free() nor modified.

Since
0.6.2

◆ iso_image_fs_get_publisher_id()

const char * iso_image_fs_get_publisher_id ( IsoImageFilesystem * fs)

Get the publisher identifier for an existent image.

The returned string belong to the IsoImageFilesystem and shouldn't be free() nor modified.

Since
0.6.2

◆ iso_image_fs_get_system_id()

const char * iso_image_fs_get_system_id ( IsoImageFilesystem * fs)

Get the system identifier for an existent image.

The returned string belong to the IsoImageFilesystem and shouldn't be free() nor modified.

Since
0.6.2

◆ iso_image_fs_get_volset_id()

const char * iso_image_fs_get_volset_id ( IsoImageFilesystem * fs)

Get the volset identifier for an existent image.

The returned string belong to the IsoImageFilesystem and shouldn't be free() nor modified.

Since
0.6.2

◆ iso_image_fs_get_volume_id()

const char * iso_image_fs_get_volume_id ( IsoImageFilesystem * fs)

Get the volume identifier for an existent image.

The returned string belong to the IsoImageFilesystem and shouldn't be free() nor modified.

Since
0.6.2

◆ iso_image_generator_is_running()

int iso_image_generator_is_running ( IsoImage * image)

Inquire whether the image generator thread is still at work.

As soon as the reply is 0, the caller of iso_image_create_burn_source() may assume that the image generation has ended. Nevertheless there may still be readily formatted output data pending in the burn_source or its consumers. So the final delivery of the image has also to be checked at the data consumer side,e.g. by burn_drive_get_status() in case of libburn as consumer.

Parameters
imageThe image to inquire.
Returns
1 generating of image stream is still in progress 0 generating of image stream has ended meanwhile
Since
0.6.38

◆ iso_image_get_abstract_file_id()

const char * iso_image_get_abstract_file_id ( const IsoImage * image)

Get the abstract information of a image.

The returned string is owned by the image and must not be freed nor changed.

Since
0.6.2

◆ iso_image_get_all_boot_imgs()

int iso_image_get_all_boot_imgs ( IsoImage * image,
int * num_boots,
ElToritoBootImage *** boots,
IsoFile *** bootnodes,
int flag )

Get all El-Torito boot images of an ISO image.

The first of these boot images is the same as returned by iso_image_get_boot_image(). The others are alternative boot images.

Parameters
imageThe image from which to get the boot images.
num_bootsThe number of available array elements in boots and bootnodes.
bootsReturns NULL or an allocated array of pointers to boot images. Apply system call free(boots) to dispose it.
bootnodesReturns NULL or an allocated array of pointers to the IsoFile nodes which bear the content of the boot images in boots. An array entry is NULL if the boot image source is no IsoFile.

‍Need getter for partition index

Parameters
flagBitfield for control purposes. Unused yet. Submit 0.
Returns
1 on success, 0 no El-Torito catalog and boot image attached, < 0 error.
Since
0.6.32

◆ iso_image_get_alpha_boot()

int iso_image_get_alpha_boot ( IsoImage * img,
char ** boot_loader_path )

Inquire the path submitted by iso_image_set_alpha_boot() Do not free() the returned pointer.

Parameters
imgThe image to be inquired.
boot_loader_pathWill return the path. NULL if none is currently submitted.
Returns
1 is success , <0 means error
Since
1.4.0

◆ iso_image_get_app_use()

const char * iso_image_get_app_use ( IsoImage * image)

Get the current setting for the Application Use field of the Primary Volume Descriptor.

The returned char array of 512 bytes is owned by the image and must not be freed or changed.

Parameters
imageThe image to inquire
Since
1.3.2

◆ iso_image_get_application_id()

const char * iso_image_get_application_id ( const IsoImage * image)

Get the application id of a image.

The returned string is owned by the image and must not be freed nor changed.

Since
0.6.2

◆ iso_image_get_attached_data()

void * iso_image_get_attached_data ( IsoImage * image)

The the data previously attached with iso_image_attach_data()

Since
0.6.2

◆ iso_image_get_biblio_file_id()

const char * iso_image_get_biblio_file_id ( const IsoImage * image)

Get the biblio information of a image.

The returned string is owned by the image and must not be freed or changed.

Since
0.6.2

◆ iso_image_get_boot_image()

int iso_image_get_boot_image ( IsoImage * image,
ElToritoBootImage ** boot,
IsoFile ** imgnode,
IsoBoot ** catnode )

Get the El-Torito boot catalog and the default boot image of an ISO image.

This can be useful, for example, to check if a volume read from a previous session or an existing image is bootable. It can also be useful to get the image and catalog tree nodes. An application would want those, for example, to prevent the user removing it.

Both nodes are owned by libisofs and must not be freed. You can get your own ref with iso_node_ref(). You can also check if the node is already on the tree by getting its parent (note that when reading El-Torito info from a previous image, the nodes might not be on the tree even if you haven't removed them). Remember that you'll need to get a new ref (with iso_node_ref()) before inserting them again to the tree, and probably you will also need to set the name or permissions.

Parameters
imageThe image from which to get the boot image.
bootIf not NULL, it will be filled with a pointer to the boot image, if any. That object is owned by the IsoImage and must not be freed by the user, nor dereferenced once the last reference to the IsoImage was disposed via iso_image_unref().
imgnodeWhen not NULL, it will be filled with the image tree node. No extra ref is added, you can use iso_node_ref() to get one if you need it. The returned value is NULL if the boot image source is no IsoFile.
catnodeWhen not NULL, it will be filled with the catnode tree node. No extra ref is added, you can use iso_node_ref() to get one if you need it.
Returns
1 on success, 0 is the image is not bootable (i.e., it has no El-Torito image), < 0 error.
Since
0.6.2

◆ iso_image_get_bootcat()

int iso_image_get_bootcat ( IsoImage * image,
IsoBoot ** catnode,
uint32_t * lba,
char ** content,
off_t * size )

Get detailed information about the boot catalog that was loaded from an ISO image.

The boot catalog links the El Torito boot record at LBA 17 with the boot images which are IsoFile objects in the image. The boot catalog itself is not a regular file and thus will not deliver an IsoStream. Its content is usually quite short and can be obtained by this call.

Parameters
imageThe image to inquire.
catnodeWill return the boot catalog tree node. No extra ref is taken.
lbaWill return the block address of the boot catalog in the image.
contentWill return either NULL or an allocated memory buffer with the content bytes of the boot catalog. Dispose it by free() when no longer needed.
sizeWill return the number of bytes in content.
Returns
1 if reply is valid, 0 if not boot catalog was loaded, < 0 on error.
Since
1.1.2

◆ iso_image_get_copyright_file_id()

const char * iso_image_get_copyright_file_id ( const IsoImage * image)

Get the copyright information of a image.

The returned string is owned by the image and must not be freed nor changed.

Since
0.6.2

◆ iso_image_get_data_preparer_id()

const char * iso_image_get_data_preparer_id ( const IsoImage * image)

Get the data preparer of a image.

The returned string is owned by the image and must not be freed nor changed.

Since
0.6.2

◆ iso_image_get_hppa_palo()

int iso_image_get_hppa_palo ( IsoImage * img,
char ** cmdline,
char ** bootloader,
char ** kernel_32,
char ** kernel_64,
char ** ramdisk )

Inquire the current settings of iso_image_set_hppa_palo().

Do not free() the returned pointers.

Parameters
imgThe image to be inquired.
cmdlineWill return the command line.
bootloaderWill return the absolute path of the bootloader file.
kernel_32Will return the absolute path of the 32 bit kernel file.
kernel_64Will return the absolute path of the 64 bit kernel file.
ramdiskWill return the absolute path of the RAM disk file.
Returns
1 is success , <0 means error
Since
1.3.8

◆ iso_image_get_ignore_aclea()

int iso_image_get_ignore_aclea ( IsoImage * image)

Obtain the current setting of iso_image_set_ignore_aclea().

Parameters
imageThe image to be inquired
Returns
The currently set value.
Since
1.5.0

◆ iso_image_get_mips_boot_files()

int iso_image_get_mips_boot_files ( IsoImage * image,
char * paths[15],
int flag )

Obtain the number of added MIPS Big Endian boot files and pointers to their paths in the ISO 9660 Rock Ridge tree.

Parameters
imageThe image to be inquired.
pathsAn array of pointers to be set to the registered boot file paths. This are just pointers to data inside IsoImage. Do not free() them. Eventually make own copies of the data before manipulating the image.
flagBitfield for control purposes, unused yet, submit 0
Returns
>= 0 is the number of valid path pointers , <0 means error
Since
0.6.38

◆ iso_image_get_msg_id()

int iso_image_get_msg_id ( IsoImage * image)

Get the id of an IsoImage, used for message reporting.

This message id, retrieved with iso_obtain_msgs(), can be used to distinguish what IsoImage has issued a given message.

Since
0.6.2

◆ iso_image_get_publisher_id()

const char * iso_image_get_publisher_id ( const IsoImage * image)

Get the publisher of a image.

The returned string is owned by the image and must not be freed nor changed.

Since
0.6.2

◆ iso_image_get_pvd_times()

int iso_image_get_pvd_times ( IsoImage * image,
char ** creation_time,
char ** modification_time,
char ** expiration_time,
char ** effective_time )

Get the four timestamps from the Primary Volume Descriptor of the imported ISO image.

The timestamps are strings which are either empty or consist of 16 digits of the form YYYYMMDDhhmmsscc, plus a signed byte in the range of -48 to +52, which gives the timezone offset in steps of 15 minutes. None of the returned string pointers shall be used for altering or freeing data. They are just for reading.

Parameters
imageThe image to be inquired.
creation_timeReturns a pointer to the Volume Creation time: When "the information in the volume was created."
modification_timeReturns a pointer to Volume Modification time: When "the information in the volume was last modified."
expiration_timeReturns a pointer to Volume Expiration time: When "the information in the volume may be regarded as obsolete."
effective_timeReturns a pointer to Volume Expiration time: When "the information in the volume may be used."
Returns
ISO_SUCCESS or error
Since
1.2.8

◆ iso_image_get_root()

IsoDir * iso_image_get_root ( const IsoImage * image)

Get the root directory of the image.

No extra ref is added to it, so you must not unref it. Use iso_node_ref() if you want to get your own reference.

Since
0.6.2

◆ iso_image_get_session_md5()

int iso_image_get_session_md5 ( IsoImage * image,
uint32_t * start_lba,
uint32_t * end_lba,
char md5[16],
int flag )

Obtain the recorded MD5 checksum of the session which was loaded as ISO image.

Such a checksum may be stored together with others in a contiguous array at the end of the session. The session checksum covers the data blocks from address start_lba to address end_lba - 1. It does not cover the recorded array of md5 checksums. Layout, size, and position of the checksum array is recorded in the xattr "isofs.ca" of the session root node.

Parameters
imageThe image to inquire
start_lbaReturns the first block address covered by md5
end_lbaReturns the first block address not covered by md5 any more
md5Returns 16 byte of MD5 checksum
flagBitfield for control purposes, unused yet, submit 0
Returns
1= md5 found 0= no md5 available (i.e. start_lba, end_lba, md5 are invalid) <0 indicates error
Since
0.6.22

◆ iso_image_get_sparc_core()

int iso_image_get_sparc_core ( IsoImage * img,
IsoFile ** sparc_core,
int flag )

Obtain the current setting of iso_image_set_sparc_core().

Parameters
imgThe image to be inquired.
sparc_coreWill return a pointer to the IsoFile (or NULL, which is not an error)
flagBitfield for control purposes, unused yet, submit 0
Returns
1 is success , <0 means error
Since
1.3.0

◆ iso_image_get_system_area()

int iso_image_get_system_area ( IsoImage * img,
char data[32768],
int * options,
int flag )

Obtain a copy of the eventually loaded first 32768 bytes of the imported session, the System Area.

It will be written to the start of the next session unless it gets overwritten by iso_write_opts_set_system_area().

Parameters
imgThe image to be inquired.
dataA byte array of at least 32768 bytes to take the loaded bytes.
optionsThe option bits which will be applied if not overridden by iso_write_opts_set_system_area(). See there.
flagBitfield for control purposes, unused yet, submit 0
Returns
1 on success, 0 if no System Area was loaded, < 0 error.
Since
0.6.30

◆ iso_image_get_system_id()

const char * iso_image_get_system_id ( const IsoImage * image)

Get the system id of a image.

The returned string is owned by the image and must not be freed nor changed.

Since
0.6.2

◆ iso_image_get_truncate_mode()

int iso_image_get_truncate_mode ( IsoImage * img,
int * mode,
int * length )

Inquire the current setting of iso_image_set_truncate_mode().

Parameters
imgThe image which shall be inquired.
modeReturns the mode value.
lengthReturns the length value.
Returns
ISO_SUCCESS or <0 = error
Since
1.4.2

◆ iso_image_get_volset_id()

const char * iso_image_get_volset_id ( const IsoImage * image)

Get the volset identifier.

The returned string is owned by the image and must not be freed nor changed.

Since
0.6.2

◆ iso_image_get_volume_id()

const char * iso_image_get_volume_id ( const IsoImage * image)

Get the volume identifier.

The returned string is owned by the image and must not be freed nor changed.

Since
0.6.2

◆ iso_image_give_up_mips_boot()

int iso_image_give_up_mips_boot ( IsoImage * image,
int flag )

Clear the list of MIPS Big Endian boot file paths.

Parameters
imageThe image to be manipulated.
flagBitfield for control purposes, unused yet, submit 0
Returns
1 is success , <0 means error
Since
0.6.38

◆ iso_image_hfsplus_bless()

int iso_image_hfsplus_bless ( IsoImage * img,
enum IsoHfsplusBlessings blessing,
IsoNode * node,
int flag )

Issue a blessing to a particular IsoNode.

If the blessing is already issued to some file, then it gets revoked from that one.

Parameters
imgThe image to manipulate.
blessingThe kind of blessing to be issued.
nodeThe file that shall be blessed. It must actually be an IsoDir or IsoFile as is appropriate for the kind of blessing. (See above enum.) The node may not yet bear a blessing other than the desired one. If node is NULL, then the blessing will be revoked from any node which bears it.
flagBitfield for control purposes. bit0= Revoke blessing if node != NULL bears it. bit1= Revoke any blessing of the node, regardless of parameter blessing. If node is NULL, then revoke all blessings in the image.
Returns
1 means successful blessing or revokation of an existing blessing. 0 means the node already bears another blessing, or is of wrong type, or that the node was not blessed and revokation was desired. <0 is one of the listed error codes.
Since
1.2.4

◆ iso_image_hfsplus_get_blessed()

int iso_image_hfsplus_get_blessed ( IsoImage * img,
IsoNode *** blessed_nodes,
int * bless_max,
int flag )

Get the array of nodes which are currently blessed.

Array indice correspond to enum IsoHfsplusBlessings. Array element value NULL means that no node bears that blessing.

Several usage restrictions apply. See parameter blessed_nodes.

Parameters
imgThe image to inquire.
blessed_nodesWill return a pointer to an internal node array of image. This pointer is valid only as long as image exists and only until iso_image_hfsplus_bless() gets used to manipulate the blessings. Do not free() this array. Do not alter the content of the array directly, but rather use iso_image_hfsplus_bless() and re-inquire by iso_image_hfsplus_get_blessed(). This call does not impose an extra reference on the nodes in the array. So do not iso_node_unref() them. Nodes listed here are not necessarily grafted into the tree of the IsoImage.
bless_maxWill return the number of elements in the array. It is unlikely but not outruled that it will be larger than ISO_HFSPLUS_BLESS_MAX in this libisofs.h file.
flagBitfield for control purposes. Submit 0.
Returns
1 means success, <0 means error
Since
1.2.4

◆ iso_image_import()

int iso_image_import ( IsoImage * image,
IsoDataSource * src,
IsoReadOpts * opts,
IsoReadImageFeatures ** features )

Import a previous session or image, for growing or modify.

Parameters
imageThe image context to which old image will be imported. Note that all files added to image, and image attributes, will be replaced with the contents of the old image. TODO #00025 support for merging old image files
srcData Source from which old image will be read. A extra reference is added, so you still need to iso_data_source_unref() yours.
optsOptions for image import. All needed data will be copied, so you can free the given struct once this function returns.
featuresIf not NULL, a new IsoReadImageFeatures will be allocated and filled with the features of the old image. It should be freed with iso_read_image_features_destroy() when no more needed. You can pass NULL if you're not interested on them.
Returns
1 on success, < 0 on error
Since
0.6.2

◆ iso_image_new()

int iso_image_new ( const char * name,
IsoImage ** image )

Create a new image, empty.

The image will be owned by you and should be unref() when no more needed.

Parameters
nameName of the image. This will be used as volset_id and volume_id.
imageLocation where the image pointer will be stored.
Returns
1 success, < 0 error
Since
0.6.2

◆ iso_image_path_to_node()

int iso_image_path_to_node ( IsoImage * image,
const char * path,
IsoNode ** node )

Locate a node by its absolute path in the image.

The IsoImage context defines a maximum permissible name length and a mode how to react on oversized names. See iso_image_set_truncate_mode().

Parameters
imageThe image to which the node belongs.
pathFile path beginning at the root directory of image. If truncation mode is set to 1, oversized path components will be truncated before lookup.
nodeLocation for a pointer to the node, it will be filled with NULL if the given path does not exists on image. The node will be owned by the image and shouldn't be unref(). Just call iso_node_ref() to get your own reference to the node. Note that you can pass NULL is the only thing you want to do is check if a node with such path really exists.
Returns
1 node found 0 no truncation was needed, path not found in image 2 truncation happened, truncated path component not found in parent dir < 0 error, see iso_dir_get_node().
Since
1.4.2

◆ iso_image_ref()

void iso_image_ref ( IsoImage * image)

Increments the reference counting of the given image.

Since
0.6.2

◆ iso_image_remove_boot_image()

void iso_image_remove_boot_image ( IsoImage * image)

Removes all El-Torito boot images from the ISO image.

The IsoBoot node that acts as placeholder for the catalog is also removed for the image tree, if there. If the image is not bootable (don't have el-torito boot image) this function just returns.

Since
0.6.2

◆ iso_image_report_el_torito()

int iso_image_report_el_torito ( IsoImage * image,
char *** reply,
int * line_count,
int flag )

Obtain an array of texts describing the detected properties of the eventually loaded El Torito boot information.

The array will be NULL if no El Torito info was loaded. Else it will consist of lines as described in ISO_ELTORITO_REPORT_DOC above.

The lines have the same length restrictions and whitespace rules as the ones returned by iso_image_report_system_area().

Parameters
imageThe image to be inquired.
replyWill return an array of pointers to the result text lines or NULL. Dispose a non-NULL reply by a call to iso_image_report_el_torito() with flag bit15, when no longer needed. Be prepared for a long text with up to ISO_MAX_SYSAREA_LINE_LENGTH characters per line.
line_countWill return the number of valid pointers in reply.
flagBitfield for control purposes bit0= do not report system area but rather reply a copy of above text line array ISO_ELTORITO_REPORT_DOC. With this bit it is permissible to submit image as NULL. bit15= dispose result from previous call.
Returns
1 on success, 0 if no El Torito information was loaded, < 0 error.
Since
1.3.8

◆ iso_image_report_system_area()

int iso_image_report_system_area ( IsoImage * image,
char *** reply,
int * line_count,
int flag )

Obtain an array of texts describing the detected properties of the eventually loaded System Area.

The array will be NULL if no System Area was loaded. It will be non-NULL with zero line count if the System Area was loaded and contains only 0-bytes. Else it will consist of lines as described in ISO_SYSAREA_REPORT_DOC above.

File paths and other long texts are reported as "(too long to show here)" if their length plus preceding text plus trailing 0-byte exceeds the line length limit of ISO_MAX_SYSAREA_LINE_LENGTH bytes. Texts which may contain whitespace or unprintable characters will start at fixed positions and extend to the end of the line. Note that newline characters may well appearing in the middle of a "line".

Parameters
imageThe image to be inquired.
replyWill return an array of pointers to the result text lines or NULL. Dispose a non-NULL reply by a call to iso_image_report_system_area() with flag bit15, when no longer needed. Be prepared for a long text with up to ISO_MAX_SYSAREA_LINE_LENGTH characters per line.
line_countWill return the number of valid pointers in reply.
flagBitfield for control purposes bit0= do not report system area but rather reply a copy of above text line arrays ISO_SYSAREA_REPORT_DOC*. With this bit it is permissible to submit image as NULL. bit15= dispose result from previous call.
Returns
1 on success, 0 if no System Area was loaded, < 0 error.
Since
1.3.8

◆ iso_image_set_abstract_file_id()

void iso_image_set_abstract_file_id ( IsoImage * image,
const char * abstract_file_id )

Fill abstract information for the image.

Usually this refers to a file on disc. Up to 37 characters.

Since
0.6.2

◆ iso_image_set_alpha_boot()

int iso_image_set_alpha_boot ( IsoImage * img,
char * boot_loader_path,
int flag )

Submit the path of the DEC Alpha Secondary Bootstrap Loader file.

The path must lead to an already existing data file in the ISO image which stays with this path until image production. This setting has an effect only if system area type is set to 6 with iso_write_opts_set_system_area().

Parameters
imgThe image to be manipulated.
boot_loader_pathAbsolute path of a data file in the ISO image. Submit NULL to free this image property.
flagBitfield for control purposes. Unused yet. Submit 0.
Returns
1 is success , <0 means error
Since
1.4.0

◆ iso_image_set_app_use()

void iso_image_set_app_use ( IsoImage * image,
const char * app_use_data,
int count )

Fill Application Use field of the Primary Volume Descriptor.

ECMA-119 8.4.32 Application Use (BP 884 to 1395) "This field shall be reserved for application use. Its content is not specified by this Standard."

Parameters
imageThe image to manipulate.
app_use_dataUp to 512 bytes of data.
countThe number of bytes in app_use_data. If the number is smaller than 512, then the remaining bytes will be set to 0.
Since
1.3.2

◆ iso_image_set_application_id()

void iso_image_set_application_id ( IsoImage * image,
const char * application_id )

Fill in the application id for a image.

Up to 128 chars.

Since
0.6.2

◆ iso_image_set_biblio_file_id()

void iso_image_set_biblio_file_id ( IsoImage * image,
const char * biblio_file_id )

Fill biblio information for the image.

Usually this refers to a file on disc. Up to 37 characters.

Since
0.6.2

◆ iso_image_set_boot_catalog_hidden()

int iso_image_set_boot_catalog_hidden ( IsoImage * image,
int hide_attrs )

Hides the boot catalog file from directory trees.

For the meaning of hiding files see iso_node_set_hidden().

Parameters
imageThe image to manipulate.
hide_attrsOr-combination of values from enum IsoHideNodeFlag to set the trees in which the record.
Returns
0= no boot catalog attached , 1= ok , <0 = error
Since
0.6.34

◆ iso_image_set_boot_catalog_weight()

int iso_image_set_boot_catalog_weight ( IsoImage * image,
int sort_weight )

Sets the sort weight of the boot catalog that is attached to an IsoImage.

For the meaning of sort weights see iso_node_set_sort_weight(). That function cannot be applied to the emerging boot catalog because it is not represented by an IsoFile.

Parameters
imageThe image to manipulate.
sort_weightThe larger this value, the lower will be the block address of the boot catalog record.
Returns
0= no boot catalog attached , 1= ok , <0 = error
Since
0.6.32

◆ iso_image_set_boot_image()

int iso_image_set_boot_image ( IsoImage * image,
const char * image_path,
enum eltorito_boot_media_type type,
const char * catalog_path,
ElToritoBootImage ** boot )

Create a new set of El-Torito bootable images by adding a boot catalog and the default boot image.

Further boot images may then be added by iso_image_add_boot_image().

Parameters
imageThe image to make bootable. If it was already bootable this function returns an error and the image remains unmodified.
image_pathThe absolute path of a IsoFile to be used as default boot image or –interval:appended_partition_$number[start$start_size_$size]:... if type is ELTORITO_NO_EMUL. $number gives the partition number. If start$start_size_$size is present, then it overrides the 2 KiB start block of the partition and the partition size counted in blocks of 512 bytes.
typeThe boot media type. This can be one of 3 types:
  • ELTORITO_FLOPPY_EMUL. Floppy emulation: Boot image file must be exactly 1200 KiB, 1440 KiB or 2880 KiB.
  • ELTORITO_HARD_DISC_EMUL. Hard disc emulation: The image must begin with a master boot record with a single image.
  • ELTORITO_NO_EMUL. No emulation. You should specify load segment and load size of image.
catalog_pathThe absolute path in the image tree where the catalog will be stored. The directory component of this path must be a directory existent on the image tree, and the filename component must be unique among all children of that directory on image. Otherwise a correspodent error code will be returned. This function will add an IsoBoot node that acts as a placeholder for the real catalog, that will be generated at image creation time.
bootLocation where a pointer to the added boot image will be stored. That object is owned by the IsoImage and must not be freed by the user, nor dereferenced once the last reference to the IsoImage was disposed via iso_image_unref(). A NULL value is allowed if you don't need a reference to the boot image.
Returns
1 on success, < 0 on error
Since
0.6.2

◆ iso_image_set_copyright_file_id()

void iso_image_set_copyright_file_id ( IsoImage * image,
const char * copyright_file_id )

Fill copyright information for the image.

Usually this refers to a file on disc. Up to 37 characters.

Since
0.6.2

◆ iso_image_set_data_preparer_id()

void iso_image_set_data_preparer_id ( IsoImage * image,
const char * data_preparer_id )

Fill in the data preparer for a image.

Since
0.6.2

◆ iso_image_set_hppa_palo()

int iso_image_set_hppa_palo ( IsoImage * img,
char * cmdline,
char * bootloader,
char * kernel_32,
char * kernel_64,
char * ramdisk,
int flag )

Define a command line and submit the paths of four mandatory files for production of a HP-PA PALO boot sector for PA-RISC machines.

The paths must lead to already existing data files in the ISO image which stay with these paths until image production.

Parameters
imgThe image to be manipulated.
cmdlineUp to 127 characters of command line.
bootloaderAbsolute path of a data file in the ISO image.
kernel_32Absolute path of a data file in the ISO image which serves as 32 bit kernel.
kernel_64Absolute path of a data file in the ISO image which serves as 64 bit kernel.
ramdiskAbsolute path of a data file in the ISO image.
flagBitfield for control purposes bit0= Let NULL parameters free the corresponding image properties. Else only the non-NULL parameters of this call have an effect
Returns
1 is success , <0 means error
Since
1.3.8

◆ iso_image_set_ignore_aclea()

void iso_image_set_ignore_aclea ( IsoImage * image,
int what )

Control whether ACL and xattr will be imported from external filesystems (typically the local POSIX filesystem) when new nodes get inserted.

If enabled by iso_write_opts_set_aaip() they will later be written into the image as AAIP extension fields.

A change of this setting does neither affect existing IsoNode objects nor the way how ACL and xattr are handled when loading an ISO image. The latter is controlled by iso_read_opts_set_no_aaip().

Parameters
imageThe image of which the behavior is to be controlled
whatA bit field which sets the behavior: bit0= ignore ACLs if the external file object bears some bit1= ignore xattr if the external file object bears some bit3= if not bit1: import all xattr namespaces, not only "user."
Since
1.5.0 all other bits are reserved
0.6.14

◆ iso_image_set_node_name()

int iso_image_set_node_name ( IsoImage * image,
IsoNode * node,
const char * name,
int flag )

Set the name of a node.

Note that if the node is already added to a dir this can fail if dir already contains a node with the new name. The IsoImage context defines a maximum permissible name length and a mode how to react on oversized names. See iso_image_set_truncate_mode().

Parameters
imageThe image object to which the node belongs or shall belong in future.
nodeThe node of which you want to change the name. One cannot change the name of the root directory.
nameThe new name for the node. It may not be empty. If it is oversized then it will be handled according to iso_image_set_truncate_mode().
flagbit0= issue warning in case of truncation
Returns
1 on success, < 0 on error
Since
1.4.2

◆ iso_image_set_publisher_id()

void iso_image_set_publisher_id ( IsoImage * image,
const char * publisher_id )

Fill in the publisher for a image.

Since
0.6.2

◆ iso_image_set_sparc_core()

int iso_image_set_sparc_core ( IsoImage * img,
IsoFile * sparc_core,
int flag )

Designate a data file in the ISO image of which the position and size shall be written after the SUN Disk Label.

The position is written as 64-bit big-endian number to byte position 0x228. The size is written as 32-bit big-endian to 0x230. This setting has an effect only if system area type is set to 3 with iso_write_opts_set_system_area().

Parameters
imgThe image to be manipulated.
sparc_coreThe IsoFile which shall be mentioned after the SUN Disk label. NULL is a permissible value. It disables this feature.
flagBitfield for control purposes, unused yet, submit 0
Returns
1 is success , <0 means error
Since
1.3.0

◆ iso_image_set_system_id()

void iso_image_set_system_id ( IsoImage * image,
const char * system_id )

Fill in the system id for a image.

Up to 32 characters.

Since
0.6.2

◆ iso_image_set_truncate_mode()

int iso_image_set_truncate_mode ( IsoImage * img,
int mode,
int length )

Set the name truncation mode and the maximum name length for nodes from image importing, creation of new IsoNode objects, and name changing image manipulations.

Truncated names are supposed to be nearly unique because they end by the MD5 of the first 4095 characters of the untruncated name. One should treat them as if they were the untruncated original names.

For proper processing of truncated names it is necessary to use iso_image_set_node_name() instead of iso_node_set_name() iso_image_add_new_dir() iso_tree_add_new_dir() iso_image_add_new_file() iso_tree_add_new_file() iso_image_add_new_special() iso_tree_add_new_special() iso_image_add_new_symlink() iso_tree_add_new_symlink() iso_image_tree_clone() iso_tree_clone() iso_image_dir_get_node() iso_dir_get_node() iso_image_path_to_node() iso_tree_path_to_node()

Beware of ambiguities if both, the full name and the truncated name, exist in the same directory. Best is to only set truncation parameters once with an ISO filesystem and to never change them later.

If writing of AAIP is enabled, then the mode and length are recorded in xattr "isofs.nt" of the root node. If reading of AAIP is enabled and "isofs.nt" is found, then it gets into effect if both, the truncate mode value from "isofs.nt" and the current truncate mode of the IsoImage are 1, and the length is between 64 and 255.

Parameters
imgThe image which shall be manipulated.
mode0= Do not truncate but throw error ISO_RR_NAME_TOO_LONG if a file name is longer than parameter length. 1= Truncate to length and overwrite the last 33 bytes of that length by a colon ':' and the hex representation of the MD5 of the first 4095 bytes of the whole oversized name. Potential incomplete UTF-8 characters will get their leading bytes replaced by '_'. Mode 1 is the default.
lengthMaximum byte count of a file name. Permissible values are 64 to 255. Default is 255.
Returns
ISO_SUCCESS or ISO_WRONG_ARG_VALUE
Since
1.4.2

◆ iso_image_set_volset_id()

void iso_image_set_volset_id ( IsoImage * image,
const char * volset_id )

Fill in the volset identifier for a image.

Since
0.6.2

◆ iso_image_set_volume_id()

void iso_image_set_volume_id ( IsoImage * image,
const char * volume_id )

Fill in the volume identifier for a image.

Since
0.6.2

◆ iso_image_tree_clone()

int iso_image_tree_clone ( IsoImage * image,
IsoNode * node,
IsoDir * new_parent,
char * new_name,
IsoNode ** new_node,
int flag )

Create a copy of the given node under a different path.

If the node is actually a directory then clone its whole subtree. This call may fail because an IsoFile is encountered which gets fed by an IsoStream which cannot be cloned. See also IsoStream_Iface method clone_stream(). Surely clonable node types are: IsoDir, IsoSymlink, IsoSpecial, IsoFile from a loaded ISO image, IsoFile referring to local filesystem files, IsoFile created by iso_tree_add_new_file from a stream created by iso_memory_stream_new(), IsoFile created by iso_tree_add_new_cut_out_node() Silently ignored are nodes of type IsoBoot. An IsoFile node with IsoStream filters can be cloned if all those filters are clonable and the node would be clonable without filter. Clonable IsoStream filters are created by: iso_file_add_zisofs_filter() iso_file_add_gzip_filter() iso_file_add_external_filter() An IsoNode with extended information as of iso_node_add_xinfo() can only be cloned if each of the iso_node_xinfo_func instances is associated to a clone function. See iso_node_xinfo_make_clonable(). All internally used classes of extended information are clonable.

The IsoImage context defines a maximum permissible name length and a mode how to react on oversized names. See iso_image_set_truncate_mode().

Parameters
imageThe image object to which the node belongs.
nodeThe node to be cloned.
new_parentThe existing directory node where to insert the cloned node.
new_nameThe name for the cloned node. It must not yet exist in new_parent, unless it is a directory and node is a directory and flag bit0 is set.
new_nodeWill return a pointer (without reference) to the newly created clone.
flagBitfield for control purposes. Submit any undefined bits as 0. bit0= Merge directories rather than returning ISO_NODE_NAME_NOT_UNIQUE. This will not allow to overwrite any existing node. Attributes of existing directories will not be overwritten. bit1= issue warning in case of new_name truncation
Returns
<0 means error, 1 = new node created, 2 = if flag bit0 is set: new_node is a directory which already existed.
Since
1.4.2

◆ iso_image_unref()

void iso_image_unref ( IsoImage * image)

Decrements the reference counting of the given image.

If it reaches 0, the image is free, together with its tree nodes (whether their refcount reach 0 too, of course).

Since
0.6.2

◆ iso_image_update_sizes()

int iso_image_update_sizes ( IsoImage * image)

Update the sizes of all files added to image.

This may be called just before iso_image_create_burn_source() to force libisofs to check the file sizes again (they're already checked when added to IsoImage). It is useful if you have changed some files after adding then to the image.

Returns
1 on success, < 0 on error
Since
0.6.8

◆ iso_image_was_blind_attrs()

int iso_image_was_blind_attrs ( IsoImage * image,
int flag )

Inquire whether some local filesystem xattr namespace could not be explored during node building.This may happen due to lack of administrator privileges e.g.

on FreeBSD namespace "system". It may well be that the processed local files have no attributes which would require special privileges. But already their existence was neither denied nor confirmed.

Parameters
imageThe image to inquire.
flagBitfield for control purposes: bit0 = reset internal value to 0
Returns
1 = Exploration was prevented 0 = No such prevention occurred
Since
1.5.0

◆ iso_image_zisofs_discard_bpt()

int iso_image_zisofs_discard_bpt ( IsoImage * image,
int flag )

Discard all buffered zisofs compression block pointers of streams in the given image, which are zisofs compression streams and not currently opened.

Parameters
imageThe image to be manipulated.
flagBitfield for control purposes, unused yet, submit 0
Returns
ISO_SUCCESS on success, <0 on error
Since
1.5.4

◆ iso_init()

int iso_init ( )

Initialize libisofs.

Before any usage of the library you must either call this function or iso_init_with_flag(). Only exception from this rule: iso_lib_version(), iso_lib_is_compatible().

Returns
1 on success, < 0 on error
Since
0.6.2

◆ iso_init_with_flag()

int iso_init_with_flag ( int flag)

Initialize libisofs.

Before any usage of the library you must either call this function or iso_init() which is equivalent to iso_init_with_flag(0). Only exception from this rule: iso_lib_version(), iso_lib_is_compatible().

Parameters
flagBitfield for control purposes bit0= do not set up locale by LC_* environment variables
Returns
1 on success, < 0 on error
Since
0.6.18

◆ iso_interval_reader_destroy()

int iso_interval_reader_destroy ( struct iso_interval_reader ** ivr,
int flag )

Dispose an interval reader object.

Parameters
ivrThe reader object to be disposed. *ivr will be set to NULL.
flagUnused yet. Submit 0.
Returns
ISO_SUCCESS or error (which is < 0)
Since
1.4.0

◆ iso_interval_reader_new()

int iso_interval_reader_new ( IsoImage * img,
char * path,
struct iso_interval_reader ** ivr,
off_t * byte_count,
int flag )

Create an interval reader object.

Parameters
imgThe IsoImage object which can provide the "imported_iso" data source.
pathThe interval reader description string. See above.
ivrReturns in case of success a pointer to the created object. Dispose it by iso_interval_reader_destroy() when no longer needed.
byte_countReturns in case of success the number of bytes in the interval.
flagbit0= tolerate (src == NULL) with "imported_iso". (Will immediately cause eof of interval input.)
Returns
ISO_SUCCESS or error (which is < 0)
Since
1.4.0

◆ iso_interval_reader_read()

int iso_interval_reader_read ( struct iso_interval_reader * ivr,
uint8_t * buf,
int * buf_fill,
int flag )

Read the next block of 2048 bytes from an interval reader object.

If end-of-input happens, the interval will get filled up with 0 bytes.

Parameters
ivrThe object to read from.
bufPointer to memory for filling in at least 2048 bytes.
buf_fillWill in case of success return the number of valid bytes. If this is smaller than 2048, then end-of-interval has occurred.
flagUnused yet. Submit 0.
Returns
ISO_SUCCESS if data were read, 0 if not, < 0 if error
Since
1.4.0

◆ iso_lib_is_compatible()

int iso_lib_is_compatible ( int major,
int minor,
int micro )

Check at runtime if the library is ABI compatible with the given version.

NOTE: This function may be called before iso_init().

Returns
1 lib is compatible, 0 is not.
Since
0.6.2

◆ iso_lib_version()

void iso_lib_version ( int * major,
int * minor,
int * micro )

Get version of the libisofs library at runtime.

NOTE: This function may be called before iso_init().

Since
0.6.2

◆ iso_local_attr_support()

int iso_local_attr_support ( int flag)

libisofs has an internal system dependent adapter to ACL and xattr operations.

For the sake of completeness and simplicity it exposes this functionality to its applications which might want to get and set ACLs from local files. Inquire whether local filesystem operations with ACL or xattr are enabled inside libisofs. They may be disabled because of compile time decisions. E.g. because the operating system does not support these features or because libisofs has not yet an adapter to use them.

Parameters
flagBitfield for control purposes bit0= inquire availability of ACL bit1= inquire availability of xattr bit2 - bit7= Reserved for future types. It is permissibile to set them to 1 already now. bit8 and higher: reserved, submit 0
Returns
Bitfield corresponding to flag. bit0= ACL adapter is enabled bit1= xattr adapter is enabled bit2 - bit7= Reserved for future types. bit8 and higher: reserved, do not interpret these
Since
1.1.6

◆ iso_local_get_acl_text()

int iso_local_get_acl_text ( char * disk_path,
char ** text,
int flag )

Get an ACL of the given file in the local filesystem in long text form.

Parameters
disk_pathAbsolute path to the file
textWill return a pointer to the ACL text. If not NULL the text will be 0 terminated and finally has to be disposed by a call to this function with bit15 set.
flagBitfield for control purposes bit0= get "default" ACL rather than "access" ACL bit4= set *text = NULL and return 2 if the ACL matches st_mode permissions. bit5= in case of symbolic link: inquire link target bit15= free text and return 1
Returns
1 ok 2 ok, trivial ACL found while bit4 is set, *text is NULL 0 no ACL manipulation adapter available / ACL not supported on fs -1 failure of system ACL service (see errno) -2 attempt to inquire ACL of a symbolic link without bit4 or bit5 or with no suitable link target
Since
0.6.14

◆ iso_local_get_attrs()

int iso_local_get_attrs ( char * disk_path,
size_t * num_attrs,
char *** names,
size_t ** value_lengths,
char *** values,
int flag )

Get xattr and non-trivial ACLs of the given file in the local filesystem.

The resulting data has finally to be disposed by a call to this function with flag bit15 set.

Eventual ACLs will get encoded as attribute pair with empty name if this is enabled by flag bit0. An ACL which simply replects stat(2) permissions will not be put into the result.

Parameters
disk_pathAbsolute path to the file
num_attrsWill return the number of name-value pairs
namesWill return an array of pointers to 0-terminated names
value_lengthsWill return an array with the lengths of values
valuesWill return an array of pointers to 8-bit values
flagBitfield for control purposes bit0= obtain eventual ACLs as attribute with empty name bit2= do not obtain attributes other than ACLs bit3= do not ignore eventual non-user attributes. I.e. those with a name which does not begin by "user." bit5= in case of symbolic link: inquire link target bit15= free memory
Returns
1 ok 2 ok, but it is possible that attributes exist in non-user namespaces which could not be explored due to lack of permission.
Since
1.5.0 < 0 failure
0.6.14

◆ iso_local_get_perms_wo_acl()

int iso_local_get_perms_wo_acl ( char * disk_path,
mode_t * st_mode,
int flag )

Obtain permissions of a file in the local filesystem which shall reflect ACL entry "group::" in S_IRWXG rather than ACL entry "mask::".

This is necessary if the permissions of a disk file with ACL shall be copied to an object which has no ACL.

Parameters
disk_pathAbsolute path to the local file which may have an "access" ACL or not.
flagBitfield for control purposes bit5= in case of symbolic link: inquire link target
st_modeReturns permission bits as of stat(2)
Returns
1 success -1 failure of lstat() or stat() (see errno)
Since
0.6.14

◆ iso_local_set_acl_text()

int iso_local_set_acl_text ( char * disk_path,
char * text,
int flag )

Set the ACL of the given file in the local filesystem to a given list in long text form.

Parameters
disk_pathAbsolute path to the file
textThe input text (0 terminated, ACL long text form)
flagBitfield for control purposes bit0= set "default" ACL rather than "access" ACL bit5= in case of symbolic link: manipulate link target
Returns
> 0 ok 0 no ACL manipulation adapter available for desired ACL type -1 failure of system ACL service (see errno) -2 attempt to manipulate ACL of a symbolic link without bit5 or with no suitable link target
Since
0.6.14

◆ iso_local_set_attrs()

int iso_local_set_attrs ( char * disk_path,
size_t num_attrs,
char ** names,
size_t * value_lengths,
char ** values,
int flag )

Older version of iso_local_set_attrs_errno() without the errnos array.

All other parameters and the return value have the same meaning.

Since
0.6.14

◆ iso_local_set_attrs_errno()

int iso_local_set_attrs_errno ( char * disk_path,
size_t num_attrs,
char ** names,
size_t * value_lengths,
char ** values,
int * errnos,
int flag )

Attach a list of xattr and ACLs to the given file in the local filesystem.

Eventual ACLs have to be encoded as attribute pair with empty name.

Parameters
disk_pathAbsolute path to the file
num_attrsNumber of attributes
namesArray of pointers to 0 terminated name strings
value_lengthsArray of byte lengths for each attribute payload
valuesArray of pointers to the attribute payload bytes
errnosArray of integers to return error numbers if encountered at the attempt to process the name-value pair at the given array index number: 0 = no error , -1 = unknown error >0 = errno as of local system calls to set xattr and ACLs
flagBitfield for control purposes bit0= do not attach ACLs from an eventual attribute with empty name bit3= do not ignore eventual non-user attributes. I.e. those with a name which does not begin by "user." bit5= in case of symbolic link: manipulate link target bit6=
Since
1.1.6 tolerate inappropriate presence or absence of directory "default" ACL bit7=
1.5.0 avoid setting a name value pair if it already exists and has the desired value.
Returns
1 = ok < 0 = error
Since
1.5.0

◆ iso_md5_clone()

int iso_md5_clone ( void * old_md5_context,
void ** new_md5_context )

Create a MD5 computation context as clone of an existing one.

One may call iso_md5_clone(old, &new, 0) and then iso_md5_end(&new, result, 0) in order to obtain an intermediate MD5 sum before the computation goes on.

Parameters
old_md5_contextAn opaque handle once returned by iso_md5_start() or iso_md5_clone().
new_md5_contextReturns the opaque handle to the new MD5 context. Submitted *md5_context must be NULL or point to freeable memory.
Returns
1= success , <0 indicates error
Since
0.6.22

◆ iso_md5_compute()

int iso_md5_compute ( void * md5_context,
char * data,
int datalen )

Advance the computation of a MD5 checksum by a chunk of data bytes.

Parameters
md5_contextAn opaque handle once returned by iso_md5_start() or iso_md5_clone().
dataThe bytes which shall be processed into to the checksum.
datalenThe number of bytes to be processed.
Returns
1= success , <0 indicates error
Since
0.6.22

◆ iso_md5_end()

int iso_md5_end ( void ** md5_context,
char result[16] )

Obtain the MD5 checksum from a MD5 computation context and dispose this context.

(If you want to keep the context then call iso_md5_clone() and apply iso_md5_end() to the clone.)

Parameters
md5_contextA pointer to an opaque handle once returned by iso_md5_start() or iso_md5_clone(). *md5_context will be set to NULL in this call.
resultGets filled with the 16 bytes of MD5 checksum.
Returns
1= success , <0 indicates error
Since
0.6.22

◆ iso_md5_match()

int iso_md5_match ( char first_md5[16],
char second_md5[16] )

Inquire whether two MD5 checksums match.

(This is trivial but such a call is convenient and completes the interface.)

Parameters
first_md5A MD5 byte string as returned by iso_md5_end()
second_md5A MD5 byte string as returned by iso_md5_end()
Returns
1= match , 0= mismatch
Since
0.6.22

◆ iso_md5_start()

int iso_md5_start ( void ** md5_context)

Create a MD5 computation context and hand out an opaque handle.

Parameters
md5_contextReturns the opaque handle. Submitted *md5_context must be NULL or point to freeable memory.
Returns
1= success , <0 indicates error
Since
0.6.22

◆ iso_memory_stream_new()

int iso_memory_stream_new ( unsigned char * buf,
size_t size,
IsoStream ** stream )

Create an IsoStream object from content which is stored in a dynamically allocated memory buffer.

The new stream will become owner of the buffer and apply free() to it when the stream finally gets destroyed itself.

Parameters
bufThe dynamically allocated memory buffer with the stream content.
sizeThe number of bytes which may be read from buf.
streamWill return a reference to the newly created stream.
Returns
ISO_SUCCESS or <0 for error. E.g. ISO_NULL_POINTER, ISO_OUT_OF_MEM.
Since
1.0.0

◆ iso_msgs_submit()

int iso_msgs_submit ( int error_code,
char msg_text[],
int os_errno,
char severity[],
int origin )

Submit a message to the libisofs queueing system.

It will be queued or printed as if it was generated by libisofs itself.

Parameters
error_codeThe unique error code of your message. Submit 0 if you do not have reserved error codes within the libburnia project.
msg_textNot more than ISO_MSGS_MESSAGE_LEN characters of message text.
os_errnoEventual errno related to the message. Submit 0 if the message is not related to a operating system error.
severityOne of "ABORT", "FATAL", "FAILURE", "SORRY", "WARNING", "HINT", "NOTE", "UPDATE", "DEBUG". Defaults to "FATAL".
originSubmit 0 for now.
Returns
1 if message was delivered, <=0 if failure
Since
0.6.4

◆ iso_new_find_conditions_and()

IsoFindCondition * iso_new_find_conditions_and ( IsoFindCondition * a,
IsoFindCondition * b )

Create a new condition that check if the two given conditions are valid.

Parameters
a
bIsoFindCondition to compare
Returns
The created IsoFindCondition, NULL on error.
Since
0.6.4

◆ iso_new_find_conditions_atime()

IsoFindCondition * iso_new_find_conditions_atime ( time_t time,
enum iso_find_comparisons comparison )

Create a new condition that checks the time of last access.

Parameters
timeTime to compare against IsoNode atime.
comparisonComparison to be done between IsoNode atime and submitted time. Note that ISO_FIND_COND_GREATER, for example, is true if the node time is greater than the submitted time.
Returns
The created IsoFindCondition, NULL on error.
Since
0.6.4

◆ iso_new_find_conditions_ctime()

IsoFindCondition * iso_new_find_conditions_ctime ( time_t time,
enum iso_find_comparisons comparison )

Create a new condition that checks the time of last status change.

Parameters
timeTime to compare against IsoNode ctime.
comparisonComparison to be done between IsoNode ctime and submitted time. Note that ISO_FIND_COND_GREATER, for example, is true if the node time is greater than the submitted time.
Returns
The created IsoFindCondition, NULL on error.
Since
0.6.4

◆ iso_new_find_conditions_gid()

IsoFindCondition * iso_new_find_conditions_gid ( gid_t gid)

Create a new condition that checks the node gid.

Parameters
gidDesired Group Id.
Returns
The created IsoFindCondition, NULL on error.
Since
0.6.4

◆ iso_new_find_conditions_mode()

IsoFindCondition * iso_new_find_conditions_mode ( mode_t mask)

Create a new condition that checks the node mode against a mode mask.

It can be used to check both file type and permissions.

For example:

iso_new_find_conditions_mode(S_IFREG) : search for regular files iso_new_find_conditions_mode(S_IFCHR | S_IWUSR) : search for character devices where owner has write permissions.

Parameters
maskMode mask to AND against node mode.
Returns
The created IsoFindCondition, NULL on error.
Since
0.6.4

◆ iso_new_find_conditions_mtime()

IsoFindCondition * iso_new_find_conditions_mtime ( time_t time,
enum iso_find_comparisons comparison )

Create a new condition that checks the time of last modification.

Parameters
timeTime to compare against IsoNode mtime.
comparisonComparison to be done between IsoNode mtime and submitted time. Note that ISO_FIND_COND_GREATER, for example, is true if the node time is greater than the submitted time.
Returns
The created IsoFindCondition, NULL on error.
Since
0.6.4

◆ iso_new_find_conditions_name()

IsoFindCondition * iso_new_find_conditions_name ( const char * wildcard)

Create a new condition that checks if the node name matches the given wildcard.

Parameters
wildcard
Returns
The created IsoFindCondition, NULL on error.
Since
0.6.4

◆ iso_new_find_conditions_not()

IsoFindCondition * iso_new_find_conditions_not ( IsoFindCondition * negate)

Create a new condition that check if the given conditions is false.

Parameters
negate
Returns
The created IsoFindCondition, NULL on error.
Since
0.6.4

◆ iso_new_find_conditions_or()

IsoFindCondition * iso_new_find_conditions_or ( IsoFindCondition * a,
IsoFindCondition * b )

Create a new condition that check if at least one the two given conditions is valid.

Parameters
a
bIsoFindCondition to compare
Returns
The created IsoFindCondition, NULL on error.
Since
0.6.4

◆ iso_new_find_conditions_uid()

IsoFindCondition * iso_new_find_conditions_uid ( uid_t uid)

Create a new condition that checks the node uid.

Parameters
uidDesired User Id.
Returns
The created IsoFindCondition, NULL on error.
Since
0.6.4

◆ iso_node_add_xinfo()

int iso_node_add_xinfo ( IsoNode * node,
iso_node_xinfo_func proc,
void * data )

Add extended information to the given node.

Extended info allows applications (and libisofs itself) to add more information to an IsoNode. You can use this facilities to associate temporary information with a given node. This information is not written into the ISO 9660 image on media and thus does not persist longer than the node memory object.

Each node keeps a list of added extended info, meaning you can add several extended info data to each node. Each extended info you add is identified by the proc parameter, a pointer to a function that knows how to manage the external info data. Thus, in order to add several types of extended info, you need to define a "proc" function for each type.

Parameters
nodeThe node where to add the extended info
procA function pointer used to identify the type of the data, and that knows how to manage it
dataExtended info to add.
Returns
1 if success, 0 if the given node already has extended info of the type defined by the "proc" function, < 0 on error
Since
0.6.4

◆ iso_node_cmp_ino()

int iso_node_cmp_ino ( IsoNode * n1,
IsoNode * n2,
int flag )

Compare two nodes whether they are based on the same input and can be considered as hardlinks to the same file objects.

Parameters
n1The first node to compare.
n2The second node to compare.
Returns
-1 if n1 is smaller n2 , 0 if n1 matches n2 , 1 if n1 is larger n2
Parameters
flagBitfield for control purposes, unused yet, submit 0
Since
0.6.20

◆ iso_node_get_acl_text()

int iso_node_get_acl_text ( IsoNode * node,
char ** access_text,
char ** default_text,
int flag )

Get the eventual ACLs which are associated with the node.

The result will be in "long" text form as of man acl and acl_to_text(). Call this function with flag bit15 to finally release the memory occupied by an ACL inquiry.

Parameters
nodeThe node that is to be inquired.
access_textWill return a pointer to the eventual "access" ACL text or NULL if it is not available and flag bit 4 is set.
default_textWill return a pointer to the eventual "default" ACL or NULL if it is not available. (GNU/Linux directories can have a "default" ACL which influences the permissions of newly created files.)
flagBitfield for control purposes bit4= if no "access" ACL is available: return *access_text == NULL else: produce ACL from stat(2) permissions bit15= free memory and return 1 (node may be NULL)
Returns
2 *access_text was produced from stat(2) permissions 1 *access_text was produced from ACL of node 0 if flag bit4 is set and no ACL is available < 0 on error
Since
0.6.14

◆ iso_node_get_atime()

time_t iso_node_get_atime ( const IsoNode * node)

Get the time of last access to the file.

Since
0.6.2

◆ iso_node_get_attrs()

int iso_node_get_attrs ( IsoNode * node,
size_t * num_attrs,
char *** names,
size_t ** value_lengths,
char *** values,
int flag )

Get the list of xattr which is associated with the node.

The resulting data may finally be disposed by a call to this function with flag bit15 set, or its components may be freed one-by-one. The following values are either NULL or malloc() memory: *names, *value_lengths, *values, (*names)[i], (*values)[i] with 0 <= i < *num_attrs. It is allowed to replace or reallocate those memory items in order to to manipulate the attribute list before submitting it to other calls.

If enabled by flag bit0, this list possibly includes the ACLs of the node. They are eventually encoded in a pair with empty name. It is not advisable to alter the value or name of that pair. One may decide to erase both ACLs by deleting this pair or to copy both ACLs by copying the content of this pair to an empty named pair of another node. For all other ACL purposes use iso_node_get_acl_text().

Parameters
nodeThe node that is to be inquired.
num_attrsWill return the number of name-value pairs
namesWill return an array of pointers to 0-terminated names
value_lengthsWill return an array with the lengths of values
valuesWill return an array of pointers to strings of 8-bit bytes
flagBitfield for control purposes bit0= obtain eventual ACLs as attribute with empty name bit2= with bit0: do not obtain attributes other than ACLs bit15= free memory (node may be NULL)
Returns
1 = ok (but *num_attrs may be 0) < 0 = error
Since
0.6.14

◆ iso_node_get_ctime()

time_t iso_node_get_ctime ( const IsoNode * node)

Get the time of last status change of the file.

Since
0.6.2

◆ iso_node_get_gid()

gid_t iso_node_get_gid ( const IsoNode * node)

Get the group id of the node.

Since
0.6.2

◆ iso_node_get_hidden()

int iso_node_get_hidden ( IsoNode * node)

Get the hide_attrs as eventually set by iso_node_set_hidden().

Parameters
nodeThe node to inquire.
Returns
Or-combination of values from enum IsoHideNodeFlag which are currently set for the node.
Since
0.6.34

◆ iso_node_get_mode()

mode_t iso_node_get_mode ( const IsoNode * node)

Get the mode of the node, both permissions and file type, as specified in 'man 2 stat'.

Since
0.6.2

◆ iso_node_get_mtime()

time_t iso_node_get_mtime ( const IsoNode * node)

Get the time of last modification of the file.

Since
0.6.2

◆ iso_node_get_name()

const char * iso_node_get_name ( const IsoNode * node)

Get the name of a node.

The returned string belongs to the node and must not be modified nor freed. Use strdup if you really need your own copy.

Up to version 1.4.2 inquiry of the root directory name returned NULL, which is a bug in the light of above description. Since 1.4.2 the return value is an empty string.

Since
0.6.2

◆ iso_node_get_next_xinfo()

int iso_node_get_next_xinfo ( IsoNode * node,
void ** handle,
iso_node_xinfo_func * proc,
void ** data )

Get the next pair of function pointer and data of an iteration of the list of extended information.

Like: iso_node_xinfo_func proc; void *handle = NULL, *data; while (iso_node_get_next_xinfo(node, &handle, &proc, &data) == 1) { ... make use of proc and data ... } The iteration allocates no memory. So you may end it without any disposal action. IMPORTANT: Do not continue iterations after manipulating the extended information of a node. Memory corruption hazard !

Parameters
nodeThe node to inquire
handleThe opaque iteration handle. Initialize iteration by submitting a pointer to a void pointer with value NULL. Do not alter its content until iteration has ended.
procThe function pointer which serves as key
dataWill be filled with the extended info corresponding to the given proc function
Returns
1 on success 0 if iteration has ended (proc and data are invalid then) < 0 on error
Since
1.0.2

◆ iso_node_get_old_image_lba()

int iso_node_get_old_image_lba ( IsoNode * node,
uint32_t * lba,
int flag )

◆ iso_node_get_parent()

IsoDir * iso_node_get_parent ( IsoNode * node)

◆ iso_node_get_permissions()

mode_t iso_node_get_permissions ( const IsoNode * node)

Get the permissions for the node.

Since
0.6.2

◆ iso_node_get_perms_wo_acl()

mode_t iso_node_get_perms_wo_acl ( const IsoNode * node)

Like iso_node_get_permissions but reflecting ACL entry "group::" in S_IRWXG rather than ACL entry "mask::".

This is necessary if the permissions of a node with ACL shall be restored to a filesystem without restoring the ACL. The same mapping happens internally when the ACL of a node is deleted. If the node has no ACL then the result is iso_node_get_permissions(node).

Parameters
nodeThe node that is to be inquired.
Returns
Permission bits as of stat(2)
Since
0.6.14

◆ iso_node_get_type()

enum IsoNodeType iso_node_get_type ( IsoNode * node)

Get the type of an IsoNode.

Since
0.6.2

◆ iso_node_get_uid()

uid_t iso_node_get_uid ( const IsoNode * node)

Get the user id of the node.

Since
0.6.2

◆ iso_node_get_xinfo()

int iso_node_get_xinfo ( IsoNode * node,
iso_node_xinfo_func proc,
void ** data )

Get the given extended info (defined by the proc function) from the given node.

Parameters
nodeThe node to inquire
procThe function pointer which serves as key
dataWill after successful call point to the xinfo data corresponding to the given proc. This is a pointer, not a feeable data copy.
Returns
1 on success, 0 if node does not have extended info of the requested type, < 0 on error
Since
0.6.4

◆ iso_node_lookup_attr()

int iso_node_lookup_attr ( IsoNode * node,
char * name,
size_t * value_length,
char ** value,
int flag )

Obtain the value of a particular xattr name.

Eventually make a copy of that value and add a trailing 0 byte for caller convenience.

Parameters
nodeThe node that is to be inquired.
nameThe xattr name that shall be looked up.
value_lengthWill return the length of value
valueWill return a string of 8-bit bytes. free() it when no longer needed.
flagBitfield for control purposes, unused yet, submit 0
Returns
1= name found , 0= name not found , <0 indicates error
Since
0.6.18

◆ iso_node_ref()

void iso_node_ref ( IsoNode * node)

Increments the reference counting of the given node.

Since
0.6.2

◆ iso_node_remove()

int iso_node_remove ( IsoNode * node)

Removes a child from a directory and free (unref) it.

If you want to keep the child alive, you need to iso_node_ref() it before this call, but in that case iso_node_take() is a better alternative.

Returns
1 on success, < 0 error
Since
0.6.2

◆ iso_node_remove_all_xinfo()

int iso_node_remove_all_xinfo ( IsoNode * node,
int flag )

Remove all extended information from the given node.

Parameters
nodeThe node where to remove all extended info
flagBitfield for control purposes, unused yet, submit 0
Returns
1 on success, < 0 on error
Since
1.0.2

◆ iso_node_remove_tree()

int iso_node_remove_tree ( IsoNode * node,
IsoDirIter * boss_iter )

Removes a node by iso_node_remove() or iso_dir_iter_remove().

If the node is a directory then the whole tree of nodes underneath is removed too.

Parameters
nodeThe node to be removed.
boss_iterIf not NULL, then the node will be removed by iso_dir_iter_remove(boss_iter) else it will be removed by iso_node_remove(node).
Returns
1 is success, <0 indicates error
Since
1.0.2

◆ iso_node_remove_xinfo()

int iso_node_remove_xinfo ( IsoNode * node,
iso_node_xinfo_func proc )

Remove the given extended info (defined by the proc function) from the given node.

Returns
1 on success, 0 if node does not have extended info of the requested type, < 0 on error
Since
0.6.4

◆ iso_node_set_acl_text()

int iso_node_set_acl_text ( IsoNode * node,
char * access_text,
char * default_text,
int flag )

Set the ACLs of the given node to the lists in parameters access_text and default_text or delete them.

The stat(2) permission bits get updated according to the new "access" ACL if neither bit1 of parameter flag is set nor parameter access_text is NULL. Note that S_IRWXG permission bits correspond to ACL mask permissions if a "mask::" entry exists in the ACL. Only if there is no "mask::" then the "group::" entry corresponds to to S_IRWXG.

Parameters
nodeThe node that is to be manipulated.
access_textThe text to be set into effect as "access" ACL. NULL will delete an eventually existing "access" ACL of the node.
default_textThe text to be set into effect as "default" ACL. NULL will delete an eventually existing "default" ACL of the node. (GNU/Linux directories can have a "default" ACL which influences the permissions of newly created files.)
flagBitfield for control purposes bit0= Do not change the stat(2) permissions. Caution: This can make the node's permission set inconsistent. bit1= Ignore text parameters but rather update the "access" ACL to the stat(2) permissions of node. If no "access" ACL exists, then do nothing and return success. bit2= Be verbose about failure causes.
Since
1.5.2
Returns
> 0 success < 0 failure
Since
0.6.14

◆ iso_node_set_atime()

void iso_node_set_atime ( IsoNode * node,
time_t time )

Set the time of last access to the file.

Since
0.6.2

◆ iso_node_set_attrs()

int iso_node_set_attrs ( IsoNode * node,
size_t num_attrs,
char ** names,
size_t * value_lengths,
char ** values,
int flag )

Set the list of xattr which is associated with the node.

The data get copied so that you may dispose your input data afterwards.

If enabled by flag bit0 then the submitted list of attributes will not only overwrite xattr but also both eventual ACLs of the node. Eventual ACL in the submitted list have to reside in an attribute with empty name.

Parameters
nodeThe node that is to be manipulated.
num_attrsNumber of attributes
namesArray of pointers to 0 terminated name strings
value_lengthsArray of byte lengths for each value
valuesArray of pointers to the value bytes
flagBitfield for control purposes bit0= Do not maintain eventual existing ACL of the node. Set eventual new ACL from value of empty name. bit1= Do not clear the existing attribute list but merge it with the list given by this call. The given values override the values of their eventually existing names. If no xattr with a given name exists, then it will be added as new xattr. So this bit can be used to set a single xattr without inquiring any other xattr of the node. bit2= Delete the attributes with the given names bit3= Allow to affect non-user attributes. I.e. those with a non-empty name which does not begin by "user." (The empty name is always allowed and governed by bit0.) This deletes all previously existing attributes if not bit1 is set. bit4= Do not affect attributes from namespace "isofs". To be combined with bit3 for copying attributes from local filesystem to ISO image.
Since
1.2.4
Returns
1 = ok < 0 = error
Since
0.6.14

◆ iso_node_set_ctime()

void iso_node_set_ctime ( IsoNode * node,
time_t time )

Set the time of last status change of the file.

Since
0.6.2

◆ iso_node_set_gid()

void iso_node_set_gid ( IsoNode * node,
gid_t gid )

Set the group id for the node.

This attribute is only useful when Rock Ridge extensions are enabled.

Since
0.6.2

◆ iso_node_set_hidden()

void iso_node_set_hidden ( IsoNode * node,
int hide_attrs )

Set whether the node will be hidden in the directory trees of RR/ISO 9660, or of Joliet (if enabled at all), or of ISO-9660:1999 (if enabled at all).

A hidden file does not show up by name in the affected directory tree. For example, if a file is hidden only in Joliet, it will normally not be visible on Windows systems, while being shown on GNU/Linux.

If a file is not shown in any of the enabled trees, then its content will not be written to the image, unless LIBISO_HIDE_BUT_WRITE is given (which is available only since release 0.6.34).

Parameters
nodeThe node that is to be hidden.
hide_attrsOr-combination of values from enum IsoHideNodeFlag to set the trees in which the node's name shall be hidden.
Since
0.6.2

◆ iso_node_set_mtime()

void iso_node_set_mtime ( IsoNode * node,
time_t time )

Set the time of last modification of the file.

Since
0.6.2

◆ iso_node_set_name()

int iso_node_set_name ( IsoNode * node,
const char * name )
                       *** Deprecated ***
              use iso_image_set_node_name() instead

Set the name of a node without taking into respect name truncation mode of an IsoImage.

Parameters
nodeThe node whose name you want to change. Note that you can't change the name of the root.
nameThe name for the node. If you supply an empty string or a name greater than 255 characters this returns with failure, and node name is not modified.
Returns
1 on success, < 0 on error
Since
0.6.2

◆ iso_node_set_permissions()

void iso_node_set_permissions ( IsoNode * node,
mode_t mode )

Set the permissions for the node.

This attribute is only useful when Rock Ridge extensions are enabled.

Parameters
nodeThe node to change
modebitmask with the permissions of the node, as specified in 'man 2 stat'. The file type bitfields will be ignored, only file permissions will be modified.
Since
0.6.2

◆ iso_node_set_sort_weight()

void iso_node_set_sort_weight ( IsoNode * node,
int w )

Sets the order in which a node will be written on image.

The data content of files with high weight will be written to low block addresses.

Parameters
nodeThe node which weight will be changed. If it's a dir, this function will change the weight of all its children. For nodes other that dirs or regular files, this function has no effect.
wThe weight as a integer number, the greater this value is, the closer from the beginning of image the file will be written. Default value at IsoNode creation is 0.
Since
0.6.2

◆ iso_node_set_uid()

void iso_node_set_uid ( IsoNode * node,
uid_t uid )

Set the user id for the node.

This attribute is only useful when Rock Ridge extensions are enabled.

Since
0.6.2

◆ iso_node_take()

int iso_node_take ( IsoNode * node)

Removes a child from a directory.

The child is not freed, so you will become the owner of the node. Later you can add the node to another dir (calling iso_dir_add_node), or free it if you don't need it (with iso_node_unref).

Returns
1 on success, < 0 error Possible errors: ISO_NULL_POINTER, if node is NULL ISO_NODE_NOT_ADDED_TO_DIR, if node doesn't belong to a dir
Since
0.6.2

◆ iso_node_unref()

void iso_node_unref ( IsoNode * node)

Decrements the reference counting of the given node.

If it reach 0, the node is free, and, if the node is a directory, its children will be unref() too.

Since
0.6.2

◆ iso_node_xinfo_get_cloner()

int iso_node_xinfo_get_cloner ( iso_node_xinfo_func proc,
iso_node_xinfo_cloner * cloner,
int flag )

Inquire the registered cloner function for a particular class of extended information.

Parameters
procThe key and disposal function which identifies the particular extended information class.
clonerWill return the cloner function which is associated with proc, or NULL.
flagUnused yet, submit 0
Returns
1 success, 0 no cloner registered for proc, < 0 error
Since
1.0.2

◆ iso_node_xinfo_make_clonable()

int iso_node_xinfo_make_clonable ( iso_node_xinfo_func proc,
iso_node_xinfo_cloner cloner,
int flag )

Associate a iso_node_xinfo_cloner to a particular class of extended information in order to make it clonable.

Parameters
procThe key and disposal function which identifies the particular extended information class.
clonerThe cloner function which shall be associated with proc.
flagUnused yet, submit 0
Returns
1 success, < 0 error
Since
1.0.2

◆ iso_node_zf_by_magic()

int iso_node_zf_by_magic ( IsoNode * node,
int flag )

Check for the given node or for its subtree whether the data file content effectively bears zisofs file headers and eventually mark the outcome by an xinfo data record if not already marked by a zisofs compressor filter.

This does not install any filter but only a hint for image generation that the already compressed files shall get written with zisofs ZF entries. Use this if you insert the compressed results of program mkzftree from disk into the image.

Parameters
nodeThe node which shall be checked and, if appropriate, be marked.
flagBitfield for control purposes bit0= prepare for a run with iso_write_opts_set_appendable(,1). Take into account that files from the imported image do not get their content filtered. bit1= permission to overwrite existing zisofs_zf_info bit2= if no zisofs header is found: create xinfo with parameters which indicate no zisofs bit3= no tree recursion if node is a directory bit4= skip files which stem from the imported image bit8-bit15= maximum zisofs version to be recognized (0 means 1)
Returns
0= no zisofs data found 1= zf xinfo added 2= found existing zf xinfo and flag bit1 was not set 3= both encountered: 1 and 2 <0 means error
Since
0.6.18

◆ iso_nowtime()

int iso_nowtime ( time_t * now,
int flag )

Inquire and maybe define the time which is considered to be "now" and used for timestamps of freshly created ISO nodes and as default of image timestamps.

If ever, this should normally be enabled and defined before iso_image_new(). If it is disabled, time(NULL) is considered to be "now".

Parameters
nowReturns the "now" value and maybe submits it as definition.
flagBitfield for control purposes bit0= *now contains the time to be set as nowtime override. Enable the override if not bit1 is set, too. bit1= Disable the nowtime override
Returns
1= *now is not overridden , 2= *now is overridden
Since
1.5.2

◆ iso_obtain_msgs()

int iso_obtain_msgs ( char * minimum_severity,
int * error_code,
int * imgid,
char msg_text[],
char severity[] )

Obtain the oldest pending libisofs message from the queue which has at least the given minimum_severity.

This message and any older message of lower severity will get discarded from the queue and is then lost forever.

Severity may be one of "NEVER", "FATAL", "SORRY", "WARNING", "HINT", "NOTE", "UPDATE", "DEBUG", "ALL". To call with minimum_severity "NEVER" will discard the whole queue.

Parameters
minimum_severityThreshold
error_codeWill become a unique error code as listed at the end of this header
imgidId of the image that was issued the message.
msg_textMust provide at least ISO_MSGS_MESSAGE_LEN bytes.
severityWill become the severity related to the message and should provide at least 80 bytes.
Returns
1 if a matching item was found, 0 if not, <0 for severe errors
Since
0.6.2

◆ iso_read_image_feature_named()

int iso_read_image_feature_named ( IsoReadImageFeatures * f,
char * name,
char ** text,
int * type,
int64_t * num_value,
void ** pt_value,
size_t * pt_size )

Get a named feature as text, num_value, or pt_value depending on its type.

The set of named features includes the features which can be inquired by own iso_read_image_features_*() functions: size See iso_read_image_features_get_size() rockridge See iso_read_image_features_has_rockridge() iso_write_opts_set_rockridge() joliet See iso_read_image_features_has_joliet() iso_write_opts_set_joliet() iso1999 See iso_read_image_features_has_iso1999() iso_write_opts_set_iso1999() eltorito See iso_read_image_features_has_eltorito() tree_loaded See iso_read_image_features_tree_loaded() rr_loaded See iso_read_image_features_rr_loaded() Other named features are: tree_loaded_text Text form of "tree_loaded": 0="ISO9660", 1="Joliet", 2="ISO9660:1999" aaip 1=AAIP information was seen, 0= no AAIP seen Detected traces of potential write option settings: iso_level See iso_write_opts_set_iso_level() untranslated_name_len See iso_write_opts_set_untranslated_name_len() allow_dir_id_ext See iso_write_opts_set_allow_dir_id_ext() omit_version_numbers See iso_write_opts_set_omit_version_numbers() allow_deep_paths See iso_write_opts_set_allow_deep_paths() allow_longer_paths See iso_write_opts_set_allow_longer_paths() max_37_char_filenames See iso_write_opts_set_max_37_char_filenames() no_force_dots See iso_write_opts_set_no_force_dots() allow_lowercase See iso_write_opts_set_allow_lowercase() allow_full_ascii See iso_write_opts_set_allow_full_ascii() relaxed_vol_atts See iso_write_opts_set_relaxed_vol_atts() joliet_longer_paths See iso_write_opts_set_joliet_longer_paths() joliet_long_names See iso_write_opts_set_joliet_long_names() joliet_utf16 See iso_write_opts_set_joliet_utf16() rrip_version_1_10 See iso_write_opts_set_rrip_version_1_10() rrip_1_10_px_ino See iso_write_opts_set_rrip_1_10_px_ino() aaip_susp_1_10 See iso_write_opts_set_aaip_susp_1_10() record_md5_session See iso_write_opts_set_record_md5() param session record_md5_files See iso_write_opts_set_record_md5() param files

Parameters
fA features object returned by iso_image_import() or iso_assess_written_features().
nameThe name of the feature to be inquired.
textIf text is not NULL, *text returns a textual representation of the reply. Dispose *text by free(2) when no longer needed.
typeReturns which of num_value or pt_value is valid: 0= *num_value is valid 1= *pt_value is valid
num_valueReturns the numerical value of the feature if type == 0.
pt_valueReturns a pointer to a memory area inside the features object if type is 1. The area is not necessarily 0-terminated. Do not dispose *pt_value and do not use it after f was disposed.
pt_sizeReturns the size of the pt_value memory area if type is 1. This counting includes a terminating 0-byte if it is present.
Returns
0 = Feature was not yet examined. Reply is not valid. 1 = Reply is valid ISO_UNDEF_READ_FEATURE = Given name is not known <0 = other error
Since
1.5.6

◆ iso_read_image_features_destroy()

void iso_read_image_features_destroy ( IsoReadImageFeatures * f)

Destroy an IsoReadImageFeatures object obtained with iso_image_import() or iso_assess_written_features().

Since
0.6.2

◆ iso_read_image_features_get_size()

uint32_t iso_read_image_features_get_size ( IsoReadImageFeatures * f)

Get the size (in 2048 byte block) of the image, as reported in the PVM.

Since
0.6.2

◆ iso_read_image_features_has_eltorito()

int iso_read_image_features_has_eltorito ( IsoReadImageFeatures * f)

Whether El-Torito boot record is present present in the image imported.

Since
0.6.2

◆ iso_read_image_features_has_iso1999()

int iso_read_image_features_has_iso1999 ( IsoReadImageFeatures * f)

Whether the image is recorded according to ISO 9660:1999, i.e.

it has a version 2 Enhanced Volume Descriptor.

Since
0.6.2

◆ iso_read_image_features_has_joliet()

int iso_read_image_features_has_joliet ( IsoReadImageFeatures * f)

Whether Joliet extensions are present in the image imported.

Since
0.6.2

◆ iso_read_image_features_has_rockridge()

int iso_read_image_features_has_rockridge ( IsoReadImageFeatures * f)

Whether RockRidge extensions are present in the image imported.

Since
0.6.2

◆ iso_read_image_features_rr_loaded()

int iso_read_image_features_rr_loaded ( IsoReadImageFeatures * f)

Tells whether Rock Ridge information was used while loading the tree: 1= yes, 0= no.

Since
1.5.4

◆ iso_read_image_features_text()

int iso_read_image_features_text ( IsoReadImageFeatures * f,
int with_values,
char ** feature_text )

Get all validly assessed named features as one single 0-terminated string consisting of single lines for each feature.

Parameters
fA features object returned by iso_image_import() or iso_assess_written_features().
with_valuesIf set to 1: return lines of form name=value
If set to 0: return lines of form name
feature_textReturns the result string. Dispose by free(2) when no longer needed.
Returns
1 = result is valid, <0 indicates error
Since
1.5.6

◆ iso_read_image_features_tree_loaded()

int iso_read_image_features_tree_loaded ( IsoReadImageFeatures * f)

Tells what directory tree was loaded: 0= ISO 9660 , 1 = Joliet , 2 = ISO 9660:1999.

Since
1.5.4

◆ iso_read_opts_auto_input_charset()

int iso_read_opts_auto_input_charset ( IsoReadOpts * opts,
int mode )

Enable or disable methods to automatically choose an input charset.

This eventually overrides the name set via iso_read_opts_set_input_charset()

Parameters
optsThe option set to be manipulated
modeBitfield for control purposes: bit0= Allow to use the input character set name which is eventually stored in attribute "isofs.cs" of the root directory. Applications may attach this xattr by iso_node_set_attrs() to the root node, call iso_write_opts_set_output_charset() with the same name and enable iso_write_opts_set_aaip() when writing an image. Submit any other bits with value 0.
Since
0.6.18

◆ iso_read_opts_free()

void iso_read_opts_free ( IsoReadOpts * opts)

Free an IsoReadOpts previously allocated with iso_read_opts_new().

Since
0.6.2

◆ iso_read_opts_keep_import_src()

int iso_read_opts_keep_import_src ( IsoReadOpts * opts,
int mode )

Control whether to keep a reference to the IsoDataSource object which allows access to the blocks of the imported ISO 9660 filesystem.

This is needed if the interval reader shall read from "imported_iso".

Parameters
optsThe option set to be manipulated
modeBitfield for control purposes: bit0= Keep a reference to the IsoDataSource until the IsoImage object gets disposed by its final iso_image_unref(). Submit any other bits with value 0.
Since
1.4.0

◆ iso_read_opts_load_system_area()

int iso_read_opts_load_system_area ( IsoReadOpts * opts,
int mode )

Enable or disable loading of the first 32768 bytes of the session.

Parameters
optsThe option set to be manipulated
modeBitfield for control purposes: bit0= Load System Area data and attach them to the image so that they get written by the next session, if not overridden by iso_write_opts_set_system_area(). Submit any other bits with value 0.
Since
0.6.30

◆ iso_read_opts_new()

int iso_read_opts_new ( IsoReadOpts ** opts,
int profile )

Creates an IsoReadOpts for reading an existent image.

You should set the options desired with the correspondent setters. Note that you may want to set the start block value.

Options by default are determined by the selected profile.

Parameters
optsPointer to the location where the newly created IsoReadOpts will be stored. You should free it with iso_read_opts_free() when no more needed.
profileDefault profile for image reading. For now the following values are defined: ---> 0 [STANDARD] Suitable for most situations. Most extension are read. When both Joliet and RR extension are present, RR is used. AAIP for ACL and xattr is not enabled by default.
Returns
1 success, < 0 error
Since
0.6.2

◆ iso_read_opts_set_default_gid()

int iso_read_opts_set_default_gid ( IsoReadOpts * opts,
gid_t gid )

Set default gid for files when RR extensions are not present.

Since
0.6.2

◆ iso_read_opts_set_default_permissions()

int iso_read_opts_set_default_permissions ( IsoReadOpts * opts,
mode_t file_perm,
mode_t dir_perm )

Set default permissions for files when RR extensions are not present.

Parameters
optsThe option set to be manipulated
file_permPermissions for files.
dir_permPermissions for directories.
Since
0.6.2

◆ iso_read_opts_set_default_uid()

int iso_read_opts_set_default_uid ( IsoReadOpts * opts,
uid_t uid )

Set default uid for files when RR extensions are not present.

Since
0.6.2

◆ iso_read_opts_set_ecma119_map()

int iso_read_opts_set_ecma119_map ( IsoReadOpts * opts,
int ecma119_map )

How to convert file names if neither Rock Ridge nor Joliet names are present and acceptable.

Parameters
optsThe option set to be manipulated
ecma119_mapThe conversion mode to apply: 0 = unmapped: Take name as recorded in ECMA-119 directory record (not suitable for writing it to a new ISO filesystem) 1 = stripped: Like unmapped, but strip off trailing ";1" or ".;1" 2 = uppercase: Like stripped, but map {a-z} to {A-Z} 3 = lowercase: Like stripped, but map {A-Z} to {a-z}
Returns
ISO_SUCCESS if ecma119_map was accepted 0 if the value was out of range < 0 if other error
Since
1.4.2

◆ iso_read_opts_set_input_charset()

int iso_read_opts_set_input_charset ( IsoReadOpts * opts,
const char * charset )

Set the input charset of the file names on the image.

NULL to use locale charset. You have to specify a charset if the image filenames are encoded in a charset different that the local one. This could happen, for example, if the image was created on a system with different charset.

Parameters
optsThe option set to be manipulated
charsetThe charset to use as input charset. You can obtain the list of charsets supported on your system executing "iconv -l" in a shell.
Since
0.6.2

◆ iso_read_opts_set_joliet_map()

int iso_read_opts_set_joliet_map ( IsoReadOpts * opts,
int joliet_map )

How to convert Joliet file names.

Parameters
optsThe option set to be manipulated
ecma119_mapThe conversion mode to apply: 0 = unmapped: Take name as recorded in Joliet directory record (not suitable for writing it to a new ISO filesystem) 1 = stripped: Strip off trailing ";1" or ".;1"
Returns
ISO_SUCCESS if joliet_map was accepted 0 if the value was out of range < 0 if other error
Since
1.5.4

◆ iso_read_opts_set_new_inos()

int iso_read_opts_set_new_inos ( IsoReadOpts * opts,
int new_inos )

Control discarding of eventual inode numbers from existing images.

Such numbers may come from RRIP 1.12 entries PX. If not discarded they get written unchanged when the file object gets written into an ISO image. If this inode number is missing with a file in the imported image, or if it has been discarded during image reading, then a unique inode number will be generated at some time before the file gets written into an ISO image. Two image nodes which have the same inode number represent two hardlinks of the same file object. So discarding the numbers splits hardlinks.

Parameters
optsThe option set to be manipulated
new_inos1 = Discard imported inode numbers and finally hand out a unique new one to each single file before it gets written into an ISO image. 0 = Keep eventual inode numbers from PX entries. All other values are reserved.
Since
0.6.20

◆ iso_read_opts_set_no_aaip()

int iso_read_opts_set_no_aaip ( IsoReadOpts * opts,
int noaaip )

Control reading of AAIP information about ACL and xattr when loading existing images.

For importing ACL and xattr when inserting nodes from external filesystems (e.g. the local POSIX filesystem) see iso_image_set_ignore_aclea(). For eventual writing of this information see iso_write_opts_set_aaip().

Parameters
optsThe option set to be manipulated
noaaip1 = Do not read AAIP information 0 = Read AAIP information if available All other values are reserved.
Since
0.6.14

◆ iso_read_opts_set_no_iso1999()

int iso_read_opts_set_no_iso1999 ( IsoReadOpts * opts,
int noiso1999 )

Do not read ISO 9660:1999 enhanced tree.

Since
0.6.2

◆ iso_read_opts_set_no_joliet()

int iso_read_opts_set_no_joliet ( IsoReadOpts * opts,
int nojoliet )

Do not read Joliet extensions.

Since
0.6.2

◆ iso_read_opts_set_no_md5()

int iso_read_opts_set_no_md5 ( IsoReadOpts * opts,
int no_md5 )

Control reading of an array of MD5 checksums which is eventually stored at the end of a session.

See also iso_write_opts_set_record_md5(). Important: Loading of the MD5 array will only work if AAIP is enabled because its position and layout is recorded in xattr "isofs.ca".

Parameters
optsThe option set to be manipulated
no_md50 = Read MD5 array if available, refuse on non-matching MD5 tags 1 = Do not read MD5 checksum array 2 = Read MD5 array, but do not check MD5 tags
Since
1.0.4 All other values are reserved.
0.6.22

◆ iso_read_opts_set_no_rockridge()

int iso_read_opts_set_no_rockridge ( IsoReadOpts * opts,
int norr )

Do not read Rock Ridge extensions.

In most cases you don't want to use this. It could be useful if RR info is damaged, or if you want to use the Joliet tree.

Since
0.6.2

◆ iso_read_opts_set_preferjoliet()

int iso_read_opts_set_preferjoliet ( IsoReadOpts * opts,
int preferjoliet )

Whether to prefer Joliet over RR.

libisofs usually prefers RR over Joliet, as it give us much more info about files. So, if both extensions are present, RR is used. You can set this if you prefer Joliet, but note that this is not very recommended. This doesn't mean than RR extensions are not read: if no Joliet is present, libisofs will read RR tree.

Since
0.6.2

◆ iso_read_opts_set_start_block()

int iso_read_opts_set_start_block ( IsoReadOpts * opts,
uint32_t block )

Set the block where the image begins.

It is usually 0, but may be different on a multisession disc.

Since
0.6.2

◆ iso_ring_buffer_get_status()

int iso_ring_buffer_get_status ( struct burn_source * b,
size_t * size,
size_t * free_bytes )

Get the status of the buffer used by a burn_source.

Parameters
bA burn_source previously obtained with iso_image_create_burn_source().
sizeWill be filled with the total size of the buffer, in bytes
free_bytesWill be filled with the bytes currently available in buffer
Returns
< 0 error, > 0 state: 1="active" : input and consumption are active 2="ending" : input has ended without error 3="failing" : input had error and ended, 5="abandoned" : consumption has ended prematurely 6="ended" : consumption has ended without input error 7="aborted" : consumption has ended after input error
Since
0.6.2

◆ iso_set_abort_severity()

int iso_set_abort_severity ( char * severity)

Set the minimum error severity that causes a libisofs operation to be aborted as soon as possible.

Parameters
severityone of "FAILURE", "MISHAP", "SORRY", "WARNING", "HINT", "NOTE". Severities greater or equal than FAILURE always cause program to abort. Severities under NOTE won't never cause function abort.
Returns
Previous abort priority on success, < 0 on error.
Since
0.6.2

◆ iso_set_local_charset()

int iso_set_local_charset ( char * name,
int flag )

Override the reply of libc function nl_langinfo(CODESET) which may or may not give the name of the character set which is in effect for your environment.

So this call can compensate for inconsistent terminal setups. Another use case is to choose UTF-8 as intermediate character set for a conversion from an exotic input character set to an exotic output set.

Parameters
nameName of the character set to be assumed as "local" one.
flagUnused yet. Submit 0.
Returns
1 indicates success, <=0 failure
Since
0.6.12

◆ iso_set_msgs_severities()

int iso_set_msgs_severities ( char * queue_severity,
char * print_severity,
char * print_id )

Control queueing and stderr printing of messages from libisofs.

Severity may be one of "NEVER", "FATAL", "SORRY", "WARNING", "HINT", "NOTE", "UPDATE", "DEBUG", "ALL".

Parameters
queue_severityGives the minimum limit for messages to be queued. Default: "NEVER". If you queue messages then you must consume them by iso_obtain_msgs().
print_severityDoes the same for messages to be printed directly to stderr.
print_idA text prefix to be printed before the message.
Returns
>0 for success, <=0 for error
Since
0.6.2

◆ iso_sev_to_text()

int iso_sev_to_text ( int severity_number,
char ** severity_name )

Convert a severity number into a severity name.

Parameters
severity_numberThe rank number: the higher, the more severe.
severity_nameA name as with iso_msgs_submit(), e.g. "SORRY".
Since
0.6.4

◆ iso_special_get_dev()

dev_t iso_special_get_dev ( IsoSpecial * special)

Get the device id (major/minor numbers) of the given block or character device file.

The result is undefined for other kind of special files, of first be sure iso_node_get_mode() returns either S_IFBLK or S_IFCHR.

Since
0.6.6

◆ iso_stream_clone()

int iso_stream_clone ( IsoStream * old_stream,
IsoStream ** new_stream,
int flag )

Produce a copy of a stream.

It must be possible to operate both stream objects concurrently. The success of this function depends on the existence of a IsoStream_Iface.clone_stream() method with the stream and with its eventual subordinate streams. See iso_tree_clone() for a list of surely clonable built-in streams.

Parameters
old_streamThe existing stream object to be copied
new_streamWill return a pointer to the copy
flagBitfield for control purposes. Submit 0 for now.
Returns
>0 means success ISO_STREAM_NO_CLONE is issued if no .clone_stream() exists other error return values < 0 may occur depending on kind of stream
Since
1.0.2

◆ iso_stream_close()

int iso_stream_close ( IsoStream * stream)

Close a previously opened IsoStream.

Returns
1 on success, < 0 on error
Since
0.6.4

◆ iso_stream_cmp_ino()

int iso_stream_cmp_ino ( IsoStream * s1,
IsoStream * s2,
int flag )

Compare two streams whether they are based on the same input and will produce the same output.

If in any doubt, then this comparison will indicate no match.

Parameters
s1The first stream to compare.
s2The second stream to compare.
Returns
-1 if s1 is smaller s2 , 0 if s1 matches s2 , 1 if s1 is larger s2
Parameters
flagbit0= do not use s1->class->cmp_ino() even if available
Since
0.6.20

◆ iso_stream_get_external_filter()

int iso_stream_get_external_filter ( IsoStream * stream,
IsoExternalFilterCommand ** cmd,
int flag )

Obtain the IsoExternalFilterCommand which is eventually associated with the given stream.

(Typically obtained from an IsoFile by iso_file_get_stream() or from an IsoStream by iso_stream_get_input_stream()).

Parameters
streamThe stream to be inquired.
cmdWill return the external IsoExternalFilterCommand. Valid only if the call returns 1. This does not increment cmd->refcount.
flagBitfield for control purposes, unused yet, submit 0.
Returns
1 on success, 0 if the stream is not an external filter <0 on error
Since
0.6.18

◆ iso_stream_get_id()

void iso_stream_get_id ( IsoStream * stream,
unsigned int * fs_id,
dev_t * dev_id,
ino_t * ino_id )

Get an unique identifier for a given IsoStream.

Since
0.6.4

◆ iso_stream_get_input_stream()

IsoStream * iso_stream_get_input_stream ( IsoStream * stream,
int flag )

Obtain the eventual input stream of a filter stream.

Parameters
streamThe eventual filter stream to be inquired.
flagBitfield for control purposes. bit0= Follow the chain of input streams and return the one at the end of the chain.
Since
1.3.2
Returns
The input stream, if one exists. Elsewise NULL. No extra reference to the stream is taken by this call.
Since
0.6.18

◆ iso_stream_get_size()

off_t iso_stream_get_size ( IsoStream * stream)

Get the size of a given stream.

This function should always return the same size, even if the underlying source size changes, unless you call iso_stream_update_size().

Returns
IsoStream size in bytes
Since
0.6.4

◆ iso_stream_get_source_path()

char * iso_stream_get_source_path ( IsoStream * stream,
int flag )

Try to get eventual source path string of a stream.

Meaning and availability of this string depends on the stream.class . Expect valid results with types "fsrc" and "cout". Result formats are fsrc: result of file_source_get_path() cout: result of file_source_get_path() " " offset " " size

Parameters
streamThe stream to be inquired.
flagBitfield for control purposes, unused yet, submit 0
Returns
A copy of the path string. Apply free() when no longer needed. NULL if no path string is available.
Since
0.6.18

◆ iso_stream_get_zisofs_par()

int iso_stream_get_zisofs_par ( IsoStream * stream,
int * stream_type,
uint8_t zisofs_algo[2],
uint8_t * algo_num,
int * block_size_log2,
int flag )

Obtain the parameters of a zisofs filter stream.

Parameters
streamThe stream to be inquired.
stream_type1=compressing ("ziso") -1=uncompressing ("osiz") 0 other (any obtained parameters have invalid content)
zisofs_algoAlgorithm as of ZF field: {'p', 'z'} = zisofs version 1 (Zlib) {'P', 'Z'} = zisofs version 2 (Zlib)
algo_numAlgorithm as of zisofs header: 0 = zisofs version 1 (Zlib) 1 = zisofs version 2 (Zlib)
block_size_log2Log2 of the compression block size 15 = 32 kiB , 16 = 64 kiB , 17 = 128 kiB, ...
flagBitfield for control purposes, unused yet, submit 0
Returns
1 on success, 0 if the stream has not class->type "ziso" or "osiz" <0 on error
Since
1.5.4

◆ iso_stream_is_repeatable()

int iso_stream_is_repeatable ( IsoStream * stream)

Whether the given IsoStream can be read several times, with the same results.

For example, a regular file is repeatable, you can read it as many times as you want. However, a pipe isn't.

This function doesn't take into account if the file has been modified between the two reads.

Returns
1 if stream is repeatable, 0 if not, < 0 on error
Since
0.6.4

◆ iso_stream_open()

int iso_stream_open ( IsoStream * stream)

Opens the given stream.

Remember to close the Stream before writing the image.

Returns
1 on success, 2 file greater than expected, 3 file smaller than expected, < 0 on error
Since
0.6.4

◆ iso_stream_read()

int iso_stream_read ( IsoStream * stream,
void * buf,
size_t count )

Attempts to read up to count bytes from the given stream into the buffer starting at buf.

The stream must be open() before calling this, and close() when no more needed.

Returns
number of bytes read, 0 if EOF, < 0 on error
Since
0.6.4

◆ iso_stream_ref()

void iso_stream_ref ( IsoStream * stream)

Increment reference count of an IsoStream.

Since
0.6.4

◆ iso_stream_unref()

void iso_stream_unref ( IsoStream * stream)

Decrement reference count of an IsoStream, and eventually free it if refcount reach 0.

Since
0.6.4

◆ iso_stream_update_size()

int iso_stream_update_size ( IsoStream * stream)

Updates the size of the IsoStream with the current size of the underlying source.

Returns
1 if ok, < 0 on error (has to be a valid libisofs error code), 0 if the IsoStream does not support this function.
Since
0.6.8

◆ iso_stream_zisofs_discard_bpt()

int iso_stream_zisofs_discard_bpt ( IsoStream * stream,
int flag )

Discard the buffered zisofs compression block pointers of a stream, if the stream is a zisofs compression stream and not currently opened.

Parameters
streamThe stream to be manipulated.
flagBitfield for control purposes, unused yet, submit 0
Returns
1 on success, 0 if no block pointers were reoved, <0 on error
Since
1.5.4

◆ iso_symlink_get_dest()

const char * iso_symlink_get_dest ( const IsoSymlink * link)

Get the destination of a node.

The returned string belongs to the node and must not be modified nor freed. Use strdup if you really need your own copy.

Since
0.6.2

◆ iso_symlink_set_dest()

int iso_symlink_set_dest ( IsoSymlink * link,
const char * dest )

Set the destination of a symbolic.

Parameters
linkThe link node to be manipulated
destNew destination for the link. It must be a non-empty string, otherwise this function doesn't modify previous destination.
Returns
1 on success, < 0 on error
Since
0.6.2

◆ iso_text_to_sev()

int iso_text_to_sev ( char * severity_name,
int * severity_number )

Convert a severity name into a severity number, which gives the severity rank of the name.

Parameters
severity_nameA name as with iso_msgs_submit(), e.g. "SORRY".
severity_numberThe rank number: the higher, the more severe.
Returns
>0 success, <=0 failure
Since
0.6.4

◆ iso_tree_add_dir_rec()

int iso_tree_add_dir_rec ( IsoImage * image,
IsoDir * parent,
const char * dir )

Add the contents of a dir to a given directory of the iso tree.

There are several options to control what files are added or how they are managed. Take a look at iso_tree_set_* functions to see different options for recursive directory addition.

TODO comment Builder and Filesystem related issues when exposing both

Parameters
imageThe image to which the directory belongs.
parentDirectory on the image tree where to add the contents of the dir
dirPath to a dir in the filesystem
Returns
number of nodes in parent if success, < 0 otherwise
Since
0.6.2

◆ iso_tree_add_exclude()

int iso_tree_add_exclude ( IsoImage * image,
const char * path )

Add a excluded path.

These are paths that won't never added to image, and will be excluded even when adding recursively its parent directory.

For example, in

iso_tree_add_exclude(image, "/home/user/data/private"); iso_tree_add_dir_rec(image, root, "/home/user/data");

the directory /home/user/data/private won't be added to image.

However, if you explicitly add a deeper dir, it won't be excluded. i.e., in the following example.

iso_tree_add_exclude(image, "/home/user/data"); iso_tree_add_dir_rec(image, root, "/home/user/data/private");

the directory /home/user/data/private is added. On the other, side, and following the example above,

iso_tree_add_dir_rec(image, root, "/home/user");

will exclude the directory "/home/user/data".

Absolute paths are not mandatory, you can, for example, add a relative path such as:

iso_tree_add_exclude(image, "private"); iso_tree_add_exclude(image, "user/data");

to exclude, respectively, all files or dirs named private, and also all files or dirs named data that belong to a folder named "user". Note that the above rule about deeper dirs is still valid. i.e., if you call

iso_tree_add_dir_rec(image, root, "/home/user/data/music");

it is included even containing "user/data" string. However, a possible "/home/user/data/music/user/data" is not added.

Usual wildcards, such as * or ? are also supported, with the usual meaning as stated in "man 7 glob". For example

// to exclude backup text files iso_tree_add_exclude(image, "*.~");

Returns
1 on success, < 0 on error
Since
0.6.2

◆ iso_tree_add_new_cut_out_node()

int iso_tree_add_new_cut_out_node ( IsoImage * image,
IsoDir * parent,
const char * name,
const char * path,
off_t offset,
off_t size,
IsoNode ** node )

Add a new node to the image tree with the given name that must not exist on dir.

The node data content will be a byte interval out of the data content of a file in the local filesystem.

Parameters
imageThe image
parentThe directory in the image tree where the node will be added.
nameThe leaf name that the node will have on image, possibly truncated according to iso_image_set_truncate_mode(). Its directory path depends on the parent node.
pathThe absolute path of the random-access capable file in the local filesystem. Only regular files and device files are supported. On Linux, only regular files and block device offer random-access.
offsetByte number in the given file from where to start reading data.
sizeMax size of the file. This may be more than actually available from byte offset to the end of the file in the local filesystem.
nodeplace where to store a pointer to the newly added file. No extra ref is added, so you will need to call iso_node_ref() if you really need it. You can pass NULL in this parameter if you don't need the pointer.
Returns
number of nodes in parent if success, < 0 otherwise Possible errors: ISO_NULL_POINTER, if image, parent or path are NULL ISO_NODE_NAME_NOT_UNIQUE, a node with same name already exists ISO_OUT_OF_MEM ISO_RR_NAME_TOO_LONG ISO_WRONG_ARG_VALUE, if path is not suitable for random access
Since
0.6.4

Device files as path:

Since
1.5.6

◆ iso_tree_add_new_dir()

int iso_tree_add_new_dir ( IsoDir * parent,
const char * name,
IsoDir ** dir )
                       *** Deprecated ***
              use iso_image_add_new_dir() instead

Add a new directory to the iso tree without taking into respect name truncation mode of an IsoImage. For detailed description of parameters, see above iso_image_add_new_dir().

Parameters
parentthe dir where the new directory will be created
namename for the new dir.
dirplace where to store a pointer to the newly created dir.i
Returns
number of nodes in parent if success, < 0 otherwise Possible errors: ISO_NULL_POINTER, if parent or name are NULL ISO_NODE_NAME_NOT_UNIQUE, a node with same name already exists ISO_OUT_OF_MEM
Since
0.6.2

◆ iso_tree_add_new_file()

int iso_tree_add_new_file ( IsoDir * parent,
const char * name,
IsoStream * stream,
IsoFile ** file )
                       *** Deprecated ***
              use iso_image_add_new_file() instead

Add a new regular file to the iso tree without taking into respect name truncation mode of an IsoImage. For detailed description of parameters, see above iso_image_add_new_file().

Parameters
parentthe dir where the new file will be created
namename for the new file.
streamIsoStream for the contents of the file.
fileplace where to store a pointer to the newly created file.
Returns
number of nodes in parent if success, < 0 otherwise Possible errors: ISO_NULL_POINTER, if parent, name or dest are NULL ISO_NODE_NAME_NOT_UNIQUE, a node with same name already exists ISO_OUT_OF_MEM
Since
0.6.4

◆ iso_tree_add_new_node()

int iso_tree_add_new_node ( IsoImage * image,
IsoDir * parent,
const char * name,
const char * path,
IsoNode ** node )

This is a more versatile form of iso_tree_add_node which allows to set the node name in ISO image already when it gets added.

Add a new node to the image tree, from an existing file, and with the given name, that must not exist on dir.

Parameters
imageThe image
parentThe directory in the image tree where the node will be added.
nameThe leaf name that the node will have on image, possibly truncated according to iso_image_set_truncate_mode(). Its directory path depends on the parent node.
pathThe absolute path of the file in the local filesystem.
nodeplace where to store a pointer to the newly added file. No extra ref is added, so you will need to call iso_node_ref() if you really need it. You can pass NULL in this parameter if you don't need the pointer.
Returns
number of nodes in parent if success, < 0 otherwise Possible errors: ISO_NULL_POINTER, if image, parent or path are NULL ISO_NODE_NAME_NOT_UNIQUE, a node with same name already exists ISO_OUT_OF_MEM ISO_RR_NAME_TOO_LONG
Since
0.6.4

◆ iso_tree_add_new_special()

int iso_tree_add_new_special ( IsoDir * parent,
const char * name,
mode_t mode,
dev_t dev,
IsoSpecial ** special )
                       *** Deprecated ***
              use iso_image_add_new_special() instead

Add a new special file to the directory tree without taking into respect name truncation mode of an IsoImage. For detailed description of parameters, see above iso_image_add_new_special().

Parameters
parentthe dir where the new special file will be created
namename for the new special file.
modefile type and permissions for the new node.
devdevice ID, equivalent to the st_rdev field in man 2 stat.
specialplace where to store a pointer to the newly created special file.
Returns
number of nodes in parent if success, < 0 otherwise Possible errors: ISO_NULL_POINTER, if parent, name or dest are NULL ISO_NODE_NAME_NOT_UNIQUE, a node with same name already exists ISO_WRONG_ARG_VALUE if you select a incorrect mode ISO_OUT_OF_MEM
Since
0.6.2

◆ iso_tree_add_new_symlink()

int iso_tree_add_new_symlink ( IsoDir * parent,
const char * name,
const char * dest,
IsoSymlink ** link )
                       *** Deprecated ***
             use iso_image_add_new_symlink() instead

Add a new symlink to the directory tree without taking into respect name truncation mode of an IsoImage. For detailed description of parameters, see above iso_image_add_new_isymlink().

Parameters
parentthe dir where the new symlink will be created
namename for the new symlink.
destdestination of the link
linkplace where to store a pointer to the newly created link.
Returns
number of nodes in parent if success, < 0 otherwise Possible errors: ISO_NULL_POINTER, if parent, name or dest are NULL ISO_NODE_NAME_NOT_UNIQUE, a node with same name already exists ISO_OUT_OF_MEM
Since
0.6.2

◆ iso_tree_add_node()

int iso_tree_add_node ( IsoImage * image,
IsoDir * parent,
const char * path,
IsoNode ** node )

Add a new node to the image tree, from an existing file.

TODO comment Builder and Filesystem related issues when exposing both

All attributes will be taken from the source file. The appropriate file type will be created.

Parameters
imageThe image
parentThe directory in the image tree where the node will be added.
pathThe absolute path of the file in the local filesystem. The node will have the same leaf name as the file on disk, possibly truncated according to iso_image_set_truncate_mode(). Its directory path depends on the parent node.
nodeplace where to store a pointer to the newly added file. No extra ref is added, so you will need to call iso_node_ref() if you really need it. You can pass NULL in this parameter if you don't need the pointer.
Returns
number of nodes in parent if success, < 0 otherwise Possible errors: ISO_NULL_POINTER, if image, parent or path are NULL ISO_NODE_NAME_NOT_UNIQUE, a node with same name already exists ISO_OUT_OF_MEM ISO_RR_NAME_TOO_LONG
Since
0.6.2

◆ iso_tree_clone()

int iso_tree_clone ( IsoNode * node,
IsoDir * new_parent,
char * new_name,
IsoNode ** new_node,
int flag )
                       *** Deprecated ***
              use iso_image_tree_clone() instead

Create a copy of the given node under a different path without taking into respect name truncation mode of an IsoImage.

Parameters
nodeThe node to be cloned.
new_parentThe existing directory node where to insert the cloned node.
new_nameThe name for the cloned node. It must not yet exist in new_parent, unless it is a directory and node is a directory and flag bit0 is set.
new_nodeWill return a pointer (without reference) to the newly created clone.
flagBitfield for control purposes. Submit any undefined bits as 0. bit0= Merge directories rather than returning ISO_NODE_NAME_NOT_UNIQUE. This will not allow to overwrite any existing node. Attributes of existing directories will not be overwritten.
Returns
<0 means error, 1 = new node created, 2 = if flag bit0 is set: new_node is a directory which already existed.
Since
1.0.2

◆ iso_tree_get_follow_symlinks()

int iso_tree_get_follow_symlinks ( IsoImage * image)

Get current setting for follow_symlinks.

See also
iso_tree_set_follow_symlinks
Since
0.6.2

◆ iso_tree_get_ignore_hidden()

int iso_tree_get_ignore_hidden ( IsoImage * image)

Get current setting for ignore_hidden.

See also
iso_tree_set_ignore_hidden
Since
0.6.2

◆ iso_tree_get_ignore_special()

int iso_tree_get_ignore_special ( IsoImage * image)

Get current setting for ignore_special.

See also
iso_tree_set_ignore_special
Since
0.6.2

◆ iso_tree_get_node_path()

char * iso_tree_get_node_path ( IsoNode * node)

Get the absolute path on image of the given node.

Returns
The path on the image, that must be freed when no more needed. If the given node is not added to any image, this returns NULL.
Since
0.6.4

◆ iso_tree_get_replace_mode()

enum iso_replace_mode iso_tree_get_replace_mode ( IsoImage * image)

Get current setting for replace_mode.

See also
iso_tree_set_replace_mode
Since
0.6.2

◆ iso_tree_path_to_node()

int iso_tree_path_to_node ( IsoImage * image,
const char * path,
IsoNode ** node )
                       *** Deprecated ***
         In most cases use iso_image_path_to_node() instead

Locate a node by its absolute path on image without taking into respect name truncation mode of the image.

Parameters
imageThe image to which the node belongs.
pathFile path beginning at the root directory of image. No truncation will happen.
nodeLocation for a pointer to the node, it will be filled with NULL if the given path does not exists on image. See iso_image_path_to_node().
Returns
1 found, 0 not found, < 0 error
Since
0.6.2

◆ iso_tree_remove_exclude()

int iso_tree_remove_exclude ( IsoImage * image,
const char * path )

Remove a previously added exclude.

See also
iso_tree_add_exclude
Returns
1 on success, 0 exclude do not exists, < 0 on error
Since
0.6.2

◆ iso_tree_resolve_symlink()

int iso_tree_resolve_symlink ( IsoImage * img,
IsoSymlink * sym,
IsoNode ** res,
int * depth,
int flag )

Get the destination node of a symbolic link within the IsoImage.

Parameters
imgThe image wherein to try resolving the link.
symThe symbolic link node which to resolve.
resWill return the found destination node, in case of success. Call iso_node_ref() / iso_node_unref() if you intend to use the node over API calls which might in any event delete it.
depthPrevents endless loops. Submit as 0.
flagBitfield for control purposes. Submit 0 for now.
Returns
1 on success, < 0 on failure, especially ISO_DEEP_SYMLINK and ISO_DEAD_SYMLINK
Since
1.2.4

◆ iso_tree_set_follow_symlinks()

void iso_tree_set_follow_symlinks ( IsoImage * image,
int follow )

Set whether to follow or not symbolic links when added a file from a source to IsoImage.

Default behavior is to not follow symlinks.

Since
0.6.2

◆ iso_tree_set_ignore_hidden()

void iso_tree_set_ignore_hidden ( IsoImage * image,
int skip )

Set whether to skip or not disk files with names beginning by '.

' when adding a directory recursively. Default behavior is to not ignore them.

Clarification: This is not related to the IsoNode property to be hidden in one or more of the resulting image trees as of IsoHideNodeFlag and iso_node_set_hidden().

Since
0.6.2

◆ iso_tree_set_ignore_special()

void iso_tree_set_ignore_special ( IsoImage * image,
int skip )

Set whether to skip or not special files.

Default behavior is to not skip them. Note that, despite of this setting, special files will never be added to an image unless RR extensions were enabled.

Parameters
imageThe image to manipulate.
skipBitmask to determine what kind of special files will be skipped: bit0: ignore FIFOs bit1: ignore Sockets bit2: ignore char devices bit3: ignore block devices
Since
0.6.2

◆ iso_tree_set_replace_mode()

void iso_tree_set_replace_mode ( IsoImage * image,
enum iso_replace_mode mode )

Set the replace mode, that defines the behavior of libisofs when adding a node whit the same name that an existent one, during a recursive directory addition.

Since
0.6.2

◆ iso_tree_set_report_callback()

void iso_tree_set_report_callback ( IsoImage * image,
int(*)(IsoImage *, IsoFileSource *) report )

Set a callback function that libisofs will call for each file that is added to the given image by a recursive addition function.

This includes image import.

Parameters
imageThe image to manipulate.
reportpointer to a function that will be called just before a file will be added to the image. You can control whether the file will be in fact added or ignored. This function should return 1 to add the file, 0 to ignore it and continue, < 0 to abort the process NULL is allowed if you don't want any callback.
Since
0.6.2

◆ iso_truncate_leaf_name()

int iso_truncate_leaf_name ( int mode,
int length,
char * name,
int flag )

Immediately apply the given truncate mode and length to the given string.

Parameters
modeSee iso_image_set_truncate_mode()
lengthSee iso_image_set_truncate_mode()
nameThe string to be inspected and truncated if mode says so.
flagBitfield for control purposes. Unused yet. Submit 0.
Returns
ISO_SUCCESS, ISO_WRONG_ARG_VALUE, ISO_RR_NAME_TOO_LONG
Since
1.4.2

◆ iso_util_decode_md5_tag()

int iso_util_decode_md5_tag ( char data[2048],
int * tag_type,
uint32_t * pos,
uint32_t * range_start,
uint32_t * range_size,
uint32_t * next_tag,
char md5[16],
int flag )

Check a data block whether it is a libisofs session checksum tag and eventually obtain its recorded parameters.

These tags get written after volume descriptors, directory tree and checksum array and can be detected without loading the image tree. One may start reading and computing MD5 at the suspected image session start and look out for a session tag on the fly. See doc/checksum.txt .

Parameters
dataA complete and aligned data block read from an ISO image session.
tag_type0= no tag 1= session tag 2= superblock tag 3= tree tag 4= relocated 64 kB superblock tag (at LBA 0 of overwritable media)
posReturns the LBA where the tag supposes itself to be stored. If this does not match the data block LBA then the tag might be image data payload and should be ignored for image checksumming.
range_startReturns the block address where the session is supposed to start. If this does not match the session start on media then the image volume descriptors have been been relocated. A proper checksum will only emerge if computing started at range_start.
range_sizeReturns the number of blocks beginning at range_start which are covered by parameter md5.
next_tagReturns the predicted block address of the next tag. next_tag is valid only if not 0 and only with return values 2, 3, 4. With tag types 2 and 3, reading shall go on sequentially and the MD5 computation shall continue up to that address. With tag type 4, reading shall resume either at LBA 32 for the first session or at the given address for the session which is to be loaded by default. In both cases the MD5 computation shall be re-started from scratch.
md5Returns 16 byte of MD5 checksum.
flagBitfield for control purposes: bit0-bit7= tag type being looked for 0= any checksum tag 1= session tag 2= superblock tag 3= tree tag 4= relocated superblock tag
Returns
0= not a checksum tag, return parameters are invalid 1= checksum tag found, return parameters are valid <0= error (return parameters are valid with error ISO_MD5_AREA_CORRUPTED but not trustworthy because the tag seems corrupted)
Since
0.6.22

◆ iso_write_opts_attach_jte()

int iso_write_opts_attach_jte ( IsoWriteOpts * opts,
void * libjte_handle )

Associate a libjte environment object to the upcoming write run.

libjte implements Jigdo Template Extraction as of Steve McIntyre and Richard Atterer. The call will fail if no libjte support was enabled at compile time.

Parameters
optsThe option set to be manipulated.
libjte_handlePointer to a struct libjte_env e.g. created by libjte_new(). It must stay existent from the start of image generation by iso_image_create_burn_source() until the write thread has ended. This can be inquired by iso_image_generator_is_running(). In order to keep the libisofs API identical with and without libjte support the parameter type is (void *).
Returns
ISO_SUCCESS or error
Since
0.6.38

◆ iso_write_opts_detach_jte()

int iso_write_opts_detach_jte ( IsoWriteOpts * opts,
void ** libjte_handle )

Remove eventual association to a libjte environment handle.

The call will fail if no libjte support was enabled at compile time.

Parameters
optsThe option set to be manipulated.
libjte_handleIf not submitted as NULL, this will return the previously set libjte handle.
Returns
ISO_SUCCESS or error
Since
0.6.38

◆ iso_write_opts_free()

void iso_write_opts_free ( IsoWriteOpts * opts)

Free an IsoWriteOpts previously allocated with iso_write_opts_new().

Since
0.6.2

◆ iso_write_opts_get_data_start()

int iso_write_opts_get_data_start ( IsoWriteOpts * opts,
uint32_t * data_start,
int flag )

Inquire the start address of the file data blocks after having used IsoWriteOpts with iso_image_create_burn_source().

Parameters
optsThe option set that was used when starting image creation
data_startReturns the logical block address if it is already valid
flagReserved for future usage, set to 0.
Returns
1 indicates valid data_start, <0 indicates invalid data_start
Since
0.6.16

◆ iso_write_opts_new()

int iso_write_opts_new ( IsoWriteOpts ** opts,
int profile )

Creates an IsoWriteOpts for writing an image.

You should set the options desired with the correspondent setters.

Options by default are determined by the selected profile. Fifo size is set by default to 2 MB.

Parameters
optsPointer to the location where the newly created IsoWriteOpts will be stored. You should free it with iso_write_opts_free() when no more needed.
profileDefault profile for image creation. For now the following values are defined: ---> 0 [BASIC] No extensions are enabled, and ISO level is set to 1. Only suitable for usage for very old and limited systems (like MS-DOS), or by a start point from which to set your custom options. ---> 1 [BACKUP] POSIX compatibility for backup. Simple settings, ISO level is set to 3 and RR extensions are enabled. Useful for backup purposes. Note that ACL and xattr are not enabled by default. If you enable them, expect them not to show up in the mounted image. They will have to be retrieved by libisofs applications like xorriso. ---> 2 [DISTRIBUTION] Setting for information distribution. Both RR and Joliet are enabled to maximize compatibility with most systems. Permissions are set to default values, and timestamps to the time of recording.
Returns
1 success, < 0 error
Since
0.6.2

◆ iso_write_opts_set_aaip()

int iso_write_opts_set_aaip ( IsoWriteOpts * opts,
int enable )

Control writing of AAIP information for ACL and xattr.

For importing ACL and xattr when inserting nodes from external filesystems (e.g. the local POSIX filesystem) see iso_image_set_ignore_aclea(). For loading of this information from images see iso_read_opts_set_no_aaip().

Parameters
optsThe option set to be manipulated.
enable1 = write AAIP information from nodes into the image 0 = do not write AAIP information into the image All other values are reserved.
Since
0.6.14

◆ iso_write_opts_set_aaip_susp_1_10()

int iso_write_opts_set_aaip_susp_1_10 ( IsoWriteOpts * opts,
int oldvers )

Write AAIP as extension according to SUSP 1.10 rather than SUSP 1.12.

I.e. without announcing it by an ER field and thus without the need to precede the RRIP fields and the AAIP field by ES fields. This saves 5 to 10 bytes per file and might avoid problems with readers which dislike ER fields other than the ones for RRIP. On the other hand, SUSP 1.12 frowns on such unannounced extensions and prescribes ER and ES. It does this since the year 1994.

In effect only if above iso_write_opts_set_aaip() enables writing of AAIP.

Since
0.6.14

◆ iso_write_opts_set_allow_7bit_ascii()

int iso_write_opts_set_allow_7bit_ascii ( IsoWriteOpts * opts,
int allow )

If not iso_write_opts_set_allow_full_ascii() is set to 1: Allow all 7-bit characters that would be allowed by allow_full_ascii, but map lowercase to uppercase if iso_write_opts_set_allow_lowercase() is not set to 1.

Parameters
opts
The option set to be manipulated.
allowIf not zero, then allow what is described above.
Since
1.2.2

◆ iso_write_opts_set_allow_deep_paths()

int iso_write_opts_set_allow_deep_paths ( IsoWriteOpts * opts,
int allow )

Allow ISO-9660 directory hierarchy to be deeper than 8 levels.

This breaks ECMA-119 specification. Use with caution.

Since
0.6.2

◆ iso_write_opts_set_allow_dir_id_ext()

int iso_write_opts_set_allow_dir_id_ext ( IsoWriteOpts * opts,
int allow )

Convert directory names for ECMA-119 similar to other file names, but do not force a dot or add a version number.

This violates ECMA-119 by allowing one "." and especially ISO level 1 by allowing DOS style 8.3 names rather than only 8 characters. (mkisofs and its clones seem to do this violation.)

Parameters
optsThe option set to be manipulated.
allow1= allow dots , 0= disallow dots and convert them
Returns
1 success, < 0 error
Since
1.0.0

◆ iso_write_opts_set_allow_full_ascii()

int iso_write_opts_set_allow_full_ascii ( IsoWriteOpts * opts,
int allow )

Allow all 8-bit characters to appear on an ISO-9660 filename.

Note that "/" and 0x0 characters are never allowed, even in RR names. This breaks ECMA-119 specification. Use with caution.

Since
0.6.2

◆ iso_write_opts_set_allow_longer_paths()

int iso_write_opts_set_allow_longer_paths ( IsoWriteOpts * opts,
int allow )

Allow path in the ISO-9660 tree to have more than 255 characters.

This breaks ECMA-119 specification. Use with caution.

Since
0.6.2

◆ iso_write_opts_set_allow_lowercase()

int iso_write_opts_set_allow_lowercase ( IsoWriteOpts * opts,
int allow )

Allow lowercase characters in ISO-9660 filenames.

By default, only uppercase characters, numbers and a few other characters are allowed. This breaks ECMA-119 specification. Use with caution. If lowercase is not allowed then those letters get mapped to uppercase letters.

Since
0.6.2

◆ iso_write_opts_set_always_gmt()

int iso_write_opts_set_always_gmt ( IsoWriteOpts * opts,
int gmt )

Whether to always record timestamps in GMT.

By default, libisofs stores local time information on image. You can set this to always store timestamps converted to GMT. This prevents any discrimination of the timezone of the image preparer by the image reader.

It is useful if you want to hide your timezone, or you live in a timezone that can't be represented in ECMA-119. These are timezones with an offset from GMT greater than +13 hours, lower than -12 hours, or not a multiple of 15 minutes. Negative timezones (west of GMT) can trigger bugs in some operating systems which typically appear in mounted ISO images as if the timezone shift from GMT was applied twice (e.g. in New York 22:36 becomes 17:36).

Since
0.6.2

◆ iso_write_opts_set_appendable()

int iso_write_opts_set_appendable ( IsoWriteOpts * opts,
int append )

Set the type of image creation in case there was already an existing image imported.

Libisofs supports two types of creation: stand-alone and appended.

A stand-alone image is an image that does not need the old image any more for being mounted by the operating system or imported by libisofs. It may be written beginning with byte 0 of optical media or disk file objects. There will be no distinction between files from the old image and those which have been added by the new image generation.

On the other side, an appended image is not self contained. It may refer to files that stay stored in the imported existing image. This usage model is inspired by CD multi-session. It demands that the appended image is finally written to the same media or disk file as the imported image at an address behind the end of that imported image. The exact address may depend on media peculiarities and thus has to be announced by the application via iso_write_opts_set_ms_block(). The real address where the data will be written is under control of the consumer of the struct burn_source which takes the output of libisofs image generation. It may be the one announced to libisofs or an intermediate one. Nevertheless, the image will be readable only at the announced address.

If you have not imported a previous image by iso_image_import(), then the image will always be a stand-alone image, as there is no previous data to refer to.

Parameters
optsThe option set to be manipulated.
append1 to create an appended image, 0 for an stand-alone one.
Since
0.6.2

◆ iso_write_opts_set_appended_as_apm()

int iso_write_opts_set_appended_as_apm ( IsoWriteOpts * opts,
int apm )

Control whether partitions created by iso_write_opts_set_partition_img() are to be represented in Apple Partition Map.

Parameters
optsThe option set to be manipulated.
apm0= do not represent appended partitions in APM 1= represent in APM, even if not iso_write_opts_set_part_like_isohybrid() enables it and no other APM partitions emerge.
Returns
ISO_SUCCESS or error
Since
1.4.4

◆ iso_write_opts_set_appended_as_gpt()

int iso_write_opts_set_appended_as_gpt ( IsoWriteOpts * opts,
int gpt )

Control whether partitions created by iso_write_opts_set_partition_img() are to be represented in MBR or as GPT partitions.

Parameters
optsThe option set to be manipulated.
gpt0= represent as MBR partition; as GPT only if other GPT partitions are present 1= represent as GPT partition and cause protective MBR with a single partition which covers the whole output data. This may fail if other settings demand MBR partitions.
Returns
ISO_SUCCESS or error
Since
1.4.0

◆ iso_write_opts_set_default_dir_mode()

int iso_write_opts_set_default_dir_mode ( IsoWriteOpts * opts,
mode_t dir_mode )

Set the mode to use on dirs when you set the replace_mode of dirs to 2.

See also
iso_write_opts_set_replace_mode
Since
0.6.2

◆ iso_write_opts_set_default_file_mode()

int iso_write_opts_set_default_file_mode ( IsoWriteOpts * opts,
mode_t file_mode )

Set the mode to use on files when you set the replace_mode of files to 2.

See also
iso_write_opts_set_replace_mode
Since
0.6.2

◆ iso_write_opts_set_default_gid()

int iso_write_opts_set_default_gid ( IsoWriteOpts * opts,
gid_t gid )

Set the gid to use when you set the replace_gid to 2.

See also
iso_write_opts_set_replace_mode
Since
0.6.2

◆ iso_write_opts_set_default_timestamp()

int iso_write_opts_set_default_timestamp ( IsoWriteOpts * opts,
time_t timestamp )

Set the timestamp to use when you set the replace_timestamps to 2.

See also
iso_write_opts_set_replace_timestamps
Since
0.6.2

◆ iso_write_opts_set_default_uid()

int iso_write_opts_set_default_uid ( IsoWriteOpts * opts,
uid_t uid )

Set the uid to use when you set the replace_uid to 2.

See also
iso_write_opts_set_replace_mode
Since
0.6.2

◆ iso_write_opts_set_dir_rec_mtime()

int iso_write_opts_set_dir_rec_mtime ( IsoWriteOpts * opts,
int allow )

Store as ECMA-119 Directory Record timestamp the mtime of the source node rather than the image creation time.

If storing of mtime is enabled, then the settings of iso_write_opts_set_replace_timestamps() apply. (replace==1 will revoke, replace==2 will override mtime by iso_write_opts_set_default_timestamp().

Since version 1.2.0 this may apply also to Joliet and ISO 9660:1999. To reduce the probability of unwanted behavior changes between pre-1.2.0 and post-1.2.0, the bits for Joliet and ISO 9660:1999 also enable ECMA-119. The hopefully unlikely bit14 may then be used to disable mtime for ECMA-119.

To enable mtime for all three directory trees, submit 7. To disable this feature completely, submit 0.

Parameters
opts
The option set to be manipulated.
allowIf this parameter is negative, then mtime is enabled only for ECMA-119. With positive numbers, the parameter is interpreted as bit field : bit0= enable mtime for ECMA-119 bit1= enable mtime for Joliet and ECMA-119 bit2= enable mtime for ISO 9660:1999 and ECMA-119 bit14= disable mtime for ECMA-119 although some of the other bits would enable it
Since
1.2.0 Before version 1.2.0 this applied only to ECMA-119 : 0 stored image creation time in ECMA-119 tree. Any other value caused storing of mtime. Joliet and ISO 9660:1999 always stored the image creation time.
0.6.12

◆ iso_write_opts_set_disc_label()

int iso_write_opts_set_disc_label ( IsoWriteOpts * opts,
char * label )

Set a name for the system area.

This setting is ignored unless system area type 3 "SUN Disk Label" is in effect by iso_write_opts_set_system_area(). In this case it will replace the default text at the start of the image: "CD-ROM Disc with Sun sparc boot created by libisofs"

Parameters
optsThe option set to be manipulated.
labelA text of up to 128 characters.
Returns
ISO_SUCCESS or error
Since
0.6.40

◆ iso_write_opts_set_efi_bootp()

int iso_write_opts_set_efi_bootp ( IsoWriteOpts * opts,
char * image_path,
int flag )

Copy a data file from the local filesystem into the emerging ISO image.

Mark it by an GPT partition entry as EFI System partition, and also cause protective GPT partition entries before and after the partition. GPT = Globally Unique Identifier Partition Table

This feature may collide with data submitted by iso_write_opts_set_system_area() and with settings made by el_torito_set_isolinux_options() It is compatible with HFS+/FAT production by storing the EFI partition before the start of the HFS+/FAT partition. The GPT overwrites byte 0x0200 to 0x03ff of the system area and all further bytes above 0x0800 which are not used by an Apple Partition Map.

Parameters
optsThe option set to be manipulated.
image_pathFile address in the local file system or instructions for interval reader. See flag bit0. NULL revokes production of the EFI boot partition.
flagbit0= The path contains instructions for the interval reader See above.
Since
1.4.0 All other bits are reserved for future usage. Set them to 0.
Returns
ISO_SUCCESS or error
Since
1.2.4

◆ iso_write_opts_set_fat()

int iso_write_opts_set_fat ( IsoWriteOpts * opts,
int enable )

‍Production of FAT32 is not implemented yet.

This call exists only as preparation for implementation.

Whether to add a FAT32 filesystem to the image which points to the same file content as the other directory trees.

‍FAT32 is planned to get implemented in co-existence with HFS+ Describe impact on MBR

Parameters
optsThe option set to be manipulated.
enable1 to enable FAT32 extension, 0 to not add FAT metadata
Returns
1 success, < 0 error
Since
1.2.4

◆ iso_write_opts_set_fifo_size()

int iso_write_opts_set_fifo_size ( IsoWriteOpts * opts,
size_t fifo_size )

Set the size, in number of blocks, of the ring buffer used between the writer thread and the burn_source.

You have to provide at least a 32 blocks buffer. Default value is set to 2MB, if that is ok for you, you don't need to call this function.

Since
0.6.2

◆ iso_write_opts_set_gpt_guid()

int iso_write_opts_set_gpt_guid ( IsoWriteOpts * opts,
uint8_t guid[16],
int mode )

Control whether the emerging GPT gets a pseudo-randomly generated disk GUID or whether it gets a user supplied GUID.

The partition GUIDs will be generated in a reproducible way by exoring the little-endian 32 bit partition number with the disk GUID beginning at byte offset 9.

Parameters
optsThe option set to be manipulated.
guid16 bytes of user supplied GUID. Readily byte-swapped from the text form as prescribed by UEFI specs: 4 byte, 2 byte, 2 byte as little-endian. 2 byte, 6 byte as big-endian. The upper 4 bit of guid[7] should bear the value 4 to express the RFC 4122 version 4. Bit 7 of byte[8] should be set to 1 and bit 6 be set to 0, in order to express the RFC 4122 variant of UUID, where version 4 means "pseudo-random uuid".
mode0 = ignore parameter guid and produce the GPT disk GUID by a pseudo-random algorithm. This is the default setting. 1 = use parameter guid as GPT disk GUID 2 = ignore parameter guid and derive the GPT disk GUID from parameter vol_uuid of iso_write_opts_set_pvd_times(). The 16 bytes of vol_uuid get copied and bytes 7, 8 get their upper bits changed to comply to RFC 4122 and UEFI. Error ISO_GPT_NO_VOL_UUID will occur if image production begins before vol_uuid was set.
Returns
ISO_SUCCESS or ISO_BAD_GPT_GUID_MODE
Since
1.4.6

◆ iso_write_opts_set_hardlinks()

int iso_write_opts_set_hardlinks ( IsoWriteOpts * opts,
int enable )

Control generation of non-unique inode numbers for the emerging image.

Inode numbers get written as "file serial number" with PX entries as of RRIP-1.12. They may mark families of hardlinks. RRIP-1.10 prescribes a PX entry without file serial number.If not overridden by iso_write_opts_set_rrip_1_10_px_ino() there will be no file serial number written into RRIP-1.10 images.

Inode number generation does not affect IsoNode objects which imported their inode numbers from the old ISO image (see iso_read_opts_set_new_inos()) and which have not been altered since import. It rather applies to IsoNode objects which were newly added to the image, or to IsoNode which brought no inode number from the old image, or to IsoNode where certain properties have been altered since image import.

If two IsoNode are found with same imported inode number but differing properties, then one of them will get assigned a new unique inode number. I.e. the hardlink relation between both IsoNode objects ends.

Parameters
optsThe option set to be manipulated.
enable1 = Collect IsoNode objects which have identical data sources and properties. 0 = Generate unique inode numbers for all IsoNode objects which do not have a valid inode number from an imported ISO image. All other values are reserved.
Since
0.6.20

◆ iso_write_opts_set_hfsp_block_size()

int iso_write_opts_set_hfsp_block_size ( IsoWriteOpts * opts,
int hfsp_block_size,
int apm_block_size )

Set the block size for Apple Partition Map and for HFS+.

Parameters
optsThe option set to be manipulated.
hfsp_block_sizeThe allocation block size to be used by the HFS+ filesystem. 0, 512, or 2048
apm_block_sizeThe block size to be used for and within the Apple Partition Map. 0, 512, or 2048. Size 512 is not compatible with options which produce GPT.
Returns
1 success, < 0 error
Since
1.2.4

◆ iso_write_opts_set_hfsp_serial_number()

int iso_write_opts_set_hfsp_serial_number ( IsoWriteOpts * opts,
uint8_t serial_number[8] )

Supply a serial number for the HFS+ extension of the emerging image.

Parameters
optsThe option set to be manipulated.
serial_number8 bytes which should be unique to the image. If all bytes are 0, then the serial number will be generated as random number by libisofs. This is the default setting.
Returns
1 success, < 0 error
Since
1.2.4

◆ iso_write_opts_set_hfsplus()

int iso_write_opts_set_hfsplus ( IsoWriteOpts * opts,
int enable )

Whether to add a HFS+ filesystem to the image which points to the same file content as the other directory trees.

It will get marked by an Apple Partition Map in the System Area of the ISO image. This may collide with data submitted by iso_write_opts_set_system_area() and with settings made by el_torito_set_isolinux_options() The first 8 bytes of the System Area get overwritten by {0x45, 0x52, 0x08 0x00, 0xeb, 0x02, 0xff, 0xff} which can be executed as x86 machine code without negative effects. So if an MBR gets combined with this feature, then its first 8 bytes should contain no essential commands. The next blocks of 2 KiB in the System Area will be occupied by APM entries. The first one covers the part of the ISO image before the HFS+ filesystem metadata. The second one marks the range from HFS+ metadata to the end of file content data. If more ISO image data follow, then a third partition entry gets produced. Other features of libisofs might cause the need for more APM entries.

Parameters
optsThe option set to be manipulated.
enable1 to enable HFS+ extension, 0 to not add HFS+ metadata and APM
Returns
1 success, < 0 error
Since
1.2.4

◆ iso_write_opts_set_iso1999()

int iso_write_opts_set_iso1999 ( IsoWriteOpts * opts,
int enable )

Whether to use newer ISO-9660:1999 version.

This is the second version of ISO-9660. It allows longer filenames and has less restrictions than old ISO-9660. However, nobody is using it so there are no much reasons to enable this.

Since
0.6.2

◆ iso_write_opts_set_iso_level()

int iso_write_opts_set_iso_level ( IsoWriteOpts * opts,
int level )

Set the ISO-9960 level to write at.

Parameters
optsThe option set to be manipulated.
level-> 1 for higher compatibility with old systems. With this level filenames are restricted to 8.3 characters. -> 2 to allow up to 31 filename characters. -> 3 to allow files greater than 4GB
Returns
1 success, < 0 error
Since
0.6.2

◆ iso_write_opts_set_iso_mbr_part_type()

int iso_write_opts_set_iso_mbr_part_type ( IsoWriteOpts * opts,
int part_type )

Set the partition type of the MBR partition which represents the ISO filesystem or at least protects it.

This is without effect if no such partition emerges by other settings or if the partition type is prescribed mandatorily like 0xee for GPT protective MBR or 0x96 for CHRP.

Parameters
optsThe option set to be manipulated.
part_type0x00 to 0xff as desired partition type. Any other value (e.g. -1) enables the default types of the various occasions.
Returns
ISO_SUCCESS or error
Since
1.4.8

◆ iso_write_opts_set_iso_type_guid()

int iso_write_opts_set_iso_type_guid ( IsoWriteOpts * opts,
uint8_t guid[16],
int valid )

Set the GPT Type GUID for the partition which represents the ISO 9660 filesystem, if such a partition emerges in GPT.

Parameters
optsThe option set to be manipulated.
guid16 bytes of user supplied GUID. Readily byte-swapped from the text form as prescribed by UEFI specs: 4 byte, 2 byte, 2 byte as little-endian. 2 byte, 6 byte as big-endian.
validSet to 1 to make this Type GUID valid. Set to 0 in order to invalidate a previously made setting. In this case the setting of iso_write_opts_set_iso_mbr_part_type() or its default will get into effect.
Returns
ISO_SUCCESS or error
Since
1.5.2

◆ iso_write_opts_set_joliet()

int iso_write_opts_set_joliet ( IsoWriteOpts * opts,
int enable )

Whether to add the non-standard Joliet extension to the image.

This extensions are heavily used in Microsoft Windows systems, so if you plan to use your disc on such a system you should add this extension. Usage of Joliet supplies longer filesystem length (up to 64 unicode characters), and deeper directory structure.

Parameters
optsThe option set to be manipulated.
enable1 to enable Joliet extension, 0 to not add them
Returns
1 success, < 0 error
Since
0.6.2

◆ iso_write_opts_set_joliet_long_names()

int iso_write_opts_set_joliet_long_names ( IsoWriteOpts * opts,
int allow )

Allow leaf names in the Joliet tree to have up to 103 characters.

Normal limit is 64. This breaks Joliet specification. Use with caution.

Since
1.0.6

◆ iso_write_opts_set_joliet_longer_paths()

int iso_write_opts_set_joliet_longer_paths ( IsoWriteOpts * opts,
int allow )

Allow paths in the Joliet tree to have more than 240 characters.

This breaks Joliet specification. Use with caution.

Since
0.6.2

◆ iso_write_opts_set_joliet_utf16()

int iso_write_opts_set_joliet_utf16 ( IsoWriteOpts * opts,
int allow )

Use character set UTF-16BE with Joliet, which is a superset of the actually prescribed character set UCS-2.

This breaks Joliet specification with exotic characters which would elsewise be mapped to underscore '_'. Use with caution.

Since
1.3.6

◆ iso_write_opts_set_max_37_char_filenames()

int iso_write_opts_set_max_37_char_filenames ( IsoWriteOpts * opts,
int allow )

Allow a single file or directory identifier to have up to 37 characters.

This is larger than the 31 characters allowed by ISO level 2, and the extra space is taken from the version number, so this also forces omit_version_numbers. This breaks ECMA-119 specification and could lead to buffer overflow problems on old systems. Use with caution.

Since
0.6.2

◆ iso_write_opts_set_max_ce_entries()

int iso_write_opts_set_max_ce_entries ( IsoWriteOpts * opts,
uint32_t num,
int flag )

Set the maximum number of SUSP CE entries and thus continuation areas.

Each continuation area can hold at most 2048 bytes of SUSP data (Rock Ridge or AAIP). The first area can be smaller. There might be some waste at the end of each area. When the maximum number is exceeded during ISO filesystem production then possibly xattr and ACL get removed or error ISO_TOO_MANY_CE gets reported and filesystem production is prevented.

Files with 32 or more CE entries do not show up in mounted filesystems on Linux. So the default setting is 31 with drop mode 2. If a higher limit is chosen and 31 gets surpassed, then a warning message gets reported.

Parameters
optsThe option set to be manipulated.
numThe maximum number of CE entries per file. Not more than 100000 may be set here. 0 gets silently mapped to 1, because the root directory needs one CE.
flagbit0-bit3 = Drop mode: What to do with AAIP data on too many CE: 0 = throw ISO_TOO_MANY_CE, without dropping anything 1 = permanently drop non-isofs fattr from IsoNode and retry filesystem production 2 = drop ACL if dropping non-isofs fattr does not suffice
Returns
ISO_SUCCESS or ISO_TOO_MANY_CE
Since
1.5.6

◆ iso_write_opts_set_ms_block()

int iso_write_opts_set_ms_block ( IsoWriteOpts * opts,
uint32_t ms_block )

Set the start block of the image.

It is supposed to be the lba where the first block of the image will be written on disc. All references inside the ISO image will take this into account, thus providing a mountable image.

For appendable images, that are written to a new session, you should pass here the lba of the next writable address on disc.

In stand alone images this is usually 0. However, you may want to provide a different ms_block if you don't plan to burn the image in the first session on disc, such as in some CD-Extra disc whether the data image is written in a new session after some audio tracks.

Since
0.6.2

◆ iso_write_opts_set_no_force_dots()

int iso_write_opts_set_no_force_dots ( IsoWriteOpts * opts,
int no )

ISO-9660 forces filenames to have a ".", that separates file name from extension.

libisofs adds it if original filename doesn't has one. Set this to 1 to prevent this behavior. This breaks ECMA-119 specification. Use with caution.

Parameters
optsThe option set to be manipulated.
nobit0= no forced dot with ECMA-119 bit1= no forced dot with Joliet (
Since
0.6.30)
0.6.2

◆ iso_write_opts_set_old_empty()

int iso_write_opts_set_old_empty ( IsoWriteOpts * opts,
int enable )

Use this only if you need to reproduce a suboptimal behavior of older versions of libisofs.

They used address 0 for links and device files, and the address of the Volume Descriptor Set Terminator for empty data files. New versions let symbolic links, device files, and empty data files point to a dedicated block of zero-bytes after the end of the directory trees. (Single-pass reader libarchive needs to see all directory info before processing any data files.)

Parameters
optsThe option set to be manipulated.
enable1 = use the suboptimal block addresses in the range of 0 to 115. 0 = use the address of a block after the directory tree. (Default)
Since
1.0.2

◆ iso_write_opts_set_omit_version_numbers()

int iso_write_opts_set_omit_version_numbers ( IsoWriteOpts * opts,
int omit )

Omit the version number (";1") at the end of the ISO-9660 identifiers.

This breaks ECMA-119 specification, but version numbers are usually not used, so it should work on most systems. Use with caution.

Parameters
optsThe option set to be manipulated.
omitbit0= omit version number with ECMA-119 and Joliet bit1= omit version number with Joliet alone (
Since
0.6.30)
0.6.2

◆ iso_write_opts_set_output_charset()

int iso_write_opts_set_output_charset ( IsoWriteOpts * opts,
const char * charset )

Set the charset to use for the RR names of the files that will be created on the image.

NULL to use default charset, that is the locale charset. You can obtain the list of charsets supported on your system executing "iconv -l" in a shell.

Since
0.6.2

◆ iso_write_opts_set_overwrite_buf()

int iso_write_opts_set_overwrite_buf ( IsoWriteOpts * opts,
uint8_t * overwrite )

Sets the buffer where to store the descriptors which shall be written at the beginning of an overwritable media to point to the newly written image.

This is needed if the write start address of the image is not 0. In this case the first 64 KiB of the media have to be overwritten by the buffer content after the session was written and the buffer was updated by libisofs. Otherwise the new session would not be found by operating system function mount() or by libisoburn. (One could still mount that session if its start address is known.)

If you do not need this information, for example because you are creating a new image for LBA 0 or because you will create an image for a true multisession media, just do not use this call or set buffer to NULL.

Use cases:

  • Together with iso_write_opts_set_appendable(opts, 1) the buffer serves for the growing of an image as done in growisofs by Andy Polyakov. This allows appending of a new session to non-multisession media, such as DVD+RW. The new session will refer to the data of previous sessions on the same media. libisoburn emulates multisession appendability on overwritable media and disk files by performing this use case.
  • Together with iso_write_opts_set_appendable(opts, 0) the buffer allows to write the first session on overwritable media to start addresses other than 0. This address must not be smaller than 32 blocks plus the eventual partition offset as defined by iso_write_opts_set_part_offset(). libisoburn in most cases writes the first session on overwritable media and disk files to LBA (32 + partition_offset) in order to preserve its descriptors from the subsequent overwriting by the descriptor buffer of later sessions.
Parameters
optsThe option set to be manipulated.
overwriteWhen not NULL, it should point to at least 64KiB of memory, where libisofs will install the contents that shall be written at the beginning of overwritable media. You should initialize the buffer either with 0s, or with the contents of the first 32 blocks of the image you are growing. In most cases, 0 is good enough. IMPORTANT: If you use iso_write_opts_set_part_offset() then the overwrite buffer must be larger by the offset defined there.
Since
0.6.2

◆ iso_write_opts_set_part_like_isohybrid()

int iso_write_opts_set_part_like_isohybrid ( IsoWriteOpts * opts,
int alike )

Control whether bits 2 to 8 of el_torito_set_isolinux_options() shall apply even if not isohybrid MBR patching is enabled (bit1 of parameter options of iso_write_opts_set_system_area()):

  • Mentioning of El Torito boot images in GPT.
  • Mentioning of El Torito boot images in APM.

In this case some other behavior from isohybrid processing will apply too:

  • No MBR partition of type 0xee emerges, even if GPT gets produced.
  • Gaps between GPT and APM partitions will not be filled by more partitions.

An extra feature towards isohybrid is enabled:

  • Appended partitions get mentioned in APM if other APM partitions emerge.
Parameters
optsThe option set to be manipulated.
alike0= Apply the described behavior only with ISOLINUX isohybrid. Do not mention appended partitions in APM unless iso_write_opts_set_appended_as_apm() is enabled. 1= Apply the described behavior even without ISOLINUX isohybrid.
Returns
ISO_SUCCESS or error
Since
1.4.4

◆ iso_write_opts_set_part_offset()

int iso_write_opts_set_part_offset ( IsoWriteOpts * opts,
uint32_t block_offset_2k,
int secs_512_per_head,
int heads_per_cyl )

◆ iso_write_opts_set_part_type_guid()

int iso_write_opts_set_part_type_guid ( IsoWriteOpts * opts,
int partition_number,
uint8_t guid[16],
int valid )

Set the GPT Type GUID for a partition defined by iso_write_opts_set_partition_img().

Parameters
optsThe option set to be manipulated.
partition_numberDepicts the partition table entry which shall get the Type GUID.
guid16 bytes of user supplied GUID. Readily byte-swapped from the text form as prescribed by UEFI specs: 4 byte, 2 byte, 2 byte as little-endian. 2 byte, 6 byte as big-endian.
validSet to 1 to make this Type GUID valid. Set to 0 in order to invalidate a previously made setting. In this case MBR type 0xEF will become the EFI Type GUID. All others will become the Basic Data Partition Type GUID.
Returns
ISO_SUCCESS or error
Since
1.5.2

◆ iso_write_opts_set_partition_img()

int iso_write_opts_set_partition_img ( IsoWriteOpts * opts,
int partition_number,
uint8_t partition_type,
char * image_path,
int flag )

Cause an arbitrary data file to be appended to the ISO image and to be described by a partition table entry in an MBR or SUN Disk Label at the start of the ISO image.

The partition entry will bear the size of the image file rounded up to the next multiple of 2048 bytes. MBR or SUN Disk Label are selected by iso_write_opts_set_system_area() system area type: 0 selects MBR partition table. 3 selects a SUN partition table with 320 kB start alignment.

Parameters
optsThe option set to be manipulated.
partition_numberDepicts the partition table entry which shall describe the appended image. Range with MBR: 1 to 4. 1 will cause the whole ISO image to be unclaimable space before partition 1. Range with SUN Disk Label: 2 to 8.
partition_typeThe MBR partition type. E.g. FAT12 = 0x01 , FAT16 = 0x06, Linux Native Partition = 0x83. See fdisk command L. This parameter is ignored with SUN Disk Label.
image_pathFile address in the local file system or instructions for interval reader. See flag bit0. With SUN Disk Label: an empty name causes the partition to become a copy of the next lower partition.
flagbit0= The path contains instructions for the interval reader See above.
Since
1.4.0 All other bits are reserved for future usage. Set them to 0.
Returns
ISO_SUCCESS or error
Since
0.6.38

◆ iso_write_opts_set_prep_img()

int iso_write_opts_set_prep_img ( IsoWriteOpts * opts,
char * image_path,
int flag )

Copy a data file from the local filesystem into the emerging ISO image.

Mark it by an MBR partition entry as PreP partition and also cause protective MBR partition entries before and after this partition. Vladimir Serbinenko stated aboy PreP = PowerPC Reference Platform : "PreP [...] refers mainly to IBM hardware. PreP boot is a partition containing only raw ELF and having type 0x41."

This feature is only combinable with system area type 0 and currently not combinable with ISOLINUX isohybrid production. It overrides –protective-msdos-label. See iso_write_opts_set_system_area(). Only partition 4 stays available for iso_write_opts_set_partition_img(). It is compatible with HFS+/FAT production by storing the PreP partition before the start of the HFS+/FAT partition.

Parameters
optsThe option set to be manipulated.
image_pathFile address in the local file system or instructions for interval reader. See flag bit0. NULL revokes production of the PreP partition.
flagbit0= The path contains instructions for the interval reader. See above.
Since
1.4.0 All other bits are reserved for future usage. Set them to 0.
Returns
ISO_SUCCESS or error
Since
1.2.4

◆ iso_write_opts_set_pvd_times()

int iso_write_opts_set_pvd_times ( IsoWriteOpts * opts,
time_t vol_creation_time,
time_t vol_modification_time,
time_t vol_expiration_time,
time_t vol_effective_time,
char * vol_uuid )

Explicitly set the four timestamps of the emerging Primary Volume Descriptor and in the volume descriptors of Joliet and ISO 9660:1999, if those are to be generated.

Default with all parameters is 0.

ECMA-119 defines them as:

Parameters
optsThe option set to be manipulated.
vol_creation_timeWhen "the information in the volume was created." A value of 0 means that the timepoint of write start is to be used.
vol_modification_timeWhen "the information in the volume was last modified." A value of 0 means that the timepoint of write start is to be used.
vol_expiration_timeWhen "the information in the volume may be regarded as obsolete." A value of 0 means that the information never shall expire.
vol_effective_timeWhen "the information in the volume may be used." A value of 0 means that not such retention is intended.
vol_uuidIf this text is not empty, then it overrides vol_creation_time and vol_modification_time by copying the first 16 decimal digits from uuid, eventually padding up with decimal '1', and writing a NUL-byte as timezone. Other than with vol_*_time the resulting string in the ISO image is fully predictable and free of timezone pitfalls. It should express a reasonable time in form YYYYMMDDhhmmsscc. The timezone will always be recorded as GMT. E.g.: "2010040711405800" = 7 Apr 2010 11:40:58 (+0 centiseconds)
Returns
ISO_SUCCESS or error
Since
0.6.30

◆ iso_write_opts_set_record_md5()

int iso_write_opts_set_record_md5 ( IsoWriteOpts * opts,
int session,
int files )

Whether to compute and record MD5 checksums for the whole session and/or for each single IsoFile object.

The checksums represent the data as they were written into the image output stream, not necessarily as they were on hard disk at any point of time. See also calls iso_image_get_session_md5() and iso_file_get_md5().

Parameters
optsThe option set to be manipulated.
sessionIf bit0 set: Compute session checksum
filesIf bit0 set: Compute a checksum for each single IsoFile object which gets its data content written into the session. Copy checksums from files which keep their data in older sessions. If bit1 set: Check content stability (only with bit0). I.e. before writing the file content into to image stream, read it once and compute a MD5. Do a second reading for writing into the image stream. Afterwards compare both MD5 and issue a MISHAP event ISO_MD5_STREAM_CHANGE if they do not match. Such a mismatch indicates content changes between the time point when the first MD5 reading started and the time point when the last block was read for writing. So there is high risk that the image stream was fed from changing and possibly inconsistent file content.
Since
0.6.22

◆ iso_write_opts_set_relaxed_vol_atts()

int iso_write_opts_set_relaxed_vol_atts ( IsoWriteOpts * opts,
int allow )

Allow all characters to be part of Volume and Volset identifiers on the Primary Volume Descriptor.

This breaks ISO-9660 constraints, but should work on modern systems.

Since
0.6.2

◆ iso_write_opts_set_replace_mode()

int iso_write_opts_set_replace_mode ( IsoWriteOpts * opts,
int dir_mode,
int file_mode,
int uid,
int gid )

Whether to set default values for files and directory permissions, gid and uid.

All these take one of three values: 0, 1 or 2.

If 0, the corresponding attribute will be kept as set in the IsoNode. Unless you have changed it, it corresponds to the value on disc, so it is suitable for backup purposes. If set to 1, the corresponding attrib. will be changed by a default suitable value. Finally, if you set it to 2, the attrib. will be changed with the value specified by the functioins below. Note that for mode attributes, only the permissions are set, the file type remains unchanged.

See also
iso_write_opts_set_default_dir_mode
iso_write_opts_set_default_file_mode
iso_write_opts_set_default_uid
iso_write_opts_set_default_gid
Since
0.6.2

◆ iso_write_opts_set_replace_timestamps()

int iso_write_opts_set_replace_timestamps ( IsoWriteOpts * opts,
int replace )

0 to use IsoNode timestamps, 1 to use recording time, 2 to use values from timestamp field.

This applies to the timestamps of Rock Ridge and if the use of mtime is enabled by iso_write_opts_set_dir_rec_mtime(). In the latter case, value 1 will revoke the recording of mtime, value 2 will override mtime by iso_write_opts_set_default_timestamp().

See also
iso_write_opts_set_default_timestamp
Since
0.6.2

◆ iso_write_opts_set_rockridge()

int iso_write_opts_set_rockridge ( IsoWriteOpts * opts,
int enable )

Whether to use or not Rock Ridge extensions.

This are standard extensions to ECMA-119, intended to add POSIX filesystem features to ECMA-119 images. Thus, usage of this flag is highly recommended for images used on GNU/Linux systems. With the usage of RR extension, the resulting image will have long filenames (up to 255 characters), deeper directory structure, POSIX permissions and owner info on files and directories, support for symbolic links or special files... All that attributes can be modified/set with the appropriate function.

Parameters
optsThe option set to be manipulated.
enable1 to enable RR extension, 0 to not add them
Returns
1 success, < 0 error
Since
0.6.2

◆ iso_write_opts_set_rr_reloc()

int iso_write_opts_set_rr_reloc ( IsoWriteOpts * opts,
char * name,
int flags )

This call describes the directory where to store Rock Ridge relocated directories.

If not iso_write_opts_set_allow_deep_paths(,1) is in effect, then it may become necessary to relocate directories so that no ECMA-119 file path has more than 8 components. These directories are grafted into either the root directory of the ISO image or into a dedicated relocation directory. For Rock Ridge, the relocated directories are linked forth and back to placeholders at their original positions in path level 8. Directories marked by Rock Ridge entry RE are to be considered artefacts of relocation and shall not be read into a Rock Ridge tree. Instead they are to be read via their placeholders and their links. For plain ECMA-119, the relocation directory and the relocated directories are just normal directories which contain normal files and directories.

Parameters
optsThe option set to be manipulated.
nameThe name of the relocation directory in the root directory. Do not prepend "/". An empty name or NULL will direct relocated directories into the root directory. This is the default. If the given name does not exist in the root directory when iso_image_create_burn_source() is called, and if there are directories at path level 8, then directory /name will be created automatically. The name given by this call will be compared with iso_node_get_name() of the directories in the root directory, not with the final ECMA-119 names of those directories.
flagsBitfield for control purposes. bit0= Mark the relocation directory by a Rock Ridge RE entry, if it gets created during iso_image_create_burn_source(). This will make it invisible for most Rock Ridge readers. bit1= not settable via API (used internally)
Returns
1 success, < 0 error
Since
1.2.2

◆ iso_write_opts_set_rrip_1_10_px_ino()

int iso_write_opts_set_rrip_1_10_px_ino ( IsoWriteOpts * opts,
int enable )

Write field PX with file serial number (i.e.

inode number) even if iso_write_opts_set_rrip_version_1_10(,1) is in effect. This clearly violates the RRIP-1.10 specs. But it is done by mkisofs since a while and no widespread protest is visible in the web. If this option is not enabled, then iso_write_opts_set_hardlinks() will only have an effect with iso_write_opts_set_rrip_version_1_10(,0).

Since
0.6.20

◆ iso_write_opts_set_rrip_version_1_10()

int iso_write_opts_set_rrip_version_1_10 ( IsoWriteOpts * opts,
int oldvers )

Write Rock Ridge info as of specification RRIP-1.10 rather than RRIP-1.12: signature "RRIP_1991A" rather than "IEEE_1282", field PX without file serial number.

Since
0.6.12

◆ iso_write_opts_set_scdbackup_tag()

int iso_write_opts_set_scdbackup_tag ( IsoWriteOpts * opts,
char * name,
char * timestamp,
char * tag_written )

Set the parameters "name" and "timestamp" for a scdbackup checksum tag.

It will be appended to the libisofs session tag if the image starts at LBA 0 (see iso_write_opts_set_ms_block()). The scdbackup tag can be used to verify the image by command scdbackup_verify device -auto_end. See scdbackup/README appendix VERIFY for its inner details.

Parameters
optsThe option set to be manipulated.
nameA word of up to 80 characters. Typically volno_totalno telling that this is volume volno of a total of totalno volumes.
timestampA string of 13 characters YYMMDD.hhmmss (e.g. A90831.190324). A9 = 2009, B0 = 2010, B1 = 2011, ... C0 = 2020, ...
tag_writtenEither NULL or the address of an array with at least 512 characters. In the latter case the eventually produced scdbackup tag will be copied to this array when the image gets written. This call sets scdbackup_tag_written[0] = 0 to mark its preliminary invalidity.
Returns
1 indicates success, <0 is error
Since
0.6.24

◆ iso_write_opts_set_sort_files()

int iso_write_opts_set_sort_files ( IsoWriteOpts * opts,
int sort )

Whether to sort files based on their weight.

See also
iso_node_set_sort_weight
Since
0.6.2

◆ iso_write_opts_set_system_area()

int iso_write_opts_set_system_area ( IsoWriteOpts * opts,
char data[32768],
int options,
int flag )

◆ iso_write_opts_set_tail_blocks()

int iso_write_opts_set_tail_blocks ( IsoWriteOpts * opts,
uint32_t num_blocks )

Cause a number of blocks with zero bytes to be written after the payload data, but before the eventual checksum data.

Unlike libburn tail padding, these blocks are counted as part of the image and covered by eventual image checksums. A reason for such padding can be the wish to prevent the Linux read-ahead bug by sacrificial data which still belong to image and Jigdo template. Normally such padding would be the job of the burn program which should know that it is needed with CD write type TAO if Linux read(2) shall be able to read all payload blocks. 150 blocks = 300 kB is the traditional sacrifice to the Linux kernel.

Parameters
optsThe option set to be manipulated.
num_blocksNumber of extra 2 kB blocks to be written.
Returns
ISO_SUCCESS or error
Since
0.6.38

◆ iso_write_opts_set_untranslated_name_len()

int iso_write_opts_set_untranslated_name_len ( IsoWriteOpts * opts,
int len )

Caution: This option breaks any assumptions about names that are supported by ECMA-119 specifications.

Try to omit any translation which would make a file name compliant to the ECMA-119 rules. This includes and exceeds omit_version_numbers, max_37_char_filenames, no_force_dots bit0, allow_full_ascii. Further it prevents the conversion from local character set to ASCII. The maximum name length is given by this call. If a filename exceeds this length or cannot be recorded untranslated for other reasons, then image production is aborted with ISO_NAME_NEEDS_TRANSL. Currently the length limit is 96 characters, because an ECMA-119 directory record may at most have 254 bytes and up to 158 other bytes must fit into the record. Probably 96 more bytes can be made free for the name in future.

Parameters
optsThe option set to be manipulated.
len0 = disable this feature and perform name translation according to other settings. >0 = Omit any translation. Eventually abort image production if a name is longer than the given value. -1 = Like >0. Allow maximum possible length (currently 96)
Returns
>=0 success, <0 failure In case of >=0 the return value tells the effectively set len. E.g. 96 after using len == -1.
Since
1.0.0

◆ iso_write_opts_set_will_cancel()

int iso_write_opts_set_will_cancel ( IsoWriteOpts * opts,
int will_cancel )

Announce that only the image size is desired, that the struct burn_source which is set to consume the image output stream will stay inactive, and that the write thread will be cancelled anyway by the .cancel() method of the struct burn_source.

This avoids to create a write thread which would begin production of the image stream and would generate a MISHAP event when burn_source.cancel() gets into effect.

Parameters
optsThe option set to be manipulated.
will_cancel0= normal image generation 1= prepare for being canceled before image stream output is completed
Returns
1 success, < 0 error
Since
0.6.40

◆ iso_zisofs_ctrl_susp_z2()

int iso_zisofs_ctrl_susp_z2 ( int enable)

Enable or disable the production of "Z2" SUSP entries instead of "ZF" entries for zisofs2 compressed files.

"ZF" with zisofs2 causes unaware Linux kernels to complain like: isofs: Unknown ZF compression algorithm: PZ "Z2" is silently ignored by unaware Linux kernels.

Parameters
enable1 = produce "Z2" , 0 = only "ZF" , -1 = do not change
Returns
1 = enabled , 0 = not enabled
Since
1.5.4

◆ iso_zisofs_get_params()

int iso_zisofs_get_params ( struct iso_zisofs_ctrl * params,
int flag )

Get the current global parameters for zisofs filtering.

Parameters
paramsPointer to a caller provided structure which shall take the settings. The caller sets params->version to indicate which set of members shall be filled. I.e. params->version == 0 leaves all members after params->block_size_log2 untouched.
flagBitfield for control purposes, unused yet, submit 0
Returns
1 on success, <0 on error
Since
0.6.18

◆ iso_zisofs_get_refcounts()

int iso_zisofs_get_refcounts ( off_t * ziso_count,
off_t * osiz_count,
int flag )

Inquire the number of zisofs compression and uncompression filters which are in use.

Parameters
ziso_countWill return the number of currently installed compression filters.
osiz_countWill return the number of currently installed uncompression filters.
flagBitfield for control purposes, unused yet, submit 0
Returns
1 on success, <0 on error
Since
0.6.18

◆ iso_zisofs_set_params()

int iso_zisofs_set_params ( struct iso_zisofs_ctrl * params,
int flag )

Set the global parameters for zisofs filtering.

This is only allowed while no zisofs compression filters are installed. i.e. ziso_count returned by iso_zisofs_get_refcounts() has to be 0.

Parameters
paramsPointer to a structure with the intended settings. The caller sets params->version to indicate which set of members has been filled. I.e. params->version == 0 causes all members after params->block_size_log2 to be ignored.
flagBitfield for control purposes, unused yet, submit 0
Returns
1 on success, <0 on error
Since
0.6.18

Variable Documentation

◆ iso_fs_global_id

unsigned int iso_fs_global_id
extern

See IsoFilesystem->get_id() for info about this.

Since
0.6.2

◆ serial_id

ino_t serial_id
extern

Serial number to be used when you can't get a valid id for a Stream by other means.

If you use this, both fs_id and dev_id should be set to 0. This must be incremented each time you get a reference to it.

See also
IsoStreamIface->get_id()
Since
0.6.4

Generated for libisofs by  doxygen 1.10.0