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

Generated for libisofs by  doxygen 1.8.1.1