libisofs
1.2.8
|
#include <sys/stat.h>
#include <stdlib.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. More... | |
#define | iso_lib_header_version_minor 2 |
#define | iso_lib_header_version_micro 8 |
#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 1 |
The minimum version of libjte to be used with this version of libisofs at compile time. More... | |
#define | iso_libjte_req_minor 0 |
#define | iso_libjte_req_micro 0 |
#define | LIBISO_MAX_LINK_DEPTH 100 |
#define | ISO_MSGS_MESSAGE_LEN 4096 |
#define | Libisofs_default_path_maX 4096 |
#define | ISO_SUCCESS 1 |
successfully execution More... | |
#define | ISO_NONE 0 |
special return value, it could be or not an error depending on the context. More... | |
#define | ISO_CANCELED 0xE830FFFF |
Operation canceled (FAILURE,HIGH, -1) More... | |
#define | ISO_FATAL_ERROR 0xF030FFFE |
Unknown or unexpected fatal error (FATAL,HIGH, -2) More... | |
#define | ISO_ERROR 0xE830FFFD |
Unknown or unexpected error (FAILURE,HIGH, -3) More... | |
#define | ISO_ASSERT_FAILURE 0xF030FFFC |
Internal programming error. More... | |
#define | ISO_NULL_POINTER 0xE830FFFB |
NULL pointer as value for an arg. More... | |
#define | ISO_OUT_OF_MEM 0xF030FFFA |
Memory allocation error (FATAL,HIGH, -6) More... | |
#define | ISO_INTERRUPTED 0xF030FFF9 |
Interrupted by a signal (FATAL,HIGH, -7) More... | |
#define | ISO_WRONG_ARG_VALUE 0xE830FFF8 |
Invalid parameter value (FAILURE,HIGH, -8) More... | |
#define | ISO_THREAD_ERROR 0xF030FFF7 |
Can't create a needed thread (FATAL,HIGH, -9) More... | |
#define | ISO_WRITE_ERROR 0xE830FFF6 |
Write error (FAILURE,HIGH, -10) More... | |
#define | ISO_BUF_READ_ERROR 0xE830FFF5 |
Buffer read error (FAILURE,HIGH, -11) More... | |
#define | ISO_NODE_ALREADY_ADDED 0xE830FFC0 |
Trying to add to a dir a node already added to a dir (FAILURE,HIGH, -64) More... | |
#define | ISO_NODE_NAME_NOT_UNIQUE 0xE830FFBF |
Node with same name already exists (FAILURE,HIGH, -65) More... | |
#define | ISO_NODE_NOT_ADDED_TO_DIR 0xE830FFBE |
Trying to remove a node that was not added to dir (FAILURE,HIGH, -65) More... | |
#define | ISO_NODE_DOESNT_EXIST 0xE830FFBD |
A requested node does not exist (FAILURE,HIGH, -66) More... | |
#define | ISO_IMAGE_ALREADY_BOOTABLE 0xE830FFBC |
Try to set the boot image of an already bootable image (FAILURE,HIGH, -67) More... | |
#define | ISO_BOOT_IMAGE_NOT_VALID 0xE830FFBB |
Trying to use an invalid file as boot image (FAILURE,HIGH, -68) More... | |
#define | ISO_BOOT_IMAGE_OVERFLOW 0xE830FFBA |
Too many boot images (FAILURE,HIGH, -69) More... | |
#define | ISO_BOOT_NO_CATALOG 0xE830FFB9 |
No boot catalog created yet ((FAILURE,HIGH, -70) More... | |
#define | ISO_FILE_ERROR 0xE830FF80 |
Error on file operation (FAILURE,HIGH, -128) (take a look at more specified error codes below) More... | |
#define | ISO_FILE_ALREADY_OPENED 0xE830FF7F |
Trying to open an already opened file (FAILURE,HIGH, -129) More... | |
#define | ISO_FILE_ALREADY_OPENNED 0xE830FF7F |
#define | ISO_FILE_ACCESS_DENIED 0xE830FF7E |
Access to file is not allowed (FAILURE,HIGH, -130) More... | |
#define | ISO_FILE_BAD_PATH 0xE830FF7D |
Incorrect path to file (FAILURE,HIGH, -131) More... | |
#define | ISO_FILE_DOESNT_EXIST 0xE830FF7C |
The file does not exist in the filesystem (FAILURE,HIGH, -132) More... | |
#define | ISO_FILE_NOT_OPENED 0xE830FF7B |
Trying to read or close a file not openned (FAILURE,HIGH, -133) More... | |
#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) More... | |
#define | ISO_FILE_READ_ERROR 0xE830FF79 |
Read error (FAILURE,HIGH, -135) More... | |
#define | ISO_FILE_IS_NOT_DIR 0xE830FF78 |
Not dir used where a dir is expected (FAILURE,HIGH, -136) More... | |
#define | ISO_FILE_IS_NOT_SYMLINK 0xE830FF77 |
Not symlink used where a symlink is expected (FAILURE,HIGH, -137) More... | |
#define | ISO_FILE_SEEK_ERROR 0xE830FF76 |
Can't seek to specified location (FAILURE,HIGH, -138) More... | |
#define | ISO_FILE_IGNORED 0xD020FF75 |
File not supported in ECMA-119 tree and thus ignored (WARNING,MEDIUM, -139) More... | |
#define | ISO_FILE_TOO_BIG 0xD020FF74 |
#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) More... | |
#define | ISO_FILE_OFFSET_TOO_BIG 0xE830FF6A |
Offset greater than file size (FAILURE,HIGH, -150) More... | |
#define | ISO_CHARSET_CONV_ERROR 0xE830FF00 |
Charset conversion error (FAILURE,HIGH, -256) More... | |
#define | ISO_MANGLE_TOO_MUCH_FILES 0xE830FEFF |
Too many files to mangle, i.e. More... | |
#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. More... | |
#define | ISO_WRONG_RR 0xE030FEBF |
Wrong or damaged RR entry (SORRY,HIGH, -321) More... | |
#define | ISO_UNSUPPORTED_RR 0xE030FEBE |
Unsupported RR feature (SORRY,HIGH, -322) More... | |
#define | ISO_WRONG_ECMA119 0xE830FEBD |
Wrong or damaged ECMA-119 (FAILURE,HIGH, -323) More... | |
#define | ISO_UNSUPPORTED_ECMA119 0xE830FEBC |
Unsupported ECMA-119 feature (FAILURE,HIGH, -324) More... | |
#define | ISO_WRONG_EL_TORITO 0xD030FEBB |
Wrong or damaged El-Torito catalog (WARN,HIGH, -325) More... | |
#define | ISO_UNSUPPORTED_EL_TORITO 0xD030FEBA |
Unsupported El-Torito feature (WARN,HIGH, -326) More... | |
#define | ISO_ISOLINUX_CANT_PATCH 0xE030FEB9 |
Can't patch an isolinux boot image (SORRY,HIGH, -327) More... | |
#define | ISO_UNSUPPORTED_SUSP 0xE030FEB8 |
Unsupported SUSP feature (SORRY,HIGH, -328) More... | |
#define | ISO_WRONG_RR_WARN 0xD030FEB7 |
Error on a RR entry that can be ignored (WARNING,HIGH, -329) More... | |
#define | ISO_SUSP_UNHANDLED 0xC020FEB6 |
Error on a RR entry that can be ignored (HINT,MEDIUM, -330) More... | |
#define | ISO_SUSP_MULTIPLE_ER 0xD030FEB5 |
Multiple ER SUSP entries found (WARNING,HIGH, -331) More... | |
#define | ISO_UNSUPPORTED_VD 0xC020FEB4 |
Unsupported volume descriptor found (HINT,MEDIUM, -332) More... | |
#define | ISO_EL_TORITO_WARN 0xD030FEB3 |
El-Torito related warning (WARNING,HIGH, -333) More... | |
#define | ISO_IMAGE_WRITE_CANCELED 0xE430FEB2 |
Image write cancelled (MISHAP,HIGH, -334) More... | |
#define | ISO_EL_TORITO_HIDDEN 0xD030FEB1 |
El-Torito image is hidden (WARNING,HIGH, -335) More... | |
#define | ISO_AAIP_IGNORED 0xB030FEB0 |
AAIP info with ACL or xattr in ISO image will be ignored (NOTE, HIGH, -336) More... | |
#define | ISO_AAIP_BAD_ACL 0xE830FEAF |
Error with decoding ACL from AAIP info (FAILURE, HIGH, -337) More... | |
#define | ISO_AAIP_BAD_ACL_TEXT 0xE830FEAE |
Error with encoding ACL for AAIP (FAILURE, HIGH, -338) More... | |
#define | ISO_AAIP_NOT_ENABLED 0xE830FEAD |
AAIP processing for ACL or xattr not enabled at compile time (FAILURE, HIGH, -339) More... | |
#define | ISO_AAIP_BAD_AASTRING 0xE830FEAC |
Error with decoding AAIP info for ACL or xattr (FAILURE, HIGH, -340) More... | |
#define | ISO_AAIP_NO_GET_LOCAL 0xE830FEAB |
Error with reading ACL or xattr from local file (FAILURE, HIGH, -341) More... | |
#define | ISO_AAIP_NO_SET_LOCAL 0xE830FEAA |
Error with attaching ACL or xattr to local file (FAILURE, HIGH, -342) More... | |
#define | ISO_AAIP_NON_USER_NAME 0xE830FEA9 |
Unallowed attempt to set an xattr with non-userspace name (FAILURE, HIGH, -343) More... | |
#define | ISO_EXTF_TOO_OFTEN 0xE830FEA8 |
Too many references on a single IsoExternalFilterCommand (FAILURE, HIGH, -344) More... | |
#define | ISO_ZLIB_NOT_ENABLED 0xE830FEA7 |
Use of zlib was not enabled at compile time (FAILURE, HIGH, -345) More... | |
#define | ISO_ZISOFS_TOO_LARGE 0xE830FEA6 |
Cannot apply zisofs filter to file >= 4 GiB (FAILURE, HIGH, -346) More... | |
#define | ISO_FILTER_WRONG_INPUT 0xE830FEA5 |
Filter input differs from previous run (FAILURE, HIGH, -347) More... | |
#define | ISO_ZLIB_COMPR_ERR 0xE830FEA4 |
zlib compression/decompression error (FAILURE, HIGH, -348) More... | |
#define | ISO_ZISOFS_WRONG_INPUT 0xE830FEA3 |
Input stream is not in zisofs format (FAILURE, HIGH, -349) More... | |
#define | ISO_ZISOFS_PARAM_LOCK 0xE830FEA2 |
Cannot set global zisofs parameters while filters exist (FAILURE, HIGH, -350) More... | |
#define | ISO_ZLIB_EARLY_EOF 0xE830FEA1 |
Premature EOF of zlib input stream (FAILURE, HIGH, -351) More... | |
#define | ISO_MD5_AREA_CORRUPTED 0xD030FEA0 |
Checksum area or checksum tag appear corrupted (WARNING,HIGH, -352) More... | |
#define | ISO_MD5_TAG_MISMATCH 0xE830FE9F |
Checksum mismatch between checksum tag and data blocks (FAILURE, HIGH, -353) More... | |
#define | ISO_SB_TREE_CORRUPTED 0xE830FE9E |
Checksum mismatch in System Area, Volume Descriptors, or directory tree. More... | |
#define | ISO_MD5_TAG_UNEXPECTED 0xD030FE9D |
Unexpected checksum tag type encountered. More... | |
#define | ISO_MD5_TAG_MISPLACED 0xD030FE9C |
Misplaced checksum tag encountered. More... | |
#define | ISO_MD5_TAG_OTHER_RANGE 0xD030FE9B |
Checksum tag with unexpected address range encountered. More... | |
#define | ISO_MD5_STREAM_CHANGE 0xE430FE9A |
Detected file content changes while it was written into the image. More... | |
#define | ISO_SCDBACKUP_TAG_NOT_0 0xD030FE99 |
Session does not start at LBA 0. More... | |
#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(). More... | |
#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. More... | |
#define | ISO_OVWRT_FIFO_TOO_SMALL 0xE830FE96 |
The ring buffer is smaller than 64 kB + partition offset. More... | |
#define | ISO_LIBJTE_NOT_ENABLED 0xE830FE95 |
Use of libjte was not enabled at compile time (FAILURE, HIGH, -363) More... | |
#define | ISO_LIBJTE_START_FAILED 0xE830FE94 |
Failed to start up Jigdo Template Extraction (FAILURE, HIGH, -364) More... | |
#define | ISO_LIBJTE_END_FAILED 0xE830FE93 |
Failed to finish Jigdo Template Extraction (FAILURE, HIGH, -365) More... | |
#define | ISO_LIBJTE_FILE_FAILED 0xE430FE92 |
Failed to process file for Jigdo Template Extraction (MISHAP, HIGH, -366) More... | |
#define | ISO_BOOT_TOO_MANY_MIPS 0xE830FE91 |
Too many MIPS Big Endian boot files given (max. More... | |
#define | ISO_BOOT_FILE_MISSING 0xE430FE90 |
Boot file missing in image (MISHAP, HIGH, -368) More... | |
#define | ISO_BAD_PARTITION_NO 0xE830FE8F |
Partition number out of range (FAILURE, HIGH, -369) More... | |
#define | ISO_BAD_PARTITION_FILE 0xE830FE8E |
Cannot open data file for appended partition (FAILURE, HIGH, -370) More... | |
#define | ISO_NON_MBR_SYS_AREA 0xE830FE8D |
May not combine MBR partition with non-MBR system area (FAILURE, HIGH, -371) More... | |
#define | ISO_DISPLACE_ROLLOVER 0xE830FE8C |
Displacement offset leads outside 32 bit range (FAILURE, HIGH, -372) More... | |
#define | ISO_NAME_NEEDS_TRANSL 0xE830FE8B |
File name cannot be written into ECMA-119 untranslated (FAILURE, HIGH, -373) More... | |
#define | ISO_STREAM_NO_CLONE 0xE830FE8A |
Data file input stream object offers no cloning method (FAILURE, HIGH, -374) More... | |
#define | ISO_XINFO_NO_CLONE 0xE830FE89 |
Extended information class offers no cloning method (FAILURE, HIGH, -375) More... | |
#define | ISO_MD5_TAG_COPIED 0xD030FE88 |
Found copied superblock checksum tag (WARNING, HIGH, -376) More... | |
#define | ISO_RR_NAME_TOO_LONG 0xE830FE87 |
Rock Ridge leaf name too long (FAILURE, HIGH, -377) More... | |
#define | ISO_RR_NAME_RESERVED 0xE830FE86 |
Reserved Rock Ridge leaf name (FAILURE, HIGH, -378) More... | |
#define | ISO_RR_PATH_TOO_LONG 0xE830FE85 |
Rock Ridge path too long (FAILURE, HIGH, -379) More... | |
#define | ISO_AAIP_BAD_ATTR_NAME 0xE830FE84 |
Attribute name cannot be represented (FAILURE, HIGH, -380) More... | |
#define | ISO_AAIP_ACL_MULT_OBJ 0xE830FE83 |
ACL text contains multiple entries of user::, group::, other:: (FAILURE, HIGH, -381) More... | |
#define | ISO_SECT_SCATTERED 0xE830FE82 |
File sections do not form consecutive array of blocks (FAILURE, HIGH, -382) More... | |
#define | ISO_BOOT_TOO_MANY_APM 0xE830FE81 |
Too many Apple Partition Map entries requested (FAILURE, HIGH, -383) More... | |
#define | ISO_BOOT_APM_OVERLAP 0xE830FE80 |
Overlapping Apple Partition Map entries requested (FAILURE, HIGH, -384) More... | |
#define | ISO_BOOT_TOO_MANY_GPT 0xE830FE7F |
Too many GPT entries requested (FAILURE, HIGH, -385) More... | |
#define | ISO_BOOT_GPT_OVERLAP 0xE830FE7E |
Overlapping GPT entries requested (FAILURE, HIGH, -386) More... | |
#define | ISO_BOOT_TOO_MANY_MBR 0xE830FE7D |
Too many MBR partition entries requested (FAILURE, HIGH, -387) More... | |
#define | ISO_BOOT_MBR_OVERLAP 0xE830FE7C |
Overlapping MBR partition entries requested (FAILURE, HIGH, -388) More... | |
#define | ISO_BOOT_MBR_COLLISION 0xE830FE7B |
Attempt to use an MBR partition entry twice (FAILURE, HIGH, -389) More... | |
#define | ISO_BOOT_NO_EFI_ELTO 0xE830FE7A |
No suitable El Torito EFI boot image for exposure as GPT partition (FAILURE, HIGH, -390) More... | |
#define | ISO_BOOT_HFSP_BAD_BSIZE 0xE830FE79 |
Not a supported HFS+ or APM block size (FAILURE, HIGH, -391) More... | |
#define | ISO_BOOT_APM_GPT_BSIZE 0xE830FE78 |
APM block size prevents coexistence with GPT (FAILURE, HIGH, -392) More... | |
#define | ISO_HFSP_NO_MANGLE 0xE830FE77 |
Name collision in HFS+, mangling not possible (FAILURE, HIGH, -393) More... | |
#define | ISO_DEAD_SYMLINK 0xE830FE76 |
Symbolic link cannot be resolved (FAILURE, HIGH, -394) More... | |
#define | ISO_DEEP_SYMLINK 0xE830FE75 |
Too many chained symbolic links (FAILURE, HIGH, -395) More... | |
#define | ISO_BAD_ISO_FILETYPE 0xE830FE74 |
Unrecognized file type in ISO image (FAILURE, HIGH, -396) More... | |
#define | ISO_DATA_SOURCE_SORRY 0xE030FCFF |
Read error occured with IsoDataSource (SORRY,HIGH, -513) More... | |
#define | ISO_DATA_SOURCE_MISHAP 0xE430FCFF |
Read error occured with IsoDataSource (MISHAP,HIGH, -513) More... | |
#define | ISO_DATA_SOURCE_FAILURE 0xE830FCFF |
Read error occured with IsoDataSource (FAILURE,HIGH, -513) More... | |
#define | ISO_DATA_SOURCE_FATAL 0xF030FCFF |
Read error occured with IsoDataSource (FATAL,HIGH, -513) More... | |
Typedefs | |
typedef struct Iso_Image | IsoImage |
Context for image creation. More... | |
typedef struct Iso_Node | IsoNode |
typedef struct Iso_Dir | IsoDir |
A directory in the iso tree. More... | |
typedef struct Iso_Symlink | IsoSymlink |
A symbolic link in the iso tree. More... | |
typedef struct Iso_File | IsoFile |
A regular file in the iso tree. More... | |
typedef struct Iso_Special | IsoSpecial |
An special file in the iso tree. More... | |
typedef struct Iso_Dir_Iter | IsoDirIter |
Context for iterate on directory children. More... | |
typedef struct el_torito_boot_image | ElToritoBootImage |
It represents an El-Torito boot image. More... | |
typedef struct Iso_Boot | IsoBoot |
An special type of IsoNode that acts as a placeholder for an El-Torito boot catalog. More... | |
typedef struct iso_write_opts | IsoWriteOpts |
Options for image written. More... | |
typedef struct iso_read_opts | IsoReadOpts |
Options for image reading or import. More... | |
typedef struct iso_data_source | IsoDataSource |
Source for image reading. More... | |
typedef struct iso_read_image_features | IsoReadImageFeatures |
Return information for image. More... | |
typedef struct iso_file_source | IsoFileSource |
POSIX abstraction for source files. More... | |
typedef struct iso_filesystem | IsoFilesystem |
Abstract for source filesystems. More... | |
typedef struct IsoFileSource_Iface | IsoFileSourceIface |
Interface that defines the operations (methods) available for an IsoFileSource. More... | |
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... More... | |
typedef struct iso_stream | IsoStream |
Representation of file contents. More... | |
typedef struct IsoStream_Iface | IsoStreamIface |
Interface that defines the operations (methods) available for an IsoStream. More... | |
typedef int(* | iso_node_xinfo_func )(void *data, int flag) |
Class of functions to handle particular extended information. More... | |
typedef int(* | iso_node_xinfo_cloner )(void *old_data, void **new_data, int flag) |
Class of functions to clone extended information. More... | |
typedef struct iso_find_condition | IsoFindCondition |
typedef struct iso_external_filter_command | IsoExternalFilterCommand |
Functions | |
void | iso_lib_version (int *major, int *minor, int *micro) |
Get version of the libisofs library at runtime. More... | |
int | iso_lib_is_compatible (int major, int minor, int micro) |
Check at runtime if the library is ABI compatible with the given version. More... | |
int | iso_init () |
Initialize libisofs. More... | |
int | iso_init_with_flag (int flag) |
Initialize libisofs. More... | |
void | iso_finish () |
Finalize libisofs. More... | |
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. More... | |
char * | iso_get_local_charset (int flag) |
Obtain the local charset as currently assumed by libisofs. More... | |
int | iso_image_new (const char *name, IsoImage **image) |
Create a new image, empty. More... | |
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. More... | |
int | iso_write_opts_new (IsoWriteOpts **opts, int profile) |
Creates an IsoWriteOpts for writing an image. More... | |
void | iso_write_opts_free (IsoWriteOpts *opts) |
Free an IsoWriteOpts previously allocated with iso_write_opts_new(). More... | |
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. More... | |
int | iso_write_opts_set_iso_level (IsoWriteOpts *opts, int level) |
Set the ISO-9960 level to write at. More... | |
int | iso_write_opts_set_rockridge (IsoWriteOpts *opts, int enable) |
Whether to use or not Rock Ridge extensions. More... | |
int | iso_write_opts_set_joliet (IsoWriteOpts *opts, int enable) |
Whether to add the non-standard Joliet extension to the image. More... | |
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. More... | |
int | iso_write_opts_set_fat (IsoWriteOpts *opts, int enable) |
More... | |
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. More... | |
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+. More... | |
int | iso_write_opts_set_iso1999 (IsoWriteOpts *opts, int enable) |
Whether to use newer ISO-9660:1999 version. More... | |
int | iso_write_opts_set_hardlinks (IsoWriteOpts *opts, int enable) |
Control generation of non-unique inode numbers for the emerging image. More... | |
int | iso_write_opts_set_aaip (IsoWriteOpts *opts, int enable) |
Control writing of AAIP informations for ACL and xattr. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
int | iso_write_opts_set_allow_deep_paths (IsoWriteOpts *opts, int allow) |
Allow ISO-9660 directory hierarchy to be deeper than 8 levels. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
int | iso_write_opts_set_allow_lowercase (IsoWriteOpts *opts, int allow) |
Allow lowercase characters in ISO-9660 filenames. More... | |
int | iso_write_opts_set_allow_full_ascii (IsoWriteOpts *opts, int allow) |
Allow all 8-bit characters to appear on an ISO-9660 filename. More... | |
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. More... | |
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. More... | |
int | iso_write_opts_set_joliet_longer_paths (IsoWriteOpts *opts, int allow) |
Allow paths in the Joliet tree to have more than 240 characters. More... | |
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. More... | |
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. More... | |
int | iso_write_opts_set_rrip_1_10_px_ino (IsoWriteOpts *opts, int enable) |
Write field PX with file serial number (i.e. More... | |
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. More... | |
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. More... | |
int | iso_write_opts_set_sort_files (IsoWriteOpts *opts, int sort) |
Whether to sort files based on their weight. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
int | iso_write_opts_set_always_gmt (IsoWriteOpts *opts, int gmt) |
Whether to always record timestamps in GMT. More... | |
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. More... | |
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. More... | |
int | iso_write_opts_set_ms_block (IsoWriteOpts *opts, uint32_t ms_block) |
Set the start block of the image. More... | |
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 overwriteable media to point to the newly written image. More... | |
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. More... | |
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. More... | |
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) |
Explicitely 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. More... | |
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 upcomming write run. More... | |
int | iso_write_opts_detach_jte (IsoWriteOpts *opts, void **libjte_handle) |
Remove eventual association to a libjte environment handle. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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(). More... | |
int | iso_image_update_sizes (IsoImage *image) |
Update the sizes of all files added to image. More... | |
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. More... | |
int | iso_image_generator_is_running (IsoImage *image) |
Inquire whether the image generator thread is still at work. More... | |
int | iso_read_opts_new (IsoReadOpts **opts, int profile) |
Creates an IsoReadOpts for reading an existent image. More... | |
void | iso_read_opts_free (IsoReadOpts *opts) |
Free an IsoReadOpts previously allocated with iso_read_opts_new(). More... | |
int | iso_read_opts_set_start_block (IsoReadOpts *opts, uint32_t block) |
Set the block where the image begins. More... | |
int | iso_read_opts_set_no_rockridge (IsoReadOpts *opts, int norr) |
Do not read Rock Ridge extensions. More... | |
int | iso_read_opts_set_no_joliet (IsoReadOpts *opts, int nojoliet) |
Do not read Joliet extensions. More... | |
int | iso_read_opts_set_no_iso1999 (IsoReadOpts *opts, int noiso1999) |
Do not read ISO 9660:1999 enhanced tree. More... | |
int | iso_read_opts_set_no_aaip (IsoReadOpts *opts, int noaaip) |
Control reading of AAIP informations about ACL and xattr when loading existing images. More... | |
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. More... | |
int | iso_read_opts_set_new_inos (IsoReadOpts *opts, int new_inos) |
Control discarding of eventual inode numbers from existing images. More... | |
int | iso_read_opts_set_preferjoliet (IsoReadOpts *opts, int preferjoliet) |
Whether to prefer Joliet over RR. More... | |
int | iso_read_opts_set_default_uid (IsoReadOpts *opts, uid_t uid) |
Set default uid for files when RR extensions are not present. More... | |
int | iso_read_opts_set_default_gid (IsoReadOpts *opts, gid_t gid) |
Set default gid for files when RR extensions are not present. More... | |
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. More... | |
int | iso_read_opts_set_input_charset (IsoReadOpts *opts, const char *charset) |
Set the input charset of the file names on the image. More... | |
int | iso_read_opts_auto_input_charset (IsoReadOpts *opts, int mode) |
Enable or disable methods to automatically choose an input charset. More... | |
int | iso_read_opts_load_system_area (IsoReadOpts *opts, int mode) |
Enable or disable loading of the first 32768 bytes of the session. More... | |
int | iso_image_import (IsoImage *image, IsoDataSource *src, IsoReadOpts *opts, IsoReadImageFeatures **features) |
Import a previous session or image, for growing or modify. More... | |
void | iso_read_image_features_destroy (IsoReadImageFeatures *f) |
Destroy an IsoReadImageFeatures object obtained with iso_image_import. More... | |
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. More... | |
int | iso_read_image_features_has_rockridge (IsoReadImageFeatures *f) |
Whether RockRidge extensions are present in the image imported. More... | |
int | iso_read_image_features_has_joliet (IsoReadImageFeatures *f) |
Whether Joliet extensions are present in the image imported. More... | |
int | iso_read_image_features_has_iso1999 (IsoReadImageFeatures *f) |
Whether the image is recorded according to ISO 9660:1999, i.e. More... | |
int | iso_read_image_features_has_eltorito (IsoReadImageFeatures *f) |
Whether El-Torito boot record is present present in the image imported. More... | |
void | iso_image_ref (IsoImage *image) |
Increments the reference counting of the given image. More... | |
void | iso_image_unref (IsoImage *image) |
Decrements the reference couting of the given image. More... | |
int | iso_image_attach_data (IsoImage *image, void *data, void(*give_up)(void *)) |
Attach user defined data to the image. More... | |
void * | iso_image_get_attached_data (IsoImage *image) |
The the data previously attached with iso_image_attach_data() More... | |
IsoDir * | iso_image_get_root (const IsoImage *image) |
Get the root directory of the image. More... | |
void | iso_image_set_volset_id (IsoImage *image, const char *volset_id) |
Fill in the volset identifier for a image. More... | |
const char * | iso_image_get_volset_id (const IsoImage *image) |
Get the volset identifier. More... | |
void | iso_image_set_volume_id (IsoImage *image, const char *volume_id) |
Fill in the volume identifier for a image. More... | |
const char * | iso_image_get_volume_id (const IsoImage *image) |
Get the volume identifier. More... | |
void | iso_image_set_publisher_id (IsoImage *image, const char *publisher_id) |
Fill in the publisher for a image. More... | |
const char * | iso_image_get_publisher_id (const IsoImage *image) |
Get the publisher of a image. More... | |
void | iso_image_set_data_preparer_id (IsoImage *image, const char *data_preparer_id) |
Fill in the data preparer for a image. More... | |
const char * | iso_image_get_data_preparer_id (const IsoImage *image) |
Get the data preparer of a image. More... | |
void | iso_image_set_system_id (IsoImage *image, const char *system_id) |
Fill in the system id for a image. More... | |
const char * | iso_image_get_system_id (const IsoImage *image) |
Get the system id of a image. More... | |
void | iso_image_set_application_id (IsoImage *image, const char *application_id) |
Fill in the application id for a image. More... | |
const char * | iso_image_get_application_id (const IsoImage *image) |
Get the application id of a image. More... | |
void | iso_image_set_copyright_file_id (IsoImage *image, const char *copyright_file_id) |
Fill copyright information for the image. More... | |
const char * | iso_image_get_copyright_file_id (const IsoImage *image) |
Get the copyright information of a image. More... | |
void | iso_image_set_abstract_file_id (IsoImage *image, const char *abstract_file_id) |
Fill abstract information for the image. More... | |
const char * | iso_image_get_abstract_file_id (const IsoImage *image) |
Get the abstract information of a image. More... | |
void | iso_image_set_biblio_file_id (IsoImage *image, const char *biblio_file_id) |
Fill biblio information for the image. More... | |
const char * | iso_image_get_biblio_file_id (const IsoImage *image) |
Get the biblio information of a image. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
void | iso_image_remove_boot_image (IsoImage *image) |
Removes all El-Torito boot images from the ISO image. More... | |
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. More... | |
int | iso_image_set_boot_catalog_hidden (IsoImage *image, int hide_attrs) |
Hides the boot catalog file from directory trees. More... | |
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() resp. More... | |
int | el_torito_set_boot_platform_id (ElToritoBootImage *bootimg, uint8_t id) |
Sets the platform ID of the boot image. More... | |
int | el_torito_get_boot_platform_id (ElToritoBootImage *bootimg) |
Get the platform ID value. More... | |
void | el_torito_set_load_seg (ElToritoBootImage *bootimg, short segment) |
Sets the load segment for the initial boot image. More... | |
int | el_torito_get_load_seg (ElToritoBootImage *bootimg) |
Get the load segment value. More... | |
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. More... | |
int | el_torito_get_load_size (ElToritoBootImage *bootimg) |
Get the load size. More... | |
void | el_torito_set_no_bootable (ElToritoBootImage *bootimg) |
Marks the specified boot image as not bootable. More... | |
int | el_torito_get_bootable (ElToritoBootImage *bootimg) |
Get the bootability flag. More... | |
int | el_torito_set_id_string (ElToritoBootImage *bootimg, uint8_t id_string[28]) |
Set the id_string of the Validation Entry resp. More... | |
int | el_torito_get_id_string (ElToritoBootImage *bootimg, uint8_t id_string[28]) |
Get the id_string as of el_torito_set_id_string(). More... | |
int | el_torito_set_selection_crit (ElToritoBootImage *bootimg, uint8_t crit[20]) |
Set the Selection Criteria of a boot image. More... | |
int | el_torito_get_selection_crit (ElToritoBootImage *bootimg, uint8_t crit[20]) |
Get the Selection Criteria bytes as of el_torito_set_selection_crit(). More... | |
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. More... | |
int | el_torito_set_isolinux_options (ElToritoBootImage *bootimg, int options, int flag) |
Specifies options for ISOLINUX or GRUB boot images. More... | |
int | el_torito_get_isolinux_options (ElToritoBootImage *bootimg, int flag) |
Get the options as of el_torito_set_isolinux_options(). More... | |
void | el_torito_patch_isolinux_image (ElToritoBootImage *bootimg) |
Deprecated: Specifies that this image needs to be patched. More... | |
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. More... | |
int | iso_image_add_mips_boot_file (IsoImage *image, char *path, int flag) |
Add a MIPS boot file path to the image. More... | |
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. More... | |
int | iso_image_give_up_mips_boot (IsoImage *image, int flag) |
Clear the list of MIPS Big Endian boot file paths. More... | |
void | iso_node_ref (IsoNode *node) |
Increments the reference counting of the given node. More... | |
void | iso_node_unref (IsoNode *node) |
Decrements the reference couting of the given node. More... | |
enum IsoNodeType | iso_node_get_type (IsoNode *node) |
Get the type of an IsoNode. More... | |
int | iso_node_add_xinfo (IsoNode *node, iso_node_xinfo_func proc, void *data) |
Add extended information to the given node. More... | |
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. More... | |
int | iso_node_remove_all_xinfo (IsoNode *node, int flag) |
Remove all extended information from the given node. More... | |
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. More... | |
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 informations. More... | |
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. More... | |
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. More... | |
int | iso_node_set_name (IsoNode *node, const char *name) |
Set the name of a node. More... | |
const char * | iso_node_get_name (const IsoNode *node) |
Get the name of a node. More... | |
void | iso_node_set_permissions (IsoNode *node, mode_t mode) |
Set the permissions for the node. More... | |
mode_t | iso_node_get_permissions (const IsoNode *node) |
Get the permissions for the node. More... | |
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'. More... | |
void | iso_node_set_uid (IsoNode *node, uid_t uid) |
Set the user id for the node. More... | |
uid_t | iso_node_get_uid (const IsoNode *node) |
Get the user id of the node. More... | |
void | iso_node_set_gid (IsoNode *node, gid_t gid) |
Set the group id for the node. More... | |
gid_t | iso_node_get_gid (const IsoNode *node) |
Get the group id of the node. More... | |
void | iso_node_set_mtime (IsoNode *node, time_t time) |
Set the time of last modification of the file. More... | |
time_t | iso_node_get_mtime (const IsoNode *node) |
Get the time of last modification of the file. More... | |
void | iso_node_set_atime (IsoNode *node, time_t time) |
Set the time of last access to the file. More... | |
time_t | iso_node_get_atime (const IsoNode *node) |
Get the time of last access to the file. More... | |
void | iso_node_set_ctime (IsoNode *node, time_t time) |
Set the time of last status change of the file. More... | |
time_t | iso_node_get_ctime (const IsoNode *node) |
Get the time of last status change of the file. More... | |
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). More... | |
int | iso_node_get_hidden (IsoNode *node) |
Get the hide_attrs as eventually set by iso_node_set_hidden(). More... | |
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. More... | |
int | iso_dir_add_node (IsoDir *dir, IsoNode *child, enum iso_replace_mode replace) |
Add a new node to a dir. More... | |
int | iso_dir_get_node (IsoDir *dir, const char *name, IsoNode **node) |
Locate a node inside a given dir. More... | |
int | iso_dir_get_children_count (IsoDir *dir) |
Get the number of children of a directory. More... | |
int | iso_node_take (IsoNode *node) |
Removes a child from a directory. More... | |
int | iso_node_remove (IsoNode *node) |
Removes a child from a directory and free (unref) it. More... | |
IsoDir * | iso_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. More... | |
int | iso_dir_iter_next (IsoDirIter *iter, IsoNode **node) |
Get the next child. More... | |
int | iso_dir_iter_has_next (IsoDirIter *iter) |
Check if there're more children. More... | |
void | iso_dir_iter_free (IsoDirIter *iter) |
Free a dir iterator. More... | |
int | iso_dir_iter_take (IsoDirIter *iter) |
Removes a child from a directory during an iteration, without freeing it. More... | |
int | iso_dir_iter_remove (IsoDirIter *iter) |
Removes a child from a directory during an iteration and unref() it. More... | |
int | iso_node_remove_tree (IsoNode *node, IsoDirIter *boss_iter) |
Removes a node by iso_node_remove() or iso_dir_iter_remove(). More... | |
IsoFindCondition * | iso_new_find_conditions_name (const char *wildcard) |
Create a new condition that checks if the node name matches the given wildcard. More... | |
IsoFindCondition * | iso_new_find_conditions_mode (mode_t mask) |
Create a new condition that checks the node mode against a mode mask. More... | |
IsoFindCondition * | iso_new_find_conditions_gid (gid_t gid) |
Create a new condition that checks the node gid. More... | |
IsoFindCondition * | iso_new_find_conditions_uid (uid_t uid) |
Create a new condition that checks the node uid. More... | |
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. More... | |
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. More... | |
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. More... | |
IsoFindCondition * | iso_new_find_conditions_and (IsoFindCondition *a, IsoFindCondition *b) |
Create a new condition that check if the two given conditions are valid. More... | |
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. More... | |
IsoFindCondition * | iso_new_find_conditions_not (IsoFindCondition *negate) |
Create a new condition that check if the given conditions is false. More... | |
int | iso_dir_find_children (IsoDir *dir, IsoFindCondition *cond, IsoDirIter **iter) |
Find all directory children that match the given condition. More... | |
const char * | iso_symlink_get_dest (const IsoSymlink *link) |
Get the destination of a node. More... | |
int | iso_symlink_set_dest (IsoSymlink *link, const char *dest) |
Set the destination of a link. More... | |
void | iso_node_set_sort_weight (IsoNode *node, int w) |
Sets the order in which a node will be written on image. More... | |
int | iso_file_get_sort_weight (IsoFile *file) |
Get the sort weight of a file. More... | |
off_t | iso_file_get_size (IsoFile *file) |
Get the size of the file, in bytes. More... | |
dev_t | iso_special_get_dev (IsoSpecial *special) |
Get the device id (major/minor numbers) of the given block or character device file. More... | |
IsoStream * | iso_file_get_stream (IsoFile *file) |
Get the IsoStream that represents the contents of the given IsoFile. More... | |
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. More... | |
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. More... | |
int | iso_node_get_old_image_lba (IsoNode *node, uint32_t *lba, int flag) |
int | iso_tree_add_new_dir (IsoDir *parent, const char *name, IsoDir **dir) |
Add a new directory to the iso tree. More... | |
int | iso_tree_add_new_file (IsoDir *parent, const char *name, IsoStream *stream, IsoFile **file) |
Add a new regular file to the iso tree. More... | |
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. More... | |
int | iso_tree_add_new_symlink (IsoDir *parent, const char *name, const char *dest, IsoSymlink **link) |
Add a new symlink to the directory tree. More... | |
int | iso_tree_add_new_special (IsoDir *parent, const char *name, mode_t mode, dev_t dev, IsoSpecial **special) |
Add a new special file to the directory tree. More... | |
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. More... | |
int | iso_tree_get_follow_symlinks (IsoImage *image) |
Get current setting for follow_symlinks. More... | |
void | iso_tree_set_ignore_hidden (IsoImage *image, int skip) |
Set whether to skip or not disk files with names beginning by '. More... | |
int | iso_tree_get_ignore_hidden (IsoImage *image) |
Get current setting for ignore_hidden. More... | |
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. More... | |
enum iso_replace_mode | iso_tree_get_replace_mode (IsoImage *image) |
Get current setting for replace_mode. More... | |
void | iso_tree_set_ignore_special (IsoImage *image, int skip) |
Set whether to skip or not special files. More... | |
int | iso_tree_get_ignore_special (IsoImage *image) |
Get current setting for ignore_special. More... | |
int | iso_tree_add_exclude (IsoImage *image, const char *path) |
Add a excluded path. More... | |
int | iso_tree_remove_exclude (IsoImage *image, const char *path) |
Remove a previously added exclude. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
int | iso_tree_clone (IsoNode *node, IsoDir *new_parent, char *new_name, IsoNode **new_node, int flag) |
Create a copy of the given node under a different path. More... | |
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. More... | |
int | iso_tree_path_to_node (IsoImage *image, const char *path, IsoNode **node) |
Locate a node by its absolute path on image. More... | |
char * | iso_tree_get_node_path (IsoNode *node) |
Get the absolute path on image of the given node. More... | |
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. More... | |
void | iso_data_source_ref (IsoDataSource *src) |
Increments the reference counting of the given IsoDataSource. More... | |
void | iso_data_source_unref (IsoDataSource *src) |
Decrements the reference counting of the given IsoDataSource, freeing it if refcount reach 0. More... | |
int | iso_data_source_new_from_file (const char *path, IsoDataSource **src) |
Create a new IsoDataSource from a local file. More... | |
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. More... | |
int | iso_set_msgs_severities (char *queue_severity, char *print_severity, char *print_id) |
Control queueing and stderr printing of messages from libisofs. More... | |
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. More... | |
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. More... | |
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. More... | |
int | iso_sev_to_text (int severity_number, char **severity_name) |
Convert a severity number into a severity name. More... | |
int | iso_image_get_msg_id (IsoImage *image) |
Get the id of an IsoImage, used for message reporting. More... | |
const char * | iso_error_to_msg (int errcode) |
Get a textual description of a libisofs error. More... | |
int | iso_error_get_severity (int e) |
Get the severity of a given error code. More... | |
int | iso_error_get_priority (int e) |
Get the priority of a given error. More... | |
int | iso_error_get_code (int e) |
Get the message queue code of a libisofs error. More... | |
int | iso_set_abort_severity (char *severity) |
Set the minimum error severity that causes a libisofs operation to be aborted as soon as possible. More... | |
void * | iso_get_messenger () |
Return the messenger object handle used by libisofs. More... | |
void | iso_file_source_ref (IsoFileSource *src) |
Take a ref to the given IsoFileSource. More... | |
void | iso_file_source_unref (IsoFileSource *src) |
Drop your ref to the given IsoFileSource, eventually freeing the associated system resources. More... | |
char * | iso_file_source_get_path (IsoFileSource *src) |
Get the absolute path in the filesystem this file source belongs to. More... | |
char * | iso_file_source_get_name (IsoFileSource *src) |
Get the name of the file, with the dir component of the path. More... | |
int | iso_file_source_lstat (IsoFileSource *src, struct stat *info) |
Get information about the file. More... | |
int | iso_file_source_access (IsoFileSource *src) |
Check if the process has access to read file contents. More... | |
int | iso_file_source_stat (IsoFileSource *src, struct stat *info) |
Get information about the file. More... | |
int | iso_file_source_open (IsoFileSource *src) |
Opens the source. More... | |
int | iso_file_source_close (IsoFileSource *src) |
Close a previuously openned file. More... | |
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. More... | |
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. More... | |
int | iso_file_source_readdir (IsoFileSource *src, IsoFileSource **child) |
Read a directory. More... | |
int | iso_file_source_readlink (IsoFileSource *src, char *buf, size_t bufsiz) |
Read the destination of a symlink. More... | |
int | iso_file_source_get_aa_string (IsoFileSource *src, unsigned char **aa_string, int flag) |
Get the AAIP string with encoded ACL and xattr. More... | |
IsoFilesystem * | iso_file_source_get_filesystem (IsoFileSource *src) |
Get the filesystem for this source. More... | |
void | iso_filesystem_ref (IsoFilesystem *fs) |
Take a ref to the given IsoFilesystem. More... | |
void | iso_filesystem_unref (IsoFilesystem *fs) |
Drop your ref to the given IsoFilesystem, evetually freeing associated resources. More... | |
int | iso_image_filesystem_new (IsoDataSource *src, IsoReadOpts *opts, int msgid, IsoImageFilesystem **fs) |
Create a new IsoFilesystem to access a existent ISO image. More... | |
const char * | iso_image_fs_get_volset_id (IsoImageFilesystem *fs) |
Get the volset identifier for an existent image. More... | |
const char * | iso_image_fs_get_volume_id (IsoImageFilesystem *fs) |
Get the volume identifier for an existent image. More... | |
const char * | iso_image_fs_get_publisher_id (IsoImageFilesystem *fs) |
Get the publisher identifier for an existent image. More... | |
const char * | iso_image_fs_get_data_preparer_id (IsoImageFilesystem *fs) |
Get the data preparer identifier for an existent image. More... | |
const char * | iso_image_fs_get_system_id (IsoImageFilesystem *fs) |
Get the system identifier for an existent image. More... | |
const char * | iso_image_fs_get_application_id (IsoImageFilesystem *fs) |
Get the application identifier for an existent image. More... | |
const char * | iso_image_fs_get_copyright_file_id (IsoImageFilesystem *fs) |
Get the copyright file identifier for an existent image. More... | |
const char * | iso_image_fs_get_abstract_file_id (IsoImageFilesystem *fs) |
Get the abstract file identifier for an existent image. More... | |
const char * | iso_image_fs_get_biblio_file_id (IsoImageFilesystem *fs) |
Get the biblio file identifier for an existent image. More... | |
void | iso_stream_ref (IsoStream *stream) |
Increment reference count of an IsoStream. More... | |
void | iso_stream_unref (IsoStream *stream) |
Decrement reference count of an IsoStream, and eventually free it if refcount reach 0. More... | |
int | iso_stream_open (IsoStream *stream) |
Opens the given stream. More... | |
int | iso_stream_close (IsoStream *stream) |
Close a previously openned IsoStream. More... | |
off_t | iso_stream_get_size (IsoStream *stream) |
Get the size of a given stream. More... | |
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. More... | |
int | iso_stream_is_repeatable (IsoStream *stream) |
Whether the given IsoStream can be read several times, with the same results. More... | |
int | iso_stream_update_size (IsoStream *stream) |
Updates the size of the IsoStream with the current size of the underlying source. More... | |
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. More... | |
char * | iso_stream_get_source_path (IsoStream *stream, int flag) |
Try to get eventual source path string of a stream. More... | |
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. More... | |
int | iso_stream_clone (IsoStream *old_stream, IsoStream **new_stream, int flag) |
Produce a copy of a stream. More... | |
int | aaip_xinfo_func (void *data, int flag) |
Function to identify and manage AAIP strings as xinfo of IsoNode. More... | |
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() resp. More... | |
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. More... | |
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. More... | |
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::". More... | |
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. More... | |
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. More... | |
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. More... | |
int | iso_local_attr_support (int flag) |
libisofs has an internal system dependent adapter to ACL and xattr operations. More... | |
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. More... | |
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. More... | |
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::". More... | |
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. More... | |
int | iso_local_set_attrs (char *disk_path, size_t num_attrs, char **names, size_t *value_lengths, char **values, int flag) |
Attach a list of xattr and ACLs to the given file in the local filesystem. More... | |
int | iso_file_remove_filter (IsoFile *file, int flag) |
Delete the top filter stream from a data file. More... | |
IsoStream * | iso_stream_get_input_stream (IsoStream *stream, int flag) |
Obtain the eventual input stream of a filter stream. More... | |
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. More... | |
int | iso_stream_get_external_filter (IsoStream *stream, IsoExternalFilterCommand **cmd, int flag) |
Obtain the IsoExternalFilterCommand which is eventually associated with the given stream. More... | |
int | iso_file_add_zisofs_filter (IsoFile *file, int flag) |
Install a zisofs filter on top of the content stream of a data file. More... | |
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. More... | |
int | iso_zisofs_set_params (struct iso_zisofs_ctrl *params, int flag) |
Set the global parameters for zisofs filtering. More... | |
int | iso_zisofs_get_params (struct iso_zisofs_ctrl *params, int flag) |
Get the current global parameters for zisofs filtering. More... | |
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. More... | |
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. More... | |
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. More... | |
int | iso_image_get_session_md5 (IsoImage *image, uint32_t *start_lba, uint32_t *end_lba, char md5[16], int flag) |
Eventually obtain the recorded MD5 checksum of the session which was loaded as ISO image. More... | |
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. More... | |
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. More... | |
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. More... | |
int | iso_md5_start (void **md5_context) |
Create a MD5 computation context and hand out an opaque handle. More... | |
int | iso_md5_compute (void *md5_context, char *data, int datalen) |
Advance the computation of a MD5 checksum by a chunk of data bytes. More... | |
int | iso_md5_clone (void *old_md5_context, void **new_md5_context) |
Create a MD5 computation context as clone of an existing one. More... | |
int | iso_md5_end (void **md5_context, char result[16]) |
Obtain the MD5 checksum from a MD5 computation context and dispose this context. More... | |
int | iso_md5_match (char first_md5[16], char second_md5[16]) |
Inquire whether two MD5 checksums match. More... | |
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. More... | |
struct iso_hfsplus_xinfo_data * | iso_hfsplus_xinfo_new (int flag) |
Create an instance of struct iso_hfsplus_xinfo_new(). More... | |
int | iso_image_hfsplus_bless (IsoImage *img, enum IsoHfsplusBlessings blessing, IsoNode *node, int flag) |
Issue a blessing to a particular IsoNode. More... | |
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. More... | |
Variables | |
unsigned int | iso_fs_global_id |
See IsoFilesystem->get_id() for info about this. More... | |
ino_t | serial_id |
Serial number to be used when you can't get a valid id for a Stream by other means. More... | |
#define ISO_AAIP_ACL_MULT_OBJ 0xE830FE83 |
ACL text contains multiple entries of user::, group::, other:: (FAILURE, HIGH, -381)
Definition at line 7411 of file libisofs.h.
#define ISO_AAIP_BAD_AASTRING 0xE830FEAC |
Error with decoding AAIP info for ACL or xattr (FAILURE, HIGH, -340)
Definition at line 7238 of file libisofs.h.
#define ISO_AAIP_BAD_ACL 0xE830FEAF |
Error with decoding ACL from AAIP info (FAILURE, HIGH, -337)
Definition at line 7228 of file libisofs.h.
#define ISO_AAIP_BAD_ACL_TEXT 0xE830FEAE |
Error with encoding ACL for AAIP (FAILURE, HIGH, -338)
Definition at line 7231 of file libisofs.h.
#define ISO_AAIP_BAD_ATTR_NAME 0xE830FE84 |
Attribute name cannot be represented (FAILURE, HIGH, -380)
Definition at line 7407 of file libisofs.h.
#define ISO_AAIP_IGNORED 0xB030FEB0 |
AAIP info with ACL or xattr in ISO image will be ignored (NOTE, HIGH, -336)
Definition at line 7225 of file libisofs.h.
#define ISO_AAIP_NO_GET_LOCAL 0xE830FEAB |
Error with reading ACL or xattr from local file (FAILURE, HIGH, -341)
Definition at line 7241 of file libisofs.h.
#define ISO_AAIP_NO_SET_LOCAL 0xE830FEAA |
Error with attaching ACL or xattr to local file (FAILURE, HIGH, -342)
Definition at line 7244 of file libisofs.h.
#define ISO_AAIP_NON_USER_NAME 0xE830FEA9 |
Unallowed attempt to set an xattr with non-userspace name (FAILURE, HIGH, -343)
Definition at line 7248 of file libisofs.h.
#define ISO_AAIP_NOT_ENABLED 0xE830FEAD |
AAIP processing for ACL or xattr not enabled at compile time (FAILURE, HIGH, -339)
Definition at line 7235 of file libisofs.h.
#define ISO_ASSERT_FAILURE 0xF030FFFC |
Internal programming error.
Please report this bug (FATAL,HIGH, -4)
Definition at line 7036 of file libisofs.h.
#define ISO_BAD_ISO_FILETYPE 0xE830FE74 |
Unrecognized file type in ISO image (FAILURE, HIGH, -396)
Definition at line 7458 of file libisofs.h.
#define ISO_BAD_PARTITION_FILE 0xE830FE8E |
Cannot open data file for appended partition (FAILURE, HIGH, -370)
Definition at line 7373 of file libisofs.h.
#define ISO_BAD_PARTITION_NO 0xE830FE8F |
Partition number out of range (FAILURE, HIGH, -369)
Definition at line 7370 of file libisofs.h.
#define ISO_BOOT_APM_GPT_BSIZE 0xE830FE78 |
APM block size prevents coexistence with GPT (FAILURE, HIGH, -392)
Definition at line 7446 of file libisofs.h.
#define ISO_BOOT_APM_OVERLAP 0xE830FE80 |
Overlapping Apple Partition Map entries requested (FAILURE, HIGH, -384)
Definition at line 7421 of file libisofs.h.
#define ISO_BOOT_FILE_MISSING 0xE430FE90 |
Boot file missing in image (MISHAP, HIGH, -368)
Definition at line 7367 of file libisofs.h.
#define ISO_BOOT_GPT_OVERLAP 0xE830FE7E |
Overlapping GPT entries requested (FAILURE, HIGH, -386)
Definition at line 7427 of file libisofs.h.
#define ISO_BOOT_HFSP_BAD_BSIZE 0xE830FE79 |
Not a supported HFS+ or APM block size (FAILURE, HIGH, -391)
Definition at line 7443 of file libisofs.h.
#define ISO_BOOT_IMAGE_NOT_VALID 0xE830FFBB |
Trying to use an invalid file as boot image (FAILURE,HIGH, -68)
Definition at line 7079 of file libisofs.h.
#define ISO_BOOT_IMAGE_OVERFLOW 0xE830FFBA |
Too many boot images (FAILURE,HIGH, -69)
Definition at line 7082 of file libisofs.h.
#define ISO_BOOT_MBR_COLLISION 0xE830FE7B |
Attempt to use an MBR partition entry twice (FAILURE, HIGH, -389)
Definition at line 7436 of file libisofs.h.
#define ISO_BOOT_MBR_OVERLAP 0xE830FE7C |
Overlapping MBR partition entries requested (FAILURE, HIGH, -388)
Definition at line 7433 of file libisofs.h.
#define ISO_BOOT_NO_CATALOG 0xE830FFB9 |
No boot catalog created yet ((FAILURE,HIGH, -70)
Definition at line 7085 of file libisofs.h.
#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 7440 of file libisofs.h.
#define ISO_BOOT_TOO_MANY_APM 0xE830FE81 |
Too many Apple Partition Map entries requested (FAILURE, HIGH, -383)
Definition at line 7418 of file libisofs.h.
#define ISO_BOOT_TOO_MANY_GPT 0xE830FE7F |
Too many GPT entries requested (FAILURE, HIGH, -385)
Definition at line 7424 of file libisofs.h.
#define ISO_BOOT_TOO_MANY_MBR 0xE830FE7D |
Too many MBR partition entries requested (FAILURE, HIGH, -387)
Definition at line 7430 of file libisofs.h.
#define ISO_BOOT_TOO_MANY_MIPS 0xE830FE91 |
Too many MIPS Big Endian boot files given (max.
15) (FAILURE, HIGH, -367)
Definition at line 7364 of file libisofs.h.
#define ISO_BUF_READ_ERROR 0xE830FFF5 |
Buffer read error (FAILURE,HIGH, -11)
Definition at line 7059 of file libisofs.h.
#define ISO_CANCELED 0xE830FFFF |
Operation canceled (FAILURE,HIGH, -1)
Definition at line 7027 of file libisofs.h.
#define ISO_CHARSET_CONV_ERROR 0xE830FF00 |
Charset conversion error (FAILURE,HIGH, -256)
Definition at line 7161 of file libisofs.h.
#define ISO_DATA_SOURCE_FAILURE 0xE830FCFF |
Read error occured with IsoDataSource (FAILURE,HIGH, -513)
Definition at line 7477 of file libisofs.h.
#define ISO_DATA_SOURCE_FATAL 0xF030FCFF |
Read error occured with IsoDataSource (FATAL,HIGH, -513)
Definition at line 7480 of file libisofs.h.
#define ISO_DATA_SOURCE_MISHAP 0xE430FCFF |
Read error occured with IsoDataSource (MISHAP,HIGH, -513)
Definition at line 7474 of file libisofs.h.
#define ISO_DATA_SOURCE_SORRY 0xE030FCFF |
Read error occured with IsoDataSource (SORRY,HIGH, -513)
Definition at line 7471 of file libisofs.h.
#define ISO_DEAD_SYMLINK 0xE830FE76 |
Symbolic link cannot be resolved (FAILURE, HIGH, -394)
Definition at line 7452 of file libisofs.h.
#define ISO_DEEP_SYMLINK 0xE830FE75 |
Too many chained symbolic links (FAILURE, HIGH, -395)
Definition at line 7455 of file libisofs.h.
#define ISO_DIR | ( | n | ) | ((IsoDir*)(ISO_NODE_IS_DIR(n) ? n : NULL)) |
Definition at line 234 of file libisofs.h.
#define ISO_DISPLACE_ROLLOVER 0xE830FE8C |
Displacement offset leads outside 32 bit range (FAILURE, HIGH, -372)
Definition at line 7380 of file libisofs.h.
#define ISO_EL_TORITO_HIDDEN 0xD030FEB1 |
El-Torito image is hidden (WARNING,HIGH, -335)
Definition at line 7220 of file libisofs.h.
#define ISO_EL_TORITO_WARN 0xD030FEB3 |
El-Torito related warning (WARNING,HIGH, -333)
Definition at line 7214 of file libisofs.h.
#define ISO_ERROR 0xE830FFFD |
Unknown or unexpected error (FAILURE,HIGH, -3)
Definition at line 7033 of file libisofs.h.
#define ISO_EXTF_TOO_OFTEN 0xE830FEA8 |
Too many references on a single IsoExternalFilterCommand (FAILURE, HIGH, -344)
Definition at line 7252 of file libisofs.h.
#define ISO_FATAL_ERROR 0xF030FFFE |
Unknown or unexpected fatal error (FATAL,HIGH, -2)
Definition at line 7030 of file libisofs.h.
#define ISO_FILE | ( | n | ) | ((IsoFile*)(ISO_NODE_IS_FILE(n) ? n : NULL)) |
Definition at line 235 of file libisofs.h.
#define ISO_FILE_ACCESS_DENIED 0xE830FF7E |
Access to file is not allowed (FAILURE,HIGH, -130)
Definition at line 7101 of file libisofs.h.
#define ISO_FILE_ALREADY_OPENED 0xE830FF7F |
Trying to open an already opened file (FAILURE,HIGH, -129)
Definition at line 7095 of file libisofs.h.
#define ISO_FILE_ALREADY_OPENNED 0xE830FF7F |
Definition at line 7098 of file libisofs.h.
#define ISO_FILE_BAD_PATH 0xE830FF7D |
Incorrect path to file (FAILURE,HIGH, -131)
Definition at line 7104 of file libisofs.h.
#define ISO_FILE_CANT_ADD 0xE030FF71 |
Definition at line 7145 of file libisofs.h.
#define ISO_FILE_CANT_WRITE 0xE430FF73 |
Definition at line 7137 of file libisofs.h.
#define ISO_FILE_DOESNT_EXIST 0xE830FF7C |
The file does not exist in the filesystem (FAILURE,HIGH, -132)
Definition at line 7107 of file libisofs.h.
#define ISO_FILE_ERROR 0xE830FF80 |
Error on file operation (FAILURE,HIGH, -128) (take a look at more specified error codes below)
Definition at line 7092 of file libisofs.h.
#define ISO_FILE_IGNORED 0xD020FF75 |
File not supported in ECMA-119 tree and thus ignored (WARNING,MEDIUM, -139)
Definition at line 7131 of file libisofs.h.
#define ISO_FILE_IMGPATH_WRONG 0xD020FF70 |
File path break specification constraints and will be ignored (WARNING,MEDIUM, -144)
Definition at line 7151 of file libisofs.h.
#define ISO_FILE_IS_DIR 0xE830FF7A |
Directory used where no dir is expected (FAILURE,HIGH, -134)
Definition at line 7116 of file libisofs.h.
#define ISO_FILE_IS_NOT_DIR 0xE830FF78 |
Not dir used where a dir is expected (FAILURE,HIGH, -136)
Definition at line 7122 of file libisofs.h.
#define ISO_FILE_IS_NOT_SYMLINK 0xE830FF77 |
Not symlink used where a symlink is expected (FAILURE,HIGH, -137)
Definition at line 7125 of file libisofs.h.
#define ISO_FILE_NOT_OPENED 0xE830FF7B |
Trying to read or close a file not openned (FAILURE,HIGH, -133)
Definition at line 7110 of file libisofs.h.
#define ISO_FILE_NOT_OPENNED ISO_FILE_NOT_OPENED |
Definition at line 7113 of file libisofs.h.
#define ISO_FILE_OFFSET_TOO_BIG 0xE830FF6A |
Offset greater than file size (FAILURE,HIGH, -150)
Definition at line 7157 of file libisofs.h.
#define ISO_FILE_READ_ERROR 0xE830FF79 |
Read error (FAILURE,HIGH, -135)
Definition at line 7119 of file libisofs.h.
#define ISO_FILE_SEEK_ERROR 0xE830FF76 |
Can't seek to specified location (FAILURE,HIGH, -138)
Definition at line 7128 of file libisofs.h.
#define ISO_FILE_TOO_BIG 0xD020FF74 |
Definition at line 7134 of file libisofs.h.
#define ISO_FILENAME_WRONG_CHARSET 0xD020FF72 |
Definition at line 7140 of file libisofs.h.
#define ISO_FILENAME_WRONG_CHARSET_OLD 0xC020FF72 |
Definition at line 7142 of file libisofs.h.
#define ISO_FILTER_WRONG_INPUT 0xE830FEA5 |
Filter input differs from previous run (FAILURE, HIGH, -347)
Definition at line 7261 of file libisofs.h.
#define ISO_HFSP_NO_MANGLE 0xE830FE77 |
Name collision in HFS+, mangling not possible (FAILURE, HIGH, -393)
Definition at line 7449 of file libisofs.h.
#define ISO_IMAGE_ALREADY_BOOTABLE 0xE830FFBC |
Try to set the boot image of an already bootable image (FAILURE,HIGH, -67)
Definition at line 7076 of file libisofs.h.
#define ISO_IMAGE_WRITE_CANCELED 0xE430FEB2 |
Image write cancelled (MISHAP,HIGH, -334)
Definition at line 7217 of file libisofs.h.
#define ISO_INTERRUPTED 0xF030FFF9 |
Interrupted by a signal (FATAL,HIGH, -7)
Definition at line 7047 of file libisofs.h.
#define ISO_ISOLINUX_CANT_PATCH 0xE030FEB9 |
Can't patch an isolinux boot image (SORRY,HIGH, -327)
Definition at line 7196 of file libisofs.h.
#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.
Definition at line 85 of file libisofs.h.
#define iso_lib_header_version_micro 8 |
Definition at line 87 of file libisofs.h.
#define iso_lib_header_version_minor 2 |
Definition at line 86 of file libisofs.h.
#define ISO_LIBJTE_END_FAILED 0xE830FE93 |
Failed to finish Jigdo Template Extraction (FAILURE, HIGH, -365)
Definition at line 7357 of file libisofs.h.
#define ISO_LIBJTE_FILE_FAILED 0xE430FE92 |
Failed to process file for Jigdo Template Extraction (MISHAP, HIGH, -366)
Definition at line 7361 of file libisofs.h.
#define ISO_LIBJTE_NOT_ENABLED 0xE830FE95 |
Use of libjte was not enabled at compile time (FAILURE, HIGH, -363)
Definition at line 7351 of file libisofs.h.
#define iso_libjte_req_major 1 |
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 .
Definition at line 2306 of file libisofs.h.
#define iso_libjte_req_micro 0 |
Definition at line 2308 of file libisofs.h.
#define iso_libjte_req_minor 0 |
Definition at line 2307 of file libisofs.h.
#define ISO_LIBJTE_START_FAILED 0xE830FE94 |
Failed to start up Jigdo Template Extraction (FAILURE, HIGH, -364)
Definition at line 7354 of file libisofs.h.
#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 7167 of file libisofs.h.
#define ISO_MD5_AREA_CORRUPTED 0xD030FEA0 |
Checksum area or checksum tag appear corrupted (WARNING,HIGH, -352)
Definition at line 7280 of file libisofs.h.
#define ISO_MD5_STREAM_CHANGE 0xE430FE9A |
Detected file content changes while it was written into the image.
(MISHAP, HIGH, -358)
Definition at line 7320 of file libisofs.h.
#define ISO_MD5_TAG_COPIED 0xD030FE88 |
Found copied superblock checksum tag (WARNING, HIGH, -376)
Definition at line 7395 of file libisofs.h.
#define ISO_MD5_TAG_MISMATCH 0xE830FE9F |
Checksum mismatch between checksum tag and data blocks (FAILURE, HIGH, -353)
Definition at line 7287 of file libisofs.h.
#define ISO_MD5_TAG_MISPLACED 0xD030FE9C |
Misplaced checksum tag encountered.
(WARNING, HIGH, -356)
Definition at line 7306 of file libisofs.h.
#define ISO_MD5_TAG_OTHER_RANGE 0xD030FE9B |
Checksum tag with unexpected address range encountered.
(WARNING, HIGH, -357)
Definition at line 7313 of file libisofs.h.
#define ISO_MD5_TAG_UNEXPECTED 0xD030FE9D |
Unexpected checksum tag type encountered.
(WARNING, HIGH, -355)
Definition at line 7300 of file libisofs.h.
#define ISO_MSGS_MESSAGE_LEN 4096 |
Definition at line 5187 of file libisofs.h.
#define ISO_NAME_NEEDS_TRANSL 0xE830FE8B |
File name cannot be written into ECMA-119 untranslated (FAILURE, HIGH, -373)
Definition at line 7384 of file libisofs.h.
#define ISO_NODE | ( | n | ) | ((IsoNode*)n) |
Definition at line 239 of file libisofs.h.
#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 7062 of file libisofs.h.
#define ISO_NODE_DOESNT_EXIST 0xE830FFBD |
A requested node does not exist (FAILURE,HIGH, -66)
Definition at line 7071 of file libisofs.h.
#define ISO_NODE_IS_BOOTCAT | ( | n | ) | (iso_node_get_type(n) == LIBISO_BOOT) |
Definition at line 231 of file libisofs.h.
#define ISO_NODE_IS_DIR | ( | n | ) | (iso_node_get_type(n) == LIBISO_DIR) |
Definition at line 227 of file libisofs.h.
#define ISO_NODE_IS_FILE | ( | n | ) | (iso_node_get_type(n) == LIBISO_FILE) |
Definition at line 228 of file libisofs.h.
#define ISO_NODE_IS_SPECIAL | ( | n | ) | (iso_node_get_type(n) == LIBISO_SPECIAL) |
Definition at line 230 of file libisofs.h.
#define ISO_NODE_IS_SYMLINK | ( | n | ) | (iso_node_get_type(n) == LIBISO_SYMLINK) |
Definition at line 229 of file libisofs.h.
#define ISO_NODE_NAME_NOT_UNIQUE 0xE830FFBF |
Node with same name already exists (FAILURE,HIGH, -65)
Definition at line 7065 of file libisofs.h.
#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 7068 of file libisofs.h.
#define ISO_NON_MBR_SYS_AREA 0xE830FE8D |
May not combine MBR partition with non-MBR system area (FAILURE, HIGH, -371)
Definition at line 7377 of file libisofs.h.
#define ISO_NONE 0 |
special return value, it could be or not an error depending on the context.
Definition at line 7024 of file libisofs.h.
#define ISO_NULL_POINTER 0xE830FFFB |
NULL pointer as value for an arg.
that doesn't allow NULL (FAILURE,HIGH, -5)
Definition at line 7041 of file libisofs.h.
#define ISO_OUT_OF_MEM 0xF030FFFA |
Memory allocation error (FATAL,HIGH, -6)
Definition at line 7044 of file libisofs.h.
#define ISO_OVWRT_FIFO_TOO_SMALL 0xE830FE96 |
The ring buffer is smaller than 64 kB + partition offset.
(FAILURE, HIGH, -362)
Definition at line 7348 of file libisofs.h.
#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)
Definition at line 7335 of file libisofs.h.
#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 7342 of file libisofs.h.
#define ISO_RR_NAME_RESERVED 0xE830FE86 |
Reserved Rock Ridge leaf name (FAILURE, HIGH, -378)
Definition at line 7401 of file libisofs.h.
#define ISO_RR_NAME_TOO_LONG 0xE830FE87 |
Rock Ridge leaf name too long (FAILURE, HIGH, -377)
Definition at line 7398 of file libisofs.h.
#define ISO_RR_PATH_TOO_LONG 0xE830FE85 |
Rock Ridge path too long (FAILURE, HIGH, -379)
Definition at line 7404 of file libisofs.h.
#define ISO_SB_TREE_CORRUPTED 0xE830FE9E |
Checksum mismatch in System Area, Volume Descriptors, or directory tree.
(FAILURE, HIGH, -354)
Definition at line 7294 of file libisofs.h.
#define ISO_SCDBACKUP_TAG_NOT_0 0xD030FE99 |
Session does not start at LBA 0.
scdbackup checksum tag not written. (WARNING, HIGH, -359)
Definition at line 7327 of file libisofs.h.
#define ISO_SECT_SCATTERED 0xE830FE82 |
File sections do not form consecutive array of blocks (FAILURE, HIGH, -382)
Definition at line 7415 of file libisofs.h.
#define ISO_SPECIAL | ( | n | ) | ((IsoSpecial*)(ISO_NODE_IS_SPECIAL(n) ? n : NULL)) |
Definition at line 237 of file libisofs.h.
#define ISO_STREAM_NO_CLONE 0xE830FE8A |
Data file input stream object offers no cloning method (FAILURE, HIGH, -374)
Definition at line 7388 of file libisofs.h.
#define ISO_SUCCESS 1 |
successfully execution
Definition at line 7018 of file libisofs.h.
#define ISO_SUSP_MULTIPLE_ER 0xD030FEB5 |
Multiple ER SUSP entries found (WARNING,HIGH, -331)
Definition at line 7208 of file libisofs.h.
#define ISO_SUSP_UNHANDLED 0xC020FEB6 |
Error on a RR entry that can be ignored (HINT,MEDIUM, -330)
Definition at line 7205 of file libisofs.h.
#define ISO_SYMLINK | ( | n | ) | ((IsoSymlink*)(ISO_NODE_IS_SYMLINK(n) ? n : NULL)) |
Definition at line 236 of file libisofs.h.
#define ISO_THREAD_ERROR 0xF030FFF7 |
Can't create a needed thread (FATAL,HIGH, -9)
Definition at line 7053 of file libisofs.h.
#define ISO_UNSUPPORTED_ECMA119 0xE830FEBC |
Unsupported ECMA-119 feature (FAILURE,HIGH, -324)
Definition at line 7187 of file libisofs.h.
#define ISO_UNSUPPORTED_EL_TORITO 0xD030FEBA |
Unsupported El-Torito feature (WARN,HIGH, -326)
Definition at line 7193 of file libisofs.h.
#define ISO_UNSUPPORTED_RR 0xE030FEBE |
Unsupported RR feature (SORRY,HIGH, -322)
Definition at line 7181 of file libisofs.h.
#define ISO_UNSUPPORTED_SUSP 0xE030FEB8 |
Unsupported SUSP feature (SORRY,HIGH, -328)
Definition at line 7199 of file libisofs.h.
#define ISO_UNSUPPORTED_VD 0xC020FEB4 |
Unsupported volume descriptor found (HINT,MEDIUM, -332)
Definition at line 7211 of file libisofs.h.
#define ISO_WRITE_ERROR 0xE830FFF6 |
Write error (FAILURE,HIGH, -10)
Definition at line 7056 of file libisofs.h.
#define ISO_WRONG_ARG_VALUE 0xE830FFF8 |
Invalid parameter value (FAILURE,HIGH, -8)
Definition at line 7050 of file libisofs.h.
#define ISO_WRONG_ECMA119 0xE830FEBD |
Wrong or damaged ECMA-119 (FAILURE,HIGH, -323)
Definition at line 7184 of file libisofs.h.
#define ISO_WRONG_EL_TORITO 0xD030FEBB |
Wrong or damaged El-Torito catalog (WARN,HIGH, -325)
Definition at line 7190 of file libisofs.h.
#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 7175 of file libisofs.h.
#define ISO_WRONG_RR 0xE030FEBF |
Wrong or damaged RR entry (SORRY,HIGH, -321)
Definition at line 7178 of file libisofs.h.
#define ISO_WRONG_RR_WARN 0xD030FEB7 |
Error on a RR entry that can be ignored (WARNING,HIGH, -329)
Definition at line 7202 of file libisofs.h.
#define ISO_XINFO_NO_CLONE 0xE830FE89 |
Extended information class offers no cloning method (FAILURE, HIGH, -375)
Definition at line 7392 of file libisofs.h.
#define ISO_ZISOFS_PARAM_LOCK 0xE830FEA2 |
Cannot set global zisofs parameters while filters exist (FAILURE, HIGH, -350)
Definition at line 7271 of file libisofs.h.
#define ISO_ZISOFS_TOO_LARGE 0xE830FEA6 |
Cannot apply zisofs filter to file >= 4 GiB (FAILURE, HIGH, -346)
Definition at line 7258 of file libisofs.h.
#define ISO_ZISOFS_WRONG_INPUT 0xE830FEA3 |
Input stream is not in zisofs format (FAILURE, HIGH, -349)
Definition at line 7267 of file libisofs.h.
#define ISO_ZLIB_COMPR_ERR 0xE830FEA4 |
zlib compression/decompression error (FAILURE, HIGH, -348)
Definition at line 7264 of file libisofs.h.
#define ISO_ZLIB_EARLY_EOF 0xE830FEA1 |
Premature EOF of zlib input stream (FAILURE, HIGH, -351)
Definition at line 7274 of file libisofs.h.
#define ISO_ZLIB_NOT_ENABLED 0xE830FEA7 |
Use of zlib was not enabled at compile time (FAILURE, HIGH, -345)
Definition at line 7255 of file libisofs.h.
#define LIBISO_MAX_LINK_DEPTH 100 |
Definition at line 5131 of file libisofs.h.
#define Libisofs_default_path_maX 4096 |
Definition at line 6313 of file libisofs.h.
typedef struct el_torito_boot_image ElToritoBootImage |
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.
old_data | Data item to be cloned |
new_data | Shall return the cloned data item |
flag | Unused yet, submit 0 The function shall return ISO_XINFO_NO_CLONE on unknown flag bits. |
Definition at line 3811 of file libisofs.h.
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.
data | Attached data |
flag | What to do with the data. At this time the following values are defined: -> 1 the data must be freed |
Definition at line 3681 of file libisofs.h.
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.
Definition at line 282 of file libisofs.h.
typedef struct iso_data_source IsoDataSource |
Source for image reading.
Definition at line 386 of file libisofs.h.
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.
Definition at line 173 of file libisofs.h.
typedef struct Iso_Dir_Iter IsoDirIter |
Context for iterate on directory children.
Definition at line 267 of file libisofs.h.
typedef struct iso_external_filter_command IsoExternalFilterCommand |
Definition at line 6446 of file libisofs.h.
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.
Definition at line 189 of file libisofs.h.
typedef struct iso_file_source IsoFileSource |
POSIX abstraction for source files.
Definition at line 478 of file libisofs.h.
typedef struct IsoFileSource_Iface IsoFileSourceIface |
Interface that defines the operations (methods) available for an IsoFileSource.
Definition at line 495 of file libisofs.h.
typedef struct iso_filesystem IsoFilesystem |
Abstract for source filesystems.
Definition at line 486 of file libisofs.h.
typedef struct iso_find_condition IsoFindCondition |
Definition at line 4268 of file libisofs.h.
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.
Definition at line 154 of file libisofs.h.
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...
Definition at line 504 of file libisofs.h.
typedef struct Iso_Node IsoNode |
Definition at line 165 of file libisofs.h.
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, ...
Definition at line 470 of file libisofs.h.
typedef struct iso_read_opts IsoReadOpts |
Options for image reading or import.
Definition at line 378 of file libisofs.h.
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.
Definition at line 199 of file libisofs.h.
typedef struct iso_stream IsoStream |
Representation of file contents.
It is an stream of bytes, functionally like a pipe.
Definition at line 940 of file libisofs.h.
typedef struct IsoStream_Iface IsoStreamIface |
Interface that defines the operations (methods) available for an IsoStream.
Definition at line 949 of file libisofs.h.
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.
Definition at line 181 of file libisofs.h.
typedef struct iso_write_opts IsoWriteOpts |
Options for image written.
Definition at line 371 of file libisofs.h.
El-Torito bootable image type.
Enumerator | |
---|---|
ELTORITO_FLOPPY_EMUL | |
ELTORITO_HARD_DISC_EMUL | |
ELTORITO_NO_EMUL |
Definition at line 324 of file libisofs.h.
enum iso_find_comparisons |
Possible comparison between IsoNode and given conditions.
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 4330 of file libisofs.h.
enum iso_replace_mode |
Replace mode used when addding a node to a file.
This controls how libisofs will act when you tried to add to a dir a file with the same name that an existing file.
Definition at line 337 of file libisofs.h.
enum 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.
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 6933 of file libisofs.h.
enum IsoHideNodeFlag |
Flag used to hide a file in the RR/ISO or Joliet tree.
Definition at line 290 of file libisofs.h.
enum 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; ... }
Enumerator | |
---|---|
LIBISO_DIR | |
LIBISO_FILE | |
LIBISO_SYMLINK | |
LIBISO_SPECIAL | |
LIBISO_BOOT |
Definition at line 218 of file libisofs.h.
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() resp.
iso_init_with_flag() via iso_node_xinfo_make_clonable().
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 resp. 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().
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() resp.
bootimg | The image to inquire |
media_type | Returns the media type |
int el_torito_get_boot_platform_id | ( | ElToritoBootImage * | bootimg | ) |
Get the platform ID value.
See el_torito_set_boot_platform_id().
bootimg | The image to inquire |
int el_torito_get_bootable | ( | ElToritoBootImage * | bootimg | ) |
Get the bootability flag.
See el_torito_set_no_bootable().
bootimg | The image to inquire |
int el_torito_get_id_string | ( | ElToritoBootImage * | bootimg, |
uint8_t | id_string[28] | ||
) |
Get the id_string as of el_torito_set_id_string().
bootimg | The image to inquire |
id_string | Returns 28 bytes of id string |
int el_torito_get_isolinux_options | ( | ElToritoBootImage * | bootimg, |
int | flag | ||
) |
Get the options as of el_torito_set_isolinux_options().
bootimg | The image to inquire |
flag | Reserved for future usage, set to 0. |
int el_torito_get_load_seg | ( | ElToritoBootImage * | bootimg | ) |
Get the load segment value.
bootimg | The image to inquire |
int el_torito_get_load_size | ( | ElToritoBootImage * | bootimg | ) |
Get the load size.
See el_torito_set_load_size().
bootimg | The image to inquire |
int el_torito_get_selection_crit | ( | ElToritoBootImage * | bootimg, |
uint8_t | crit[20] | ||
) |
Get the Selection Criteria bytes as of el_torito_set_selection_crit().
bootimg | The image to inquire |
id_string | Returns 20 bytes of type and data |
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.
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.
bootimg | The image to inquire |
flag | Reserved for future usage, set to 0. |
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 consequtive bootimages are the same
bootimg | The image to manipulate. |
id | A Platform ID as of El Torito 1.0 : 0x00= 80x86, 0x01= PowerPC, 0x02= Mac Others : 0xef= EFI |
int el_torito_set_id_string | ( | ElToritoBootImage * | bootimg, |
uint8_t | id_string[28] | ||
) |
Set the id_string of the Validation Entry resp.
Sector Header Entry which will govern the boot image Section Entry in the El Torito Catalog.
bootimg | The image to manipulate. |
id_string | The 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.) |
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.
bootimg | The image to set options on |
options | bitmask 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.
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
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()
flag | Reserved for future usage, set to 0. |
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.
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.
void el_torito_set_no_bootable | ( | ElToritoBootImage * | bootimg | ) |
Marks the specified boot image as not bootable.
int el_torito_set_selection_crit | ( | ElToritoBootImage * | bootimg, |
uint8_t | crit[20] | ||
) |
Set the Selection Criteria of a boot image.
bootimg | The image to manipulate. |
crit | The 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)". |
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.
path | The absolute path of the file |
src | Will be filled with the pointer to the newly created data source. |
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_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.
dir | the dir where to add the node |
child | the 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. |
replace | if the dir already contains a node with the same name, whether to replace or not the old node with this. |
int iso_dir_find_children | ( | IsoDir * | dir, |
IsoFindCondition * | cond, | ||
IsoDirIter ** | iter | ||
) |
Find all directory children that match the given condition.
dir | Directory where we will search children. |
cond | Condition 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. |
iter | Iterator that returns only the children that match condition. |
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 musn't 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.
int iso_dir_get_children_count | ( | IsoDir * | dir | ) |
Get the number of children of a directory.
Locate a node inside a given dir.
dir | The dir where to look for the node. |
name | The name of the node |
node | Location 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. |
void iso_dir_iter_free | ( | IsoDirIter * | iter | ) |
Free a dir iterator.
int iso_dir_iter_has_next | ( | IsoDirIter * | iter | ) |
Check if there're more children.
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.
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 inbetween.
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.
int iso_error_get_code | ( | int | e | ) |
Get the message queue code of a libisofs error.
int iso_error_get_priority | ( | int | e | ) |
Get the priority of a given error.
int iso_error_get_severity | ( | int | e | ) |
Get the severity of a given error code.
const char* iso_error_to_msg | ( | int | errcode | ) |
Get a textual description of a libisofs error.
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.
file | The data file node which shall show filtered content. |
cmd | The external program and its arguments which shall do the filtering. |
flag | Bitfield for control purposes, unused yet, submit 0. |
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.
file | The data file node which shall show filtered content. |
flag | Bitfield 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 |
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 . 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.
file | The data file node which shall show filtered content. |
flag | Bitfield 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 |
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.
image | The image from which file stems. |
file | The file object to inquire |
md5 | Eventually returns 16 byte of MD5 checksum |
flag | Bitfield for control purposes bit0= only determine return value, do not touch parameter md5 |
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.
file | The file |
lba | Will be filled with the kba |
flag | Reserved for future usage, submit 0 |
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.
file | The file |
section_count | Returns the number of extent entries in sections array. |
sections | Returns the array of file sections. Apply free() to dispose it. |
flag | Reserved for future usage, submit 0 |
off_t iso_file_get_size | ( | IsoFile * | file | ) |
Get the size of the file, in bytes.
int iso_file_get_sort_weight | ( | IsoFile * | file | ) |
Get the sort weight of a 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.
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.
file | The 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. |
flag | Bitfield for control purposes. Unused yet. Submit 0. |
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.
file | The data file node which shall get rid of one layer of content filtering. |
flag | Bitfield for control purposes, unused yet, submit 0. |
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.
int iso_file_source_close | ( | IsoFileSource * | src | ) |
Close a previuously openned file.
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).
src | The file source object to be inquired. |
aa_string | Returns 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. |
flag | Bitfield 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) |
IsoFilesystem* iso_file_source_get_filesystem | ( | IsoFileSource * | src | ) |
Get the filesystem for this source.
No extra ref is added, so you musn't unref the IsoFilesystem.
char* iso_file_source_get_name | ( | IsoFileSource * | src | ) |
Get the name of the file, with the dir component of the path.
char* iso_file_source_get_path | ( | IsoFileSource * | src | ) |
Get the absolute path in the filesystem this file source belongs to.
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.
src | The given source |
offset | in bytes |
flag | 0 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). |
int iso_file_source_lstat | ( | IsoFileSource * | src, |
struct stat * | info | ||
) |
Get information about the file.
int iso_file_source_open | ( | IsoFileSource * | src | ) |
Opens the source.
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.
src | The given source |
buf | Pointer to a buffer of at least count bytes where the read data will be stored |
count | Bytes to read |
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.
src | The given source |
child | pointer to be filled with the given child. Undefined on error or OEF |
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.
src | An IsoFileSource corresponding to a symbolic link. |
buf | Allocated 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. |
bufsiz | Maximum 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. |
void iso_file_source_ref | ( | IsoFileSource * | src | ) |
Take a ref to the given IsoFileSource.
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.
void iso_file_source_unref | ( | IsoFileSource * | src | ) |
Drop your ref to the given IsoFileSource, eventually freeing the associated system resources.
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.
void iso_finish | ( | ) |
Finalize libisofs.
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.
flag | Unused yet. Submit 0. |
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().
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.
gzip_count | Will return the number of currently installed compression filters. |
gunzip_count | Will return the number of currently installed uncompression filters. |
flag | Bitfield for control purposes, unused yet, submit 0 |
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().
|
read |
Create an instance of struct iso_hfsplus_xinfo_new().
flag | Bitfield for control purposes. Unused yet. Submit 0. |
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.
image | The image to which the boot image shall be added. returns an error and the image remains unmodified. |
image_path | The absolute path of a IsoFile to be used as default boot image. |
type | The boot media type. See iso_image_set_boot_image |
flag | Bitfield for control purposes. Unused yet. Submit 0. |
boot | Location where a pointer to the added boot image will be stored. See iso_image_set_boot_image |
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.
img | The image to be manipulated. |
path | Absolute path of the boot file in the ISO 9660 Rock Ridge tree. |
flag | Bitfield for control purposes, unused yet, submit 0 |
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.
image | The image to which data shall be attached. |
data | Pointer to application defined data that will be attached to the image. You can pass NULL to remove any already attached data. |
give_up | Function 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. |
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);
image | The image to write. |
opts | The options for image generation. All needed data will be copied, so you can free the given struct once this function returns. |
burn_src | Location where the pointer to the burn_source will be stored |
int iso_image_filesystem_new | ( | IsoDataSource * | src, |
IsoReadOpts * | opts, | ||
int | msgid, | ||
IsoImageFilesystem ** | fs | ||
) |
Create a new IsoFilesystem to access a existent ISO image.
src | Data source to access data. |
opts | Image read options |
msgid | An image identifer, 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. |
fs | Will be filled with a pointer to the filesystem that can be used to access image contents. |
1 | on success, < 0 on error |
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
image | The image to inquire. |
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 should not be freed nor changed.
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.
image | The image from which to get the boot images. |
num_boots | The number of available array elements in boots and bootnodes. |
boots | Returns NULL or an allocated array of pointers to boot images. Apply system call free(boots) to dispose it. |
bootnodes | Returns NULL or an allocated array of pointers to the IsoFile nodes which bear the content of the boot images in boots. |
flag | Bitfield for control purposes. Unused yet. Submit 0. |
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 should not be freed nor changed.
void* iso_image_get_attached_data | ( | IsoImage * | image | ) |
The the data previously attached with iso_image_attach_data()
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 should not be freed nor changed.
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 should 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.
image | The image from which to get the boot image. |
boot | If not NULL, it will be filled with a pointer to the boot image, if any. That object is owned by the IsoImage and should not be freed by the user, nor dereferenced once the last reference to the IsoImage was disposed via iso_image_unref(). |
imgnode | When 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. |
catnode | When 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. |
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.
image | The image to inquire. |
catnode | Will return the boot catalog tree node. No extra ref is taken. |
lba | Will return the block address of the boot catalog in the image. |
content | Will return either NULL or an allocated memory buffer with the content bytes of the boot catalog. Dispose it by free() when no longer needed. |
size | Will return the number of bytes in content. |
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 should not be freed nor changed.
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 should not be freed nor changed.
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.
img | The image to be inquired. |
paths | An 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. |
flag | Bitfield for control purposes, unused yet, submit 0 |
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 isssued a given message.
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 should not be freed nor changed.
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 17 digits of the form YYYYMMDDhhmmsscc. None of the returned string pointers shall be used for altering or freeing data. They are just for reading.
image | The image to be inquired. |
vol_creation_time | Returns a pointer to the Volume Creation time: When "the information in the volume was created." |
vol_modification_time | Returns a pointer to Volume Modification time: When "the information in the volume was last modified." |
vol_expiration_time | Returns a pointer to Volume Expiration time: When "the information in the volume may be regarded as obsolete." |
vol_effective_time | Returns a pointer to Volume Expiration time: When "the information in the volume may be used." |
Get the root directory of the image.
No extra ref is added to it, so you musn't unref it. Use iso_node_ref() if you want to get your own reference.
int iso_image_get_session_md5 | ( | IsoImage * | image, |
uint32_t * | start_lba, | ||
uint32_t * | end_lba, | ||
char | md5[16], | ||
int | flag | ||
) |
Eventually 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.
image | The image to inquire |
start_lba | Eventually returns the first block address covered by md5 |
end_lba | Eventually returns the first block address not covered by md5 any more |
md5 | Eventually returns 16 byte of MD5 checksum |
flag | Bitfield for control purposes, unused yet, submit 0 |
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().
img | The image to be inquired. |
data | A byte array of at least 32768 bytesi to take the loaded bytes. |
options | The option bits which will be applied if not overridden by iso_write_opts_set_system_area(). See there. |
flag | Bitfield for control purposes, unused yet, submit 0 |
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 should not be freed nor changed.
const char* iso_image_get_volset_id | ( | const IsoImage * | image | ) |
Get the volset identifier.
The returned string is owned by the image and should not be freed nor changed.
const char* iso_image_get_volume_id | ( | const IsoImage * | image | ) |
Get the volume identifier.
The returned string is owned by the image and should not be freed nor changed.
int iso_image_give_up_mips_boot | ( | IsoImage * | image, |
int | flag | ||
) |
Clear the list of MIPS Big Endian boot file paths.
img | The image to be manipulated. |
flag | Bitfield for control purposes, unused yet, submit 0 |
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.
image | The image to manipulate. |
blessing | The kind of blessing to be issued. |
node | The 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. |
flag | Bitfield 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. |
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.
image | The image to inquire. |
blessed_nodes | Will 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_max | Will 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. |
flag | Bitfield for control purposes. Submit 0. |
int iso_image_import | ( | IsoImage * | image, |
IsoDataSource * | src, | ||
IsoReadOpts * | opts, | ||
IsoReadImageFeatures ** | features | ||
) |
Import a previous session or image, for growing or modify.
image | The 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 |
src | Data Source from which old image will be read. A extra reference is added, so you still need to iso_data_source_unref() yours. |
opts | Options for image import. All needed data will be copied, so you can free the given struct once this function returns. |
features | If 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. |
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.
name | Name of the image. This will be used as volset_id and volume_id. |
image | Location where the image pointer will be stored. |
void iso_image_ref | ( | IsoImage * | image | ) |
Increments the reference counting of the given 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.
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.
void iso_image_set_application_id | ( | IsoImage * | image, |
const char * | application_id | ||
) |
Fill in the application id for a image.
Up to 128 chars.
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.
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().
image | The image to manipulate. |
hide_attrs | Or-combination of values from enum IsoHideNodeFlag to set the trees in which the record. |
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.
image | The image to manipulate. |
sort_weight | The larger this value, the lower will be the block address of the boot catalog record. |
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().
image | The image to make bootable. If it was already bootable this function returns an error and the image remains unmodified. |
image_path | The absolute path of a IsoFile to be used as default boot image. |
type | The boot media type. This can be one of 3 types:
|
catalog_path | The 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. |
boot | Location where a pointer to the added boot image will be stored. That object is owned by the IsoImage and should 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. |
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.
void iso_image_set_data_preparer_id | ( | IsoImage * | image, |
const char * | data_preparer_id | ||
) |
Fill in the data preparer for a image.
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().
image | The image of which the behavior is to be controlled |
what | A 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 all other bits are reserved |
void iso_image_set_publisher_id | ( | IsoImage * | image, |
const char * | publisher_id | ||
) |
Fill in the publisher for a image.
void iso_image_set_system_id | ( | IsoImage * | image, |
const char * | system_id | ||
) |
Fill in the system id for a image.
Up to 32 characters.
void iso_image_set_volset_id | ( | IsoImage * | image, |
const char * | volset_id | ||
) |
Fill in the volset identifier for a image.
void iso_image_set_volume_id | ( | IsoImage * | image, |
const char * | volume_id | ||
) |
Fill in the volume identifier for a image.
void iso_image_unref | ( | IsoImage * | image | ) |
Decrements the reference couting 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).
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.
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().
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().
flag | Bitfield for control purposes bit0= do not set up locale by LC_* environment variables |
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().
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().
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.
flag | Bitfield 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 |
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.
disk_path | Absolute path to the file |
text | Will 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. |
flag | Bitfield 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 |
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.
disk_path | Absolute path to the file |
num_attrs | Will return the number of name-value pairs |
names | Will return an array of pointers to 0-terminated names |
value_lengths | Will return an arry with the lenghts of values |
values | Will return an array of pointers to 8-bit values |
flag | Bitfield 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 |
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.
disk_path | Absolute path to the local file which may have an "access" ACL or not. |
flag | Bitfield for control purposes bit5= in case of symbolic link: inquire link target |
st_mode | Returns permission bits as of stat(2) |
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.
disk_path | Absolute path to the file |
text | The input text (0 terminated, ACL long text form) |
flag | Bitfield for control purposes bit0= set "default" ACL rather than "access" ACL bit5= in case of symbolic link: manipulate link target |
int iso_local_set_attrs | ( | char * | disk_path, |
size_t | num_attrs, | ||
char ** | names, | ||
size_t * | value_lengths, | ||
char ** | values, | ||
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.
disk_path | Absolute path to the file |
num_attrs | Number of attributes |
names | Array of pointers to 0 terminated name strings |
value_lengths | Array of byte lengths for each attribute payload |
values | Array of pointers to the attribute payload bytes |
flag | Bitfield 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= |
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.
old_md5_context | An opaque handle once returned by iso_md5_start() or iso_md5_clone(). |
new_md5_context | Returns the opaque handle to the new MD5 context. Submitted *md5_context must be NULL or point to freeable memory. |
int iso_md5_compute | ( | void * | md5_context, |
char * | data, | ||
int | datalen | ||
) |
Advance the computation of a MD5 checksum by a chunk of data bytes.
md5_context | An opaque handle once returned by iso_md5_start() or iso_md5_clone(). |
data | The bytes which shall be processed into to the checksum. |
datalen | The number of bytes to be processed. |
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.)
md5_context | A 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. |
result | Gets filled with the 16 bytes of MD5 checksum. |
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.)
first_md5 | A MD5 byte string as returned by iso_md5_end() |
second_md5 | A MD5 byte string as returned by iso_md5_end() |
int iso_md5_start | ( | void ** | md5_context | ) |
Create a MD5 computation context and hand out an opaque handle.
md5_context | Returns the opaque handle. Submitted *md5_context must be NULL or point to freeable memory. |
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.
buf | The dynamically allocated memory buffer with the stream content. size The number of bytes which may be read from buf. |
stream | Will return a reference to the newly created stream. |
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.
error_code | The unique error code of your message. Submit 0 if you do not have reserved error codes within the libburnia project. |
msg_text | Not more than ISO_MSGS_MESSAGE_LEN characters of message text. |
os_errno | Eventual errno related to the message. Submit 0 if the message is not related to a operating system error. |
severity | One of "ABORT", "FATAL", "FAILURE", "SORRY", "WARNING", "HINT", "NOTE", "UPDATE", "DEBUG". Defaults to "FATAL". |
origin | Submit 0 for now. |
IsoFindCondition* iso_new_find_conditions_and | ( | IsoFindCondition * | a, |
IsoFindCondition * | b | ||
) |
Create a new condition that check if the two given conditions are valid.
a | |
b | IsoFindCondition to compare |
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.
time | Time to compare against IsoNode atime. |
comparison | Comparison 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. |
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.
time | Time to compare against IsoNode ctime. |
comparison | Comparison 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. |
IsoFindCondition* iso_new_find_conditions_gid | ( | gid_t | gid | ) |
Create a new condition that checks the node gid.
gid | Desired Group Id. |
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.
mask | Mode mask to AND against node mode. |
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.
time | Time to compare against IsoNode mtime. |
comparison | Comparison 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. |
IsoFindCondition* iso_new_find_conditions_name | ( | const char * | wildcard | ) |
Create a new condition that checks if the node name matches the given wildcard.
wildcard |
IsoFindCondition* iso_new_find_conditions_not | ( | IsoFindCondition * | negate | ) |
Create a new condition that check if the given conditions is false.
negate |
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.
a | |
b | IsoFindCondition to compare |
IsoFindCondition* iso_new_find_conditions_uid | ( | uid_t | uid | ) |
Create a new condition that checks the node uid.
uid | Desired User Id. |
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.
node | The node where to add the extended info |
proc | A function pointer used to identify the type of the data, and that knows how to manage it |
data | Extended info to add. |
Compare two nodes whether they are based on the same input and can be considered as hardlinks to the same file objects.
n1 | The first node to compare. |
n2 | The second node to compare. |
flag | Bitfield for control purposes, unused yet, submit 0 |
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 resp. acl_to_text(). Call this function with flag bit15 to finally release the memory occupied by an ACL inquiry.
node | The node that is to be inquired. |
access_text | Will return a pointer to the eventual "access" ACL text or NULL if it is not available and flag bit 4 is set. |
default_text | Will 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.) |
flag | Bitfield 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) |
time_t iso_node_get_atime | ( | const IsoNode * | node | ) |
Get the time of last access to the file.
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().
node | The node that is to be inquired. |
num_attrs | Will return the number of name-value pairs |
names | Will return an array of pointers to 0-terminated names |
value_lengths | Will return an arry with the lenghts of values |
values | Will return an array of pointers to strings of 8-bit bytes |
flag | Bitfield 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) |
time_t iso_node_get_ctime | ( | const IsoNode * | node | ) |
Get the time of last status change of the file.
gid_t iso_node_get_gid | ( | const IsoNode * | node | ) |
Get the group id of the node.
int iso_node_get_hidden | ( | IsoNode * | node | ) |
Get the hide_attrs as eventually set by iso_node_set_hidden().
node | The node to inquire. |
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'.
time_t iso_node_get_mtime | ( | const IsoNode * | node | ) |
Get the time of last modification of the file.
const char* iso_node_get_name | ( | const IsoNode * | node | ) |
Get the name of a node.
The returned string belongs to the node and should not be modified nor freed. Use strdup if you really need your own copy.
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 informations.
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 !
node | The node to inquire |
handle | The 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. |
proc | The function pointer which serves as key |
data | Will be filled with the extended info corresponding to the given proc function |
int iso_node_get_old_image_lba | ( | IsoNode * | node, |
uint32_t * | lba, | ||
int | flag | ||
) |
mode_t iso_node_get_permissions | ( | const IsoNode * | node | ) |
Get the permissions for the node.
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).
node | The node that is to be inquired. |
enum IsoNodeType iso_node_get_type | ( | IsoNode * | node | ) |
Get the type of an IsoNode.
uid_t iso_node_get_uid | ( | const IsoNode * | node | ) |
Get the user id of the 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.
node | The node to inquire |
proc | The function pointer which serves as key |
data | Will after successful call point to the xinfo data corresponding to the given proc. This is a pointer, not a feeable data copy. |
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.
node | The node that is to be inquired. |
name | The xattr name that shall be looked up. |
value_length | Will return the lenght of value |
value | Will return a string of 8-bit bytes. free() it when no longer needed. |
flag | Bitfield for control purposes, unused yet, submit 0 |
void iso_node_ref | ( | IsoNode * | node | ) |
Increments the reference counting of the given node.
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.
int iso_node_remove_all_xinfo | ( | IsoNode * | node, |
int | flag | ||
) |
Remove all extended information from the given node.
node | The node where to remove all extended info |
flag | Bitfield for control purposes, unused yet, submit 0 |
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.
node | The node to be removed. |
iter | If not NULL, then the node will be removed by iso_dir_iter_remove(iter) else it will be removed by iso_node_remove(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_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.
node | The node that is to be manipulated. |
access_text | The text to be set into effect as "access" ACL. NULL will delete an eventually existing "access" ACL of the node. |
default_text | The 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.) |
flag | Bitfield for control purposes bit1= ignore text parameters but rather update eventual "access" ACL to the stat(2) permissions of node. If no "access" ACL exists, then do nothing and return success. |
void iso_node_set_atime | ( | IsoNode * | node, |
time_t | time | ||
) |
Set the time of last access to the file.
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.
node | The node that is to be manipulated. |
num_attrs | Number of attributes |
names | Array of pointers to 0 terminated name strings |
value_lengths | Array of byte lengths for each value |
values | Array of pointers to the value bytes |
flag | Bitfield 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. |
void iso_node_set_ctime | ( | IsoNode * | node, |
time_t | time | ||
) |
Set the time of last status change of the file.
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.
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).
node | The node that is to be hidden. |
hide_attrs | Or-combination of values from enum IsoHideNodeFlag to set the trees in which the node's name shall be hidden. |
void iso_node_set_mtime | ( | IsoNode * | node, |
time_t | time | ||
) |
Set the time of last modification of the file.
int iso_node_set_name | ( | IsoNode * | node, |
const char * | name | ||
) |
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.
node | The node whose name you want to change. Note that you can't change the name of the root. |
name | The 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. |
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.
node | The node to change |
mode | bitmask 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. |
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.
node | The 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. |
w | The weight as a integer number, the greater this value is, the closer from the begining of image the file will be written. Default value at IsoNode creation is 0. |
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.
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).
void iso_node_unref | ( | IsoNode * | node | ) |
Decrements the reference couting 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.
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.
proc | The key and disposal function which identifies the particular extended information class. |
cloner | Will return the cloner function which is associated with proc, or NULL. |
flag | Unused yet, submit 0 |
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.
proc | The key and disposal function which identifies the particular extended information class. |
cloner | The cloner function which shall be associated with proc. |
flag | Unused yet, submit 0 |
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 reults of program mkzftree from disk into the image.
node | The node which shall be checked and eventually marked. |
flag | Bitfield for control purposes, unused yet, submit 0 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 |
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.
minimum_severity | Threshhold |
error_code | Will become a unique error code as listed at the end of this header |
imgid | Id of the image that was issued the message. |
msg_text | Must provide at least ISO_MSGS_MESSAGE_LEN bytes. |
severity | Will become the severity related to the message and should provide at least 80 bytes. |
void iso_read_image_features_destroy | ( | IsoReadImageFeatures * | f | ) |
Destroy an IsoReadImageFeatures object obtained with iso_image_import.
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_eltorito | ( | IsoReadImageFeatures * | f | ) |
Whether El-Torito boot record is present 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.
it has a version 2 Enhanced Volume Descriptor.
int iso_read_image_features_has_joliet | ( | IsoReadImageFeatures * | f | ) |
Whether Joliet extensions are present in the image imported.
int iso_read_image_features_has_rockridge | ( | IsoReadImageFeatures * | f | ) |
Whether RockRidge extensions are present in the image imported.
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()
opts | The option set to be manipulated |
mode | Bitfield 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. |
void iso_read_opts_free | ( | IsoReadOpts * | opts | ) |
Free an IsoReadOpts previously allocated with iso_read_opts_new().
int iso_read_opts_load_system_area | ( | IsoReadOpts * | opts, |
int | mode | ||
) |
Enable or disable loading of the first 32768 bytes of the session.
opts | The option set to be manipulated |
mode | Bitfield 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. |
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.
opts | Pointer to the location where the newly created IsoReadOpts will be stored. You should free it with iso_read_opts_free() when no more needed. |
profile | Default 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. |
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.
opts | The option set to be manipulated |
file_perm | Permissions for files. |
dir_perm | Permissions for directories. |
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_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.
opts | The option set to be manipulated |
charset | The charset to use as input charset. You can obtain the list of charsets supported on your system executing "iconv -l" in a shell. |
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.
opts | The option set to be manipulated |
new_inos | 1 = 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. |
int iso_read_opts_set_no_aaip | ( | IsoReadOpts * | opts, |
int | noaaip | ||
) |
Control reading of AAIP informations 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().
opts | The option set to be manipulated |
noaaip | 1 = Do not read AAIP information 0 = Read AAIP information if available All other values are reserved. |
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_joliet | ( | IsoReadOpts * | opts, |
int | nojoliet | ||
) |
Do not read Joliet extensions.
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".
opts | The option set to be manipulated |
no_md5 | 0 = 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 |
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.
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.
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.
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.
b | A burn_source previously obtained with iso_image_create_burn_source(). |
size | Will be filled with the total size of the buffer, in bytes |
free_bytes | Will be filled with the bytes currently available in buffer |
int iso_set_abort_severity | ( | char * | severity | ) |
Set the minimum error severity that causes a libisofs operation to be aborted as soon as possible.
severity | one 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. |
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.
name | Name of the character set to be assumed as "local" one. |
flag | Unused yet. Submit 0. |
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".
queue_severity | Gives the minimum limit for messages to be queued. Default: "NEVER". If you queue messages then you must consume them by iso_msgs_obtain(). |
print_severity | Does the same for messages to be printed directly to stderr. |
print_id | A text prefix to be printed before the message. |
int iso_sev_to_text | ( | int | severity_number, |
char ** | severity_name | ||
) |
Convert a severity number into a severity name.
severity_number | The rank number: the higher, the more severe. |
severity_name | A name as with iso_msgs_submit(), e.g. "SORRY". |
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.
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.
old_stream | The existing stream object to be copied |
new_stream | Will return a pointer to the copy |
flag | Bitfield for control purposes. Submit 0 for now. |
int iso_stream_close | ( | IsoStream * | stream | ) |
Close a previously openned IsoStream.
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.
s1 | The first stream to compare. |
s2 | The second stream to compare. |
flag | bit0= do not use s1->class->compare() even if available (e.g. because iso_stream_cmp_ino(0 is called as fallback from said stream->class->compare()) |
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()).
stream | The stream to be inquired. |
cmd | Will return the external IsoExternalFilterCommand. Valid only if the call returns 1. This does not increment cmd->refcount. |
flag | Bitfield for control purposes, unused yet, submit 0. |
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.
Obtain the eventual input stream of a filter stream.
stream | The eventual filter stream to be inquired. |
flag | Bitfield for control purposes. Submit 0 for now. |
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().
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
stream | The stream to be inquired. |
flag | Bitfield for control purposes, unused yet, submit 0 |
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.
int iso_stream_open | ( | IsoStream * | stream | ) |
Opens the given stream.
Remember to close the Stream before writing the image.
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.
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_update_size | ( | IsoStream * | stream | ) |
Updates the size of the IsoStream with the current size of the underlying source.
const char* iso_symlink_get_dest | ( | const IsoSymlink * | link | ) |
Get the destination of a node.
The returned string belongs to the node and should not be modified nor freed. Use strdup if you really need your own copy.
int iso_symlink_set_dest | ( | IsoSymlink * | link, |
const char * | dest | ||
) |
Set the destination of a link.
opts | The option set to be manipulated |
dest | New destination for the link. It must be a non-empty string, otherwise this function doesn't modify previous destination. |
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.
severity_name | A name as with iso_msgs_submit(), e.g. "SORRY". |
severity_number | The rank number: the higher, the more severe. |
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 diferent options for recursive directory addition.
TODO comment Builder and Filesystem related issues when exposing both
image | The image to which the directory belongs. |
parent | Directory on the image tree where to add the contents of the dir |
dir | Path to a dir in the filesystem |
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 explicity 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 foollowing the 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 excluve, respectively, all files or dirs named private, and also all files or dirs named data that belong to a folder named "user". Not 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, "*.~");
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.
image | The image |
parent | The directory in the image tree where the node will be added. |
name | The leaf name that the node will have on image. Its directory path depends on the parent node. |
path | The absolute path of the file in the local filesystem. For now only regular files and symlinks to regular files are supported. |
offset | Byte number in the given file from where to start reading data. |
size | Max size of the file. This may be more than actually available from byte offset to the end of the file in the local filesystem. |
node | place where to store a pointer to the newly added file. No extra ref is addded, 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. |
Add a new directory to the iso tree.
Permissions, owner and hidden atts are taken from parent, you can modify them later.
parent | the dir where the new directory will be created |
name | name for the new dir. If a node with same name already exists on parent, this functions fails with ISO_NODE_NAME_NOT_UNIQUE. |
dir | place where to store a pointer to the newly created dir. No extra ref is addded, 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. |
int iso_tree_add_new_file | ( | 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.
parent | the dir where the new file will be created |
name | name for the new file. If a node with same name already exists on parent, this functions fails with ISO_NODE_NAME_NOT_UNIQUE. |
stream | IsoStream 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. |
file | place where to store a pointer to the newly created file. No extra ref is addded, 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 |
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.
image | The image |
parent | The directory in the image tree where the node will be added. |
name | The leaf name that the node will have on image. Its directory path depends on the parent node. |
path | The absolute path of the file in the local filesystem. |
node | place where to store a pointer to the newly added file. No extra ref is addded, 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. |
int iso_tree_add_new_special | ( | 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, an 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 propertly (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.
parent | the dir where the new special file will be created |
name | name for the new special file. If a node with same name already exists on parent, this functions fails with ISO_NODE_NAME_NOT_UNIQUE. |
mode | file type and permissions for the new node. Note that you can't specify any kind of file here, only special types are allowed. i.e, S_IFSOCK, S_IFBLK, S_IFCHR and S_IFIFO are valid types; S_IFLNK, S_IFREG and S_IFDIR aren't. |
dev | device ID, equivalent to the st_rdev field in man 2 stat. |
special | place where to store a pointer to the newly created special file. No extra ref is addded, 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. |
int iso_tree_add_new_symlink | ( | IsoDir * | parent, |
const char * | name, | ||
const char * | dest, | ||
IsoSymlink ** | link | ||
) |
Add a new symlink to the directory tree.
Permissions are set to 0777, owner and hidden atts are taken from parent. You can modify any of them later.
parent | the dir where the new symlink will be created |
name | name for the new symlink. If a node with same name already exists on parent, this functions fails with ISO_NODE_NAME_NOT_UNIQUE. |
dest | destination of the link |
link | place where to store a pointer to the newly created link. No extra ref is addded, 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 |
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.
image | The image |
parent | The directory in the image tree where the node will be added. |
path | The absolute path of the file in the local filesystem. The node will have the same leaf name as the file on disk. Its directory path depends on the parent node. |
node | place where to store a pointer to the newly added file. No extra ref is addded, 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. |
int iso_tree_clone | ( | 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.
node | The node to be cloned. |
new_parent | The existing directory node where to insert the cloned node. |
new_name | The 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_node | Will return a pointer (without reference) to the newly created clone. |
flag | Bitfield 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. |
int iso_tree_get_follow_symlinks | ( | IsoImage * | image | ) |
int iso_tree_get_ignore_hidden | ( | IsoImage * | image | ) |
int iso_tree_get_ignore_special | ( | IsoImage * | image | ) |
char* iso_tree_get_node_path | ( | IsoNode * | node | ) |
Get the absolute path on image of the given node.
enum iso_replace_mode iso_tree_get_replace_mode | ( | IsoImage * | image | ) |
Locate a node by its absolute path on image.
image | The image to which the node belongs. |
node | Location for a pointer to the node, it will 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. |
int iso_tree_remove_exclude | ( | IsoImage * | image, |
const char * | path | ||
) |
Remove a previously added exclude.
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.
img | The image wherein to try resolving the link. |
sym | The symbolic link node which to resolve. |
res | Will 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. |
depth | Prevents endless loops. Submit as 0. |
flag | Bitfield for control purposes. Submit 0 for now. |
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.
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().
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.
image | The image to manipulate. |
skip | Bitmask to determine what kind of special files will be skipped: bit0: ignore FIFOs bit1: ignore Sockets bit2: ignore char devices bit3: ignore block devices |
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.
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.
image | The image to manipulate. |
report | pointer 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. |
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 .
data | A complete and aligned data block read from an ISO image session. |
tag_type | 0= no tag 1= session tag 2= superblock tag 3= tree tag 4= relocated 64 kB superblock tag (at LBA 0 of overwriteable media) |
pos | Returns 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_start | Returns 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_size | Returns the number of blocks beginning at range_start which are covered by parameter md5. |
next_tag | Returns 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. |
md5 | Returns 16 byte of MD5 checksum. |
flag | Bitfield 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 |
int iso_write_opts_attach_jte | ( | IsoWriteOpts * | opts, |
void * | libjte_handle | ||
) |
Associate a libjte environment object to the upcomming 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.
opts | The option set to be manipulated. |
libjte_handle | Pointer 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 *). |
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.
opts | The option set to be manipulated. |
libjte_handle | If not submitted as NULL, this will return the previously set libjte handle. |
void iso_write_opts_free | ( | IsoWriteOpts * | opts | ) |
Free an IsoWriteOpts previously allocated with iso_write_opts_new().
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().
opts | The option set that was used when starting image creation |
data_start | Returns the logical block address if it is already valid |
flag | Reserved for future usage, set to 0. |
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.
opts | Pointer to the location where the newly created IsoWriteOpts will be stored. You should free it with iso_write_opts_free() when no more needed. |
profile | Default 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. |
int iso_write_opts_set_aaip | ( | IsoWriteOpts * | opts, |
int | enable | ||
) |
Control writing of AAIP informations 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().
opts | The option set to be manipulated. |
enable | 1 = write AAIP information from nodes into the image 0 = do not write AAIP information into the image All other values are reserved. |
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 preceed 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.
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.
opts | The option set to be manipulated. |
allow | If not zero, then allow what is described above. |
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.
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.)
opts | The option set to be manipulated. |
allow | 1= allow dots , 0= disallow dots and convert them |
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.
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.
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.
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).
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 resp. 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.
opts | The option set to be manipulated. |
append | 1 to create an appended image, 0 for an stand-alone one. |
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_gid | ( | IsoWriteOpts * | opts, |
gid_t | gid | ||
) |
Set the gid to use when you set the replace_gid to 2.
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_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_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.
opts | The option set to be manipulated. |
allow | If 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 |
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"
opts | The option set to be manipulated. |
label | A text of up to 128 characters. |
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.
opts | The option set to be manipulated. |
image_path | File address in the local file system. NULL revokes production of the EFI boot partition. |
flag | Reserved for future usage, set to 0. |
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
opts | The option set to be manipulated. |
enable | 1 to enable FAT32 extension, 0 to not add FAT metadata |
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.
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 overriden 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.
opts | The option set to be manipulated. |
enable | 1 = 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. |
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+.
opts | The option set to be manipulated. |
hfsp_block_size | The allocation block size to be used by the HFS+ fileystem. 0, 512, or 2048 |
hfsp_block_size | The 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. |
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.
opts | The option set to be manipulated. |
serial_number | 8 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. |
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.
opts | The option set to be manipulated. |
enable | 1 to enable HFS+ extension, 0 to not add HFS+ metadata and APM |
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.
int iso_write_opts_set_iso_level | ( | IsoWriteOpts * | opts, |
int | level | ||
) |
Set the ISO-9960 level to write at.
opts | The 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 |
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.
opts | The option set to be manipulated. |
enable | 1 to enable Joliet extension, 0 to not add them |
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.
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.
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.
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.
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.
opts | The option set to be manipulated. |
no | bit0= no forced dot with ECMA-119 bit1= no forced dot with Joliet ( |
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.)
opts | The option set to be manipulated. |
enable | 1 = use the suboptimal block addresses in the range of 0 to 115. 0 = use the address of a block after the directory tree. (Default) |
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.
opts | The option set to be manipulated. |
omit | bit0= omit version number with ECMA-119 and Joliet bit1= omit version number with Joliet alone ( |
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.
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 overwriteable 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:
opts | The option set to be manipulated. |
overwrite | When 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 overwriteable 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 enought. IMPORTANT: If you use iso_write_opts_set_part_offset() then the overwrite buffer must be larger by the offset defined there. |
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_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.
opts | The option set to be manipulated. |
partition_number | Depicts 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. |
image_path | File address in the local file system. With SUN Disk Label: an empty name causes the partition to become a copy of the next lower partition. |
image_type | The 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. |
flag | Reserved for future usage, set to 0. |
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.
opts | The option set to be manipulated. |
image_path | File address in the local file system. NULL revokes production of the PreP partition. |
flag | Reserved for future usage, set to 0. |
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 | ||
) |
Explicitely 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:
opts | The option set to be manipulated. |
vol_creation_time | When "the information in the volume was created." A value of 0 means that the timepoint of write start is to be used. |
vol_modification_time | When "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_time | When "the information in the volume may be regarded as obsolete." A value of 0 means that the information never shall expire. |
vol_effective_time | When "the information in the volume may be used." A value of 0 means that not such retention is intended. |
vol_uuid | If 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 E.g.: "2010040711405800" = 7 Apr 2010 11:40:58 (+0 centiseconds) |
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().
opts | The option set to be manipulated. |
session | If bit0 set: Compute session checksum |
files | If 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. |
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 contraints, but should work on modern systems.
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.
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().
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/setted with the appropiate function.
opts | The option set to be manipulated. |
enable | 1 to enable RR extension, 0 to not add them |
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.
opts | The option set to be manipulated. |
name | The 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. flags Bitfield 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) |
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).
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_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.
opts | The option set to be manipulated. |
name | A word of up to 80 characters. Typically volno_totalno telling that this is volume volno of a total of totalno volumes. |
timestamp | A string of 13 characters YYMMDD.hhmmss (e.g. A90831.190324). A9 = 2009, B0 = 2010, B1 = 2011, ... C0 = 2020, ... |
tag_written | Either 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. |
int iso_write_opts_set_sort_files | ( | IsoWriteOpts * | opts, |
int | sort | ||
) |
int iso_write_opts_set_system_area | ( | IsoWriteOpts * | opts, |
char | data[32768], | ||
int | options, | ||
int | flag | ||
) |
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.
opts | The option set to be manipulated. |
num_blocks | Number of extra 2 kB blocks to be written. |
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.
opts | The option set to be manipulated. |
len | 0 = 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) |
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.
opts | The option set to be manipulated. |
will_cancel | 0= normal image generation 1= prepare for being canceled before image stream output is completed |
int iso_zisofs_get_params | ( | struct iso_zisofs_ctrl * | params, |
int | flag | ||
) |
Get the current global parameters for zisofs filtering.
params | Pointer to a caller provided structure which shall take the settings. |
flag | Bitfield for control purposes, unused yet, submit 0 |
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.
ziso_count | Will return the number of currently installed compression filters. |
osiz_count | Will return the number of currently installed uncompression filters. |
flag | Bitfield for control purposes, unused yet, submit 0 |
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.
params | Pointer to a structure with the intended settings. |
flag | Bitfield for control purposes, unused yet, submit 0 |
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.
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.