libisofs  1.5.0
libisofs.h
Go to the documentation of this file.
1 
2 #ifndef LIBISO_LIBISOFS_H_
3 #define LIBISO_LIBISOFS_H_
4 
5 /*
6  * Copyright (c) 2007-2008 Vreixo Formoso, Mario Danic
7  * Copyright (c) 2009-2018 Thomas Schmitt
8  *
9  * This file is part of the libisofs project; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License version 2
11  * or later as published by the Free Software Foundation.
12  * See COPYING file for details.
13  */
14 
15 /* Important: If you add a public API function then add its name to file
16  libisofs/libisofs.ver
17 */
18 
19 #ifdef __cplusplus
20 extern "C" {
21 #endif
22 
23 /*
24  *
25  * Applications must use 64 bit off_t.
26  * E.g. on 32-bit GNU/Linux by defining
27  * #define _LARGEFILE_SOURCE
28  * #define _FILE_OFFSET_BITS 64
29  * The minimum requirement is to interface with the library by 64 bit signed
30  * integers where libisofs.h or libisoburn.h prescribe off_t.
31  * Failure to do so may result in surprising malfunction or memory faults.
32  *
33  * Application files which include libisofs/libisofs.h must provide
34  * definitions for uint32_t and uint8_t.
35  * This can be achieved either:
36  * - by using autotools which will define HAVE_STDINT_H or HAVE_INTTYPES_H
37  * according to its ./configure tests,
38  * - or by defining the macros HAVE_STDINT_H or HAVE_INTTYPES_H according
39  * to the local situation,
40  * - or by appropriately defining uint32_t and uint8_t by other means,
41  * e.g. by including inttypes.h before including libisofs.h
42  */
43 #ifdef HAVE_STDINT_H
44 #include <stdint.h>
45 #else
46 #ifdef HAVE_INTTYPES_H
47 #include <inttypes.h>
48 #endif
49 #endif
50 
51 
52 /*
53  * Normally this API is operated via public functions and opaque object
54  * handles. But it also exposes several C structures which may be used to
55  * provide custom functionality for the objects of the API. The same
56  * structures are used for internal objects of libisofs, too.
57  * You are not supposed to manipulate the entrails of such objects if they
58  * are not your own custom extensions.
59  *
60  * See for an example IsoStream = struct iso_stream below.
61  */
62 
63 
64 #include <sys/stat.h>
65 
66 #include <stdlib.h>
67 
68 /* Because AIX defines "open" as "open64".
69  There are struct members named "open" in libisofs.h which get affected.
70  So all includers of libisofs.h must get included fcntl.h to see the same.
71 */
72 #include <fcntl.h>
73 
74 
75 /**
76  * The following two functions and three macros are utilities to help ensuring
77  * version match of application, compile time header, and runtime library.
78  */
79 /**
80  * These three release version numbers tell the revision of this header file
81  * and of the API it describes. They are memorized by applications at
82  * compile time.
83  * They must show the same values as these symbols in ./configure.ac
84  * LIBISOFS_MAJOR_VERSION=...
85  * LIBISOFS_MINOR_VERSION=...
86  * LIBISOFS_MICRO_VERSION=...
87  * Note to anybody who does own work inside libisofs:
88  * Any change of configure.ac or libisofs.h has to keep up this equality !
89  *
90  * Before usage of these macros on your code, please read the usage discussion
91  * below.
92  *
93  * @since 0.6.2
94  */
95 #define iso_lib_header_version_major 1
96 #define iso_lib_header_version_minor 5
97 #define iso_lib_header_version_micro 0
98 
99 /**
100  * Get version of the libisofs library at runtime.
101  * NOTE: This function may be called before iso_init().
102  *
103  * @since 0.6.2
104  */
105 void iso_lib_version(int *major, int *minor, int *micro);
106 
107 /**
108  * Check at runtime if the library is ABI compatible with the given version.
109  * NOTE: This function may be called before iso_init().
110  *
111  * @return
112  * 1 lib is compatible, 0 is not.
113  *
114  * @since 0.6.2
115  */
116 int iso_lib_is_compatible(int major, int minor, int micro);
117 
118 /**
119  * Usage discussion:
120  *
121  * Some developers of the libburnia project have differing opinions how to
122  * ensure the compatibility of libaries and applications.
123  *
124  * It is about whether to use at compile time and at runtime the version
125  * numbers provided here. Thomas Schmitt advises to use them. Vreixo Formoso
126  * advises to use other means.
127  *
128  * At compile time:
129  *
130  * Vreixo Formoso advises to leave proper version matching to properly
131  * programmed checks in the the application's build system, which will
132  * eventually refuse compilation.
133  *
134  * Thomas Schmitt advises to use the macros defined here for comparison with
135  * the application's requirements of library revisions and to eventually
136  * break compilation.
137  *
138  * Both advises are combinable. I.e. be master of your build system and have
139  * #if checks in the source code of your application, nevertheless.
140  *
141  * At runtime (via iso_lib_is_compatible()):
142  *
143  * Vreixo Formoso advises to compare the application's requirements of
144  * library revisions with the runtime library. This is to allow runtime
145  * libraries which are young enough for the application but too old for
146  * the lib*.h files seen at compile time.
147  *
148  * Thomas Schmitt advises to compare the header revisions defined here with
149  * the runtime library. This is to enforce a strictly monotonous chain of
150  * revisions from app to header to library, at the cost of excluding some older
151  * libraries.
152  *
153  * These two advises are mutually exclusive.
154  */
155 
156 struct burn_source;
157 
158 /**
159  * Context for image creation. It holds the files that will be added to image,
160  * and several options to control libisofs behavior.
161  *
162  * @since 0.6.2
163  */
164 typedef struct Iso_Image IsoImage;
165 
166 /*
167  * A node in the iso tree, i.e. a file that will be written to image.
168  *
169  * It can represent any kind of files. When needed, you can get the type with
170  * iso_node_get_type() and cast it to the appropriate subtype. Useful macros
171  * are provided, see below.
172  *
173  * @since 0.6.2
174  */
175 typedef struct Iso_Node IsoNode;
176 
177 /**
178  * A directory in the iso tree. It is an special type of IsoNode and can be
179  * casted to it in any case.
180  *
181  * @since 0.6.2
182  */
183 typedef struct Iso_Dir IsoDir;
184 
185 /**
186  * A symbolic link in the iso tree. It is an special type of IsoNode and can be
187  * casted to it in any case.
188  *
189  * @since 0.6.2
190  */
191 typedef struct Iso_Symlink IsoSymlink;
192 
193 /**
194  * A regular file in the iso tree. It is an special type of IsoNode and can be
195  * casted to it in any case.
196  *
197  * @since 0.6.2
198  */
199 typedef struct Iso_File IsoFile;
200 
201 /**
202  * An special file in the iso tree. This is used to represent any POSIX file
203  * other that regular files, directories or symlinks, i.e.: socket, block and
204  * character devices, and fifos.
205  * It is an special type of IsoNode and can be casted to it in any case.
206  *
207  * @since 0.6.2
208  */
209 typedef struct Iso_Special IsoSpecial;
210 
211 /**
212  * The type of an IsoNode.
213  *
214  * When an user gets an IsoNode from an image, (s)he can use
215  * iso_node_get_type() to get the current type of the node, and then
216  * cast to the appropriate subtype. For example:
217  *
218  * ...
219  * IsoNode *node;
220  * res = iso_dir_iter_next(iter, &node);
221  * if (res == 1 && iso_node_get_type(node) == LIBISO_DIR) {
222  * IsoDir *dir = (IsoDir *)node;
223  * ...
224  * }
225  *
226  * @since 0.6.2
227  */
234 };
235 
236 /* macros to check node type */
237 #define ISO_NODE_IS_DIR(n) (iso_node_get_type(n) == LIBISO_DIR)
238 #define ISO_NODE_IS_FILE(n) (iso_node_get_type(n) == LIBISO_FILE)
239 #define ISO_NODE_IS_SYMLINK(n) (iso_node_get_type(n) == LIBISO_SYMLINK)
240 #define ISO_NODE_IS_SPECIAL(n) (iso_node_get_type(n) == LIBISO_SPECIAL)
241 #define ISO_NODE_IS_BOOTCAT(n) (iso_node_get_type(n) == LIBISO_BOOT)
242 
243 /* macros for safe downcasting */
244 #define ISO_DIR(n) ((IsoDir*)(ISO_NODE_IS_DIR(n) ? n : NULL))
245 #define ISO_FILE(n) ((IsoFile*)(ISO_NODE_IS_FILE(n) ? n : NULL))
246 #define ISO_SYMLINK(n) ((IsoSymlink*)(ISO_NODE_IS_SYMLINK(n) ? n : NULL))
247 #define ISO_SPECIAL(n) ((IsoSpecial*)(ISO_NODE_IS_SPECIAL(n) ? n : NULL))
248 
249 #define ISO_NODE(n) ((IsoNode*)n)
250 
251 /**
252  * File section in an old image.
253  *
254  * @since 0.6.8
255  */
257 {
258  uint32_t block;
259  uint32_t size;
260 };
261 
262 /* If you get here because of a compilation error like
263 
264  /usr/include/libisofs/libisofs.h:166: error:
265  expected specifier-qualifier-list before 'uint32_t'
266 
267  then see the paragraph above about the definition of uint32_t.
268 */
269 
270 
271 /**
272  * Context for iterate on directory children.
273  * @see iso_dir_get_children()
274  *
275  * @since 0.6.2
276  */
277 typedef struct Iso_Dir_Iter IsoDirIter;
278 
279 /**
280  * It represents an El-Torito boot image.
281  *
282  * @since 0.6.2
283  */
284 typedef struct el_torito_boot_image ElToritoBootImage;
285 
286 /**
287  * An special type of IsoNode that acts as a placeholder for an El-Torito
288  * boot catalog. Once written, it will appear as a regular file.
289  *
290  * @since 0.6.2
291  */
292 typedef struct Iso_Boot IsoBoot;
293 
294 /**
295  * Flag used to hide a file in the RR/ISO or Joliet tree.
296  *
297  * @see iso_node_set_hidden
298  * @since 0.6.2
299  */
301  /** Hide the node in the ECMA-119 / RR tree */
303  /** Hide the node in the Joliet tree, if Joliet extension are enabled */
305  /** Hide the node in the ISO-9660:1999 tree, if that format is enabled */
307 
308  /** Hide the node in the HFS+ tree, if that format is enabled.
309  @since 1.2.4
310  */
312 
313  /** Hide the node in the FAT tree, if that format is enabled.
314  @since 1.2.4
315  */
317 
318  /** With IsoNode and IsoBoot: Write data content even if the node is
319  * not visible in any tree.
320  * With directory nodes : Write data content of IsoNode and IsoBoot
321  * in the directory's tree unless they are
322  * explicitely marked LIBISO_HIDE_ON_RR
323  * without LIBISO_HIDE_BUT_WRITE.
324  * @since 0.6.34
325  */
327 };
328 
329 /**
330  * El-Torito bootable image type.
331  *
332  * @since 0.6.2
333  */
338 };
339 
340 /**
341  * Replace mode used when addding a node to a directory.
342  * This controls how libisofs will act when you tried to add to a dir a file
343  * with the same name that an existing file.
344  *
345  * @since 0.6.2
346  */
348  /**
349  * Never replace an existing node, and instead fail with
350  * ISO_NODE_NAME_NOT_UNIQUE.
351  */
353  /**
354  * Always replace the old node with the new.
355  */
357  /**
358  * Replace with the new node if it is the same file type
359  */
361  /**
362  * Replace with the new node if it is the same file type and its ctime
363  * is newer than the old one.
364  */
366  /**
367  * Replace with the new node if its ctime is newer than the old one.
368  */
370  /*
371  * TODO #00006 define more values
372  * -if both are dirs, add contents (and what to do with conflicts?)
373  */
374 };
375 
376 /**
377  * Options for image written.
378  * @see iso_write_opts_new()
379  * @since 0.6.2
380  */
381 typedef struct iso_write_opts IsoWriteOpts;
382 
383 /**
384  * Options for image reading or import.
385  * @see iso_read_opts_new()
386  * @since 0.6.2
387  */
388 typedef struct iso_read_opts IsoReadOpts;
389 
390 /**
391  * Source for image reading.
392  *
393  * @see struct iso_data_source
394  * @since 0.6.2
395  */
397 
398 /**
399  * Data source used by libisofs for reading an existing image.
400  *
401  * It offers homogeneous read access to arbitrary blocks to different sources
402  * for images, such as .iso files, CD/DVD drives, etc...
403  *
404  * To create a multisession image, libisofs needs a IsoDataSource, that the
405  * user must provide. The function iso_data_source_new_from_file() constructs
406  * an IsoDataSource that uses POSIX I/O functions to access data. You can use
407  * it with regular .iso images, and also with block devices that represent a
408  * drive.
409  *
410  * @since 0.6.2
411  */
413 {
414 
415  /* reserved for future usage, set to 0 */
416  int version;
417 
418  /**
419  * Reference count for the data source. Should be 1 when a new source
420  * is created. Don't access it directly, but with iso_data_source_ref()
421  * and iso_data_source_unref() functions.
422  */
423  unsigned int refcount;
424 
425  /**
426  * Opens the given source. You must open() the source before any attempt
427  * to read data from it. The open is the right place for grabbing the
428  * underlying resources.
429  *
430  * @return
431  * 1 if success, < 0 on error (has to be a valid libisofs error code)
432  */
433  int (*open)(IsoDataSource *src);
434 
435  /**
436  * Close a given source, freeing all system resources previously grabbed in
437  * open().
438  *
439  * @return
440  * 1 if success, < 0 on error (has to be a valid libisofs error code)
441  */
442  int (*close)(IsoDataSource *src);
443 
444  /**
445  * Read an arbitrary block (2048 bytes) of data from the source.
446  *
447  * @param lba
448  * Block to be read.
449  * @param buffer
450  * Buffer where the data will be written. It should have at least
451  * 2048 bytes.
452  * @return
453  * 1 if success,
454  * < 0 if error. This function has to emit a valid libisofs error code.
455  * Predifined (but not mandatory) for this purpose are:
456  * ISO_DATA_SOURCE_SORRY , ISO_DATA_SOURCE_MISHAP,
457  * ISO_DATA_SOURCE_FAILURE , ISO_DATA_SOURCE_FATAL
458  */
459  int (*read_block)(IsoDataSource *src, uint32_t lba, uint8_t *buffer);
460 
461  /**
462  * Clean up the source specific data. Never call this directly, it is
463  * automatically called by iso_data_source_unref() when refcount reach
464  * 0.
465  */
466  void (*free_data)(IsoDataSource *src);
467 
468  /** Source specific data */
469  void *data;
470 };
471 
472 /**
473  * Return information for image. This is optionally allocated by libisofs,
474  * as a way to inform user about the features of an existing image, such as
475  * extensions present, size, ...
476  *
477  * @see iso_image_import()
478  * @since 0.6.2
479  */
480 typedef struct iso_read_image_features IsoReadImageFeatures;
481 
482 /**
483  * POSIX abstraction for source files.
484  *
485  * @see struct iso_file_source
486  * @since 0.6.2
487  */
489 
490 /**
491  * Abstract for source filesystems.
492  *
493  * @see struct iso_filesystem
494  * @since 0.6.2
495  */
497 
498 /**
499  * Interface that defines the operations (methods) available for an
500  * IsoFileSource.
501  *
502  * @see struct IsoFileSource_Iface
503  * @since 0.6.2
504  */
506 
507 /**
508  * IsoFilesystem implementation to deal with ISO images, and to offer a way to
509  * access specific information of the image, such as several volume attributes,
510  * extensions being used, El-Torito artifacts...
511  *
512  * @since 0.6.2
513  */
515 
516 /**
517  * See IsoFilesystem->get_id() for info about this.
518  * @since 0.6.2
519  */
520 extern unsigned int iso_fs_global_id;
521 
522 /**
523  * An IsoFilesystem is a handler for a source of files, or a "filesystem".
524  * That is defined as a set of files that are organized in a hierarchical
525  * structure.
526  *
527  * A filesystem allows libisofs to access files from several sources in
528  * an homogeneous way, thus abstracting the underlying operations needed to
529  * access and read file contents. Note that this doesn't need to be tied
530  * to the disc filesystem used in the partition being accessed. For example,
531  * we have an IsoFilesystem implementation to access any mounted filesystem,
532  * using standard POSIX functions. It is also legal, of course, to implement
533  * an IsoFilesystem to deal with a specific filesystem over raw partitions.
534  * That is what we do, for example, to access an ISO Image.
535  *
536  * Each file inside an IsoFilesystem is represented as an IsoFileSource object,
537  * that defines POSIX-like interface for accessing files.
538  *
539  * @since 0.6.2
540  */
542 {
543  /**
544  * Type of filesystem.
545  * "file" -> local filesystem
546  * "iso " -> iso image filesystem
547  */
548  char type[4];
549 
550  /* reserved for future usage, set to 0 */
551  int version;
552 
553  /**
554  * Get the root of a filesystem.
555  *
556  * @return
557  * 1 on success, < 0 on error (has to be a valid libisofs error code)
558  */
559  int (*get_root)(IsoFilesystem *fs, IsoFileSource **root);
560 
561  /**
562  * Retrieve a file from its absolute path inside the filesystem.
563  * @param file
564  * Returns a pointer to a IsoFileSource object representing the
565  * file. It has to be disposed by iso_file_source_unref() when
566  * no longer needed.
567  * @return
568  * 1 success, < 0 error (has to be a valid libisofs error code)
569  * Error codes:
570  * ISO_FILE_ACCESS_DENIED
571  * ISO_FILE_BAD_PATH
572  * ISO_FILE_DOESNT_EXIST
573  * ISO_OUT_OF_MEM
574  * ISO_FILE_ERROR
575  * ISO_NULL_POINTER
576  */
577  int (*get_by_path)(IsoFilesystem *fs, const char *path,
578  IsoFileSource **file);
579 
580  /**
581  * Get filesystem identifier.
582  *
583  * If the filesystem is able to generate correct values of the st_dev
584  * and st_ino fields for the struct stat of each file, this should
585  * return an unique number, greater than 0.
586  *
587  * To get a identifier for your filesystem implementation you should
588  * use iso_fs_global_id, incrementing it by one each time.
589  *
590  * Otherwise, if you can't ensure values in the struct stat are valid,
591  * this should return 0.
592  */
593  unsigned int (*get_id)(IsoFilesystem *fs);
594 
595  /**
596  * Opens the filesystem for several read operations. Calling this funcion
597  * is not needed at all, each time that the underlying system resource
598  * needs to be accessed, it is openned propertly.
599  * However, if you plan to execute several operations on the filesystem,
600  * it is a good idea to open it previously, to prevent several open/close
601  * operations to occur.
602  *
603  * @return 1 on success, < 0 on error (has to be a valid libisofs error code)
604  */
605  int (*open)(IsoFilesystem *fs);
606 
607  /**
608  * Close the filesystem, thus freeing all system resources. You should
609  * call this function if you have previously open() it.
610  * Note that you can open()/close() a filesystem several times.
611  *
612  * @return 1 on success, < 0 on error (has to be a valid libisofs error code)
613  */
614  int (*close)(IsoFilesystem *fs);
615 
616  /**
617  * Free implementation specific data. Should never be called by user.
618  * Use iso_filesystem_unref() instead.
619  */
620  void (*free)(IsoFilesystem *fs);
621 
622  /* internal usage, do never access them directly */
623  unsigned int refcount;
624  void *data;
625 };
626 
627 /**
628  * Interface definition for an IsoFileSource. Defines the POSIX-like function
629  * to access files and abstract underlying source.
630  *
631  * @since 0.6.2
632  */
634 {
635  /**
636  * Tells the version of the interface:
637  * Version 0 provides functions up to (*lseek)().
638  * @since 0.6.2
639  * Version 1 additionally provides function *(get_aa_string)().
640  * @since 0.6.14
641  * Version 2 additionally provides function *(clone_src)().
642  * @since 1.0.2
643  */
644  int version;
645 
646  /**
647  * Get the absolute path in the filesystem this file source belongs to.
648  *
649  * @return
650  * the path of the FileSource inside the filesystem, it should be
651  * freed when no more needed.
652  */
653  char* (*get_path)(IsoFileSource *src);
654 
655  /**
656  * Get the name of the file, with the dir component of the path.
657  *
658  * @return
659  * the name of the file, it should be freed when no more needed.
660  */
661  char* (*get_name)(IsoFileSource *src);
662 
663  /**
664  * Get information about the file. It is equivalent to lstat(2).
665  *
666  * @return
667  * 1 success, < 0 error (has to be a valid libisofs error code)
668  * Error codes:
669  * ISO_FILE_ACCESS_DENIED
670  * ISO_FILE_BAD_PATH
671  * ISO_FILE_DOESNT_EXIST
672  * ISO_OUT_OF_MEM
673  * ISO_FILE_ERROR
674  * ISO_NULL_POINTER
675  */
676  int (*lstat)(IsoFileSource *src, struct stat *info);
677 
678  /**
679  * Get information about the file. If the file is a symlink, the info
680  * returned refers to the destination. It is equivalent to stat(2).
681  *
682  * @return
683  * 1 success, < 0 error
684  * Error codes:
685  * ISO_FILE_ACCESS_DENIED
686  * ISO_FILE_BAD_PATH
687  * ISO_FILE_DOESNT_EXIST
688  * ISO_OUT_OF_MEM
689  * ISO_FILE_ERROR
690  * ISO_NULL_POINTER
691  */
692  int (*stat)(IsoFileSource *src, struct stat *info);
693 
694  /**
695  * Check if the process has access to read file contents. Note that this
696  * is not necessarily related with (l)stat functions. For example, in a
697  * filesystem implementation to deal with an ISO image, if the user has
698  * read access to the image it will be able to read all files inside it,
699  * despite of the particular permission of each file in the RR tree, that
700  * are what the above functions return.
701  *
702  * @return
703  * 1 if process has read access, < 0 on error (has to be a valid
704  * libisofs error code)
705  * Error codes:
706  * ISO_FILE_ACCESS_DENIED
707  * ISO_FILE_BAD_PATH
708  * ISO_FILE_DOESNT_EXIST
709  * ISO_OUT_OF_MEM
710  * ISO_FILE_ERROR
711  * ISO_NULL_POINTER
712  */
713  int (*access)(IsoFileSource *src);
714 
715  /**
716  * Opens the source.
717  * @return 1 on success, < 0 on error (has to be a valid libisofs error code)
718  * Error codes:
719  * ISO_FILE_ALREADY_OPENED
720  * ISO_FILE_ACCESS_DENIED
721  * ISO_FILE_BAD_PATH
722  * ISO_FILE_DOESNT_EXIST
723  * ISO_OUT_OF_MEM
724  * ISO_FILE_ERROR
725  * ISO_NULL_POINTER
726  */
727  int (*open)(IsoFileSource *src);
728 
729  /**
730  * Close a previuously openned file
731  * @return 1 on success, < 0 on error
732  * Error codes:
733  * ISO_FILE_ERROR
734  * ISO_NULL_POINTER
735  * ISO_FILE_NOT_OPENED
736  */
737  int (*close)(IsoFileSource *src);
738 
739  /**
740  * Attempts to read up to count bytes from the given source into
741  * the buffer starting at buf.
742  *
743  * The file src must be open() before calling this, and close() when no
744  * more needed. Not valid for dirs. On symlinks it reads the destination
745  * file.
746  *
747  * @return
748  * number of bytes read, 0 if EOF, < 0 on error (has to be a valid
749  * libisofs error code)
750  * Error codes:
751  * ISO_FILE_ERROR
752  * ISO_NULL_POINTER
753  * ISO_FILE_NOT_OPENED
754  * ISO_WRONG_ARG_VALUE -> if count == 0
755  * ISO_FILE_IS_DIR
756  * ISO_OUT_OF_MEM
757  * ISO_INTERRUPTED
758  */
759  int (*read)(IsoFileSource *src, void *buf, size_t count);
760 
761  /**
762  * Read a directory.
763  *
764  * Each call to this function will return a new children, until we reach
765  * the end of file (i.e, no more children), in that case it returns 0.
766  *
767  * The dir must be open() before calling this, and close() when no more
768  * needed. Only valid for dirs.
769  *
770  * Note that "." and ".." children MUST NOT BE returned.
771  *
772  * @param child
773  * pointer to be filled with the given child. Undefined on error or OEF
774  * @return
775  * 1 on success, 0 if EOF (no more children), < 0 on error (has to be
776  * a valid libisofs error code)
777  * Error codes:
778  * ISO_FILE_ERROR
779  * ISO_NULL_POINTER
780  * ISO_FILE_NOT_OPENED
781  * ISO_FILE_IS_NOT_DIR
782  * ISO_OUT_OF_MEM
783  */
784  int (*readdir)(IsoFileSource *src, IsoFileSource **child);
785 
786  /**
787  * Read the destination of a symlink. You don't need to open the file
788  * to call this.
789  *
790  * @param buf
791  * allocated buffer of at least bufsiz bytes.
792  * The dest. will be copied there, and it will be NULL-terminated
793  * @param bufsiz
794  * characters to be copied. Destination link will be truncated if
795  * it is larger than given size. This include the 0x0 character.
796  * @return
797  * 1 on success, < 0 on error (has to be a valid libisofs error code)
798  * Error codes:
799  * ISO_FILE_ERROR
800  * ISO_NULL_POINTER
801  * ISO_WRONG_ARG_VALUE -> if bufsiz <= 0
802  * ISO_FILE_IS_NOT_SYMLINK
803  * ISO_OUT_OF_MEM
804  * ISO_FILE_BAD_PATH
805  * ISO_FILE_DOESNT_EXIST
806  *
807  */
808  int (*readlink)(IsoFileSource *src, char *buf, size_t bufsiz);
809 
810  /**
811  * Get the filesystem for this source. No extra ref is added, so you
812  * musn't unref the IsoFilesystem.
813  *
814  * @return
815  * The filesystem, NULL on error
816  */
817  IsoFilesystem* (*get_filesystem)(IsoFileSource *src);
818 
819  /**
820  * Free implementation specific data. Should never be called by user.
821  * Use iso_file_source_unref() instead.
822  */
823  void (*free)(IsoFileSource *src);
824 
825  /**
826  * Repositions the offset of the IsoFileSource (must be opened) to the
827  * given offset according to the value of flag.
828  *
829  * @param offset
830  * in bytes
831  * @param flag
832  * 0 The offset is set to offset bytes (SEEK_SET)
833  * 1 The offset is set to its current location plus offset bytes
834  * (SEEK_CUR)
835  * 2 The offset is set to the size of the file plus offset bytes
836  * (SEEK_END).
837  * @return
838  * Absolute offset position of the file, or < 0 on error. Cast the
839  * returning value to int to get a valid libisofs error.
840  *
841  * @since 0.6.4
842  */
843  off_t (*lseek)(IsoFileSource *src, off_t offset, int flag);
844 
845  /* Add-ons of .version 1 begin here */
846 
847  /**
848  * Valid only if .version is > 0. See above.
849  * Get the AAIP string with encoded ACL and xattr.
850  * (Not to be confused with ECMA-119 Extended Attributes).
851  *
852  * bit1 and bit2 of flag should be implemented so that freshly fetched
853  * info does not include the undesired ACL or xattr. Nevertheless if the
854  * aa_string is cached, then it is permissible that ACL and xattr are still
855  * delivered.
856  *
857  * @param flag Bitfield for control purposes
858  * bit0= Transfer ownership of AAIP string data.
859  * src will free the eventual cached data and might
860  * not be able to produce it again.
861  * bit1= No need to get ACL (no guarantee of exclusion)
862  * bit2= No need to get xattr (no guarantee of exclusion)
863  * @param aa_string Returns a pointer to the AAIP string data. If no AAIP
864  * string is available, *aa_string becomes NULL.
865  * (See doc/susp_aaip_*_*.txt for the meaning of AAIP and
866  * libisofs/aaip_0_2.h for encoding and decoding.)
867  * The caller is responsible for finally calling free()
868  * on non-NULL results.
869  * @return 1 means success (*aa_string == NULL is possible)
870  * 2 means success, but it is possible that attributes
871  * exist in non-user namespaces which could not be
872  * explored due to lack of permission.
873  * @since 1.5.0
874  * <0 means failure and must b a valid libisofs error code
875  * (e.g. ISO_FILE_ERROR if no better one can be found).
876  * @since 0.6.14
877  */
879  unsigned char **aa_string, int flag);
880 
881  /**
882  * Produce a copy of a source. It must be possible to operate both source
883  * objects concurrently.
884  *
885  * @param old_src
886  * The existing source object to be copied
887  * @param new_stream
888  * Will return a pointer to the copy
889  * @param flag
890  * Bitfield for control purposes. Submit 0 for now.
891  * The function shall return ISO_STREAM_NO_CLONE on unknown flag bits.
892  *
893  * @since 1.0.2
894  * Present if .version is 2 or higher.
895  */
896  int (*clone_src)(IsoFileSource *old_src, IsoFileSource **new_src,
897  int flag);
898 
899  /*
900  * TODO #00004 Add a get_mime_type() function.
901  * This can be useful for GUI apps, to choose the icon of the file
902  */
903 };
904 
905 #ifndef __cplusplus
906 #ifndef Libisofs_h_as_cpluspluS
907 
908 /**
909  * An IsoFile Source is a POSIX abstraction of a file.
910  *
911  * @since 0.6.2
912  */
914 {
915  const IsoFileSourceIface *class;
916  int refcount;
917  void *data;
918 };
919 
920 #endif /* ! Libisofs_h_as_cpluspluS */
921 #endif /* ! __cplusplus */
922 
923 
924 /* A class of IsoStream is implemented by a class description
925  * IsoStreamIface = struct IsoStream_Iface
926  * and a structure of data storage for each instance of IsoStream.
927  * This structure shall be known to the functions of the IsoStreamIface.
928  * To create a custom IsoStream class:
929  * - Define the structure of the custom instance data.
930  * - Implement the methods which are described by the definition of
931  * struct IsoStream_Iface (see below),
932  * - Create a static instance of IsoStreamIface which lists the methods as
933  * C function pointers. (Example in libisofs/stream.c : fsrc_stream_class)
934  * To create an instance of that class:
935  * - Allocate sizeof(IsoStream) bytes of memory and initialize it as
936  * struct iso_stream :
937  * - Point to the custom IsoStreamIface by member .class .
938  * - Set member .refcount to 1.
939  * - Let member .data point to the custom instance data.
940  *
941  * Regrettably the choice of the structure member name "class" makes it
942  * impossible to implement this generic interface in C++ language directly.
943  * If C++ is absolutely necessary then you will have to make own copies
944  * of the public API structures. Use other names but take care to maintain
945  * the same memory layout.
946  */
947 
948 /**
949  * Representation of file contents. It is an stream of bytes, functionally
950  * like a pipe.
951  *
952  * @since 0.6.4
953  */
954 typedef struct iso_stream IsoStream;
955 
956 /**
957  * Interface that defines the operations (methods) available for an
958  * IsoStream.
959  *
960  * @see struct IsoStream_Iface
961  * @since 0.6.4
962  */
964 
965 /**
966  * Serial number to be used when you can't get a valid id for a Stream by other
967  * means. If you use this, both fs_id and dev_id should be set to 0.
968  * This must be incremented each time you get a reference to it.
969  *
970  * @see IsoStreamIface->get_id()
971  * @since 0.6.4
972  */
973 extern ino_t serial_id;
974 
975 /**
976  * Interface definition for IsoStream methods. It is public to allow
977  * implementation of own stream types.
978  * The methods defined here typically make use of stream.data which points
979  * to the individual state data of stream instances.
980  *
981  * @since 0.6.4
982  */
983 
985 {
986  /*
987  * Current version of the interface.
988  * Version 0 (since 0.6.4)
989  * deprecated but still valid.
990  * Version 1 (since 0.6.8)
991  * update_size() added.
992  * Version 2 (since 0.6.18)
993  * get_input_stream() added.
994  * A filter stream must have version 2 at least.
995  * Version 3 (since 0.6.20)
996  * cmp_ino() added.
997  * A filter stream should have version 3 at least.
998  * Version 4 (since 1.0.2)
999  * clone_stream() added.
1000  */
1001  int version;
1002 
1003  /**
1004  * Type of Stream.
1005  * "fsrc" -> Read from file source
1006  * "cout" -> Cut out interval from disk file
1007  * "mem " -> Read from memory
1008  * "boot" -> Boot catalog
1009  * "extf" -> External filter program
1010  * "ziso" -> zisofs compression
1011  * "osiz" -> zisofs uncompression
1012  * "gzip" -> gzip compression
1013  * "pizg" -> gzip uncompression (gunzip)
1014  * "user" -> User supplied stream
1015  */
1016  char type[4];
1017 
1018  /**
1019  * Opens the stream.
1020  *
1021  * @return
1022  * 1 on success, 2 file greater than expected, 3 file smaller than
1023  * expected, < 0 on error (has to be a valid libisofs error code)
1024  */
1025  int (*open)(IsoStream *stream);
1026 
1027  /**
1028  * Close the Stream.
1029  * @return
1030  * 1 on success, < 0 on error (has to be a valid libisofs error code)
1031  */
1032  int (*close)(IsoStream *stream);
1033 
1034  /**
1035  * Get the size (in bytes) of the stream. This function should always
1036  * return the same size, even if the underlying source size changes,
1037  * unless you call update_size() method.
1038  */
1039  off_t (*get_size)(IsoStream *stream);
1040 
1041  /**
1042  * Attempt to read up to count bytes from the given stream into
1043  * the buffer starting at buf. The implementation has to make sure that
1044  * either the full desired count of bytes is delivered or that the
1045  * next call to this function will return EOF or error.
1046  * I.e. only the last read block may be shorter than parameter count.
1047  *
1048  * The stream must be open() before calling this, and close() when no
1049  * more needed.
1050  *
1051  * @return
1052  * number of bytes read, 0 if EOF, < 0 on error (has to be a valid
1053  * libisofs error code)
1054  */
1055  int (*read)(IsoStream *stream, void *buf, size_t count);
1056 
1057  /**
1058  * Tell whether this IsoStream can be read several times, with the same
1059  * results. For example, a regular file is repeatable, you can read it
1060  * as many times as you want. However, a pipe is not.
1061  *
1062  * @return
1063  * 1 if stream is repeatable, 0 if not,
1064  * < 0 on error (has to be a valid libisofs error code)
1065  */
1066  int (*is_repeatable)(IsoStream *stream);
1067 
1068  /**
1069  * Get an unique identifier for the IsoStream.
1070  */
1071  void (*get_id)(IsoStream *stream, unsigned int *fs_id, dev_t *dev_id,
1072  ino_t *ino_id);
1073 
1074  /**
1075  * Free implementation specific data. Should never be called by user.
1076  * Use iso_stream_unref() instead.
1077  */
1078  void (*free)(IsoStream *stream);
1079 
1080  /**
1081  * Update the size of the IsoStream with the current size of the underlying
1082  * source, if the source is prone to size changes. After calling this,
1083  * get_size() shall eventually return the new size.
1084  * This will never be called after iso_image_create_burn_source() was
1085  * called and before the image was completely written.
1086  * (The API call to update the size of all files in the image is
1087  * iso_image_update_sizes()).
1088  *
1089  * @return
1090  * 1 if ok, < 0 on error (has to be a valid libisofs error code)
1091  *
1092  * @since 0.6.8
1093  * Present if .version is 1 or higher.
1094  */
1095  int (*update_size)(IsoStream *stream);
1096 
1097  /**
1098  * Retrieve the eventual input stream of a filter stream.
1099  *
1100  * @param stream
1101  * The eventual filter stream to be inquired.
1102  * @param flag
1103  * Bitfield for control purposes. 0 means normal behavior.
1104  * @return
1105  * The input stream, if one exists. Elsewise NULL.
1106  * No extra reference to the stream shall be taken by this call.
1107  *
1108  * @since 0.6.18
1109  * Present if .version is 2 or higher.
1110  */
1111  IsoStream *(*get_input_stream)(IsoStream *stream, int flag);
1112 
1113  /**
1114  * Compare two streams whether they are based on the same input and will
1115  * produce the same output. If in any doubt, then this comparison should
1116  * indicate no match. A match might allow hardlinking of IsoFile objects.
1117  *
1118  * A pointer value of NULL is permissible. In this case, function
1119  * iso_stream_cmp_ino() will decide on its own.
1120  *
1121  * If not NULL, this function .cmp_ino() will be called by
1122  * iso_stream_cmp_ino() if both compared streams point to it, and if not
1123  * flag bit0 of iso_stream_cmp_ino() prevents it.
1124  * So a .cmp_ino() function must be able to compare any pair of streams
1125  * which name it as their .cmp_ino(). A fallback to iso_stream_cmp_ino(,,1)
1126  * would endanger transitivity of iso_stream_cmp_ino(,,0).
1127  *
1128  * With filter streams, the decision whether the underlying chains of
1129  * streams match, should be delegated to
1130  * iso_stream_cmp_ino(iso_stream_get_input_stream(s1, 0),
1131  * iso_stream_get_input_stream(s2, 0), 0);
1132  *
1133  * The stream.cmp_ino() function has to establish an equivalence and order
1134  * relation:
1135  * cmp_ino(A,A) == 0
1136  * cmp_ino(A,B) == -cmp_ino(B,A)
1137  * if cmp_ino(A,B) == 0 && cmp_ino(B,C) == 0 then cmp_ino(A,C) == 0
1138  * Most tricky is the demand for transitivity:
1139  * if cmp_ino(A,B) < 0 && cmp_ino(B,C) < 0 then cmp_ino(A,C) < 0
1140  *
1141  * @param s1
1142  * The first stream to compare. Expect foreign stream types.
1143  * @param s2
1144  * The second stream to compare. Expect foreign stream types.
1145  * @return
1146  * -1 if s1 is smaller s2 , 0 if s1 matches s2 , 1 if s1 is larger s2
1147  *
1148  * @since 0.6.20
1149  * Present if .version is 3 or higher.
1150  */
1151  int (*cmp_ino)(IsoStream *s1, IsoStream *s2);
1152 
1153  /**
1154  * Produce a copy of a stream. It must be possible to operate both stream
1155  * objects concurrently.
1156  *
1157  * @param old_stream
1158  * The existing stream object to be copied
1159  * @param new_stream
1160  * Will return a pointer to the copy
1161  * @param flag
1162  * Bitfield for control purposes. 0 means normal behavior.
1163  * The function shall return ISO_STREAM_NO_CLONE on unknown flag bits.
1164  * @return
1165  * 1 in case of success, or an error code < 0
1166  *
1167  * @since 1.0.2
1168  * Present if .version is 4 or higher.
1169  */
1170  int (*clone_stream)(IsoStream *old_stream, IsoStream **new_stream,
1171  int flag);
1172 
1173 };
1174 
1175 #ifndef __cplusplus
1176 #ifndef Libisofs_h_as_cpluspluS
1177 
1178 /**
1179  * Representation of file contents as a stream of bytes.
1180  *
1181  * @since 0.6.4
1182  */
1184 {
1187  void *data;
1188 };
1189 
1190 #endif /* ! Libisofs_h_as_cpluspluS */
1191 #endif /* ! __cplusplus */
1192 
1193 
1194 /**
1195  * Initialize libisofs. Before any usage of the library you must either call
1196  * this function or iso_init_with_flag().
1197  * Only exception from this rule: iso_lib_version(), iso_lib_is_compatible().
1198  * @return 1 on success, < 0 on error
1199  *
1200  * @since 0.6.2
1201  */
1202 int iso_init();
1203 
1204 /**
1205  * Initialize libisofs. Before any usage of the library you must either call
1206  * this function or iso_init() which is equivalent to iso_init_with_flag(0).
1207  * Only exception from this rule: iso_lib_version(), iso_lib_is_compatible().
1208  * @param flag
1209  * Bitfield for control purposes
1210  * bit0= do not set up locale by LC_* environment variables
1211  * @return 1 on success, < 0 on error
1212  *
1213  * @since 0.6.18
1214  */
1215 int iso_init_with_flag(int flag);
1216 
1217 /**
1218  * Finalize libisofs.
1219  *
1220  * @since 0.6.2
1221  */
1222 void iso_finish();
1223 
1224 /**
1225  * Override the reply of libc function nl_langinfo(CODESET) which may or may
1226  * not give the name of the character set which is in effect for your
1227  * environment. So this call can compensate for inconsistent terminal setups.
1228  * Another use case is to choose UTF-8 as intermediate character set for a
1229  * conversion from an exotic input character set to an exotic output set.
1230  *
1231  * @param name
1232  * Name of the character set to be assumed as "local" one.
1233  * @param flag
1234  * Unused yet. Submit 0.
1235  * @return
1236  * 1 indicates success, <=0 failure
1237  *
1238  * @since 0.6.12
1239  */
1240 int iso_set_local_charset(char *name, int flag);
1241 
1242 /**
1243  * Obtain the local charset as currently assumed by libisofs.
1244  * The result points to internal memory. It is volatile and must not be
1245  * altered.
1246  *
1247  * @param flag
1248  * Unused yet. Submit 0.
1249  *
1250  * @since 0.6.12
1251  */
1252 char *iso_get_local_charset(int flag);
1253 
1254 /**
1255  * Create a new image, empty.
1256  *
1257  * The image will be owned by you and should be unref() when no more needed.
1258  *
1259  * @param name
1260  * Name of the image. This will be used as volset_id and volume_id.
1261  * @param image
1262  * Location where the image pointer will be stored.
1263  * @return
1264  * 1 success, < 0 error
1265  *
1266  * @since 0.6.2
1267  */
1268 int iso_image_new(const char *name, IsoImage **image);
1269 
1270 
1271 /**
1272  * Control whether ACL and xattr will be imported from external filesystems
1273  * (typically the local POSIX filesystem) when new nodes get inserted. If
1274  * enabled by iso_write_opts_set_aaip() they will later be written into the
1275  * image as AAIP extension fields.
1276  *
1277  * A change of this setting does neither affect existing IsoNode objects
1278  * nor the way how ACL and xattr are handled when loading an ISO image.
1279  * The latter is controlled by iso_read_opts_set_no_aaip().
1280  *
1281  * @param image
1282  * The image of which the behavior is to be controlled
1283  * @param what
1284  * A bit field which sets the behavior:
1285  * bit0= ignore ACLs if the external file object bears some
1286  * bit1= ignore xattr if the external file object bears some
1287  * bit3= if not bit1: import all xattr namespaces, not only "user."
1288  * @since 1.5.0
1289  * all other bits are reserved
1290  *
1291  * @since 0.6.14
1292  */
1293 void iso_image_set_ignore_aclea(IsoImage *image, int what);
1294 
1295 
1296 /**
1297  * Obtain the current setting of iso_image_set_ignore_aclea().
1298  *
1299  * @param image
1300  * The image to be inquired
1301  * @return
1302  * The currently set value.
1303  *
1304  * @since 1.5.0
1305  */
1307 
1308 
1309 /**
1310  * Creates an IsoWriteOpts for writing an image. You should set the options
1311  * desired with the correspondent setters.
1312  *
1313  * Options by default are determined by the selected profile. Fifo size is set
1314  * by default to 2 MB.
1315  *
1316  * @param opts
1317  * Pointer to the location where the newly created IsoWriteOpts will be
1318  * stored. You should free it with iso_write_opts_free() when no more
1319  * needed.
1320  * @param profile
1321  * Default profile for image creation. For now the following values are
1322  * defined:
1323  * ---> 0 [BASIC]
1324  * No extensions are enabled, and ISO level is set to 1. Only suitable
1325  * for usage for very old and limited systems (like MS-DOS), or by a
1326  * start point from which to set your custom options.
1327  * ---> 1 [BACKUP]
1328  * POSIX compatibility for backup. Simple settings, ISO level is set to
1329  * 3 and RR extensions are enabled. Useful for backup purposes.
1330  * Note that ACL and xattr are not enabled by default.
1331  * If you enable them, expect them not to show up in the mounted image.
1332  * They will have to be retrieved by libisofs applications like xorriso.
1333  * ---> 2 [DISTRIBUTION]
1334  * Setting for information distribution. Both RR and Joliet are enabled
1335  * to maximize compatibility with most systems. Permissions are set to
1336  * default values, and timestamps to the time of recording.
1337  * @return
1338  * 1 success, < 0 error
1339  *
1340  * @since 0.6.2
1341  */
1342 int iso_write_opts_new(IsoWriteOpts **opts, int profile);
1343 
1344 /**
1345  * Free an IsoWriteOpts previously allocated with iso_write_opts_new().
1346  *
1347  * @since 0.6.2
1348  */
1349 void iso_write_opts_free(IsoWriteOpts *opts);
1350 
1351 /**
1352  * Announce that only the image size is desired, that the struct burn_source
1353  * which is set to consume the image output stream will stay inactive,
1354  * and that the write thread will be cancelled anyway by the .cancel() method
1355  * of the struct burn_source.
1356  * This avoids to create a write thread which would begin production of the
1357  * image stream and would generate a MISHAP event when burn_source.cancel()
1358  * gets into effect.
1359  *
1360  * @param opts
1361  * The option set to be manipulated.
1362  * @param will_cancel
1363  * 0= normal image generation
1364  * 1= prepare for being canceled before image stream output is completed
1365  * @return
1366  * 1 success, < 0 error
1367  *
1368  * @since 0.6.40
1369  */
1370 int iso_write_opts_set_will_cancel(IsoWriteOpts *opts, int will_cancel);
1371 
1372 /**
1373  * Set the ISO-9960 level to write at.
1374  *
1375  * @param opts
1376  * The option set to be manipulated.
1377  * @param level
1378  * -> 1 for higher compatibility with old systems. With this level
1379  * filenames are restricted to 8.3 characters.
1380  * -> 2 to allow up to 31 filename characters.
1381  * -> 3 to allow files greater than 4GB
1382  * @return
1383  * 1 success, < 0 error
1384  *
1385  * @since 0.6.2
1386  */
1387 int iso_write_opts_set_iso_level(IsoWriteOpts *opts, int level);
1388 
1389 /**
1390  * Whether to use or not Rock Ridge extensions.
1391  *
1392  * This are standard extensions to ECMA-119, intended to add POSIX filesystem
1393  * features to ECMA-119 images. Thus, usage of this flag is highly recommended
1394  * for images used on GNU/Linux systems. With the usage of RR extension, the
1395  * resulting image will have long filenames (up to 255 characters), deeper
1396  * directory structure, POSIX permissions and owner info on files and
1397  * directories, support for symbolic links or special files... All that
1398  * attributes can be modified/set with the appropriate function.
1399  *
1400  * @param opts
1401  * The option set to be manipulated.
1402  * @param enable
1403  * 1 to enable RR extension, 0 to not add them
1404  * @return
1405  * 1 success, < 0 error
1406  *
1407  * @since 0.6.2
1408  */
1409 int iso_write_opts_set_rockridge(IsoWriteOpts *opts, int enable);
1410 
1411 /**
1412  * Whether to add the non-standard Joliet extension to the image.
1413  *
1414  * This extensions are heavily used in Microsoft Windows systems, so if you
1415  * plan to use your disc on such a system you should add this extension.
1416  * Usage of Joliet supplies longer filesystem length (up to 64 unicode
1417  * characters), and deeper directory structure.
1418  *
1419  * @param opts
1420  * The option set to be manipulated.
1421  * @param enable
1422  * 1 to enable Joliet extension, 0 to not add them
1423  * @return
1424  * 1 success, < 0 error
1425  *
1426  * @since 0.6.2
1427  */
1428 int iso_write_opts_set_joliet(IsoWriteOpts *opts, int enable);
1429 
1430 /**
1431  * Whether to add a HFS+ filesystem to the image which points to the same
1432  * file content as the other directory trees.
1433  * It will get marked by an Apple Partition Map in the System Area of the ISO
1434  * image. This may collide with data submitted by
1435  * iso_write_opts_set_system_area()
1436  * and with settings made by
1437  * el_torito_set_isolinux_options()
1438  * The first 8 bytes of the System Area get overwritten by
1439  * {0x45, 0x52, 0x08 0x00, 0xeb, 0x02, 0xff, 0xff}
1440  * which can be executed as x86 machine code without negative effects.
1441  * So if an MBR gets combined with this feature, then its first 8 bytes
1442  * should contain no essential commands.
1443  * The next blocks of 2 KiB in the System Area will be occupied by APM entries.
1444  * The first one covers the part of the ISO image before the HFS+ filesystem
1445  * metadata. The second one marks the range from HFS+ metadata to the end
1446  * of file content data. If more ISO image data follow, then a third partition
1447  * entry gets produced. Other features of libisofs might cause the need for
1448  * more APM entries.
1449  *
1450  * @param opts
1451  * The option set to be manipulated.
1452  * @param enable
1453  * 1 to enable HFS+ extension, 0 to not add HFS+ metadata and APM
1454  * @return
1455  * 1 success, < 0 error
1456  *
1457  * @since 1.2.4
1458  */
1459 int iso_write_opts_set_hfsplus(IsoWriteOpts *opts, int enable);
1460 
1461 /**
1462  * >>> Production of FAT32 is not implemented yet.
1463  * >>> This call exists only as preparation for implementation.
1464  *
1465  * Whether to add a FAT32 filesystem to the image which points to the same
1466  * file content as the other directory trees.
1467  *
1468  * >>> FAT32 is planned to get implemented in co-existence with HFS+
1469  * >>> Describe impact on MBR
1470  *
1471  * @param opts
1472  * The option set to be manipulated.
1473  * @param enable
1474  * 1 to enable FAT32 extension, 0 to not add FAT metadata
1475  * @return
1476  * 1 success, < 0 error
1477  *
1478  * @since 1.2.4
1479  */
1480 int iso_write_opts_set_fat(IsoWriteOpts *opts, int enable);
1481 
1482 /**
1483  * Supply a serial number for the HFS+ extension of the emerging image.
1484  *
1485  * @param opts
1486  * The option set to be manipulated.
1487  * @param serial_number
1488  * 8 bytes which should be unique to the image.
1489  * If all bytes are 0, then the serial number will be generated as
1490  * random number by libisofs. This is the default setting.
1491  * @return
1492  * 1 success, < 0 error
1493  *
1494  * @since 1.2.4
1495  */
1497  uint8_t serial_number[8]);
1498 
1499 /**
1500  * Set the block size for Apple Partition Map and for HFS+.
1501  *
1502  * @param opts
1503  * The option set to be manipulated.
1504  * @param hfsp_block_size
1505  * The allocation block size to be used by the HFS+ fileystem.
1506  * 0, 512, or 2048
1507  * @param apm_block_size
1508  * The block size to be used for and within the Apple Partition Map.
1509  * 0, 512, or 2048.
1510  * Size 512 is not compatible with options which produce GPT.
1511  * @return
1512  * 1 success, < 0 error
1513  *
1514  * @since 1.2.4
1515  */
1517  int hfsp_block_size, int apm_block_size);
1518 
1519 
1520 /**
1521  * Whether to use newer ISO-9660:1999 version.
1522  *
1523  * This is the second version of ISO-9660. It allows longer filenames and has
1524  * less restrictions than old ISO-9660. However, nobody is using it so there
1525  * are no much reasons to enable this.
1526  *
1527  * @since 0.6.2
1528  */
1529 int iso_write_opts_set_iso1999(IsoWriteOpts *opts, int enable);
1530 
1531 /**
1532  * Control generation of non-unique inode numbers for the emerging image.
1533  * Inode numbers get written as "file serial number" with PX entries as of
1534  * RRIP-1.12. They may mark families of hardlinks.
1535  * RRIP-1.10 prescribes a PX entry without file serial number. If not overriden
1536  * by iso_write_opts_set_rrip_1_10_px_ino() there will be no file serial number
1537  * written into RRIP-1.10 images.
1538  *
1539  * Inode number generation does not affect IsoNode objects which imported their
1540  * inode numbers from the old ISO image (see iso_read_opts_set_new_inos())
1541  * and which have not been altered since import. It rather applies to IsoNode
1542  * objects which were newly added to the image, or to IsoNode which brought no
1543  * inode number from the old image, or to IsoNode where certain properties
1544  * have been altered since image import.
1545  *
1546  * If two IsoNode are found with same imported inode number but differing
1547  * properties, then one of them will get assigned a new unique inode number.
1548  * I.e. the hardlink relation between both IsoNode objects ends.
1549  *
1550  * @param opts
1551  * The option set to be manipulated.
1552  * @param enable
1553  * 1 = Collect IsoNode objects which have identical data sources and
1554  * properties.
1555  * 0 = Generate unique inode numbers for all IsoNode objects which do not
1556  * have a valid inode number from an imported ISO image.
1557  * All other values are reserved.
1558  *
1559  * @since 0.6.20
1560  */
1561 int iso_write_opts_set_hardlinks(IsoWriteOpts *opts, int enable);
1562 
1563 /**
1564  * Control writing of AAIP informations for ACL and xattr.
1565  * For importing ACL and xattr when inserting nodes from external filesystems
1566  * (e.g. the local POSIX filesystem) see iso_image_set_ignore_aclea().
1567  * For loading of this information from images see iso_read_opts_set_no_aaip().
1568  *
1569  * @param opts
1570  * The option set to be manipulated.
1571  * @param enable
1572  * 1 = write AAIP information from nodes into the image
1573  * 0 = do not write AAIP information into the image
1574  * All other values are reserved.
1575  *
1576  * @since 0.6.14
1577  */
1578 int iso_write_opts_set_aaip(IsoWriteOpts *opts, int enable);
1579 
1580 /**
1581  * Use this only if you need to reproduce a suboptimal behavior of older
1582  * versions of libisofs. They used address 0 for links and device files,
1583  * and the address of the Volume Descriptor Set Terminator for empty data
1584  * files.
1585  * New versions let symbolic links, device files, and empty data files point
1586  * to a dedicated block of zero-bytes after the end of the directory trees.
1587  * (Single-pass reader libarchive needs to see all directory info before
1588  * processing any data files.)
1589  *
1590  * @param opts
1591  * The option set to be manipulated.
1592  * @param enable
1593  * 1 = use the suboptimal block addresses in the range of 0 to 115.
1594  * 0 = use the address of a block after the directory tree. (Default)
1595  *
1596  * @since 1.0.2
1597  */
1598 int iso_write_opts_set_old_empty(IsoWriteOpts *opts, int enable);
1599 
1600 /**
1601  * Caution: This option breaks any assumptions about names that
1602  * are supported by ECMA-119 specifications.
1603  * Try to omit any translation which would make a file name compliant to the
1604  * ECMA-119 rules. This includes and exceeds omit_version_numbers,
1605  * max_37_char_filenames, no_force_dots bit0, allow_full_ascii. Further it
1606  * prevents the conversion from local character set to ASCII.
1607  * The maximum name length is given by this call. If a filename exceeds
1608  * this length or cannot be recorded untranslated for other reasons, then
1609  * image production is aborted with ISO_NAME_NEEDS_TRANSL.
1610  * Currently the length limit is 96 characters, because an ECMA-119 directory
1611  * record may at most have 254 bytes and up to 158 other bytes must fit into
1612  * the record. Probably 96 more bytes can be made free for the name in future.
1613  * @param opts
1614  * The option set to be manipulated.
1615  * @param len
1616  * 0 = disable this feature and perform name translation according to
1617  * other settings.
1618  * >0 = Omit any translation. Eventually abort image production
1619  * if a name is longer than the given value.
1620  * -1 = Like >0. Allow maximum possible length (currently 96)
1621  * @return >=0 success, <0 failure
1622  * In case of >=0 the return value tells the effectively set len.
1623  * E.g. 96 after using len == -1.
1624  * @since 1.0.0
1625  */
1627 
1628 /**
1629  * Convert directory names for ECMA-119 similar to other file names, but do
1630  * not force a dot or add a version number.
1631  * This violates ECMA-119 by allowing one "." and especially ISO level 1
1632  * by allowing DOS style 8.3 names rather than only 8 characters.
1633  * (mkisofs and its clones seem to do this violation.)
1634  * @param opts
1635  * The option set to be manipulated.
1636  * @param allow
1637  * 1= allow dots , 0= disallow dots and convert them
1638  * @return
1639  * 1 success, < 0 error
1640  * @since 1.0.0
1641  */
1643 
1644 /**
1645  * Omit the version number (";1") at the end of the ISO-9660 identifiers.
1646  * This breaks ECMA-119 specification, but version numbers are usually not
1647  * used, so it should work on most systems. Use with caution.
1648  * @param opts
1649  * The option set to be manipulated.
1650  * @param omit
1651  * bit0= omit version number with ECMA-119 and Joliet
1652  * bit1= omit version number with Joliet alone (@since 0.6.30)
1653  * @since 0.6.2
1654  */
1656 
1657 /**
1658  * Allow ISO-9660 directory hierarchy to be deeper than 8 levels.
1659  * This breaks ECMA-119 specification. Use with caution.
1660  *
1661  * @since 0.6.2
1662  */
1664 
1665 /**
1666  * This call describes the directory where to store Rock Ridge relocated
1667  * directories.
1668  * If not iso_write_opts_set_allow_deep_paths(,1) is in effect, then it may
1669  * become necessary to relocate directories so that no ECMA-119 file path
1670  * has more than 8 components. These directories are grafted into either
1671  * the root directory of the ISO image or into a dedicated relocation
1672  * directory.
1673  * For Rock Ridge, the relocated directories are linked forth and back to
1674  * placeholders at their original positions in path level 8. Directories
1675  * marked by Rock Ridge entry RE are to be considered artefacts of relocation
1676  * and shall not be read into a Rock Ridge tree. Instead they are to be read
1677  * via their placeholders and their links.
1678  * For plain ECMA-119, the relocation directory and the relocated directories
1679  * are just normal directories which contain normal files and directories.
1680  * @param opts
1681  * The option set to be manipulated.
1682  * @param name
1683  * The name of the relocation directory in the root directory. Do not
1684  * prepend "/". An empty name or NULL will direct relocated directories
1685  * into the root directory. This is the default.
1686  * If the given name does not exist in the root directory when
1687  * iso_image_create_burn_source() is called, and if there are directories
1688  * at path level 8, then directory /name will be created automatically.
1689  * The name given by this call will be compared with iso_node_get_name()
1690  * of the directories in the root directory, not with the final ECMA-119
1691  * names of those directories.
1692  * @param flags
1693  * Bitfield for control purposes.
1694  * bit0= Mark the relocation directory by a Rock Ridge RE entry, if it
1695  * gets created during iso_image_create_burn_source(). This will
1696  * make it invisible for most Rock Ridge readers.
1697  * bit1= not settable via API (used internally)
1698  * @return
1699  * 1 success, < 0 error
1700  * @since 1.2.2
1701 */
1702 int iso_write_opts_set_rr_reloc(IsoWriteOpts *opts, char *name, int flags);
1703 
1704 /**
1705  * Allow path in the ISO-9660 tree to have more than 255 characters.
1706  * This breaks ECMA-119 specification. Use with caution.
1707  *
1708  * @since 0.6.2
1709  */
1711 
1712 /**
1713  * Allow a single file or directory identifier to have up to 37 characters.
1714  * This is larger than the 31 characters allowed by ISO level 2, and the
1715  * extra space is taken from the version number, so this also forces
1716  * omit_version_numbers.
1717  * This breaks ECMA-119 specification and could lead to buffer overflow
1718  * problems on old systems. Use with caution.
1719  *
1720  * @since 0.6.2
1721  */
1723 
1724 /**
1725  * ISO-9660 forces filenames to have a ".", that separates file name from
1726  * extension. libisofs adds it if original filename doesn't has one. Set
1727  * this to 1 to prevent this behavior.
1728  * This breaks ECMA-119 specification. Use with caution.
1729  *
1730  * @param opts
1731  * The option set to be manipulated.
1732  * @param no
1733  * bit0= no forced dot with ECMA-119
1734  * bit1= no forced dot with Joliet (@since 0.6.30)
1735  *
1736  * @since 0.6.2
1737  */
1739 
1740 /**
1741  * Allow lowercase characters in ISO-9660 filenames. By default, only
1742  * uppercase characters, numbers and a few other characters are allowed.
1743  * This breaks ECMA-119 specification. Use with caution.
1744  * If lowercase is not allowed then those letters get mapped to uppercase
1745  * letters.
1746  *
1747  * @since 0.6.2
1748  */
1749 int iso_write_opts_set_allow_lowercase(IsoWriteOpts *opts, int allow);
1750 
1751 /**
1752  * Allow all 8-bit characters to appear on an ISO-9660 filename. Note
1753  * that "/" and 0x0 characters are never allowed, even in RR names.
1754  * This breaks ECMA-119 specification. Use with caution.
1755  *
1756  * @since 0.6.2
1757  */
1759 
1760 /**
1761  * If not iso_write_opts_set_allow_full_ascii() is set to 1:
1762  * Allow all 7-bit characters that would be allowed by allow_full_ascii, but
1763  * map lowercase to uppercase if iso_write_opts_set_allow_lowercase()
1764  * is not set to 1.
1765  * @param opts
1766  * The option set to be manipulated.
1767  * @param allow
1768  * If not zero, then allow what is described above.
1769  *
1770  * @since 1.2.2
1771  */
1773 
1774 /**
1775  * Allow all characters to be part of Volume and Volset identifiers on
1776  * the Primary Volume Descriptor. This breaks ISO-9660 contraints, but
1777  * should work on modern systems.
1778  *
1779  * @since 0.6.2
1780  */
1782 
1783 /**
1784  * Allow paths in the Joliet tree to have more than 240 characters.
1785  * This breaks Joliet specification. Use with caution.
1786  *
1787  * @since 0.6.2
1788  */
1790 
1791 /**
1792  * Allow leaf names in the Joliet tree to have up to 103 characters.
1793  * Normal limit is 64.
1794  * This breaks Joliet specification. Use with caution.
1795  *
1796  * @since 1.0.6
1797  */
1799 
1800 /**
1801  * Use character set UTF-16BE with Joliet, which is a superset of the
1802  * actually prescribed character set UCS-2.
1803  * This breaks Joliet specification with exotic characters which would
1804  * elsewise be mapped to underscore '_'. Use with caution.
1805  *
1806  * @since 1.3.6
1807  */
1808 int iso_write_opts_set_joliet_utf16(IsoWriteOpts *opts, int allow);
1809 
1810 /**
1811  * Write Rock Ridge info as of specification RRIP-1.10 rather than RRIP-1.12:
1812  * signature "RRIP_1991A" rather than "IEEE_1282", field PX without file
1813  * serial number.
1814  *
1815  * @since 0.6.12
1816  */
1817 int iso_write_opts_set_rrip_version_1_10(IsoWriteOpts *opts, int oldvers);
1818 
1819 /**
1820  * Write field PX with file serial number (i.e. inode number) even if
1821  * iso_write_opts_set_rrip_version_1_10(,1) is in effect.
1822  * This clearly violates the RRIP-1.10 specs. But it is done by mkisofs since
1823  * a while and no widespread protest is visible in the web.
1824  * If this option is not enabled, then iso_write_opts_set_hardlinks() will
1825  * only have an effect with iso_write_opts_set_rrip_version_1_10(,0).
1826  *
1827  * @since 0.6.20
1828  */
1829 int iso_write_opts_set_rrip_1_10_px_ino(IsoWriteOpts *opts, int enable);
1830 
1831 /**
1832  * Write AAIP as extension according to SUSP 1.10 rather than SUSP 1.12.
1833  * I.e. without announcing it by an ER field and thus without the need
1834  * to precede the RRIP fields and the AAIP field by ES fields.
1835  * This saves 5 to 10 bytes per file and might avoid problems with readers
1836  * which dislike ER fields other than the ones for RRIP.
1837  * On the other hand, SUSP 1.12 frowns on such unannounced extensions
1838  * and prescribes ER and ES. It does this since the year 1994.
1839  *
1840  * In effect only if above iso_write_opts_set_aaip() enables writing of AAIP.
1841  *
1842  * @since 0.6.14
1843  */
1844 int iso_write_opts_set_aaip_susp_1_10(IsoWriteOpts *opts, int oldvers);
1845 
1846 /**
1847  * Store as ECMA-119 Directory Record timestamp the mtime of the source node
1848  * rather than the image creation time.
1849  * If storing of mtime is enabled, then the settings of
1850  * iso_write_opts_set_replace_timestamps() apply. (replace==1 will revoke,
1851  * replace==2 will override mtime by iso_write_opts_set_default_timestamp().
1852  *
1853  * Since version 1.2.0 this may apply also to Joliet and ISO 9660:1999. To
1854  * reduce the probability of unwanted behavior changes between pre-1.2.0 and
1855  * post-1.2.0, the bits for Joliet and ISO 9660:1999 also enable ECMA-119.
1856  * The hopefully unlikely bit14 may then be used to disable mtime for ECMA-119.
1857  *
1858  * To enable mtime for all three directory trees, submit 7.
1859  * To disable this feature completely, submit 0.
1860  *
1861  * @param opts
1862  * The option set to be manipulated.
1863  * @param allow
1864  * If this parameter is negative, then mtime is enabled only for ECMA-119.
1865  * With positive numbers, the parameter is interpreted as bit field :
1866  * bit0= enable mtime for ECMA-119
1867  * bit1= enable mtime for Joliet and ECMA-119
1868  * bit2= enable mtime for ISO 9660:1999 and ECMA-119
1869  * bit14= disable mtime for ECMA-119 although some of the other bits
1870  * would enable it
1871  * @since 1.2.0
1872  * Before version 1.2.0 this applied only to ECMA-119 :
1873  * 0 stored image creation time in ECMA-119 tree.
1874  * Any other value caused storing of mtime.
1875  * Joliet and ISO 9660:1999 always stored the image creation time.
1876  * @since 0.6.12
1877  */
1878 int iso_write_opts_set_dir_rec_mtime(IsoWriteOpts *opts, int allow);
1879 
1880 /**
1881  * Whether to sort files based on their weight.
1882  *
1883  * @see iso_node_set_sort_weight
1884  * @since 0.6.2
1885  */
1886 int iso_write_opts_set_sort_files(IsoWriteOpts *opts, int sort);
1887 
1888 /**
1889  * Whether to compute and record MD5 checksums for the whole session and/or
1890  * for each single IsoFile object. The checksums represent the data as they
1891  * were written into the image output stream, not necessarily as they were
1892  * on hard disk at any point of time.
1893  * See also calls iso_image_get_session_md5() and iso_file_get_md5().
1894  * @param opts
1895  * The option set to be manipulated.
1896  * @param session
1897  * If bit0 set: Compute session checksum
1898  * @param files
1899  * If bit0 set: Compute a checksum for each single IsoFile object which
1900  * gets its data content written into the session. Copy
1901  * checksums from files which keep their data in older
1902  * sessions.
1903  * If bit1 set: Check content stability (only with bit0). I.e. before
1904  * writing the file content into to image stream, read it
1905  * once and compute a MD5. Do a second reading for writing
1906  * into the image stream. Afterwards compare both MD5 and
1907  * issue a MISHAP event ISO_MD5_STREAM_CHANGE if they do not
1908  * match.
1909  * Such a mismatch indicates content changes between the
1910  * time point when the first MD5 reading started and the
1911  * time point when the last block was read for writing.
1912  * So there is high risk that the image stream was fed from
1913  * changing and possibly inconsistent file content.
1914  *
1915  * @since 0.6.22
1916  */
1917 int iso_write_opts_set_record_md5(IsoWriteOpts *opts, int session, int files);
1918 
1919 /**
1920  * Set the parameters "name" and "timestamp" for a scdbackup checksum tag.
1921  * It will be appended to the libisofs session tag if the image starts at
1922  * LBA 0 (see iso_write_opts_set_ms_block()). The scdbackup tag can be used
1923  * to verify the image by command scdbackup_verify device -auto_end.
1924  * See scdbackup/README appendix VERIFY for its inner details.
1925  *
1926  * @param opts
1927  * The option set to be manipulated.
1928  * @param name
1929  * A word of up to 80 characters. Typically volno_totalno telling
1930  * that this is volume volno of a total of totalno volumes.
1931  * @param timestamp
1932  * A string of 13 characters YYMMDD.hhmmss (e.g. A90831.190324).
1933  * A9 = 2009, B0 = 2010, B1 = 2011, ... C0 = 2020, ...
1934  * @param tag_written
1935  * Either NULL or the address of an array with at least 512 characters.
1936  * In the latter case the eventually produced scdbackup tag will be
1937  * copied to this array when the image gets written. This call sets
1938  * scdbackup_tag_written[0] = 0 to mark its preliminary invalidity.
1939  * @return
1940  * 1 indicates success, <0 is error
1941  *
1942  * @since 0.6.24
1943  */
1945  char *name, char *timestamp,
1946  char *tag_written);
1947 
1948 /**
1949  * Whether to set default values for files and directory permissions, gid and
1950  * uid. All these take one of three values: 0, 1 or 2.
1951  *
1952  * If 0, the corresponding attribute will be kept as set in the IsoNode.
1953  * Unless you have changed it, it corresponds to the value on disc, so it
1954  * is suitable for backup purposes. If set to 1, the corresponding attrib.
1955  * will be changed by a default suitable value. Finally, if you set it to
1956  * 2, the attrib. will be changed with the value specified by the functioins
1957  * below. Note that for mode attributes, only the permissions are set, the
1958  * file type remains unchanged.
1959  *
1960  * @see iso_write_opts_set_default_dir_mode
1961  * @see iso_write_opts_set_default_file_mode
1962  * @see iso_write_opts_set_default_uid
1963  * @see iso_write_opts_set_default_gid
1964  * @since 0.6.2
1965  */
1966 int iso_write_opts_set_replace_mode(IsoWriteOpts *opts, int dir_mode,
1967  int file_mode, int uid, int gid);
1968 
1969 /**
1970  * Set the mode to use on dirs when you set the replace_mode of dirs to 2.
1971  *
1972  * @see iso_write_opts_set_replace_mode
1973  * @since 0.6.2
1974  */
1975 int iso_write_opts_set_default_dir_mode(IsoWriteOpts *opts, mode_t dir_mode);
1976 
1977 /**
1978  * Set the mode to use on files when you set the replace_mode of files to 2.
1979  *
1980  * @see iso_write_opts_set_replace_mode
1981  * @since 0.6.2
1982  */
1983 int iso_write_opts_set_default_file_mode(IsoWriteOpts *opts, mode_t file_mode);
1984 
1985 /**
1986  * Set the uid to use when you set the replace_uid to 2.
1987  *
1988  * @see iso_write_opts_set_replace_mode
1989  * @since 0.6.2
1990  */
1991 int iso_write_opts_set_default_uid(IsoWriteOpts *opts, uid_t uid);
1992 
1993 /**
1994  * Set the gid to use when you set the replace_gid to 2.
1995  *
1996  * @see iso_write_opts_set_replace_mode
1997  * @since 0.6.2
1998  */
1999 int iso_write_opts_set_default_gid(IsoWriteOpts *opts, gid_t gid);
2000 
2001 /**
2002  * 0 to use IsoNode timestamps, 1 to use recording time, 2 to use
2003  * values from timestamp field. This applies to the timestamps of Rock Ridge
2004  * and if the use of mtime is enabled by iso_write_opts_set_dir_rec_mtime().
2005  * In the latter case, value 1 will revoke the recording of mtime, value
2006  * 2 will override mtime by iso_write_opts_set_default_timestamp().
2007  *
2008  * @see iso_write_opts_set_default_timestamp
2009  * @since 0.6.2
2010  */
2011 int iso_write_opts_set_replace_timestamps(IsoWriteOpts *opts, int replace);
2012 
2013 /**
2014  * Set the timestamp to use when you set the replace_timestamps to 2.
2015  *
2016  * @see iso_write_opts_set_replace_timestamps
2017  * @since 0.6.2
2018  */
2019 int iso_write_opts_set_default_timestamp(IsoWriteOpts *opts, time_t timestamp);
2020 
2021 /**
2022  * Whether to always record timestamps in GMT.
2023  *
2024  * By default, libisofs stores local time information on image. You can set
2025  * this to always store timestamps converted to GMT. This prevents any
2026  * discrimination of the timezone of the image preparer by the image reader.
2027  *
2028  * It is useful if you want to hide your timezone, or you live in a timezone
2029  * that can't be represented in ECMA-119. These are timezones with an offset
2030  * from GMT greater than +13 hours, lower than -12 hours, or not a multiple
2031  * of 15 minutes.
2032  * Negative timezones (west of GMT) can trigger bugs in some operating systems
2033  * which typically appear in mounted ISO images as if the timezone shift from
2034  * GMT was applied twice (e.g. in New York 22:36 becomes 17:36).
2035  *
2036  * @since 0.6.2
2037  */
2038 int iso_write_opts_set_always_gmt(IsoWriteOpts *opts, int gmt);
2039 
2040 /**
2041  * Set the charset to use for the RR names of the files that will be created
2042  * on the image.
2043  * NULL to use default charset, that is the locale charset.
2044  * You can obtain the list of charsets supported on your system executing
2045  * "iconv -l" in a shell.
2046  *
2047  * @since 0.6.2
2048  */
2049 int iso_write_opts_set_output_charset(IsoWriteOpts *opts, const char *charset);
2050 
2051 /**
2052  * Set the type of image creation in case there was already an existing
2053  * image imported. Libisofs supports two types of creation:
2054  * stand-alone and appended.
2055  *
2056  * A stand-alone image is an image that does not need the old image any more
2057  * for being mounted by the operating system or imported by libisofs. It may
2058  * be written beginning with byte 0 of optical media or disk file objects.
2059  * There will be no distinction between files from the old image and those
2060  * which have been added by the new image generation.
2061  *
2062  * On the other side, an appended image is not self contained. It may refer
2063  * to files that stay stored in the imported existing image.
2064  * This usage model is inspired by CD multi-session. It demands that the
2065  * appended image is finally written to the same media or disk file
2066  * as the imported image at an address behind the end of that imported image.
2067  * The exact address may depend on media peculiarities and thus has to be
2068  * announced by the application via iso_write_opts_set_ms_block().
2069  * The real address where the data will be written is under control of the
2070  * consumer of the struct burn_source which takes the output of libisofs
2071  * image generation. It may be the one announced to libisofs or an intermediate
2072  * one. Nevertheless, the image will be readable only at the announced address.
2073  *
2074  * If you have not imported a previous image by iso_image_import(), then the
2075  * image will always be a stand-alone image, as there is no previous data to
2076  * refer to.
2077  *
2078  * @param opts
2079  * The option set to be manipulated.
2080  * @param append
2081  * 1 to create an appended image, 0 for an stand-alone one.
2082  *
2083  * @since 0.6.2
2084  */
2085 int iso_write_opts_set_appendable(IsoWriteOpts *opts, int append);
2086 
2087 /**
2088  * Set the start block of the image. It is supposed to be the lba where the
2089  * first block of the image will be written on disc. All references inside the
2090  * ISO image will take this into account, thus providing a mountable image.
2091  *
2092  * For appendable images, that are written to a new session, you should
2093  * pass here the lba of the next writable address on disc.
2094  *
2095  * In stand alone images this is usually 0. However, you may want to
2096  * provide a different ms_block if you don't plan to burn the image in the
2097  * first session on disc, such as in some CD-Extra disc whether the data
2098  * image is written in a new session after some audio tracks.
2099  *
2100  * @since 0.6.2
2101  */
2102 int iso_write_opts_set_ms_block(IsoWriteOpts *opts, uint32_t ms_block);
2103 
2104 /**
2105  * Sets the buffer where to store the descriptors which shall be written
2106  * at the beginning of an overwriteable media to point to the newly written
2107  * image.
2108  * This is needed if the write start address of the image is not 0.
2109  * In this case the first 64 KiB of the media have to be overwritten
2110  * by the buffer content after the session was written and the buffer
2111  * was updated by libisofs. Otherwise the new session would not be
2112  * found by operating system function mount() or by libisoburn.
2113  * (One could still mount that session if its start address is known.)
2114  *
2115  * If you do not need this information, for example because you are creating a
2116  * new image for LBA 0 or because you will create an image for a true
2117  * multisession media, just do not use this call or set buffer to NULL.
2118  *
2119  * Use cases:
2120  *
2121  * - Together with iso_write_opts_set_appendable(opts, 1) the buffer serves
2122  * for the growing of an image as done in growisofs by Andy Polyakov.
2123  * This allows appending of a new session to non-multisession media, such
2124  * as DVD+RW. The new session will refer to the data of previous sessions
2125  * on the same media.
2126  * libisoburn emulates multisession appendability on overwriteable media
2127  * and disk files by performing this use case.
2128  *
2129  * - Together with iso_write_opts_set_appendable(opts, 0) the buffer allows
2130  * to write the first session on overwriteable media to start addresses
2131  * other than 0.
2132  * This address must not be smaller than 32 blocks plus the eventual
2133  * partition offset as defined by iso_write_opts_set_part_offset().
2134  * libisoburn in most cases writes the first session on overwriteable media
2135  * and disk files to LBA (32 + partition_offset) in order to preserve its
2136  * descriptors from the subsequent overwriting by the descriptor buffer of
2137  * later sessions.
2138  *
2139  * @param opts
2140  * The option set to be manipulated.
2141  * @param overwrite
2142  * When not NULL, it should point to at least 64KiB of memory, where
2143  * libisofs will install the contents that shall be written at the
2144  * beginning of overwriteable media.
2145  * You should initialize the buffer either with 0s, or with the contents
2146  * of the first 32 blocks of the image you are growing. In most cases,
2147  * 0 is good enought.
2148  * IMPORTANT: If you use iso_write_opts_set_part_offset() then the
2149  * overwrite buffer must be larger by the offset defined there.
2150  *
2151  * @since 0.6.2
2152  */
2153 int iso_write_opts_set_overwrite_buf(IsoWriteOpts *opts, uint8_t *overwrite);
2154 
2155 /**
2156  * Set the size, in number of blocks, of the ring buffer used between the
2157  * writer thread and the burn_source. You have to provide at least a 32
2158  * blocks buffer. Default value is set to 2MB, if that is ok for you, you
2159  * don't need to call this function.
2160  *
2161  * @since 0.6.2
2162  */
2163 int iso_write_opts_set_fifo_size(IsoWriteOpts *opts, size_t fifo_size);
2164 
2165 /*
2166  * Attach 32 kB of binary data which shall get written to the first 32 kB
2167  * of the ISO image, the ECMA-119 System Area. This space is intended for
2168  * system dependent boot software, e.g. a Master Boot Record which allows to
2169  * boot from USB sticks or hard disks. ECMA-119 makes no own assumptions or
2170  * prescriptions about the byte content.
2171  *
2172  * If system area data are given or options bit0 is set, then bit1 of
2173  * el_torito_set_isolinux_options() is automatically disabled.
2174  *
2175  * @param opts
2176  * The option set to be manipulated.
2177  * @param data
2178  * Either NULL or 32 kB of data. Do not submit less bytes !
2179  * @param options
2180  * Can cause manipulations of submitted data before they get written:
2181  * bit0= Only with System area type 0 = MBR
2182  * Apply a --protective-msdos-label as of grub-mkisofs.
2183  * This means to patch bytes 446 to 512 of the system area so
2184  * that one partition is defined which begins at the second
2185  * 512-byte block of the image and ends where the image ends.
2186  * This works with and without system_area_data.
2187  * Modern GRUB2 system areas get also treated by bit14. See below.
2188  * bit1= Only with System area type 0 = MBR
2189  * Apply isohybrid MBR patching to the system area.
2190  * This works only with system area data from SYSLINUX plus an
2191  * ISOLINUX boot image as first submitted boot image
2192  * (see iso_image_set_boot_image()) and only if not bit0 is set.
2193  * bit2-7= System area type
2194  * 0= with bit0 or bit1: MBR
2195  * else: type depends on bits bit10-13: System area sub type
2196  * 1= MIPS Big Endian Volume Header
2197  * @since 0.6.38
2198  * Submit up to 15 MIPS Big Endian boot files by
2199  * iso_image_add_mips_boot_file().
2200  * This will overwrite the first 512 bytes of the submitted
2201  * data.
2202  * 2= DEC Boot Block for MIPS Little Endian
2203  * @since 0.6.38
2204  * The first boot file submitted by
2205  * iso_image_add_mips_boot_file() will be activated.
2206  * This will overwrite the first 512 bytes of the submitted
2207  * data.
2208  * 3= SUN Disk Label for SUN SPARC
2209  * @since 0.6.40
2210  * Submit up to 7 SPARC boot images by
2211  * iso_write_opts_set_partition_img() for partition numbers 2
2212  * to 8.
2213  * This will overwrite the first 512 bytes of the submitted
2214  * data.
2215  * 4= HP-PA PALO boot sector version 4 for HP PA-RISC
2216  * @since 1.3.8
2217  * Suitable for older PALO of e.g. Debian 4 and 5.
2218  * Submit all five parameters of iso_image_set_hppa_palo():
2219  * cmdline, bootloader, kernel_32, kernel_64, ramdisk
2220  * 5= HP-PA PALO boot sector version 5 for HP PA-RISC
2221  * @since 1.3.8
2222  * Suitable for newer PALO, where PALOHDRVERSION in
2223  * lib/common.h is defined as 5.
2224  * Submit all five parameters of iso_image_set_hppa_palo():
2225  * cmdline, bootloader, kernel_32, kernel_64, ramdisk
2226  * 6= DEC Alpha SRM boot sector
2227  * @since 1.4.0
2228  * Submit bootloader path in ISO by iso_image_set_alpha_boot().
2229  * bit8-9= Only with System area type 0 = MBR
2230  * @since 1.0.4
2231  * Cylinder alignment mode eventually pads the image to make it
2232  * end at a cylinder boundary.
2233  * 0 = auto (align if bit1)
2234  * 1 = always align to cylinder boundary
2235  * 2 = never align to cylinder boundary
2236  * 3 = always align, additionally pad up and align partitions
2237  * which were appended by iso_write_opts_set_partition_img()
2238  * @since 1.2.6
2239  * bit10-13= System area sub type
2240  * @since 1.2.4
2241  * With type 0:
2242  * if options bit0 ... MBR with partition start at block 1
2243  * if options bit1 ... ISOLINUX isohybrid MBR
2244  * else:
2245  * 0 = no particular sub type, use unaltered
2246  * 1 = CHRP: A single MBR partition of type 0x96 covers the
2247  * ISO image. Not compatible with any other feature
2248  * which needs to have own MBR partition entries.
2249  * 2 = generic MBR @since 1.3.8
2250  * bit14= Only with System area type 0 = MBR
2251  * GRUB2 boot provisions:
2252  * @since 1.3.0
2253  * Patch system area at byte 0x1b0 to 0x1b7 with
2254  * (512-block address + 4) of the first boot image file.
2255  * Little-endian 8-byte.
2256  * Is normally combined with options bit0.
2257  * Will not be in effect if options bit1 is set.
2258  * bit15= Only with System area type MBR but not with CHRP
2259  * Enforce MBR "bootable/active" flag. In worst case by dummy
2260  * partition of type 0x00 which occupies block 0.
2261  * @since 1.4.4
2262  * @param flag
2263  * bit0 = invalidate any attached system area data. Same as data == NULL
2264  * (This re-activates eventually loaded image System Area data.
2265  * To erase those, submit 32 kB of zeros without flag bit0.)
2266  * bit1 = keep data unaltered
2267  * bit2 = keep options unaltered
2268  * @return
2269  * ISO_SUCCESS or error
2270  * @since 0.6.30
2271  */
2272 int iso_write_opts_set_system_area(IsoWriteOpts *opts, char data[32768],
2273  int options, int flag);
2274 
2275 /**
2276  * Set a name for the system area. This setting is ignored unless system area
2277  * type 3 "SUN Disk Label" is in effect by iso_write_opts_set_system_area().
2278  * In this case it will replace the default text at the start of the image:
2279  * "CD-ROM Disc with Sun sparc boot created by libisofs"
2280  *
2281  * @param opts
2282  * The option set to be manipulated.
2283  * @param label
2284  * A text of up to 128 characters.
2285  * @return
2286  * ISO_SUCCESS or error
2287  * @since 0.6.40
2288 */
2289 int iso_write_opts_set_disc_label(IsoWriteOpts *opts, char *label);
2290 
2291 /**
2292  * Explicitely set the four timestamps of the emerging Primary Volume
2293  * Descriptor and in the volume descriptors of Joliet and ISO 9660:1999,
2294  * if those are to be generated.
2295  * Default with all parameters is 0.
2296  *
2297  * ECMA-119 defines them as:
2298  * @param opts
2299  * The option set to be manipulated.
2300  * @param vol_creation_time
2301  * When "the information in the volume was created."
2302  * A value of 0 means that the timepoint of write start is to be used.
2303  * @param vol_modification_time
2304  * When "the information in the volume was last modified."
2305  * A value of 0 means that the timepoint of write start is to be used.
2306  * @param vol_expiration_time
2307  * When "the information in the volume may be regarded as obsolete."
2308  * A value of 0 means that the information never shall expire.
2309  * @param vol_effective_time
2310  * When "the information in the volume may be used."
2311  * A value of 0 means that not such retention is intended.
2312  * @param vol_uuid
2313  * If this text is not empty, then it overrides vol_creation_time and
2314  * vol_modification_time by copying the first 16 decimal digits from
2315  * uuid, eventually padding up with decimal '1', and writing a NUL-byte
2316  * as timezone.
2317  * Other than with vol_*_time the resulting string in the ISO image
2318  * is fully predictable and free of timezone pitfalls.
2319  * It should express a reasonable time in form YYYYMMDDhhmmsscc.
2320  * The timezone will always be recorded as GMT.
2321  * E.g.: "2010040711405800" = 7 Apr 2010 11:40:58 (+0 centiseconds)
2322  * @return
2323  * ISO_SUCCESS or error
2324  *
2325  * @since 0.6.30
2326  */
2328  time_t vol_creation_time, time_t vol_modification_time,
2329  time_t vol_expiration_time, time_t vol_effective_time,
2330  char *vol_uuid);
2331 
2332 
2333 /*
2334  * Control production of a second set of volume descriptors (superblock)
2335  * and directory trees, together with a partition table in the MBR where the
2336  * first partition has non-zero start address and the others are zeroed.
2337  * The first partition stretches to the end of the whole ISO image.
2338  * The additional volume descriptor set and trees will allow to mount the
2339  * ISO image at the start of the first partition, while it is still possible
2340  * to mount it via the normal first volume descriptor set and tree at the
2341  * start of the image or storage device.
2342  * This makes few sense on optical media. But on USB sticks it creates a
2343  * conventional partition table which makes it mountable on e.g. Linux via
2344  * /dev/sdb and /dev/sdb1 alike.
2345  * IMPORTANT: When submitting memory by iso_write_opts_set_overwrite_buf()
2346  * then its size must be at least 64 KiB + partition offset.
2347  *
2348  * @param opts
2349  * The option set to be manipulated.
2350  * @param block_offset_2k
2351  * The offset of the partition start relative to device start.
2352  * This is counted in 2 kB blocks. The partition table will show the
2353  * according number of 512 byte sectors.
2354  * Default is 0 which causes no special partition table preparations.
2355  * If it is not 0 then it must not be smaller than 16.
2356  * @param secs_512_per_head
2357  * Number of 512 byte sectors per head. 1 to 63. 0=automatic.
2358  * @param heads_per_cyl
2359  * Number of heads per cylinder. 1 to 255. 0=automatic.
2360  * @return
2361  * ISO_SUCCESS or error
2362  *
2363  * @since 0.6.36
2364  */
2366  uint32_t block_offset_2k,
2367  int secs_512_per_head, int heads_per_cyl);
2368 
2369 
2370 /** The minimum version of libjte to be used with this version of libisofs
2371  at compile time. The use of libjte is optional and depends on configure
2372  tests. It can be prevented by ./configure option --disable-libjte .
2373  @since 0.6.38
2374 */
2375 #define iso_libjte_req_major 1
2376 #define iso_libjte_req_minor 0
2377 #define iso_libjte_req_micro 0
2378 
2379 /**
2380  * Associate a libjte environment object to the upcoming write run.
2381  * libjte implements Jigdo Template Extraction as of Steve McIntyre and
2382  * Richard Atterer.
2383  * The call will fail if no libjte support was enabled at compile time.
2384  * @param opts
2385  * The option set to be manipulated.
2386  * @param libjte_handle
2387  * Pointer to a struct libjte_env e.g. created by libjte_new().
2388  * It must stay existent from the start of image generation by
2389  * iso_image_create_burn_source() until the write thread has ended.
2390  * This can be inquired by iso_image_generator_is_running().
2391  * In order to keep the libisofs API identical with and without
2392  * libjte support the parameter type is (void *).
2393  * @return
2394  * ISO_SUCCESS or error
2395  *
2396  * @since 0.6.38
2397 */
2398 int iso_write_opts_attach_jte(IsoWriteOpts *opts, void *libjte_handle);
2399 
2400 /**
2401  * Remove eventual association to a libjte environment handle.
2402  * The call will fail if no libjte support was enabled at compile time.
2403  * @param opts
2404  * The option set to be manipulated.
2405  * @param libjte_handle
2406  * If not submitted as NULL, this will return the previously set
2407  * libjte handle.
2408  * @return
2409  * ISO_SUCCESS or error
2410  *
2411  * @since 0.6.38
2412 */
2413 int iso_write_opts_detach_jte(IsoWriteOpts *opts, void **libjte_handle);
2414 
2415 
2416 /**
2417  * Cause a number of blocks with zero bytes to be written after the payload
2418  * data, but before the eventual checksum data. Unlike libburn tail padding,
2419  * these blocks are counted as part of the image and covered by eventual
2420  * image checksums.
2421  * A reason for such padding can be the wish to prevent the Linux read-ahead
2422  * bug by sacrificial data which still belong to image and Jigdo template.
2423  * Normally such padding would be the job of the burn program which should know
2424  * that it is needed with CD write type TAO if Linux read(2) shall be able
2425  * to read all payload blocks.
2426  * 150 blocks = 300 kB is the traditional sacrifice to the Linux kernel.
2427  * @param opts
2428  * The option set to be manipulated.
2429  * @param num_blocks
2430  * Number of extra 2 kB blocks to be written.
2431  * @return
2432  * ISO_SUCCESS or error
2433  *
2434  * @since 0.6.38
2435  */
2436 int iso_write_opts_set_tail_blocks(IsoWriteOpts *opts, uint32_t num_blocks);
2437 
2438 
2439 /**
2440  * The libisofs interval reader is used internally and offered by libisofs API:
2441  * @since 1.4.0
2442  * The functions iso_write_opts_set_prep_img(), iso_write_opts_set_efi_bootp(),
2443  * and iso_write_opts_set_partition_img() accept with their flag bit0 an
2444  * interval reader description string instead of a disk path.
2445  * The API calls are iso_interval_reader_new(), iso_interval_reader_read(),
2446  * and iso_interval_reader_destroy().
2447  * The data may be cut out and optionally partly zeroized.
2448  *
2449  * An interval reader description string has the form:
2450  * $flags:$interval:$zeroizers:$source
2451  * The component $flags modifies the further interpretation:
2452  * "local_fs" ....... demands to read from a file depicted by the path in
2453  * $source.
2454  * "imported_iso" ... demands to read from the IsoDataSource object that was
2455  * used with iso_image_import() when
2456  * iso_read_opts_keep_import_src() was enabled.
2457  * The text in $source is ignored.
2458  * The application has to ensure that reading from the
2459  * import source does not disturb production of the new
2460  * ISO session. Especially this would be the case if the
2461  * import source is the same libburn drive with a
2462  * sequential optical medium to which the new session shall
2463  * get burned.
2464  * The component $interval consists of two byte address numbers separated
2465  * by a "-" character. E.g. "0-429" means to read bytes 0 to 429.
2466  * The component $zeroizers consists of zero or more comma separated strings.
2467  * They define which part of the read data to zeroize. Byte number 0 means
2468  * the byte read from the $interval start address.
2469  * Each string may be either
2470  * "zero_mbrpt" ..... demands to zeroize bytes 446 to 509 of the read data if
2471  * bytes 510 and 511 bear the MBR signature 0x55 0xaa.
2472  * "zero_gpt" ....... demands to check for a GPT header in bytes 512 to 1023,
2473  * to zeroize it and its partition table blocks.
2474  * "zero_apm" ....... demands to check for an APM block 0 and to zeroize
2475  * its partition table blocks. But not the block 0 itself,
2476  * because it could be actually MBR x86 machine code.
2477  * $zero_start"-"$zero_end ... demands to zeroize the read-in bytes beginning
2478  * with number $zero_start and ending after $zero_end.
2479  * The component $source is the file path with "local_fs", and ignored with
2480  * "imported_iso".
2481  * Byte numbers may be scaled by a suffix out of {k,m,g,t,s,d} meaning
2482  * multiplication by {1024, 1024k, 1024m, 1024g, 2048, 512}. A scaled value
2483  * as end number depicts the last byte of the scaled range.
2484  * E.g. "0d-0d" is "0-511".
2485  * Examples:
2486  * "local_fs:0-32767:zero_mbrpt,zero_gpt,440-443:/tmp/template.iso"
2487  * "imported_iso:45056d-47103d::"
2488  */
2489 struct iso_interval_reader;
2490 
2491 /**
2492  * Create an interval reader object.
2493  *
2494  * @param img
2495  * The IsoImage object which can provide the "imported_iso" data source.
2496  * @param path
2497  * The interval reader description string. See above.
2498  * @param ivr
2499  * Returns in case of success a pointer to the created object.
2500  * Dispose it by iso_interval_reader_destroy() when no longer needed.
2501  * @param byte_count
2502  * Returns in case of success the number of bytes in the interval.
2503  * @param flag
2504  * bit0= tolerate (src == NULL) with "imported_iso".
2505  * (Will immediately cause eof of interval input.)
2506  * @return
2507  * ISO_SUCCESS or error (which is < 0)
2508  *
2509  * @since 1.4.0
2510  */
2511 int iso_interval_reader_new(IsoImage *img, char *path,
2512  struct iso_interval_reader **ivr,
2513  off_t *byte_count, int flag);
2514 
2515 /**
2516  * Dispose an interval reader object.
2517  *
2518  * @param ivr
2519  * The reader object to be disposed. *ivr will be set to NULL.
2520  * @param flag
2521  * Unused yet. Submit 0.
2522  * @return
2523  * ISO_SUCCESS or error (which is < 0)
2524  *
2525  * @since 1.4.0
2526  */
2527 int iso_interval_reader_destroy(struct iso_interval_reader **ivr, int flag);
2528 
2529 /**
2530  * Read the next block of 2048 bytes from an interval reader object.
2531  * If end-of-input happens, the interval will get filled up with 0 bytes.
2532  *
2533  * @param ivr
2534  * The object to read from.
2535  * @param buf
2536  * Pointer to memory for filling in at least 2048 bytes.
2537  * @param buf_fill
2538  * Will in case of success return the number of valid bytes.
2539  * If this is smaller than 2048, then end-of-interval has occurred.
2540  * @param flag
2541  * Unused yet. Submit 0.
2542  * @return
2543  * ISO_SUCCESS if data were read, 0 if not, < 0 if error
2544  *
2545  * @since 1.4.0
2546  */
2547 int iso_interval_reader_read(struct iso_interval_reader *ivr, uint8_t *buf,
2548  int *buf_fill, int flag);
2549 
2550 
2551 /**
2552  * Copy a data file from the local filesystem into the emerging ISO image.
2553  * Mark it by an MBR partition entry as PreP partition and also cause
2554  * protective MBR partition entries before and after this partition.
2555  * Vladimir Serbinenko stated aboy PreP = PowerPC Reference Platform :
2556  * "PreP [...] refers mainly to IBM hardware. PreP boot is a partition
2557  * containing only raw ELF and having type 0x41."
2558  *
2559  * This feature is only combinable with system area type 0
2560  * and currently not combinable with ISOLINUX isohybrid production.
2561  * It overrides --protective-msdos-label. See iso_write_opts_set_system_area().
2562  * Only partition 4 stays available for iso_write_opts_set_partition_img().
2563  * It is compatible with HFS+/FAT production by storing the PreP partition
2564  * before the start of the HFS+/FAT partition.
2565  *
2566  * @param opts
2567  * The option set to be manipulated.
2568  * @param image_path
2569  * File address in the local file system or instructions for interval
2570  * reader. See flag bit0.
2571  * NULL revokes production of the PreP partition.
2572  * @param flag
2573  * bit0= The path contains instructions for the interval reader.
2574  * See above.
2575  * @since 1.4.0
2576  * All other bits are reserved for future usage. Set them to 0.
2577  * @return
2578  * ISO_SUCCESS or error
2579  *
2580  * @since 1.2.4
2581  */
2582 int iso_write_opts_set_prep_img(IsoWriteOpts *opts, char *image_path,
2583  int flag);
2584 
2585 /**
2586  * Copy a data file from the local filesystem into the emerging ISO image.
2587  * Mark it by an GPT partition entry as EFI System partition, and also cause
2588  * protective GPT partition entries before and after the partition.
2589  * GPT = Globally Unique Identifier Partition Table
2590  *
2591  * This feature may collide with data submitted by
2592  * iso_write_opts_set_system_area()
2593  * and with settings made by
2594  * el_torito_set_isolinux_options()
2595  * It is compatible with HFS+/FAT production by storing the EFI partition
2596  * before the start of the HFS+/FAT partition.
2597  * The GPT overwrites byte 0x0200 to 0x03ff of the system area and all
2598  * further bytes above 0x0800 which are not used by an Apple Partition Map.
2599  *
2600  * @param opts
2601  * The option set to be manipulated.
2602  * @param image_path
2603  * File address in the local file system or instructions for interval
2604  * reader. See flag bit0.
2605  * NULL revokes production of the EFI boot partition.
2606  * @param flag
2607  * bit0= The path contains instructions for the interval reader
2608  * See above.
2609  * @since 1.4.0
2610  * All other bits are reserved for future usage. Set them to 0.
2611  * @return
2612  * ISO_SUCCESS or error
2613  *
2614  * @since 1.2.4
2615  */
2616 int iso_write_opts_set_efi_bootp(IsoWriteOpts *opts, char *image_path,
2617  int flag);
2618 
2619 /**
2620  * Control whether the emerging GPT gets a pseudo-randomly generated disk GUID
2621  * or whether it gets a user supplied GUID.
2622  * The partition GUIDs will be generated in a reproducible way by exoring the
2623  * little-endian 32 bit partion number with the disk GUID beginning at byte
2624  * offset 9.
2625  *
2626  * @param opts
2627  * The option set to be manipulated.
2628  * @param guid
2629  * 16 bytes of user supplied GUID. Readily byte-swapped as prescribed by
2630  * UEFI specs: 4 byte, 2 byte, 2 byte as little-endian. The rest as
2631  * big-endian.
2632  * The upper 4 bit of guid[7] should bear the value 4 to express the
2633  * RFC 4122 version 4. Bit 7 of byte[8] should be set to 1 and bit 6
2634  * be set to 0, in order to express the RFC 4122 variant of UUID,
2635  * where version 4 means "pseudo-random uuid".
2636  * @param mode
2637  * 0 = ignore parameter guid and produce the GPT disk GUID by a
2638  * pseudo-random algorithm. This is the default setting.
2639  * 1 = use parameter guid as GPT disk GUID
2640  * 2 = ignore parameter guid and derive the GPT disk GUID from
2641  * parameter vol_uuid of iso_write_opts_set_pvd_times().
2642  * The 16 bytes of vol_uuid get copied and bytes 7, 8 get their
2643  * upper bits changed to comply to RFC 4122 and UEFI.
2644  * Error ISO_GPT_NO_VOL_UUID will occur if image production begins
2645  * before vol_uuid was set.
2646  *
2647  * @return
2648  * ISO_SUCCESS or ISO_BAD_GPT_GUID_MODE
2649  *
2650  * @since 1.4.6
2651  */
2652 int iso_write_opts_set_gpt_guid(IsoWriteOpts *opts, uint8_t guid[16],
2653  int mode);
2654 
2655 /**
2656  * Generate a pseudo-random GUID suitable for iso_write_opts_set_gpt_guid().
2657  *
2658  * @param guid
2659  * Will be filled by 16 bytes of generated GUID.
2660  *
2661  * @since 1.4.6
2662  */
2663 void iso_generate_gpt_guid(uint8_t guid[16]);
2664 
2665 /**
2666  * Cause an arbitrary data file to be appended to the ISO image and to be
2667  * described by a partition table entry in an MBR or SUN Disk Label at the
2668  * start of the ISO image.
2669  * The partition entry will bear the size of the image file rounded up to
2670  * the next multiple of 2048 bytes.
2671  * MBR or SUN Disk Label are selected by iso_write_opts_set_system_area()
2672  * system area type: 0 selects MBR partition table. 3 selects a SUN partition
2673  * table with 320 kB start alignment.
2674  *
2675  * @param opts
2676  * The option set to be manipulated.
2677  * @param partition_number
2678  * Depicts the partition table entry which shall describe the
2679  * appended image.
2680  * Range with MBR: 1 to 4. 1 will cause the whole ISO image to be
2681  * unclaimable space before partition 1.
2682  * Range with SUN Disk Label: 2 to 8.
2683  * @param partition_type
2684  * The MBR partition type. E.g. FAT12 = 0x01 , FAT16 = 0x06,
2685  * Linux Native Partition = 0x83. See fdisk command L.
2686  * This parameter is ignored with SUN Disk Label.
2687  * @param image_path
2688  * File address in the local file system or instructions for interval
2689  * reader. See flag bit0.
2690  * With SUN Disk Label: an empty name causes the partition to become
2691  * a copy of the next lower partition.
2692  * @param flag
2693  * bit0= The path contains instructions for the interval reader
2694  * See above.
2695  * @since 1.4.0
2696  * All other bits are reserved for future usage. Set them to 0.
2697  * @return
2698  * ISO_SUCCESS or error
2699  *
2700  * @since 0.6.38
2701  */
2702 int iso_write_opts_set_partition_img(IsoWriteOpts *opts, int partition_number,
2703  uint8_t partition_type, char *image_path, int flag);
2704 
2705 /**
2706  * Control whether partitions created by iso_write_opts_set_partition_img()
2707  * are to be represented in MBR or as GPT partitions.
2708  *
2709  * @param opts
2710  * The option set to be manipulated.
2711  * @param gpt
2712  * 0= represent as MBR partition; as GPT only if other GPT partitions
2713  * are present
2714  * 1= represent as GPT partition and cause protective MBR with a single
2715  * partition which covers the whole output data.
2716  * This may fail if other settings demand MBR partitions.
2717  * @return
2718  * ISO_SUCCESS or error
2719  *
2720  * @since 1.4.0
2721  */
2723 
2724 /**
2725  * Control whether partitions created by iso_write_opts_set_partition_img()
2726  * are to be represented in Apple Partition Map.
2727  *
2728  * @param opts
2729  * The option set to be manipulated.
2730  * @param apm
2731  * 0= do not represent appended partitions in APM
2732  * 1= represent in APM, even if not
2733  * iso_write_opts_set_part_like_isohybrid() enables it and no
2734  * other APM partitions emerge.
2735  * @return
2736  * ISO_SUCCESS or error
2737  *
2738  * @since 1.4.4
2739  */
2741 
2742 /**
2743  * Control whether bits 2 to 8 of el_torito_set_isolinux_options()
2744  * shall apply even if not isohybrid MBR patching is enabled (bit1 of
2745  * parameter options of iso_write_opts_set_system_area()):
2746  * - Mentioning of El Torito boot images in GPT.
2747  * - Mentioning of El Torito boot images in APM.
2748  *
2749  * In this case some other behavior from isohybrid processing will apply too:
2750  * - No MBR partition of type 0xee emerges, even if GPT gets produced.
2751  * - Gaps between GPT and APM partitions will not be filled by more partitions.
2752  *
2753  * An extra feature towards isohybrid is enabled:
2754  * - Appended partitions get mentioned in APM if other APM partitions emerge.
2755  *
2756  * @param opts
2757  * The option set to be manipulated.
2758  * @param alike
2759  * 0= Apply the described behavior only with ISOLINUX isohybrid.
2760  * Do not mention appended partitions in APM unless
2761  * iso_write_opts_set_appended_as_apm() is enabled.
2762  * 1= Apply the described behavior even without ISOLINUX isohybrid.
2763  *
2764  * @return
2765  * ISO_SUCCESS or error
2766  *
2767  * @since 1.4.4
2768  */
2770 
2771 /**
2772  * Set the partition type of the MBR partition which represents the ISO
2773  * filesystem or at least protects it.
2774  * This is without effect if no such partition emerges by other settings or
2775  * if the partition type is prescribed mandatorily like 0xee for GPT protective
2776  * MBR or 0x96 for CHRP.
2777  * @param opts
2778  * The option set to be manipulated.
2779  * @param part_type
2780  * 0x00 to 0xff as desired partition type.
2781  * Any other value (e.g. -1) enables the default types of the various
2782  * occasions.
2783  * @since 1.4.8
2784  */
2785 int iso_write_opts_set_iso_mbr_part_type(IsoWriteOpts *opts, int part_type);
2786 
2787 /**
2788  * Inquire the start address of the file data blocks after having used
2789  * IsoWriteOpts with iso_image_create_burn_source().
2790  * @param opts
2791  * The option set that was used when starting image creation
2792  * @param data_start
2793  * Returns the logical block address if it is already valid
2794  * @param flag
2795  * Reserved for future usage, set to 0.
2796  * @return
2797  * 1 indicates valid data_start, <0 indicates invalid data_start
2798  *
2799  * @since 0.6.16
2800  */
2801 int iso_write_opts_get_data_start(IsoWriteOpts *opts, uint32_t *data_start,
2802  int flag);
2803 
2804 /**
2805  * Update the sizes of all files added to image.
2806  *
2807  * This may be called just before iso_image_create_burn_source() to force
2808  * libisofs to check the file sizes again (they're already checked when added
2809  * to IsoImage). It is useful if you have changed some files after adding then
2810  * to the image.
2811  *
2812  * @return
2813  * 1 on success, < 0 on error
2814  * @since 0.6.8
2815  */
2816 int iso_image_update_sizes(IsoImage *image);
2817 
2818 /**
2819  * Create a burn_source and a thread which immediately begins to generate
2820  * the image. That burn_source can be used with libburn as a data source
2821  * for a track. A copy of its public declaration in libburn.h can be found
2822  * further below in this text.
2823  *
2824  * If image generation shall be aborted by the application program, then
2825  * the .cancel() method of the burn_source must be called to end the
2826  * generation thread: burn_src->cancel(burn_src);
2827  *
2828  * @param image
2829  * The image to write.
2830  * @param opts
2831  * The options for image generation. All needed data will be copied, so
2832  * you can free the given struct once this function returns.
2833  * @param burn_src
2834  * Location where the pointer to the burn_source will be stored
2835  * @return
2836  * 1 on success, < 0 on error
2837  *
2838  * @since 0.6.2
2839  */
2841  struct burn_source **burn_src);
2842 
2843 /**
2844  * Inquire whether the image generator thread is still at work. As soon as the
2845  * reply is 0, the caller of iso_image_create_burn_source() may assume that
2846  * the image generation has ended.
2847  * Nevertheless there may still be readily formatted output data pending in
2848  * the burn_source or its consumers. So the final delivery of the image has
2849  * also to be checked at the data consumer side,e.g. by burn_drive_get_status()
2850  * in case of libburn as consumer.
2851  * @param image
2852  * The image to inquire.
2853  * @return
2854  * 1 generating of image stream is still in progress
2855  * 0 generating of image stream has ended meanwhile
2856  *
2857  * @since 0.6.38
2858  */
2860 
2861 /**
2862  * Creates an IsoReadOpts for reading an existent image. You should set the
2863  * options desired with the correspondent setters. Note that you may want to
2864  * set the start block value.
2865  *
2866  * Options by default are determined by the selected profile.
2867  *
2868  * @param opts
2869  * Pointer to the location where the newly created IsoReadOpts will be
2870  * stored. You should free it with iso_read_opts_free() when no more
2871  * needed.
2872  * @param profile
2873  * Default profile for image reading. For now the following values are
2874  * defined:
2875  * ---> 0 [STANDARD]
2876  * Suitable for most situations. Most extension are read. When both
2877  * Joliet and RR extension are present, RR is used.
2878  * AAIP for ACL and xattr is not enabled by default.
2879  * @return
2880  * 1 success, < 0 error
2881  *
2882  * @since 0.6.2
2883  */
2884 int iso_read_opts_new(IsoReadOpts **opts, int profile);
2885 
2886 /**
2887  * Free an IsoReadOpts previously allocated with iso_read_opts_new().
2888  *
2889  * @since 0.6.2
2890  */
2891 void iso_read_opts_free(IsoReadOpts *opts);
2892 
2893 /**
2894  * Set the block where the image begins. It is usually 0, but may be different
2895  * on a multisession disc.
2896  *
2897  * @since 0.6.2
2898  */
2899 int iso_read_opts_set_start_block(IsoReadOpts *opts, uint32_t block);
2900 
2901 /**
2902  * Do not read Rock Ridge extensions.
2903  * In most cases you don't want to use this. It could be useful if RR info
2904  * is damaged, or if you want to use the Joliet tree.
2905  *
2906  * @since 0.6.2
2907  */
2908 int iso_read_opts_set_no_rockridge(IsoReadOpts *opts, int norr);
2909 
2910 /**
2911  * Do not read Joliet extensions.
2912  *
2913  * @since 0.6.2
2914  */
2915 int iso_read_opts_set_no_joliet(IsoReadOpts *opts, int nojoliet);
2916 
2917 /**
2918  * Do not read ISO 9660:1999 enhanced tree
2919  *
2920  * @since 0.6.2
2921  */
2922 int iso_read_opts_set_no_iso1999(IsoReadOpts *opts, int noiso1999);
2923 
2924 /**
2925  * Control reading of AAIP informations about ACL and xattr when loading
2926  * existing images.
2927  * For importing ACL and xattr when inserting nodes from external filesystems
2928  * (e.g. the local POSIX filesystem) see iso_image_set_ignore_aclea().
2929  * For eventual writing of this information see iso_write_opts_set_aaip().
2930  *
2931  * @param opts
2932  * The option set to be manipulated
2933  * @param noaaip
2934  * 1 = Do not read AAIP information
2935  * 0 = Read AAIP information if available
2936  * All other values are reserved.
2937  * @since 0.6.14
2938  */
2939 int iso_read_opts_set_no_aaip(IsoReadOpts *opts, int noaaip);
2940 
2941 /**
2942  * Control reading of an array of MD5 checksums which is eventually stored
2943  * at the end of a session. See also iso_write_opts_set_record_md5().
2944  * Important: Loading of the MD5 array will only work if AAIP is enabled
2945  * because its position and layout is recorded in xattr "isofs.ca".
2946  *
2947  * @param opts
2948  * The option set to be manipulated
2949  * @param no_md5
2950  * 0 = Read MD5 array if available, refuse on non-matching MD5 tags
2951  * 1 = Do not read MD5 checksum array
2952  * 2 = Read MD5 array, but do not check MD5 tags
2953  * @since 1.0.4
2954  * All other values are reserved.
2955  *
2956  * @since 0.6.22
2957  */
2958 int iso_read_opts_set_no_md5(IsoReadOpts *opts, int no_md5);
2959 
2960 
2961 /**
2962  * Control discarding of eventual inode numbers from existing images.
2963  * Such numbers may come from RRIP 1.12 entries PX. If not discarded they
2964  * get written unchanged when the file object gets written into an ISO image.
2965  * If this inode number is missing with a file in the imported image,
2966  * or if it has been discarded during image reading, then a unique inode number
2967  * will be generated at some time before the file gets written into an ISO
2968  * image.
2969  * Two image nodes which have the same inode number represent two hardlinks
2970  * of the same file object. So discarding the numbers splits hardlinks.
2971  *
2972  * @param opts
2973  * The option set to be manipulated
2974  * @param new_inos
2975  * 1 = Discard imported inode numbers and finally hand out a unique new
2976  * one to each single file before it gets written into an ISO image.
2977  * 0 = Keep eventual inode numbers from PX entries.
2978  * All other values are reserved.
2979  * @since 0.6.20
2980  */
2981 int iso_read_opts_set_new_inos(IsoReadOpts *opts, int new_inos);
2982 
2983 /**
2984  * Whether to prefer Joliet over RR. libisofs usually prefers RR over
2985  * Joliet, as it give us much more info about files. So, if both extensions
2986  * are present, RR is used. You can set this if you prefer Joliet, but
2987  * note that this is not very recommended. This doesn't mean than RR
2988  * extensions are not read: if no Joliet is present, libisofs will read
2989  * RR tree.
2990  *
2991  * @since 0.6.2
2992  */
2993 int iso_read_opts_set_preferjoliet(IsoReadOpts *opts, int preferjoliet);
2994 
2995 /**
2996  * How to convert file names if neither Rock Ridge nor Joliet names
2997  * are present and acceptable.
2998  *
2999  * @param opts
3000  * The option set to be manipulated
3001  * @param ecma119_map
3002  * The conversion mode to apply:
3003  * 0 = unmapped: Take name as recorded in ECMA-119 directory record
3004  * (not suitable for writing them to a new ISO filesystem)
3005  * 1 = stripped: Like unmapped, but strip off trailing ";1" or ".;1"
3006  * 2 = uppercase: Like stripped, but map {a-z} to {A-Z}
3007  * 3 = lowercase: Like stripped, but map {A-Z} to {a-z}
3008  * @return
3009  * ISO_SUCCESS if ecma119_map was accepted
3010  * 0 if the value was out of range
3011  * < 0 if other error
3012  *
3013  * @since 1.4.2
3014  */
3015 int iso_read_opts_set_ecma119_map(IsoReadOpts *opts, int ecma119_map);
3016 
3017 /**
3018  * Set default uid for files when RR extensions are not present.
3019  *
3020  * @since 0.6.2
3021  */
3022 int iso_read_opts_set_default_uid(IsoReadOpts *opts, uid_t uid);
3023 
3024 /**
3025  * Set default gid for files when RR extensions are not present.
3026  *
3027  * @since 0.6.2
3028  */
3029 int iso_read_opts_set_default_gid(IsoReadOpts *opts, gid_t gid);
3030 
3031 /**
3032  * Set default permissions for files when RR extensions are not present.
3033  *
3034  * @param opts
3035  * The option set to be manipulated
3036  * @param file_perm
3037  * Permissions for files.
3038  * @param dir_perm
3039  * Permissions for directories.
3040  *
3041  * @since 0.6.2
3042  */
3043 int iso_read_opts_set_default_permissions(IsoReadOpts *opts, mode_t file_perm,
3044  mode_t dir_perm);
3045 
3046 /**
3047  * Set the input charset of the file names on the image. NULL to use locale
3048  * charset. You have to specify a charset if the image filenames are encoded
3049  * in a charset different that the local one. This could happen, for example,
3050  * if the image was created on a system with different charset.
3051  *
3052  * @param opts
3053  * The option set to be manipulated
3054  * @param charset
3055  * The charset to use as input charset. You can obtain the list of
3056  * charsets supported on your system executing "iconv -l" in a shell.
3057  *
3058  * @since 0.6.2
3059  */
3060 int iso_read_opts_set_input_charset(IsoReadOpts *opts, const char *charset);
3061 
3062 /**
3063  * Enable or disable methods to automatically choose an input charset.
3064  * This eventually overrides the name set via iso_read_opts_set_input_charset()
3065  *
3066  * @param opts
3067  * The option set to be manipulated
3068  * @param mode
3069  * Bitfield for control purposes:
3070  * bit0= Allow to use the input character set name which is eventually
3071  * stored in attribute "isofs.cs" of the root directory.
3072  * Applications may attach this xattr by iso_node_set_attrs() to
3073  * the root node, call iso_write_opts_set_output_charset() with the
3074  * same name and enable iso_write_opts_set_aaip() when writing
3075  * an image.
3076  * Submit any other bits with value 0.
3077  *
3078  * @since 0.6.18
3079  *
3080  */
3081 int iso_read_opts_auto_input_charset(IsoReadOpts *opts, int mode);
3082 
3083 /**
3084  * Enable or disable loading of the first 32768 bytes of the session.
3085  *
3086  * @param opts
3087  * The option set to be manipulated
3088  * @param mode
3089  * Bitfield for control purposes:
3090  * bit0= Load System Area data and attach them to the image so that they
3091  * get written by the next session, if not overridden by
3092  * iso_write_opts_set_system_area().
3093  * Submit any other bits with value 0.
3094  *
3095  * @since 0.6.30
3096  *
3097  */
3098 int iso_read_opts_load_system_area(IsoReadOpts *opts, int mode);
3099 
3100 /**
3101  * Control whether to keep a reference to the IsoDataSource object which
3102  * allows access to the blocks of the imported ISO 9660 filesystem.
3103  * This is needed if the interval reader shall read from "imported_iso".
3104  *
3105  * @param opts
3106  * The option set to be manipulated
3107  * @param mode
3108  * Bitfield for control purposes:
3109  * bit0= Keep a reference to the IsoDataSource until the IsoImage object
3110  * gets disposed by its final iso_image_unref().
3111  * Submit any other bits with value 0.
3112  *
3113  * @since 1.4.0
3114  *
3115  */
3116 int iso_read_opts_keep_import_src(IsoReadOpts *opts, int mode);
3117 
3118 /**
3119  * Import a previous session or image, for growing or modify.
3120  *
3121  * @param image
3122  * The image context to which old image will be imported. Note that all
3123  * files added to image, and image attributes, will be replaced with the
3124  * contents of the old image.
3125  * TODO #00025 support for merging old image files
3126  * @param src
3127  * Data Source from which old image will be read. A extra reference is
3128  * added, so you still need to iso_data_source_unref() yours.
3129  * @param opts
3130  * Options for image import. All needed data will be copied, so you
3131  * can free the given struct once this function returns.
3132  * @param features
3133  * If not NULL, a new IsoReadImageFeatures will be allocated and filled
3134  * with the features of the old image. It should be freed with
3135  * iso_read_image_features_destroy() when no more needed. You can pass
3136  * NULL if you're not interested on them.
3137  * @return
3138  * 1 on success, < 0 on error
3139  *
3140  * @since 0.6.2
3141  */
3142 int iso_image_import(IsoImage *image, IsoDataSource *src, IsoReadOpts *opts,
3143  IsoReadImageFeatures **features);
3144 
3145 /**
3146  * Destroy an IsoReadImageFeatures object obtained with iso_image_import.
3147  *
3148  * @since 0.6.2
3149  */
3151 
3152 /**
3153  * Get the size (in 2048 byte block) of the image, as reported in the PVM.
3154  *
3155  * @since 0.6.2
3156  */
3158 
3159 /**
3160  * Whether RockRidge extensions are present in the image imported.
3161  *
3162  * @since 0.6.2
3163  */
3165 
3166 /**
3167  * Whether Joliet extensions are present in the image imported.
3168  *
3169  * @since 0.6.2
3170  */
3172 
3173 /**
3174  * Whether the image is recorded according to ISO 9660:1999, i.e. it has
3175  * a version 2 Enhanced Volume Descriptor.
3176  *
3177  * @since 0.6.2
3178  */
3180 
3181 /**
3182  * Whether El-Torito boot record is present present in the image imported.
3183  *
3184  * @since 0.6.2
3185  */
3187 
3188 /**
3189  * Increments the reference counting of the given image.
3190  *
3191  * @since 0.6.2
3192  */
3193 void iso_image_ref(IsoImage *image);
3194 
3195 /**
3196  * Decrements the reference couting of the given image.
3197  * If it reaches 0, the image is free, together with its tree nodes (whether
3198  * their refcount reach 0 too, of course).
3199  *
3200  * @since 0.6.2
3201  */
3202 void iso_image_unref(IsoImage *image);
3203 
3204 /**
3205  * Attach user defined data to the image. Use this if your application needs
3206  * to store addition info together with the IsoImage. If the image already
3207  * has data attached, the old data will be freed.
3208  *
3209  * @param image
3210  * The image to which data shall be attached.
3211  * @param data
3212  * Pointer to application defined data that will be attached to the
3213  * image. You can pass NULL to remove any already attached data.
3214  * @param give_up
3215  * Function that will be called when the image does not need the data
3216  * any more. It receives the data pointer as an argumente, and eventually
3217  * causes data to be freed. It can be NULL if you don't need it.
3218  * @return
3219  * 1 on succes, < 0 on error
3220  *
3221  * @since 0.6.2
3222  */
3223 int iso_image_attach_data(IsoImage *image, void *data, void (*give_up)(void*));
3224 
3225 /**
3226  * The the data previously attached with iso_image_attach_data()
3227  *
3228  * @since 0.6.2
3229  */
3231 
3232 /**
3233  * Set the name truncation mode and the maximum name length for nodes from
3234  * image importing, creation of new IsoNode objects, and name changing image
3235  * manipulations.
3236  *
3237  * Truncated names are supposed to be nearly unique because they end by the MD5
3238  * of the first 4095 characters of the untruncated name. One should treat them
3239  * as if they were the untruncated original names.
3240  *
3241  * For proper processing of truncated names it is necessary to use
3242  * iso_image_set_node_name() instead of iso_node_set_name()
3243  * iso_image_add_new_dir() iso_tree_add_new_dir()
3244  * iso_image_add_new_file() iso_tree_add_new_file()
3245  * iso_image_add_new_special() iso_tree_add_new_special()
3246  * iso_image_add_new_symlink() iso_tree_add_new_symlink()
3247  * iso_image_tree_clone() iso_tree_clone()
3248  * iso_image_dir_get_node() iso_dir_get_node()
3249  * iso_image_path_to_node() iso_tree_path_to_node()
3250  *
3251  * Beware of ambiguities if both, the full name and the truncated name,
3252  * exist in the same directory. Best is to only set truncation parameters
3253  * once with an ISO filesystem and to never change them later.
3254  *
3255  * If writing of AAIP is enabled, then the mode and length are recorded in
3256  * xattr "isofs.nt" of the root node.
3257  * If reading of AAIP is enabled and "isofs.nt" is found, then it gets into
3258  * effect if both, the truncate mode value from "isofs.nt" and the current
3259  * truncate mode of the IsoImage are 1, and the length is between 64 and 255.
3260  *
3261  * @param img
3262  * The image which shall be manipulated.
3263  * @param mode
3264  * 0= Do not truncate but throw error ISO_RR_NAME_TOO_LONG if a file name
3265  * is longer than parameter length.
3266  * 1= Truncate to length and overwrite the last 33 bytes of that length
3267  * by a colon ':' and the hex representation of the MD5 of the first
3268  * 4095 bytes of the whole oversized name.
3269  * Potential incomplete UTF-8 characters will get their leading bytes
3270  * replaced by '_'.
3271  * Mode 1 is the default.
3272  * @param length
3273  * Maximum byte count of a file name. Permissible values are 64 to 255.
3274  * Default is 255.
3275  * @return
3276  * ISO_SUCCESS or ISO_WRONG_ARG_VALUE
3277  *
3278  * @since 1.4.2
3279  */
3280 int iso_image_set_truncate_mode(IsoImage *img, int mode, int length);
3281 
3282 /**
3283  * Inquire the current setting of iso_image_set_truncate_mode().
3284  *
3285  * @param img
3286  * The image which shall be inquired.
3287  * @param mode
3288  * Returns the mode value.
3289  * @param length
3290  * Returns the length value.
3291  * @return
3292  * ISO_SUCCESS or <0 = error
3293  *
3294  * @since 1.4.2
3295  */
3296 int iso_image_get_truncate_mode(IsoImage *img, int *mode, int *length);
3297 
3298 /**
3299  * Immediately apply the given truncate mode and length to the given string.
3300  *
3301  * @param mode
3302  * See iso_image_set_truncate_mode()
3303  * @param length
3304  * See iso_image_set_truncate_mode()
3305  * @param name
3306  * The string to be inspected and truncated if mode says so.
3307  * @param flag
3308  * Bitfield for control purposes. Unused yet. Submit 0.
3309  * @return
3310  * ISO_SUCCESS, ISO_WRONG_ARG_VALUE, ISO_RR_NAME_TOO_LONG
3311  *
3312  * @since 1.4.2
3313  */
3314 int iso_truncate_leaf_name(int mode, int length, char *name, int flag);
3315 
3316 /**
3317  * Get the root directory of the image.
3318  * No extra ref is added to it, so you must not unref it. Use iso_node_ref()
3319  * if you want to get your own reference.
3320  *
3321  * @since 0.6.2
3322  */
3323 IsoDir *iso_image_get_root(const IsoImage *image);
3324 
3325 /**
3326  * Fill in the volset identifier for a image.
3327  *
3328  * @since 0.6.2
3329  */
3330 void iso_image_set_volset_id(IsoImage *image, const char *volset_id);
3331 
3332 /**
3333  * Get the volset identifier.
3334  * The returned string is owned by the image and must not be freed nor
3335  * changed.
3336  *
3337  * @since 0.6.2
3338  */
3339 const char *iso_image_get_volset_id(const IsoImage *image);
3340 
3341 /**
3342  * Fill in the volume identifier for a image.
3343  *
3344  * @since 0.6.2
3345  */
3346 void iso_image_set_volume_id(IsoImage *image, const char *volume_id);
3347 
3348 /**
3349  * Get the volume identifier.
3350  * The returned string is owned by the image and must not be freed nor
3351  * changed.
3352  *
3353  * @since 0.6.2
3354  */
3355 const char *iso_image_get_volume_id(const IsoImage *image);
3356 
3357 /**
3358  * Fill in the publisher for a image.
3359  *
3360  * @since 0.6.2
3361  */
3362 void iso_image_set_publisher_id(IsoImage *image, const char *publisher_id);
3363 
3364 /**
3365  * Get the publisher of a image.
3366  * The returned string is owned by the image and must not be freed nor
3367  * changed.
3368  *
3369  * @since 0.6.2
3370  */
3371 const char *iso_image_get_publisher_id(const IsoImage *image);
3372 
3373 /**
3374  * Fill in the data preparer for a image.
3375  *
3376  * @since 0.6.2
3377  */
3379  const char *data_preparer_id);
3380 
3381 /**
3382  * Get the data preparer of a image.
3383  * The returned string is owned by the image and must not be freed nor
3384  * changed.
3385  *
3386  * @since 0.6.2
3387  */
3388 const char *iso_image_get_data_preparer_id(const IsoImage *image);
3389 
3390 /**
3391  * Fill in the system id for a image. Up to 32 characters.
3392  *
3393  * @since 0.6.2
3394  */
3395 void iso_image_set_system_id(IsoImage *image, const char *system_id);
3396 
3397 /**
3398  * Get the system id of a image.
3399  * The returned string is owned by the image and must not be freed nor
3400  * changed.
3401  *
3402  * @since 0.6.2
3403  */
3404 const char *iso_image_get_system_id(const IsoImage *image);
3405 
3406 /**
3407  * Fill in the application id for a image. Up to 128 chars.
3408  *
3409  * @since 0.6.2
3410  */
3411 void iso_image_set_application_id(IsoImage *image, const char *application_id);
3412 
3413 /**
3414  * Get the application id of a image.
3415  * The returned string is owned by the image and must not be freed nor
3416  * changed.
3417  *
3418  * @since 0.6.2
3419  */
3420 const char *iso_image_get_application_id(const IsoImage *image);
3421 
3422 /**
3423  * Fill copyright information for the image. Usually this refers
3424  * to a file on disc. Up to 37 characters.
3425  *
3426  * @since 0.6.2
3427  */
3429  const char *copyright_file_id);
3430 
3431 /**
3432  * Get the copyright information of a image.
3433  * The returned string is owned by the image and must not be freed nor
3434  * changed.
3435  *
3436  * @since 0.6.2
3437  */
3438 const char *iso_image_get_copyright_file_id(const IsoImage *image);
3439 
3440 /**
3441  * Fill abstract information for the image. Usually this refers
3442  * to a file on disc. Up to 37 characters.
3443  *
3444  * @since 0.6.2
3445  */
3447  const char *abstract_file_id);
3448 
3449 /**
3450  * Get the abstract information of a image.
3451  * The returned string is owned by the image and must not be freed nor
3452  * changed.
3453  *
3454  * @since 0.6.2
3455  */
3456 const char *iso_image_get_abstract_file_id(const IsoImage *image);
3457 
3458 /**
3459  * Fill biblio information for the image. Usually this refers
3460  * to a file on disc. Up to 37 characters.
3461  *
3462  * @since 0.6.2
3463  */
3464 void iso_image_set_biblio_file_id(IsoImage *image, const char *biblio_file_id);
3465 
3466 /**
3467  * Get the biblio information of a image.
3468  * The returned string is owned by the image and must not be freed or changed.
3469  *
3470  * @since 0.6.2
3471  */
3472 const char *iso_image_get_biblio_file_id(const IsoImage *image);
3473 
3474 /**
3475  * Fill Application Use field of the Primary Volume Descriptor.
3476  * ECMA-119 8.4.32 Application Use (BP 884 to 1395)
3477  * "This field shall be reserved for application use. Its content
3478  * is not specified by this Standard."
3479  *
3480  * @param image
3481  * The image to manipulate.
3482  * @param app_use_data
3483  * Up to 512 bytes of data.
3484  * @param count
3485  * The number of bytes in app_use_data. If the number is smaller than 512,
3486  * then the remaining bytes will be set to 0.
3487  * @since 1.3.2
3488  */
3489 void iso_image_set_app_use(IsoImage *image, const char *app_use_data,
3490  int count);
3491 
3492 /**
3493  * Get the current setting for the Application Use field of the Primary Volume
3494  * Descriptor.
3495  * The returned char array of 512 bytes is owned by the image and must not
3496  * be freed or changed.
3497  *
3498  * @param image
3499  * The image to inquire
3500  * @since 1.3.2
3501  */
3502 const char *iso_image_get_app_use(IsoImage *image);
3503 
3504 /**
3505  * Get the four timestamps from the Primary Volume Descriptor of the imported
3506  * ISO image. The timestamps are strings which are either empty or consist
3507  * of 16 digits of the form YYYYMMDDhhmmsscc, plus a signed byte in the range
3508  * of -48 to +52, which gives the timezone offset in steps of 15 minutes.
3509  * None of the returned string pointers shall be used for altering or freeing
3510  * data. They are just for reading.
3511  *
3512  * @param image
3513  * The image to be inquired.
3514  * @param creation_time
3515  * Returns a pointer to the Volume Creation time:
3516  * When "the information in the volume was created."
3517  * @param modification_time
3518  * Returns a pointer to Volume Modification time:
3519  * When "the information in the volume was last modified."
3520  * @param expiration_time
3521  * Returns a pointer to Volume Expiration time:
3522  * When "the information in the volume may be regarded as obsolete."
3523  * @param effective_time
3524  * Returns a pointer to Volume Expiration time:
3525  * When "the information in the volume may be used."
3526  * @return
3527  * ISO_SUCCESS or error
3528  *
3529  * @since 1.2.8
3530  */
3532  char **creation_time, char **modification_time,
3533  char **expiration_time, char **effective_time);
3534 
3535 /**
3536  * Create a new set of El-Torito bootable images by adding a boot catalog
3537  * and the default boot image.
3538  * Further boot images may then be added by iso_image_add_boot_image().
3539  *
3540  * @param image
3541  * The image to make bootable. If it was already bootable this function
3542  * returns an error and the image remains unmodified.
3543  * @param image_path
3544  * The absolute path of a IsoFile to be used as default boot image or
3545  * --interval:appended_partition_$number[_start_$start_size_$size]:...
3546  * if type is ELTORITO_NO_EMUL. $number gives the partition number.
3547  * If _start_$start_size_$size is present, then it overrides the 2 KiB
3548  * start block of the partition and the partition size counted in
3549  * blocks of 512 bytes.
3550  * @param type
3551  * The boot media type. This can be one of 3 types:
3552  * - ELTORITO_FLOPPY_EMUL.
3553  * Floppy emulation: Boot image file must be exactly
3554  * 1200 KiB, 1440 KiB or 2880 KiB.
3555  * - ELTORITO_HARD_DISC_EMUL.
3556  * Hard disc emulation: The image must begin with a master
3557  * boot record with a single image.
3558  * - ELTORITO_NO_EMUL.
3559  * No emulation. You should specify load segment and load size
3560  * of image.
3561  * @param catalog_path
3562  * The absolute path in the image tree where the catalog will be stored.
3563  * The directory component of this path must be a directory existent on
3564  * the image tree, and the filename component must be unique among all
3565  * children of that directory on image. Otherwise a correspodent error
3566  * code will be returned. This function will add an IsoBoot node that acts
3567  * as a placeholder for the real catalog, that will be generated at image
3568  * creation time.
3569  * @param boot
3570  * Location where a pointer to the added boot image will be stored. That
3571  * object is owned by the IsoImage and must not be freed by the user,
3572  * nor dereferenced once the last reference to the IsoImage was disposed
3573  * via iso_image_unref(). A NULL value is allowed if you don't need a
3574  * reference to the boot image.
3575  * @return
3576  * 1 on success, < 0 on error
3577  *
3578  * @since 0.6.2
3579  */
3580 int iso_image_set_boot_image(IsoImage *image, const char *image_path,
3581  enum eltorito_boot_media_type type,
3582  const char *catalog_path,
3583  ElToritoBootImage **boot);
3584 
3585 /**
3586  * Add a further boot image to the set of El-Torito bootable images.
3587  * This set has already to be created by iso_image_set_boot_image().
3588  * Up to 31 further boot images may be added.
3589  *
3590  * @param image
3591  * The image to which the boot image shall be added.
3592  * returns an error and the image remains unmodified.
3593  * @param image_path
3594  * The absolute path of a IsoFile to be used as boot image or
3595  * --interval:appended_partition_$number[_start_$start_size_$size]:...
3596  * if type is ELTORITO_NO_EMUL. See iso_image_set_boot_image.
3597  * @param type
3598  * The boot media type. See iso_image_set_boot_image.
3599  * @param flag
3600  * Bitfield for control purposes. Unused yet. Submit 0.
3601  * @param boot
3602  * Location where a pointer to the added boot image will be stored.
3603  * See iso_image_set_boot_image
3604  * @return
3605  * 1 on success, < 0 on error
3606  * ISO_BOOT_NO_CATALOG means iso_image_set_boot_image()
3607  * was not called first.
3608  *
3609  * @since 0.6.32
3610  */
3611 int iso_image_add_boot_image(IsoImage *image, const char *image_path,
3612  enum eltorito_boot_media_type type, int flag,
3613  ElToritoBootImage **boot);
3614 
3615 /**
3616  * Get the El-Torito boot catalog and the default boot image of an ISO image.
3617  *
3618  * This can be useful, for example, to check if a volume read from a previous
3619  * session or an existing image is bootable. It can also be useful to get
3620  * the image and catalog tree nodes. An application would want those, for
3621  * example, to prevent the user removing it.
3622  *
3623  * Both nodes are owned by libisofs and must not be freed. You can get your
3624  * own ref with iso_node_ref(). You can also check if the node is already
3625  * on the tree by getting its parent (note that when reading El-Torito info
3626  * from a previous image, the nodes might not be on the tree even if you haven't
3627  * removed them). Remember that you'll need to get a new ref
3628  * (with iso_node_ref()) before inserting them again to the tree, and probably
3629  * you will also need to set the name or permissions.
3630  *
3631  * @param image
3632  * The image from which to get the boot image.
3633  * @param boot
3634  * If not NULL, it will be filled with a pointer to the boot image, if
3635  * any. That object is owned by the IsoImage and must not be freed by
3636  * the user, nor dereferenced once the last reference to the IsoImage was
3637  * disposed via iso_image_unref().
3638  * @param imgnode
3639  * When not NULL, it will be filled with the image tree node. No extra ref
3640  * is added, you can use iso_node_ref() to get one if you need it.
3641  * The returned value is NULL if the boot image source is no IsoFile.
3642  * @param catnode
3643  * When not NULL, it will be filled with the catnode tree node. No extra
3644  * ref is added, you can use iso_node_ref() to get one if you need it.
3645  * @return
3646  * 1 on success, 0 is the image is not bootable (i.e., it has no El-Torito
3647  * image), < 0 error.
3648  *
3649  * @since 0.6.2
3650  */
3652  IsoFile **imgnode, IsoBoot **catnode);
3653 
3654 /**
3655  * Get detailed information about the boot catalog that was loaded from
3656  * an ISO image.
3657  * The boot catalog links the El Torito boot record at LBA 17 with the
3658  * boot images which are IsoFile objects in the image. The boot catalog
3659  * itself is not a regular file and thus will not deliver an IsoStream.
3660  * Its content is usually quite short and can be obtained by this call.
3661  *
3662  * @param image
3663  * The image to inquire.
3664  * @param catnode
3665  * Will return the boot catalog tree node. No extra ref is taken.
3666  * @param lba
3667  * Will return the block address of the boot catalog in the image.
3668  * @param content
3669  * Will return either NULL or an allocated memory buffer with the
3670  * content bytes of the boot catalog.
3671  * Dispose it by free() when no longer needed.
3672  * @param size
3673  * Will return the number of bytes in content.
3674  * @return
3675  * 1 if reply is valid, 0 if not boot catalog was loaded, < 0 on error.
3676  *
3677  * @since 1.1.2
3678  */
3679 int iso_image_get_bootcat(IsoImage *image, IsoBoot **catnode, uint32_t *lba,
3680  char **content, off_t *size);
3681 
3682 
3683 /**
3684  * Get all El-Torito boot images of an ISO image.
3685  *
3686  * The first of these boot images is the same as returned by
3687  * iso_image_get_boot_image(). The others are alternative boot images.
3688  *
3689  * @param image
3690  * The image from which to get the boot images.
3691  * @param num_boots
3692  * The number of available array elements in boots and bootnodes.
3693  * @param boots
3694  * Returns NULL or an allocated array of pointers to boot images.
3695  * Apply system call free(boots) to dispose it.
3696  * @param bootnodes
3697  * Returns NULL or an allocated array of pointers to the IsoFile nodes
3698  * which bear the content of the boot images in boots.
3699  * An array entry is NULL if the boot image source is no IsoFile.
3700 
3701 >>> Need getter for partition index
3702 
3703  * @param flag
3704  * Bitfield for control purposes. Unused yet. Submit 0.
3705  * @return
3706  * 1 on success, 0 no El-Torito catalog and boot image attached,
3707  * < 0 error.
3708  *
3709  * @since 0.6.32
3710  */
3711 int iso_image_get_all_boot_imgs(IsoImage *image, int *num_boots,
3712  ElToritoBootImage ***boots, IsoFile ***bootnodes, int flag);
3713 
3714 
3715 /**
3716  * Removes all El-Torito boot images from the ISO image.
3717  *
3718  * The IsoBoot node that acts as placeholder for the catalog is also removed
3719  * for the image tree, if there.
3720  * If the image is not bootable (don't have el-torito boot image) this function
3721  * just returns.
3722  *
3723  * @since 0.6.2
3724  */
3726 
3727 /**
3728  * Sets the sort weight of the boot catalog that is attached to an IsoImage.
3729  *
3730  * For the meaning of sort weights see iso_node_set_sort_weight().
3731  * That function cannot be applied to the emerging boot catalog because
3732  * it is not represented by an IsoFile.
3733  *
3734  * @param image
3735  * The image to manipulate.
3736  * @param sort_weight
3737  * The larger this value, the lower will be the block address of the
3738  * boot catalog record.
3739  * @return
3740  * 0= no boot catalog attached , 1= ok , <0 = error
3741  *
3742  * @since 0.6.32
3743  */
3744 int iso_image_set_boot_catalog_weight(IsoImage *image, int sort_weight);
3745 
3746 /**
3747  * Hides the boot catalog file from directory trees.
3748  *
3749  * For the meaning of hiding files see iso_node_set_hidden().
3750  *
3751  *
3752  * @param image
3753  * The image to manipulate.
3754  * @param hide_attrs
3755  * Or-combination of values from enum IsoHideNodeFlag to set the trees
3756  * in which the record.
3757  * @return
3758  * 0= no boot catalog attached , 1= ok , <0 = error
3759  *
3760  * @since 0.6.34
3761  */
3762 int iso_image_set_boot_catalog_hidden(IsoImage *image, int hide_attrs);
3763 
3764 
3765 /**
3766  * Get the boot media type as of parameter "type" of iso_image_set_boot_image()
3767  * or iso_image_add_boot_image().
3768  *
3769  * @param bootimg
3770  * The image to inquire
3771  * @param media_type
3772  * Returns the media type
3773  * @return
3774  * 1 = ok , < 0 = error
3775  *
3776  * @since 0.6.32
3777  */
3779  enum eltorito_boot_media_type *media_type);
3780 
3781 /**
3782  * Sets the platform ID of the boot image.
3783  *
3784  * The Platform ID gets written into the boot catalog at byte 1 of the
3785  * Validation Entry, or at byte 1 of a Section Header Entry.
3786  * If Platform ID and ID String of two consequtive bootimages are the same
3787  *
3788  * @param bootimg
3789  * The image to manipulate.
3790  * @param id
3791  * A Platform ID as of
3792  * El Torito 1.0 : 0x00= 80x86, 0x01= PowerPC, 0x02= Mac
3793  * Others : 0xef= EFI
3794  * @return
3795  * 1 ok , <=0 error
3796  *
3797  * @since 0.6.32
3798  */
3799 int el_torito_set_boot_platform_id(ElToritoBootImage *bootimg, uint8_t id);
3800 
3801 /**
3802  * Get the platform ID value. See el_torito_set_boot_platform_id().
3803  *
3804  * @param bootimg
3805  * The image to inquire
3806  * @return
3807  * 0 - 255 : The platform ID
3808  * < 0 : error
3809  *
3810  * @since 0.6.32
3811  */
3813 
3814 /**
3815  * Sets the load segment for the initial boot image. This is only for
3816  * no emulation boot images, and is a NOP for other image types.
3817  *
3818  * @param bootimg
3819  * The image to to manipulate
3820  * @param segment
3821  * Load segment address.
3822  * The data type of this parameter is not fully suitable. You may submit
3823  * negative numbers in the range ((short) 0x8000) to ((short) 0xffff)
3824  * in order to express the non-negative numbers 0x8000 to 0xffff.
3825  *
3826  * @since 0.6.2
3827  */
3828 void el_torito_set_load_seg(ElToritoBootImage *bootimg, short segment);
3829 
3830 /**
3831  * Get the load segment value. See el_torito_set_load_seg().
3832  *
3833  * @param bootimg
3834  * The image to inquire
3835  * @return
3836  * 0 - 65535 : The load segment value
3837  * < 0 : error
3838  *
3839  * @since 0.6.32
3840  */
3842 
3843 /**
3844  * Sets the number of sectors (512b) to be load at load segment during
3845  * the initial boot procedure. This is only for
3846  * no emulation boot images, and is a NOP for other image types.
3847  *
3848  * @param bootimg
3849  * The image to to manipulate
3850  * @param sectors
3851  * Number of 512-byte blocks to be loaded by the BIOS.
3852  * The data type of this parameter is not fully suitable. You may submit
3853  * negative numbers in the range ((short) 0x8000) to ((short) 0xffff)
3854  * in order to express the non-negative numbers 0x8000 to 0xffff.
3855  *
3856  * @since 0.6.2
3857  */
3858 void el_torito_set_load_size(ElToritoBootImage *bootimg, short sectors);
3859 
3860 /**
3861  * Get the load size. See el_torito_set_load_size().
3862  *
3863  * @param bootimg
3864  * The image to inquire
3865  * @return
3866  * 0 - 65535 : The load size value
3867  * < 0 : error
3868  *
3869  * @since 0.6.32
3870  */
3872 
3873 /**
3874  * State that the load size shall be the size of the boot image automatically.
3875  * This overrides el_torito_set_load_size().
3876  * @param bootimg
3877  * The image to to manipulate
3878  * @param mode
3879  * 0= use value of el_torito_set_load_size()
3880  * 1= determine value from boot image
3881  */
3882 void el_torito_set_full_load(ElToritoBootImage *bootimg, int mode);
3883 
3884 /**
3885  * Inquire the setting of el_torito_set_full_load().
3886  * @param bootimg
3887  * The image to inquire
3888  * @return
3889  * The mode set with el_torito_set_full_load().
3890  */
3892 
3893 /**
3894  * Marks the specified boot image as not bootable
3895  *
3896  * @since 0.6.2
3897  */
3899 
3900 /**
3901  * Get the bootability flag. See el_torito_set_no_bootable().
3902  *
3903  * @param bootimg
3904  * The image to inquire
3905  * @return
3906  * 0 = not bootable, 1 = bootable , <0 = error
3907  *
3908  * @since 0.6.32
3909  */
3911 
3912 /**
3913  * Set the id_string of the Validation Entry or Sector Header Entry which
3914  * will govern the boot image Section Entry in the El Torito Catalog.
3915  *
3916  * @param bootimg
3917  * The image to manipulate.
3918  * @param id_string
3919  * The first boot image puts 24 bytes of ID string into the Validation
3920  * Entry, where they shall "identify the manufacturer/developer of
3921  * the CD-ROM".
3922  * Further boot images put 28 bytes into their Section Header.
3923  * El Torito 1.0 states that "If the BIOS understands the ID string, it
3924  * may choose to boot the system using one of these entries in place
3925  * of the INITIAL/DEFAULT entry." (The INITIAL/DEFAULT entry points to the
3926  * first boot image.)
3927  * @return
3928  * 1 = ok , <0 = error
3929  *
3930  * @since 0.6.32
3931  */
3932 int el_torito_set_id_string(ElToritoBootImage *bootimg, uint8_t id_string[28]);
3933 
3934 /**
3935  * Get the id_string as of el_torito_set_id_string().
3936  *
3937  * @param bootimg
3938  * The image to inquire
3939  * @param id_string
3940  * Returns 28 bytes of id string
3941  * @return
3942  * 1 = ok , <0 = error
3943  *
3944  * @since 0.6.32
3945  */
3946 int el_torito_get_id_string(ElToritoBootImage *bootimg, uint8_t id_string[28]);
3947 
3948 /**
3949  * Set the Selection Criteria of a boot image.
3950  *
3951  * @param bootimg
3952  * The image to manipulate.
3953  * @param crit
3954  * The first boot image has no selection criteria. They will be ignored.
3955  * Further boot images put 1 byte of Selection Criteria Type and 19
3956  * bytes of data into their Section Entry.
3957  * El Torito 1.0 states that "The format of the selection criteria is
3958  * a function of the BIOS vendor. In the case of a foreign language
3959  * BIOS three bytes would be used to identify the language".
3960  * Type byte == 0 means "no criteria",
3961  * type byte == 1 means "Language and Version Information (IBM)".
3962  * @return
3963  * 1 = ok , <0 = error
3964  *
3965  * @since 0.6.32
3966  */
3967 int el_torito_set_selection_crit(ElToritoBootImage *bootimg, uint8_t crit[20]);
3968 
3969 /**
3970  * Get the Selection Criteria bytes as of el_torito_set_selection_crit().
3971  *
3972  * @param bootimg
3973  * The image to inquire
3974  * @param crit
3975  * Returns 20 bytes of type and data
3976  * @return
3977  * 1 = ok , <0 = error
3978  *
3979  * @since 0.6.32
3980  */
3981 int el_torito_get_selection_crit(ElToritoBootImage *bootimg, uint8_t crit[20]);
3982 
3983 
3984 /**
3985  * Makes a guess whether the boot image was patched by a boot information
3986  * table. It is advisable to patch such boot images if their content gets
3987  * copied to a new location. See el_torito_set_isolinux_options().
3988  * Note: The reply can be positive only if the boot image was imported
3989  * from an existing ISO image.
3990  *
3991  * @param bootimg
3992  * The image to inquire
3993  * @param flag
3994  * Bitfield for control purposes:
3995  * bit0 - bit3= mode
3996  * 0 = inquire for classic boot info table as described in man mkisofs
3997  * @since 0.6.32
3998  * 1 = inquire for GRUB2 boot info as of bit9 of options of
3999  * el_torito_set_isolinux_options()
4000  * @since 1.3.0
4001  * @return
4002  * 1 = seems to contain the inquired boot info, 0 = quite surely not
4003  * @since 0.6.32
4004  */
4005 int el_torito_seems_boot_info_table(ElToritoBootImage *bootimg, int flag);
4006 
4007 /**
4008  * Specifies options for ISOLINUX or GRUB boot images. This should only be used
4009  * if the type of boot image is known.
4010  *
4011  * @param bootimg
4012  * The image to set options on
4013  * @param options
4014  * bitmask style flag. The following values are defined:
4015  *
4016  * bit0= Patch the boot info table of the boot image.
4017  * This does the same as mkisofs option -boot-info-table.
4018  * Needed for ISOLINUX or GRUB boot images with platform ID 0.
4019  * The table is located at byte 8 of the boot image file.
4020  * Its size is 56 bytes.
4021  * The original boot image file on disk will not be modified.
4022  *
4023  * One may use el_torito_seems_boot_info_table() for a
4024  * qualified guess whether a boot info table is present in
4025  * the boot image. If the result is 1 then it should get bit0
4026  * set if its content gets copied to a new LBA.
4027  *
4028  * bit1= Generate a ISOLINUX isohybrid image with MBR.
4029  * ----------------------------------------------------------
4030  * @deprecated since 31 Mar 2010:
4031  * The author of syslinux, H. Peter Anvin requested that this
4032  * feature shall not be used any more. He intends to cease
4033  * support for the MBR template that is included in libisofs.
4034  * ----------------------------------------------------------
4035  * A hybrid image is a boot image that boots from either
4036  * CD/DVD media or from disk-like media, e.g. USB stick.
4037  * For that you need isolinux.bin from SYSLINUX 3.72 or later.
4038  * IMPORTANT: The application has to take care that the image
4039  * on media gets padded up to the next full MB.
4040  * Under seiveral circumstances it might get aligned
4041  * automatically. But there is no warranty.
4042  * bit2-7= Mentioning in isohybrid GPT
4043  * 0= Do not mention in GPT
4044  * 1= Mention as Basic Data partition.
4045  * This cannot be combined with GPT partitions as of
4046  * iso_write_opts_set_efi_bootp()
4047  * @since 1.2.4
4048  * 2= Mention as HFS+ partition.
4049  * This cannot be combined with HFS+ production by
4050  * iso_write_opts_set_hfsplus().
4051  * @since 1.2.4
4052  * Primary GPT and backup GPT get written if at least one
4053  * ElToritoBootImage shall be mentioned.
4054  * The first three mentioned GPT partitions get mirrored in the
4055  * the partition table of the isohybrid MBR. They get type 0xfe.
4056  * The MBR partition entry for PC-BIOS gets type 0x00 rather
4057  * than 0x17.
4058  * Often it is one of the further MBR partitions which actually
4059  * gets used by EFI.
4060  * @since 1.2.4
4061  * bit8= Mention in isohybrid Apple partition map
4062  * APM get written if at least one ElToritoBootImage shall be
4063  * mentioned. The ISOLINUX MBR must look suitable or else an error
4064  * event will happen at image generation time.
4065  * @since 1.2.4
4066  * bit9= GRUB2 boot info
4067  * Patch the boot image file at byte 1012 with the 512-block
4068  * address + 2. Two little endian 32-bit words. Low word first.
4069  * This is combinable with bit0.
4070  * @since 1.3.0
4071  * @param flag
4072  * Reserved for future usage, set to 0.
4073  * @return
4074  * 1 success, < 0 on error
4075  * @since 0.6.12
4076  */
4078  int options, int flag);
4079 
4080 /**
4081  * Get the options as of el_torito_set_isolinux_options().
4082  *
4083  * @param bootimg
4084  * The image to inquire
4085  * @param flag
4086  * Reserved for future usage, set to 0.
4087  * @return
4088  * >= 0 returned option bits , <0 = error
4089  *
4090  * @since 0.6.32
4091  */
4092 int el_torito_get_isolinux_options(ElToritoBootImage *bootimg, int flag);
4093 
4094 /** Deprecated:
4095  * Specifies that this image needs to be patched. This involves the writing
4096  * of a 16 bytes boot information table at offset 8 of the boot image file.
4097  * The original boot image file won't be modified.
4098  * This is needed for isolinux boot images.
4099  *
4100  * @since 0.6.2
4101  * @deprecated Use el_torito_set_isolinux_options() instead
4102  */
4104 
4105 /**
4106  * Obtain a copy of the eventually loaded first 32768 bytes of the imported
4107  * session, the System Area.
4108  * It will be written to the start of the next session unless it gets
4109  * overwritten by iso_write_opts_set_system_area().
4110  *
4111  * @param img
4112  * The image to be inquired.
4113  * @param data
4114  * A byte array of at least 32768 bytes to take the loaded bytes.
4115  * @param options
4116  * The option bits which will be applied if not overridden by
4117  * iso_write_opts_set_system_area(). See there.
4118  * @param flag
4119  * Bitfield for control purposes, unused yet, submit 0
4120  * @return
4121  * 1 on success, 0 if no System Area was loaded, < 0 error.
4122  * @since 0.6.30
4123  */
4124 int iso_image_get_system_area(IsoImage *img, char data[32768],
4125  int *options, int flag);
4126 
4127 /**
4128  * The maximum length of a single line in the output of function
4129  * iso_image_report_system_area() and iso_image_report_el_torito().
4130  * This number includes the trailing 0.
4131  * @since 1.3.8
4132  */
4133 #define ISO_MAX_SYSAREA_LINE_LENGTH 4096
4134 
4135 /**
4136  * Texts which describe the output format of iso_image_report_system_area().
4137  * They are publicly defined here only as part of the API description.
4138  * Do not use these macros in your application but rather call
4139  * iso_image_report_system_area() with flag bit0.
4140  */
4141 #define ISO_SYSAREA_REPORT_DOC \
4142 \
4143 "Report format for recognized System Area data.", \
4144 "", \
4145 "No text will be reported if no System Area was loaded or if it was", \
4146 "entirely filled with 0-bytes.", \
4147 "Else there will be at least these three lines:", \
4148 " System area options: hex", \
4149 " see libisofs.h, parameter of iso_write_opts_set_system_area().", \
4150 " System area summary: word ... word", \
4151 " human readable interpretation of system area options and other info", \
4152 " The words are from the set:", \
4153 " { MBR, CHRP, PReP, GPT, APM, MIPS-Big-Endian, MIPS-Little-Endian,", \
4154 " SUN-SPARC-Disk-Label, HP-PA-PALO, DEC-Alpha, ", \
4155 " protective-msdos-label, isohybrid, grub2-mbr,", \
4156 " cyl-align-{auto,on,off,all}, not-recognized, }", \
4157 " The acronyms indicate boot data for particular hardware/firmware.", \
4158 " protective-msdos-label is an MBR conformant to specs of GPT.", \
4159 " isohybrid is an MBR implementing ISOLINUX isohybrid functionality.", \
4160 " grub2-mbr is an MBR with GRUB2 64 bit address patching.", \
4161 " cyl-align-on indicates that the ISO image MBR partition ends at a", \
4162 " cylinder boundary. cyl-align-all means that more MBR partitions", \
4163 " exist and all end at a cylinder boundary.", \
4164 " not-recognized tells about unrecognized non-zero system area data.", \
4165 " ISO image size/512 : decimal", \
4166 " size of ISO image in block units of 512 bytes.", \
4167 ""
4168 #define ISO_SYSAREA_REPORT_DOC_MBR \
4169 \
4170 "If an MBR is detected, with at least one partition entry of non-zero size,", \
4171 "then there may be:", \
4172 " Partition offset : decimal", \
4173 " if not 0 then a second ISO 9660 superblock was found to which", \
4174 " MBR partition 1 or GPT partition 1 is pointing.", \
4175 " MBR heads per cyl : decimal", \
4176 " conversion factor between MBR C/H/S address and LBA. 0=inconsistent.", \
4177 " MBR secs per head : decimal", \
4178 " conversion factor between MBR C/H/S address and LBA. 0=inconsistent.", \
4179 " MBR partition table: N Status Type Start Blocks", \
4180 " headline for MBR partition table.", \
4181 " MBR partition : X hex hex decimal decimal", \
4182 " gives partition number, status byte, type byte, start block,", \
4183 " and number of blocks. 512 bytes per block.", \
4184 " MBR partition path : X path", \
4185 " the path of a file in the ISO image which begins at the partition", \
4186 " start block of partition X.", \
4187 " PReP boot partition: decimal decimal", \
4188 " gives start block and size of a PReP boot partition in ISO 9660", \
4189 " block units of 2048 bytes.", \
4190 ""
4191 #define ISO_SYSAREA_REPORT_DOC_GPT1 \
4192 \
4193 "GUID Partition Table can coexist with MBR:", \
4194 " GPT : N Info", \
4195 " headline for GPT partition table. The fields are too wide for a", \
4196 " neat table. So they are listed with a partition number and a text.", \
4197 " GPT CRC should be : <hex> to match first 92 GPT header block bytes", \
4198 " GPT CRC found : <hex> matches all 512 bytes of GPT header block", \
4199 " libisofs-1.2.4 to 1.2.8 had a bug with the GPT header CRC. So", \
4200 " libisofs is willing to recognize GPT with the buggy CRC. These", \
4201 " two lines inform that most partition editors will not accept it.", \
4202 " GPT array CRC wrong: should be <hex>, found <hex>", \
4203 " GPT entry arrays are accepted even if their CRC does not match.", \
4204 " In this case, both CRCs are reported by this line.", \
4205 " GPT backup problems: text", \
4206 " reports about inconsistencies between main GPT and backup GPT.", \
4207 " The statements are comma separated:", \
4208 " Implausible header LBA <decimal>", \
4209 " Cannot read header block at 2k LBA <decimal>", \
4210 " Not a GPT 1.0 header of 92 bytes for 128 bytes per entry", \
4211 " Head CRC <hex> wrong. Should be <hex>", \
4212 " Head CRC <hex> wrong. Should be <hex>. Matches all 512 block bytes", \
4213 " Disk GUID differs (<hex_digits>)", \
4214 " Cannot read array block at 2k LBA <decimal>", \
4215 " Array CRC <hex> wrong. Should be <hex>", \
4216 " Entries differ for partitions <decimal> [... <decimal>]", \
4217 " GPT disk GUID : hex_digits", \
4218 " 32 hex digits giving the byte string of the disk's GUID", \
4219 " GPT entry array : decimal decimal word", \
4220 " start block of partition entry array and number of entries. 512 bytes", \
4221 " per block. The word may be \"separated\" if partitions are disjoint,", \
4222 " \"overlapping\" if they are not. In future there may be \"nested\"", \
4223 " as special case where all overlapping partitions are superset and", \
4224 " subset, and \"covering\" as special case of disjoint partitions", \
4225 " covering the whole GPT block range for partitions.", \
4226 " GPT lba range : decimal decimal decimal", \
4227 " addresses of first payload block, last payload block, and of the", \
4228 " GPT backup header block. 512 bytes per block." \
4229 
4230 #define ISO_SYSAREA_REPORT_DOC_GPT2 \
4231 \
4232 " GPT partition name : X hex_digits", \
4233 " up to 144 hex digits giving the UTF-16LE name byte string of", \
4234 " partition X. Trailing 16 bit 0-characters are omitted.", \
4235 " GPT partname local : X text", \
4236 " the name of partition X converted to the local character set.", \
4237 " This line may be missing if the name cannot be converted, or is", \
4238 " empty.", \
4239 " GPT partition GUID : X hex_digits", \
4240 " 32 hex digits giving the byte string of the GUID of partition X.", \
4241 " GPT type GUID : X hex_digits", \
4242 " 32 hex digits giving the byte string of the type GUID of partition X.", \
4243 " GPT partition flags: X hex", \
4244 " 64 flag bits of partition X in hex representation.", \
4245 " Known bit meanings are:", \
4246 " bit0 = \"System Partition\" Do not alter.", \
4247 " bit2 = Legacy BIOS bootable (MBR partition type 0x80)", \
4248 " bit60= read-only", \
4249 " GPT start and size : X decimal decimal", \
4250 " start block and number of blocks of partition X. 512 bytes per block.", \
4251 " GPT partition path : X path", \
4252 " the path of a file in the ISO image which begins at the partition", \
4253 " start block of partition X.", \
4254 ""
4255 #define ISO_SYSAREA_REPORT_DOC_APM \
4256 \
4257 "Apple partition map can coexist with MBR and GPT:", \
4258 " APM : N Info", \
4259 " headline for human readers.", \
4260 " APM block size : decimal", \
4261 " block size of Apple Partition Map. 512 or 2048. This applies to", \
4262 " start address and size of all partitions in the APM.", \
4263 " APM gap fillers : decimal", \
4264 " tells the number of partitions with name \"Gap[0-9[0-9]]\" and type", \
4265 " \"ISO9660_data\".", \
4266 " APM partition name : X text", \
4267 " the name of partition X. Up to 32 characters.", \
4268 " APM partition type : X text", \
4269 " the type string of partition X. Up to 32 characters.", \
4270 " APM start and size : X decimal decimal", \
4271 " start block and number of blocks of partition X.", \
4272 " APM partition path : X path", \
4273 " the path of a file in the ISO image which begins at the partition", \
4274 " start block of partition X.", \
4275 ""
4276 #define ISO_SYSAREA_REPORT_DOC_MIPS \
4277 \
4278 "If a MIPS Big Endian Volume Header is detected, there may be:", \
4279 " MIPS-BE volume dir : N Name Block Bytes", \
4280 " headline for human readers.", \
4281 " MIPS-BE boot entry : X upto8chr decimal decimal", \
4282 " tells name, 512-byte block address, and byte count of boot entry X.", \
4283 " MIPS-BE boot path : X path", \
4284 " tells the path to the boot image file in the ISO image which belongs", \
4285 " to the block address given by boot entry X.", \
4286 "", \
4287 "If a DEC Boot Block for MIPS Little Endian is detected, there may be:", \
4288 " MIPS-LE boot map : LoadAddr ExecAddr SegmentSize SegmentStart", \
4289 " headline for human readers.", \
4290 " MIPS-LE boot params: decimal decimal decimal decimal", \
4291 " tells four numbers which are originally derived from the ELF header", \
4292 " of the boot file. The first two are counted in bytes, the other two", \
4293 " are counted in blocks of 512 bytes.", \
4294 " MIPS-LE boot path : path", \
4295 " tells the path to the boot file in the ISO image which belongs to the", \
4296 " address given by SegmentStart.", \
4297 " MIPS-LE elf offset : decimal", \
4298 " tells the relative 512-byte block offset inside the boot file:", \
4299 " SegmentStart - FileStartBlock", \
4300 ""
4301 #define ISO_SYSAREA_REPORT_DOC_SUN \
4302 \
4303 "If a SUN SPARC Disk Label is present:", \
4304 " SUN SPARC disklabel: text", \
4305 " tells the disk label text.", \
4306 " SUN SPARC secs/head: decimal", \
4307 " tells the number of sectors per head.", \
4308 " SUN SPARC heads/cyl: decimal", \
4309 " tells the number of heads per cylinder.", \
4310 " SUN SPARC partmap : N IdTag Perms StartCyl NumBlock", \
4311 " headline for human readers.", \
4312 " SUN SPARC partition: X hex hex decimal decimal", \
4313 " gives partition number, type word, permission word, start cylinder,", \
4314 " and number of of blocks. 512 bytes per block. Type word may be: ", \
4315 " 0=unused, 2=root partition with boot, 4=user partition.", \
4316 " Permission word is 0x10 = read-only.", \
4317 " SPARC GRUB2 core : decimal decimal", \
4318 " tells byte address and byte count of the GRUB2 SPARC core file.", \
4319 " SPARC GRUB2 path : path", \
4320 " tells the path to the data file in the ISO image which belongs to the", \
4321 " address given by core.", \
4322 ""
4323 #define ISO_SYSAREA_REPORT_DOC_HPPA \
4324 \
4325 "If a HP-PA PALO boot sector version 4 or 5 is present:", \
4326 " PALO header version: decimal", \
4327 " tells the PALO header version: 4 or 5.", \
4328 " HP-PA cmdline : text", \
4329 " tells the command line for the kernels.", \
4330 " HP-PA boot files : ByteAddr ByteSize Path", \
4331 " headline for human readers.", \
4332 " HP-PA 32-bit kernel: decimal decimal path", \
4333 " tells start byte, byte count, and file path of the 32-bit kernel.", \
4334 " HP-PA 64-bit kernel: decimal decimal path", \
4335 " tells the same for the 64-bit kernel.", \
4336 " HP-PA ramdisk : decimal decimal path", \
4337 " tells the same for the ramdisk file.", \
4338 " HP-PA bootloader : decimal decimal path", \
4339 " tells the same for the bootloader file.", \
4340 ""
4341 #define ISO_SYSAREA_REPORT_DOC_ALPHA \
4342 "If a DEC Alpha SRM boot sector is present:", \
4343 " DEC Alpha ldr size : decimal", \
4344 " tells the number of 512-byte blocks in DEC Alpha Secondary Bootstrap", \
4345 " Loader file.", \
4346 " DEC Alpha ldr adr : decimal", \
4347 " tells the start of the loader file in units of 512-byte blocks.", \
4348 " DEC Alpha ldr path : path", \
4349 " tells the path of a file in the ISO image which starts at the loader", \
4350 " start address."
4351 
4352 /**
4353  * Obtain an array of texts describing the detected properties of the
4354  * eventually loaded System Area.
4355  * The array will be NULL if no System Area was loaded. It will be non-NULL
4356  * with zero line count if the System Area was loaded and contains only
4357  * 0-bytes.
4358  * Else it will consist of lines as described in ISO_SYSAREA_REPORT_DOC above.
4359  *
4360  * File paths and other long texts are reported as "(too long to show here)"
4361  * if their length plus preceding text plus trailing 0-byte exceeds the
4362  * line length limit of ISO_MAX_SYSAREA_LINE_LENGTH bytes.
4363  * Texts which may contain whitespace or unprintable characters will start
4364  * at fixed positions and extend to the end of the line.
4365  * Note that newline characters may well appearing in the middle of a "line".
4366  *
4367  * @param image
4368  * The image to be inquired.
4369  * @param reply
4370  * Will return an array of pointers to the result text lines or NULL.
4371  * Dispose a non-NULL reply by a call to iso_image_report_system_area()
4372  * with flag bit15, when no longer needed.
4373  * Be prepared for a long text with up to ISO_MAX_SYSAREA_LINE_LENGTH
4374  * characters per line.
4375  * @param line_count
4376  * Will return the number of valid pointers in reply.
4377  * @param flag
4378  * Bitfield for control purposes
4379  * bit0= do not report system area but rather reply a copy of
4380  * above text line arrays ISO_SYSAREA_REPORT_DOC*.
4381  * With this bit it is permissible to submit image as NULL.
4382  * bit15= dispose result from previous call.
4383  * @return
4384  * 1 on success, 0 if no System Area was loaded, < 0 error.
4385  * @since 1.3.8
4386  */
4388  char ***reply, int *line_count, int flag);
4389 
4390 /**
4391  * Text which describes the output format of iso_image_report_el_torito().
4392  * It is publicly defined here only as part of the API description.
4393  * Do not use it as macro in your application but rather call
4394  * iso_image_report_el_torito() with flag bit0.
4395  */
4396 #define ISO_ELTORITO_REPORT_DOC \
4397 "Report format for recognized El Torito boot information.", \
4398 "", \
4399 "No text will be reported if no El Torito information was found.", \
4400 "Else there will be at least these three lines", \
4401 " El Torito catalog : decimal decimal", \
4402 " tells the block address and number of 2048-blocks of the boot catalog.", \
4403 " El Torito images : N Pltf B Emul Ld_seg Hdpt Ldsiz LBA", \
4404 " is the headline of the boot image list.", \
4405 " El Torito boot img : X word char word hex hex decimal decimal", \
4406 " tells about boot image number X:", \
4407 " - Platform Id: \"BIOS\", \"PPC\", \"Mac\", \"UEFI\" or a hex number.", \
4408 " - Bootability: either \"y\" or \"n\".", \
4409 " - Emulation: \"none\", \"fd1.2\", \"fd1.4\", \"fd2.8\", \"hd\"", \
4410 " for no emulation, three floppy MB sizes, hard disk.", \
4411 " - Load Segment: start offset in boot image. 0x0000 means 0x07c0.", \
4412 " - Hard disk emulation partition type: MBR partition type code.", \
4413 " - Load size: number of 512-blocks to load with emulation mode \"none\".", \
4414 " - LBA: start block number in ISO filesystem (2048-block).", \
4415 "", \
4416 "The following lines appear conditionally:", \
4417 " El Torito cat path : iso_rr_path", \
4418 " tells the path to the data file in the ISO image which belongs to", \
4419 " the block address where the boot catalog starts.", \
4420 " (This line is not reported if no path points to that block.)", \
4421 " El Torito img path : X iso_rr_path", \
4422 " tells the path to the data file in the ISO image which belongs to", \
4423 " the block address given by LBA of boot image X.", \
4424 " (This line is not reported if no path points to that block.)", \
4425 " El Torito img opts : X word ... word", \
4426 " tells the presence of extra features:", \
4427 " \"boot-info-table\" image got boot info table patching.", \
4428 " \"isohybrid-suitable\" image is suitable for ISOLINUX isohybrid MBR.", \
4429 " \"grub2-boot-info\" image got GRUB2 boot info patching.", \
4430 " (This line is not reported if no such options were detected.)", \
4431 " El Torito id string: X hex_digits", \
4432 " tells the id string of the catalog section which hosts boot image X.", \
4433 " (This line is not reported if the id string is all zero.)", \
4434 " El Torito sel crit : X hex_digits", \
4435 " tells the selection criterion of boot image X.", \
4436 " (This line is not reported if the criterion is all zero.)", \
4437 " El Torito img blks : X decimal", \
4438 " gives an upper limit of the number of 2048-blocks in the boot image", \
4439 " if it is not accessible via a path in the ISO directory tree.", \
4440 " The boot image is supposed to end before the start block of any", \
4441 " other entity of the ISO filesystem.", \
4442 " (This line is not reported if no limiting entity is found.)", \
4443 ""
4444 
4445 /**
4446  * Obtain an array of texts describing the detected properties of the
4447  * eventually loaded El Torito boot information.
4448  * The array will be NULL if no El Torito info was loaded.
4449  * Else it will consist of lines as described in ISO_ELTORITO_REPORT_DOC above.
4450  *
4451  * The lines have the same length restrictions and whitespace rules as the ones
4452  * returned by iso_image_report_system_area().
4453  *
4454  * @param image
4455  * The image to be inquired.
4456  * @param reply
4457  * Will return an array of pointers to the result text lines or NULL.
4458  * Dispose a non-NULL reply by a call to iso_image_report_el_torito()
4459  * with flag bit15, when no longer needed.
4460  * Be prepared for a long text with up to ISO_MAX_SYSAREA_LINE_LENGTH
4461  * characters per line.
4462  * @param line_count
4463  * Will return the number of valid pointers in reply.
4464  * @param flag
4465  * Bitfield for control purposes
4466  * bit0= do not report system area but rather reply a copy of
4467  * above text line array ISO_ELTORITO_REPORT_DOC.
4468  * With this bit it is permissible to submit image as NULL.
4469  * bit15= dispose result from previous call.
4470  * @return
4471  * 1 on success, 0 if no El Torito information was loaded, < 0 error.
4472  * @since 1.3.8
4473  */
4475  char ***reply, int *line_count, int flag);
4476 
4477 
4478 /**
4479  * Compute a CRC number as expected in the GPT main and backup header blocks.
4480  *
4481  * The CRC at byte offset 88 is supposed to cover the array of partition
4482  * entries.
4483  * The CRC at byte offset 16 is supposed to cover the readily produced
4484  * first 92 bytes of the header block while its bytes 16 to 19 are still
4485  * set to 0.
4486  * Block size is 512 bytes. Numbers are stored little-endian.
4487  * See doc/boot_sectors.txt for the byte layout of GPT.
4488  *
4489  * This might be helpful for applications which want to manipulate GPT
4490  * directly. The function is in libisofs/system_area.c and self-contained.
4491  * So if you want to copy+paste it under the license of that file: Be invited.
4492  * Be warned that this implementation works bit-wise and thus is much slower
4493  * than table-driven ones. For less than 32 KiB, it fully suffices, though.
4494  *
4495  * @param data
4496  * The memory buffer with the data to sum up.
4497  * @param count
4498  * Number of bytes in data.
4499  * @param flag
4500  * Bitfield for control purposes. Submit 0.
4501  * @return
4502  * The CRC of data.
4503  * @since 1.3.8
4504  */
4505 uint32_t iso_crc32_gpt(unsigned char *data, int count, int flag);
4506 
4507 /**
4508  * Add a MIPS boot file path to the image.
4509  * Up to 15 such files can be written into a MIPS Big Endian Volume Header
4510  * if this is enabled by value 1 in iso_write_opts_set_system_area() option
4511  * bits 2 to 7.
4512  * A single file can be written into a DEC Boot Block if this is enabled by
4513  * value 2 in iso_write_opts_set_system_area() option bits 2 to 7. So only
4514  * the first added file gets into effect with this system area type.
4515  * The data files which shall serve as MIPS boot files have to be brought into
4516  * the image by the normal means.
4517  * @param image
4518  * The image to be manipulated.
4519  * @param path
4520  * Absolute path of the boot file in the ISO 9660 Rock Ridge tree.
4521  * @param flag
4522  * Bitfield for control purposes, unused yet, submit 0
4523  * @return
4524  * 1 on success, < 0 error
4525  * @since 0.6.38
4526  */
4527 int iso_image_add_mips_boot_file(IsoImage *image, char *path, int flag);
4528 
4529 /**
4530  * Obtain the number of added MIPS Big Endian boot files and pointers to
4531  * their paths in the ISO 9660 Rock Ridge tree.
4532  * @param image
4533  * The image to be inquired.
4534  * @param paths
4535  * An array of pointers to be set to the registered boot file paths.
4536  * This are just pointers to data inside IsoImage. Do not free() them.
4537  * Eventually make own copies of the data before manipulating the image.
4538  * @param flag
4539  * Bitfield for control purposes, unused yet, submit 0
4540  * @return
4541  * >= 0 is the number of valid path pointers , <0 means error
4542  * @since 0.6.38
4543  */
4544 int iso_image_get_mips_boot_files(IsoImage *image, char *paths[15], int flag);
4545 
4546 /**
4547  * Clear the list of MIPS Big Endian boot file paths.
4548  * @param image
4549  * The image to be manipulated.
4550  * @param flag
4551  * Bitfield for control purposes, unused yet, submit 0
4552  * @return
4553  * 1 is success , <0 means error
4554  * @since 0.6.38
4555  */
4556 int iso_image_give_up_mips_boot(IsoImage *image, int flag);
4557 
4558 /**
4559  * Designate a data file in the ISO image of which the position and size
4560  * shall be written after the SUN Disk Label. The position is written as
4561  * 64-bit big-endian number to byte position 0x228. The size is written
4562  * as 32-bit big-endian to 0x230.
4563  * This setting has an effect only if system area type is set to 3
4564  * with iso_write_opts_set_system_area().
4565  *
4566  * @param img
4567  * The image to be manipulated.
4568  * @param sparc_core
4569  * The IsoFile which shall be mentioned after the SUN Disk label.
4570  * NULL is a permissible value. It disables this feature.
4571  * @param flag
4572  * Bitfield for control purposes, unused yet, submit 0
4573  * @return
4574  * 1 is success , <0 means error
4575  * @since 1.3.0
4576  */
4577 int iso_image_set_sparc_core(IsoImage *img, IsoFile *sparc_core, int flag);
4578 
4579 /**
4580  * Obtain the current setting of iso_image_set_sparc_core().
4581  *
4582  * @param img
4583  * The image to be inquired.
4584  * @param sparc_core
4585  * Will return a pointer to the IsoFile (or NULL, which is not an error)
4586  * @param flag
4587  * Bitfield for control purposes, unused yet, submit 0
4588  * @return
4589  * 1 is success , <0 means error
4590  * @since 1.3.0
4591  */
4592 int iso_image_get_sparc_core(IsoImage *img, IsoFile **sparc_core, int flag);
4593 
4594 /**
4595  * Define a command line and submit the paths of four mandatory files for
4596  * production of a HP-PA PALO boot sector for PA-RISC machines.
4597  * The paths must lead to already existing data files in the ISO image
4598  * which stay with these paths until image production.
4599  *
4600  * @param img
4601  * The image to be manipulated.
4602  * @param cmdline
4603  * Up to 127 characters of command line.
4604  * @param bootloader
4605  * Absolute path of a data file in the ISO image.
4606  * @param kernel_32
4607  * Absolute path of a data file in the ISO image which serves as
4608  * 32 bit kernel.
4609  * @param kernel_64
4610  * Absolute path of a data file in the ISO image which serves as
4611  * 64 bit kernel.
4612  * @param ramdisk
4613  * Absolute path of a data file in the ISO image.
4614  * @param flag
4615  * Bitfield for control purposes
4616  * bit0= Let NULL parameters free the corresponding image properties.
4617  * Else only the non-NULL parameters of this call have an effect
4618  * @return
4619  * 1 is success , <0 means error
4620  * @since 1.3.8
4621  */
4622 int iso_image_set_hppa_palo(IsoImage *img, char *cmdline, char *bootloader,
4623  char *kernel_32, char *kernel_64, char *ramdisk,
4624  int flag);
4625 
4626 /**
4627  * Inquire the current settings of iso_image_set_hppa_palo().
4628  * Do not free() the returned pointers.
4629  *
4630  * @param img
4631  * The image to be inquired.
4632  * @param cmdline
4633  * Will return the command line.
4634  * @param bootloader
4635  * Will return the absolute path of the bootloader file.
4636  * @param kernel_32
4637  * Will return the absolute path of the 32 bit kernel file.
4638  * @param kernel_64
4639  * Will return the absolute path of the 64 bit kernel file.
4640  * @param ramdisk
4641  * Will return the absolute path of the RAM disk file.
4642  * @return
4643  * 1 is success , <0 means error
4644  * @since 1.3.8
4645  */
4646 int iso_image_get_hppa_palo(IsoImage *img, char **cmdline, char **bootloader,
4647  char **kernel_32, char **kernel_64, char **ramdisk);
4648 
4649 
4650 /**
4651  * Submit the path of the DEC Alpha Secondary Bootstrap Loader file.
4652  * The path must lead to an already existing data file in the ISO image
4653  * which stays with this path until image production.
4654  * This setting has an effect only if system area type is set to 6
4655  * with iso_write_opts_set_system_area().
4656  *
4657  * @param img
4658  * The image to be manipulated.
4659  * @param boot_loader_path
4660  * Absolute path of a data file in the ISO image.
4661  * Submit NULL to free this image property.
4662  * @param flag
4663  * Bitfield for control purposes. Unused yet. Submit 0.
4664  * @return
4665  * 1 is success , <0 means error
4666  * @since 1.4.0
4667  */
4668 int iso_image_set_alpha_boot(IsoImage *img, char *boot_loader_path, int flag);
4669 
4670 /**
4671  * Inquire the path submitted by iso_image_set_alpha_boot()
4672  * Do not free() the returned pointer.
4673  *
4674  * @param img
4675  * The image to be inquired.
4676  * @param boot_loader_path
4677  * Will return the path. NULL if none is currently submitted.
4678  * @return
4679  * 1 is success , <0 means error
4680  * @since 1.4.0
4681  */
4682 int iso_image_get_alpha_boot(IsoImage *img, char **boot_loader_path);
4683 
4684 
4685 /**
4686  * Increments the reference counting of the given node.
4687  *
4688  * @since 0.6.2
4689  */
4690 void iso_node_ref(IsoNode *node);
4691 
4692 /**
4693  * Decrements the reference couting of the given node.
4694  * If it reach 0, the node is free, and, if the node is a directory,
4695  * its children will be unref() too.
4696  *
4697  * @since 0.6.2
4698  */
4699 void iso_node_unref(IsoNode *node);
4700 
4701 /**
4702  * Get the type of an IsoNode.
4703  *
4704  * @since 0.6.2
4705  */
4707 
4708 /**
4709  * Class of functions to handle particular extended information. A function
4710  * instance acts as an identifier for the type of the information. Structs
4711  * with same information type must use a pointer to the same function.
4712  *
4713  * @param data
4714  * Attached data
4715  * @param flag
4716  * What to do with the data. At this time the following values are
4717  * defined:
4718  * -> 1 the data must be freed
4719  * @return
4720  * 1 in any case.
4721  *
4722  * @since 0.6.4
4723  */
4724 typedef int (*iso_node_xinfo_func)(void *data, int flag);
4725 
4726 /**
4727  * Add extended information to the given node. Extended info allows
4728  * applications (and libisofs itself) to add more information to an IsoNode.
4729  * You can use this facilities to associate temporary information with a given
4730  * node. This information is not written into the ISO 9660 image on media
4731  * and thus does not persist longer than the node memory object.
4732  *
4733  * Each node keeps a list of added extended info, meaning you can add several
4734  * extended info data to each node. Each extended info you add is identified
4735  * by the proc parameter, a pointer to a function that knows how to manage
4736  * the external info data. Thus, in order to add several types of extended
4737  * info, you need to define a "proc" function for each type.
4738  *
4739  * @param node
4740  * The node where to add the extended info
4741  * @param proc
4742  * A function pointer used to identify the type of the data, and that
4743  * knows how to manage it
4744  * @param data
4745  * Extended info to add.
4746  * @return
4747  * 1 if success, 0 if the given node already has extended info of the
4748  * type defined by the "proc" function, < 0 on error
4749  *
4750  * @since 0.6.4
4751  */
4752 int iso_node_add_xinfo(IsoNode *node, iso_node_xinfo_func proc, void *data);
4753 
4754 /**
4755  * Remove the given extended info (defined by the proc function) from the
4756  * given node.
4757  *
4758  * @return
4759  * 1 on success, 0 if node does not have extended info of the requested
4760  * type, < 0 on error
4761  *
4762  * @since 0.6.4
4763  */
4765 
4766 /**
4767  * Remove all extended information from the given node.
4768  *
4769  * @param node
4770  * The node where to remove all extended info
4771  * @param flag
4772  * Bitfield for control purposes, unused yet, submit 0
4773  * @return
4774  * 1 on success, < 0 on error
4775  *
4776  * @since 1.0.2
4777  */
4778 int iso_node_remove_all_xinfo(IsoNode *node, int flag);
4779 
4780 /**
4781  * Get the given extended info (defined by the proc function) from the
4782  * given node.
4783  *
4784  * @param node
4785  * The node to inquire
4786  * @param proc
4787  * The function pointer which serves as key
4788  * @param data
4789  * Will after successful call point to the xinfo data corresponding
4790  * to the given proc. This is a pointer, not a feeable data copy.
4791  * @return
4792  * 1 on success, 0 if node does not have extended info of the requested
4793  * type, < 0 on error
4794  *
4795  * @since 0.6.4
4796  */
4797 int iso_node_get_xinfo(IsoNode *node, iso_node_xinfo_func proc, void **data);
4798 
4799 
4800 /**
4801  * Get the next pair of function pointer and data of an iteration of the
4802  * list of extended informations. Like:
4803  * iso_node_xinfo_func proc;
4804  * void *handle = NULL, *data;
4805  * while (iso_node_get_next_xinfo(node, &handle, &proc, &data) == 1) {
4806  * ... make use of proc and data ...
4807  * }
4808  * The iteration allocates no memory. So you may end it without any disposal
4809  * action.
4810  * IMPORTANT: Do not continue iterations after manipulating the extended
4811  * information of a node. Memory corruption hazard !
4812  * @param node
4813  * The node to inquire
4814  * @param handle
4815  * The opaque iteration handle. Initialize iteration by submitting
4816  * a pointer to a void pointer with value NULL.
4817  * Do not alter its content until iteration has ended.
4818  * @param proc
4819  * The function pointer which serves as key
4820  * @param data
4821  * Will be filled with the extended info corresponding to the given proc
4822  * function
4823  * @return
4824  * 1 on success
4825  * 0 if iteration has ended (proc and data are invalid then)
4826  * < 0 on error
4827  *
4828  * @since 1.0.2
4829  */
4830 int iso_node_get_next_xinfo(IsoNode *node, void **handle,
4831  iso_node_xinfo_func *proc, void **data);
4832 
4833 
4834 /**
4835  * Class of functions to clone extended information. A function instance gets
4836  * associated to a particular iso_node_xinfo_func instance by function
4837  * iso_node_xinfo_make_clonable(). This is a precondition to have IsoNode
4838  * objects clonable which carry data for a particular iso_node_xinfo_func.
4839  *
4840  * @param old_data
4841  * Data item to be cloned
4842  * @param new_data
4843  * Shall return the cloned data item
4844  * @param flag
4845  * Unused yet, submit 0
4846  * The function shall return ISO_XINFO_NO_CLONE on unknown flag bits.
4847  * @return
4848  * > 0 number of allocated bytes
4849  * 0 no size info is available
4850  * < 0 error
4851  *
4852  * @since 1.0.2
4853  */
4854 typedef int (*iso_node_xinfo_cloner)(void *old_data, void **new_data,int flag);
4855 
4856 /**
4857  * Associate a iso_node_xinfo_cloner to a particular class of extended
4858  * information in order to make it clonable.
4859  *
4860  * @param proc
4861  * The key and disposal function which identifies the particular
4862  * extended information class.
4863  * @param cloner
4864  * The cloner function which shall be associated with proc.
4865  * @param flag
4866  * Unused yet, submit 0
4867  * @return
4868  * 1 success, < 0 error
4869  *
4870  * @since 1.0.2
4871  */
4873  iso_node_xinfo_cloner cloner, int flag);
4874 
4875 /**
4876  * Inquire the registered cloner function for a particular class of
4877  * extended information.
4878  *
4879  * @param proc
4880  * The key and disposal function which identifies the particular
4881  * extended information class.
4882  * @param cloner
4883  * Will return the cloner function which is associated with proc, or NULL.
4884  * @param flag
4885  * Unused yet, submit 0
4886  * @return
4887  * 1 success, 0 no cloner registered for proc, < 0 error
4888  *
4889  * @since 1.0.2
4890  */
4892  iso_node_xinfo_cloner *cloner, int flag);
4893 
4894 /**
4895  * Set the name of a node. Note that if the node is already added to a dir
4896  * this can fail if dir already contains a node with the new name.
4897  * The IsoImage context defines a maximum permissible name length and a mode
4898  * how to react on oversized names. See iso_image_set_truncate_mode().
4899  *
4900  * @param image
4901  * The image object to which the node belongs or shall belong in future.
4902  * @param node
4903  * The node of which you want to change the name. One cannot change the
4904  * name of the root directory.
4905  * @param name
4906  * The new name for the node. It may not be empty. If it is oversized
4907  * then it will be handled according to iso_image_set_truncate_mode().
4908  * @param flag
4909  * bit0= issue warning in case of truncation
4910  * @return
4911  * 1 on success, < 0 on error
4912  *
4913  * @since 1.4.2
4914  */
4915 int iso_image_set_node_name(IsoImage *image, IsoNode *node, const char *name,
4916  int flag);
4917 
4918 /**
4919  * *** Deprecated ***
4920  * use iso_image_set_node_name() instead
4921  *
4922  * Set the name of a node without taking into respect name truncation mode of
4923  * an IsoImage.
4924  *
4925  * @param node
4926  * The node whose name you want to change. Note that you can't change
4927  * the name of the root.
4928  * @param name
4929  * The name for the node. If you supply an empty string or a
4930  * name greater than 255 characters this returns with failure, and
4931  * node name is not modified.
4932  * @return
4933  * 1 on success, < 0 on error
4934  *
4935  * @since 0.6.2
4936  */
4937 int iso_node_set_name(IsoNode *node, const char *name);
4938 
4939 
4940 /**
4941  * Get the name of a node.
4942  * The returned string belongs to the node and must not be modified nor
4943  * freed. Use strdup if you really need your own copy.
4944  *
4945  * Up to version 1.4.2 inquiry of the root directory name returned NULL,
4946  * which is a bug in the light of above description.
4947  * Since 1.4.2 the return value is an empty string.
4948  *
4949  * @since 0.6.2
4950  */
4951 const char *iso_node_get_name(const IsoNode *node);
4952 
4953 /**
4954  * Set the permissions for the node. This attribute is only useful when
4955  * Rock Ridge extensions are enabled.
4956  *
4957  * @param node
4958  * The node to change
4959  * @param mode
4960  * bitmask with the permissions of the node, as specified in 'man 2 stat'.
4961  * The file type bitfields will be ignored, only file permissions will be
4962  * modified.
4963  *
4964  * @since 0.6.2
4965  */
4966 void iso_node_set_permissions(IsoNode *node, mode_t mode);
4967 
4968 /**
4969  * Get the permissions for the node
4970  *
4971  * @since 0.6.2
4972  */
4973 mode_t iso_node_get_permissions(const IsoNode *node);
4974 
4975 /**
4976  * Get the mode of the node, both permissions and file type, as specified in
4977  * 'man 2 stat'.
4978  *
4979  * @since 0.6.2
4980  */
4981 mode_t iso_node_get_mode(const IsoNode *node);
4982 
4983 /**
4984  * Set the user id for the node. This attribute is only useful when
4985  * Rock Ridge extensions are enabled.
4986  *
4987  * @since 0.6.2
4988  */
4989 void iso_node_set_uid(IsoNode *node, uid_t uid);
4990 
4991 /**
4992  * Get the user id of the node.
4993  *
4994  * @since 0.6.2
4995  */
4996 uid_t iso_node_get_uid(const IsoNode *node);
4997 
4998 /**
4999  * Set the group id for the node. This attribute is only useful when
5000  * Rock Ridge extensions are enabled.
5001  *
5002  * @since 0.6.2
5003  */
5004 void iso_node_set_gid(IsoNode *node, gid_t gid);
5005 
5006 /**
5007  * Get the group id of the node.
5008  *
5009  * @since 0.6.2
5010  */
5011 gid_t iso_node_get_gid(const IsoNode *node);
5012 
5013 /**
5014  * Set the time of last modification of the file
5015  *
5016  * @since 0.6.2
5017  */
5018 void iso_node_set_mtime(IsoNode *node, time_t time);
5019 
5020 /**
5021  * Get the time of last modification of the file
5022  *
5023  * @since 0.6.2
5024  */
5025 time_t iso_node_get_mtime(const IsoNode *node);
5026 
5027 /**
5028  * Set the time of last access to the file
5029  *
5030  * @since 0.6.2
5031  */
5032 void iso_node_set_atime(IsoNode *node, time_t time);
5033 
5034 /**
5035  * Get the time of last access to the file
5036  *
5037  * @since 0.6.2
5038  */
5039 time_t iso_node_get_atime(const IsoNode *node);
5040 
5041 /**
5042  * Set the time of last status change of the file
5043  *
5044  * @since 0.6.2
5045  */
5046 void iso_node_set_ctime(IsoNode *node, time_t time);
5047 
5048 /**
5049  * Get the time of last status change of the file
5050  *
5051  * @since 0.6.2
5052  */
5053 time_t iso_node_get_ctime(const IsoNode *node);
5054 
5055 /**
5056  * Set whether the node will be hidden in the directory trees of RR/ISO 9660,
5057  * or of Joliet (if enabled at all), or of ISO-9660:1999 (if enabled at all).
5058  *
5059  * A hidden file does not show up by name in the affected directory tree.
5060  * For example, if a file is hidden only in Joliet, it will normally
5061  * not be visible on Windows systems, while being shown on GNU/Linux.
5062  *
5063  * If a file is not shown in any of the enabled trees, then its content will
5064  * not be written to the image, unless LIBISO_HIDE_BUT_WRITE is given (which
5065  * is available only since release 0.6.34).
5066  *
5067  * @param node
5068  * The node that is to be hidden.
5069  * @param hide_attrs
5070  * Or-combination of values from enum IsoHideNodeFlag to set the trees
5071  * in which the node's name shall be hidden.
5072  *
5073  * @since 0.6.2
5074  */
5075 void iso_node_set_hidden(IsoNode *node, int hide_attrs);
5076 
5077 /**
5078  * Get the hide_attrs as eventually set by iso_node_set_hidden().
5079  *
5080  * @param node
5081  * The node to inquire.
5082  * @return
5083  * Or-combination of values from enum IsoHideNodeFlag which are
5084  * currently set for the node.
5085  *
5086  * @since 0.6.34
5087  */
5088 int iso_node_get_hidden(IsoNode *node);
5089 
5090 /**
5091  * Compare two nodes whether they are based on the same input and
5092  * can be considered as hardlinks to the same file objects.
5093  *
5094  * @param n1
5095  * The first node to compare.
5096  * @param n2
5097  * The second node to compare.
5098  * @return
5099  * -1 if n1 is smaller n2 , 0 if n1 matches n2 , 1 if n1 is larger n2
5100  * @param flag
5101  * Bitfield for control purposes, unused yet, submit 0
5102  * @since 0.6.20
5103  */
5104 int iso_node_cmp_ino(IsoNode *n1, IsoNode *n2, int flag);
5105 
5106 /**
5107  * Add a new node to a dir. Note that this function don't add a new ref to
5108  * the node, so you don't need to free it, it will be automatically freed
5109  * when the dir is deleted. Of course, if you want to keep using the node
5110  * after the dir life, you need to iso_node_ref() it.
5111  *
5112  * @param dir
5113  * the dir where to add the node
5114  * @param child
5115  * the node to add. You must ensure that the node hasn't previously added
5116  * to other dir, and that the node name is unique inside the child.
5117  * Otherwise this function will return a failure, and the child won't be
5118  * inserted.
5119  * @param replace
5120  * if the dir already contains a node with the same name, whether to
5121  * replace or not the old node with this.
5122  * @return
5123  * number of nodes in dir if succes, < 0 otherwise
5124  * Possible errors:
5125  * ISO_NULL_POINTER, if dir or child are NULL
5126  * ISO_NODE_ALREADY_ADDED, if child is already added to other dir
5127  * ISO_NODE_NAME_NOT_UNIQUE, a node with same name already exists
5128  * ISO_WRONG_ARG_VALUE, if child == dir, or replace != (0,1)
5129  *
5130  * @since 0.6.2
5131  */
5132 int iso_dir_add_node(IsoDir *dir, IsoNode *child,
5133  enum iso_replace_mode replace);
5134 
5135 /**
5136  * Locate a node inside a given dir.
5137  *
5138  * The IsoImage context defines a maximum permissible name length and a mode
5139  * how to react on oversized names. See iso_image_set_truncate_mode().
5140  * If the caller looks for an oversized name and image truncate mode is 1,
5141  * then this call looks for the truncated name among the nodes of dir.
5142  *
5143  * @param image
5144  * The image object to which dir belongs.
5145  * @param dir
5146  * The dir where to look for the node.
5147  * @param name
5148  * The name of the node. (Will not be changed if truncation happens.)
5149  * @param node
5150  * Location for a pointer to the node, it will filled with NULL if the dir
5151  * doesn't have a child with the given name.
5152  * The node will be owned by the dir and shouldn't be unref(). Just call
5153  * iso_node_ref() to get your own reference to the node.
5154  * Note that you can pass NULL is the only thing you want to do is check
5155  * if a node with such name already exists on dir.
5156  * @param flag
5157  * Bitfield for control purposes.
5158  * bit0= do not truncate name but lookup exactly as given.
5159  * @return
5160  * 1 node found
5161  * 0 no name truncation was needed, name not found in dir
5162  * 2 name truncation happened, truncated name not found in dir
5163  * < 0 error, see iso_dir_get_node().
5164  *
5165  * @since 1.4.2
5166  */
5167 int iso_image_dir_get_node(IsoImage *image, IsoDir *dir,
5168  const char *name, IsoNode **node, int flag);
5169 
5170 /**
5171  * *** Deprecated ***
5172  * In most cases use iso_image_dir_get_node() instead.
5173  *
5174  * Locate a node inside a given dir without taking into respect name truncation
5175  * mode of an IsoImage.
5176  *
5177  * @param dir
5178  * The dir where to look for the node.
5179  * @param name
5180  * The name of the node
5181  * @param node
5182  * Location for a pointer to the node. See iso_image_get_node().
5183  * @return
5184  * 1 node found, 0 child has no such node, < 0 error
5185  * Possible errors:
5186  * ISO_NULL_POINTER, if dir or name are NULL
5187  *
5188  * @since 0.6.2
5189  */
5190 int iso_dir_get_node(IsoDir *dir, const char *name, IsoNode **node);
5191 
5192 /**
5193  * Get the number of children of a directory.
5194  *
5195  * @return
5196  * >= 0 number of items, < 0 error
5197  * Possible errors:
5198  * ISO_NULL_POINTER, if dir is NULL
5199  *
5200  * @since 0.6.2
5201  */
5203 
5204 /**
5205  * Removes a child from a directory.
5206  * The child is not freed, so you will become the owner of the node. Later
5207  * you can add the node to another dir (calling iso_dir_add_node), or free
5208  * it if you don't need it (with iso_node_unref).
5209  *
5210  * @return
5211  * 1 on success, < 0 error
5212  * Possible errors:
5213  * ISO_NULL_POINTER, if node is NULL
5214  * ISO_NODE_NOT_ADDED_TO_DIR, if node doesn't belong to a dir
5215  *
5216  * @since 0.6.2
5217  */
5218 int iso_node_take(IsoNode *node);
5219 
5220 /**
5221  * Removes a child from a directory and free (unref) it.
5222  * If you want to keep the child alive, you need to iso_node_ref() it
5223  * before this call, but in that case iso_node_take() is a better
5224  * alternative.
5225  *
5226  * @return
5227  * 1 on success, < 0 error
5228  *
5229  * @since 0.6.2
5230  */
5231 int iso_node_remove(IsoNode *node);
5232 
5233 /*
5234  * Get the parent of the given iso tree node. No extra ref is added to the
5235  * returned directory, you must take your ref. with iso_node_ref() if you
5236  * need it.
5237  *
5238  * If node is the root node, the same node will be returned as its parent.
5239  *
5240  * This returns NULL if the node doesn't pertain to any tree
5241  * (it was removed/taken).
5242  *
5243  * @since 0.6.2
5244  */
5246 
5247 /**
5248  * Get an iterator for the children of the given dir.
5249  *
5250  * You can iterate over the children with iso_dir_iter_next. When finished,
5251  * you should free the iterator with iso_dir_iter_free.
5252  * You musn't delete a child of the same dir, using iso_node_take() or
5253  * iso_node_remove(), while you're using the iterator. You can use
5254  * iso_dir_iter_take() or iso_dir_iter_remove() instead.
5255  *
5256  * You can use the iterator in the way like this
5257  *
5258  * IsoDirIter *iter;
5259  * IsoNode *node;
5260  * if ( iso_dir_get_children(dir, &iter) != 1 ) {
5261  * // handle error
5262  * }
5263  * while ( iso_dir_iter_next(iter, &node) == 1 ) {
5264  * // do something with the child
5265  * }
5266  * iso_dir_iter_free(iter);
5267  *
5268  * An iterator is intended to be used in a single iteration over the
5269  * children of a dir. Thus, it should be treated as a temporary object,
5270  * and free as soon as possible.
5271  *
5272  * @return
5273  * 1 success, < 0 error
5274  * Possible errors:
5275  * ISO_NULL_POINTER, if dir or iter are NULL
5276  * ISO_OUT_OF_MEM
5277  *
5278  * @since 0.6.2
5279  */
5280 int iso_dir_get_children(const IsoDir *dir, IsoDirIter **iter);
5281 
5282 /**
5283  * Get the next child.
5284  * Take care that the node is owned by its parent, and will be unref() when
5285  * the parent is freed. If you want your own ref to it, call iso_node_ref()
5286  * on it.
5287  *
5288  * @return
5289  * 1 success, 0 if dir has no more elements, < 0 error
5290  * Possible errors:
5291  * ISO_NULL_POINTER, if node or iter are NULL
5292  * ISO_ERROR, on wrong iter usage, usual caused by modiying the
5293  * dir during iteration
5294  *
5295  * @since 0.6.2
5296  */
5297 int iso_dir_iter_next(IsoDirIter *iter, IsoNode **node);
5298 
5299 /**
5300  * Check if there're more children.
5301  *
5302  * @return
5303  * 1 dir has more elements, 0 no, < 0 error
5304  * Possible errors:
5305  * ISO_NULL_POINTER, if iter is NULL
5306  *
5307  * @since 0.6.2
5308  */
5310 
5311 /**
5312  * Free a dir iterator.
5313  *
5314  * @since 0.6.2
5315  */
5316 void iso_dir_iter_free(IsoDirIter *iter);
5317 
5318 /**
5319  * Removes a child from a directory during an iteration, without freeing it.
5320  * It's like iso_node_take(), but to be used during a directory iteration.
5321  * The node removed will be the last returned by the iteration.
5322  *
5323  * If you call this function twice without calling iso_dir_iter_next between
5324  * them is not allowed and you will get an ISO_ERROR in second call.
5325  *
5326  * @return
5327  * 1 on succes, < 0 error
5328  * Possible errors:
5329  * ISO_NULL_POINTER, if iter is NULL
5330  * ISO_ERROR, on wrong iter usage, for example by call this before
5331  * iso_dir_iter_next.
5332  *
5333  * @since 0.6.2
5334  */
5335 int iso_dir_iter_take(IsoDirIter *iter);
5336 
5337 /**
5338  * Removes a child from a directory during an iteration and unref() it.
5339  * Like iso_node_remove(), but to be used during a directory iteration.
5340  * The node removed will be the one returned by the previous iteration.
5341  *
5342  * It is not allowed to call this function twice without calling
5343  * iso_dir_iter_next between the calls.
5344  *
5345  * @return
5346  * 1 on succes, < 0 error
5347  * Possible errors:
5348  * ISO_NULL_POINTER, if iter is NULL
5349  * ISO_ERROR, on wrong iter usage, for example by calling this before
5350  * iso_dir_iter_next.
5351  *
5352  * @since 0.6.2
5353  */
5354 int iso_dir_iter_remove(IsoDirIter *iter);
5355 
5356 /**
5357  * Removes a node by iso_node_remove() or iso_dir_iter_remove(). If the node
5358  * is a directory then the whole tree of nodes underneath is removed too.
5359  *
5360  * @param node
5361  * The node to be removed.
5362  * @param boss_iter
5363  * If not NULL, then the node will be removed by
5364  * iso_dir_iter_remove(boss_iter)
5365  * else it will be removed by iso_node_remove(node).
5366  * @return
5367  * 1 is success, <0 indicates error
5368  *
5369  * @since 1.0.2
5370  */
5371 int iso_node_remove_tree(IsoNode *node, IsoDirIter *boss_iter);
5372 
5373 
5374 /**
5375  * @since 0.6.4
5376  */
5377 typedef struct iso_find_condition IsoFindCondition;
5378 
5379 /**
5380  * Create a new condition that checks if the node name matches the given
5381  * wildcard.
5382  *
5383  * @param wildcard
5384  * @result
5385  * The created IsoFindCondition, NULL on error.
5386  *
5387  * @since 0.6.4
5388  */
5389 IsoFindCondition *iso_new_find_conditions_name(const char *wildcard);
5390 
5391 /**
5392  * Create a new condition that checks the node mode against a mode mask. It
5393  * can be used to check both file type and permissions.
5394  *
5395  * For example:
5396  *
5397  * iso_new_find_conditions_mode(S_IFREG) : search for regular files
5398  * iso_new_find_conditions_mode(S_IFCHR | S_IWUSR) : search for character
5399  * devices where owner has write permissions.
5400  *
5401  * @param mask
5402  * Mode mask to AND against node mode.
5403  * @result
5404  * The created IsoFindCondition, NULL on error.
5405  *
5406  * @since 0.6.4
5407  */
5409 
5410 /**
5411  * Create a new condition that checks the node gid.
5412  *
5413  * @param gid
5414  * Desired Group Id.
5415  * @result
5416  * The created IsoFindCondition, NULL on error.
5417  *
5418  * @since 0.6.4
5419  */
5421 
5422 /**
5423  * Create a new condition that checks the node uid.
5424  *
5425  * @param uid
5426  * Desired User Id.
5427  * @result
5428  * The created IsoFindCondition, NULL on error.
5429  *
5430  * @since 0.6.4
5431  */
5433 
5434 /**
5435  * Possible comparison between IsoNode and given conditions.
5436  *
5437  * @since 0.6.4
5438  */
5445 };
5446 
5447 /**
5448  * Create a new condition that checks the time of last access.
5449  *
5450  * @param time
5451  * Time to compare against IsoNode atime.
5452  * @param comparison
5453  * Comparison to be done between IsoNode atime and submitted time.
5454  * Note that ISO_FIND_COND_GREATER, for example, is true if the node
5455  * time is greater than the submitted time.
5456  * @result
5457  * The created IsoFindCondition, NULL on error.
5458  *
5459  * @since 0.6.4
5460  */
5462  enum iso_find_comparisons comparison);
5463 
5464 /**
5465  * Create a new condition that checks the time of last modification.
5466  *
5467  * @param time
5468  * Time to compare against IsoNode mtime.
5469  * @param comparison
5470  * Comparison to be done between IsoNode mtime and submitted time.
5471  * Note that ISO_FIND_COND_GREATER, for example, is true if the node
5472  * time is greater than the submitted time.
5473  * @result
5474  * The created IsoFindCondition, NULL on error.
5475  *
5476  * @since 0.6.4
5477  */
5479  enum iso_find_comparisons comparison);
5480 
5481 /**
5482  * Create a new condition that checks the time of last status change.
5483  *
5484  * @param time
5485  * Time to compare against IsoNode ctime.
5486  * @param comparison
5487  * Comparison to be done between IsoNode ctime and submitted time.
5488  * Note that ISO_FIND_COND_GREATER, for example, is true if the node
5489  * time is greater than the submitted time.
5490  * @result
5491  * The created IsoFindCondition, NULL on error.
5492  *
5493  * @since 0.6.4
5494  */
5496  enum iso_find_comparisons comparison);
5497 
5498 /**
5499  * Create a new condition that check if the two given conditions are
5500  * valid.
5501  *
5502  * @param a
5503  * @param b
5504  * IsoFindCondition to compare
5505  * @result
5506  * The created IsoFindCondition, NULL on error.
5507  *
5508  * @since 0.6.4
5509  */
5511  IsoFindCondition *b);
5512 
5513 /**
5514  * Create a new condition that check if at least one the two given conditions
5515  * is valid.
5516  *
5517  * @param a
5518  * @param b
5519  * IsoFindCondition to compare
5520  * @result
5521  * The created IsoFindCondition, NULL on error.
5522  *
5523  * @since 0.6.4
5524  */
5526  IsoFindCondition *b);
5527 
5528 /**
5529  * Create a new condition that check if the given conditions is false.
5530  *
5531  * @param negate
5532  * @result
5533  * The created IsoFindCondition, NULL on error.
5534  *
5535  * @since 0.6.4
5536  */
5538 
5539 /**
5540  * Find all directory children that match the given condition.
5541  *
5542  * @param dir
5543  * Directory where we will search children.
5544  * @param cond
5545  * Condition that the children must match in order to be returned.
5546  * It will be free together with the iterator. Remember to delete it
5547  * if this function return error.
5548  * @param iter
5549  * Iterator that returns only the children that match condition.
5550  * @return
5551  * 1 on success, < 0 on error
5552  *
5553  * @since 0.6.4
5554  */
5556  IsoDirIter **iter);
5557 
5558 /**
5559  * Get the destination of a node.
5560  * The returned string belongs to the node and must not be modified nor
5561  * freed. Use strdup if you really need your own copy.
5562  *
5563  * @since 0.6.2
5564  */
5565 const char *iso_symlink_get_dest(const IsoSymlink *link);
5566 
5567 /**
5568  * Set the destination of a symbolic
5569  *
5570  * @param link
5571  * The link node to be manipulated
5572  * @param dest
5573  * New destination for the link. It must be a non-empty string, otherwise
5574  * this function doesn't modify previous destination.
5575  * @return
5576  * 1 on success, < 0 on error
5577  *
5578  * @since 0.6.2
5579  */
5580 int iso_symlink_set_dest(IsoSymlink *link, const char *dest);
5581 
5582 /**
5583  * Sets the order in which a node will be written on image. The data content
5584  * of files with high weight will be written to low block addresses.
5585  *
5586  * @param node
5587  * The node which weight will be changed. If it's a dir, this function
5588  * will change the weight of all its children. For nodes other that dirs
5589  * or regular files, this function has no effect.
5590  * @param w
5591  * The weight as a integer number, the greater this value is, the
5592  * closer from the beginning of image the file will be written.
5593  * Default value at IsoNode creation is 0.
5594  *
5595  * @since 0.6.2
5596  */
5597 void iso_node_set_sort_weight(IsoNode *node, int w);
5598 
5599 /**
5600  * Get the sort weight of a file.
5601  *
5602  * @since 0.6.2
5603  */
5605 
5606 /**
5607  * Get the size of the file, in bytes
5608  *
5609  * @since 0.6.2
5610  */
5611 off_t iso_file_get_size(IsoFile *file);
5612 
5613 /**
5614  * Get the device id (major/minor numbers) of the given block or
5615  * character device file. The result is undefined for other kind
5616  * of special files, of first be sure iso_node_get_mode() returns either
5617  * S_IFBLK or S_IFCHR.
5618  *
5619  * @since 0.6.6
5620  */
5621 dev_t iso_special_get_dev(IsoSpecial *special);
5622 
5623 /**
5624  * Get the IsoStream that represents the contents of the given IsoFile.
5625  * The stream may be a filter stream which itself get its input from a
5626  * further stream. This may be inquired by iso_stream_get_input_stream().
5627  *
5628  * If you iso_stream_open() the stream, iso_stream_close() it before
5629  * image generation begins.
5630  *
5631  * @return
5632  * The IsoStream. No extra ref is added, so the IsoStream belongs to the
5633  * IsoFile, and it may be freed together with it. Add your own ref with
5634  * iso_stream_ref() if you need it.
5635  *
5636  * @since 0.6.4
5637  */
5639 
5640 /**
5641  * Get the block lba of a file node, if it was imported from an old image.
5642  *
5643  * @param file
5644  * The file
5645  * @param lba
5646  * Will be filled with the kba
5647  * @param flag
5648  * Reserved for future usage, submit 0
5649  * @return
5650  * 1 if lba is valid (file comes from old image and has only one section),
5651  * 0 if file was newly added, i.e. it does not come from an old image,
5652  * < 0 error, especially ISO_WRONG_ARG_VALUE if the file has more than
5653  * one file section.
5654  *
5655  * @since 0.6.4
5656  *
5657  * @deprecated Use iso_file_get_old_image_sections(), as this function does
5658  * not work with multi-extend files.
5659  */
5660 int iso_file_get_old_image_lba(IsoFile *file, uint32_t *lba, int flag);
5661 
5662 /**
5663  * Get the start addresses and the sizes of the data extents of a file node
5664  * if it was imported from an old image.
5665  *
5666  * @param file
5667  * The file
5668  * @param section_count
5669  * Returns the number of extent entries in sections array.
5670  * @param sections
5671  * Returns the array of file sections if section_count > 0.
5672  * In this case, apply free() to dispose it.
5673  * @param flag
5674  * Reserved for future usage, submit 0
5675  * @return
5676  * 1 if there are valid extents (file comes from old image),
5677  * 0 if file was newly added, i.e. it does not come from an old image,
5678  * < 0 error
5679  *
5680  * @since 0.6.8
5681  */
5682 int iso_file_get_old_image_sections(IsoFile *file, int *section_count,
5683  struct iso_file_section **sections,
5684  int flag);
5685 
5686 /*
5687  * Like iso_file_get_old_image_lba(), but take an IsoNode.
5688  *
5689  * @return
5690  * 1 if lba is valid (file comes from old image), 0 if file was newly
5691  * added, i.e. it does not come from an old image, 2 node type has no
5692  * LBA (no regular file), < 0 error
5693  *
5694  * @since 0.6.4
5695  */
5696 int iso_node_get_old_image_lba(IsoNode *node, uint32_t *lba, int flag);
5697 
5698 /**
5699  * Add a new directory to the iso tree. Permissions, owner and hidden atts
5700  * are taken from parent, you can modify them later.
5701  *
5702  * @param image
5703  * The image object to which the new directory shall belong.
5704  * @param parent
5705  * The directory node where the new directory will be grafted in.
5706  * @param name
5707  * Name for the new directory. If truncation mode is set to 1,
5708  * an oversized name gets truncated before further processing.
5709  * If a node with same name already exists on parent, this function
5710  * fails with ISO_NODE_NAME_NOT_UNIQUE.
5711  * @param dir
5712  * place where to store a pointer to the newly created dir. No extra
5713  * ref is addded, so you will need to call iso_node_ref() if you really
5714  * need it. You can pass NULL in this parameter if you don't need the
5715  * pointer.
5716  * @return
5717  * number of nodes in parent if success, < 0 otherwise
5718  * Possible errors:
5719  * ISO_NULL_POINTER, if parent or name are NULL
5720  * ISO_NODE_NAME_NOT_UNIQUE, a node with same name already exists
5721  * ISO_OUT_OF_MEM
5722  * ISO_RR_NAME_TOO_LONG
5723  *
5724  * @since 1.4.2
5725  */
5726 int iso_image_add_new_dir(IsoImage *image, IsoDir *parent, const char *name,
5727  IsoDir **dir);
5728 
5729 /**
5730  * *** Deprecated ***
5731  * use iso_image_add_new_dir() instead
5732  *
5733  * Add a new directory to the iso tree without taking into respect name
5734  * truncation mode of an IsoImage.
5735  * For detailed description of parameters, see above iso_image_add_new_dir().
5736  *
5737  * @param parent
5738  * the dir where the new directory will be created
5739  * @param name
5740  * name for the new dir.
5741  * @param dir
5742  * place where to store a pointer to the newly created dir.i
5743  * @return
5744  * number of nodes in parent if success, < 0 otherwise
5745  * Possible errors:
5746  * ISO_NULL_POINTER, if parent or name are NULL
5747  * ISO_NODE_NAME_NOT_UNIQUE, a node with same name already exists
5748  * ISO_OUT_OF_MEM
5749  *
5750  * @since 0.6.2
5751  */
5752 int iso_tree_add_new_dir(IsoDir *parent, const char *name, IsoDir **dir);
5753 
5754 /**
5755  * Add a new regular file to the iso tree. Permissions are set to 0444,
5756  * owner and hidden atts are taken from parent. You can modify any of them
5757  * later.
5758  *
5759  * @param image
5760  * The image object to which the new file shall belong.
5761  * @param parent
5762  * The directory node where the new directory will be grafted in.
5763  * @param name
5764  * Name for the new file. If truncation mode is set to 1,
5765  * an oversized name gets truncated before further processing.
5766  * If a node with same name already exists on parent, this function
5767  * fails with ISO_NODE_NAME_NOT_UNIQUE.
5768  * @param stream
5769  * IsoStream for the contents of the file. The reference will be taken
5770  * by the newly created file, you will need to take an extra ref to it
5771  * if you need it.
5772  * @param file
5773  * place where to store a pointer to the newly created file. No extra
5774  * ref is addded, so you will need to call iso_node_ref() if you really
5775  * need it. You can pass NULL in this parameter if you don't need the
5776  * pointer
5777  * @return
5778  * number of nodes in parent if success, < 0 otherwise
5779  * Possible errors:
5780  * ISO_NULL_POINTER, if parent, name or dest are NULL
5781  * ISO_NODE_NAME_NOT_UNIQUE, a node with same name already exists
5782  * ISO_OUT_OF_MEM
5783  * ISO_RR_NAME_TOO_LONG
5784  *
5785  * @since 1.4.2
5786  */
5787 int iso_image_add_new_file(IsoImage *image, IsoDir *parent, const char *name,
5788  IsoStream *stream, IsoFile **file);
5789 
5790 /**
5791  * *** Deprecated ***
5792  * use iso_image_add_new_file() instead
5793  *
5794  * Add a new regular file to the iso tree without taking into respect name
5795  * truncation mode of an IsoImage.
5796  * For detailed description of parameters, see above iso_image_add_new_file().
5797  *
5798  * @param parent
5799  * the dir where the new file will be created
5800  * @param name
5801  * name for the new file.
5802  * @param stream
5803  * IsoStream for the contents of the file.
5804  * @param file
5805  * place where to store a pointer to the newly created file.
5806  * @return
5807  * number of nodes in parent if success, < 0 otherwise
5808  * Possible errors:
5809  * ISO_NULL_POINTER, if parent, name or dest are NULL
5810  * ISO_NODE_NAME_NOT_UNIQUE, a node with same name already exists
5811  * ISO_OUT_OF_MEM
5812  *
5813  * @since 0.6.4
5814  */
5815 int iso_tree_add_new_file(IsoDir *parent, const char *name, IsoStream *stream,
5816  IsoFile **file);
5817 
5818 /**
5819  * Create an IsoStream object from content which is stored in a dynamically
5820  * allocated memory buffer. The new stream will become owner of the buffer
5821  * and apply free() to it when the stream finally gets destroyed itself.
5822  *
5823  * @param buf
5824  * The dynamically allocated memory buffer with the stream content.
5825  * @param size
5826  * The number of bytes which may be read from buf.
5827  * @param stream
5828  * Will return a reference to the newly created stream.
5829  * @return
5830  * ISO_SUCCESS or <0 for error. E.g. ISO_NULL_POINTER, ISO_OUT_OF_MEM.
5831  *
5832  * @since 1.0.0
5833  */
5834 int iso_memory_stream_new(unsigned char *buf, size_t size, IsoStream **stream);
5835 
5836 /**
5837  * Add a new symbolic link to the directory tree. Permissions are set to 0777,
5838  * owner and hidden atts are taken from parent. You can modify any of them
5839  * later.
5840  *
5841  * @param image
5842  * The image object to which the new directory shall belong.
5843  * @param parent
5844  * The directory node where the new symlink will be grafted in.
5845  * @param name
5846  * Name for the new symlink. If truncation mode is set to 1,
5847  * an oversized name gets truncated before further processing.
5848  * If a node with same name already exists on parent, this function
5849  * fails with ISO_NODE_NAME_NOT_UNIQUE.
5850  * @param dest
5851  * The destination path of the link. The components of this path are
5852  * not checked for being oversized.
5853  * @param link
5854  * Place where to store a pointer to the newly created link. No extra
5855  * ref is addded, so you will need to call iso_node_ref() if you really
5856  * need it. You can pass NULL in this parameter if you don't need the
5857  * pointer
5858  * @return
5859  * number of nodes in parent if success, < 0 otherwise
5860  * Possible errors:
5861  * ISO_NULL_POINTER, if parent, name or dest are NULL
5862  * ISO_NODE_NAME_NOT_UNIQUE, a node with same name already exists
5863  * ISO_OUT_OF_MEM
5864  * ISO_RR_NAME_TOO_LONG
5865  *
5866  * @since 1.4.2
5867  */
5868 int iso_image_add_new_symlink(IsoImage *image, IsoDir *parent,
5869  const char *name, const char *dest,
5870  IsoSymlink **link);
5871 
5872 /**
5873  * *** Deprecated ***
5874  * use iso_image_add_new_symlink() instead
5875  *
5876  * Add a new symlink to the directory tree without taking into respect name
5877  * truncation mode of an IsoImage.
5878  * For detailed description of parameters, see above
5879  * iso_image_add_new_isymlink().
5880  *
5881  * @param parent
5882  * the dir where the new symlink will be created
5883  * @param name
5884  * name for the new symlink.
5885  * @param dest
5886  * destination of the link
5887  * @param link
5888  * place where to store a pointer to the newly created link.
5889  * @return
5890  * number of nodes in parent if success, < 0 otherwise
5891  * Possible errors:
5892  * ISO_NULL_POINTER, if parent, name or dest are NULL
5893  * ISO_NODE_NAME_NOT_UNIQUE, a node with same name already exists
5894  * ISO_OUT_OF_MEM
5895  *
5896  * @since 0.6.2
5897  */
5898 int iso_tree_add_new_symlink(IsoDir *parent, const char *name,
5899  const char *dest, IsoSymlink **link);
5900 
5901 /**
5902  * Add a new special file to the directory tree. As far as libisofs concerns,
5903  * a special file is a block device, a character device, a FIFO (named pipe)
5904  * or a socket. You can choose the specific kind of file you want to add
5905  * by setting mode propertly (see man 2 stat).
5906  *
5907  * Note that special files are only written to image when Rock Ridge
5908  * extensions are enabled. Moreover, a special file is just a directory entry
5909  * in the image tree, no data is written beyond that.
5910  *
5911  * Owner and hidden atts are taken from parent. You can modify any of them
5912  * later.
5913  *
5914  * @param image
5915  * The image object to which the new special file shall belong.
5916  * @param parent
5917  * The directory node where the new special file will be grafted in.
5918  * @param name
5919  * Name for the new special file. If truncation mode is set to 1,
5920  * an oversized name gets truncated before further processing.
5921  * If a node with same name already exists on parent, this function
5922  * fails with ISO_NODE_NAME_NOT_UNIQUE.
5923  * @param mode
5924  * File type and permissions for the new node. Note that only the file
5925  * types S_IFSOCK, S_IFBLK, S_IFCHR, and S_IFIFO are allowed.
5926  * S_IFLNK, S_IFREG, or S_IFDIR are not.
5927  * @param dev
5928  * Device ID, equivalent to the st_rdev field in man 2 stat.
5929  * @param special
5930  * Place where to store a pointer to the newly created special file. No
5931  * extra ref is addded, so you will need to call iso_node_ref() if you
5932  * really need it. You can pass NULL in this parameter if you don't need
5933  * the pointer.
5934  * @return
5935  * Number of nodes in parent if success, < 0 otherwise
5936  * Possible errors:
5937  * ISO_NULL_POINTER, if parent, name or dest are NULL
5938  * ISO_NODE_NAME_NOT_UNIQUE, a node with same name already exists
5939  * ISO_WRONG_ARG_VALUE if you select a incorrect mode
5940  * ISO_OUT_OF_MEM
5941  * ISO_RR_NAME_TOO_LONG
5942  *
5943  * @since 1.4.2
5944  */
5945 int iso_image_add_new_special(IsoImage *image, IsoDir *parent,
5946  const char *name, mode_t mode,
5947  dev_t dev, IsoSpecial **special);
5948 
5949 /**
5950  * *** Deprecated ***
5951  * use iso_image_add_new_special() instead
5952  *
5953  * Add a new special file to the directory tree without taking into respect name
5954  * truncation mode of an IsoImage.
5955  * For detailed description of parameters, see above
5956  * iso_image_add_new_special().
5957  *
5958  * @param parent
5959  * the dir where the new special file will be created
5960  * @param name
5961  * name for the new special file.
5962  * @param mode
5963  * file type and permissions for the new node.
5964  * @param dev
5965  * device ID, equivalent to the st_rdev field in man 2 stat.
5966  * @param special
5967  * place where to store a pointer to the newly created special file.
5968  * @return
5969  * number of nodes in parent if success, < 0 otherwise
5970  * Possible errors:
5971  * ISO_NULL_POINTER, if parent, name or dest are NULL
5972  * ISO_NODE_NAME_NOT_UNIQUE, a node with same name already exists
5973  * ISO_WRONG_ARG_VALUE if you select a incorrect mode
5974  * ISO_OUT_OF_MEM
5975  *
5976  * @since 0.6.2
5977  */
5978 int iso_tree_add_new_special(IsoDir *parent, const char *name, mode_t mode,
5979  dev_t dev, IsoSpecial **special);
5980 
5981 /**
5982  * Set whether to follow or not symbolic links when added a file from a source
5983  * to IsoImage. Default behavior is to not follow symlinks.
5984  *
5985  * @since 0.6.2
5986  */
5987 void iso_tree_set_follow_symlinks(IsoImage *image, int follow);
5988 
5989 /**
5990  * Get current setting for follow_symlinks.
5991  *
5992  * @see iso_tree_set_follow_symlinks
5993  * @since 0.6.2
5994  */
5996 
5997 /**
5998  * Set whether to skip or not disk files with names beginning by '.'
5999  * when adding a directory recursively.
6000  * Default behavior is to not ignore them.
6001  *
6002  * Clarification: This is not related to the IsoNode property to be hidden
6003  * in one or more of the resulting image trees as of
6004  * IsoHideNodeFlag and iso_node_set_hidden().
6005  *
6006  * @since 0.6.2
6007  */
6008 void iso_tree_set_ignore_hidden(IsoImage *image, int skip);
6009 
6010 /**
6011  * Get current setting for ignore_hidden.
6012  *
6013  * @see iso_tree_set_ignore_hidden
6014  * @since 0.6.2
6015  */
6017 
6018 /**
6019  * Set the replace mode, that defines the behavior of libisofs when adding
6020  * a node whit the same name that an existent one, during a recursive
6021  * directory addition.
6022  *
6023  * @since 0.6.2
6024  */
6025 void iso_tree_set_replace_mode(IsoImage *image, enum iso_replace_mode mode);
6026 
6027 /**
6028  * Get current setting for replace_mode.
6029  *
6030  * @see iso_tree_set_replace_mode
6031  * @since 0.6.2
6032  */
6034 
6035 /**
6036  * Set whether to skip or not special files. Default behavior is to not skip
6037  * them. Note that, despite of this setting, special files will never be added
6038  * to an image unless RR extensions were enabled.
6039  *
6040  * @param image
6041  * The image to manipulate.
6042  * @param skip
6043  * Bitmask to determine what kind of special files will be skipped:
6044  * bit0: ignore FIFOs
6045  * bit1: ignore Sockets
6046  * bit2: ignore char devices
6047  * bit3: ignore block devices
6048  *
6049  * @since 0.6.2
6050  */
6051 void iso_tree_set_ignore_special(IsoImage *image, int skip);
6052 
6053 /**
6054  * Get current setting for ignore_special.
6055  *
6056  * @see iso_tree_set_ignore_special
6057  * @since 0.6.2
6058  */
6060 
6061 /**
6062  * Add a excluded path. These are paths that won't never added to image, and
6063  * will be excluded even when adding recursively its parent directory.
6064  *
6065  * For example, in
6066  *
6067  * iso_tree_add_exclude(image, "/home/user/data/private");
6068  * iso_tree_add_dir_rec(image, root, "/home/user/data");
6069  *
6070  * the directory /home/user/data/private won't be added to image.
6071  *
6072  * However, if you explicity add a deeper dir, it won't be excluded. i.e.,
6073  * in the following example.
6074  *
6075  * iso_tree_add_exclude(image, "/home/user/data");
6076  * iso_tree_add_dir_rec(image, root, "/home/user/data/private");
6077  *
6078  * the directory /home/user/data/private is added. On the other, side, and
6079  * following the example above,
6080  *
6081  * iso_tree_add_dir_rec(image, root, "/home/user");
6082  *
6083  * will exclude the directory "/home/user/data".
6084  *
6085  * Absolute paths are not mandatory, you can, for example, add a relative
6086  * path such as:
6087  *
6088  * iso_tree_add_exclude(image, "private");
6089  * iso_tree_add_exclude(image, "user/data");
6090  *
6091  * to exclude, respectively, all files or dirs named private, and also all
6092  * files or dirs named data that belong to a folder named "user". Note that the
6093  * above rule about deeper dirs is still valid. i.e., if you call
6094  *
6095  * iso_tree_add_dir_rec(image, root, "/home/user/data/music");
6096  *
6097  * it is included even containing "user/data" string. However, a possible
6098  * "/home/user/data/music/user/data" is not added.
6099  *
6100  * Usual wildcards, such as * or ? are also supported, with the usual meaning
6101  * as stated in "man 7 glob". For example
6102  *
6103  * // to exclude backup text files
6104  * iso_tree_add_exclude(image, "*.~");
6105  *
6106  * @return
6107  * 1 on success, < 0 on error
6108  *
6109  * @since 0.6.2
6110  */
6111 int iso_tree_add_exclude(IsoImage *image, const char *path);
6112 
6113 /**
6114  * Remove a previously added exclude.
6115  *
6116  * @see iso_tree_add_exclude
6117  * @return
6118  * 1 on success, 0 exclude do not exists, < 0 on error
6119  *
6120  * @since 0.6.2
6121  */
6122 int iso_tree_remove_exclude(IsoImage *image, const char *path);
6123 
6124 /**
6125  * Set a callback function that libisofs will call for each file that is
6126  * added to the given image by a recursive addition function. This includes
6127  * image import.
6128  *
6129  * @param image
6130  * The image to manipulate.
6131  * @param report
6132  * pointer to a function that will be called just before a file will be
6133  * added to the image. You can control whether the file will be in fact
6134  * added or ignored.
6135  * This function should return 1 to add the file, 0 to ignore it and
6136  * continue, < 0 to abort the process
6137  * NULL is allowed if you don't want any callback.
6138  *
6139  * @since 0.6.2
6140  */
6142  int (*report)(IsoImage*, IsoFileSource*));
6143 
6144 /**
6145  * Add a new node to the image tree, from an existing file.
6146  *
6147  * TODO comment Builder and Filesystem related issues when exposing both
6148  *
6149  * All attributes will be taken from the source file. The appropriate file
6150  * type will be created.
6151  *
6152  * @param image
6153  * The image
6154  * @param parent
6155  * The directory in the image tree where the node will be added.
6156  * @param path
6157  * The absolute path of the file in the local filesystem.
6158  * The node will have the same leaf name as the file on disk, possibly
6159  * truncated according to iso_image_set_truncate_mode().
6160  * Its directory path depends on the parent node.
6161  * @param node
6162  * place where to store a pointer to the newly added file. No
6163  * extra ref is addded, so you will need to call iso_node_ref() if you
6164  * really need it. You can pass NULL in this parameter if you don't need
6165  * the pointer.
6166  * @return
6167  * number of nodes in parent if success, < 0 otherwise
6168  * Possible errors:
6169  * ISO_NULL_POINTER, if image, parent or path are NULL
6170  * ISO_NODE_NAME_NOT_UNIQUE, a node with same name already exists
6171  * ISO_OUT_OF_MEM
6172  * ISO_RR_NAME_TOO_LONG
6173  *
6174  * @since 0.6.2
6175  */
6176 int iso_tree_add_node(IsoImage *image, IsoDir *parent, const char *path,
6177  IsoNode **node);
6178 
6179 /**
6180  * This is a more versatile form of iso_tree_add_node which allows to set
6181  * the node name in ISO image already when it gets added.
6182  *
6183  * Add a new node to the image tree, from an existing file, and with the
6184  * given name, that must not exist on dir.
6185  *
6186  * @param image
6187  * The image
6188  * @param parent
6189  * The directory in the image tree where the node will be added.
6190  * @param name
6191  * The leaf name that the node will have on image, possibly truncated
6192  * according to iso_image_set_truncate_mode().
6193  * Its directory path depends on the parent node.
6194  * @param path
6195  * The absolute path of the file in the local filesystem.
6196  * @param node
6197  * place where to store a pointer to the newly added file. No
6198  * extra ref is addded, so you will need to call iso_node_ref() if you
6199  * really need it. You can pass NULL in this parameter if you don't need
6200  * the pointer.
6201  * @return
6202  * number of nodes in parent if success, < 0 otherwise
6203  * Possible errors:
6204  * ISO_NULL_POINTER, if image, parent or path are NULL
6205  * ISO_NODE_NAME_NOT_UNIQUE, a node with same name already exists
6206  * ISO_OUT_OF_MEM
6207  * ISO_RR_NAME_TOO_LONG
6208  *
6209  * @since 0.6.4
6210  */
6211 int iso_tree_add_new_node(IsoImage *image, IsoDir *parent, const char *name,
6212  const char *path, IsoNode **node);
6213 
6214 /**
6215  * Add a new node to the image tree with the given name that must not exist
6216  * on dir. The node data content will be a byte interval out of the data
6217  * content of a file in the local filesystem.
6218  *
6219  * @param image
6220  * The image
6221  * @param parent
6222  * The directory in the image tree where the node will be added.
6223  * @param name
6224  * The leaf name that the node will have on image, possibly truncated
6225  * according to iso_image_set_truncate_mode().
6226  * Its directory path depends on the parent node.
6227  * @param path
6228  * The absolute path of the file in the local filesystem. For now
6229  * only regular files and symlinks to regular files are supported.
6230  * @param offset
6231  * Byte number in the given file from where to start reading data.
6232  * @param size
6233  * Max size of the file. This may be more than actually available from
6234  * byte offset to the end of the file in the local filesystem.
6235  * @param node
6236  * place where to store a pointer to the newly added file. No
6237  * extra ref is addded, so you will need to call iso_node_ref() if you
6238  * really need it. You can pass NULL in this parameter if you don't need
6239  * the pointer.
6240  * @return
6241  * number of nodes in parent if success, < 0 otherwise
6242  * Possible errors:
6243  * ISO_NULL_POINTER, if image, parent or path are NULL
6244  * ISO_NODE_NAME_NOT_UNIQUE, a node with same name already exists
6245  * ISO_OUT_OF_MEM
6246  * ISO_RR_NAME_TOO_LONG
6247  *
6248  * @since 0.6.4
6249  */
6250 int iso_tree_add_new_cut_out_node(IsoImage *image, IsoDir *parent,
6251  const char *name, const char *path,
6252  off_t offset, off_t size,
6253  IsoNode **node);
6254 
6255 /**
6256  * Create a copy of the given node under a different path. If the node is
6257  * actually a directory then clone its whole subtree.
6258  * This call may fail because an IsoFile is encountered which gets fed by an
6259  * IsoStream which cannot be cloned. See also IsoStream_Iface method
6260  * clone_stream().
6261  * Surely clonable node types are:
6262  * IsoDir,
6263  * IsoSymlink,
6264  * IsoSpecial,
6265  * IsoFile from a loaded ISO image,
6266  * IsoFile referring to local filesystem files,
6267  * IsoFile created by iso_tree_add_new_file
6268  * from a stream created by iso_memory_stream_new(),
6269  * IsoFile created by iso_tree_add_new_cut_out_node()
6270  * Silently ignored are nodes of type IsoBoot.
6271  * An IsoFile node with IsoStream filters can be cloned if all those filters
6272  * are clonable and the node would be clonable without filter.
6273  * Clonable IsoStream filters are created by:
6274  * iso_file_add_zisofs_filter()
6275  * iso_file_add_gzip_filter()
6276  * iso_file_add_external_filter()
6277  * An IsoNode with extended information as of iso_node_add_xinfo() can only be
6278  * cloned if each of the iso_node_xinfo_func instances is associated to a
6279  * clone function. See iso_node_xinfo_make_clonable().
6280  * All internally used classes of extended information are clonable.
6281  *
6282  * The IsoImage context defines a maximum permissible name length and a mode
6283  * how to react on oversized names. See iso_image_set_truncate_mode().
6284  *
6285  * @param image
6286  * The image object to which the node belongs.
6287  * @param node
6288  * The node to be cloned.
6289  * @param new_parent
6290  * The existing directory node where to insert the cloned node.
6291  * @param new_name
6292  * The name for the cloned node. It must not yet exist in new_parent,
6293  * unless it is a directory and node is a directory and flag bit0 is set.
6294  * @param new_node
6295  * Will return a pointer (without reference) to the newly created clone.
6296  * @param flag
6297  * Bitfield for control purposes. Submit any undefined bits as 0.
6298  * bit0= Merge directories rather than returning ISO_NODE_NAME_NOT_UNIQUE.
6299  * This will not allow to overwrite any existing node.
6300  * Attributes of existing directories will not be overwritten.
6301  * bit1= issue warning in case of new_name truncation
6302  * @return
6303  * <0 means error, 1 = new node created,
6304  * 2 = if flag bit0 is set: new_node is a directory which already existed.
6305  *
6306  * @since 1.4.2
6307  */
6308 int iso_image_tree_clone(IsoImage *image, IsoNode *node, IsoDir *new_parent,
6309  char *new_name, IsoNode **new_node, int flag);
6310 
6311 /**
6312  * *** Deprecated ***
6313  * use iso_image_tree_clone() instead
6314  *
6315  * Create a copy of the given node under a different path without taking
6316  * into respect name truncation mode of an IsoImage.
6317  *
6318  * @param node
6319  * The node to be cloned.
6320  * @param new_parent
6321  * The existing directory node where to insert the cloned node.
6322  * @param new_name
6323  * The name for the cloned node. It must not yet exist in new_parent,
6324  * unless it is a directory and node is a directory and flag bit0 is set.
6325  * @param new_node
6326  * Will return a pointer (without reference) to the newly created clone.
6327  * @param flag
6328  * Bitfield for control purposes. Submit any undefined bits as 0.
6329  * bit0= Merge directories rather than returning ISO_NODE_NAME_NOT_UNIQUE.
6330  * This will not allow to overwrite any existing node.
6331  * Attributes of existing directories will not be overwritten.
6332  * @return
6333  * <0 means error, 1 = new node created,
6334  * 2 = if flag bit0 is set: new_node is a directory which already existed.
6335  *
6336  * @since 1.0.2
6337  */
6338 int iso_tree_clone(IsoNode *node,
6339  IsoDir *new_parent, char *new_name, IsoNode **new_node,
6340  int flag);
6341 
6342 /**
6343  * Add the contents of a dir to a given directory of the iso tree.
6344  *
6345  * There are several options to control what files are added or how they are
6346  * managed. Take a look at iso_tree_set_* functions to see different options
6347  * for recursive directory addition.
6348  *
6349  * TODO comment Builder and Filesystem related issues when exposing both
6350  *
6351  * @param image
6352  * The image to which the directory belongs.
6353  * @param parent
6354  * Directory on the image tree where to add the contents of the dir
6355  * @param dir
6356  * Path to a dir in the filesystem
6357  * @return
6358  * number of nodes in parent if success, < 0 otherwise
6359  *
6360  * @since 0.6.2
6361  */
6362 int iso_tree_add_dir_rec(IsoImage *image, IsoDir *parent, const char *dir);
6363 
6364 /**
6365  * Inquire whether some local filesystem xattr namespace could not be explored
6366  * during node building. This may happen due to lack of adminstrator privileges
6367  * e.g. on FreeBSD namespace "system".
6368  * It may well be that the processed local files have no attributes which
6369  * would require special privileges. But already their existence was neither
6370  * denied nor confirmed.
6371  *
6372  * @param image
6373  * The image to inquire.
6374  * @param flag
6375  * Bitfield for control purposes:
6376  * bit0 = reset internal value to 0
6377  * @return
6378  * 1 = Exploration was prevented
6379  * 0 = No such prevention occured
6380  *
6381  * @since 1.5.0
6382  */
6383 int iso_image_was_blind_attrs(IsoImage *image, int flag);
6384 
6385 
6386 /**
6387  * Locate a node by its absolute path in the image.
6388  * The IsoImage context defines a maximum permissible name length and a mode
6389  * how to react on oversized names. See iso_image_set_truncate_mode().
6390  *
6391  * @param image
6392  * The image to which the node belongs.
6393  * @param path
6394  * File path beginning at the root directory of image. If truncation mode
6395  * is set to 1, oversized path components will be truncated before lookup.
6396  * @param node
6397  * Location for a pointer to the node, it will be filled with NULL if the
6398  * given path does not exists on image.
6399  * The node will be owned by the image and shouldn't be unref(). Just call
6400  * iso_node_ref() to get your own reference to the node.
6401  * Note that you can pass NULL is the only thing you want to do is check
6402  * if a node with such path really exists.
6403  *
6404  * @return
6405  * 1 node found
6406  * 0 no truncation was needed, path not found in image
6407  * 2 truncation happened, truncated path component not found in parent dir
6408  * < 0 error, see iso_dir_get_node().
6409  *
6410  * @since 1.4.2
6411  */
6412 int iso_image_path_to_node(IsoImage *image, const char *path, IsoNode **node);
6413 
6414 /**
6415  * *** Deprecated ***
6416  * In most cases use iso_image_path_to_node() instead
6417  *
6418  * Locate a node by its absolute path on image without taking into respect
6419  * name truncation mode of the image.
6420  *
6421  * @param image
6422  * The image to which the node belongs.
6423  * @param path
6424  * File path beginning at the root directory of image. No truncation will
6425  * happen.
6426  * @param node
6427  * Location for a pointer to the node, it will be filled with NULL if the
6428  * given path does not exists on image. See iso_image_path_to_node().
6429  * @return
6430  * 1 found, 0 not found, < 0 error
6431  *
6432  * @since 0.6.2
6433  */
6434 int iso_tree_path_to_node(IsoImage *image, const char *path, IsoNode **node);
6435 
6436 /**
6437  * Get the absolute path on image of the given node.
6438  *
6439  * @return
6440  * The path on the image, that must be freed when no more needed. If the
6441  * given node is not added to any image, this returns NULL.
6442  * @since 0.6.4
6443  */
6444 char *iso_tree_get_node_path(IsoNode *node);
6445 
6446 /**
6447  * Get the destination node of a symbolic link within the IsoImage.
6448  *
6449  * @param img
6450  * The image wherein to try resolving the link.
6451  * @param sym
6452  * The symbolic link node which to resolve.
6453  * @param res
6454  * Will return the found destination node, in case of success.
6455  * Call iso_node_ref() / iso_node_unref() if you intend to use the node
6456  * over API calls which might in any event delete it.
6457  * @param depth
6458  * Prevents endless loops. Submit as 0.
6459  * @param flag
6460  * Bitfield for control purposes. Submit 0 for now.
6461  * @return
6462  * 1 on success,
6463  * < 0 on failure, especially ISO_DEEP_SYMLINK and ISO_DEAD_SYMLINK
6464  *
6465  * @since 1.2.4
6466  */
6467 int iso_tree_resolve_symlink(IsoImage *img, IsoSymlink *sym, IsoNode **res,
6468  int *depth, int flag);
6469 
6470 /* Maximum number link resolution steps before ISO_DEEP_SYMLINK gets
6471  * returned by iso_tree_resolve_symlink().
6472  *
6473  * @since 1.2.4
6474 */
6475 #define LIBISO_MAX_LINK_DEPTH 100
6476 
6477 /**
6478  * Increments the reference counting of the given IsoDataSource.
6479  *
6480  * @since 0.6.2
6481  */
6483 
6484 /**
6485  * Decrements the reference counting of the given IsoDataSource, freeing it
6486  * if refcount reach 0.
6487  *
6488  * @since 0.6.2
6489  */
6491 
6492 /**
6493  * Create a new IsoDataSource from a local file. This is suitable for
6494  * accessing regular files or block devices with ISO images.
6495  *
6496  * @param path
6497  * The absolute path of the file
6498  * @param src
6499  * Will be filled with the pointer to the newly created data source.
6500  * @return
6501  * 1 on success, < 0 on error.
6502  *
6503  * @since 0.6.2
6504  */
6505 int iso_data_source_new_from_file(const char *path, IsoDataSource **src);
6506 
6507 /**
6508  * Get the status of the buffer used by a burn_source.
6509  *
6510  * @param b
6511  * A burn_source previously obtained with
6512  * iso_image_create_burn_source().
6513  * @param size
6514  * Will be filled with the total size of the buffer, in bytes
6515  * @param free_bytes
6516  * Will be filled with the bytes currently available in buffer
6517  * @return
6518  * < 0 error, > 0 state:
6519  * 1="active" : input and consumption are active
6520  * 2="ending" : input has ended without error
6521  * 3="failing" : input had error and ended,
6522  * 5="abandoned" : consumption has ended prematurely
6523  * 6="ended" : consumption has ended without input error
6524  * 7="aborted" : consumption has ended after input error
6525  *
6526  * @since 0.6.2
6527  */
6528 int iso_ring_buffer_get_status(struct burn_source *b, size_t *size,
6529  size_t *free_bytes);
6530 
6531 #define ISO_MSGS_MESSAGE_LEN 4096
6532 
6533 /**
6534  * Control queueing and stderr printing of messages from libisofs.
6535  * Severity may be one of "NEVER", "FATAL", "SORRY", "WARNING", "HINT",
6536  * "NOTE", "UPDATE", "DEBUG", "ALL".
6537  *
6538  * @param queue_severity Gives the minimum limit for messages to be queued.
6539  * Default: "NEVER". If you queue messages then you
6540  * must consume them by iso_obtain_msgs().
6541  * @param print_severity Does the same for messages to be printed directly
6542  * to stderr.
6543  * @param print_id A text prefix to be printed before the message.
6544  * @return >0 for success, <=0 for error
6545  *
6546  * @since 0.6.2
6547  */
6548 int iso_set_msgs_severities(char *queue_severity, char *print_severity,
6549  char *print_id);
6550 
6551 /**
6552  * Obtain the oldest pending libisofs message from the queue which has at
6553  * least the given minimum_severity. This message and any older message of
6554  * lower severity will get discarded from the queue and is then lost forever.
6555  *
6556  * Severity may be one of "NEVER", "FATAL", "SORRY", "WARNING", "HINT",
6557  * "NOTE", "UPDATE", "DEBUG", "ALL". To call with minimum_severity "NEVER"
6558  * will discard the whole queue.
6559  *
6560  * @param minimum_severity
6561  * Threshold
6562  * @param error_code
6563  * Will become a unique error code as listed at the end of this header
6564  * @param imgid
6565  * Id of the image that was issued the message.
6566  * @param msg_text
6567  * Must provide at least ISO_MSGS_MESSAGE_LEN bytes.
6568  * @param severity
6569  * Will become the severity related to the message and should provide at
6570  * least 80 bytes.
6571  * @return
6572  * 1 if a matching item was found, 0 if not, <0 for severe errors
6573  *
6574  * @since 0.6.2
6575  */
6576 int iso_obtain_msgs(char *minimum_severity, int *error_code, int *imgid,
6577  char msg_text[], char severity[]);
6578 
6579 
6580 /**
6581  * Submit a message to the libisofs queueing system. It will be queued or
6582  * printed as if it was generated by libisofs itself.
6583  *
6584  * @param error_code
6585  * The unique error code of your message.
6586  * Submit 0 if you do not have reserved error codes within the libburnia
6587  * project.
6588  * @param msg_text
6589  * Not more than ISO_MSGS_MESSAGE_LEN characters of message text.
6590  * @param os_errno
6591  * Eventual errno related to the message. Submit 0 if the message is not
6592  * related to a operating system error.
6593  * @param severity
6594  * One of "ABORT", "FATAL", "FAILURE", "SORRY", "WARNING", "HINT", "NOTE",
6595  * "UPDATE", "DEBUG". Defaults to "FATAL".
6596  * @param origin
6597  * Submit 0 for now.
6598  * @return
6599  * 1 if message was delivered, <=0 if failure
6600  *
6601  * @since 0.6.4
6602  */
6603 int iso_msgs_submit(int error_code, char msg_text[], int os_errno,
6604  char severity[], int origin);
6605 
6606 
6607 /**
6608  * Convert a severity name into a severity number, which gives the severity
6609  * rank of the name.
6610  *
6611  * @param severity_name
6612  * A name as with iso_msgs_submit(), e.g. "SORRY".
6613  * @param severity_number
6614  * The rank number: the higher, the more severe.
6615  * @return
6616  * >0 success, <=0 failure
6617  *
6618  * @since 0.6.4
6619  */
6620 int iso_text_to_sev(char *severity_name, int *severity_number);
6621 
6622 
6623 /**
6624  * Convert a severity number into a severity name
6625  *
6626  * @param severity_number
6627  * The rank number: the higher, the more severe.
6628  * @param severity_name
6629  * A name as with iso_msgs_submit(), e.g. "SORRY".
6630  *
6631  * @since 0.6.4
6632  */
6633 int iso_sev_to_text(int severity_number, char **severity_name);
6634 
6635 
6636 /**
6637  * Get the id of an IsoImage, used for message reporting. This message id,
6638  * retrieved with iso_obtain_msgs(), can be used to distinguish what
6639  * IsoImage has isssued a given message.
6640  *
6641  * @since 0.6.2
6642  */
6643 int iso_image_get_msg_id(IsoImage *image);
6644 
6645 /**
6646  * Get a textual description of a libisofs error.
6647  *
6648  * @since 0.6.2
6649  */
6650 const char *iso_error_to_msg(int errcode);
6651 
6652 /**
6653  * Get the severity of a given error code
6654  * @return
6655  * 0x10000000 -> DEBUG
6656  * 0x20000000 -> UPDATE
6657  * 0x30000000 -> NOTE
6658  * 0x40000000 -> HINT
6659  * 0x50000000 -> WARNING
6660  * 0x60000000 -> SORRY
6661  * 0x64000000 -> MISHAP
6662  * 0x68000000 -> FAILURE
6663  * 0x70000000 -> FATAL
6664  * 0x71000000 -> ABORT
6665  *
6666  * @since 0.6.2
6667  */
6668 int iso_error_get_severity(int e);
6669 
6670 /**
6671  * Get the priority of a given error.
6672  * @return
6673  * 0x00000000 -> ZERO
6674  * 0x10000000 -> LOW
6675  * 0x20000000 -> MEDIUM
6676  * 0x30000000 -> HIGH
6677  *
6678  * @since 0.6.2
6679  */
6680 int iso_error_get_priority(int e);
6681 
6682 /**
6683  * Get the message queue code of a libisofs error.
6684  */
6685 int iso_error_get_code(int e);
6686 
6687 /**
6688  * Set the minimum error severity that causes a libisofs operation to
6689  * be aborted as soon as possible.
6690  *
6691  * @param severity
6692  * one of "FAILURE", "MISHAP", "SORRY", "WARNING", "HINT", "NOTE".
6693  * Severities greater or equal than FAILURE always cause program to abort.
6694  * Severities under NOTE won't never cause function abort.
6695  * @return
6696  * Previous abort priority on success, < 0 on error.
6697  *
6698  * @since 0.6.2
6699  */
6700 int iso_set_abort_severity(char *severity);
6701 
6702 /**
6703  * Return the messenger object handle used by libisofs. This handle
6704  * may be used by related libraries to their own compatible
6705  * messenger objects and thus to direct their messages to the libisofs
6706  * message queue. See also: libburn, API function burn_set_messenger().
6707  *
6708  * @return the handle. Do only use with compatible
6709  *
6710  * @since 0.6.2
6711  */
6712 void *iso_get_messenger();
6713 
6714 /**
6715  * Take a ref to the given IsoFileSource.
6716  *
6717  * @since 0.6.2
6718  */
6720 
6721 /**
6722  * Drop your ref to the given IsoFileSource, eventually freeing the associated
6723  * system resources.
6724  *
6725  * @since 0.6.2
6726  */
6728 
6729 /*
6730  * this are just helpers to invoque methods in class
6731  */
6732 
6733 /**
6734  * Get the absolute path in the filesystem this file source belongs to.
6735  *
6736  * @return
6737  * the path of the FileSource inside the filesystem, it should be
6738  * freed when no more needed.
6739  *
6740  * @since 0.6.2
6741  */
6743 
6744 /**
6745  * Get the name of the file, with the dir component of the path.
6746  *
6747  * @return
6748  * the name of the file, it should be freed when no more needed.
6749  *
6750  * @since 0.6.2
6751  */
6753 
6754 /**
6755  * Get information about the file.
6756  * @return
6757  * 1 success, < 0 error
6758  * Error codes:
6759  * ISO_FILE_ACCESS_DENIED
6760  * ISO_FILE_BAD_PATH
6761  * ISO_FILE_DOESNT_EXIST
6762  * ISO_OUT_OF_MEM
6763  * ISO_FILE_ERROR
6764  * ISO_NULL_POINTER
6765  *
6766  * @since 0.6.2
6767  */
6768 int iso_file_source_lstat(IsoFileSource *src, struct stat *info);
6769 
6770 /**
6771  * Check if the process has access to read file contents. Note that this
6772  * is not necessarily related with (l)stat functions. For example, in a
6773  * filesystem implementation to deal with an ISO image, if the user has
6774  * read access to the image it will be able to read all files inside it,
6775  * despite of the particular permission of each file in the RR tree, that
6776  * are what the above functions return.
6777  *
6778  * @return
6779  * 1 if process has read access, < 0 on error
6780  * Error codes:
6781  * ISO_FILE_ACCESS_DENIED
6782  * ISO_FILE_BAD_PATH
6783  * ISO_FILE_DOESNT_EXIST
6784  * ISO_OUT_OF_MEM
6785  * ISO_FILE_ERROR
6786  * ISO_NULL_POINTER
6787  *
6788  * @since 0.6.2
6789  */
6791 
6792 /**
6793  * Get information about the file. If the file is a symlink, the info
6794  * returned refers to the destination.
6795  *
6796  * @return
6797  * 1 success, < 0 error
6798  * Error codes:
6799  * ISO_FILE_ACCESS_DENIED
6800  * ISO_FILE_BAD_PATH
6801  * ISO_FILE_DOESNT_EXIST
6802  * ISO_OUT_OF_MEM
6803  * ISO_FILE_ERROR
6804  * ISO_NULL_POINTER
6805  *
6806  * @since 0.6.2
6807  */
6808 int iso_file_source_stat(IsoFileSource *src, struct stat *info);
6809 
6810 /**
6811  * Opens the source.
6812  * @return 1 on success, < 0 on error
6813  * Error codes:
6814  * ISO_FILE_ALREADY_OPENED
6815  * ISO_FILE_ACCESS_DENIED
6816  * ISO_FILE_BAD_PATH
6817  * ISO_FILE_DOESNT_EXIST
6818  * ISO_OUT_OF_MEM
6819  * ISO_FILE_ERROR
6820  * ISO_NULL_POINTER
6821  *
6822  * @since 0.6.2
6823  */
6825 
6826 /**
6827  * Close a previuously openned file
6828  * @return 1 on success, < 0 on error
6829  * Error codes:
6830  * ISO_FILE_ERROR
6831  * ISO_NULL_POINTER
6832  * ISO_FILE_NOT_OPENED
6833  *
6834  * @since 0.6.2
6835  */
6837 
6838 /**
6839  * Attempts to read up to count bytes from the given source into
6840  * the buffer starting at buf.
6841  *
6842  * The file src must be open() before calling this, and close() when no
6843  * more needed. Not valid for dirs. On symlinks it reads the destination
6844  * file.
6845  *
6846  * @param src
6847  * The given source
6848  * @param buf
6849  * Pointer to a buffer of at least count bytes where the read data will be
6850  * stored
6851  * @param count
6852  * Bytes to read
6853  * @return
6854  * number of bytes read, 0 if EOF, < 0 on error
6855  * Error codes:
6856  * ISO_FILE_ERROR
6857  * ISO_NULL_POINTER
6858  * ISO_FILE_NOT_OPENED
6859  * ISO_WRONG_ARG_VALUE -> if count == 0
6860  * ISO_FILE_IS_DIR
6861  * ISO_OUT_OF_MEM
6862  * ISO_INTERRUPTED
6863  *
6864  * @since 0.6.2
6865  */
6866 int iso_file_source_read(IsoFileSource *src, void *buf, size_t count);
6867 
6868 /**
6869  * Repositions the offset of the given IsoFileSource (must be opened) to the
6870  * given offset according to the value of flag.
6871  *
6872  * @param src
6873  * The given source
6874  * @param offset
6875  * in bytes
6876  * @param flag
6877  * 0 The offset is set to offset bytes (SEEK_SET)
6878  * 1 The offset is set to its current location plus offset bytes
6879  * (SEEK_CUR)
6880  * 2 The offset is set to the size of the file plus offset bytes
6881  * (SEEK_END).
6882  * @return
6883  * Absolute offset posistion on the file, or < 0 on error. Cast the
6884  * returning value to int to get a valid libisofs error.
6885  * @since 0.6.4
6886  */
6887 off_t iso_file_source_lseek(IsoFileSource *src, off_t offset, int flag);
6888 
6889 /**
6890  * Read a directory.
6891  *
6892  * Each call to this function will return a new child, until we reach
6893  * the end of file (i.e, no more children), in that case it returns 0.
6894  *
6895  * The dir must be open() before calling this, and close() when no more
6896  * needed. Only valid for dirs.
6897  *
6898  * Note that "." and ".." children MUST NOT BE returned.
6899  *
6900  * @param src
6901  * The given source
6902  * @param child
6903  * pointer to be filled with the given child. Undefined on error or OEF
6904  * @return
6905  * 1 on success, 0 if EOF (no more children), < 0 on error
6906  * Error codes:
6907  * ISO_FILE_ERROR
6908  * ISO_NULL_POINTER
6909  * ISO_FILE_NOT_OPENED
6910  * ISO_FILE_IS_NOT_DIR
6911  * ISO_OUT_OF_MEM
6912  *
6913  * @since 0.6.2
6914  */
6916 
6917 /**
6918  * Read the destination of a symlink. You don't need to open the file
6919  * to call this.
6920  *
6921  * @param src
6922  * An IsoFileSource corresponding to a symbolic link.
6923  * @param buf
6924  * Allocated buffer of at least bufsiz bytes.
6925  * The destination string will be copied there, and it will be 0-terminated
6926  * if the return value indicates success or ISO_RR_PATH_TOO_LONG.
6927  * @param bufsiz
6928  * Maximum number of buf characters + 1. The string will be truncated if
6929  * it is larger than bufsiz - 1 and ISO_RR_PATH_TOO_LONG. will be returned.
6930  * @return
6931  * 1 on success, < 0 on error
6932  * Error codes:
6933  * ISO_FILE_ERROR
6934  * ISO_NULL_POINTER
6935  * ISO_WRONG_ARG_VALUE -> if bufsiz <= 0
6936  * ISO_FILE_IS_NOT_SYMLINK
6937  * ISO_OUT_OF_MEM
6938  * ISO_FILE_BAD_PATH
6939  * ISO_FILE_DOESNT_EXIST
6940  * ISO_RR_PATH_TOO_LONG (@since 1.0.6)
6941  *
6942  * @since 0.6.2
6943  */
6944 int iso_file_source_readlink(IsoFileSource *src, char *buf, size_t bufsiz);
6945 
6946 
6947 /**
6948  * Get the AAIP string with encoded ACL and xattr.
6949  * (Not to be confused with ECMA-119 Extended Attributes).
6950  * @param src The file source object to be inquired.
6951  * @param aa_string Returns a pointer to the AAIP string data. If no AAIP
6952  * string is available, *aa_string becomes NULL.
6953  * (See doc/susp_aaip_2_0.txt for the meaning of AAIP.)
6954  * The caller is responsible for finally calling free()
6955  * on non-NULL results.
6956  * @param flag Bitfield for control purposes
6957  * bit0= Transfer ownership of AAIP string data.
6958  * src will free the eventual cached data and might
6959  * not be able to produce it again.
6960  * bit1= No need to get ACL (but no guarantee of exclusion)
6961  * bit2= No need to get xattr (but no guarantee of exclusion)
6962  * bit3= if not bit2: import all xattr namespaces from
6963  * local filesystem, not only "user."
6964  * @since 1.5.0
6965  * @return 1 means success (*aa_string == NULL is possible)
6966  * <0 means failure and must b a valid libisofs error code
6967  * (e.g. ISO_FILE_ERROR if no better one can be found).
6968  * @since 0.6.14
6969  */
6971  unsigned char **aa_string, int flag);
6972 
6973 /**
6974  * Get the filesystem for this source. No extra ref is added, so you
6975  * musn't unref the IsoFilesystem.
6976  *
6977  * @return
6978  * The filesystem, NULL on error
6979  *
6980  * @since 0.6.2
6981  */
6983 
6984 /**
6985  * Take a ref to the given IsoFilesystem
6986  *
6987  * @since 0.6.2
6988  */
6990 
6991 /**
6992  * Drop your ref to the given IsoFilesystem, evetually freeing associated
6993  * resources.
6994  *
6995  * @since 0.6.2
6996  */
6998 
6999 /**
7000  * Create a new IsoFilesystem to access a existent ISO image.
7001  *
7002  * @param src
7003  * Data source to access data.
7004  * @param opts
7005  * Image read options
7006  * @param msgid
7007  * An image identifer, obtained with iso_image_get_msg_id(), used to
7008  * associated messages issued by the filesystem implementation with an
7009  * existent image. If you are not using this filesystem in relation with
7010  * any image context, just use 0x1fffff as the value for this parameter.
7011  * @param fs
7012  * Will be filled with a pointer to the filesystem that can be used
7013  * to access image contents.
7014  * @return
7015  * 1 on success, < 0 on error
7016  *
7017  * @since 0.6.2
7018  */
7019 int iso_image_filesystem_new(IsoDataSource *src, IsoReadOpts *opts, int msgid,
7020  IsoImageFilesystem **fs);
7021 
7022 /**
7023  * Get the volset identifier for an existent image. The returned string belong
7024  * to the IsoImageFilesystem and shouldn't be free() nor modified.
7025  *
7026  * @since 0.6.2
7027  */
7029 
7030 /**
7031  * Get the volume identifier for an existent image. The returned string belong
7032  * to the IsoImageFilesystem and shouldn't be free() nor modified.
7033  *
7034  * @since 0.6.2
7035  */
7037 
7038 /**
7039  * Get the publisher identifier for an existent image. The returned string
7040  * belong to the IsoImageFilesystem and shouldn't be free() nor modified.
7041  *
7042  * @since 0.6.2
7043  */
7045 
7046 /**
7047  * Get the data preparer identifier for an existent image. The returned string
7048  * belong to the IsoImageFilesystem and shouldn't be free() nor modified.
7049  *
7050  * @since 0.6.2
7051  */
7053 
7054 /**
7055  * Get the system identifier for an existent image. The returned string belong
7056  * to the IsoImageFilesystem and shouldn't be free() nor modified.
7057  *
7058  * @since 0.6.2
7059  */
7061 
7062 /**
7063  * Get the application identifier for an existent image. The returned string
7064  * belong to the IsoImageFilesystem and shouldn't be free() nor modified.
7065  *
7066  * @since 0.6.2
7067  */
7069 
7070 /**
7071  * Get the copyright file identifier for an existent image. The returned string
7072  * belong to the IsoImageFilesystem and shouldn't be free() nor modified.
7073  *
7074  * @since 0.6.2
7075  */
7077 
7078 /**
7079  * Get the abstract file identifier for an existent image. The returned string
7080  * belong to the IsoImageFilesystem and shouldn't be free() nor modified.
7081  *
7082  * @since 0.6.2
7083  */
7085 
7086 /**
7087  * Get the biblio file identifier for an existent image. The returned string
7088  * belong to the IsoImageFilesystem and shouldn't be free() nor modified.
7089  *
7090  * @since 0.6.2
7091  */
7093 
7094 /**
7095  * Increment reference count of an IsoStream.
7096  *
7097  * @since 0.6.4
7098  */
7099 void iso_stream_ref(IsoStream *stream);
7100 
7101 /**
7102  * Decrement reference count of an IsoStream, and eventually free it if
7103  * refcount reach 0.
7104  *
7105  * @since 0.6.4
7106  */
7107 void iso_stream_unref(IsoStream *stream);
7108 
7109 /**
7110  * Opens the given stream. Remember to close the Stream before writing the
7111  * image.
7112  *
7113  * @return
7114  * 1 on success, 2 file greater than expected, 3 file smaller than
7115  * expected, < 0 on error
7116  *
7117  * @since 0.6.4
7118  */
7119 int iso_stream_open(IsoStream *stream);
7120 
7121 /**
7122  * Close a previously openned IsoStream.
7123  *
7124  * @return
7125  * 1 on success, < 0 on error
7126  *
7127  * @since 0.6.4
7128  */
7129 int iso_stream_close(IsoStream *stream);
7130 
7131 /**
7132  * Get the size of a given stream. This function should always return the same
7133  * size, even if the underlying source size changes, unless you call
7134  * iso_stream_update_size().
7135  *
7136  * @return
7137  * IsoStream size in bytes
7138  *
7139  * @since 0.6.4
7140  */
7141 off_t iso_stream_get_size(IsoStream *stream);
7142 
7143 /**
7144  * Attempts to read up to count bytes from the given stream into
7145  * the buffer starting at buf.
7146  *
7147  * The stream must be open() before calling this, and close() when no
7148  * more needed.
7149  *
7150  * @return
7151  * number of bytes read, 0 if EOF, < 0 on error
7152  *
7153  * @since 0.6.4
7154  */
7155 int iso_stream_read(IsoStream *stream, void *buf, size_t count);
7156 
7157 /**
7158  * Whether the given IsoStream can be read several times, with the same
7159  * results.
7160  * For example, a regular file is repeatable, you can read it as many
7161  * times as you want. However, a pipe isn't.
7162  *
7163  * This function doesn't take into account if the file has been modified
7164  * between the two reads.
7165  *
7166  * @return
7167  * 1 if stream is repeatable, 0 if not, < 0 on error
7168  *
7169  * @since 0.6.4
7170  */
7171 int iso_stream_is_repeatable(IsoStream *stream);
7172 
7173 /**
7174  * Updates the size of the IsoStream with the current size of the
7175  * underlying source.
7176  *
7177  * @return
7178  * 1 if ok, < 0 on error (has to be a valid libisofs error code),
7179  * 0 if the IsoStream does not support this function.
7180  * @since 0.6.8
7181  */
7182 int iso_stream_update_size(IsoStream *stream);
7183 
7184 /**
7185  * Get an unique identifier for a given IsoStream.
7186  *
7187  * @since 0.6.4
7188  */
7189 void iso_stream_get_id(IsoStream *stream, unsigned int *fs_id, dev_t *dev_id,
7190  ino_t *ino_id);
7191 
7192 /**
7193  * Try to get eventual source path string of a stream. Meaning and availability
7194  * of this string depends on the stream.class . Expect valid results with
7195  * types "fsrc" and "cout". Result formats are
7196  * fsrc: result of file_source_get_path()
7197  * cout: result of file_source_get_path() " " offset " " size
7198  * @param stream
7199  * The stream to be inquired.
7200  * @param flag
7201  * Bitfield for control purposes, unused yet, submit 0
7202  * @return
7203  * A copy of the path string. Apply free() when no longer needed.
7204  * NULL if no path string is available.
7205  *
7206  * @since 0.6.18
7207  */
7208 char *iso_stream_get_source_path(IsoStream *stream, int flag);
7209 
7210 /**
7211  * Compare two streams whether they are based on the same input and will
7212  * produce the same output. If in any doubt, then this comparison will
7213  * indicate no match.
7214  *
7215  * @param s1
7216  * The first stream to compare.
7217  * @param s2
7218  * The second stream to compare.
7219  * @return
7220  * -1 if s1 is smaller s2 , 0 if s1 matches s2 , 1 if s1 is larger s2
7221  * @param flag
7222  * bit0= do not use s1->class->cmp_ino() even if available
7223  *
7224  * @since 0.6.20
7225  */
7226 int iso_stream_cmp_ino(IsoStream *s1, IsoStream *s2, int flag);
7227 
7228 
7229 /**
7230  * Produce a copy of a stream. It must be possible to operate both stream
7231  * objects concurrently. The success of this function depends on the
7232  * existence of a IsoStream_Iface.clone_stream() method with the stream
7233  * and with its eventual subordinate streams.
7234  * See iso_tree_clone() for a list of surely clonable built-in streams.
7235  *
7236  * @param old_stream
7237  * The existing stream object to be copied
7238  * @param new_stream
7239  * Will return a pointer to the copy
7240  * @param flag
7241  * Bitfield for control purposes. Submit 0 for now.
7242  * @return
7243  * >0 means success
7244  * ISO_STREAM_NO_CLONE is issued if no .clone_stream() exists
7245  * other error return values < 0 may occur depending on kind of stream
7246  *
7247  * @since 1.0.2
7248  */
7249 int iso_stream_clone(IsoStream *old_stream, IsoStream **new_stream, int flag);
7250 
7251 
7252 /* --------------------------------- AAIP --------------------------------- */
7253 
7254 /**
7255  * Function to identify and manage AAIP strings as xinfo of IsoNode.
7256  *
7257  * An AAIP string contains the Attribute List with the xattr and ACL of a node
7258  * in the image tree. It is formatted according to libisofs specification
7259  * AAIP-2.0 and ready to be written into the System Use Area or Continuation
7260  * Area of a directory entry in an ISO image.
7261  *
7262  * Applications are not supposed to manipulate AAIP strings directly.
7263  * They should rather make use of the appropriate iso_node_get_* and
7264  * iso_node_set_* calls.
7265  *
7266  * AAIP represents ACLs as xattr with empty name and AAIP-specific binary
7267  * content. Local filesystems may represent ACLs as xattr with names like
7268  * "system.posix_acl_access". libisofs does not interpret those local
7269  * xattr representations of ACL directly but rather uses the ACL interface of
7270  * the local system. By default the local xattr representations of ACL will
7271  * not become part of the AAIP Attribute List via iso_local_get_attrs() and
7272  * not be attached to local files via iso_local_set_attrs().
7273  *
7274  * @since 0.6.14
7275  */
7276 int aaip_xinfo_func(void *data, int flag);
7277 
7278 /**
7279  * The iso_node_xinfo_cloner function which gets associated to aaip_xinfo_func
7280  * by iso_init() or iso_init_with_flag() via iso_node_xinfo_make_clonable().
7281  * @since 1.0.2
7282  */
7283 int aaip_xinfo_cloner(void *old_data, void **new_data, int flag);
7284 
7285 /**
7286  * Get the eventual ACLs which are associated with the node.
7287  * The result will be in "long" text form as of man acl and acl_to_text().
7288  * Call this function with flag bit15 to finally release the memory
7289  * occupied by an ACL inquiry.
7290  *
7291  * @param node
7292  * The node that is to be inquired.
7293  * @param access_text
7294  * Will return a pointer to the eventual "access" ACL text or NULL if it
7295  * is not available and flag bit 4 is set.
7296  * @param default_text
7297  * Will return a pointer to the eventual "default" ACL or NULL if it
7298  * is not available.
7299  * (GNU/Linux directories can have a "default" ACL which influences
7300  * the permissions of newly created files.)
7301  * @param flag
7302  * Bitfield for control purposes
7303  * bit4= if no "access" ACL is available: return *access_text == NULL
7304  * else: produce ACL from stat(2) permissions
7305  * bit15= free memory and return 1 (node may be NULL)
7306  * @return
7307  * 2 *access_text was produced from stat(2) permissions
7308  * 1 *access_text was produced from ACL of node
7309  * 0 if flag bit4 is set and no ACL is available
7310  * < 0 on error
7311  *
7312  * @since 0.6.14
7313  */
7314 int iso_node_get_acl_text(IsoNode *node,
7315  char **access_text, char **default_text, int flag);
7316 
7317 
7318 /**
7319  * Set the ACLs of the given node to the lists in parameters access_text and
7320  * default_text or delete them.
7321  *
7322  * The stat(2) permission bits get updated according to the new "access" ACL if
7323  * neither bit1 of parameter flag is set nor parameter access_text is NULL.
7324  * Note that S_IRWXG permission bits correspond to ACL mask permissions
7325  * if a "mask::" entry exists in the ACL. Only if there is no "mask::" then
7326  * the "group::" entry corresponds to to S_IRWXG.
7327  *
7328  * @param node
7329  * The node that is to be manipulated.
7330  * @param access_text
7331  * The text to be set into effect as "access" ACL. NULL will delete an
7332  * eventually existing "access" ACL of the node.
7333  * @param default_text
7334  * The text to be set into effect as "default" ACL. NULL will delete an
7335  * eventually existing "default" ACL of the node.
7336  * (GNU/Linux directories can have a "default" ACL which influences
7337  * the permissions of newly created files.)
7338  * @param flag
7339  * Bitfield for control purposes
7340  * bit1= ignore text parameters but rather update eventual "access" ACL
7341  * to the stat(2) permissions of node. If no "access" ACL exists,
7342  * then do nothing and return success.
7343  * @return
7344  * > 0 success
7345  * < 0 failure
7346  *
7347  * @since 0.6.14
7348  */
7349 int iso_node_set_acl_text(IsoNode *node,
7350  char *access_text, char *default_text, int flag);
7351 
7352 /**
7353  * Like iso_node_get_permissions but reflecting ACL entry "group::" in S_IRWXG
7354  * rather than ACL entry "mask::". This is necessary if the permissions of a
7355  * node with ACL shall be restored to a filesystem without restoring the ACL.
7356  * The same mapping happens internally when the ACL of a node is deleted.
7357  * If the node has no ACL then the result is iso_node_get_permissions(node).
7358  * @param node
7359  * The node that is to be inquired.
7360  * @return
7361  * Permission bits as of stat(2)
7362  *
7363  * @since 0.6.14
7364  */
7365 mode_t iso_node_get_perms_wo_acl(const IsoNode *node);
7366 
7367 
7368 /**
7369  * Get the list of xattr which is associated with the node.
7370  * The resulting data may finally be disposed by a call to this function
7371  * with flag bit15 set, or its components may be freed one-by-one.
7372  * The following values are either NULL or malloc() memory:
7373  * *names, *value_lengths, *values, (*names)[i], (*values)[i]
7374  * with 0 <= i < *num_attrs.
7375  * It is allowed to replace or reallocate those memory items in order to
7376  * to manipulate the attribute list before submitting it to other calls.
7377  *
7378  * If enabled by flag bit0, this list possibly includes the ACLs of the node.
7379  * They are eventually encoded in a pair with empty name. It is not advisable
7380  * to alter the value or name of that pair. One may decide to erase both ACLs
7381  * by deleting this pair or to copy both ACLs by copying the content of this
7382  * pair to an empty named pair of another node.
7383  * For all other ACL purposes use iso_node_get_acl_text().
7384  *
7385  * @param node
7386  * The node that is to be inquired.
7387  * @param num_attrs
7388  * Will return the number of name-value pairs
7389  * @param names
7390  * Will return an array of pointers to 0-terminated names
7391  * @param value_lengths
7392  * Will return an array with the lengths of values
7393  * @param values
7394  * Will return an array of pointers to strings of 8-bit bytes
7395  * @param flag
7396  * Bitfield for control purposes
7397  * bit0= obtain eventual ACLs as attribute with empty name
7398  * bit2= with bit0: do not obtain attributes other than ACLs
7399  * bit15= free memory (node may be NULL)
7400  * @return
7401  * 1 = ok (but *num_attrs may be 0)
7402  * < 0 = error
7403  *
7404  * @since 0.6.14
7405  */
7406 int iso_node_get_attrs(IsoNode *node, size_t *num_attrs,
7407  char ***names, size_t **value_lengths, char ***values, int flag);
7408 
7409 
7410 /**
7411  * Obtain the value of a particular xattr name. Eventually make a copy of
7412  * that value and add a trailing 0 byte for caller convenience.
7413  * @param node
7414  * The node that is to be inquired.
7415  * @param name
7416  * The xattr name that shall be looked up.
7417  * @param value_length
7418  * Will return the length of value
7419  * @param value
7420  * Will return a string of 8-bit bytes. free() it when no longer needed.
7421  * @param flag
7422  * Bitfield for control purposes, unused yet, submit 0
7423  * @return
7424  * 1= name found , 0= name not found , <0 indicates error
7425  *
7426  * @since 0.6.18
7427  */
7428 int iso_node_lookup_attr(IsoNode *node, char *name,
7429  size_t *value_length, char **value, int flag);
7430 
7431 /**
7432  * Set the list of xattr which is associated with the node.
7433  * The data get copied so that you may dispose your input data afterwards.
7434  *
7435  * If enabled by flag bit0 then the submitted list of attributes will not only
7436  * overwrite xattr but also both eventual ACLs of the node. Eventual ACL in
7437  * the submitted list have to reside in an attribute with empty name.
7438  *
7439  * @param node
7440  * The node that is to be manipulated.
7441  * @param num_attrs
7442  * Number of attributes
7443  * @param names
7444  * Array of pointers to 0 terminated name strings
7445  * @param value_lengths
7446  * Array of byte lengths for each value
7447  * @param values
7448  * Array of pointers to the value bytes
7449  * @param flag
7450  * Bitfield for control purposes
7451  * bit0= Do not maintain eventual existing ACL of the node.
7452  * Set eventual new ACL from value of empty name.
7453  * bit1= Do not clear the existing attribute list but merge it with
7454  * the list given by this call.
7455  * The given values override the values of their eventually existing
7456  * names. If no xattr with a given name exists, then it will be
7457  * added as new xattr. So this bit can be used to set a single
7458  * xattr without inquiring any other xattr of the node.
7459  * bit2= Delete the attributes with the given names
7460  * bit3= Allow to affect non-user attributes.
7461  * I.e. those with a non-empty name which does not begin by "user."
7462  * (The empty name is always allowed and governed by bit0.) This
7463  * deletes all previously existing attributes if not bit1 is set.
7464  * bit4= Do not affect attributes from namespace "isofs".
7465  * To be combined with bit3 for copying attributes from local
7466  * filesystem to ISO image.
7467  * @since 1.2.4
7468  * @return
7469  * 1 = ok
7470  * < 0 = error
7471  *
7472  * @since 0.6.14
7473  */
7474 int iso_node_set_attrs(IsoNode *node, size_t num_attrs, char **names,
7475  size_t *value_lengths, char **values, int flag);
7476 
7477 
7478 /* ----- This is an interface to ACL and xattr of the local filesystem ----- */
7479 
7480 /**
7481  * libisofs has an internal system dependent adapter to ACL and xattr
7482  * operations. For the sake of completeness and simplicity it exposes this
7483  * functionality to its applications which might want to get and set ACLs
7484  * from local files.
7485  */
7486 
7487 /**
7488  * Inquire whether local filesystem operations with ACL or xattr are enabled
7489  * inside libisofs. They may be disabled because of compile time decisions.
7490  * E.g. because the operating system does not support these features or
7491  * because libisofs has not yet an adapter to use them.
7492  *
7493  * @param flag
7494  * Bitfield for control purposes
7495  * bit0= inquire availability of ACL
7496  * bit1= inquire availability of xattr
7497  * bit2 - bit7= Reserved for future types.
7498  * It is permissibile to set them to 1 already now.
7499  * bit8 and higher: reserved, submit 0
7500  * @return
7501  * Bitfield corresponding to flag.
7502  * bit0= ACL adapter is enabled
7503  * bit1= xattr adapter is enabled
7504  * bit2 - bit7= Reserved for future types.
7505  * bit8 and higher: reserved, do not interpret these
7506  *
7507  * @since 1.1.6
7508  */
7509 int iso_local_attr_support(int flag);
7510 
7511 /**
7512  * Get an ACL of the given file in the local filesystem in long text form.
7513  *
7514  * @param disk_path
7515  * Absolute path to the file
7516  * @param text
7517  * Will return a pointer to the ACL text. If not NULL the text will be
7518  * 0 terminated and finally has to be disposed by a call to this function
7519  * with bit15 set.
7520  * @param flag
7521  * Bitfield for control purposes
7522  * bit0= get "default" ACL rather than "access" ACL
7523  * bit4= set *text = NULL and return 2
7524  * if the ACL matches st_mode permissions.
7525  * bit5= in case of symbolic link: inquire link target
7526  * bit15= free text and return 1
7527  * @return
7528  * 1 ok
7529  * 2 ok, trivial ACL found while bit4 is set, *text is NULL
7530  * 0 no ACL manipulation adapter available / ACL not supported on fs
7531  * -1 failure of system ACL service (see errno)
7532  * -2 attempt to inquire ACL of a symbolic link without bit4 or bit5
7533  * or with no suitable link target
7534  *
7535  * @since 0.6.14
7536  */
7537 int iso_local_get_acl_text(char *disk_path, char **text, int flag);
7538 
7539 
7540 /**
7541  * Set the ACL of the given file in the local filesystem to a given list
7542  * in long text form.
7543  *
7544  * @param disk_path
7545  * Absolute path to the file
7546  * @param text
7547  * The input text (0 terminated, ACL long text form)
7548  * @param flag
7549  * Bitfield for control purposes
7550  * bit0= set "default" ACL rather than "access" ACL
7551  * bit5= in case of symbolic link: manipulate link target
7552  * @return
7553  * > 0 ok
7554  * 0 no ACL manipulation adapter available for desired ACL type
7555  * -1 failure of system ACL service (see errno)
7556  * -2 attempt to manipulate ACL of a symbolic link without bit5
7557  * or with no suitable link target
7558  *
7559  * @since 0.6.14
7560  */
7561 int iso_local_set_acl_text(char *disk_path, char *text, int flag);
7562 
7563 
7564 /**
7565  * Obtain permissions of a file in the local filesystem which shall reflect
7566  * ACL entry "group::" in S_IRWXG rather than ACL entry "mask::". This is
7567  * necessary if the permissions of a disk file with ACL shall be copied to
7568  * an object which has no ACL.
7569  * @param disk_path
7570  * Absolute path to the local file which may have an "access" ACL or not.
7571  * @param flag
7572  * Bitfield for control purposes
7573  * bit5= in case of symbolic link: inquire link target
7574  * @param st_mode
7575  * Returns permission bits as of stat(2)
7576  * @return
7577  * 1 success
7578  * -1 failure of lstat() or stat() (see errno)
7579  *
7580  * @since 0.6.14
7581  */
7582 int iso_local_get_perms_wo_acl(char *disk_path, mode_t *st_mode, int flag);
7583 
7584 
7585 /**
7586  * Get xattr and non-trivial ACLs of the given file in the local filesystem.
7587  * The resulting data has finally to be disposed by a call to this function
7588  * with flag bit15 set.
7589  *
7590  * Eventual ACLs will get encoded as attribute pair with empty name if this is
7591  * enabled by flag bit0. An ACL which simply replects stat(2) permissions
7592  * will not be put into the result.
7593  *
7594  * @param disk_path
7595  * Absolute path to the file
7596  * @param num_attrs
7597  * Will return the number of name-value pairs
7598  * @param names
7599  * Will return an array of pointers to 0-terminated names
7600  * @param value_lengths
7601  * Will return an array with the lengths of values
7602  * @param values
7603  * Will return an array of pointers to 8-bit values
7604  * @param flag
7605  * Bitfield for control purposes
7606  * bit0= obtain eventual ACLs as attribute with empty name
7607  * bit2= do not obtain attributes other than ACLs
7608  * bit3= do not ignore eventual non-user attributes.
7609  * I.e. those with a name which does not begin by "user."
7610  * bit5= in case of symbolic link: inquire link target
7611  * bit15= free memory
7612  * @return
7613  * 1 ok
7614  * 2 ok, but it is possible that attributes exist in non-user namespaces
7615  * which could not be explored due to lack of permission.
7616  * @since 1.5.0
7617  * < 0 failure
7618  *
7619  * @since 0.6.14
7620  */
7621 int iso_local_get_attrs(char *disk_path, size_t *num_attrs, char ***names,
7622  size_t **value_lengths, char ***values, int flag);
7623 
7624 
7625 /**
7626  * Attach a list of xattr and ACLs to the given file in the local filesystem.
7627  *
7628  * Eventual ACLs have to be encoded as attribute pair with empty name.
7629  *
7630  * @param disk_path
7631  * Absolute path to the file
7632  * @param num_attrs
7633  * Number of attributes
7634  * @param names
7635  * Array of pointers to 0 terminated name strings
7636  * @param value_lengths
7637  * Array of byte lengths for each attribute payload
7638  * @param values
7639  * Array of pointers to the attribute payload bytes
7640  * @param errnos
7641  * Array of integers to return error numbers if encountered at the attempt
7642  * to process the name-value pair at the given array index number:
7643  * 0 = no error , -1 = unknown error
7644  * >0 = errno as of local system calls to set xattr and ACLs
7645  * @param flag
7646  * Bitfield for control purposes
7647  * bit0= do not attach ACLs from an eventual attribute with empty name
7648  * bit3= do not ignore eventual non-user attributes.
7649  * I.e. those with a name which does not begin by "user."
7650  * bit5= in case of symbolic link: manipulate link target
7651  * bit6= @since 1.1.6
7652  * tolerate inappropriate presence or absence of
7653  * directory "default" ACL
7654  * bit7= @since 1.5.0
7655  * avoid setting a name value pair if it already exists and
7656  * has the desired value.
7657  * @return
7658  * 1 = ok
7659  * < 0 = error
7660  *
7661  * @since 1.5.0
7662  */
7663 int iso_local_set_attrs_errno(char *disk_path, size_t num_attrs, char **names,
7664  size_t *value_lengths, char **values,
7665  int *errnos, int flag);
7666 /**
7667  * Older version of iso_local_set_attrs_errno() without the errnos array.
7668  * All other parameters and the return value have the same meaning.
7669  *
7670  * @since 0.6.14
7671  */
7672 int iso_local_set_attrs(char *disk_path, size_t num_attrs, char **names,
7673  size_t *value_lengths, char **values, int flag);
7674 
7675 
7676 /* Default in case that the compile environment has no macro PATH_MAX.
7677 */
7678 #define Libisofs_default_path_maX 4096
7679 
7680 
7681 /* --------------------------- Filters in General -------------------------- */
7682 
7683 /*
7684  * A filter is an IsoStream which uses another IsoStream as input. It gets
7685  * attached to an IsoFile by specialized calls iso_file_add_*_filter() which
7686  * replace its current IsoStream by the filter stream which takes over the
7687  * current IsoStream as input.
7688  * The consequences are:
7689  * iso_file_get_stream() will return the filter stream.
7690  * iso_stream_get_size() will return the (cached) size of the filtered data,
7691  * iso_stream_open() will start eventual child processes,
7692  * iso_stream_close() will kill eventual child processes,
7693  * iso_stream_read() will return filtered data. E.g. as data file content
7694  * during ISO image generation.
7695  *
7696  * There are external filters which run child processes
7697  * iso_file_add_external_filter()
7698  * and internal filters
7699  * iso_file_add_zisofs_filter()
7700  * iso_file_add_gzip_filter()
7701  * which may or may not be available depending on compile time settings and
7702  * installed software packages like libz.
7703  *
7704  * During image generation filters get not in effect if the original IsoStream
7705  * is an "fsrc" stream based on a file in the loaded ISO image and if the
7706  * image generation type is set to 1 by iso_write_opts_set_appendable().
7707  */
7708 
7709 /**
7710  * Delete the top filter stream from a data file. This is the most recent one
7711  * which was added by iso_file_add_*_filter().
7712  * Caution: One should not do this while the IsoStream of the file is opened.
7713  * For now there is no general way to determine this state.
7714  * Filter stream implementations are urged to eventually call .close()
7715  * inside method .free() . This will close the input stream too.
7716  * @param file
7717  * The data file node which shall get rid of one layer of content
7718  * filtering.
7719  * @param flag
7720  * Bitfield for control purposes, unused yet, submit 0.
7721  * @return
7722  * 1 on success, 0 if no filter was present
7723  * <0 on error
7724  *
7725  * @since 0.6.18
7726  */
7727 int iso_file_remove_filter(IsoFile *file, int flag);
7728 
7729 /**
7730  * Obtain the eventual input stream of a filter stream.
7731  * @param stream
7732  * The eventual filter stream to be inquired.
7733  * @param flag
7734  * Bitfield for control purposes.
7735  * bit0= Follow the chain of input streams and return the one at the
7736  * end of the chain.
7737  * @since 1.3.2
7738  * @return
7739  * The input stream, if one exists. Elsewise NULL.
7740  * No extra reference to the stream is taken by this call.
7741  *
7742  * @since 0.6.18
7743  */
7744 IsoStream *iso_stream_get_input_stream(IsoStream *stream, int flag);
7745 
7746 
7747 /* ---------------------------- External Filters --------------------------- */
7748 
7749 /**
7750  * Representation of an external program that shall serve as filter for
7751  * an IsoStream. This object may be shared among many IsoStream objects.
7752  * It is to be created and disposed by the application.
7753  *
7754  * The filter will act as proxy between the original IsoStream of an IsoFile.
7755  * Up to completed image generation it will be run at least twice:
7756  * for IsoStream.class.get_size() and for .open() with subsequent .read().
7757  * So the original IsoStream has to return 1 by its .class.is_repeatable().
7758  * The filter program has to be repeateable too. I.e. it must produce the same
7759  * output on the same input.
7760  *
7761  * @since 0.6.18
7762  */
7764 {
7765  /* Will indicate future extensions. It has to be 0 for now. */
7766  int version;
7767 
7768  /* Tells how many IsoStream objects depend on this command object.
7769  * One may only dispose an IsoExternalFilterCommand when this count is 0.
7770  * Initially this value has to be 0.
7771  */
7773 
7774  /* An optional instance id.
7775  * Set to empty text if no individual name for this object is intended.
7776  */
7777  char *name;
7778 
7779  /* Absolute local filesystem path to the executable program. */
7780  char *path;
7781 
7782  /* Tells the number of arguments. */
7783  int argc;
7784 
7785  /* NULL terminated list suitable for system call execv(3).
7786  * I.e. argv[0] points to the alleged program name,
7787  * argv[1] to argv[argc] point to program arguments (if argc > 0)
7788  * argv[argc+1] is NULL
7789  */
7790  char **argv;
7791 
7792  /* A bit field which controls behavior variations:
7793  * bit0= Do not install filter if the input has size 0.
7794  * bit1= Do not install filter if the output is not smaller than the input.
7795  * bit2= Do not install filter if the number of output blocks is
7796  * not smaller than the number of input blocks. Block size is 2048.
7797  * Assume that non-empty input yields non-empty output and thus do
7798  * not attempt to attach a filter to files smaller than 2049 bytes.
7799  * bit3= suffix removed rather than added.
7800  * (Removal and adding suffixes is the task of the application.
7801  * This behavior bit serves only as reminder for the application.)
7802  */
7804 
7805  /* The eventual suffix which is supposed to be added to the IsoFile name
7806  * or to be removed from the name.
7807  * (This is to be done by the application, not by calls
7808  * iso_file_add_external_filter() or iso_file_remove_filter().
7809  * The value recorded here serves only as reminder for the application.)
7810  */
7811  char *suffix;
7812 };
7813 
7815 
7816 /**
7817  * Install an external filter command on top of the content stream of a data
7818  * file. The filter process must be repeatable. It will be run once by this
7819  * call in order to cache the output size.
7820  * @param file
7821  * The data file node which shall show filtered content.
7822  * @param cmd
7823  * The external program and its arguments which shall do the filtering.
7824  * @param flag
7825  * Bitfield for control purposes, unused yet, submit 0.
7826  * @return
7827  * 1 on success, 2 if filter installation revoked (e.g. cmd.behavior bit1)
7828  * <0 on error
7829  *
7830  * @since 0.6.18
7831  */
7833  int flag);
7834 
7835 /**
7836  * Obtain the IsoExternalFilterCommand which is eventually associated with the
7837  * given stream. (Typically obtained from an IsoFile by iso_file_get_stream()
7838  * or from an IsoStream by iso_stream_get_input_stream()).
7839  * @param stream
7840  * The stream to be inquired.
7841  * @param cmd
7842  * Will return the external IsoExternalFilterCommand. Valid only if
7843  * the call returns 1. This does not increment cmd->refcount.
7844  * @param flag
7845  * Bitfield for control purposes, unused yet, submit 0.
7846  * @return
7847  * 1 on success, 0 if the stream is not an external filter
7848  * <0 on error
7849  *
7850  * @since 0.6.18
7851  */
7853  IsoExternalFilterCommand **cmd, int flag);
7854 
7855 
7856 /* ---------------------------- Internal Filters --------------------------- */
7857 
7858 
7859 /**
7860  * Install a zisofs filter on top of the content stream of a data file.
7861  * zisofs is a compression format which is decompressed by some Linux kernels.
7862  * See also doc/zisofs_format.txt .
7863  * The filter will not be installed if its output size is not smaller than
7864  * the size of the input stream.
7865  * This is only enabled if the use of libz was enabled at compile time.
7866  * @param file
7867  * The data file node which shall show filtered content.
7868  * @param flag
7869  * Bitfield for control purposes
7870  * bit0= Do not install filter if the number of output blocks is
7871  * not smaller than the number of input blocks. Block size is 2048.
7872  * bit1= Install a decompression filter rather than one for compression.
7873  * bit2= Only inquire availability of zisofs filtering. file may be NULL.
7874  * If available return 2, else return error.
7875  * bit3= is reserved for internal use and will be forced to 0
7876  * @return
7877  * 1 on success, 2 if filter available but installation revoked
7878  * <0 on error, e.g. ISO_ZLIB_NOT_ENABLED
7879  *
7880  * @since 0.6.18
7881  */
7882 int iso_file_add_zisofs_filter(IsoFile *file, int flag);
7883 
7884 /**
7885  * Inquire the number of zisofs compression and uncompression filters which
7886  * are in use.
7887  * @param ziso_count
7888  * Will return the number of currently installed compression filters.
7889  * @param osiz_count
7890  * Will return the number of currently installed uncompression filters.
7891  * @param flag
7892  * Bitfield for control purposes, unused yet, submit 0
7893  * @return
7894  * 1 on success, <0 on error
7895  *
7896  * @since 0.6.18
7897  */
7898 int iso_zisofs_get_refcounts(off_t *ziso_count, off_t *osiz_count, int flag);
7899 
7900 
7901 /**
7902  * Parameter set for iso_zisofs_set_params().
7903  *
7904  * @since 0.6.18
7905  */
7907 
7908  /* Set to 0 for this version of the structure */
7909  int version;
7910 
7911  /* Compression level for zlib function compress2(). From <zlib.h>:
7912  * "between 0 and 9:
7913  * 1 gives best speed, 9 gives best compression, 0 gives no compression"
7914  * Default is 6.
7915  */
7917 
7918  /* Log2 of the block size for compression filters. Allowed values are:
7919  * 15 = 32 kiB , 16 = 64 kiB , 17 = 128 kiB
7920  */
7922 
7923 };
7924 
7925 /**
7926  * Set the global parameters for zisofs filtering.
7927  * This is only allowed while no zisofs compression filters are installed.
7928  * i.e. ziso_count returned by iso_zisofs_get_refcounts() has to be 0.
7929  * @param params
7930  * Pointer to a structure with the intended settings.
7931  * @param flag
7932  * Bitfield for control purposes, unused yet, submit 0
7933  * @return
7934  * 1 on success, <0 on error
7935  *
7936  * @since 0.6.18
7937  */
7938 int iso_zisofs_set_params(struct iso_zisofs_ctrl *params, int flag);
7939 
7940 /**
7941  * Get the current global parameters for zisofs filtering.
7942  * @param params
7943  * Pointer to a caller provided structure which shall take the settings.
7944  * @param flag
7945  * Bitfield for control purposes, unused yet, submit 0
7946  * @return
7947  * 1 on success, <0 on error
7948  *
7949  * @since 0.6.18
7950  */
7951 int iso_zisofs_get_params(struct iso_zisofs_ctrl *params, int flag);
7952 
7953 
7954 /**
7955  * Check for the given node or for its subtree whether the data file content
7956  * effectively bears zisofs file headers and eventually mark the outcome
7957  * by an xinfo data record if not already marked by a zisofs compressor filter.
7958  * This does not install any filter but only a hint for image generation
7959  * that the already compressed files shall get written with zisofs ZF entries.
7960  * Use this if you insert the compressed reults of program mkzftree from disk
7961  * into the image.
7962  * @param node
7963  * The node which shall be checked and eventually marked.
7964  * @param flag
7965  * Bitfield for control purposes, unused yet, submit 0
7966  * bit0= prepare for a run with iso_write_opts_set_appendable(,1).
7967  * Take into account that files from the imported image
7968  * do not get their content filtered.
7969  * bit1= permission to overwrite existing zisofs_zf_info
7970  * bit2= if no zisofs header is found:
7971  * create xinfo with parameters which indicate no zisofs
7972  * bit3= no tree recursion if node is a directory
7973  * bit4= skip files which stem from the imported image
7974  * @return
7975  * 0= no zisofs data found
7976  * 1= zf xinfo added
7977  * 2= found existing zf xinfo and flag bit1 was not set
7978  * 3= both encountered: 1 and 2
7979  * <0 means error
7980  *
7981  * @since 0.6.18
7982  */
7983 int iso_node_zf_by_magic(IsoNode *node, int flag);
7984 
7985 
7986 /**
7987  * Install a gzip or gunzip filter on top of the content stream of a data file.
7988  * gzip is a compression format which is used by programs gzip and gunzip.
7989  * The filter will not be installed if its output size is not smaller than
7990  * the size of the input stream.
7991  * This is only enabled if the use of libz was enabled at compile time.
7992  * @param file
7993  * The data file node which shall show filtered content.
7994  * @param flag
7995  * Bitfield for control purposes
7996  * bit0= Do not install filter if the number of output blocks is
7997  * not smaller than the number of input blocks. Block size is 2048.
7998  * bit1= Install a decompression filter rather than one for compression.
7999  * bit2= Only inquire availability of gzip filtering. file may be NULL.
8000  * If available return 2, else return error.
8001  * bit3= is reserved for internal use and will be forced to 0
8002  * @return
8003  * 1 on success, 2 if filter available but installation revoked
8004  * <0 on error, e.g. ISO_ZLIB_NOT_ENABLED
8005  *
8006  * @since 0.6.18
8007  */
8008 int iso_file_add_gzip_filter(IsoFile *file, int flag);
8009 
8010 
8011 /**
8012  * Inquire the number of gzip compression and uncompression filters which
8013  * are in use.
8014  * @param gzip_count
8015  * Will return the number of currently installed compression filters.
8016  * @param gunzip_count
8017  * Will return the number of currently installed uncompression filters.
8018  * @param flag
8019  * Bitfield for control purposes, unused yet, submit 0
8020  * @return
8021  * 1 on success, <0 on error
8022  *
8023  * @since 0.6.18
8024  */
8025 int iso_gzip_get_refcounts(off_t *gzip_count, off_t *gunzip_count, int flag);
8026 
8027 
8028 /* ---------------------------- MD5 Checksums --------------------------- */
8029 
8030 /* Production and loading of MD5 checksums is controlled by calls
8031  iso_write_opts_set_record_md5() and iso_read_opts_set_no_md5().
8032  For data representation details see doc/checksums.txt .
8033 */
8034 
8035 /**
8036  * Eventually obtain the recorded MD5 checksum of the session which was
8037  * loaded as ISO image. Such a checksum may be stored together with others
8038  * in a contiguous array at the end of the session. The session checksum
8039  * covers the data blocks from address start_lba to address end_lba - 1.
8040  * It does not cover the recorded array of md5 checksums.
8041  * Layout, size, and position of the checksum array is recorded in the xattr
8042  * "isofs.ca" of the session root node.
8043  * @param image
8044  * The image to inquire
8045  * @param start_lba
8046  * Eventually returns the first block address covered by md5
8047  * @param end_lba
8048  * Eventually returns the first block address not covered by md5 any more
8049  * @param md5
8050  * Eventually returns 16 byte of MD5 checksum
8051  * @param flag
8052  * Bitfield for control purposes, unused yet, submit 0
8053  * @return
8054  * 1= md5 found , 0= no md5 available , <0 indicates error
8055  *
8056  * @since 0.6.22
8057  */
8058 int iso_image_get_session_md5(IsoImage *image, uint32_t *start_lba,
8059  uint32_t *end_lba, char md5[16], int flag);
8060 
8061 /**
8062  * Eventually obtain the recorded MD5 checksum of a data file from the loaded
8063  * ISO image. Such a checksum may be stored with others in a contiguous
8064  * array at the end of the loaded session. The data file eventually has an
8065  * xattr "isofs.cx" which gives the index in that array.
8066  * @param image
8067  * The image from which file stems.
8068  * @param file
8069  * The file object to inquire
8070  * @param md5
8071  * Eventually returns 16 byte of MD5 checksum
8072  * @param flag
8073  * Bitfield for control purposes
8074  * bit0= only determine return value, do not touch parameter md5
8075  * @return
8076  * 1= md5 found , 0= no md5 available , <0 indicates error
8077  *
8078  * @since 0.6.22
8079  */
8080 int iso_file_get_md5(IsoImage *image, IsoFile *file, char md5[16], int flag);
8081 
8082 /**
8083  * Read the content of an IsoFile object, compute its MD5 and attach it to
8084  * the IsoFile. It can then be inquired by iso_file_get_md5() and will get
8085  * written into the next session if this is enabled at write time and if the
8086  * image write process does not compute an MD5 from content which it copies.
8087  * So this call can be used to equip nodes from the old image with checksums
8088  * or to make available checksums of newly added files before the session gets
8089  * written.
8090  * @param file
8091  * The file object to read data from and to which to attach the checksum.
8092  * If the file is from the imported image, then its most original stream
8093  * will be checksummed. Else the eventual filter streams will get into
8094  * effect.
8095  * @param flag
8096  * Bitfield for control purposes. Unused yet. Submit 0.
8097  * @return
8098  * 1= ok, MD5 is computed and attached , <0 indicates error
8099  *
8100  * @since 0.6.22
8101  */
8102 int iso_file_make_md5(IsoFile *file, int flag);
8103 
8104 /**
8105  * Check a data block whether it is a libisofs session checksum tag and
8106  * eventually obtain its recorded parameters. These tags get written after
8107  * volume descriptors, directory tree and checksum array and can be detected
8108  * without loading the image tree.
8109  * One may start reading and computing MD5 at the suspected image session
8110  * start and look out for a session tag on the fly. See doc/checksum.txt .
8111  * @param data
8112  * A complete and aligned data block read from an ISO image session.
8113  * @param tag_type
8114  * 0= no tag
8115  * 1= session tag
8116  * 2= superblock tag
8117  * 3= tree tag
8118  * 4= relocated 64 kB superblock tag (at LBA 0 of overwriteable media)
8119  * @param pos
8120  * Returns the LBA where the tag supposes itself to be stored.
8121  * If this does not match the data block LBA then the tag might be
8122  * image data payload and should be ignored for image checksumming.
8123  * @param range_start
8124  * Returns the block address where the session is supposed to start.
8125  * If this does not match the session start on media then the image
8126  * volume descriptors have been been relocated.
8127  * A proper checksum will only emerge if computing started at range_start.
8128  * @param range_size
8129  * Returns the number of blocks beginning at range_start which are
8130  * covered by parameter md5.
8131  * @param next_tag
8132  * Returns the predicted block address of the next tag.
8133  * next_tag is valid only if not 0 and only with return values 2, 3, 4.
8134  * With tag types 2 and 3, reading shall go on sequentially and the MD5
8135  * computation shall continue up to that address.
8136  * With tag type 4, reading shall resume either at LBA 32 for the first
8137  * session or at the given address for the session which is to be loaded
8138  * by default. In both cases the MD5 computation shall be re-started from
8139  * scratch.
8140  * @param md5
8141  * Returns 16 byte of MD5 checksum.
8142  * @param flag
8143  * Bitfield for control purposes:
8144  * bit0-bit7= tag type being looked for
8145  * 0= any checksum tag
8146  * 1= session tag
8147  * 2= superblock tag
8148  * 3= tree tag
8149  * 4= relocated superblock tag
8150  * @return
8151  * 0= not a checksum tag, return parameters are invalid
8152  * 1= checksum tag found, return parameters are valid
8153  * <0= error
8154  * (return parameters are valid with error ISO_MD5_AREA_CORRUPTED
8155  * but not trustworthy because the tag seems corrupted)
8156  *
8157  * @since 0.6.22
8158  */
8159 int iso_util_decode_md5_tag(char data[2048], int *tag_type, uint32_t *pos,
8160  uint32_t *range_start, uint32_t *range_size,
8161  uint32_t *next_tag, char md5[16], int flag);
8162 
8163 
8164 /* The following functions allow to do own MD5 computations. E.g for
8165  comparing the result with a recorded checksum.
8166 */
8167 /**
8168  * Create a MD5 computation context and hand out an opaque handle.
8169  *
8170  * @param md5_context
8171  * Returns the opaque handle. Submitted *md5_context must be NULL or
8172  * point to freeable memory.
8173  * @return
8174  * 1= success , <0 indicates error
8175  *
8176  * @since 0.6.22
8177  */
8178 int iso_md5_start(void **md5_context);
8179 
8180 /**
8181  * Advance the computation of a MD5 checksum by a chunk of data bytes.
8182  *
8183  * @param md5_context
8184  * An opaque handle once returned by iso_md5_start() or iso_md5_clone().
8185  * @param data
8186  * The bytes which shall be processed into to the checksum.
8187  * @param datalen
8188  * The number of bytes to be processed.
8189  * @return
8190  * 1= success , <0 indicates error
8191  *
8192  * @since 0.6.22
8193  */
8194 int iso_md5_compute(void *md5_context, char *data, int datalen);
8195 
8196 /**
8197  * Create a MD5 computation context as clone of an existing one. One may call
8198  * iso_md5_clone(old, &new, 0) and then iso_md5_end(&new, result, 0) in order
8199  * to obtain an intermediate MD5 sum before the computation goes on.
8200  *
8201  * @param old_md5_context
8202  * An opaque handle once returned by iso_md5_start() or iso_md5_clone().
8203  * @param new_md5_context
8204  * Returns the opaque handle to the new MD5 context. Submitted
8205  * *md5_context must be NULL or point to freeable memory.
8206  * @return
8207  * 1= success , <0 indicates error
8208  *
8209  * @since 0.6.22
8210  */
8211 int iso_md5_clone(void *old_md5_context, void **new_md5_context);
8212 
8213 /**
8214  * Obtain the MD5 checksum from a MD5 computation context and dispose this
8215  * context. (If you want to keep the context then call iso_md5_clone() and
8216  * apply iso_md5_end() to the clone.)
8217  *
8218  * @param md5_context
8219  * A pointer to an opaque handle once returned by iso_md5_start() or
8220  * iso_md5_clone(). *md5_context will be set to NULL in this call.
8221  * @param result
8222  * Gets filled with the 16 bytes of MD5 checksum.
8223  * @return
8224  * 1= success , <0 indicates error
8225  *
8226  * @since 0.6.22
8227  */
8228 int iso_md5_end(void **md5_context, char result[16]);
8229 
8230 /**
8231  * Inquire whether two MD5 checksums match. (This is trivial but such a call
8232  * is convenient and completes the interface.)
8233  * @param first_md5
8234  * A MD5 byte string as returned by iso_md5_end()
8235  * @param second_md5
8236  * A MD5 byte string as returned by iso_md5_end()
8237  * @return
8238  * 1= match , 0= mismatch
8239  *
8240  * @since 0.6.22
8241  */
8242 int iso_md5_match(char first_md5[16], char second_md5[16]);
8243 
8244 
8245 /* -------------------------------- For HFS+ ------------------------------- */
8246 
8247 
8248 /**
8249  * HFS+ attributes which may be attached to IsoNode objects as data parameter
8250  * of iso_node_add_xinfo(). As parameter proc use iso_hfsplus_xinfo_func().
8251  * Create instances of this struct by iso_hfsplus_xinfo_new().
8252  *
8253  * @since 1.2.4
8254  */
8256 
8257  /* Currently set to 0 by iso_hfsplus_xinfo_new() */
8258  int version;
8259 
8260  /* Attributes available with version 0.
8261  * See: http://en.wikipedia.org/wiki/Creator_code , .../Type_code
8262  * @since 1.2.4
8263  */
8264  uint8_t creator_code[4];
8265  uint8_t type_code[4];
8266 };
8267 
8268 /**
8269  * The function that is used to mark struct iso_hfsplus_xinfo_data at IsoNodes
8270  * and finally disposes such structs when their IsoNodes get disposed.
8271  * Usually an application does not call this function, but only uses it as
8272  * parameter of xinfo calls like iso_node_add_xinfo() or iso_node_get_xinfo().
8273  *
8274  * @since 1.2.4
8275  */
8276 int iso_hfsplus_xinfo_func(void *data, int flag);
8277 
8278 /**
8279  * Create an instance of struct iso_hfsplus_xinfo_new().
8280  *
8281  * @param flag
8282  * Bitfield for control purposes. Unused yet. Submit 0.
8283  * @return
8284  * A pointer to the new object
8285  * NULL indicates failure to allocate memory
8286  *
8287  * @since 1.2.4
8288  */
8290 
8291 
8292 /**
8293  * HFS+ blessings are relationships between HFS+ enhanced ISO images and
8294  * particular files in such images. Except for ISO_HFSPLUS_BLESS_INTEL_BOOTFILE
8295  * and ISO_HFSPLUS_BLESS_MAX, these files have to be directories.
8296  * No file may have more than one blessing. Each blessing can only be issued
8297  * to one file.
8298  *
8299  * @since 1.2.4
8300  */
8302  /* The blessing that is issued by mkisofs option -hfs-bless. */
8304 
8305  /* To be applied to a data file */
8307 
8308  /* Further blessings for directories */
8312 
8313  /* Not a blessing, but telling the number of blessings in this list */
8315 };
8316 
8317 /**
8318  * Issue a blessing to a particular IsoNode. If the blessing is already issued
8319  * to some file, then it gets revoked from that one.
8320  *
8321  * @param img
8322  * The image to manipulate.
8323  * @param blessing
8324  * The kind of blessing to be issued.
8325  * @param node
8326  * The file that shall be blessed. It must actually be an IsoDir or
8327  * IsoFile as is appropriate for the kind of blessing. (See above enum.)
8328  * The node may not yet bear a blessing other than the desired one.
8329  * If node is NULL, then the blessing will be revoked from any node
8330  * which bears it.
8331  * @param flag
8332  * Bitfield for control purposes.
8333  * bit0= Revoke blessing if node != NULL bears it.
8334  * bit1= Revoke any blessing of the node, regardless of parameter
8335  * blessing. If node is NULL, then revoke all blessings in
8336  * the image.
8337  * @return
8338  * 1 means successful blessing or revokation of an existing blessing.
8339  * 0 means the node already bears another blessing, or is of wrong type,
8340  * or that the node was not blessed and revokation was desired.
8341  * <0 is one of the listed error codes.
8342  *
8343  * @since 1.2.4
8344  */
8345 int iso_image_hfsplus_bless(IsoImage *img, enum IsoHfsplusBlessings blessing,
8346  IsoNode *node, int flag);
8347 
8348 /**
8349  * Get the array of nodes which are currently blessed.
8350  * Array indice correspond to enum IsoHfsplusBlessings.
8351  * Array element value NULL means that no node bears that blessing.
8352  *
8353  * Several usage restrictions apply. See parameter blessed_nodes.
8354  *
8355  * @param img
8356  * The image to inquire.
8357  * @param blessed_nodes
8358  * Will return a pointer to an internal node array of image.
8359  * This pointer is valid only as long as image exists and only until
8360  * iso_image_hfsplus_bless() gets used to manipulate the blessings.
8361  * Do not free() this array. Do not alter the content of the array
8362  * directly, but rather use iso_image_hfsplus_bless() and re-inquire
8363  * by iso_image_hfsplus_get_blessed().
8364  * This call does not impose an extra reference on the nodes in the
8365  * array. So do not iso_node_unref() them.
8366  * Nodes listed here are not necessarily grafted into the tree of
8367  * the IsoImage.
8368  * @param bless_max
8369  * Will return the number of elements in the array.
8370  * It is unlikely but not outruled that it will be larger than
8371  * ISO_HFSPLUS_BLESS_MAX in this libisofs.h file.
8372  * @param flag
8373  * Bitfield for control purposes. Submit 0.
8374  * @return
8375  * 1 means success, <0 means error
8376  *
8377  * @since 1.2.4
8378  */
8379 int iso_image_hfsplus_get_blessed(IsoImage *img, IsoNode ***blessed_nodes,
8380  int *bless_max, int flag);
8381 
8382 
8383 /* ----------------------------- Character sets ---------------------------- */
8384 
8385 /**
8386  * Convert the characters in name from local charset to another charset or
8387  * convert name to the representation of a particular ISO image name space.
8388  * In the latter case it is assumed that the conversion result does not
8389  * collide with any other converted name in the same directory.
8390  * I.e. this function does not take into respect possible name changes
8391  * due to collision handling.
8392  *
8393  * @param opts
8394  * Defines output charset, UCS-2 versus UTF-16 for Joliet,
8395  * and naming restrictions.
8396  * @param name
8397  * The input text which shall be converted.
8398  * @param name_len
8399  * The number of bytes in input text.
8400  * @param result
8401  * Will return the conversion result in case of success. Terminated by
8402  * a trailing zero byte.
8403  * Use free() to dispose it when no longer needed.
8404  * @param result_len
8405  * Will return the number of bytes in result (excluding trailing zero)
8406  * @param flag
8407  * Bitfield for control purposes.
8408  * bit0-bit7= Name space
8409  * 0= generic (output charset is used,
8410  * no reserved characters, no length limits)
8411  * 1= Rock Ridge (output charset is used)
8412  * 2= Joliet (output charset gets overridden by UCS-2 or
8413  * UTF-16)
8414  * 3= ECMA-119 (output charset gets overridden by the
8415  * dull ISO 9660 subset of ASCII)
8416  * 4= HFS+ (output charset gets overridden by UTF-16BE)
8417  * bit8= Treat input text as directory name
8418  * (matters for Joliet and ECMA-119)
8419  * bit9= Do not issue error messages
8420  * bit15= Reverse operation (best to be done only with results of
8421  * previous conversions)
8422  * @return
8423  * 1 means success, <0 means error
8424  *
8425  * @since 1.3.6
8426  */
8427 int iso_conv_name_chars(IsoWriteOpts *opts, char *name, size_t name_len,
8428  char **result, size_t *result_len, int flag);
8429 
8430 
8431 
8432 /************ Error codes and return values for libisofs ********************/
8433 
8434 /** successfully execution */
8435 #define ISO_SUCCESS 1
8436 
8437 /**
8438  * special return value, it could be or not an error depending on the
8439  * context.
8440  */
8441 #define ISO_NONE 0
8442 
8443 /** Operation canceled (FAILURE,HIGH, -1) */
8444 #define ISO_CANCELED 0xE830FFFF
8445 
8446 /** Unknown or unexpected fatal error (FATAL,HIGH, -2) */
8447 #define ISO_FATAL_ERROR 0xF030FFFE
8448 
8449 /** Unknown or unexpected error (FAILURE,HIGH, -3) */
8450 #define ISO_ERROR 0xE830FFFD
8451 
8452 /** Internal programming error. Please report this bug (FATAL,HIGH, -4) */
8453 #define ISO_ASSERT_FAILURE 0xF030FFFC
8454 
8455 /**
8456  * NULL pointer as value for an arg. that doesn't allow NULL (FAILURE,HIGH, -5)
8457  */
8458 #define ISO_NULL_POINTER 0xE830FFFB
8459 
8460 /** Memory allocation error (FATAL,HIGH, -6) */
8461 #define ISO_OUT_OF_MEM 0xF030FFFA
8462 
8463 /** Interrupted by a signal (FATAL,HIGH, -7) */
8464 #define ISO_INTERRUPTED 0xF030FFF9
8465 
8466 /** Invalid parameter value (FAILURE,HIGH, -8) */
8467 #define ISO_WRONG_ARG_VALUE 0xE830FFF8
8468 
8469 /** Can't create a needed thread (FATAL,HIGH, -9) */
8470 #define ISO_THREAD_ERROR 0xF030FFF7
8471 
8472 /** Write error (FAILURE,HIGH, -10) */
8473 #define ISO_WRITE_ERROR 0xE830FFF6
8474 
8475 /** Buffer read error (FAILURE,HIGH, -11) */
8476 #define ISO_BUF_READ_ERROR 0xE830FFF5
8477 
8478 /** Trying to add to a dir a node already added to a dir (FAILURE,HIGH, -64) */
8479 #define ISO_NODE_ALREADY_ADDED 0xE830FFC0
8480 
8481 /** Node with same name already exists (FAILURE,HIGH, -65) */
8482 #define ISO_NODE_NAME_NOT_UNIQUE 0xE830FFBF
8483 
8484 /** Trying to remove a node that was not added to dir (FAILURE,HIGH, -65) */
8485 #define ISO_NODE_NOT_ADDED_TO_DIR 0xE830FFBE
8486 
8487 /** A requested node does not exist (FAILURE,HIGH, -66) */
8488 #define ISO_NODE_DOESNT_EXIST 0xE830FFBD
8489 
8490 /**
8491  * Try to set the boot image of an already bootable image (FAILURE,HIGH, -67)
8492  */
8493 #define ISO_IMAGE_ALREADY_BOOTABLE 0xE830FFBC
8494 
8495 /** Trying to use an invalid file as boot image (FAILURE,HIGH, -68) */
8496 #define ISO_BOOT_IMAGE_NOT_VALID 0xE830FFBB
8497 
8498 /** Too many boot images (FAILURE,HIGH, -69) */
8499 #define ISO_BOOT_IMAGE_OVERFLOW 0xE830FFBA
8500 
8501 /** No boot catalog created yet ((FAILURE,HIGH, -70) */ /* @since 0.6.34 */
8502 #define ISO_BOOT_NO_CATALOG 0xE830FFB9
8503 
8504 
8505 /**
8506  * Error on file operation (FAILURE,HIGH, -128)
8507  * (take a look at more specified error codes below)
8508  */
8509 #define ISO_FILE_ERROR 0xE830FF80
8510 
8511 /** Trying to open an already opened file (FAILURE,HIGH, -129) */
8512 #define ISO_FILE_ALREADY_OPENED 0xE830FF7F
8513 
8514 /* @deprecated use ISO_FILE_ALREADY_OPENED instead */
8515 #define ISO_FILE_ALREADY_OPENNED 0xE830FF7F
8516 
8517 /** Access to file is not allowed (FAILURE,HIGH, -130) */
8518 #define ISO_FILE_ACCESS_DENIED 0xE830FF7E
8519 
8520 /** Incorrect path to file (FAILURE,HIGH, -131) */
8521 #define ISO_FILE_BAD_PATH 0xE830FF7D
8522 
8523 /** The file does not exist in the filesystem (FAILURE,HIGH, -132) */
8524 #define ISO_FILE_DOESNT_EXIST 0xE830FF7C
8525 
8526 /** Trying to read or close a file not openned (FAILURE,HIGH, -133) */
8527 #define ISO_FILE_NOT_OPENED 0xE830FF7B
8528 
8529 /* @deprecated use ISO_FILE_NOT_OPENED instead */
8530 #define ISO_FILE_NOT_OPENNED ISO_FILE_NOT_OPENED
8531 
8532 /** Directory used where no dir is expected (FAILURE,HIGH, -134) */
8533 #define ISO_FILE_IS_DIR 0xE830FF7A
8534 
8535 /** Read error (FAILURE,HIGH, -135) */
8536 #define ISO_FILE_READ_ERROR 0xE830FF79
8537 
8538 /** Not dir used where a dir is expected (FAILURE,HIGH, -136) */
8539 #define ISO_FILE_IS_NOT_DIR 0xE830FF78
8540 
8541 /** Not symlink used where a symlink is expected (FAILURE,HIGH, -137) */
8542 #define ISO_FILE_IS_NOT_SYMLINK 0xE830FF77
8543 
8544 /** Can't seek to specified location (FAILURE,HIGH, -138) */
8545 #define ISO_FILE_SEEK_ERROR 0xE830FF76
8546 
8547 /** File not supported in ECMA-119 tree and thus ignored (WARNING,MEDIUM, -139) */
8548 #define ISO_FILE_IGNORED 0xD020FF75
8549 
8550 /* A file is bigger than supported by used standard (FAILURE,HIGH, -140) */
8551 #define ISO_FILE_TOO_BIG 0xE830FF74
8552 
8553 /* File read error during image creation (MISHAP,HIGH, -141) */
8554 #define ISO_FILE_CANT_WRITE 0xE430FF73
8555 
8556 /* Can't convert filename to requested charset (WARNING,MEDIUM, -142) */
8557 #define ISO_FILENAME_WRONG_CHARSET 0xD020FF72
8558 /* This was once a HINT. Deprecated now. */
8559 #define ISO_FILENAME_WRONG_CHARSET_OLD 0xC020FF72
8560 
8561 /* File can't be added to the tree (SORRY,HIGH, -143) */
8562 #define ISO_FILE_CANT_ADD 0xE030FF71
8563 
8564 /**
8565  * File path break specification constraints and will be ignored
8566  * (WARNING,MEDIUM, -144)
8567  */
8568 #define ISO_FILE_IMGPATH_WRONG 0xD020FF70
8569 
8570 /**
8571  * Offset greater than file size (FAILURE,HIGH, -150)
8572  * @since 0.6.4
8573  */
8574 #define ISO_FILE_OFFSET_TOO_BIG 0xE830FF6A
8575 
8576 
8577 /** Charset conversion error (FAILURE,HIGH, -256) */
8578 #define ISO_CHARSET_CONV_ERROR 0xE830FF00
8579 
8580 /**
8581  * Too many files to mangle, i.e. we cannot guarantee unique file names
8582  * (FAILURE,HIGH, -257)
8583  */
8584 #define ISO_MANGLE_TOO_MUCH_FILES 0xE830FEFF
8585 
8586 /* image related errors */
8587 
8588 /**
8589  * Wrong or damaged Primary Volume Descriptor (FAILURE,HIGH, -320)
8590  * This could mean that the file is not a valid ISO image.
8591  */
8592 #define ISO_WRONG_PVD 0xE830FEC0
8593 
8594 /** Wrong or damaged RR entry (SORRY,HIGH, -321) */
8595 #define ISO_WRONG_RR 0xE030FEBF
8596 
8597 /** Unsupported RR feature (SORRY,HIGH, -322) */
8598 #define ISO_UNSUPPORTED_RR 0xE030FEBE
8599 
8600 /** Wrong or damaged ECMA-119 (FAILURE,HIGH, -323) */
8601 #define ISO_WRONG_ECMA119 0xE830FEBD
8602 
8603 /** Unsupported ECMA-119 feature (FAILURE,HIGH, -324) */
8604 #define ISO_UNSUPPORTED_ECMA119 0xE830FEBC
8605 
8606 /** Wrong or damaged El-Torito catalog (WARN,HIGH, -325) */
8607 #define ISO_WRONG_EL_TORITO 0xD030FEBB
8608 
8609 /** Unsupported El-Torito feature (WARN,HIGH, -326) */
8610 #define ISO_UNSUPPORTED_EL_TORITO 0xD030FEBA
8611 
8612 /** Can't patch an isolinux boot image (SORRY,HIGH, -327) */
8613 #define ISO_ISOLINUX_CANT_PATCH 0xE030FEB9
8614 
8615 /** Unsupported SUSP feature (SORRY,HIGH, -328) */
8616 #define ISO_UNSUPPORTED_SUSP 0xE030FEB8
8617 
8618 /** Error on a RR entry that can be ignored (WARNING,HIGH, -329) */
8619 #define ISO_WRONG_RR_WARN 0xD030FEB7
8620 
8621 /** Error on a RR entry that can be ignored (HINT,MEDIUM, -330) */
8622 #define ISO_SUSP_UNHANDLED 0xC020FEB6
8623 
8624 /** Multiple ER SUSP entries found (WARNING,HIGH, -331) */
8625 #define ISO_SUSP_MULTIPLE_ER 0xD030FEB5
8626 
8627 /** Unsupported volume descriptor found (HINT,MEDIUM, -332) */
8628 #define ISO_UNSUPPORTED_VD 0xC020FEB4
8629 
8630 /** El-Torito related warning (WARNING,HIGH, -333) */
8631 #define ISO_EL_TORITO_WARN 0xD030FEB3
8632 
8633 /** Image write cancelled (MISHAP,HIGH, -334) */
8634 #define ISO_IMAGE_WRITE_CANCELED 0xE430FEB2
8635 
8636 /** El-Torito image is hidden (WARNING,HIGH, -335) */
8637 #define ISO_EL_TORITO_HIDDEN 0xD030FEB1
8638 
8639 
8640 /** AAIP info with ACL or xattr in ISO image will be ignored
8641  (NOTE, HIGH, -336) */
8642 #define ISO_AAIP_IGNORED 0xB030FEB0
8643 
8644 /** Error with decoding ACL from AAIP info (FAILURE, HIGH, -337) */
8645 #define ISO_AAIP_BAD_ACL 0xE830FEAF
8646 
8647 /** Error with encoding ACL for AAIP (FAILURE, HIGH, -338) */
8648 #define ISO_AAIP_BAD_ACL_TEXT 0xE830FEAE
8649 
8650 /** AAIP processing for ACL or xattr not enabled at compile time
8651  (FAILURE, HIGH, -339) */
8652 #define ISO_AAIP_NOT_ENABLED 0xE830FEAD
8653 
8654 /** Error with decoding AAIP info for ACL or xattr (FAILURE, HIGH, -340) */
8655 #define ISO_AAIP_BAD_AASTRING 0xE830FEAC
8656 
8657 /** Error with reading ACL or xattr from local file (FAILURE, HIGH, -341) */
8658 #define ISO_AAIP_NO_GET_LOCAL 0xE830FEAB
8659 
8660 /** Error with attaching ACL or xattr to local file (FAILURE, HIGH, -342) */
8661 #define ISO_AAIP_NO_SET_LOCAL 0xE830FEAA
8662 
8663 /** Unallowed attempt to set an xattr with non-userspace name
8664  (FAILURE, HIGH, -343) */
8665 #define ISO_AAIP_NON_USER_NAME 0xE830FEA9
8666 
8667 /** Too many references on a single IsoExternalFilterCommand
8668  (FAILURE, HIGH, -344) */
8669 #define ISO_EXTF_TOO_OFTEN 0xE830FEA8
8670 
8671 /** Use of zlib was not enabled at compile time (FAILURE, HIGH, -345) */
8672 #define ISO_ZLIB_NOT_ENABLED 0xE830FEA7
8673 
8674 /** Cannot apply zisofs filter to file >= 4 GiB (FAILURE, HIGH, -346) */
8675 #define ISO_ZISOFS_TOO_LARGE 0xE830FEA6
8676 
8677 /** Filter input differs from previous run (FAILURE, HIGH, -347) */
8678 #define ISO_FILTER_WRONG_INPUT 0xE830FEA5
8679 
8680 /** zlib compression/decompression error (FAILURE, HIGH, -348) */
8681 #define ISO_ZLIB_COMPR_ERR 0xE830FEA4
8682 
8683 /** Input stream is not in zisofs format (FAILURE, HIGH, -349) */
8684 #define ISO_ZISOFS_WRONG_INPUT 0xE830FEA3
8685 
8686 /** Cannot set global zisofs parameters while filters exist
8687  (FAILURE, HIGH, -350) */
8688 #define ISO_ZISOFS_PARAM_LOCK 0xE830FEA2
8689 
8690 /** Premature EOF of zlib input stream (FAILURE, HIGH, -351) */
8691 #define ISO_ZLIB_EARLY_EOF 0xE830FEA1
8692 
8693 /**
8694  * Checksum area or checksum tag appear corrupted (WARNING,HIGH, -352)
8695  * @since 0.6.22
8696 */
8697 #define ISO_MD5_AREA_CORRUPTED 0xD030FEA0
8698 
8699 /**
8700  * Checksum mismatch between checksum tag and data blocks
8701  * (FAILURE, HIGH, -353)
8702  * @since 0.6.22
8703 */
8704 #define ISO_MD5_TAG_MISMATCH 0xE830FE9F
8705 
8706 /**
8707  * Checksum mismatch in System Area, Volume Descriptors, or directory tree.
8708  * (FAILURE, HIGH, -354)
8709  * @since 0.6.22
8710 */
8711 #define ISO_SB_TREE_CORRUPTED 0xE830FE9E
8712 
8713 /**
8714  * Unexpected checksum tag type encountered. (WARNING, HIGH, -355)
8715  * @since 0.6.22
8716 */
8717 #define ISO_MD5_TAG_UNEXPECTED 0xD030FE9D
8718 
8719 /**
8720  * Misplaced checksum tag encountered. (WARNING, HIGH, -356)
8721  * @since 0.6.22
8722 */
8723 #define ISO_MD5_TAG_MISPLACED 0xD030FE9C
8724 
8725 /**
8726  * Checksum tag with unexpected address range encountered.
8727  * (WARNING, HIGH, -357)
8728  * @since 0.6.22
8729 */
8730 #define ISO_MD5_TAG_OTHER_RANGE 0xD030FE9B
8731 
8732 /**
8733  * Detected file content changes while it was written into the image.
8734  * (MISHAP, HIGH, -358)
8735  * @since 0.6.22
8736 */
8737 #define ISO_MD5_STREAM_CHANGE 0xE430FE9A
8738 
8739 /**
8740  * Session does not start at LBA 0. scdbackup checksum tag not written.
8741  * (WARNING, HIGH, -359)
8742  * @since 0.6.24
8743 */
8744 #define ISO_SCDBACKUP_TAG_NOT_0 0xD030FE99
8745 
8746 /**
8747  * The setting of iso_write_opts_set_ms_block() leaves not enough room
8748  * for the prescibed size of iso_write_opts_set_overwrite_buf().
8749  * (FAILURE, HIGH, -360)
8750  * @since 0.6.36
8751  */
8752 #define ISO_OVWRT_MS_TOO_SMALL 0xE830FE98
8753 
8754 /**
8755  * The partition offset is not 0 and leaves not not enough room for
8756  * system area, volume descriptors, and checksum tags of the first tree.
8757  * (FAILURE, HIGH, -361)
8758  */
8759 #define ISO_PART_OFFST_TOO_SMALL 0xE830FE97
8760 
8761 /**
8762  * The ring buffer is smaller than 64 kB + partition offset.
8763  * (FAILURE, HIGH, -362)
8764  */
8765 #define ISO_OVWRT_FIFO_TOO_SMALL 0xE830FE96
8766 
8767 /** Use of libjte was not enabled at compile time (FAILURE, HIGH, -363) */
8768 #define ISO_LIBJTE_NOT_ENABLED 0xE830FE95
8769 
8770 /** Failed to start up Jigdo Template Extraction (FAILURE, HIGH, -364) */
8771 #define ISO_LIBJTE_START_FAILED 0xE830FE94
8772 
8773 /** Failed to finish Jigdo Template Extraction (FAILURE, HIGH, -365) */
8774 #define ISO_LIBJTE_END_FAILED 0xE830FE93
8775 
8776 /** Failed to process file for Jigdo Template Extraction
8777  (MISHAP, HIGH, -366) */
8778 #define ISO_LIBJTE_FILE_FAILED 0xE430FE92
8779 
8780 /** Too many MIPS Big Endian boot files given (max. 15) (FAILURE, HIGH, -367)*/
8781 #define ISO_BOOT_TOO_MANY_MIPS 0xE830FE91
8782 
8783 /** Boot file missing in image (MISHAP, HIGH, -368) */
8784 #define ISO_BOOT_FILE_MISSING 0xE430FE90
8785 
8786 /** Partition number out of range (FAILURE, HIGH, -369) */
8787 #define ISO_BAD_PARTITION_NO 0xE830FE8F
8788 
8789 /** Cannot open data file for appended partition (FAILURE, HIGH, -370) */
8790 #define ISO_BAD_PARTITION_FILE 0xE830FE8E
8791 
8792 /** May not combine MBR partition with non-MBR system area
8793  (FAILURE, HIGH, -371) */
8794 #define ISO_NON_MBR_SYS_AREA 0xE830FE8D
8795 
8796 /** Displacement offset leads outside 32 bit range (FAILURE, HIGH, -372) */
8797 #define ISO_DISPLACE_ROLLOVER 0xE830FE8C
8798 
8799 /** File name cannot be written into ECMA-119 untranslated
8800  (FAILURE, HIGH, -373) */
8801 #define ISO_NAME_NEEDS_TRANSL 0xE830FE8B
8802 
8803 /** Data file input stream object offers no cloning method
8804  (FAILURE, HIGH, -374) */
8805 #define ISO_STREAM_NO_CLONE 0xE830FE8A
8806 
8807 /** Extended information class offers no cloning method
8808  (FAILURE, HIGH, -375) */
8809 #define ISO_XINFO_NO_CLONE 0xE830FE89
8810 
8811 /** Found copied superblock checksum tag (WARNING, HIGH, -376) */
8812 #define ISO_MD5_TAG_COPIED 0xD030FE88
8813 
8814 /** Rock Ridge leaf name too long (FAILURE, HIGH, -377) */
8815 #define ISO_RR_NAME_TOO_LONG 0xE830FE87
8816 
8817 /** Reserved Rock Ridge leaf name (FAILURE, HIGH, -378) */
8818 #define ISO_RR_NAME_RESERVED 0xE830FE86
8819 
8820 /** Rock Ridge path too long (FAILURE, HIGH, -379) */
8821 #define ISO_RR_PATH_TOO_LONG 0xE830FE85
8822 
8823 /** Attribute name cannot be represented (FAILURE, HIGH, -380) */
8824 #define ISO_AAIP_BAD_ATTR_NAME 0xE830FE84
8825 
8826 /** ACL text contains multiple entries of user::, group::, other::
8827  (FAILURE, HIGH, -381) */
8828 #define ISO_AAIP_ACL_MULT_OBJ 0xE830FE83
8829 
8830 /** File sections do not form consecutive array of blocks
8831  (FAILURE, HIGH, -382) */
8832 #define ISO_SECT_SCATTERED 0xE830FE82
8833 
8834 /** Too many Apple Partition Map entries requested (FAILURE, HIGH, -383) */
8835 #define ISO_BOOT_TOO_MANY_APM 0xE830FE81
8836 
8837 /** Overlapping Apple Partition Map entries requested (FAILURE, HIGH, -384) */
8838 #define ISO_BOOT_APM_OVERLAP 0xE830FE80
8839 
8840 /** Too many GPT entries requested (FAILURE, HIGH, -385) */
8841 #define ISO_BOOT_TOO_MANY_GPT 0xE830FE7F
8842 
8843 /** Overlapping GPT entries requested (FAILURE, HIGH, -386) */
8844 #define ISO_BOOT_GPT_OVERLAP 0xE830FE7E
8845 
8846 /** Too many MBR partition entries requested (FAILURE, HIGH, -387) */
8847 #define ISO_BOOT_TOO_MANY_MBR 0xE830FE7D
8848 
8849 /** Overlapping MBR partition entries requested (FAILURE, HIGH, -388) */
8850 #define ISO_BOOT_MBR_OVERLAP 0xE830FE7C
8851 
8852 /** Attempt to use an MBR partition entry twice (FAILURE, HIGH, -389) */
8853 #define ISO_BOOT_MBR_COLLISION 0xE830FE7B
8854 
8855 /** No suitable El Torito EFI boot image for exposure as GPT partition
8856  (FAILURE, HIGH, -390) */
8857 #define ISO_BOOT_NO_EFI_ELTO 0xE830FE7A
8858 
8859 /** Not a supported HFS+ or APM block size (FAILURE, HIGH, -391) */
8860 #define ISO_BOOT_HFSP_BAD_BSIZE 0xE830FE79
8861 
8862 /** APM block size prevents coexistence with GPT (FAILURE, HIGH, -392) */
8863 #define ISO_BOOT_APM_GPT_BSIZE 0xE830FE78
8864 
8865 /** Name collision in HFS+, mangling not possible (FAILURE, HIGH, -393) */
8866 #define ISO_HFSP_NO_MANGLE 0xE830FE77
8867 
8868 /** Symbolic link cannot be resolved (FAILURE, HIGH, -394) */
8869 #define ISO_DEAD_SYMLINK 0xE830FE76
8870 
8871 /** Too many chained symbolic links (FAILURE, HIGH, -395) */
8872 #define ISO_DEEP_SYMLINK 0xE830FE75
8873 
8874 /** Unrecognized file type in ISO image (FAILURE, HIGH, -396) */
8875 #define ISO_BAD_ISO_FILETYPE 0xE830FE74
8876 
8877 /** Filename not suitable for character set UCS-2 (WARNING, HIGH, -397) */
8878 #define ISO_NAME_NOT_UCS2 0xD030FE73
8879 
8880 /** File name collision during ISO image import (WARNING, HIGH, -398) */
8881 #define ISO_IMPORT_COLLISION 0xD030FE72
8882 
8883 /** Incomplete HP-PA PALO boot parameters (FAILURE, HIGH, -399) */
8884 #define ISO_HPPA_PALO_INCOMPL 0xE830FE71
8885 
8886 /** HP-PA PALO boot address exceeds 2 GB (FAILURE, HIGH, -400) */
8887 #define ISO_HPPA_PALO_OFLOW 0xE830FE70
8888 
8889 /** HP-PA PALO file is not a data file (FAILURE, HIGH, -401) */
8890 #define ISO_HPPA_PALO_NOTREG 0xE830FE6F
8891 
8892 /** HP-PA PALO command line too long (FAILURE, HIGH, -402) */
8893 #define ISO_HPPA_PALO_CMDLEN 0xE830FE6E
8894 
8895 /** Problems encountered during inspection of System Area (WARN, HIGH, -403) */
8896 #define ISO_SYSAREA_PROBLEMS 0xD030FE6D
8897 
8898 /** Unrecognized inquiry for system area property (FAILURE, HIGH, -404) */
8899 #define ISO_INQ_SYSAREA_PROP 0xE830FE6C
8900 
8901 /** DEC Alpha Boot Loader file is not a data file (FAILURE, HIGH, -405) */
8902 #define ISO_ALPHA_BOOT_NOTREG 0xE830FE6B
8903 
8904 /** No data source of imported ISO image available (WARNING, HIGH, -406) */
8905 #define ISO_NO_KEPT_DATA_SRC 0xD030FE6A
8906 
8907 /** Malformed description string for interval reader (FAILURE, HIGH, -407) */
8908 #define ISO_MALFORMED_READ_INTVL 0xE830FE69
8909 
8910 /** Unreadable file, premature EOF, or failure to seek for interval reader
8911  (WARNING, HIGH, -408) */
8912 #define ISO_INTVL_READ_PROBLEM 0xD030FE68
8913 
8914 /** Cannot arrange content of data files in surely reproducible way
8915  (NOTE, HIGH, -409) */
8916 #define ISO_NOT_REPRODUCIBLE 0xB030FE67
8917 
8918 /** May not write boot info into filtered stream of boot image
8919  (FAILURE, HIGH, -410) */
8920 #define ISO_PATCH_FILTERED_BOOT 0xE830FE66
8921 
8922 /** Boot image to large to buffer for writing boot info
8923  (FAILURE, HIGH, -411) */
8924 #define ISO_PATCH_OVERSIZED_BOOT 0xE830FE65
8925 
8926 /** File name had to be truncated and MD5 marked (WARNING, HIGH, -412) */
8927 #define ISO_RR_NAME_TRUNCATED 0xD030FE64
8928 
8929 /** File name truncation length changed by loaded image info
8930  (NOTE, HIGH, -413) */
8931 #define ISO_TRUNCATE_ISOFSNT 0xB030FE63
8932 
8933 /** General note (NOTE, HIGH, -414) */
8934 #define ISO_GENERAL_NOTE 0xB030FE62
8935 
8936 /** Unrecognized file type of IsoFileSrc object (SORRY, HIGH, -415) */
8937 #define ISO_BAD_FSRC_FILETYPE 0xE030FE61
8938 
8939 /** Cannot derive GPT GUID from undefined pseudo-UUID volume timestamp
8940  (FAILURE, HIGH, -416) */
8941 #define ISO_GPT_NO_VOL_UUID 0xE830FE60
8942 
8943 /** Unrecognized GPT disk GUID setup mode
8944  (FAILURE, HIGH, -417) */
8945 #define ISO_BAD_GPT_GUID_MODE 0xE830FE5F
8946 
8947 /** Unable to obtain root directory (FATAL,HIGH, -418) */
8948 #define ISO_NO_ROOT_DIR 0xF030FE5E
8949 
8950 /** Zero sized, oversized, or mislocated SUSP CE area found
8951  (FAILURE, HIGH, -419) */
8952 #define ISO_SUSP_WRONG_CE_SIZE 0xE830FE5D
8953 
8954 /** Multi-session would overwrite imported_iso interval
8955  (FAILURE, HIGH, -420) */
8956 #define ISO_MULTI_OVER_IMPORTED 0xE830FE5C
8957 
8958 /** El-Torito EFI image is hidden (NOTE,HIGH, -421) */
8959 #define ISO_ELTO_EFI_HIDDEN 0xB030FE5B
8960 
8961 
8962 /* Internal developer note:
8963  Place new error codes directly above this comment.
8964  Newly introduced errors must get a message entry in
8965  libisofs/messages.c, function iso_error_to_msg()
8966 */
8967 
8968 /* ! PLACE NEW ERROR CODES ABOVE. NOT AFTER THIS LINE ! */
8969 
8970 
8971 /** Read error occurred with IsoDataSource (SORRY,HIGH, -513) */
8972 #define ISO_DATA_SOURCE_SORRY 0xE030FCFF
8973 
8974 /** Read error occurred with IsoDataSource (MISHAP,HIGH, -513) */
8975 #define ISO_DATA_SOURCE_MISHAP 0xE430FCFF
8976 
8977 /** Read error occurred with IsoDataSource (FAILURE,HIGH, -513) */
8978 #define ISO_DATA_SOURCE_FAILURE 0xE830FCFF
8979 
8980 /** Read error occurred with IsoDataSource (FATAL,HIGH, -513) */
8981 #define ISO_DATA_SOURCE_FATAL 0xF030FCFF
8982 
8983 
8984 /* ! PLACE NEW ERROR CODES SEVERAL LINES ABOVE. NOT HERE ! */
8985 
8986 
8987 /* ------------------------------------------------------------------------- */
8988 
8989 #ifdef LIBISOFS_WITHOUT_LIBBURN
8990 
8991 /**
8992  This is a copy from the API of libburn-0.6.0 (under GPL).
8993  It is supposed to be as stable as any overall include of libburn.h.
8994  I.e. if this definition is out of sync then you cannot rely on any
8995  contract that was made with libburn.h.
8996 
8997  Libisofs does not need to be linked with libburn at all. But if it is
8998  linked with libburn then it must be libburn-0.4.2 or later.
8999 
9000  An application that provides own struct burn_source objects and does not
9001  include libburn/libburn.h has to define LIBISOFS_WITHOUT_LIBBURN before
9002  including libisofs/libisofs.h in order to make this copy available.
9003 */
9004 
9005 
9006 /** Data source interface for tracks.
9007  This allows to use arbitrary program code as provider of track input data.
9008 
9009  Objects compliant to this interface are either provided by the application
9010  or by API calls of libburn: burn_fd_source_new(), burn_file_source_new(),
9011  and burn_fifo_source_new().
9012 
9013  libisofs acts as "application" and implements an own class of burn_source.
9014  Instances of that class are handed out by iso_image_create_burn_source().
9015 
9016 */
9017 struct burn_source {
9018 
9019  /** Reference count for the data source. MUST be 1 when a new source
9020  is created and thus the first reference is handed out. Increment
9021  it to take more references for yourself. Use burn_source_free()
9022  to destroy your references to it. */
9023  int refcount;
9024 
9025 
9026  /** Read data from the source. Semantics like with read(2), but MUST
9027  either deliver the full buffer as defined by size or MUST deliver
9028  EOF (return 0) or failure (return -1) at this call or at the
9029  next following call. I.e. the only incomplete buffer may be the
9030  last one from that source.
9031  libburn will read a single sector by each call to (*read).
9032  The size of a sector depends on BURN_MODE_*. The known range is
9033  2048 to 2352.
9034 
9035  If this call is reading from a pipe then it will learn
9036  about the end of data only when that pipe gets closed on the
9037  feeder side. So if the track size is not fixed or if the pipe
9038  delivers less than the predicted amount or if the size is not
9039  block aligned, then burning will halt until the input process
9040  closes the pipe.
9041 
9042  IMPORTANT:
9043  If this function pointer is NULL, then the struct burn_source is of
9044  version >= 1 and the job of .(*read)() is done by .(*read_xt)().
9045  See below, member .version.
9046  */
9047  int (*read)(struct burn_source *, unsigned char *buffer, int size);
9048 
9049 
9050  /** Read subchannel data from the source (NULL if lib generated)
9051  WARNING: This is an obscure feature with CD raw write modes.
9052  Unless you checked the libburn code for correctness in that aspect
9053  you should not rely on raw writing with own subchannels.
9054  ADVICE: Set this pointer to NULL.
9055  */
9056  int (*read_sub)(struct burn_source *, unsigned char *buffer, int size);
9057 
9058 
9059  /** Get the size of the source's data. Return 0 means unpredictable
9060  size. If application provided (*get_size) allows return 0, then
9061  the application MUST provide a fully functional (*set_size).
9062  */
9063  off_t (*get_size)(struct burn_source *);
9064 
9065 
9066  /* @since 0.3.2 */
9067  /** Program the reply of (*get_size) to a fixed value. It is advised
9068  to implement this by a attribute off_t fixed_size; in *data .
9069  The read() function does not have to take into respect this fake
9070  setting. It is rather a note of libburn to itself. Eventually
9071  necessary truncation or padding is done in libburn. Truncation
9072  is usually considered a misburn. Padding is considered ok.
9073 
9074  libburn is supposed to work even if (*get_size) ignores the
9075  setting by (*set_size). But your application will not be able to
9076  enforce fixed track sizes by burn_track_set_size() and possibly
9077  even padding might be left out.
9078  */
9079  int (*set_size)(struct burn_source *source, off_t size);
9080 
9081 
9082  /** Clean up the source specific data. This function will be called
9083  once by burn_source_free() when the last referer disposes the
9084  source.
9085  */
9086  void (*free_data)(struct burn_source *);
9087 
9088 
9089  /** Next source, for when a source runs dry and padding is disabled
9090  WARNING: This is an obscure feature. Set to NULL at creation and
9091  from then on leave untouched and uninterpreted.
9092  */
9093  struct burn_source *next;
9094 
9095 
9096  /** Source specific data. Here the various source classes express their
9097  specific properties and the instance objects store their individual
9098  management data.
9099  E.g. data could point to a struct like this:
9100  struct app_burn_source
9101  {
9102  struct my_app *app_handle;
9103  ... other individual source parameters ...
9104  off_t fixed_size;
9105  };
9106 
9107  Function (*free_data) has to be prepared to clean up and free
9108  the struct.
9109  */
9110  void *data;
9111 
9112 
9113  /* @since 0.4.2 */
9114  /** Valid only if above member .(*read)() is NULL. This indicates a
9115  version of struct burn_source younger than 0.
9116  From then on, member .version tells which further members exist
9117  in the memory layout of struct burn_source. libburn will only touch
9118  those announced extensions.
9119 
9120  Versions:
9121  0 has .(*read)() != NULL, not even .version is present.
9122  1 has .version, .(*read_xt)(), .(*cancel)()
9123  */
9124  int version;
9125 
9126  /** This substitutes for (*read)() in versions above 0. */
9127  int (*read_xt)(struct burn_source *, unsigned char *buffer, int size);
9128 
9129  /** Informs the burn_source that the consumer of data prematurely
9130  ended reading. This call may or may not be issued by libburn
9131  before (*free_data)() is called.
9132  */
9133  int (*cancel)(struct burn_source *source);
9134 };
9135 
9136 #endif /* LIBISOFS_WITHOUT_LIBBURN */
9137 
9138 /* ----------------------------- Bug Fixes ----------------------------- */
9139 
9140 /* currently none being tested */
9141 
9142 
9143 /* ---------------------------- Improvements --------------------------- */
9144 
9145 /* currently none being tested */
9146 
9147 
9148 /* ---------------------------- Experiments ---------------------------- */
9149 
9150 
9151 /* Experiment: Write obsolete RR entries with Rock Ridge.
9152  I suspect Solaris wants to see them.
9153  DID NOT HELP: Solaris knows only RRIP_1991A.
9154 
9155  #define Libisofs_with_rrip_rR yes
9156 */
9157 
9158 #ifdef __cplusplus
9159 } /* extern "C" */
9160 #endif
9161 
9162 #endif /*LIBISO_LIBISOFS_H_*/
int el_torito_get_load_seg(ElToritoBootImage *bootimg)
Get the load segment value.
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 el_torito_set_id_string(ElToritoBootImage *bootimg, uint8_t id_string[28])
Set the id_string of the Validation Entry or Sector Header Entry which will govern the boot image Sec...
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 a...
int iso_file_remove_filter(IsoFile *file, int flag)
Delete the top filter stream from a data file.
char type[4]
Type of filesystem.
Definition: libisofs.h:548
int iso_write_opts_set_hardlinks(IsoWriteOpts *opts, int enable)
Control generation of non-unique inode numbers for the emerging image.
int iso_write_opts_set_sort_files(IsoWriteOpts *opts, int sort)
Whether to sort files based on their weight.
char * iso_file_source_get_path(IsoFileSource *src)
Get the absolute path in the filesystem this file source belongs to.
int(* close)(IsoFileSource *src)
Close a previuously openned file.
Definition: libisofs.h:737
const char * iso_symlink_get_dest(const IsoSymlink *link)
Get the destination of a node.
An IsoFile Source is a POSIX abstraction of a file.
Definition: libisofs.h:913
int iso_tree_add_new_special(IsoDir *parent, const char *name, mode_t mode, dev_t dev, IsoSpecial **special)
*** Deprecated *** use iso_image_add_new_special() instead
int iso_image_new(const char *name, IsoImage **image)
Create a new image, empty.
int iso_write_opts_set_aaip(IsoWriteOpts *opts, int enable)
Control writing of AAIP informations for ACL and xattr.
Replace with the new node if it is the same file type.
Definition: libisofs.h:360
int iso_read_opts_set_no_iso1999(IsoReadOpts *opts, int noiso1999)
Do not read ISO 9660:1999 enhanced tree.
int iso_zisofs_get_refcounts(off_t *ziso_count, off_t *osiz_count, int flag)
Inquire the number of zisofs compression and uncompression filters which are in use.
int iso_write_opts_set_allow_lowercase(IsoWriteOpts *opts, int allow)
Allow lowercase characters in ISO-9660 filenames.
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.
int iso_read_opts_set_no_rockridge(IsoReadOpts *opts, int norr)
Do not read Rock Ridge extensions.
int iso_error_get_severity(int e)
Get the severity of a given error code.
int iso_data_source_new_from_file(const char *path, IsoDataSource **src)
Create a new IsoDataSource from a local file.
int(* open)(IsoFilesystem *fs)
Opens the filesystem for several read operations.
Definition: libisofs.h:605
int iso_node_remove(IsoNode *node)
Removes a child from a directory and free (unref) it.
void * iso_image_get_attached_data(IsoImage *image)
The the data previously attached with iso_image_attach_data()
void iso_data_source_ref(IsoDataSource *src)
Increments the reference counting of the given IsoDataSource.
int iso_write_opts_set_rockridge(IsoWriteOpts *opts, int enable)
Whether to use or not Rock Ridge extensions.
int el_torito_get_id_string(ElToritoBootImage *bootimg, uint8_t id_string[28])
Get the id_string as of el_torito_set_id_string().
int iso_node_remove_tree(IsoNode *node, IsoDirIter *boss_iter)
Removes a node by iso_node_remove() or iso_dir_iter_remove().
IsoFindCondition * iso_new_find_conditions_gid(gid_t gid)
Create a new condition that checks the node gid.
int iso_image_generator_is_running(IsoImage *image)
Inquire whether the image generator thread is still at work.
int compression_level
Definition: libisofs.h:7916
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...
With IsoNode and IsoBoot: Write data content even if the node is not visible in any tree...
Definition: libisofs.h:326
const char * iso_image_fs_get_volume_id(IsoImageFilesystem *fs)
Get the volume identifier for an existent image.
int iso_init_with_flag(int flag)
Initialize libisofs.
void(* get_id)(IsoStream *stream, unsigned int *fs_id, dev_t *dev_id, ino_t *ino_id)
Get an unique identifier for the IsoStream.
Definition: libisofs.h:1071
void iso_file_source_ref(IsoFileSource *src)
Take a ref to the given IsoFileSource.
struct Iso_Dir_Iter IsoDirIter
Context for iterate on directory children.
Definition: libisofs.h:277
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...
int iso_tree_get_ignore_special(IsoImage *image)
Get current setting for ignore_special.
uint32_t size
Definition: libisofs.h:259
int iso_file_source_lstat(IsoFileSource *src, struct stat *info)
Get information about the file.
int el_torito_get_boot_platform_id(ElToritoBootImage *bootimg)
Get the platform ID value.
int iso_tree_get_follow_symlinks(IsoImage *image)
Get current setting for follow_symlinks.
struct Iso_File IsoFile
A regular file in the iso tree.
Definition: libisofs.h:199
int iso_dir_get_children_count(IsoDir *dir)
Get the number of children of a directory.
const char * iso_node_get_name(const IsoNode *node)
Get the name of a node.
int iso_image_get_msg_id(IsoImage *image)
Get the id of an IsoImage, used for message reporting.
int iso_file_add_zisofs_filter(IsoFile *file, int flag)
Install a zisofs filter on top of the content stream of a data file.
const char * iso_image_get_publisher_id(const IsoImage *image)
Get the publisher of a image.
int iso_write_opts_set_omit_version_numbers(IsoWriteOpts *opts, int omit)
Omit the version number (";1") at the end of the ISO-9660 identifiers.
int(* close)(IsoDataSource *src)
Close a given source, freeing all system resources previously grabbed in open().
Definition: libisofs.h:442
struct Iso_Symlink IsoSymlink
A symbolic link in the iso tree.
Definition: libisofs.h:191
int iso_tree_add_node(IsoImage *image, IsoDir *parent, const char *path, IsoNode **node)
Add a new node to the image tree, from an existing file.
int iso_write_opts_set_allow_full_ascii(IsoWriteOpts *opts, int allow)
Allow all 8-bit characters to appear on an ISO-9660 filename.
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.
void iso_image_set_data_preparer_id(IsoImage *image, const char *data_preparer_id)
Fill in the data preparer for a image.
int iso_write_opts_set_gpt_guid(IsoWriteOpts *opts, uint8_t guid[16], int mode)
Control whether the emerging GPT gets a pseudo-randomly generated disk GUID or whether it gets a user...
int iso_write_opts_set_hfsp_serial_number(IsoWriteOpts *opts, uint8_t serial_number[8])
Supply a serial number for the HFS+ extension of the emerging image.
int iso_zisofs_get_params(struct iso_zisofs_ctrl *params, int flag)
Get the current global parameters for zisofs filtering.
int iso_write_opts_set_prep_img(IsoWriteOpts *opts, char *image_path, int flag)
Copy a data file from the local filesystem into the emerging ISO image.
int iso_write_opts_set_allow_deep_paths(IsoWriteOpts *opts, int allow)
Allow ISO-9660 directory hierarchy to be deeper than 8 levels.
uint8_t type_code[4]
Definition: libisofs.h:8265
int iso_write_opts_new(IsoWriteOpts **opts, int profile)
Creates an IsoWriteOpts for writing an image.
int iso_file_source_open(IsoFileSource *src)
Opens the source.
struct iso_find_condition IsoFindCondition
Definition: libisofs.h:5377
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_severi...
int iso_node_remove_all_xinfo(IsoNode *node, int flag)
Remove all extended information from the given node.
int iso_write_opts_set_iso_mbr_part_type(IsoWriteOpts *opts, int part_type)
Set the partition type of the MBR partition which represents the ISO filesystem or at least protects ...
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.
void el_torito_set_no_bootable(ElToritoBootImage *bootimg)
Marks the specified boot image as not bootable.
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.
void iso_node_set_ctime(IsoNode *node, time_t time)
Set the time of last status change of the file.
int iso_image_get_truncate_mode(IsoImage *img, int *mode, int *length)
Inquire the current setting of iso_image_set_truncate_mode().
int iso_write_opts_set_part_like_isohybrid(IsoWriteOpts *opts, int alike)
Control whether bits 2 to 8 of el_torito_set_isolinux_options() shall apply even if not isohybrid MBR...
int iso_image_set_truncate_mode(IsoImage *img, int mode, int length)
Set the name truncation mode and the maximum name length for nodes from image importing, creation of new IsoNode objects, and name changing image manipulations.
int iso_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 c...
void el_torito_set_load_seg(ElToritoBootImage *bootimg, short segment)
Sets the load segment for the initial boot image.
int iso_symlink_set_dest(IsoSymlink *link, const char *dest)
Set the destination of a symbolic.
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...
char * iso_stream_get_source_path(IsoStream *stream, int flag)
Try to get eventual source path string of a stream.
int iso_image_add_new_symlink(IsoImage *image, IsoDir *parent, const char *name, const char *dest, IsoSymlink **link)
Add a new symbolic link to the directory tree.
struct Iso_Boot IsoBoot
An special type of IsoNode that acts as a placeholder for an El-Torito boot catalog.
Definition: libisofs.h:292
void iso_stream_ref(IsoStream *stream)
Increment reference count of an IsoStream.
void iso_image_set_application_id(IsoImage *image, const char *application_id)
Fill in the application id for a image.
int iso_file_get_md5(IsoImage *image, IsoFile *file, char md5[16], int flag)
Eventually obtain the recorded MD5 checksum of a data file from the loaded ISO image.
int iso_file_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.
const char * iso_image_get_volume_id(const IsoImage *image)
Get the volume identifier.
int(* get_aa_string)(IsoFileSource *src, unsigned char **aa_string, int flag)
Valid only if .version is > 0.
Definition: libisofs.h:878
int iso_image_add_new_dir(IsoImage *image, IsoDir *parent, const char *name, IsoDir **dir)
Add a new directory to the iso tree.
int iso_write_opts_set_hfsp_block_size(IsoWriteOpts *opts, int hfsp_block_size, int apm_block_size)
Set the block size for Apple Partition Map and for HFS+.
int iso_dir_add_node(IsoDir *dir, IsoNode *child, enum iso_replace_mode replace)
Add a new node to a dir.
int iso_md5_end(void **md5_context, char result[16])
Obtain the MD5 checksum from a MD5 computation context and dispose this context.
int iso_write_opts_set_allow_longer_paths(IsoWriteOpts *opts, int allow)
Allow path in the ISO-9660 tree to have more than 255 characters.
int iso_node_get_xinfo(IsoNode *node, iso_node_xinfo_func proc, void **data)
Get the given extended info (defined by the proc function) from the given node.
int iso_stream_update_size(IsoStream *stream)
Updates the size of the IsoStream with the current size of the underlying source. ...
int iso_write_opts_set_disc_label(IsoWriteOpts *opts, char *label)
Set a name for the system area.
int iso_write_opts_set_output_charset(IsoWriteOpts *opts, const char *charset)
Set the charset to use for the RR names of the files that will be created on the image.
int iso_tree_remove_exclude(IsoImage *image, const char *path)
Remove a previously added exclude.
void iso_generate_gpt_guid(uint8_t guid[16])
Generate a pseudo-random GUID suitable for iso_write_opts_set_gpt_guid().
off_t(* get_size)(IsoStream *stream)
Get the size (in bytes) of the stream.
Definition: libisofs.h:1039
int iso_tree_get_ignore_hidden(IsoImage *image)
Get current setting for ignore_hidden.
void iso_node_set_mtime(IsoNode *node, time_t time)
Set the time of last modification of the file.
int iso_stream_get_external_filter(IsoStream *stream, IsoExternalFilterCommand **cmd, int flag)
Obtain the IsoExternalFilterCommand which is eventually associated with the given stream...
void iso_file_source_unref(IsoFileSource *src)
Drop your ref to the given IsoFileSource, eventually freeing the associated system resources...
int iso_image_set_hppa_palo(IsoImage *img, char *cmdline, char *bootloader, char *kernel_32, char *kernel_64, char *ramdisk, int flag)
Define a command line and submit the paths of four mandatory files for production of a HP-PA PALO boo...
int iso_image_get_bootcat(IsoImage *image, IsoBoot **catnode, uint32_t *lba, char **content, off_t *size)
Get detailed information about the boot catalog that was loaded from an ISO image.
int iso_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 descr...
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 obje...
off_t iso_file_get_size(IsoFile *file)
Get the size of the file, in bytes.
int iso_dir_iter_take(IsoDirIter *iter)
Removes a child from a directory during an iteration, without freeing it.
int el_torito_set_selection_crit(ElToritoBootImage *bootimg, uint8_t crit[20])
Set the Selection Criteria of a boot image.
uint32_t block
Definition: libisofs.h:258
IsoStream * iso_file_get_stream(IsoFile *file)
Get the IsoStream that represents the contents of the given IsoFile.
int iso_tree_add_new_symlink(IsoDir *parent, const char *name, const char *dest, IsoSymlink **link)
*** Deprecated *** use iso_image_add_new_symlink() instead
const char * iso_image_get_copyright_file_id(const IsoImage *image)
Get the copyright information of a image.
int el_torito_get_selection_crit(ElToritoBootImage *bootimg, uint8_t crit[20])
Get the Selection Criteria bytes as of el_torito_set_selection_crit().
int 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 p...
void iso_image_set_abstract_file_id(IsoImage *image, const char *abstract_file_id)
Fill abstract information for the image.
int iso_write_opts_set_ms_block(IsoWriteOpts *opts, uint32_t ms_block)
Set the start block of the image.
int iso_image_create_burn_source(IsoImage *image, IsoWriteOpts *opts, struct burn_source **burn_src)
Create a burn_source and a thread which immediately begins to generate the image. ...
ino_t serial_id
Serial number to be used when you can&#39;t get a valid id for a Stream by other means.
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.
struct iso_hfsplus_xinfo_data * iso_hfsplus_xinfo_new(int flag)
Create an instance of struct iso_hfsplus_xinfo_new().
const char * iso_image_fs_get_biblio_file_id(IsoImageFilesystem *fs)
Get the biblio file identifier for an existent image.
int iso_image_add_new_file(IsoImage *image, IsoDir *parent, const char *name, IsoStream *stream, IsoFile **file)
Add a new regular file to the iso tree.
int iso_node_xinfo_get_cloner(iso_node_xinfo_func proc, iso_node_xinfo_cloner *cloner, int flag)
Inquire the registered cloner function for a particular class of extended information.
int iso_interval_reader_new(IsoImage *img, char *path, struct iso_interval_reader **ivr, off_t *byte_count, int flag)
Create an interval reader object.
int iso_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...
void iso_image_set_volume_id(IsoImage *image, const char *volume_id)
Fill in the volume identifier for a image.
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.
void iso_image_ref(IsoImage *image)
Increments the reference counting of the given image.
int iso_read_opts_new(IsoReadOpts **opts, int profile)
Creates an IsoReadOpts for reading an existent image.
int iso_file_get_sort_weight(IsoFile *file)
Get the sort weight of a file.
int(* read)(IsoStream *stream, void *buf, size_t count)
Attempt to read up to count bytes from the given stream into the buffer starting at buf...
Definition: libisofs.h:1055
int(* is_repeatable)(IsoStream *stream)
Tell whether this IsoStream can be read several times, with the same results.
Definition: libisofs.h:1066
int iso_read_opts_set_ecma119_map(IsoReadOpts *opts, int ecma119_map)
How to convert file names if neither Rock Ridge nor Joliet names are present and acceptable.
void iso_node_unref(IsoNode *node)
Decrements the reference couting of the given node.
const char * iso_image_get_data_preparer_id(const IsoImage *image)
Get the data preparer of a image.
off_t iso_stream_get_size(IsoStream *stream)
Get the size of a given stream.
int iso_sev_to_text(int severity_number, char **severity_name)
Convert a severity number into a severity name.
int(* close)(IsoFilesystem *fs)
Close the filesystem, thus freeing all system resources.
Definition: libisofs.h:614
int iso_write_opts_set_rrip_1_10_px_ino(IsoWriteOpts *opts, int enable)
Write field PX with file serial number (i.e.
void el_torito_set_full_load(ElToritoBootImage *bootimg, int mode)
State that the load size shall be the size of the boot image automatically.
int iso_write_opts_set_always_gmt(IsoWriteOpts *opts, int gmt)
Whether to always record timestamps in GMT.
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 r...
Interface definition for IsoStream methods.
Definition: libisofs.h:984
IsoHideNodeFlag
Flag used to hide a file in the RR/ISO or Joliet tree.
Definition: libisofs.h:300
int iso_image_get_alpha_boot(IsoImage *img, char **boot_loader_path)
Inquire the path submitted by iso_image_set_alpha_boot() Do not free() the returned pointer...
int(* get_root)(IsoFilesystem *fs, IsoFileSource **root)
Get the root of a filesystem.
Definition: libisofs.h:559
int iso_local_set_attrs_errno(char *disk_path, size_t num_attrs, char **names, size_t *value_lengths, char **values, int *errnos, int flag)
Attach a list of xattr and ACLs to the given file in the local filesystem.
struct Iso_Dir IsoDir
A directory in the iso tree.
Definition: libisofs.h:183
int iso_image_was_blind_attrs(IsoImage *image, int flag)
Inquire whether some local filesystem xattr namespace could not be explored during node building...
Hide the node in the HFS+ tree, if that format is enabled.
Definition: libisofs.h:311
void iso_tree_set_follow_symlinks(IsoImage *image, int follow)
Set whether to follow or not symbolic links when added a file from a source to IsoImage.
int iso_file_source_close(IsoFileSource *src)
Close a previuously openned file.
const char * iso_image_fs_get_system_id(IsoImageFilesystem *fs)
Get the system identifier for an existent image.
unsigned int iso_fs_global_id
See IsoFilesystem->get_id() for info about this.
int el_torito_get_isolinux_options(ElToritoBootImage *bootimg, int flag)
Get the options as of el_torito_set_isolinux_options().
IsoFindCondition * iso_new_find_conditions_and(IsoFindCondition *a, IsoFindCondition *b)
Create a new condition that check if the two given conditions are valid.
unsigned int(* get_id)(IsoFilesystem *fs)
Get filesystem identifier.
Definition: libisofs.h:593
int(* clone_src)(IsoFileSource *old_src, IsoFileSource **new_src, int flag)
Produce a copy of a source.
Definition: libisofs.h:896
Hide the node in the Joliet tree, if Joliet extension are enabled.
Definition: libisofs.h:304
int iso_md5_match(char first_md5[16], char second_md5[16])
Inquire whether two MD5 checksums match.
int el_torito_get_bootable(ElToritoBootImage *bootimg)
Get the bootability flag.
void el_torito_patch_isolinux_image(ElToritoBootImage *bootimg)
Deprecated: Specifies that this image needs to be patched.
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...
int iso_read_opts_auto_input_charset(IsoReadOpts *opts, int mode)
Enable or disable methods to automatically choose an input charset.
int(* readdir)(IsoFileSource *src, IsoFileSource **child)
Read a directory.
Definition: libisofs.h:784
int iso_tree_add_new_dir(IsoDir *parent, const char *name, IsoDir **dir)
*** Deprecated *** use iso_image_add_new_dir() instead
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...
int iso_local_get_attrs(char *disk_path, size_t *num_attrs, char ***names, size_t **value_lengths, char ***values, int flag)
Get xattr and non-trivial ACLs of the given file in the local filesystem.
int version
Tells the version of the interface: Version 0 provides functions up to (*lseek)().
Definition: libisofs.h:644
int(* clone_stream)(IsoStream *old_stream, IsoStream **new_stream, int flag)
Produce a copy of a stream.
Definition: libisofs.h:1170
void iso_node_set_uid(IsoNode *node, uid_t uid)
Set the user id for the node.
time_t iso_node_get_ctime(const IsoNode *node)
Get the time of last status change of the file.
int iso_image_get_ignore_aclea(IsoImage *image)
Obtain the current setting of iso_image_set_ignore_aclea().
int iso_write_opts_set_system_area(IsoWriteOpts *opts, char data[32768], int options, int flag)
void * data
Definition: libisofs.h:624
int iso_image_set_boot_catalog_hidden(IsoImage *image, int hide_attrs)
Hides the boot catalog file from directory trees.
int iso_stream_is_repeatable(IsoStream *stream)
Whether the given IsoStream can be read several times, with the same results.
An IsoFilesystem is a handler for a source of files, or a "filesystem".
Definition: libisofs.h:541
int(* lstat)(IsoFileSource *src, struct stat *info)
Get information about the file.
Definition: libisofs.h:676
int iso_read_opts_set_no_joliet(IsoReadOpts *opts, int nojoliet)
Do not read Joliet extensions.
int iso_image_add_boot_image(IsoImage *image, const char *image_path, enum eltorito_boot_media_type type, int flag, ElToritoBootImage **boot)
Add a further boot image to the set of El-Torito bootable images.
int(* 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...
Definition: libisofs.h:759
int iso_write_opts_set_no_force_dots(IsoWriteOpts *opts, int no)
ISO-9660 forces filenames to have a ".", that separates file name from extension. ...
int iso_write_opts_set_max_37_char_filenames(IsoWriteOpts *opts, int allow)
Allow a single file or directory identifier to have up to 37 characters.
IsoFindCondition * iso_new_find_conditions_uid(uid_t uid)
Create a new condition that checks the node uid.
int iso_dir_iter_next(IsoDirIter *iter, IsoNode **node)
Get the next child.
IsoFilesystem IsoImageFilesystem
IsoFilesystem implementation to deal with ISO images, and to offer a way to access specific informati...
Definition: libisofs.h:514
int iso_local_set_acl_text(char *disk_path, char *text, int flag)
Set the ACL of the given file in the local filesystem to a given list in long text form...
int iso_stream_clone(IsoStream *old_stream, IsoStream **new_stream, int flag)
Produce a copy of a stream.
void iso_image_set_app_use(IsoImage *image, const char *app_use_data, int count)
Fill Application Use field of the Primary Volume Descriptor.
int aaip_xinfo_func(void *data, int flag)
Function to identify and manage AAIP strings as xinfo of IsoNode.
struct iso_read_image_features IsoReadImageFeatures
Return information for image.
Definition: libisofs.h:480
const char * iso_image_fs_get_application_id(IsoImageFilesystem *fs)
Get the application identifier for an existent image.
File section in an old image.
Definition: libisofs.h:256
int iso_tree_add_dir_rec(IsoImage *image, IsoDir *parent, const char *dir)
Add the contents of a dir to a given directory of the iso tree.
int el_torito_get_load_size(ElToritoBootImage *bootimg)
Get the load size.
int iso_file_make_md5(IsoFile *file, int flag)
Read the content of an IsoFile object, compute its MD5 and attach it to the IsoFile.
int iso_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 eventua...
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.
void iso_finish()
Finalize libisofs.
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.
enum IsoNodeType iso_node_get_type(IsoNode *node)
Get the type of an IsoNode.
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...
Representation of an external program that shall serve as filter for an IsoStream.
Definition: libisofs.h:7763
const char * iso_image_get_volset_id(const IsoImage *image)
Get the volset identifier.
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 "ma...
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.
void iso_filesystem_unref(IsoFilesystem *fs)
Drop your ref to the given IsoFilesystem, evetually freeing associated resources. ...
int iso_write_opts_set_joliet_longer_paths(IsoWriteOpts *opts, int allow)
Allow paths in the Joliet tree to have more than 240 characters.
void iso_image_set_publisher_id(IsoImage *image, const char *publisher_id)
Fill in the publisher for a image.
int iso_init()
Initialize libisofs.
int(* iso_node_xinfo_cloner)(void *old_data, void **new_data, int flag)
Class of functions to clone extended information.
Definition: libisofs.h:4854
struct el_torito_boot_image ElToritoBootImage
It represents an El-Torito boot image.
Definition: libisofs.h:284
int iso_node_get_old_image_lba(IsoNode *node, uint32_t *lba, int flag)
int(* stat)(IsoFileSource *src, struct stat *info)
Get information about the file.
Definition: libisofs.h:692
dev_t iso_special_get_dev(IsoSpecial *special)
Get the device id (major/minor numbers) of the given block or character device 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.
int iso_node_set_name(IsoNode *node, const char *name)
*** Deprecated *** use iso_image_set_node_name() instead
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_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...
void el_torito_set_load_size(ElToritoBootImage *bootimg, short sectors)
Sets the number of sectors (512b) to be load at load segment during the initial boot procedure...
int iso_interval_reader_read(struct iso_interval_reader *ivr, uint8_t *buf, int *buf_fill, int flag)
Read the next block of 2048 bytes from an interval reader object.
void iso_data_source_unref(IsoDataSource *src)
Decrements the reference counting of the given IsoDataSource, freeing it if refcount reach 0...
void iso_lib_version(int *major, int *minor, int *micro)
Get version of the libisofs library at runtime.
void iso_node_set_atime(IsoNode *node, time_t time)
Set the time of last access to the file.
void iso_tree_set_ignore_special(IsoImage *image, int skip)
Set whether to skip or not special files.
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.
Representation of file contents as a stream of bytes.
Definition: libisofs.h:1183
int(* read_block)(IsoDataSource *src, uint32_t lba, uint8_t *buffer)
Read an arbitrary block (2048 bytes) of data from the source.
Definition: libisofs.h:459
int iso_write_opts_set_untranslated_name_len(IsoWriteOpts *opts, int len)
Caution: This option breaks any assumptions about names that are supported by ECMA-119 specifications...
int iso_write_opts_set_dir_rec_mtime(IsoWriteOpts *opts, int allow)
Store as ECMA-119 Directory Record timestamp the mtime of the source node rather than the image creat...
char * iso_tree_get_node_path(IsoNode *node)
Get the absolute path on image of the given node.
int iso_image_filesystem_new(IsoDataSource *src, IsoReadOpts *opts, int msgid, IsoImageFilesystem **fs)
Create a new IsoFilesystem to access a existent ISO image.
int iso_image_dir_get_node(IsoImage *image, IsoDir *dir, const char *name, IsoNode **node, int flag)
Locate a node inside a given dir.
int iso_image_attach_data(IsoImage *image, void *data, void(*give_up)(void *))
Attach user defined data to the image.
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" rat...
void(* free_data)(IsoDataSource *src)
Clean up the source specific data.
Definition: libisofs.h:466
off_t(* lseek)(IsoFileSource *src, off_t offset, int flag)
Repositions the offset of the IsoFileSource (must be opened) to the given offset according to the val...
Definition: libisofs.h:843
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.
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.
const char * iso_image_get_abstract_file_id(const IsoImage *image)
Get the abstract information of a image.
int iso_file_source_access(IsoFileSource *src)
Check if the process has access to read file contents.
struct Iso_Image IsoImage
Context for image creation.
Definition: libisofs.h:164
int iso_md5_clone(void *old_md5_context, void **new_md5_context)
Create a MD5 computation context as clone of an existing one.
Always replace the old node with the new.
Definition: libisofs.h:356
int iso_write_opts_set_aaip_susp_1_10(IsoWriteOpts *opts, int oldvers)
Write AAIP as extension according to SUSP 1.10 rather than SUSP 1.12.
int iso_read_image_features_has_iso1999(IsoReadImageFeatures *f)
Whether the image is recorded according to ISO 9660:1999, i.e.
int iso_read_opts_load_system_area(IsoReadOpts *opts, int mode)
Enable or disable loading of the first 32768 bytes of the session.
int iso_image_set_sparc_core(IsoImage *img, IsoFile *sparc_core, int flag)
Designate a data file in the ISO image of which the position and size shall be written after the SUN ...
int iso_file_source_stat(IsoFileSource *src, struct stat *info)
Get information about the file.
int iso_md5_start(void **md5_context)
Create a MD5 computation context and hand out an opaque handle.
unsigned int refcount
Reference count for the data source.
Definition: libisofs.h:423
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 ...
Never replace an existing node, and instead fail with ISO_NODE_NAME_NOT_UNIQUE.
Definition: libisofs.h:352
const char * iso_image_get_system_id(const IsoImage *image)
Get the system id of a image.
int(* readlink)(IsoFileSource *src, char *buf, size_t bufsiz)
Read the destination of a symlink.
Definition: libisofs.h:808
int(* iso_node_xinfo_func)(void *data, int flag)
Class of functions to handle particular extended information.
Definition: libisofs.h:4724
time_t iso_node_get_atime(const IsoNode *node)
Get the time of last access to the file.
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 fi...
uid_t iso_node_get_uid(const IsoNode *node)
Get the user id of the node.
int iso_write_opts_set_joliet(IsoWriteOpts *opts, int enable)
Whether to add the non-standard Joliet extension to the image.
void * data
Source specific data.
Definition: libisofs.h:469
unsigned int refcount
Definition: libisofs.h:623
int iso_image_report_system_area(IsoImage *image, char ***reply, int *line_count, int flag)
Obtain an array of texts describing the detected properties of the eventually loaded System Area...
Hide the node in the ISO-9660:1999 tree, if that format is enabled.
Definition: libisofs.h:306
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 overwrit...
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.
uint32_t iso_crc32_gpt(unsigned char *data, int count, int flag)
Compute a CRC number as expected in the GPT main and backup header blocks.
const char * iso_image_fs_get_volset_id(IsoImageFilesystem *fs)
Get the volset identifier for an existent image.
Hide the node in the FAT tree, if that format is enabled.
Definition: libisofs.h:316
int iso_write_opts_detach_jte(IsoWriteOpts *opts, void **libjte_handle)
Remove eventual association to a libjte environment handle.
int iso_image_tree_clone(IsoImage *image, IsoNode *node, IsoDir *new_parent, char *new_name, IsoNode **new_node, int flag)
Create a copy of the given node under a different path.
int iso_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_IRW...
int iso_image_get_hppa_palo(IsoImage *img, char **cmdline, char **bootloader, char **kernel_32, char **kernel_64, char **ramdisk)
Inquire the current settings of iso_image_set_hppa_palo().
int iso_image_import(IsoImage *image, IsoDataSource *src, IsoReadOpts *opts, IsoReadImageFeatures **features)
Import a previous session or image, for growing or modify.
int iso_read_image_features_has_eltorito(IsoReadImageFeatures *f)
Whether El-Torito boot record is present present in the image imported.
int aaip_xinfo_cloner(void *old_data, void **new_data, int flag)
The iso_node_xinfo_cloner function which gets associated to aaip_xinfo_func by iso_init() or iso_init...
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.
struct iso_write_opts IsoWriteOpts
Options for image written.
Definition: libisofs.h:381
int el_torito_get_boot_media_type(ElToritoBootImage *bootimg, enum eltorito_boot_media_type *media_type)
Get the boot media type as of parameter "type" of iso_image_set_boot_image() or iso_image_add_boot_im...
int iso_error_get_priority(int e)
Get the priority of a given error.
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.
const char * iso_error_to_msg(int errcode)
Get a textual description of a libisofs error.
int iso_image_add_new_special(IsoImage *image, IsoDir *parent, const char *name, mode_t mode, dev_t dev, IsoSpecial **special)
Add a new special file to the directory tree.
IsoStream * iso_stream_get_input_stream(IsoStream *stream, int flag)
Obtain the eventual input stream of a filter stream.
int iso_read_opts_set_preferjoliet(IsoReadOpts *opts, int preferjoliet)
Whether to prefer Joliet over RR.
Replace with the new node if it is the same file type and its ctime is newer than the old one...
Definition: libisofs.h:365
void iso_write_opts_free(IsoWriteOpts *opts)
Free an IsoWriteOpts previously allocated with iso_write_opts_new().
int iso_local_get_acl_text(char *disk_path, char **text, int flag)
Get an ACL of the given file in the local filesystem in long text form.
int iso_local_set_attrs(char *disk_path, size_t num_attrs, char **names, size_t *value_lengths, char **values, int flag)
Older version of iso_local_set_attrs_errno() without the errnos array.
int iso_tree_path_to_node(IsoImage *image, const char *path, IsoNode **node)
*** Deprecated *** In most cases use iso_image_path_to_node() instead
int iso_set_abort_severity(char *severity)
Set the minimum error severity that causes a libisofs operation to be aborted as soon as possible...
Interface definition for an IsoFileSource.
Definition: libisofs.h:633
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.
IsoFindCondition * iso_new_find_conditions_not(IsoFindCondition *negate)
Create a new condition that check if the given conditions is false.
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.
int iso_error_get_code(int e)
Get the message queue code of a libisofs error.
int iso_dir_get_node(IsoDir *dir, const char *name, IsoNode **node)
*** Deprecated *** In most cases use iso_image_dir_get_node() instead.
Data source used by libisofs for reading an existing image.
Definition: libisofs.h:412
void iso_image_set_volset_id(IsoImage *image, const char *volset_id)
Fill in the volset identifier for a image.
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_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 ver...
int iso_set_msgs_severities(char *queue_severity, char *print_severity, char *print_id)
Control queueing and stderr printing of messages from libisofs.
int iso_tree_add_new_file(IsoDir *parent, const char *name, IsoStream *stream, IsoFile **file)
*** Deprecated *** use iso_image_add_new_file() instead
int iso_lib_is_compatible(int major, int minor, int micro)
Check at runtime if the library is ABI compatible with the given version.
int el_torito_set_boot_platform_id(ElToritoBootImage *bootimg, uint8_t id)
Sets the platform ID of the boot image.
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...
void iso_image_set_copyright_file_id(IsoImage *image, const char *copyright_file_id)
Fill copyright information for the image.
int iso_image_give_up_mips_boot(IsoImage *image, int flag)
Clear the list of MIPS Big Endian boot file paths.
void(* free)(IsoFilesystem *fs)
Free implementation specific data.
Definition: libisofs.h:620
IsoHfsplusBlessings
HFS+ blessings are relationships between HFS+ enhanced ISO images and particular files in such images...
Definition: libisofs.h:8301
int(* get_by_path)(IsoFilesystem *fs, const char *path, IsoFileSource **file)
Retrieve a file from its absolute path inside the filesystem.
Definition: libisofs.h:577
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...
IsoFindCondition * iso_new_find_conditions_name(const char *wildcard)
Create a new condition that checks if the node name matches the given wildcard.
int iso_write_opts_attach_jte(IsoWriteOpts *opts, void *libjte_handle)
Associate a libjte environment object to the upcoming write run.
int(* close)(IsoStream *stream)
Close the Stream.
Definition: libisofs.h:1032
int iso_truncate_leaf_name(int mode, int length, char *name, int flag)
Immediately apply the given truncate mode and length to the given string.
int iso_read_opts_set_no_aaip(IsoReadOpts *opts, int noaaip)
Control reading of AAIP informations about ACL and xattr when loading existing images.
int iso_node_set_attrs(IsoNode *node, size_t num_attrs, char **names, size_t *value_lengths, char **values, int flag)
Set the list of xattr which is associated with the node.
int iso_image_get_sparc_core(IsoImage *img, IsoFile **sparc_core, int flag)
Obtain the current setting of iso_image_set_sparc_core().
IsoDir * iso_node_get_parent(IsoNode *node)
void iso_filesystem_ref(IsoFilesystem *fs)
Take a ref to the given IsoFilesystem.
int iso_image_set_boot_image(IsoImage *image, const char *image_path, enum eltorito_boot_media_type type, const char *catalog_path, ElToritoBootImage **boot)
Create a new set of El-Torito bootable images by adding a boot catalog and the default boot image...
int iso_read_opts_set_no_md5(IsoReadOpts *opts, int no_md5)
Control reading of an array of MD5 checksums which is eventually stored at the end of a session...
int iso_tree_clone(IsoNode *node, IsoDir *new_parent, char *new_name, IsoNode **new_node, int flag)
*** Deprecated *** use iso_image_tree_clone() instead
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.
char * iso_file_source_get_name(IsoFileSource *src)
Get the name of the file, with the dir component of the path.
struct Iso_Special IsoSpecial
An special file in the iso tree.
Definition: libisofs.h:209
char * iso_get_local_charset(int flag)
Obtain the local charset as currently assumed by libisofs.
void iso_image_remove_boot_image(IsoImage *image)
Removes all El-Torito boot images from the ISO image.
int iso_write_opts_set_hfsplus(IsoWriteOpts *opts, int enable)
Whether to add a HFS+ filesystem to the image which points to the same file content as the other dire...
int iso_file_source_get_aa_string(IsoFileSource *src, unsigned char **aa_string, int flag)
Get the AAIP string with encoded ACL and xattr.
int iso_image_set_node_name(IsoImage *image, IsoNode *node, const char *name, int flag)
Set the name of a node.
int iso_image_hfsplus_get_blessed(IsoImage *img, IsoNode ***blessed_nodes, int *bless_max, int flag)
Get the array of nodes which are currently blessed.
int iso_ring_buffer_get_status(struct burn_source *b, size_t *size, size_t *free_bytes)
Get the status of the buffer used by a burn_source.
int iso_read_opts_set_default_gid(IsoReadOpts *opts, gid_t gid)
Set default gid for files when RR extensions are not present.
struct Iso_Node IsoNode
Definition: libisofs.h:175
int iso_image_update_sizes(IsoImage *image)
Update the sizes of all files added to image.
int iso_read_image_features_has_rockridge(IsoReadImageFeatures *f)
Whether RockRidge extensions are present in the image imported.
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.
int iso_stream_close(IsoStream *stream)
Close a previously openned IsoStream.
int el_torito_get_full_load(ElToritoBootImage *bootimg)
Inquire the setting of el_torito_set_full_load().
const char * iso_image_get_biblio_file_id(const IsoImage *image)
Get the biblio information of a image.
int(* cmp_ino)(IsoStream *s1, IsoStream *s2)
Compare two streams whether they are based on the same input and will produce the same output...
Definition: libisofs.h:1151
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.
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 f...
gid_t iso_node_get_gid(const IsoNode *node)
Get the group id of the node.
int iso_image_report_el_torito(IsoImage *image, char ***reply, int *line_count, int flag)
Obtain an array of texts describing the detected properties of the eventually loaded El Torito boot i...
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...
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_creat...
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 t...
const char * iso_image_fs_get_abstract_file_id(IsoImageFilesystem *fs)
Get the abstract file identifier for an existent image.
int iso_dir_iter_has_next(IsoDirIter *iter)
Check if there&#39;re more children.
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 al...
int(* open)(IsoDataSource *src)
Opens the given source.
Definition: libisofs.h:433
void(* free)(IsoStream *stream)
Free implementation specific data.
Definition: libisofs.h:1078
enum iso_replace_mode iso_tree_get_replace_mode(IsoImage *image)
Get current setting for replace_mode.
int iso_node_take(IsoNode *node)
Removes a child from a directory.
int iso_node_lookup_attr(IsoNode *node, char *name, size_t *value_length, char **value, int flag)
Obtain the value of a particular xattr name.
int iso_dir_iter_remove(IsoDirIter *iter)
Removes a child from a directory during an iteration and unref() it.
int iso_write_opts_set_appended_as_apm(IsoWriteOpts *opts, int apm)
Control whether partitions created by iso_write_opts_set_partition_img() are to be represented in App...
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 ch...
Parameter set for iso_zisofs_set_params().
Definition: libisofs.h:7906
int iso_zisofs_set_params(struct iso_zisofs_ctrl *params, int flag)
Set the global parameters for zisofs filtering.
int iso_image_set_alpha_boot(IsoImage *img, char *boot_loader_path, int flag)
Submit the path of the DEC Alpha Secondary Bootstrap Loader file.
void * iso_get_messenger()
Return the messenger object handle used by libisofs.
int iso_dir_get_children(const IsoDir *dir, IsoDirIter **iter)
Get an iterator for the children of the given dir.
const char * iso_image_get_app_use(IsoImage *image)
Get the current setting for the Application Use field of the Primary Volume Descriptor.
char type[4]
Type of Stream.
Definition: libisofs.h:1016
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 o...
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 Roc...
int iso_write_opts_set_iso1999(IsoWriteOpts *opts, int enable)
Whether to use newer ISO-9660:1999 version.
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.
const char * iso_image_get_application_id(const IsoImage *image)
Get the application id of a image.
void * data
Definition: libisofs.h:1187
void iso_stream_unref(IsoStream *stream)
Decrement reference count of an IsoStream, and eventually free it if refcount reach 0...
eltorito_boot_media_type
El-Torito bootable image type.
Definition: libisofs.h:334
int iso_write_opts_set_joliet_utf16(IsoWriteOpts *opts, int allow)
Use character set UTF-16BE with Joliet, which is a superset of the actually prescribed character set ...
IsoFindCondition * iso_new_find_conditions_mode(mode_t mask)
Create a new condition that checks the node mode against a mode mask.
IsoNodeType
The type of an IsoNode.
Definition: libisofs.h:228
int iso_file_source_readdir(IsoFileSource *src, IsoFileSource **child)
Read a directory.
void iso_image_set_biblio_file_id(IsoImage *image, const char *biblio_file_id)
Fill biblio information for the image.
int iso_file_add_external_filter(IsoFile *file, IsoExternalFilterCommand *cmd, int flag)
Install an external filter command on top of the content stream of a data file.
int iso_md5_compute(void *md5_context, char *data, int datalen)
Advance the computation of a MD5 checksum by a chunk of data bytes.
uint8_t block_size_log2
Definition: libisofs.h:7921
int iso_image_add_mips_boot_file(IsoImage *image, char *path, int flag)
Add a MIPS boot file path to the image.
int(* open)(IsoStream *stream)
Opens the stream.
Definition: libisofs.h:1025
void iso_node_set_sort_weight(IsoNode *node, int w)
Sets the order in which a node will be written on image.
int el_torito_set_isolinux_options(ElToritoBootImage *bootimg, int options, int flag)
Specifies options for ISOLINUX or GRUB boot images.
int(* access)(IsoFileSource *src)
Check if the process has access to read file contents.
Definition: libisofs.h:713
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_sou...
const char * iso_image_fs_get_copyright_file_id(IsoImageFilesystem *fs)
Get the copyright file identifier for an existent image.
int iso_interval_reader_destroy(struct iso_interval_reader **ivr, int flag)
Dispose an interval reader object.
int(* open)(IsoFileSource *src)
Opens the source.
Definition: libisofs.h:727
int iso_read_opts_set_input_charset(IsoReadOpts *opts, const char *charset)
Set the input charset of the file names on the image.
int iso_write_opts_set_rr_reloc(IsoWriteOpts *opts, char *name, int flags)
This call describes the directory where to store Rock Ridge relocated directories.
void(* free)(IsoFileSource *src)
Free implementation specific data.
Definition: libisofs.h:823
int refcount
Definition: libisofs.h:1186
void iso_image_set_system_id(IsoImage *image, const char *system_id)
Fill in the system id for a image.
int iso_read_opts_set_new_inos(IsoReadOpts *opts, int new_inos)
Control discarding of eventual inode numbers from existing images.
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_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...
void iso_image_unref(IsoImage *image)
Decrements the reference couting of the given image.
iso_replace_mode
Replace mode used when addding a node to a directory.
Definition: libisofs.h:347
void iso_tree_set_ignore_hidden(IsoImage *image, int skip)
Set whether to skip or not disk files with names beginning by &#39;.
iso_find_comparisons
Possible comparison between IsoNode and given conditions.
Definition: libisofs.h:5439
HFS+ attributes which may be attached to IsoNode objects as data parameter of iso_node_add_xinfo().
Definition: libisofs.h:8255
void iso_node_set_permissions(IsoNode *node, mode_t mode)
Set the permissions for the node.
void iso_node_set_gid(IsoNode *node, gid_t gid)
Set the group id for the node.
int iso_local_attr_support(int flag)
libisofs has an internal system dependent adapter to ACL and xattr operations.
const char * iso_image_fs_get_publisher_id(IsoImageFilesystem *fs)
Get the publisher identifier for an existent image.
int iso_read_image_features_has_joliet(IsoReadImageFeatures *f)
Whether Joliet extensions are present in the image imported.
void iso_node_ref(IsoNode *node)
Increments the reference counting of the given node.
int iso_stream_cmp_ino(IsoStream *s1, IsoStream *s2, int flag)
Compare two streams whether they are based on the same input and will produce the same output...
int iso_file_source_readlink(IsoFileSource *src, char *buf, size_t bufsiz)
Read the destination of a symlink.
Hide the node in the ECMA-119 / RR tree.
Definition: libisofs.h:302
struct iso_read_opts IsoReadOpts
Options for image reading or import.
Definition: libisofs.h:388
IsoFilesystem * iso_file_source_get_filesystem(IsoFileSource *src)
Get the filesystem for this source.
int iso_node_add_xinfo(IsoNode *node, iso_node_xinfo_func proc, void *data)
Add extended information to the given node.
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...
mode_t iso_node_get_permissions(const IsoNode *node)
Get the permissions for the node.
int iso_conv_name_chars(IsoWriteOpts *opts, char *name, size_t name_len, char **result, size_t *result_len, int flag)
Convert the characters in name from local charset to another charset or convert name to the represent...
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.
void iso_dir_iter_free(IsoDirIter *iter)
Free a dir iterator.
int(* update_size)(IsoStream *stream)
Update the size of the IsoStream with the current size of the underlying source, if the source is pro...
Definition: libisofs.h:1095
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_iso_level(IsoWriteOpts *opts, int level)
Set the ISO-9960 level to write at.
time_t iso_node_get_mtime(const IsoNode *node)
Get the time of last modification of the file.
int iso_write_opts_set_fat(IsoWriteOpts *opts, int enable)
Production of FAT32 is not implemented yet.
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_image_path_to_node(IsoImage *image, const char *path, IsoNode **node)
Locate a node by its absolute path in the image.
const char * iso_image_fs_get_data_preparer_id(IsoImageFilesystem *fs)
Get the data preparer identifier for an existent image.
int iso_write_opts_set_scdbackup_tag(IsoWriteOpts *opts, char *name, char *timestamp, char *tag_written)
Set the parameters "name" and "timestamp" for a scdbackup checksum tag.
int iso_write_opts_set_appended_as_gpt(IsoWriteOpts *opts, int gpt)
Control whether partitions created by iso_write_opts_set_partition_img() are to be represented in MBR...
void iso_read_image_features_destroy(IsoReadImageFeatures *f)
Destroy an IsoReadImageFeatures object obtained with iso_image_import.
uint8_t creator_code[4]
Definition: libisofs.h:8264
int iso_text_to_sev(char *severity_name, int *severity_number)
Convert a severity name into a severity number, which gives the severity rank of the name...
int iso_read_opts_keep_import_src(IsoReadOpts *opts, int mode)
Control whether to keep a reference to the IsoDataSource object which allows access to the blocks of ...
int iso_read_opts_set_start_block(IsoReadOpts *opts, uint32_t block)
Set the block where the image begins.
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.
void iso_read_opts_free(IsoReadOpts *opts)
Free an IsoReadOpts previously allocated with iso_read_opts_new().
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 tha...
int iso_tree_add_exclude(IsoImage *image, const char *path)
Add a excluded path.
int iso_stream_open(IsoStream *stream)
Opens the given stream.
int iso_write_opts_set_joliet_long_names(IsoWriteOpts *opts, int allow)
Allow leaf names in the Joliet tree to have up to 103 characters.
int iso_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 alr...
int iso_dir_find_children(IsoDir *dir, IsoFindCondition *cond, IsoDirIter **iter)
Find all directory children that match the given condition.
int iso_image_hfsplus_bless(IsoImage *img, enum IsoHfsplusBlessings blessing, IsoNode *node, int flag)
Issue a blessing to a particular IsoNode.
IsoDir * iso_image_get_root(const IsoImage *image)
Get the root directory of the image.
Replace with the new node if its ctime is newer than the old one.
Definition: libisofs.h:369
int iso_node_get_hidden(IsoNode *node)
Get the hide_attrs as eventually set by iso_node_set_hidden().
mode_t iso_node_get_mode(const IsoNode *node)
Get the mode of the node, both permissions and file type, as specified in &#39;man 2 stat&#39;.

Generated for libisofs by  doxygen 1.8.14