libisofs  1.3.4
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 3
87 #define iso_lib_header_version_micro 4
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  * 1= MIPS Big Endian Volume Header
2160  * @since 0.6.38
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  * @since 0.6.38
2167  * The first boot file submitted by
2168  * iso_image_add_mips_boot_file() will be activated.
2169  * This will overwrite the first 512 bytes of the submitted
2170  * data.
2171  * 3= SUN Disk Label for SUN SPARC
2172  * @since 0.6.40
2173  * Submit up to 7 SPARC boot images by
2174  * iso_write_opts_set_partition_img() for partition numbers 2
2175  * to 8.
2176  * This will overwrite the first 512 bytes of the submitted
2177  * data.
2178  * bit8-9= Only with System area type 0 = MBR
2179  * @since 1.0.4
2180  * Cylinder alignment mode eventually pads the image to make it
2181  * end at a cylinder boundary.
2182  * 0 = auto (align if bit1)
2183  * 1 = always align to cylinder boundary
2184  * 2 = never align to cylinder boundary
2185  * 3 = always align, additionally pad up and align partitions
2186  * which were appended by iso_write_opts_set_partition_img()
2187  * @since 1.2.6
2188  * bit10-13= System area sub type
2189  * @since 1.2.4
2190  * With type 0 = MBR:
2191  * Gets overridden by bit0 and bit1.
2192  * 0 = no particular sub type
2193  * 1 = CHRP: A single MBR partition of type 0x96 covers the
2194  * ISO image. Not compatible with any other feature
2195  * which needs to have own MBR partition entries.
2196  * bit14= Only with System area type 0 = MBR
2197  * GRUB2 boot provisions:
2198  * @since 1.3.0
2199  * Patch system area at byte 92 to 99 with 512-block address + 1
2200  * of the first boot image file. Little-endian 8-byte.
2201  * Should be combined with options bit0.
2202  * Will not be in effect if options bit1 is set.
2203  * @param flag
2204  * bit0 = invalidate any attached system area data. Same as data == NULL
2205  * (This re-activates eventually loaded image System Area data.
2206  * To erase those, submit 32 kB of zeros without flag bit0.)
2207  * bit1 = keep data unaltered
2208  * bit2 = keep options unaltered
2209  * @return
2210  * ISO_SUCCESS or error
2211  * @since 0.6.30
2212  */
2213 int iso_write_opts_set_system_area(IsoWriteOpts *opts, char data[32768],
2214  int options, int flag);
2215 
2216 /**
2217  * Set a name for the system area. This setting is ignored unless system area
2218  * type 3 "SUN Disk Label" is in effect by iso_write_opts_set_system_area().
2219  * In this case it will replace the default text at the start of the image:
2220  * "CD-ROM Disc with Sun sparc boot created by libisofs"
2221  *
2222  * @param opts
2223  * The option set to be manipulated.
2224  * @param label
2225  * A text of up to 128 characters.
2226  * @return
2227  * ISO_SUCCESS or error
2228  * @since 0.6.40
2229 */
2230 int iso_write_opts_set_disc_label(IsoWriteOpts *opts, char *label);
2231 
2232 /**
2233  * Explicitely set the four timestamps of the emerging Primary Volume
2234  * Descriptor and in the volume descriptors of Joliet and ISO 9660:1999,
2235  * if those are to be generated.
2236  * Default with all parameters is 0.
2237  *
2238  * ECMA-119 defines them as:
2239  * @param opts
2240  * The option set to be manipulated.
2241  * @param vol_creation_time
2242  * When "the information in the volume was created."
2243  * A value of 0 means that the timepoint of write start is to be used.
2244  * @param vol_modification_time
2245  * When "the information in the volume was last modified."
2246  * A value of 0 means that the timepoint of write start is to be used.
2247  * @param vol_expiration_time
2248  * When "the information in the volume may be regarded as obsolete."
2249  * A value of 0 means that the information never shall expire.
2250  * @param vol_effective_time
2251  * When "the information in the volume may be used."
2252  * A value of 0 means that not such retention is intended.
2253  * @param vol_uuid
2254  * If this text is not empty, then it overrides vol_creation_time and
2255  * vol_modification_time by copying the first 16 decimal digits from
2256  * uuid, eventually padding up with decimal '1', and writing a NUL-byte
2257  * as timezone.
2258  * Other than with vol_*_time the resulting string in the ISO image
2259  * is fully predictable and free of timezone pitfalls.
2260  * It should express a reasonable time in form YYYYMMDDhhmmsscc
2261  * E.g.: "2010040711405800" = 7 Apr 2010 11:40:58 (+0 centiseconds)
2262  * @return
2263  * ISO_SUCCESS or error
2264  *
2265  * @since 0.6.30
2266  */
2268  time_t vol_creation_time, time_t vol_modification_time,
2269  time_t vol_expiration_time, time_t vol_effective_time,
2270  char *vol_uuid);
2271 
2272 
2273 /*
2274  * Control production of a second set of volume descriptors (superblock)
2275  * and directory trees, together with a partition table in the MBR where the
2276  * first partition has non-zero start address and the others are zeroed.
2277  * The first partition stretches to the end of the whole ISO image.
2278  * The additional volume descriptor set and trees will allow to mount the
2279  * ISO image at the start of the first partition, while it is still possible
2280  * to mount it via the normal first volume descriptor set and tree at the
2281  * start of the image resp. storage device.
2282  * This makes few sense on optical media. But on USB sticks it creates a
2283  * conventional partition table which makes it mountable on e.g. Linux via
2284  * /dev/sdb and /dev/sdb1 alike.
2285  * IMPORTANT: When submitting memory by iso_write_opts_set_overwrite_buf()
2286  * then its size must be at least 64 KiB + partition offset.
2287  *
2288  * @param opts
2289  * The option set to be manipulated.
2290  * @param block_offset_2k
2291  * The offset of the partition start relative to device start.
2292  * This is counted in 2 kB blocks. The partition table will show the
2293  * according number of 512 byte sectors.
2294  * Default is 0 which causes no special partition table preparations.
2295  * If it is not 0 then it must not be smaller than 16.
2296  * @param secs_512_per_head
2297  * Number of 512 byte sectors per head. 1 to 63. 0=automatic.
2298  * @param heads_per_cyl
2299  * Number of heads per cylinder. 1 to 255. 0=automatic.
2300  * @return
2301  * ISO_SUCCESS or error
2302  *
2303  * @since 0.6.36
2304  */
2306  uint32_t block_offset_2k,
2307  int secs_512_per_head, int heads_per_cyl);
2308 
2309 
2310 /** The minimum version of libjte to be used with this version of libisofs
2311  at compile time. The use of libjte is optional and depends on configure
2312  tests. It can be prevented by ./configure option --disable-libjte .
2313  @since 0.6.38
2314 */
2315 #define iso_libjte_req_major 1
2316 #define iso_libjte_req_minor 0
2317 #define iso_libjte_req_micro 0
2318 
2319 /**
2320  * Associate a libjte environment object to the upcomming write run.
2321  * libjte implements Jigdo Template Extraction as of Steve McIntyre and
2322  * Richard Atterer.
2323  * The call will fail if no libjte support was enabled at compile time.
2324  * @param opts
2325  * The option set to be manipulated.
2326  * @param libjte_handle
2327  * Pointer to a struct libjte_env e.g. created by libjte_new().
2328  * It must stay existent from the start of image generation by
2329  * iso_image_create_burn_source() until the write thread has ended.
2330  * This can be inquired by iso_image_generator_is_running().
2331  * In order to keep the libisofs API identical with and without
2332  * libjte support the parameter type is (void *).
2333  * @return
2334  * ISO_SUCCESS or error
2335  *
2336  * @since 0.6.38
2337 */
2338 int iso_write_opts_attach_jte(IsoWriteOpts *opts, void *libjte_handle);
2339 
2340 /**
2341  * Remove eventual association to a libjte environment handle.
2342  * The call will fail if no libjte support was enabled at compile time.
2343  * @param opts
2344  * The option set to be manipulated.
2345  * @param libjte_handle
2346  * If not submitted as NULL, this will return the previously set
2347  * libjte handle.
2348  * @return
2349  * ISO_SUCCESS or error
2350  *
2351  * @since 0.6.38
2352 */
2353 int iso_write_opts_detach_jte(IsoWriteOpts *opts, void **libjte_handle);
2354 
2355 
2356 /**
2357  * Cause a number of blocks with zero bytes to be written after the payload
2358  * data, but before the eventual checksum data. Unlike libburn tail padding,
2359  * these blocks are counted as part of the image and covered by eventual
2360  * image checksums.
2361  * A reason for such padding can be the wish to prevent the Linux read-ahead
2362  * bug by sacrificial data which still belong to image and Jigdo template.
2363  * Normally such padding would be the job of the burn program which should know
2364  * that it is needed with CD write type TAO if Linux read(2) shall be able
2365  * to read all payload blocks.
2366  * 150 blocks = 300 kB is the traditional sacrifice to the Linux kernel.
2367  * @param opts
2368  * The option set to be manipulated.
2369  * @param num_blocks
2370  * Number of extra 2 kB blocks to be written.
2371  * @return
2372  * ISO_SUCCESS or error
2373  *
2374  * @since 0.6.38
2375  */
2376 int iso_write_opts_set_tail_blocks(IsoWriteOpts *opts, uint32_t num_blocks);
2377 
2378 /**
2379  * Copy a data file from the local filesystem into the emerging ISO image.
2380  * Mark it by an MBR partition entry as PreP partition and also cause
2381  * protective MBR partition entries before and after this partition.
2382  * Vladimir Serbinenko stated aboy PreP = PowerPC Reference Platform :
2383  * "PreP [...] refers mainly to IBM hardware. PreP boot is a partition
2384  * containing only raw ELF and having type 0x41."
2385  *
2386  * This feature is only combinable with system area type 0
2387  * and currently not combinable with ISOLINUX isohybrid production.
2388  * It overrides --protective-msdos-label. See iso_write_opts_set_system_area().
2389  * Only partition 4 stays available for iso_write_opts_set_partition_img().
2390  * It is compatible with HFS+/FAT production by storing the PreP partition
2391  * before the start of the HFS+/FAT partition.
2392  *
2393  * @param opts
2394  * The option set to be manipulated.
2395  * @param image_path
2396  * File address in the local file system.
2397  * NULL revokes production of the PreP partition.
2398  * @param flag
2399  * Reserved for future usage, set to 0.
2400  * @return
2401  * ISO_SUCCESS or error
2402  *
2403  * @since 1.2.4
2404  */
2405 int iso_write_opts_set_prep_img(IsoWriteOpts *opts, char *image_path,
2406  int flag);
2407 
2408 /**
2409  * Copy a data file from the local filesystem into the emerging ISO image.
2410  * Mark it by an GPT partition entry as EFI System partition, and also cause
2411  * protective GPT partition entries before and after the partition.
2412  * GPT = Globally Unique Identifier Partition Table
2413  *
2414  * This feature may collide with data submitted by
2415  * iso_write_opts_set_system_area()
2416  * and with settings made by
2417  * el_torito_set_isolinux_options()
2418  * It is compatible with HFS+/FAT production by storing the EFI partition
2419  * before the start of the HFS+/FAT partition.
2420  * The GPT overwrites byte 0x0200 to 0x03ff of the system area and all
2421  * further bytes above 0x0800 which are not used by an Apple Partition Map.
2422  *
2423  * @param opts
2424  * The option set to be manipulated.
2425  * @param image_path
2426  * File address in the local file system.
2427  * NULL revokes production of the EFI boot partition.
2428  * @param flag
2429  * Reserved for future usage, set to 0.
2430  * @return
2431  * ISO_SUCCESS or error
2432  *
2433  * @since 1.2.4
2434  */
2435 int iso_write_opts_set_efi_bootp(IsoWriteOpts *opts, char *image_path,
2436  int flag);
2437 
2438 /**
2439  * Cause an arbitrary data file to be appended to the ISO image and to be
2440  * described by a partition table entry in an MBR or SUN Disk Label at the
2441  * start of the ISO image.
2442  * The partition entry will bear the size of the image file rounded up to
2443  * the next multiple of 2048 bytes.
2444  * MBR or SUN Disk Label are selected by iso_write_opts_set_system_area()
2445  * system area type: 0 selects MBR partition table. 3 selects a SUN partition
2446  * table with 320 kB start alignment.
2447  *
2448  * @param opts
2449  * The option set to be manipulated.
2450  * @param partition_number
2451  * Depicts the partition table entry which shall describe the
2452  * appended image.
2453  * Range with MBR: 1 to 4. 1 will cause the whole ISO image to be
2454  * unclaimable space before partition 1.
2455  * Range with SUN Disk Label: 2 to 8.
2456  * @param image_path
2457  * File address in the local file system.
2458  * With SUN Disk Label: an empty name causes the partition to become
2459  * a copy of the next lower partition.
2460  * @param image_type
2461  * The MBR partition type. E.g. FAT12 = 0x01 , FAT16 = 0x06,
2462  * Linux Native Partition = 0x83. See fdisk command L.
2463  * This parameter is ignored with SUN Disk Label.
2464  * @param flag
2465  * Reserved for future usage, set to 0.
2466  * @return
2467  * ISO_SUCCESS or error
2468  *
2469  * @since 0.6.38
2470  */
2471 int iso_write_opts_set_partition_img(IsoWriteOpts *opts, int partition_number,
2472  uint8_t partition_type, char *image_path, int flag);
2473 
2474 
2475 /**
2476  * Inquire the start address of the file data blocks after having used
2477  * IsoWriteOpts with iso_image_create_burn_source().
2478  * @param opts
2479  * The option set that was used when starting image creation
2480  * @param data_start
2481  * Returns the logical block address if it is already valid
2482  * @param flag
2483  * Reserved for future usage, set to 0.
2484  * @return
2485  * 1 indicates valid data_start, <0 indicates invalid data_start
2486  *
2487  * @since 0.6.16
2488  */
2489 int iso_write_opts_get_data_start(IsoWriteOpts *opts, uint32_t *data_start,
2490  int flag);
2491 
2492 /**
2493  * Update the sizes of all files added to image.
2494  *
2495  * This may be called just before iso_image_create_burn_source() to force
2496  * libisofs to check the file sizes again (they're already checked when added
2497  * to IsoImage). It is useful if you have changed some files after adding then
2498  * to the image.
2499  *
2500  * @return
2501  * 1 on success, < 0 on error
2502  * @since 0.6.8
2503  */
2504 int iso_image_update_sizes(IsoImage *image);
2505 
2506 /**
2507  * Create a burn_source and a thread which immediately begins to generate
2508  * the image. That burn_source can be used with libburn as a data source
2509  * for a track. A copy of its public declaration in libburn.h can be found
2510  * further below in this text.
2511  *
2512  * If image generation shall be aborted by the application program, then
2513  * the .cancel() method of the burn_source must be called to end the
2514  * generation thread: burn_src->cancel(burn_src);
2515  *
2516  * @param image
2517  * The image to write.
2518  * @param opts
2519  * The options for image generation. All needed data will be copied, so
2520  * you can free the given struct once this function returns.
2521  * @param burn_src
2522  * Location where the pointer to the burn_source will be stored
2523  * @return
2524  * 1 on success, < 0 on error
2525  *
2526  * @since 0.6.2
2527  */
2529  struct burn_source **burn_src);
2530 
2531 /**
2532  * Inquire whether the image generator thread is still at work. As soon as the
2533  * reply is 0, the caller of iso_image_create_burn_source() may assume that
2534  * the image generation has ended.
2535  * Nevertheless there may still be readily formatted output data pending in
2536  * the burn_source or its consumers. So the final delivery of the image has
2537  * also to be checked at the data consumer side,e.g. by burn_drive_get_status()
2538  * in case of libburn as consumer.
2539  * @param image
2540  * The image to inquire.
2541  * @return
2542  * 1 generating of image stream is still in progress
2543  * 0 generating of image stream has ended meanwhile
2544  *
2545  * @since 0.6.38
2546  */
2548 
2549 /**
2550  * Creates an IsoReadOpts for reading an existent image. You should set the
2551  * options desired with the correspondent setters. Note that you may want to
2552  * set the start block value.
2553  *
2554  * Options by default are determined by the selected profile.
2555  *
2556  * @param opts
2557  * Pointer to the location where the newly created IsoReadOpts will be
2558  * stored. You should free it with iso_read_opts_free() when no more
2559  * needed.
2560  * @param profile
2561  * Default profile for image reading. For now the following values are
2562  * defined:
2563  * ---> 0 [STANDARD]
2564  * Suitable for most situations. Most extension are read. When both
2565  * Joliet and RR extension are present, RR is used.
2566  * AAIP for ACL and xattr is not enabled by default.
2567  * @return
2568  * 1 success, < 0 error
2569  *
2570  * @since 0.6.2
2571  */
2572 int iso_read_opts_new(IsoReadOpts **opts, int profile);
2573 
2574 /**
2575  * Free an IsoReadOpts previously allocated with iso_read_opts_new().
2576  *
2577  * @since 0.6.2
2578  */
2579 void iso_read_opts_free(IsoReadOpts *opts);
2580 
2581 /**
2582  * Set the block where the image begins. It is usually 0, but may be different
2583  * on a multisession disc.
2584  *
2585  * @since 0.6.2
2586  */
2587 int iso_read_opts_set_start_block(IsoReadOpts *opts, uint32_t block);
2588 
2589 /**
2590  * Do not read Rock Ridge extensions.
2591  * In most cases you don't want to use this. It could be useful if RR info
2592  * is damaged, or if you want to use the Joliet tree.
2593  *
2594  * @since 0.6.2
2595  */
2596 int iso_read_opts_set_no_rockridge(IsoReadOpts *opts, int norr);
2597 
2598 /**
2599  * Do not read Joliet extensions.
2600  *
2601  * @since 0.6.2
2602  */
2603 int iso_read_opts_set_no_joliet(IsoReadOpts *opts, int nojoliet);
2604 
2605 /**
2606  * Do not read ISO 9660:1999 enhanced tree
2607  *
2608  * @since 0.6.2
2609  */
2610 int iso_read_opts_set_no_iso1999(IsoReadOpts *opts, int noiso1999);
2611 
2612 /**
2613  * Control reading of AAIP informations about ACL and xattr when loading
2614  * existing images.
2615  * For importing ACL and xattr when inserting nodes from external filesystems
2616  * (e.g. the local POSIX filesystem) see iso_image_set_ignore_aclea().
2617  * For eventual writing of this information see iso_write_opts_set_aaip().
2618  *
2619  * @param opts
2620  * The option set to be manipulated
2621  * @param noaaip
2622  * 1 = Do not read AAIP information
2623  * 0 = Read AAIP information if available
2624  * All other values are reserved.
2625  * @since 0.6.14
2626  */
2627 int iso_read_opts_set_no_aaip(IsoReadOpts *opts, int noaaip);
2628 
2629 /**
2630  * Control reading of an array of MD5 checksums which is eventually stored
2631  * at the end of a session. See also iso_write_opts_set_record_md5().
2632  * Important: Loading of the MD5 array will only work if AAIP is enabled
2633  * because its position and layout is recorded in xattr "isofs.ca".
2634  *
2635  * @param opts
2636  * The option set to be manipulated
2637  * @param no_md5
2638  * 0 = Read MD5 array if available, refuse on non-matching MD5 tags
2639  * 1 = Do not read MD5 checksum array
2640  * 2 = Read MD5 array, but do not check MD5 tags
2641  * @since 1.0.4
2642  * All other values are reserved.
2643  *
2644  * @since 0.6.22
2645  */
2646 int iso_read_opts_set_no_md5(IsoReadOpts *opts, int no_md5);
2647 
2648 
2649 /**
2650  * Control discarding of eventual inode numbers from existing images.
2651  * Such numbers may come from RRIP 1.12 entries PX. If not discarded they
2652  * get written unchanged when the file object gets written into an ISO image.
2653  * If this inode number is missing with a file in the imported image,
2654  * or if it has been discarded during image reading, then a unique inode number
2655  * will be generated at some time before the file gets written into an ISO
2656  * image.
2657  * Two image nodes which have the same inode number represent two hardlinks
2658  * of the same file object. So discarding the numbers splits hardlinks.
2659  *
2660  * @param opts
2661  * The option set to be manipulated
2662  * @param new_inos
2663  * 1 = Discard imported inode numbers and finally hand out a unique new
2664  * one to each single file before it gets written into an ISO image.
2665  * 0 = Keep eventual inode numbers from PX entries.
2666  * All other values are reserved.
2667  * @since 0.6.20
2668  */
2669 int iso_read_opts_set_new_inos(IsoReadOpts *opts, int new_inos);
2670 
2671 /**
2672  * Whether to prefer Joliet over RR. libisofs usually prefers RR over
2673  * Joliet, as it give us much more info about files. So, if both extensions
2674  * are present, RR is used. You can set this if you prefer Joliet, but
2675  * note that this is not very recommended. This doesn't mean than RR
2676  * extensions are not read: if no Joliet is present, libisofs will read
2677  * RR tree.
2678  *
2679  * @since 0.6.2
2680  */
2681 int iso_read_opts_set_preferjoliet(IsoReadOpts *opts, int preferjoliet);
2682 
2683 /**
2684  * Set default uid for files when RR extensions are not present.
2685  *
2686  * @since 0.6.2
2687  */
2688 int iso_read_opts_set_default_uid(IsoReadOpts *opts, uid_t uid);
2689 
2690 /**
2691  * Set default gid for files when RR extensions are not present.
2692  *
2693  * @since 0.6.2
2694  */
2695 int iso_read_opts_set_default_gid(IsoReadOpts *opts, gid_t gid);
2696 
2697 /**
2698  * Set default permissions for files when RR extensions are not present.
2699  *
2700  * @param opts
2701  * The option set to be manipulated
2702  * @param file_perm
2703  * Permissions for files.
2704  * @param dir_perm
2705  * Permissions for directories.
2706  *
2707  * @since 0.6.2
2708  */
2709 int iso_read_opts_set_default_permissions(IsoReadOpts *opts, mode_t file_perm,
2710  mode_t dir_perm);
2711 
2712 /**
2713  * Set the input charset of the file names on the image. NULL to use locale
2714  * charset. You have to specify a charset if the image filenames are encoded
2715  * in a charset different that the local one. This could happen, for example,
2716  * if the image was created on a system with different charset.
2717  *
2718  * @param opts
2719  * The option set to be manipulated
2720  * @param charset
2721  * The charset to use as input charset. You can obtain the list of
2722  * charsets supported on your system executing "iconv -l" in a shell.
2723  *
2724  * @since 0.6.2
2725  */
2726 int iso_read_opts_set_input_charset(IsoReadOpts *opts, const char *charset);
2727 
2728 /**
2729  * Enable or disable methods to automatically choose an input charset.
2730  * This eventually overrides the name set via iso_read_opts_set_input_charset()
2731  *
2732  * @param opts
2733  * The option set to be manipulated
2734  * @param mode
2735  * Bitfield for control purposes:
2736  * bit0= Allow to use the input character set name which is eventually
2737  * stored in attribute "isofs.cs" of the root directory.
2738  * Applications may attach this xattr by iso_node_set_attrs() to
2739  * the root node, call iso_write_opts_set_output_charset() with the
2740  * same name and enable iso_write_opts_set_aaip() when writing
2741  * an image.
2742  * Submit any other bits with value 0.
2743  *
2744  * @since 0.6.18
2745  *
2746  */
2747 int iso_read_opts_auto_input_charset(IsoReadOpts *opts, int mode);
2748 
2749 /**
2750  * Enable or disable loading of the first 32768 bytes of the session.
2751  *
2752  * @param opts
2753  * The option set to be manipulated
2754  * @param mode
2755  * Bitfield for control purposes:
2756  * bit0= Load System Area data and attach them to the image so that they
2757  * get written by the next session, if not overridden by
2758  * iso_write_opts_set_system_area().
2759  * Submit any other bits with value 0.
2760  *
2761  * @since 0.6.30
2762  *
2763  */
2764 int iso_read_opts_load_system_area(IsoReadOpts *opts, int mode);
2765 
2766 /**
2767  * Import a previous session or image, for growing or modify.
2768  *
2769  * @param image
2770  * The image context to which old image will be imported. Note that all
2771  * files added to image, and image attributes, will be replaced with the
2772  * contents of the old image.
2773  * TODO #00025 support for merging old image files
2774  * @param src
2775  * Data Source from which old image will be read. A extra reference is
2776  * added, so you still need to iso_data_source_unref() yours.
2777  * @param opts
2778  * Options for image import. All needed data will be copied, so you
2779  * can free the given struct once this function returns.
2780  * @param features
2781  * If not NULL, a new IsoReadImageFeatures will be allocated and filled
2782  * with the features of the old image. It should be freed with
2783  * iso_read_image_features_destroy() when no more needed. You can pass
2784  * NULL if you're not interested on them.
2785  * @return
2786  * 1 on success, < 0 on error
2787  *
2788  * @since 0.6.2
2789  */
2790 int iso_image_import(IsoImage *image, IsoDataSource *src, IsoReadOpts *opts,
2791  IsoReadImageFeatures **features);
2792 
2793 /**
2794  * Destroy an IsoReadImageFeatures object obtained with iso_image_import.
2795  *
2796  * @since 0.6.2
2797  */
2799 
2800 /**
2801  * Get the size (in 2048 byte block) of the image, as reported in the PVM.
2802  *
2803  * @since 0.6.2
2804  */
2806 
2807 /**
2808  * Whether RockRidge extensions are present in the image imported.
2809  *
2810  * @since 0.6.2
2811  */
2813 
2814 /**
2815  * Whether Joliet extensions are present in the image imported.
2816  *
2817  * @since 0.6.2
2818  */
2820 
2821 /**
2822  * Whether the image is recorded according to ISO 9660:1999, i.e. it has
2823  * a version 2 Enhanced Volume Descriptor.
2824  *
2825  * @since 0.6.2
2826  */
2828 
2829 /**
2830  * Whether El-Torito boot record is present present in the image imported.
2831  *
2832  * @since 0.6.2
2833  */
2835 
2836 /**
2837  * Increments the reference counting of the given image.
2838  *
2839  * @since 0.6.2
2840  */
2841 void iso_image_ref(IsoImage *image);
2842 
2843 /**
2844  * Decrements the reference couting of the given image.
2845  * If it reaches 0, the image is free, together with its tree nodes (whether
2846  * their refcount reach 0 too, of course).
2847  *
2848  * @since 0.6.2
2849  */
2850 void iso_image_unref(IsoImage *image);
2851 
2852 /**
2853  * Attach user defined data to the image. Use this if your application needs
2854  * to store addition info together with the IsoImage. If the image already
2855  * has data attached, the old data will be freed.
2856  *
2857  * @param image
2858  * The image to which data shall be attached.
2859  * @param data
2860  * Pointer to application defined data that will be attached to the
2861  * image. You can pass NULL to remove any already attached data.
2862  * @param give_up
2863  * Function that will be called when the image does not need the data
2864  * any more. It receives the data pointer as an argumente, and eventually
2865  * causes data to be freed. It can be NULL if you don't need it.
2866  * @return
2867  * 1 on succes, < 0 on error
2868  *
2869  * @since 0.6.2
2870  */
2871 int iso_image_attach_data(IsoImage *image, void *data, void (*give_up)(void*));
2872 
2873 /**
2874  * The the data previously attached with iso_image_attach_data()
2875  *
2876  * @since 0.6.2
2877  */
2879 
2880 /**
2881  * Get the root directory of the image.
2882  * No extra ref is added to it, so you musn't unref it. Use iso_node_ref()
2883  * if you want to get your own reference.
2884  *
2885  * @since 0.6.2
2886  */
2887 IsoDir *iso_image_get_root(const IsoImage *image);
2888 
2889 /**
2890  * Fill in the volset identifier for a image.
2891  *
2892  * @since 0.6.2
2893  */
2894 void iso_image_set_volset_id(IsoImage *image, const char *volset_id);
2895 
2896 /**
2897  * Get the volset identifier.
2898  * The returned string is owned by the image and must not be freed nor
2899  * changed.
2900  *
2901  * @since 0.6.2
2902  */
2903 const char *iso_image_get_volset_id(const IsoImage *image);
2904 
2905 /**
2906  * Fill in the volume identifier for a image.
2907  *
2908  * @since 0.6.2
2909  */
2910 void iso_image_set_volume_id(IsoImage *image, const char *volume_id);
2911 
2912 /**
2913  * Get the volume identifier.
2914  * The returned string is owned by the image and must not be freed nor
2915  * changed.
2916  *
2917  * @since 0.6.2
2918  */
2919 const char *iso_image_get_volume_id(const IsoImage *image);
2920 
2921 /**
2922  * Fill in the publisher for a image.
2923  *
2924  * @since 0.6.2
2925  */
2926 void iso_image_set_publisher_id(IsoImage *image, const char *publisher_id);
2927 
2928 /**
2929  * Get the publisher of a image.
2930  * The returned string is owned by the image and must not be freed nor
2931  * changed.
2932  *
2933  * @since 0.6.2
2934  */
2935 const char *iso_image_get_publisher_id(const IsoImage *image);
2936 
2937 /**
2938  * Fill in the data preparer for a image.
2939  *
2940  * @since 0.6.2
2941  */
2943  const char *data_preparer_id);
2944 
2945 /**
2946  * Get the data preparer of a image.
2947  * The returned string is owned by the image and must not be freed nor
2948  * changed.
2949  *
2950  * @since 0.6.2
2951  */
2952 const char *iso_image_get_data_preparer_id(const IsoImage *image);
2953 
2954 /**
2955  * Fill in the system id for a image. Up to 32 characters.
2956  *
2957  * @since 0.6.2
2958  */
2959 void iso_image_set_system_id(IsoImage *image, const char *system_id);
2960 
2961 /**
2962  * Get the system id of a image.
2963  * The returned string is owned by the image and must not be freed nor
2964  * changed.
2965  *
2966  * @since 0.6.2
2967  */
2968 const char *iso_image_get_system_id(const IsoImage *image);
2969 
2970 /**
2971  * Fill in the application id for a image. Up to 128 chars.
2972  *
2973  * @since 0.6.2
2974  */
2975 void iso_image_set_application_id(IsoImage *image, const char *application_id);
2976 
2977 /**
2978  * Get the application id of a image.
2979  * The returned string is owned by the image and must not be freed nor
2980  * changed.
2981  *
2982  * @since 0.6.2
2983  */
2984 const char *iso_image_get_application_id(const IsoImage *image);
2985 
2986 /**
2987  * Fill copyright information for the image. Usually this refers
2988  * to a file on disc. Up to 37 characters.
2989  *
2990  * @since 0.6.2
2991  */
2993  const char *copyright_file_id);
2994 
2995 /**
2996  * Get the copyright information of a image.
2997  * The returned string is owned by the image and must not be freed nor
2998  * changed.
2999  *
3000  * @since 0.6.2
3001  */
3002 const char *iso_image_get_copyright_file_id(const IsoImage *image);
3003 
3004 /**
3005  * Fill abstract information for the image. Usually this refers
3006  * to a file on disc. Up to 37 characters.
3007  *
3008  * @since 0.6.2
3009  */
3011  const char *abstract_file_id);
3012 
3013 /**
3014  * Get the abstract information of a image.
3015  * The returned string is owned by the image and must not be freed nor
3016  * changed.
3017  *
3018  * @since 0.6.2
3019  */
3020 const char *iso_image_get_abstract_file_id(const IsoImage *image);
3021 
3022 /**
3023  * Fill biblio information for the image. Usually this refers
3024  * to a file on disc. Up to 37 characters.
3025  *
3026  * @since 0.6.2
3027  */
3028 void iso_image_set_biblio_file_id(IsoImage *image, const char *biblio_file_id);
3029 
3030 /**
3031  * Get the biblio information of a image.
3032  * The returned string is owned by the image and must not be freed or changed.
3033  *
3034  * @since 0.6.2
3035  */
3036 const char *iso_image_get_biblio_file_id(const IsoImage *image);
3037 
3038 /**
3039  * Fill Application Use field of the Primary Volume Descriptor.
3040  * ECMA-119 8.4.32 Application Use (BP 884 to 1395)
3041  * "This field shall be reserved for application use. Its content
3042  * is not specified by this Standard."
3043  *
3044  * @param image
3045  * The image to manipulate.
3046  * @param app_use_data
3047  * Up to 512 bytes of data.
3048  * @param count
3049  * The number of bytes in app_use_data. If the number is smaller than 512,
3050  * then the remaining bytes will be set to 0.
3051  * @since 1.3.2
3052  */
3053 void iso_image_set_app_use(IsoImage *image, const char *app_use_data,
3054  int count);
3055 
3056 /**
3057  * Get the current setting for the Application Use field of the Primary Volume
3058  * Descriptor.
3059  * The returned char array of 512 bytes is owned by the image and must not
3060  * be freed or changed.
3061  *
3062  * @param image
3063  * The image to inquire
3064  * @since 1.3.2
3065  */
3066 const char *iso_image_get_app_use(IsoImage *image);
3067 
3068 /**
3069  * Get the four timestamps from the Primary Volume Descriptor of the imported
3070  * ISO image. The timestamps are strings which are either empty or consist
3071  * of 17 digits of the form YYYYMMDDhhmmsscc.
3072  * None of the returned string pointers shall be used for altering or freeing
3073  * data. They are just for reading.
3074  *
3075  * @param image
3076  * The image to be inquired.
3077  * @param vol_creation_time
3078  * Returns a pointer to the Volume Creation time:
3079  * When "the information in the volume was created."
3080  * @param vol_modification_time
3081  * Returns a pointer to Volume Modification time:
3082  * When "the information in the volume was last modified."
3083  * @param vol_expiration_time
3084  * Returns a pointer to Volume Expiration time:
3085  * When "the information in the volume may be regarded as obsolete."
3086  * @param vol_effective_time
3087  * Returns a pointer to Volume Expiration time:
3088  * When "the information in the volume may be used."
3089  * @return
3090  * ISO_SUCCESS or error
3091  *
3092  * @since 1.2.8
3093  */
3095  char **creation_time, char **modification_time,
3096  char **expiration_time, char **effective_time);
3097 
3098 /**
3099  * Create a new set of El-Torito bootable images by adding a boot catalog
3100  * and the default boot image.
3101  * Further boot images may then be added by iso_image_add_boot_image().
3102  *
3103  * @param image
3104  * The image to make bootable. If it was already bootable this function
3105  * returns an error and the image remains unmodified.
3106  * @param image_path
3107  * The absolute path of a IsoFile to be used as default boot image.
3108  * @param type
3109  * The boot media type. This can be one of 3 types:
3110  * - Floppy emulation: Boot image file must be exactly
3111  * 1200 kB, 1440 kB or 2880 kB.
3112  * - Hard disc emulation: The image must begin with a master
3113  * boot record with a single image.
3114  * - No emulation. You should specify load segment and load size
3115  * of image.
3116  * @param catalog_path
3117  * The absolute path in the image tree where the catalog will be stored.
3118  * The directory component of this path must be a directory existent on
3119  * the image tree, and the filename component must be unique among all
3120  * children of that directory on image. Otherwise a correspodent error
3121  * code will be returned. This function will add an IsoBoot node that acts
3122  * as a placeholder for the real catalog, that will be generated at image
3123  * creation time.
3124  * @param boot
3125  * Location where a pointer to the added boot image will be stored. That
3126  * object is owned by the IsoImage and must not be freed by the user,
3127  * nor dereferenced once the last reference to the IsoImage was disposed
3128  * via iso_image_unref(). A NULL value is allowed if you don't need a
3129  * reference to the boot image.
3130  * @return
3131  * 1 on success, < 0 on error
3132  *
3133  * @since 0.6.2
3134  */
3135 int iso_image_set_boot_image(IsoImage *image, const char *image_path,
3136  enum eltorito_boot_media_type type,
3137  const char *catalog_path,
3138  ElToritoBootImage **boot);
3139 
3140 /**
3141  * Add a further boot image to the set of El-Torito bootable images.
3142  * This set has already to be created by iso_image_set_boot_image().
3143  * Up to 31 further boot images may be added.
3144  *
3145  * @param image
3146  * The image to which the boot image shall be added.
3147  * returns an error and the image remains unmodified.
3148  * @param image_path
3149  * The absolute path of a IsoFile to be used as default boot image.
3150  * @param type
3151  * The boot media type. See iso_image_set_boot_image
3152  * @param flag
3153  * Bitfield for control purposes. Unused yet. Submit 0.
3154  * @param boot
3155  * Location where a pointer to the added boot image will be stored.
3156  * See iso_image_set_boot_image
3157  * @return
3158  * 1 on success, < 0 on error
3159  * ISO_BOOT_NO_CATALOG means iso_image_set_boot_image()
3160  * was not called first.
3161  *
3162  * @since 0.6.32
3163  */
3164 int iso_image_add_boot_image(IsoImage *image, const char *image_path,
3165  enum eltorito_boot_media_type type, int flag,
3166  ElToritoBootImage **boot);
3167 
3168 /**
3169  * Get the El-Torito boot catalog and the default boot image of an ISO image.
3170  *
3171  * This can be useful, for example, to check if a volume read from a previous
3172  * session or an existing image is bootable. It can also be useful to get
3173  * the image and catalog tree nodes. An application would want those, for
3174  * example, to prevent the user removing it.
3175  *
3176  * Both nodes are owned by libisofs and must not be freed. You can get your
3177  * own ref with iso_node_ref(). You can also check if the node is already
3178  * on the tree by getting its parent (note that when reading El-Torito info
3179  * from a previous image, the nodes might not be on the tree even if you haven't
3180  * removed them). Remember that you'll need to get a new ref
3181  * (with iso_node_ref()) before inserting them again to the tree, and probably
3182  * you will also need to set the name or permissions.
3183  *
3184  * @param image
3185  * The image from which to get the boot image.
3186  * @param boot
3187  * If not NULL, it will be filled with a pointer to the boot image, if
3188  * any. That object is owned by the IsoImage and must not be freed by
3189  * the user, nor dereferenced once the last reference to the IsoImage was
3190  * disposed via iso_image_unref().
3191  * @param imgnode
3192  * When not NULL, it will be filled with the image tree node. No extra ref
3193  * is added, you can use iso_node_ref() to get one if you need it.
3194  * @param catnode
3195  * When not NULL, it will be filled with the catnode tree node. No extra
3196  * ref is added, you can use iso_node_ref() to get one if you need it.
3197  * @return
3198  * 1 on success, 0 is the image is not bootable (i.e., it has no El-Torito
3199  * image), < 0 error.
3200  *
3201  * @since 0.6.2
3202  */
3204  IsoFile **imgnode, IsoBoot **catnode);
3205 
3206 /**
3207  * Get detailed information about the boot catalog that was loaded from
3208  * an ISO image.
3209  * The boot catalog links the El Torito boot record at LBA 17 with the
3210  * boot images which are IsoFile objects in the image. The boot catalog
3211  * itself is not a regular file and thus will not deliver an IsoStream.
3212  * Its content is usually quite short and can be obtained by this call.
3213  *
3214  * @param image
3215  * The image to inquire.
3216  * @param catnode
3217  * Will return the boot catalog tree node. No extra ref is taken.
3218  * @param lba
3219  * Will return the block address of the boot catalog in the image.
3220  * @param content
3221  * Will return either NULL or an allocated memory buffer with the
3222  * content bytes of the boot catalog.
3223  * Dispose it by free() when no longer needed.
3224  * @param size
3225  * Will return the number of bytes in content.
3226  * @return
3227  * 1 if reply is valid, 0 if not boot catalog was loaded, < 0 on error.
3228  *
3229  * @since 1.1.2
3230  */
3231 int iso_image_get_bootcat(IsoImage *image, IsoBoot **catnode, uint32_t *lba,
3232  char **content, off_t *size);
3233 
3234 
3235 /**
3236  * Get all El-Torito boot images of an ISO image.
3237  *
3238  * The first of these boot images is the same as returned by
3239  * iso_image_get_boot_image(). The others are alternative boot images.
3240  *
3241  * @param image
3242  * The image from which to get the boot images.
3243  * @param num_boots
3244  * The number of available array elements in boots and bootnodes.
3245  * @param boots
3246  * Returns NULL or an allocated array of pointers to boot images.
3247  * Apply system call free(boots) to dispose it.
3248  * @param bootnodes
3249  * Returns NULL or an allocated array of pointers to the IsoFile nodes
3250  * which bear the content of the boot images in boots.
3251  * @param flag
3252  * Bitfield for control purposes. Unused yet. Submit 0.
3253  * @return
3254  * 1 on success, 0 no El-Torito catalog and boot image attached,
3255  * < 0 error.
3256  *
3257  * @since 0.6.32
3258  */
3259 int iso_image_get_all_boot_imgs(IsoImage *image, int *num_boots,
3260  ElToritoBootImage ***boots, IsoFile ***bootnodes, int flag);
3261 
3262 
3263 /**
3264  * Removes all El-Torito boot images from the ISO image.
3265  *
3266  * The IsoBoot node that acts as placeholder for the catalog is also removed
3267  * for the image tree, if there.
3268  * If the image is not bootable (don't have el-torito boot image) this function
3269  * just returns.
3270  *
3271  * @since 0.6.2
3272  */
3274 
3275 /**
3276  * Sets the sort weight of the boot catalog that is attached to an IsoImage.
3277  *
3278  * For the meaning of sort weights see iso_node_set_sort_weight().
3279  * That function cannot be applied to the emerging boot catalog because
3280  * it is not represented by an IsoFile.
3281  *
3282  * @param image
3283  * The image to manipulate.
3284  * @param sort_weight
3285  * The larger this value, the lower will be the block address of the
3286  * boot catalog record.
3287  * @return
3288  * 0= no boot catalog attached , 1= ok , <0 = error
3289  *
3290  * @since 0.6.32
3291  */
3292 int iso_image_set_boot_catalog_weight(IsoImage *image, int sort_weight);
3293 
3294 /**
3295  * Hides the boot catalog file from directory trees.
3296  *
3297  * For the meaning of hiding files see iso_node_set_hidden().
3298  *
3299  *
3300  * @param image
3301  * The image to manipulate.
3302  * @param hide_attrs
3303  * Or-combination of values from enum IsoHideNodeFlag to set the trees
3304  * in which the record.
3305  * @return
3306  * 0= no boot catalog attached , 1= ok , <0 = error
3307  *
3308  * @since 0.6.34
3309  */
3310 int iso_image_set_boot_catalog_hidden(IsoImage *image, int hide_attrs);
3311 
3312 
3313 /**
3314  * Get the boot media type as of parameter "type" of iso_image_set_boot_image()
3315  * resp. iso_image_add_boot_image().
3316  *
3317  * @param bootimg
3318  * The image to inquire
3319  * @param media_type
3320  * Returns the media type
3321  * @return
3322  * 1 = ok , < 0 = error
3323  *
3324  * @since 0.6.32
3325  */
3327  enum eltorito_boot_media_type *media_type);
3328 
3329 /**
3330  * Sets the platform ID of the boot image.
3331  *
3332  * The Platform ID gets written into the boot catalog at byte 1 of the
3333  * Validation Entry, or at byte 1 of a Section Header Entry.
3334  * If Platform ID and ID String of two consequtive bootimages are the same
3335  *
3336  * @param bootimg
3337  * The image to manipulate.
3338  * @param id
3339  * A Platform ID as of
3340  * El Torito 1.0 : 0x00= 80x86, 0x01= PowerPC, 0x02= Mac
3341  * Others : 0xef= EFI
3342  * @return
3343  * 1 ok , <=0 error
3344  *
3345  * @since 0.6.32
3346  */
3347 int el_torito_set_boot_platform_id(ElToritoBootImage *bootimg, uint8_t id);
3348 
3349 /**
3350  * Get the platform ID value. See el_torito_set_boot_platform_id().
3351  *
3352  * @param bootimg
3353  * The image to inquire
3354  * @return
3355  * 0 - 255 : The platform ID
3356  * < 0 : error
3357  *
3358  * @since 0.6.32
3359  */
3361 
3362 /**
3363  * Sets the load segment for the initial boot image. This is only for
3364  * no emulation boot images, and is a NOP for other image types.
3365  *
3366  * @since 0.6.2
3367  */
3368 void el_torito_set_load_seg(ElToritoBootImage *bootimg, short segment);
3369 
3370 /**
3371  * Get the load segment value. See el_torito_set_load_seg().
3372  *
3373  * @param bootimg
3374  * The image to inquire
3375  * @return
3376  * 0 - 65535 : The load segment value
3377  * < 0 : error
3378  *
3379  * @since 0.6.32
3380  */
3382 
3383 /**
3384  * Sets the number of sectors (512b) to be load at load segment during
3385  * the initial boot procedure. This is only for
3386  * no emulation boot images, and is a NOP for other image types.
3387  *
3388  * @since 0.6.2
3389  */
3390 void el_torito_set_load_size(ElToritoBootImage *bootimg, short sectors);
3391 
3392 /**
3393  * Get the load size. See el_torito_set_load_size().
3394  *
3395  * @param bootimg
3396  * The image to inquire
3397  * @return
3398  * 0 - 65535 : The load size value
3399  * < 0 : error
3400  *
3401  * @since 0.6.32
3402  */
3404 
3405 /**
3406  * Marks the specified boot image as not bootable
3407  *
3408  * @since 0.6.2
3409  */
3411 
3412 /**
3413  * Get the bootability flag. See el_torito_set_no_bootable().
3414  *
3415  * @param bootimg
3416  * The image to inquire
3417  * @return
3418  * 0 = not bootable, 1 = bootable , <0 = error
3419  *
3420  * @since 0.6.32
3421  */
3423 
3424 /**
3425  * Set the id_string of the Validation Entry resp. Sector Header Entry which
3426  * will govern the boot image Section Entry in the El Torito Catalog.
3427  *
3428  * @param bootimg
3429  * The image to manipulate.
3430  * @param id_string
3431  * The first boot image puts 24 bytes of ID string into the Validation
3432  * Entry, where they shall "identify the manufacturer/developer of
3433  * the CD-ROM".
3434  * Further boot images put 28 bytes into their Section Header.
3435  * El Torito 1.0 states that "If the BIOS understands the ID string, it
3436  * may choose to boot the system using one of these entries in place
3437  * of the INITIAL/DEFAULT entry." (The INITIAL/DEFAULT entry points to the
3438  * first boot image.)
3439  * @return
3440  * 1 = ok , <0 = error
3441  *
3442  * @since 0.6.32
3443  */
3444 int el_torito_set_id_string(ElToritoBootImage *bootimg, uint8_t id_string[28]);
3445 
3446 /**
3447  * Get the id_string as of el_torito_set_id_string().
3448  *
3449  * @param bootimg
3450  * The image to inquire
3451  * @param id_string
3452  * Returns 28 bytes of id string
3453  * @return
3454  * 1 = ok , <0 = error
3455  *
3456  * @since 0.6.32
3457  */
3458 int el_torito_get_id_string(ElToritoBootImage *bootimg, uint8_t id_string[28]);
3459 
3460 /**
3461  * Set the Selection Criteria of a boot image.
3462  *
3463  * @param bootimg
3464  * The image to manipulate.
3465  * @param crit
3466  * The first boot image has no selection criteria. They will be ignored.
3467  * Further boot images put 1 byte of Selection Criteria Type and 19
3468  * bytes of data into their Section Entry.
3469  * El Torito 1.0 states that "The format of the selection criteria is
3470  * a function of the BIOS vendor. In the case of a foreign language
3471  * BIOS three bytes would be used to identify the language".
3472  * Type byte == 0 means "no criteria",
3473  * type byte == 1 means "Language and Version Information (IBM)".
3474  * @return
3475  * 1 = ok , <0 = error
3476  *
3477  * @since 0.6.32
3478  */
3479 int el_torito_set_selection_crit(ElToritoBootImage *bootimg, uint8_t crit[20]);
3480 
3481 /**
3482  * Get the Selection Criteria bytes as of el_torito_set_selection_crit().
3483  *
3484  * @param bootimg
3485  * The image to inquire
3486  * @param id_string
3487  * Returns 20 bytes of type and data
3488  * @return
3489  * 1 = ok , <0 = error
3490  *
3491  * @since 0.6.32
3492  */
3493 int el_torito_get_selection_crit(ElToritoBootImage *bootimg, uint8_t crit[20]);
3494 
3495 
3496 /**
3497  * Makes a guess whether the boot image was patched by a boot information
3498  * table. It is advisable to patch such boot images if their content gets
3499  * copied to a new location. See el_torito_set_isolinux_options().
3500  * Note: The reply can be positive only if the boot image was imported
3501  * from an existing ISO image.
3502  *
3503  * @param bootimg
3504  * The image to inquire
3505  * @param flag
3506  * Bitfield for control purposes:
3507  * bit0 - bit3= mode
3508  * 0 = inquire for classic boot info table as described in man mkisofs
3509  * @since 0.6.32
3510  * 1 = inquire for GRUB2 boot info as of bit9 of options of
3511  * el_torito_set_isolinux_options()
3512  * @since 1.3.0
3513  * @return
3514  * 1 = seems to contain the inquired boot info, 0 = quite surely not
3515  * @since 0.6.32
3516  */
3517 int el_torito_seems_boot_info_table(ElToritoBootImage *bootimg, int flag);
3518 
3519 /**
3520  * Specifies options for ISOLINUX or GRUB boot images. This should only be used
3521  * if the type of boot image is known.
3522  *
3523  * @param bootimg
3524  * The image to set options on
3525  * @param options
3526  * bitmask style flag. The following values are defined:
3527  *
3528  * bit0= Patch the boot info table of the boot image.
3529  * This does the same as mkisofs option -boot-info-table.
3530  * Needed for ISOLINUX or GRUB boot images with platform ID 0.
3531  * The table is located at byte 8 of the boot image file.
3532  * Its size is 56 bytes.
3533  * The original boot image file on disk will not be modified.
3534  *
3535  * One may use el_torito_seems_boot_info_table() for a
3536  * qualified guess whether a boot info table is present in
3537  * the boot image. If the result is 1 then it should get bit0
3538  * set if its content gets copied to a new LBA.
3539  *
3540  * bit1= Generate a ISOLINUX isohybrid image with MBR.
3541  * ----------------------------------------------------------
3542  * @deprecated since 31 Mar 2010:
3543  * The author of syslinux, H. Peter Anvin requested that this
3544  * feature shall not be used any more. He intends to cease
3545  * support for the MBR template that is included in libisofs.
3546  * ----------------------------------------------------------
3547  * A hybrid image is a boot image that boots from either
3548  * CD/DVD media or from disk-like media, e.g. USB stick.
3549  * For that you need isolinux.bin from SYSLINUX 3.72 or later.
3550  * IMPORTANT: The application has to take care that the image
3551  * on media gets padded up to the next full MB.
3552  * Under seiveral circumstances it might get aligned
3553  * automatically. But there is no warranty.
3554  * bit2-7= Mentioning in isohybrid GPT
3555  * 0= Do not mention in GPT
3556  * 1= Mention as Basic Data partition.
3557  * This cannot be combined with GPT partitions as of
3558  * iso_write_opts_set_efi_bootp()
3559  * @since 1.2.4
3560  * 2= Mention as HFS+ partition.
3561  * This cannot be combined with HFS+ production by
3562  * iso_write_opts_set_hfsplus().
3563  * @since 1.2.4
3564  * Primary GPT and backup GPT get written if at least one
3565  * ElToritoBootImage shall be mentioned.
3566  * The first three mentioned GPT partitions get mirrored in the
3567  * the partition table of the isohybrid MBR. They get type 0xfe.
3568  * The MBR partition entry for PC-BIOS gets type 0x00 rather
3569  * than 0x17.
3570  * Often it is one of the further MBR partitions which actually
3571  * gets used by EFI.
3572  * @since 1.2.4
3573  * bit8= Mention in isohybrid Apple partition map
3574  * APM get written if at least one ElToritoBootImage shall be
3575  * mentioned. The ISOLINUX MBR must look suitable or else an error
3576  * event will happen at image generation time.
3577  * @since 1.2.4
3578  * bit9= GRUB2 boot info
3579  * Patch the boot image file at byte 1012 with the 512-block
3580  * address + 2. Two little endian 32-bit words. Low word first.
3581  * This is combinable with bit0.
3582  * @since 1.3.0
3583  * @param flag
3584  * Reserved for future usage, set to 0.
3585  * @return
3586  * 1 success, < 0 on error
3587  * @since 0.6.12
3588  */
3590  int options, int flag);
3591 
3592 /**
3593  * Get the options as of el_torito_set_isolinux_options().
3594  *
3595  * @param bootimg
3596  * The image to inquire
3597  * @param flag
3598  * Reserved for future usage, set to 0.
3599  * @return
3600  * >= 0 returned option bits , <0 = error
3601  *
3602  * @since 0.6.32
3603  */
3604 int el_torito_get_isolinux_options(ElToritoBootImage *bootimg, int flag);
3605 
3606 /** Deprecated:
3607  * Specifies that this image needs to be patched. This involves the writing
3608  * of a 16 bytes boot information table at offset 8 of the boot image file.
3609  * The original boot image file won't be modified.
3610  * This is needed for isolinux boot images.
3611  *
3612  * @since 0.6.2
3613  * @deprecated Use el_torito_set_isolinux_options() instead
3614  */
3616 
3617 /**
3618  * Obtain a copy of the eventually loaded first 32768 bytes of the imported
3619  * session, the System Area.
3620  * It will be written to the start of the next session unless it gets
3621  * overwritten by iso_write_opts_set_system_area().
3622  *
3623  * @param img
3624  * The image to be inquired.
3625  * @param data
3626  * A byte array of at least 32768 bytes to take the loaded bytes.
3627  * @param options
3628  * The option bits which will be applied if not overridden by
3629  * iso_write_opts_set_system_area(). See there.
3630  * @param flag
3631  * Bitfield for control purposes, unused yet, submit 0
3632  * @return
3633  * 1 on success, 0 if no System Area was loaded, < 0 error.
3634  * @since 0.6.30
3635  */
3636 int iso_image_get_system_area(IsoImage *img, char data[32768],
3637  int *options, int flag);
3638 
3639 /**
3640  * Add a MIPS boot file path to the image.
3641  * Up to 15 such files can be written into a MIPS Big Endian Volume Header
3642  * if this is enabled by value 1 in iso_write_opts_set_system_area() option
3643  * bits 2 to 7.
3644  * A single file can be written into a DEC Boot Block if this is enabled by
3645  * value 2 in iso_write_opts_set_system_area() option bits 2 to 7. So only
3646  * the first added file gets into effect with this system area type.
3647  * The data files which shall serve as MIPS boot files have to be brought into
3648  * the image by the normal means.
3649  * @param img
3650  * The image to be manipulated.
3651  * @param path
3652  * Absolute path of the boot file in the ISO 9660 Rock Ridge tree.
3653  * @param flag
3654  * Bitfield for control purposes, unused yet, submit 0
3655  * @return
3656  * 1 on success, < 0 error
3657  * @since 0.6.38
3658  */
3659 int iso_image_add_mips_boot_file(IsoImage *image, char *path, int flag);
3660 
3661 /**
3662  * Obtain the number of added MIPS Big Endian boot files and pointers to
3663  * their paths in the ISO 9660 Rock Ridge tree.
3664  * @param img
3665  * The image to be inquired.
3666  * @param paths
3667  * An array of pointers to be set to the registered boot file paths.
3668  * This are just pointers to data inside IsoImage. Do not free() them.
3669  * Eventually make own copies of the data before manipulating the image.
3670  * @param flag
3671  * Bitfield for control purposes, unused yet, submit 0
3672  * @return
3673  * >= 0 is the number of valid path pointers , <0 means error
3674  * @since 0.6.38
3675  */
3676 int iso_image_get_mips_boot_files(IsoImage *image, char *paths[15], int flag);
3677 
3678 /**
3679  * Clear the list of MIPS Big Endian boot file paths.
3680  * @param img
3681  * The image to be manipulated.
3682  * @param flag
3683  * Bitfield for control purposes, unused yet, submit 0
3684  * @return
3685  * 1 is success , <0 means error
3686  * @since 0.6.38
3687  */
3688 int iso_image_give_up_mips_boot(IsoImage *image, int flag);
3689 
3690 /**
3691  * Designate a data file in the ISO image of which the position and size
3692  * shall be written after the SUN Disk Label. The position is written as
3693  * 64-bit big-endian number to byte position 0x228. The size is written
3694  * as 32-bit big-endian to 0x230.
3695  * This setting has an effect only if system area type is set to 3
3696  * with iso_write_opts_set_system_area().
3697  *
3698  * @param img
3699  * The image to be manipulated.
3700  * @param sparc_core
3701  * The IsoFile which shall be mentioned after the SUN Disk label.
3702  * NULL is a permissible value. It disables this feature.
3703  * @param flag
3704  * Bitfield for control purposes, unused yet, submit 0
3705  * @return
3706  * 1 is success , <0 means error
3707  * @since 1.3.0
3708  */
3709 int iso_image_set_sparc_core(IsoImage *img, IsoFile *sparc_core, int flag);
3710 
3711 /**
3712  * Obtain the current setting of iso_image_set_sparc_core().
3713  *
3714  * @param img
3715  * The image to be inquired.
3716  * @param sparc_core
3717  * Will return a pointer to the IsoFile (or NULL, which is not an error)
3718  * @param flag
3719  * Bitfield for control purposes, unused yet, submit 0
3720  * @return
3721  * 1 is success , <0 means error
3722  * @since 1.3.0
3723  */
3724 int iso_image_get_sparc_core(IsoImage *img, IsoFile **sparc_core, int flag);
3725 
3726 /**
3727  * Increments the reference counting of the given node.
3728  *
3729  * @since 0.6.2
3730  */
3731 void iso_node_ref(IsoNode *node);
3732 
3733 /**
3734  * Decrements the reference couting of the given node.
3735  * If it reach 0, the node is free, and, if the node is a directory,
3736  * its children will be unref() too.
3737  *
3738  * @since 0.6.2
3739  */
3740 void iso_node_unref(IsoNode *node);
3741 
3742 /**
3743  * Get the type of an IsoNode.
3744  *
3745  * @since 0.6.2
3746  */
3748 
3749 /**
3750  * Class of functions to handle particular extended information. A function
3751  * instance acts as an identifier for the type of the information. Structs
3752  * with same information type must use a pointer to the same function.
3753  *
3754  * @param data
3755  * Attached data
3756  * @param flag
3757  * What to do with the data. At this time the following values are
3758  * defined:
3759  * -> 1 the data must be freed
3760  * @return
3761  * 1 in any case.
3762  *
3763  * @since 0.6.4
3764  */
3765 typedef int (*iso_node_xinfo_func)(void *data, int flag);
3766 
3767 /**
3768  * Add extended information to the given node. Extended info allows
3769  * applications (and libisofs itself) to add more information to an IsoNode.
3770  * You can use this facilities to associate temporary information with a given
3771  * node. This information is not written into the ISO 9660 image on media
3772  * and thus does not persist longer than the node memory object.
3773  *
3774  * Each node keeps a list of added extended info, meaning you can add several
3775  * extended info data to each node. Each extended info you add is identified
3776  * by the proc parameter, a pointer to a function that knows how to manage
3777  * the external info data. Thus, in order to add several types of extended
3778  * info, you need to define a "proc" function for each type.
3779  *
3780  * @param node
3781  * The node where to add the extended info
3782  * @param proc
3783  * A function pointer used to identify the type of the data, and that
3784  * knows how to manage it
3785  * @param data
3786  * Extended info to add.
3787  * @return
3788  * 1 if success, 0 if the given node already has extended info of the
3789  * type defined by the "proc" function, < 0 on error
3790  *
3791  * @since 0.6.4
3792  */
3793 int iso_node_add_xinfo(IsoNode *node, iso_node_xinfo_func proc, void *data);
3794 
3795 /**
3796  * Remove the given extended info (defined by the proc function) from the
3797  * given node.
3798  *
3799  * @return
3800  * 1 on success, 0 if node does not have extended info of the requested
3801  * type, < 0 on error
3802  *
3803  * @since 0.6.4
3804  */
3806 
3807 /**
3808  * Remove all extended information from the given node.
3809  *
3810  * @param node
3811  * The node where to remove all extended info
3812  * @param flag
3813  * Bitfield for control purposes, unused yet, submit 0
3814  * @return
3815  * 1 on success, < 0 on error
3816  *
3817  * @since 1.0.2
3818  */
3819 int iso_node_remove_all_xinfo(IsoNode *node, int flag);
3820 
3821 /**
3822  * Get the given extended info (defined by the proc function) from the
3823  * given node.
3824  *
3825  * @param node
3826  * The node to inquire
3827  * @param proc
3828  * The function pointer which serves as key
3829  * @param data
3830  * Will after successful call point to the xinfo data corresponding
3831  * to the given proc. This is a pointer, not a feeable data copy.
3832  * @return
3833  * 1 on success, 0 if node does not have extended info of the requested
3834  * type, < 0 on error
3835  *
3836  * @since 0.6.4
3837  */
3838 int iso_node_get_xinfo(IsoNode *node, iso_node_xinfo_func proc, void **data);
3839 
3840 
3841 /**
3842  * Get the next pair of function pointer and data of an iteration of the
3843  * list of extended informations. Like:
3844  * iso_node_xinfo_func proc;
3845  * void *handle = NULL, *data;
3846  * while (iso_node_get_next_xinfo(node, &handle, &proc, &data) == 1) {
3847  * ... make use of proc and data ...
3848  * }
3849  * The iteration allocates no memory. So you may end it without any disposal
3850  * action.
3851  * IMPORTANT: Do not continue iterations after manipulating the extended
3852  * information of a node. Memory corruption hazard !
3853  * @param node
3854  * The node to inquire
3855  * @param handle
3856  * The opaque iteration handle. Initialize iteration by submitting
3857  * a pointer to a void pointer with value NULL.
3858  * Do not alter its content until iteration has ended.
3859  * @param proc
3860  * The function pointer which serves as key
3861  * @param data
3862  * Will be filled with the extended info corresponding to the given proc
3863  * function
3864  * @return
3865  * 1 on success
3866  * 0 if iteration has ended (proc and data are invalid then)
3867  * < 0 on error
3868  *
3869  * @since 1.0.2
3870  */
3871 int iso_node_get_next_xinfo(IsoNode *node, void **handle,
3872  iso_node_xinfo_func *proc, void **data);
3873 
3874 
3875 /**
3876  * Class of functions to clone extended information. A function instance gets
3877  * associated to a particular iso_node_xinfo_func instance by function
3878  * iso_node_xinfo_make_clonable(). This is a precondition to have IsoNode
3879  * objects clonable which carry data for a particular iso_node_xinfo_func.
3880  *
3881  * @param old_data
3882  * Data item to be cloned
3883  * @param new_data
3884  * Shall return the cloned data item
3885  * @param flag
3886  * Unused yet, submit 0
3887  * The function shall return ISO_XINFO_NO_CLONE on unknown flag bits.
3888  * @return
3889  * > 0 number of allocated bytes
3890  * 0 no size info is available
3891  * < 0 error
3892  *
3893  * @since 1.0.2
3894  */
3895 typedef int (*iso_node_xinfo_cloner)(void *old_data, void **new_data,int flag);
3896 
3897 /**
3898  * Associate a iso_node_xinfo_cloner to a particular class of extended
3899  * information in order to make it clonable.
3900  *
3901  * @param proc
3902  * The key and disposal function which identifies the particular
3903  * extended information class.
3904  * @param cloner
3905  * The cloner function which shall be associated with proc.
3906  * @param flag
3907  * Unused yet, submit 0
3908  * @return
3909  * 1 success, < 0 error
3910  *
3911  * @since 1.0.2
3912  */
3914  iso_node_xinfo_cloner cloner, int flag);
3915 
3916 /**
3917  * Inquire the registered cloner function for a particular class of
3918  * extended information.
3919  *
3920  * @param proc
3921  * The key and disposal function which identifies the particular
3922  * extended information class.
3923  * @param cloner
3924  * Will return the cloner function which is associated with proc, or NULL.
3925  * @param flag
3926  * Unused yet, submit 0
3927  * @return
3928  * 1 success, 0 no cloner registered for proc, < 0 error
3929  *
3930  * @since 1.0.2
3931  */
3933  iso_node_xinfo_cloner *cloner, int flag);
3934 
3935 
3936 /**
3937  * Set the name of a node. Note that if the node is already added to a dir
3938  * this can fail if dir already contains a node with the new name.
3939  *
3940  * @param node
3941  * The node whose name you want to change. Note that you can't change
3942  * the name of the root.
3943  * @param name
3944  * The name for the node. If you supply an empty string or a
3945  * name greater than 255 characters this returns with failure, and
3946  * node name is not modified.
3947  * @return
3948  * 1 on success, < 0 on error
3949  *
3950  * @since 0.6.2
3951  */
3952 int iso_node_set_name(IsoNode *node, const char *name);
3953 
3954 /**
3955  * Get the name of a node.
3956  * The returned string belongs to the node and must not be modified nor
3957  * freed. Use strdup if you really need your own copy.
3958  *
3959  * @since 0.6.2
3960  */
3961 const char *iso_node_get_name(const IsoNode *node);
3962 
3963 /**
3964  * Set the permissions for the node. This attribute is only useful when
3965  * Rock Ridge extensions are enabled.
3966  *
3967  * @param node
3968  * The node to change
3969  * @param mode
3970  * bitmask with the permissions of the node, as specified in 'man 2 stat'.
3971  * The file type bitfields will be ignored, only file permissions will be
3972  * modified.
3973  *
3974  * @since 0.6.2
3975  */
3976 void iso_node_set_permissions(IsoNode *node, mode_t mode);
3977 
3978 /**
3979  * Get the permissions for the node
3980  *
3981  * @since 0.6.2
3982  */
3983 mode_t iso_node_get_permissions(const IsoNode *node);
3984 
3985 /**
3986  * Get the mode of the node, both permissions and file type, as specified in
3987  * 'man 2 stat'.
3988  *
3989  * @since 0.6.2
3990  */
3991 mode_t iso_node_get_mode(const IsoNode *node);
3992 
3993 /**
3994  * Set the user id for the node. This attribute is only useful when
3995  * Rock Ridge extensions are enabled.
3996  *
3997  * @since 0.6.2
3998  */
3999 void iso_node_set_uid(IsoNode *node, uid_t uid);
4000 
4001 /**
4002  * Get the user id of the node.
4003  *
4004  * @since 0.6.2
4005  */
4006 uid_t iso_node_get_uid(const IsoNode *node);
4007 
4008 /**
4009  * Set the group id for the node. This attribute is only useful when
4010  * Rock Ridge extensions are enabled.
4011  *
4012  * @since 0.6.2
4013  */
4014 void iso_node_set_gid(IsoNode *node, gid_t gid);
4015 
4016 /**
4017  * Get the group id of the node.
4018  *
4019  * @since 0.6.2
4020  */
4021 gid_t iso_node_get_gid(const IsoNode *node);
4022 
4023 /**
4024  * Set the time of last modification of the file
4025  *
4026  * @since 0.6.2
4027  */
4028 void iso_node_set_mtime(IsoNode *node, time_t time);
4029 
4030 /**
4031  * Get the time of last modification of the file
4032  *
4033  * @since 0.6.2
4034  */
4035 time_t iso_node_get_mtime(const IsoNode *node);
4036 
4037 /**
4038  * Set the time of last access to the file
4039  *
4040  * @since 0.6.2
4041  */
4042 void iso_node_set_atime(IsoNode *node, time_t time);
4043 
4044 /**
4045  * Get the time of last access to the file
4046  *
4047  * @since 0.6.2
4048  */
4049 time_t iso_node_get_atime(const IsoNode *node);
4050 
4051 /**
4052  * Set the time of last status change of the file
4053  *
4054  * @since 0.6.2
4055  */
4056 void iso_node_set_ctime(IsoNode *node, time_t time);
4057 
4058 /**
4059  * Get the time of last status change of the file
4060  *
4061  * @since 0.6.2
4062  */
4063 time_t iso_node_get_ctime(const IsoNode *node);
4064 
4065 /**
4066  * Set whether the node will be hidden in the directory trees of RR/ISO 9660,
4067  * or of Joliet (if enabled at all), or of ISO-9660:1999 (if enabled at all).
4068  *
4069  * A hidden file does not show up by name in the affected directory tree.
4070  * For example, if a file is hidden only in Joliet, it will normally
4071  * not be visible on Windows systems, while being shown on GNU/Linux.
4072  *
4073  * If a file is not shown in any of the enabled trees, then its content will
4074  * not be written to the image, unless LIBISO_HIDE_BUT_WRITE is given (which
4075  * is available only since release 0.6.34).
4076  *
4077  * @param node
4078  * The node that is to be hidden.
4079  * @param hide_attrs
4080  * Or-combination of values from enum IsoHideNodeFlag to set the trees
4081  * in which the node's name shall be hidden.
4082  *
4083  * @since 0.6.2
4084  */
4085 void iso_node_set_hidden(IsoNode *node, int hide_attrs);
4086 
4087 /**
4088  * Get the hide_attrs as eventually set by iso_node_set_hidden().
4089  *
4090  * @param node
4091  * The node to inquire.
4092  * @return
4093  * Or-combination of values from enum IsoHideNodeFlag which are
4094  * currently set for the node.
4095  *
4096  * @since 0.6.34
4097  */
4098 int iso_node_get_hidden(IsoNode *node);
4099 
4100 /**
4101  * Compare two nodes whether they are based on the same input and
4102  * can be considered as hardlinks to the same file objects.
4103  *
4104  * @param n1
4105  * The first node to compare.
4106  * @param n2
4107  * The second node to compare.
4108  * @return
4109  * -1 if s1 is smaller s2 , 0 if s1 matches s2 , 1 if s1 is larger s2
4110  * @param flag
4111  * Bitfield for control purposes, unused yet, submit 0
4112  * @since 0.6.20
4113  */
4114 int iso_node_cmp_ino(IsoNode *n1, IsoNode *n2, int flag);
4115 
4116 /**
4117  * Add a new node to a dir. Note that this function don't add a new ref to
4118  * the node, so you don't need to free it, it will be automatically freed
4119  * when the dir is deleted. Of course, if you want to keep using the node
4120  * after the dir life, you need to iso_node_ref() it.
4121  *
4122  * @param dir
4123  * the dir where to add the node
4124  * @param child
4125  * the node to add. You must ensure that the node hasn't previously added
4126  * to other dir, and that the node name is unique inside the child.
4127  * Otherwise this function will return a failure, and the child won't be
4128  * inserted.
4129  * @param replace
4130  * if the dir already contains a node with the same name, whether to
4131  * replace or not the old node with this.
4132  * @return
4133  * number of nodes in dir if succes, < 0 otherwise
4134  * Possible errors:
4135  * ISO_NULL_POINTER, if dir or child are NULL
4136  * ISO_NODE_ALREADY_ADDED, if child is already added to other dir
4137  * ISO_NODE_NAME_NOT_UNIQUE, a node with same name already exists
4138  * ISO_WRONG_ARG_VALUE, if child == dir, or replace != (0,1)
4139  *
4140  * @since 0.6.2
4141  */
4142 int iso_dir_add_node(IsoDir *dir, IsoNode *child,
4143  enum iso_replace_mode replace);
4144 
4145 /**
4146  * Locate a node inside a given dir.
4147  *
4148  * @param dir
4149  * The dir where to look for the node.
4150  * @param name
4151  * The name of the node
4152  * @param node
4153  * Location for a pointer to the node, it will filled with NULL if the dir
4154  * doesn't have a child with the given name.
4155  * The node will be owned by the dir and shouldn't be unref(). Just call
4156  * iso_node_ref() to get your own reference to the node.
4157  * Note that you can pass NULL is the only thing you want to do is check
4158  * if a node with such name already exists on dir.
4159  * @return
4160  * 1 node found, 0 child has no such node, < 0 error
4161  * Possible errors:
4162  * ISO_NULL_POINTER, if dir or name are NULL
4163  *
4164  * @since 0.6.2
4165  */
4166 int iso_dir_get_node(IsoDir *dir, const char *name, IsoNode **node);
4167 
4168 /**
4169  * Get the number of children of a directory.
4170  *
4171  * @return
4172  * >= 0 number of items, < 0 error
4173  * Possible errors:
4174  * ISO_NULL_POINTER, if dir is NULL
4175  *
4176  * @since 0.6.2
4177  */
4179 
4180 /**
4181  * Removes a child from a directory.
4182  * The child is not freed, so you will become the owner of the node. Later
4183  * you can add the node to another dir (calling iso_dir_add_node), or free
4184  * it if you don't need it (with iso_node_unref).
4185  *
4186  * @return
4187  * 1 on success, < 0 error
4188  * Possible errors:
4189  * ISO_NULL_POINTER, if node is NULL
4190  * ISO_NODE_NOT_ADDED_TO_DIR, if node doesn't belong to a dir
4191  *
4192  * @since 0.6.2
4193  */
4194 int iso_node_take(IsoNode *node);
4195 
4196 /**
4197  * Removes a child from a directory and free (unref) it.
4198  * If you want to keep the child alive, you need to iso_node_ref() it
4199  * before this call, but in that case iso_node_take() is a better
4200  * alternative.
4201  *
4202  * @return
4203  * 1 on success, < 0 error
4204  *
4205  * @since 0.6.2
4206  */
4207 int iso_node_remove(IsoNode *node);
4208 
4209 /*
4210  * Get the parent of the given iso tree node. No extra ref is added to the
4211  * returned directory, you must take your ref. with iso_node_ref() if you
4212  * need it.
4213  *
4214  * If node is the root node, the same node will be returned as its parent.
4215  *
4216  * This returns NULL if the node doesn't pertain to any tree
4217  * (it was removed/taken).
4218  *
4219  * @since 0.6.2
4220  */
4222 
4223 /**
4224  * Get an iterator for the children of the given dir.
4225  *
4226  * You can iterate over the children with iso_dir_iter_next. When finished,
4227  * you should free the iterator with iso_dir_iter_free.
4228  * You musn't delete a child of the same dir, using iso_node_take() or
4229  * iso_node_remove(), while you're using the iterator. You can use
4230  * iso_dir_iter_take() or iso_dir_iter_remove() instead.
4231  *
4232  * You can use the iterator in the way like this
4233  *
4234  * IsoDirIter *iter;
4235  * IsoNode *node;
4236  * if ( iso_dir_get_children(dir, &iter) != 1 ) {
4237  * // handle error
4238  * }
4239  * while ( iso_dir_iter_next(iter, &node) == 1 ) {
4240  * // do something with the child
4241  * }
4242  * iso_dir_iter_free(iter);
4243  *
4244  * An iterator is intended to be used in a single iteration over the
4245  * children of a dir. Thus, it should be treated as a temporary object,
4246  * and free as soon as possible.
4247  *
4248  * @return
4249  * 1 success, < 0 error
4250  * Possible errors:
4251  * ISO_NULL_POINTER, if dir or iter are NULL
4252  * ISO_OUT_OF_MEM
4253  *
4254  * @since 0.6.2
4255  */
4256 int iso_dir_get_children(const IsoDir *dir, IsoDirIter **iter);
4257 
4258 /**
4259  * Get the next child.
4260  * Take care that the node is owned by its parent, and will be unref() when
4261  * the parent is freed. If you want your own ref to it, call iso_node_ref()
4262  * on it.
4263  *
4264  * @return
4265  * 1 success, 0 if dir has no more elements, < 0 error
4266  * Possible errors:
4267  * ISO_NULL_POINTER, if node or iter are NULL
4268  * ISO_ERROR, on wrong iter usage, usual caused by modiying the
4269  * dir during iteration
4270  *
4271  * @since 0.6.2
4272  */
4273 int iso_dir_iter_next(IsoDirIter *iter, IsoNode **node);
4274 
4275 /**
4276  * Check if there're more children.
4277  *
4278  * @return
4279  * 1 dir has more elements, 0 no, < 0 error
4280  * Possible errors:
4281  * ISO_NULL_POINTER, if iter is NULL
4282  *
4283  * @since 0.6.2
4284  */
4286 
4287 /**
4288  * Free a dir iterator.
4289  *
4290  * @since 0.6.2
4291  */
4292 void iso_dir_iter_free(IsoDirIter *iter);
4293 
4294 /**
4295  * Removes a child from a directory during an iteration, without freeing it.
4296  * It's like iso_node_take(), but to be used during a directory iteration.
4297  * The node removed will be the last returned by the iteration.
4298  *
4299  * If you call this function twice without calling iso_dir_iter_next between
4300  * them is not allowed and you will get an ISO_ERROR in second call.
4301  *
4302  * @return
4303  * 1 on succes, < 0 error
4304  * Possible errors:
4305  * ISO_NULL_POINTER, if iter is NULL
4306  * ISO_ERROR, on wrong iter usage, for example by call this before
4307  * iso_dir_iter_next.
4308  *
4309  * @since 0.6.2
4310  */
4311 int iso_dir_iter_take(IsoDirIter *iter);
4312 
4313 /**
4314  * Removes a child from a directory during an iteration and unref() it.
4315  * Like iso_node_remove(), but to be used during a directory iteration.
4316  * The node removed will be the one returned by the previous iteration.
4317  *
4318  * It is not allowed to call this function twice without calling
4319  * iso_dir_iter_next inbetween.
4320  *
4321  * @return
4322  * 1 on succes, < 0 error
4323  * Possible errors:
4324  * ISO_NULL_POINTER, if iter is NULL
4325  * ISO_ERROR, on wrong iter usage, for example by calling this before
4326  * iso_dir_iter_next.
4327  *
4328  * @since 0.6.2
4329  */
4330 int iso_dir_iter_remove(IsoDirIter *iter);
4331 
4332 /**
4333  * Removes a node by iso_node_remove() or iso_dir_iter_remove(). If the node
4334  * is a directory then the whole tree of nodes underneath is removed too.
4335  *
4336  * @param node
4337  * The node to be removed.
4338  * @param iter
4339  * If not NULL, then the node will be removed by iso_dir_iter_remove(iter)
4340  * else it will be removed by iso_node_remove(node).
4341  * @return
4342  * 1 is success, <0 indicates error
4343  *
4344  * @since 1.0.2
4345  */
4346 int iso_node_remove_tree(IsoNode *node, IsoDirIter *boss_iter);
4347 
4348 
4349 /**
4350  * @since 0.6.4
4351  */
4352 typedef struct iso_find_condition IsoFindCondition;
4353 
4354 /**
4355  * Create a new condition that checks if the node name matches the given
4356  * wildcard.
4357  *
4358  * @param wildcard
4359  * @result
4360  * The created IsoFindCondition, NULL on error.
4361  *
4362  * @since 0.6.4
4363  */
4364 IsoFindCondition *iso_new_find_conditions_name(const char *wildcard);
4365 
4366 /**
4367  * Create a new condition that checks the node mode against a mode mask. It
4368  * can be used to check both file type and permissions.
4369  *
4370  * For example:
4371  *
4372  * iso_new_find_conditions_mode(S_IFREG) : search for regular files
4373  * iso_new_find_conditions_mode(S_IFCHR | S_IWUSR) : search for character
4374  * devices where owner has write permissions.
4375  *
4376  * @param mask
4377  * Mode mask to AND against node mode.
4378  * @result
4379  * The created IsoFindCondition, NULL on error.
4380  *
4381  * @since 0.6.4
4382  */
4384 
4385 /**
4386  * Create a new condition that checks the node gid.
4387  *
4388  * @param gid
4389  * Desired Group Id.
4390  * @result
4391  * The created IsoFindCondition, NULL on error.
4392  *
4393  * @since 0.6.4
4394  */
4396 
4397 /**
4398  * Create a new condition that checks the node uid.
4399  *
4400  * @param uid
4401  * Desired User Id.
4402  * @result
4403  * The created IsoFindCondition, NULL on error.
4404  *
4405  * @since 0.6.4
4406  */
4408 
4409 /**
4410  * Possible comparison between IsoNode and given conditions.
4411  *
4412  * @since 0.6.4
4413  */
4420 };
4421 
4422 /**
4423  * Create a new condition that checks the time of last access.
4424  *
4425  * @param time
4426  * Time to compare against IsoNode atime.
4427  * @param comparison
4428  * Comparison to be done between IsoNode atime and submitted time.
4429  * Note that ISO_FIND_COND_GREATER, for example, is true if the node
4430  * time is greater than the submitted time.
4431  * @result
4432  * The created IsoFindCondition, NULL on error.
4433  *
4434  * @since 0.6.4
4435  */
4437  enum iso_find_comparisons comparison);
4438 
4439 /**
4440  * Create a new condition that checks the time of last modification.
4441  *
4442  * @param time
4443  * Time to compare against IsoNode mtime.
4444  * @param comparison
4445  * Comparison to be done between IsoNode mtime and submitted time.
4446  * Note that ISO_FIND_COND_GREATER, for example, is true if the node
4447  * time is greater than the submitted time.
4448  * @result
4449  * The created IsoFindCondition, NULL on error.
4450  *
4451  * @since 0.6.4
4452  */
4454  enum iso_find_comparisons comparison);
4455 
4456 /**
4457  * Create a new condition that checks the time of last status change.
4458  *
4459  * @param time
4460  * Time to compare against IsoNode ctime.
4461  * @param comparison
4462  * Comparison to be done between IsoNode ctime and submitted time.
4463  * Note that ISO_FIND_COND_GREATER, for example, is true if the node
4464  * time is greater than the submitted time.
4465  * @result
4466  * The created IsoFindCondition, NULL on error.
4467  *
4468  * @since 0.6.4
4469  */
4471  enum iso_find_comparisons comparison);
4472 
4473 /**
4474  * Create a new condition that check if the two given conditions are
4475  * valid.
4476  *
4477  * @param a
4478  * @param b
4479  * IsoFindCondition to compare
4480  * @result
4481  * The created IsoFindCondition, NULL on error.
4482  *
4483  * @since 0.6.4
4484  */
4486  IsoFindCondition *b);
4487 
4488 /**
4489  * Create a new condition that check if at least one the two given conditions
4490  * is valid.
4491  *
4492  * @param a
4493  * @param b
4494  * IsoFindCondition to compare
4495  * @result
4496  * The created IsoFindCondition, NULL on error.
4497  *
4498  * @since 0.6.4
4499  */
4501  IsoFindCondition *b);
4502 
4503 /**
4504  * Create a new condition that check if the given conditions is false.
4505  *
4506  * @param negate
4507  * @result
4508  * The created IsoFindCondition, NULL on error.
4509  *
4510  * @since 0.6.4
4511  */
4513 
4514 /**
4515  * Find all directory children that match the given condition.
4516  *
4517  * @param dir
4518  * Directory where we will search children.
4519  * @param cond
4520  * Condition that the children must match in order to be returned.
4521  * It will be free together with the iterator. Remember to delete it
4522  * if this function return error.
4523  * @param iter
4524  * Iterator that returns only the children that match condition.
4525  * @return
4526  * 1 on success, < 0 on error
4527  *
4528  * @since 0.6.4
4529  */
4531  IsoDirIter **iter);
4532 
4533 /**
4534  * Get the destination of a node.
4535  * The returned string belongs to the node and must not be modified nor
4536  * freed. Use strdup if you really need your own copy.
4537  *
4538  * @since 0.6.2
4539  */
4540 const char *iso_symlink_get_dest(const IsoSymlink *link);
4541 
4542 /**
4543  * Set the destination of a link.
4544  *
4545  * @param opts
4546  * The option set to be manipulated
4547  * @param dest
4548  * New destination for the link. It must be a non-empty string, otherwise
4549  * this function doesn't modify previous destination.
4550  * @return
4551  * 1 on success, < 0 on error
4552  *
4553  * @since 0.6.2
4554  */
4555 int iso_symlink_set_dest(IsoSymlink *link, const char *dest);
4556 
4557 /**
4558  * Sets the order in which a node will be written on image. The data content
4559  * of files with high weight will be written to low block addresses.
4560  *
4561  * @param node
4562  * The node which weight will be changed. If it's a dir, this function
4563  * will change the weight of all its children. For nodes other that dirs
4564  * or regular files, this function has no effect.
4565  * @param w
4566  * The weight as a integer number, the greater this value is, the
4567  * closer from the begining of image the file will be written.
4568  * Default value at IsoNode creation is 0.
4569  *
4570  * @since 0.6.2
4571  */
4572 void iso_node_set_sort_weight(IsoNode *node, int w);
4573 
4574 /**
4575  * Get the sort weight of a file.
4576  *
4577  * @since 0.6.2
4578  */
4580 
4581 /**
4582  * Get the size of the file, in bytes
4583  *
4584  * @since 0.6.2
4585  */
4586 off_t iso_file_get_size(IsoFile *file);
4587 
4588 /**
4589  * Get the device id (major/minor numbers) of the given block or
4590  * character device file. The result is undefined for other kind
4591  * of special files, of first be sure iso_node_get_mode() returns either
4592  * S_IFBLK or S_IFCHR.
4593  *
4594  * @since 0.6.6
4595  */
4596 dev_t iso_special_get_dev(IsoSpecial *special);
4597 
4598 /**
4599  * Get the IsoStream that represents the contents of the given IsoFile.
4600  * The stream may be a filter stream which itself get its input from a
4601  * further stream. This may be inquired by iso_stream_get_input_stream().
4602  *
4603  * If you iso_stream_open() the stream, iso_stream_close() it before
4604  * image generation begins.
4605  *
4606  * @return
4607  * The IsoStream. No extra ref is added, so the IsoStream belongs to the
4608  * IsoFile, and it may be freed together with it. Add your own ref with
4609  * iso_stream_ref() if you need it.
4610  *
4611  * @since 0.6.4
4612  */
4614 
4615 /**
4616  * Get the block lba of a file node, if it was imported from an old image.
4617  *
4618  * @param file
4619  * The file
4620  * @param lba
4621  * Will be filled with the kba
4622  * @param flag
4623  * Reserved for future usage, submit 0
4624  * @return
4625  * 1 if lba is valid (file comes from old image), 0 if file was newly
4626  * added, i.e. it does not come from an old image, < 0 error
4627  *
4628  * @since 0.6.4
4629  *
4630  * @deprecated Use iso_file_get_old_image_sections(), as this function does
4631  * not work with multi-extend files.
4632  */
4633 int iso_file_get_old_image_lba(IsoFile *file, uint32_t *lba, int flag);
4634 
4635 /**
4636  * Get the start addresses and the sizes of the data extents of a file node
4637  * if it was imported from an old image.
4638  *
4639  * @param file
4640  * The file
4641  * @param section_count
4642  * Returns the number of extent entries in sections array.
4643  * @param sections
4644  * Returns the array of file sections. Apply free() to dispose it.
4645  * @param flag
4646  * Reserved for future usage, submit 0
4647  * @return
4648  * 1 if there are valid extents (file comes from old image),
4649  * 0 if file was newly added, i.e. it does not come from an old image,
4650  * < 0 error
4651  *
4652  * @since 0.6.8
4653  */
4654 int iso_file_get_old_image_sections(IsoFile *file, int *section_count,
4655  struct iso_file_section **sections,
4656  int flag);
4657 
4658 /*
4659  * Like iso_file_get_old_image_lba(), but take an IsoNode.
4660  *
4661  * @return
4662  * 1 if lba is valid (file comes from old image), 0 if file was newly
4663  * added, i.e. it does not come from an old image, 2 node type has no
4664  * LBA (no regular file), < 0 error
4665  *
4666  * @since 0.6.4
4667  */
4668 int iso_node_get_old_image_lba(IsoNode *node, uint32_t *lba, int flag);
4669 
4670 /**
4671  * Add a new directory to the iso tree. Permissions, owner and hidden atts
4672  * are taken from parent, you can modify them later.
4673  *
4674  * @param parent
4675  * the dir where the new directory will be created
4676  * @param name
4677  * name for the new dir. If a node with same name already exists on
4678  * parent, this functions fails with ISO_NODE_NAME_NOT_UNIQUE.
4679  * @param dir
4680  * place where to store a pointer to the newly created dir. No extra
4681  * ref is addded, so you will need to call iso_node_ref() if you really
4682  * need it. You can pass NULL in this parameter if you don't need the
4683  * pointer.
4684  * @return
4685  * number of nodes in parent if success, < 0 otherwise
4686  * Possible errors:
4687  * ISO_NULL_POINTER, if parent or name are NULL
4688  * ISO_NODE_NAME_NOT_UNIQUE, a node with same name already exists
4689  * ISO_OUT_OF_MEM
4690  *
4691  * @since 0.6.2
4692  */
4693 int iso_tree_add_new_dir(IsoDir *parent, const char *name, IsoDir **dir);
4694 
4695 /**
4696  * Add a new regular file to the iso tree. Permissions are set to 0444,
4697  * owner and hidden atts are taken from parent. You can modify any of them
4698  * later.
4699  *
4700  * @param parent
4701  * the dir where the new file will be created
4702  * @param name
4703  * name for the new file. If a node with same name already exists on
4704  * parent, this functions fails with ISO_NODE_NAME_NOT_UNIQUE.
4705  * @param stream
4706  * IsoStream for the contents of the file. The reference will be taken
4707  * by the newly created file, you will need to take an extra ref to it
4708  * if you need it.
4709  * @param file
4710  * place where to store a pointer to the newly created file. No extra
4711  * ref is addded, so you will need to call iso_node_ref() if you really
4712  * need it. You can pass NULL in this parameter if you don't need the
4713  * pointer
4714  * @return
4715  * number of nodes in parent if success, < 0 otherwise
4716  * Possible errors:
4717  * ISO_NULL_POINTER, if parent, name or dest are NULL
4718  * ISO_NODE_NAME_NOT_UNIQUE, a node with same name already exists
4719  * ISO_OUT_OF_MEM
4720  *
4721  * @since 0.6.4
4722  */
4723 int iso_tree_add_new_file(IsoDir *parent, const char *name, IsoStream *stream,
4724  IsoFile **file);
4725 
4726 /**
4727  * Create an IsoStream object from content which is stored in a dynamically
4728  * allocated memory buffer. The new stream will become owner of the buffer
4729  * and apply free() to it when the stream finally gets destroyed itself.
4730  *
4731  * @param buf
4732  * The dynamically allocated memory buffer with the stream content.
4733  * @parm size
4734  * The number of bytes which may be read from buf.
4735  * @param stream
4736  * Will return a reference to the newly created stream.
4737  * @return
4738  * ISO_SUCCESS or <0 for error. E.g. ISO_NULL_POINTER, ISO_OUT_OF_MEM.
4739  *
4740  * @since 1.0.0
4741  */
4742 int iso_memory_stream_new(unsigned char *buf, size_t size, IsoStream **stream);
4743 
4744 /**
4745  * Add a new symlink to the directory tree. Permissions are set to 0777,
4746  * owner and hidden atts are taken from parent. You can modify any of them
4747  * later.
4748  *
4749  * @param parent
4750  * the dir where the new symlink will be created
4751  * @param name
4752  * name for the new symlink. If a node with same name already exists on
4753  * parent, this functions fails with ISO_NODE_NAME_NOT_UNIQUE.
4754  * @param dest
4755  * destination of the link
4756  * @param link
4757  * place where to store a pointer to the newly created link. No extra
4758  * ref is addded, so you will need to call iso_node_ref() if you really
4759  * need it. You can pass NULL in this parameter if you don't need the
4760  * pointer
4761  * @return
4762  * number of nodes in parent if success, < 0 otherwise
4763  * Possible errors:
4764  * ISO_NULL_POINTER, if parent, name or dest are NULL
4765  * ISO_NODE_NAME_NOT_UNIQUE, a node with same name already exists
4766  * ISO_OUT_OF_MEM
4767  *
4768  * @since 0.6.2
4769  */
4770 int iso_tree_add_new_symlink(IsoDir *parent, const char *name,
4771  const char *dest, IsoSymlink **link);
4772 
4773 /**
4774  * Add a new special file to the directory tree. As far as libisofs concerns,
4775  * an special file is a block device, a character device, a FIFO (named pipe)
4776  * or a socket. You can choose the specific kind of file you want to add
4777  * by setting mode propertly (see man 2 stat).
4778  *
4779  * Note that special files are only written to image when Rock Ridge
4780  * extensions are enabled. Moreover, a special file is just a directory entry
4781  * in the image tree, no data is written beyond that.
4782  *
4783  * Owner and hidden atts are taken from parent. You can modify any of them
4784  * later.
4785  *
4786  * @param parent
4787  * the dir where the new special file will be created
4788  * @param name
4789  * name for the new special file. If a node with same name already exists
4790  * on parent, this functions fails with ISO_NODE_NAME_NOT_UNIQUE.
4791  * @param mode
4792  * file type and permissions for the new node. Note that you can't
4793  * specify any kind of file here, only special types are allowed. i.e,
4794  * S_IFSOCK, S_IFBLK, S_IFCHR and S_IFIFO are valid types; S_IFLNK,
4795  * S_IFREG and S_IFDIR aren't.
4796  * @param dev
4797  * device ID, equivalent to the st_rdev field in man 2 stat.
4798  * @param special
4799  * place where to store a pointer to the newly created special file. No
4800  * extra ref is addded, so you will need to call iso_node_ref() if you
4801  * really need it. You can pass NULL in this parameter if you don't need
4802  * the pointer.
4803  * @return
4804  * number of nodes in parent if success, < 0 otherwise
4805  * Possible errors:
4806  * ISO_NULL_POINTER, if parent, name or dest are NULL
4807  * ISO_NODE_NAME_NOT_UNIQUE, a node with same name already exists
4808  * ISO_WRONG_ARG_VALUE if you select a incorrect mode
4809  * ISO_OUT_OF_MEM
4810  *
4811  * @since 0.6.2
4812  */
4813 int iso_tree_add_new_special(IsoDir *parent, const char *name, mode_t mode,
4814  dev_t dev, IsoSpecial **special);
4815 
4816 /**
4817  * Set whether to follow or not symbolic links when added a file from a source
4818  * to IsoImage. Default behavior is to not follow symlinks.
4819  *
4820  * @since 0.6.2
4821  */
4822 void iso_tree_set_follow_symlinks(IsoImage *image, int follow);
4823 
4824 /**
4825  * Get current setting for follow_symlinks.
4826  *
4827  * @see iso_tree_set_follow_symlinks
4828  * @since 0.6.2
4829  */
4831 
4832 /**
4833  * Set whether to skip or not disk files with names beginning by '.'
4834  * when adding a directory recursively.
4835  * Default behavior is to not ignore them.
4836  *
4837  * Clarification: This is not related to the IsoNode property to be hidden
4838  * in one or more of the resulting image trees as of
4839  * IsoHideNodeFlag and iso_node_set_hidden().
4840  *
4841  * @since 0.6.2
4842  */
4843 void iso_tree_set_ignore_hidden(IsoImage *image, int skip);
4844 
4845 /**
4846  * Get current setting for ignore_hidden.
4847  *
4848  * @see iso_tree_set_ignore_hidden
4849  * @since 0.6.2
4850  */
4852 
4853 /**
4854  * Set the replace mode, that defines the behavior of libisofs when adding
4855  * a node whit the same name that an existent one, during a recursive
4856  * directory addition.
4857  *
4858  * @since 0.6.2
4859  */
4860 void iso_tree_set_replace_mode(IsoImage *image, enum iso_replace_mode mode);
4861 
4862 /**
4863  * Get current setting for replace_mode.
4864  *
4865  * @see iso_tree_set_replace_mode
4866  * @since 0.6.2
4867  */
4869 
4870 /**
4871  * Set whether to skip or not special files. Default behavior is to not skip
4872  * them. Note that, despite of this setting, special files will never be added
4873  * to an image unless RR extensions were enabled.
4874  *
4875  * @param image
4876  * The image to manipulate.
4877  * @param skip
4878  * Bitmask to determine what kind of special files will be skipped:
4879  * bit0: ignore FIFOs
4880  * bit1: ignore Sockets
4881  * bit2: ignore char devices
4882  * bit3: ignore block devices
4883  *
4884  * @since 0.6.2
4885  */
4886 void iso_tree_set_ignore_special(IsoImage *image, int skip);
4887 
4888 /**
4889  * Get current setting for ignore_special.
4890  *
4891  * @see iso_tree_set_ignore_special
4892  * @since 0.6.2
4893  */
4895 
4896 /**
4897  * Add a excluded path. These are paths that won't never added to image, and
4898  * will be excluded even when adding recursively its parent directory.
4899  *
4900  * For example, in
4901  *
4902  * iso_tree_add_exclude(image, "/home/user/data/private");
4903  * iso_tree_add_dir_rec(image, root, "/home/user/data");
4904  *
4905  * the directory /home/user/data/private won't be added to image.
4906  *
4907  * However, if you explicity add a deeper dir, it won't be excluded. i.e.,
4908  * in the following example.
4909  *
4910  * iso_tree_add_exclude(image, "/home/user/data");
4911  * iso_tree_add_dir_rec(image, root, "/home/user/data/private");
4912  *
4913  * the directory /home/user/data/private is added. On the other, side, and
4914  * foollowing the the example above,
4915  *
4916  * iso_tree_add_dir_rec(image, root, "/home/user");
4917  *
4918  * will exclude the directory "/home/user/data".
4919  *
4920  * Absolute paths are not mandatory, you can, for example, add a relative
4921  * path such as:
4922  *
4923  * iso_tree_add_exclude(image, "private");
4924  * iso_tree_add_exclude(image, "user/data");
4925  *
4926  * to excluve, respectively, all files or dirs named private, and also all
4927  * files or dirs named data that belong to a folder named "user". Not that the
4928  * above rule about deeper dirs is still valid. i.e., if you call
4929  *
4930  * iso_tree_add_dir_rec(image, root, "/home/user/data/music");
4931  *
4932  * it is included even containing "user/data" string. However, a possible
4933  * "/home/user/data/music/user/data" is not added.
4934  *
4935  * Usual wildcards, such as * or ? are also supported, with the usual meaning
4936  * as stated in "man 7 glob". For example
4937  *
4938  * // to exclude backup text files
4939  * iso_tree_add_exclude(image, "*.~");
4940  *
4941  * @return
4942  * 1 on success, < 0 on error
4943  *
4944  * @since 0.6.2
4945  */
4946 int iso_tree_add_exclude(IsoImage *image, const char *path);
4947 
4948 /**
4949  * Remove a previously added exclude.
4950  *
4951  * @see iso_tree_add_exclude
4952  * @return
4953  * 1 on success, 0 exclude do not exists, < 0 on error
4954  *
4955  * @since 0.6.2
4956  */
4957 int iso_tree_remove_exclude(IsoImage *image, const char *path);
4958 
4959 /**
4960  * Set a callback function that libisofs will call for each file that is
4961  * added to the given image by a recursive addition function. This includes
4962  * image import.
4963  *
4964  * @param image
4965  * The image to manipulate.
4966  * @param report
4967  * pointer to a function that will be called just before a file will be
4968  * added to the image. You can control whether the file will be in fact
4969  * added or ignored.
4970  * This function should return 1 to add the file, 0 to ignore it and
4971  * continue, < 0 to abort the process
4972  * NULL is allowed if you don't want any callback.
4973  *
4974  * @since 0.6.2
4975  */
4977  int (*report)(IsoImage*, IsoFileSource*));
4978 
4979 /**
4980  * Add a new node to the image tree, from an existing file.
4981  *
4982  * TODO comment Builder and Filesystem related issues when exposing both
4983  *
4984  * All attributes will be taken from the source file. The appropriate file
4985  * type will be created.
4986  *
4987  * @param image
4988  * The image
4989  * @param parent
4990  * The directory in the image tree where the node will be added.
4991  * @param path
4992  * The absolute path of the file in the local filesystem.
4993  * The node will have the same leaf name as the file on disk.
4994  * Its directory path depends on the parent node.
4995  * @param node
4996  * place where to store a pointer to the newly added file. No
4997  * extra ref is addded, so you will need to call iso_node_ref() if you
4998  * really need it. You can pass NULL in this parameter if you don't need
4999  * the pointer.
5000  * @return
5001  * number of nodes in parent if success, < 0 otherwise
5002  * Possible errors:
5003  * ISO_NULL_POINTER, if image, parent or path are NULL
5004  * ISO_NODE_NAME_NOT_UNIQUE, a node with same name already exists
5005  * ISO_OUT_OF_MEM
5006  *
5007  * @since 0.6.2
5008  */
5009 int iso_tree_add_node(IsoImage *image, IsoDir *parent, const char *path,
5010  IsoNode **node);
5011 
5012 /**
5013  * This is a more versatile form of iso_tree_add_node which allows to set
5014  * the node name in ISO image already when it gets added.
5015  *
5016  * Add a new node to the image tree, from an existing file, and with the
5017  * given name, that must not exist on dir.
5018  *
5019  * @param image
5020  * The image
5021  * @param parent
5022  * The directory in the image tree where the node will be added.
5023  * @param name
5024  * The leaf name that the node will have on image.
5025  * Its directory path depends on the parent node.
5026  * @param path
5027  * The absolute path of the file in the local filesystem.
5028  * @param node
5029  * place where to store a pointer to the newly added file. No
5030  * extra ref is addded, so you will need to call iso_node_ref() if you
5031  * really need it. You can pass NULL in this parameter if you don't need
5032  * the pointer.
5033  * @return
5034  * number of nodes in parent if success, < 0 otherwise
5035  * Possible errors:
5036  * ISO_NULL_POINTER, if image, parent or path are NULL
5037  * ISO_NODE_NAME_NOT_UNIQUE, a node with same name already exists
5038  * ISO_OUT_OF_MEM
5039  *
5040  * @since 0.6.4
5041  */
5042 int iso_tree_add_new_node(IsoImage *image, IsoDir *parent, const char *name,
5043  const char *path, IsoNode **node);
5044 
5045 /**
5046  * Add a new node to the image tree with the given name that must not exist
5047  * on dir. The node data content will be a byte interval out of the data
5048  * content of a file in the local filesystem.
5049  *
5050  * @param image
5051  * The image
5052  * @param parent
5053  * The directory in the image tree where the node will be added.
5054  * @param name
5055  * The leaf name that the node will have on image.
5056  * Its directory path depends on the parent node.
5057  * @param path
5058  * The absolute path of the file in the local filesystem. For now
5059  * only regular files and symlinks to regular files are supported.
5060  * @param offset
5061  * Byte number in the given file from where to start reading data.
5062  * @param size
5063  * Max size of the file. This may be more than actually available from
5064  * byte offset to the end of the file in the local filesystem.
5065  * @param node
5066  * place where to store a pointer to the newly added file. No
5067  * extra ref is addded, so you will need to call iso_node_ref() if you
5068  * really need it. You can pass NULL in this parameter if you don't need
5069  * the pointer.
5070  * @return
5071  * number of nodes in parent if success, < 0 otherwise
5072  * Possible errors:
5073  * ISO_NULL_POINTER, if image, parent or path are NULL
5074  * ISO_NODE_NAME_NOT_UNIQUE, a node with same name already exists
5075  * ISO_OUT_OF_MEM
5076  *
5077  * @since 0.6.4
5078  */
5079 int iso_tree_add_new_cut_out_node(IsoImage *image, IsoDir *parent,
5080  const char *name, const char *path,
5081  off_t offset, off_t size,
5082  IsoNode **node);
5083 
5084 /**
5085  * Create a copy of the given node under a different path. If the node is
5086  * actually a directory then clone its whole subtree.
5087  * This call may fail because an IsoFile is encountered which gets fed by an
5088  * IsoStream which cannot be cloned. See also IsoStream_Iface method
5089  * clone_stream().
5090  * Surely clonable node types are:
5091  * IsoDir,
5092  * IsoSymlink,
5093  * IsoSpecial,
5094  * IsoFile from a loaded ISO image,
5095  * IsoFile referring to local filesystem files,
5096  * IsoFile created by iso_tree_add_new_file
5097  * from a stream created by iso_memory_stream_new(),
5098  * IsoFile created by iso_tree_add_new_cut_out_node()
5099  * Silently ignored are nodes of type IsoBoot.
5100  * An IsoFile node with IsoStream filters can be cloned if all those filters
5101  * are clonable and the node would be clonable without filter.
5102  * Clonable IsoStream filters are created by:
5103  * iso_file_add_zisofs_filter()
5104  * iso_file_add_gzip_filter()
5105  * iso_file_add_external_filter()
5106  * An IsoNode with extended information as of iso_node_add_xinfo() can only be
5107  * cloned if each of the iso_node_xinfo_func instances is associated to a
5108  * clone function. See iso_node_xinfo_make_clonable().
5109  * All internally used classes of extended information are clonable.
5110  *
5111  * @param node
5112  * The node to be cloned.
5113  * @param new_parent
5114  * The existing directory node where to insert the cloned node.
5115  * @param new_name
5116  * The name for the cloned node. It must not yet exist in new_parent,
5117  * unless it is a directory and node is a directory and flag bit0 is set.
5118  * @param new_node
5119  * Will return a pointer (without reference) to the newly created clone.
5120  * @param flag
5121  * Bitfield for control purposes. Submit any undefined bits as 0.
5122  * bit0= Merge directories rather than returning ISO_NODE_NAME_NOT_UNIQUE.
5123  * This will not allow to overwrite any existing node.
5124  * Attributes of existing directories will not be overwritten.
5125  * @return
5126  * <0 means error, 1 = new node created,
5127  * 2 = if flag bit0 is set: new_node is a directory which already existed.
5128  *
5129  * @since 1.0.2
5130  */
5131 int iso_tree_clone(IsoNode *node,
5132  IsoDir *new_parent, char *new_name, IsoNode **new_node,
5133  int flag);
5134 
5135 /**
5136  * Add the contents of a dir to a given directory of the iso tree.
5137  *
5138  * There are several options to control what files are added or how they are
5139  * managed. Take a look at iso_tree_set_* functions to see diferent options
5140  * for recursive directory addition.
5141  *
5142  * TODO comment Builder and Filesystem related issues when exposing both
5143  *
5144  * @param image
5145  * The image to which the directory belongs.
5146  * @param parent
5147  * Directory on the image tree where to add the contents of the dir
5148  * @param dir
5149  * Path to a dir in the filesystem
5150  * @return
5151  * number of nodes in parent if success, < 0 otherwise
5152  *
5153  * @since 0.6.2
5154  */
5155 int iso_tree_add_dir_rec(IsoImage *image, IsoDir *parent, const char *dir);
5156 
5157 /**
5158  * Locate a node by its absolute path on image.
5159  *
5160  * @param image
5161  * The image to which the node belongs.
5162  * @param node
5163  * Location for a pointer to the node, it will filled with NULL if the
5164  * given path does not exists on image.
5165  * The node will be owned by the image and shouldn't be unref(). Just call
5166  * iso_node_ref() to get your own reference to the node.
5167  * Note that you can pass NULL is the only thing you want to do is check
5168  * if a node with such path really exists.
5169  * @return
5170  * 1 found, 0 not found, < 0 error
5171  *
5172  * @since 0.6.2
5173  */
5174 int iso_tree_path_to_node(IsoImage *image, const char *path, IsoNode **node);
5175 
5176 /**
5177  * Get the absolute path on image of the given node.
5178  *
5179  * @return
5180  * The path on the image, that must be freed when no more needed. If the
5181  * given node is not added to any image, this returns NULL.
5182  * @since 0.6.4
5183  */
5184 char *iso_tree_get_node_path(IsoNode *node);
5185 
5186 /**
5187  * Get the destination node of a symbolic link within the IsoImage.
5188  *
5189  * @param img
5190  * The image wherein to try resolving the link.
5191  * @param sym
5192  * The symbolic link node which to resolve.
5193  * @param res
5194  * Will return the found destination node, in case of success.
5195  * Call iso_node_ref() / iso_node_unref() if you intend to use the node
5196  * over API calls which might in any event delete it.
5197  * @param depth
5198  * Prevents endless loops. Submit as 0.
5199  * @param flag
5200  * Bitfield for control purposes. Submit 0 for now.
5201  * @return
5202  * 1 on success,
5203  * < 0 on failure, especially ISO_DEEP_SYMLINK and ISO_DEAD_SYMLINK
5204  *
5205  * @since 1.2.4
5206  */
5207 int iso_tree_resolve_symlink(IsoImage *img, IsoSymlink *sym, IsoNode **res,
5208  int *depth, int flag);
5209 
5210 /* Maximum number link resolution steps before ISO_DEEP_SYMLINK gets
5211  * returned by iso_tree_resolve_symlink().
5212  *
5213  * @since 1.2.4
5214 */
5215 #define LIBISO_MAX_LINK_DEPTH 100
5216 
5217 /**
5218  * Increments the reference counting of the given IsoDataSource.
5219  *
5220  * @since 0.6.2
5221  */
5223 
5224 /**
5225  * Decrements the reference counting of the given IsoDataSource, freeing it
5226  * if refcount reach 0.
5227  *
5228  * @since 0.6.2
5229  */
5231 
5232 /**
5233  * Create a new IsoDataSource from a local file. This is suitable for
5234  * accessing regular files or block devices with ISO images.
5235  *
5236  * @param path
5237  * The absolute path of the file
5238  * @param src
5239  * Will be filled with the pointer to the newly created data source.
5240  * @return
5241  * 1 on success, < 0 on error.
5242  *
5243  * @since 0.6.2
5244  */
5245 int iso_data_source_new_from_file(const char *path, IsoDataSource **src);
5246 
5247 /**
5248  * Get the status of the buffer used by a burn_source.
5249  *
5250  * @param b
5251  * A burn_source previously obtained with
5252  * iso_image_create_burn_source().
5253  * @param size
5254  * Will be filled with the total size of the buffer, in bytes
5255  * @param free_bytes
5256  * Will be filled with the bytes currently available in buffer
5257  * @return
5258  * < 0 error, > 0 state:
5259  * 1="active" : input and consumption are active
5260  * 2="ending" : input has ended without error
5261  * 3="failing" : input had error and ended,
5262  * 5="abandoned" : consumption has ended prematurely
5263  * 6="ended" : consumption has ended without input error
5264  * 7="aborted" : consumption has ended after input error
5265  *
5266  * @since 0.6.2
5267  */
5268 int iso_ring_buffer_get_status(struct burn_source *b, size_t *size,
5269  size_t *free_bytes);
5270 
5271 #define ISO_MSGS_MESSAGE_LEN 4096
5272 
5273 /**
5274  * Control queueing and stderr printing of messages from libisofs.
5275  * Severity may be one of "NEVER", "FATAL", "SORRY", "WARNING", "HINT",
5276  * "NOTE", "UPDATE", "DEBUG", "ALL".
5277  *
5278  * @param queue_severity Gives the minimum limit for messages to be queued.
5279  * Default: "NEVER". If you queue messages then you
5280  * must consume them by iso_msgs_obtain().
5281  * @param print_severity Does the same for messages to be printed directly
5282  * to stderr.
5283  * @param print_id A text prefix to be printed before the message.
5284  * @return >0 for success, <=0 for error
5285  *
5286  * @since 0.6.2
5287  */
5288 int iso_set_msgs_severities(char *queue_severity, char *print_severity,
5289  char *print_id);
5290 
5291 /**
5292  * Obtain the oldest pending libisofs message from the queue which has at
5293  * least the given minimum_severity. This message and any older message of
5294  * lower severity will get discarded from the queue and is then lost forever.
5295  *
5296  * Severity may be one of "NEVER", "FATAL", "SORRY", "WARNING", "HINT",
5297  * "NOTE", "UPDATE", "DEBUG", "ALL". To call with minimum_severity "NEVER"
5298  * will discard the whole queue.
5299  *
5300  * @param minimum_severity
5301  * Threshhold
5302  * @param error_code
5303  * Will become a unique error code as listed at the end of this header
5304  * @param imgid
5305  * Id of the image that was issued the message.
5306  * @param msg_text
5307  * Must provide at least ISO_MSGS_MESSAGE_LEN bytes.
5308  * @param severity
5309  * Will become the severity related to the message and should provide at
5310  * least 80 bytes.
5311  * @return
5312  * 1 if a matching item was found, 0 if not, <0 for severe errors
5313  *
5314  * @since 0.6.2
5315  */
5316 int iso_obtain_msgs(char *minimum_severity, int *error_code, int *imgid,
5317  char msg_text[], char severity[]);
5318 
5319 
5320 /**
5321  * Submit a message to the libisofs queueing system. It will be queued or
5322  * printed as if it was generated by libisofs itself.
5323  *
5324  * @param error_code
5325  * The unique error code of your message.
5326  * Submit 0 if you do not have reserved error codes within the libburnia
5327  * project.
5328  * @param msg_text
5329  * Not more than ISO_MSGS_MESSAGE_LEN characters of message text.
5330  * @param os_errno
5331  * Eventual errno related to the message. Submit 0 if the message is not
5332  * related to a operating system error.
5333  * @param severity
5334  * One of "ABORT", "FATAL", "FAILURE", "SORRY", "WARNING", "HINT", "NOTE",
5335  * "UPDATE", "DEBUG". Defaults to "FATAL".
5336  * @param origin
5337  * Submit 0 for now.
5338  * @return
5339  * 1 if message was delivered, <=0 if failure
5340  *
5341  * @since 0.6.4
5342  */
5343 int iso_msgs_submit(int error_code, char msg_text[], int os_errno,
5344  char severity[], int origin);
5345 
5346 
5347 /**
5348  * Convert a severity name into a severity number, which gives the severity
5349  * rank of the name.
5350  *
5351  * @param severity_name
5352  * A name as with iso_msgs_submit(), e.g. "SORRY".
5353  * @param severity_number
5354  * The rank number: the higher, the more severe.
5355  * @return
5356  * >0 success, <=0 failure
5357  *
5358  * @since 0.6.4
5359  */
5360 int iso_text_to_sev(char *severity_name, int *severity_number);
5361 
5362 
5363 /**
5364  * Convert a severity number into a severity name
5365  *
5366  * @param severity_number
5367  * The rank number: the higher, the more severe.
5368  * @param severity_name
5369  * A name as with iso_msgs_submit(), e.g. "SORRY".
5370  *
5371  * @since 0.6.4
5372  */
5373 int iso_sev_to_text(int severity_number, char **severity_name);
5374 
5375 
5376 /**
5377  * Get the id of an IsoImage, used for message reporting. This message id,
5378  * retrieved with iso_obtain_msgs(), can be used to distinguish what
5379  * IsoImage has isssued a given message.
5380  *
5381  * @since 0.6.2
5382  */
5383 int iso_image_get_msg_id(IsoImage *image);
5384 
5385 /**
5386  * Get a textual description of a libisofs error.
5387  *
5388  * @since 0.6.2
5389  */
5390 const char *iso_error_to_msg(int errcode);
5391 
5392 /**
5393  * Get the severity of a given error code
5394  * @return
5395  * 0x10000000 -> DEBUG
5396  * 0x20000000 -> UPDATE
5397  * 0x30000000 -> NOTE
5398  * 0x40000000 -> HINT
5399  * 0x50000000 -> WARNING
5400  * 0x60000000 -> SORRY
5401  * 0x64000000 -> MISHAP
5402  * 0x68000000 -> FAILURE
5403  * 0x70000000 -> FATAL
5404  * 0x71000000 -> ABORT
5405  *
5406  * @since 0.6.2
5407  */
5408 int iso_error_get_severity(int e);
5409 
5410 /**
5411  * Get the priority of a given error.
5412  * @return
5413  * 0x00000000 -> ZERO
5414  * 0x10000000 -> LOW
5415  * 0x20000000 -> MEDIUM
5416  * 0x30000000 -> HIGH
5417  *
5418  * @since 0.6.2
5419  */
5420 int iso_error_get_priority(int e);
5421 
5422 /**
5423  * Get the message queue code of a libisofs error.
5424  */
5425 int iso_error_get_code(int e);
5426 
5427 /**
5428  * Set the minimum error severity that causes a libisofs operation to
5429  * be aborted as soon as possible.
5430  *
5431  * @param severity
5432  * one of "FAILURE", "MISHAP", "SORRY", "WARNING", "HINT", "NOTE".
5433  * Severities greater or equal than FAILURE always cause program to abort.
5434  * Severities under NOTE won't never cause function abort.
5435  * @return
5436  * Previous abort priority on success, < 0 on error.
5437  *
5438  * @since 0.6.2
5439  */
5440 int iso_set_abort_severity(char *severity);
5441 
5442 /**
5443  * Return the messenger object handle used by libisofs. This handle
5444  * may be used by related libraries to their own compatible
5445  * messenger objects and thus to direct their messages to the libisofs
5446  * message queue. See also: libburn, API function burn_set_messenger().
5447  *
5448  * @return the handle. Do only use with compatible
5449  *
5450  * @since 0.6.2
5451  */
5452 void *iso_get_messenger();
5453 
5454 /**
5455  * Take a ref to the given IsoFileSource.
5456  *
5457  * @since 0.6.2
5458  */
5460 
5461 /**
5462  * Drop your ref to the given IsoFileSource, eventually freeing the associated
5463  * system resources.
5464  *
5465  * @since 0.6.2
5466  */
5468 
5469 /*
5470  * this are just helpers to invoque methods in class
5471  */
5472 
5473 /**
5474  * Get the absolute path in the filesystem this file source belongs to.
5475  *
5476  * @return
5477  * the path of the FileSource inside the filesystem, it should be
5478  * freed when no more needed.
5479  *
5480  * @since 0.6.2
5481  */
5483 
5484 /**
5485  * Get the name of the file, with the dir component of the path.
5486  *
5487  * @return
5488  * the name of the file, it should be freed when no more needed.
5489  *
5490  * @since 0.6.2
5491  */
5493 
5494 /**
5495  * Get information about the file.
5496  * @return
5497  * 1 success, < 0 error
5498  * Error codes:
5499  * ISO_FILE_ACCESS_DENIED
5500  * ISO_FILE_BAD_PATH
5501  * ISO_FILE_DOESNT_EXIST
5502  * ISO_OUT_OF_MEM
5503  * ISO_FILE_ERROR
5504  * ISO_NULL_POINTER
5505  *
5506  * @since 0.6.2
5507  */
5508 int iso_file_source_lstat(IsoFileSource *src, struct stat *info);
5509 
5510 /**
5511  * Check if the process has access to read file contents. Note that this
5512  * is not necessarily related with (l)stat functions. For example, in a
5513  * filesystem implementation to deal with an ISO image, if the user has
5514  * read access to the image it will be able to read all files inside it,
5515  * despite of the particular permission of each file in the RR tree, that
5516  * are what the above functions return.
5517  *
5518  * @return
5519  * 1 if process has read access, < 0 on error
5520  * Error codes:
5521  * ISO_FILE_ACCESS_DENIED
5522  * ISO_FILE_BAD_PATH
5523  * ISO_FILE_DOESNT_EXIST
5524  * ISO_OUT_OF_MEM
5525  * ISO_FILE_ERROR
5526  * ISO_NULL_POINTER
5527  *
5528  * @since 0.6.2
5529  */
5531 
5532 /**
5533  * Get information about the file. If the file is a symlink, the info
5534  * returned refers to the destination.
5535  *
5536  * @return
5537  * 1 success, < 0 error
5538  * Error codes:
5539  * ISO_FILE_ACCESS_DENIED
5540  * ISO_FILE_BAD_PATH
5541  * ISO_FILE_DOESNT_EXIST
5542  * ISO_OUT_OF_MEM
5543  * ISO_FILE_ERROR
5544  * ISO_NULL_POINTER
5545  *
5546  * @since 0.6.2
5547  */
5548 int iso_file_source_stat(IsoFileSource *src, struct stat *info);
5549 
5550 /**
5551  * Opens the source.
5552  * @return 1 on success, < 0 on error
5553  * Error codes:
5554  * ISO_FILE_ALREADY_OPENED
5555  * ISO_FILE_ACCESS_DENIED
5556  * ISO_FILE_BAD_PATH
5557  * ISO_FILE_DOESNT_EXIST
5558  * ISO_OUT_OF_MEM
5559  * ISO_FILE_ERROR
5560  * ISO_NULL_POINTER
5561  *
5562  * @since 0.6.2
5563  */
5565 
5566 /**
5567  * Close a previuously openned file
5568  * @return 1 on success, < 0 on error
5569  * Error codes:
5570  * ISO_FILE_ERROR
5571  * ISO_NULL_POINTER
5572  * ISO_FILE_NOT_OPENED
5573  *
5574  * @since 0.6.2
5575  */
5577 
5578 /**
5579  * Attempts to read up to count bytes from the given source into
5580  * the buffer starting at buf.
5581  *
5582  * The file src must be open() before calling this, and close() when no
5583  * more needed. Not valid for dirs. On symlinks it reads the destination
5584  * file.
5585  *
5586  * @param src
5587  * The given source
5588  * @param buf
5589  * Pointer to a buffer of at least count bytes where the read data will be
5590  * stored
5591  * @param count
5592  * Bytes to read
5593  * @return
5594  * number of bytes read, 0 if EOF, < 0 on error
5595  * Error codes:
5596  * ISO_FILE_ERROR
5597  * ISO_NULL_POINTER
5598  * ISO_FILE_NOT_OPENED
5599  * ISO_WRONG_ARG_VALUE -> if count == 0
5600  * ISO_FILE_IS_DIR
5601  * ISO_OUT_OF_MEM
5602  * ISO_INTERRUPTED
5603  *
5604  * @since 0.6.2
5605  */
5606 int iso_file_source_read(IsoFileSource *src, void *buf, size_t count);
5607 
5608 /**
5609  * Repositions the offset of the given IsoFileSource (must be opened) to the
5610  * given offset according to the value of flag.
5611  *
5612  * @param src
5613  * The given source
5614  * @param offset
5615  * in bytes
5616  * @param flag
5617  * 0 The offset is set to offset bytes (SEEK_SET)
5618  * 1 The offset is set to its current location plus offset bytes
5619  * (SEEK_CUR)
5620  * 2 The offset is set to the size of the file plus offset bytes
5621  * (SEEK_END).
5622  * @return
5623  * Absolute offset posistion on the file, or < 0 on error. Cast the
5624  * returning value to int to get a valid libisofs error.
5625  * @since 0.6.4
5626  */
5627 off_t iso_file_source_lseek(IsoFileSource *src, off_t offset, int flag);
5628 
5629 /**
5630  * Read a directory.
5631  *
5632  * Each call to this function will return a new child, until we reach
5633  * the end of file (i.e, no more children), in that case it returns 0.
5634  *
5635  * The dir must be open() before calling this, and close() when no more
5636  * needed. Only valid for dirs.
5637  *
5638  * Note that "." and ".." children MUST NOT BE returned.
5639  *
5640  * @param src
5641  * The given source
5642  * @param child
5643  * pointer to be filled with the given child. Undefined on error or OEF
5644  * @return
5645  * 1 on success, 0 if EOF (no more children), < 0 on error
5646  * Error codes:
5647  * ISO_FILE_ERROR
5648  * ISO_NULL_POINTER
5649  * ISO_FILE_NOT_OPENED
5650  * ISO_FILE_IS_NOT_DIR
5651  * ISO_OUT_OF_MEM
5652  *
5653  * @since 0.6.2
5654  */
5656 
5657 /**
5658  * Read the destination of a symlink. You don't need to open the file
5659  * to call this.
5660  *
5661  * @param src
5662  * An IsoFileSource corresponding to a symbolic link.
5663  * @param buf
5664  * Allocated buffer of at least bufsiz bytes.
5665  * The destination string will be copied there, and it will be 0-terminated
5666  * if the return value indicates success or ISO_RR_PATH_TOO_LONG.
5667  * @param bufsiz
5668  * Maximum number of buf characters + 1. The string will be truncated if
5669  * it is larger than bufsiz - 1 and ISO_RR_PATH_TOO_LONG. will be returned.
5670  * @return
5671  * 1 on success, < 0 on error
5672  * Error codes:
5673  * ISO_FILE_ERROR
5674  * ISO_NULL_POINTER
5675  * ISO_WRONG_ARG_VALUE -> if bufsiz <= 0
5676  * ISO_FILE_IS_NOT_SYMLINK
5677  * ISO_OUT_OF_MEM
5678  * ISO_FILE_BAD_PATH
5679  * ISO_FILE_DOESNT_EXIST
5680  * ISO_RR_PATH_TOO_LONG (@since 1.0.6)
5681  *
5682  * @since 0.6.2
5683  */
5684 int iso_file_source_readlink(IsoFileSource *src, char *buf, size_t bufsiz);
5685 
5686 
5687 /**
5688  * Get the AAIP string with encoded ACL and xattr.
5689  * (Not to be confused with ECMA-119 Extended Attributes).
5690  * @param src The file source object to be inquired.
5691  * @param aa_string Returns a pointer to the AAIP string data. If no AAIP
5692  * string is available, *aa_string becomes NULL.
5693  * (See doc/susp_aaip_2_0.txt for the meaning of AAIP.)
5694  * The caller is responsible for finally calling free()
5695  * on non-NULL results.
5696  * @param flag Bitfield for control purposes
5697  * bit0= Transfer ownership of AAIP string data.
5698  * src will free the eventual cached data and might
5699  * not be able to produce it again.
5700  * bit1= No need to get ACL (but no guarantee of exclusion)
5701  * bit2= No need to get xattr (but no guarantee of exclusion)
5702  * @return 1 means success (*aa_string == NULL is possible)
5703  * <0 means failure and must b a valid libisofs error code
5704  * (e.g. ISO_FILE_ERROR if no better one can be found).
5705  * @since 0.6.14
5706  */
5708  unsigned char **aa_string, int flag);
5709 
5710 /**
5711  * Get the filesystem for this source. No extra ref is added, so you
5712  * musn't unref the IsoFilesystem.
5713  *
5714  * @return
5715  * The filesystem, NULL on error
5716  *
5717  * @since 0.6.2
5718  */
5720 
5721 /**
5722  * Take a ref to the given IsoFilesystem
5723  *
5724  * @since 0.6.2
5725  */
5727 
5728 /**
5729  * Drop your ref to the given IsoFilesystem, evetually freeing associated
5730  * resources.
5731  *
5732  * @since 0.6.2
5733  */
5735 
5736 /**
5737  * Create a new IsoFilesystem to access a existent ISO image.
5738  *
5739  * @param src
5740  * Data source to access data.
5741  * @param opts
5742  * Image read options
5743  * @param msgid
5744  * An image identifer, obtained with iso_image_get_msg_id(), used to
5745  * associated messages issued by the filesystem implementation with an
5746  * existent image. If you are not using this filesystem in relation with
5747  * any image context, just use 0x1fffff as the value for this parameter.
5748  * @param fs
5749  * Will be filled with a pointer to the filesystem that can be used
5750  * to access image contents.
5751  * @param
5752  * 1 on success, < 0 on error
5753  *
5754  * @since 0.6.2
5755  */
5756 int iso_image_filesystem_new(IsoDataSource *src, IsoReadOpts *opts, int msgid,
5757  IsoImageFilesystem **fs);
5758 
5759 /**
5760  * Get the volset identifier for an existent image. The returned string belong
5761  * to the IsoImageFilesystem and shouldn't be free() nor modified.
5762  *
5763  * @since 0.6.2
5764  */
5766 
5767 /**
5768  * Get the volume identifier for an existent image. The returned string belong
5769  * to the IsoImageFilesystem and shouldn't be free() nor modified.
5770  *
5771  * @since 0.6.2
5772  */
5774 
5775 /**
5776  * Get the publisher identifier for an existent image. The returned string
5777  * belong to the IsoImageFilesystem and shouldn't be free() nor modified.
5778  *
5779  * @since 0.6.2
5780  */
5782 
5783 /**
5784  * Get the data preparer identifier for an existent image. The returned string
5785  * belong to the IsoImageFilesystem and shouldn't be free() nor modified.
5786  *
5787  * @since 0.6.2
5788  */
5790 
5791 /**
5792  * Get the system identifier for an existent image. The returned string belong
5793  * to the IsoImageFilesystem and shouldn't be free() nor modified.
5794  *
5795  * @since 0.6.2
5796  */
5798 
5799 /**
5800  * Get the application identifier for an existent image. The returned string
5801  * belong to the IsoImageFilesystem and shouldn't be free() nor modified.
5802  *
5803  * @since 0.6.2
5804  */
5806 
5807 /**
5808  * Get the copyright file identifier for an existent image. The returned string
5809  * belong to the IsoImageFilesystem and shouldn't be free() nor modified.
5810  *
5811  * @since 0.6.2
5812  */
5814 
5815 /**
5816  * Get the abstract file identifier for an existent image. The returned string
5817  * belong to the IsoImageFilesystem and shouldn't be free() nor modified.
5818  *
5819  * @since 0.6.2
5820  */
5822 
5823 /**
5824  * Get the biblio file identifier for an existent image. The returned string
5825  * belong to the IsoImageFilesystem and shouldn't be free() nor modified.
5826  *
5827  * @since 0.6.2
5828  */
5830 
5831 /**
5832  * Increment reference count of an IsoStream.
5833  *
5834  * @since 0.6.4
5835  */
5836 void iso_stream_ref(IsoStream *stream);
5837 
5838 /**
5839  * Decrement reference count of an IsoStream, and eventually free it if
5840  * refcount reach 0.
5841  *
5842  * @since 0.6.4
5843  */
5844 void iso_stream_unref(IsoStream *stream);
5845 
5846 /**
5847  * Opens the given stream. Remember to close the Stream before writing the
5848  * image.
5849  *
5850  * @return
5851  * 1 on success, 2 file greater than expected, 3 file smaller than
5852  * expected, < 0 on error
5853  *
5854  * @since 0.6.4
5855  */
5856 int iso_stream_open(IsoStream *stream);
5857 
5858 /**
5859  * Close a previously openned IsoStream.
5860  *
5861  * @return
5862  * 1 on success, < 0 on error
5863  *
5864  * @since 0.6.4
5865  */
5866 int iso_stream_close(IsoStream *stream);
5867 
5868 /**
5869  * Get the size of a given stream. This function should always return the same
5870  * size, even if the underlying source size changes, unless you call
5871  * iso_stream_update_size().
5872  *
5873  * @return
5874  * IsoStream size in bytes
5875  *
5876  * @since 0.6.4
5877  */
5878 off_t iso_stream_get_size(IsoStream *stream);
5879 
5880 /**
5881  * Attempts to read up to count bytes from the given stream into
5882  * the buffer starting at buf.
5883  *
5884  * The stream must be open() before calling this, and close() when no
5885  * more needed.
5886  *
5887  * @return
5888  * number of bytes read, 0 if EOF, < 0 on error
5889  *
5890  * @since 0.6.4
5891  */
5892 int iso_stream_read(IsoStream *stream, void *buf, size_t count);
5893 
5894 /**
5895  * Whether the given IsoStream can be read several times, with the same
5896  * results.
5897  * For example, a regular file is repeatable, you can read it as many
5898  * times as you want. However, a pipe isn't.
5899  *
5900  * This function doesn't take into account if the file has been modified
5901  * between the two reads.
5902  *
5903  * @return
5904  * 1 if stream is repeatable, 0 if not, < 0 on error
5905  *
5906  * @since 0.6.4
5907  */
5908 int iso_stream_is_repeatable(IsoStream *stream);
5909 
5910 /**
5911  * Updates the size of the IsoStream with the current size of the
5912  * underlying source.
5913  *
5914  * @return
5915  * 1 if ok, < 0 on error (has to be a valid libisofs error code),
5916  * 0 if the IsoStream does not support this function.
5917  * @since 0.6.8
5918  */
5919 int iso_stream_update_size(IsoStream *stream);
5920 
5921 /**
5922  * Get an unique identifier for a given IsoStream.
5923  *
5924  * @since 0.6.4
5925  */
5926 void iso_stream_get_id(IsoStream *stream, unsigned int *fs_id, dev_t *dev_id,
5927  ino_t *ino_id);
5928 
5929 /**
5930  * Try to get eventual source path string of a stream. Meaning and availability
5931  * of this string depends on the stream.class . Expect valid results with
5932  * types "fsrc" and "cout". Result formats are
5933  * fsrc: result of file_source_get_path()
5934  * cout: result of file_source_get_path() " " offset " " size
5935  * @param stream
5936  * The stream to be inquired.
5937  * @param flag
5938  * Bitfield for control purposes, unused yet, submit 0
5939  * @return
5940  * A copy of the path string. Apply free() when no longer needed.
5941  * NULL if no path string is available.
5942  *
5943  * @since 0.6.18
5944  */
5945 char *iso_stream_get_source_path(IsoStream *stream, int flag);
5946 
5947 /**
5948  * Compare two streams whether they are based on the same input and will
5949  * produce the same output. If in any doubt, then this comparison will
5950  * indicate no match.
5951  *
5952  * @param s1
5953  * The first stream to compare.
5954  * @param s2
5955  * The second stream to compare.
5956  * @return
5957  * -1 if s1 is smaller s2 , 0 if s1 matches s2 , 1 if s1 is larger s2
5958  * @param flag
5959  * bit0= do not use s1->class->compare() even if available
5960  * (e.g. because iso_stream_cmp_ino(0 is called as fallback
5961  * from said stream->class->compare())
5962  *
5963  * @since 0.6.20
5964  */
5965 int iso_stream_cmp_ino(IsoStream *s1, IsoStream *s2, int flag);
5966 
5967 
5968 /**
5969  * Produce a copy of a stream. It must be possible to operate both stream
5970  * objects concurrently. The success of this function depends on the
5971  * existence of a IsoStream_Iface.clone_stream() method with the stream
5972  * and with its eventual subordinate streams.
5973  * See iso_tree_clone() for a list of surely clonable built-in streams.
5974  *
5975  * @param old_stream
5976  * The existing stream object to be copied
5977  * @param new_stream
5978  * Will return a pointer to the copy
5979  * @param flag
5980  * Bitfield for control purposes. Submit 0 for now.
5981  * @return
5982  * >0 means success
5983  * ISO_STREAM_NO_CLONE is issued if no .clone_stream() exists
5984  * other error return values < 0 may occur depending on kind of stream
5985  *
5986  * @since 1.0.2
5987  */
5988 int iso_stream_clone(IsoStream *old_stream, IsoStream **new_stream, int flag);
5989 
5990 
5991 /* --------------------------------- AAIP --------------------------------- */
5992 
5993 /**
5994  * Function to identify and manage AAIP strings as xinfo of IsoNode.
5995  *
5996  * An AAIP string contains the Attribute List with the xattr and ACL of a node
5997  * in the image tree. It is formatted according to libisofs specification
5998  * AAIP-2.0 and ready to be written into the System Use Area resp. Continuation
5999  * Area of a directory entry in an ISO image.
6000  *
6001  * Applications are not supposed to manipulate AAIP strings directly.
6002  * They should rather make use of the appropriate iso_node_get_* and
6003  * iso_node_set_* calls.
6004  *
6005  * AAIP represents ACLs as xattr with empty name and AAIP-specific binary
6006  * content. Local filesystems may represent ACLs as xattr with names like
6007  * "system.posix_acl_access". libisofs does not interpret those local
6008  * xattr representations of ACL directly but rather uses the ACL interface of
6009  * the local system. By default the local xattr representations of ACL will
6010  * not become part of the AAIP Attribute List via iso_local_get_attrs() and
6011  * not be attached to local files via iso_local_set_attrs().
6012  *
6013  * @since 0.6.14
6014  */
6015 int aaip_xinfo_func(void *data, int flag);
6016 
6017 /**
6018  * The iso_node_xinfo_cloner function which gets associated to aaip_xinfo_func
6019  * by iso_init() resp. iso_init_with_flag() via iso_node_xinfo_make_clonable().
6020  * @since 1.0.2
6021  */
6022 int aaip_xinfo_cloner(void *old_data, void **new_data, int flag);
6023 
6024 /**
6025  * Get the eventual ACLs which are associated with the node.
6026  * The result will be in "long" text form as of man acl resp. acl_to_text().
6027  * Call this function with flag bit15 to finally release the memory
6028  * occupied by an ACL inquiry.
6029  *
6030  * @param node
6031  * The node that is to be inquired.
6032  * @param access_text
6033  * Will return a pointer to the eventual "access" ACL text or NULL if it
6034  * is not available and flag bit 4 is set.
6035  * @param default_text
6036  * Will return a pointer to the eventual "default" ACL or NULL if it
6037  * is not available.
6038  * (GNU/Linux directories can have a "default" ACL which influences
6039  * the permissions of newly created files.)
6040  * @param flag
6041  * Bitfield for control purposes
6042  * bit4= if no "access" ACL is available: return *access_text == NULL
6043  * else: produce ACL from stat(2) permissions
6044  * bit15= free memory and return 1 (node may be NULL)
6045  * @return
6046  * 2 *access_text was produced from stat(2) permissions
6047  * 1 *access_text was produced from ACL of node
6048  * 0 if flag bit4 is set and no ACL is available
6049  * < 0 on error
6050  *
6051  * @since 0.6.14
6052  */
6053 int iso_node_get_acl_text(IsoNode *node,
6054  char **access_text, char **default_text, int flag);
6055 
6056 
6057 /**
6058  * Set the ACLs of the given node to the lists in parameters access_text and
6059  * default_text or delete them.
6060  *
6061  * The stat(2) permission bits get updated according to the new "access" ACL if
6062  * neither bit1 of parameter flag is set nor parameter access_text is NULL.
6063  * Note that S_IRWXG permission bits correspond to ACL mask permissions
6064  * if a "mask::" entry exists in the ACL. Only if there is no "mask::" then
6065  * the "group::" entry corresponds to to S_IRWXG.
6066  *
6067  * @param node
6068  * The node that is to be manipulated.
6069  * @param access_text
6070  * The text to be set into effect as "access" ACL. NULL will delete an
6071  * eventually existing "access" ACL of the node.
6072  * @param default_text
6073  * The text to be set into effect as "default" ACL. NULL will delete an
6074  * eventually existing "default" ACL of the node.
6075  * (GNU/Linux directories can have a "default" ACL which influences
6076  * the permissions of newly created files.)
6077  * @param flag
6078  * Bitfield for control purposes
6079  * bit1= ignore text parameters but rather update eventual "access" ACL
6080  * to the stat(2) permissions of node. If no "access" ACL exists,
6081  * then do nothing and return success.
6082  * @return
6083  * > 0 success
6084  * < 0 failure
6085  *
6086  * @since 0.6.14
6087  */
6088 int iso_node_set_acl_text(IsoNode *node,
6089  char *access_text, char *default_text, int flag);
6090 
6091 /**
6092  * Like iso_node_get_permissions but reflecting ACL entry "group::" in S_IRWXG
6093  * rather than ACL entry "mask::". This is necessary if the permissions of a
6094  * node with ACL shall be restored to a filesystem without restoring the ACL.
6095  * The same mapping happens internally when the ACL of a node is deleted.
6096  * If the node has no ACL then the result is iso_node_get_permissions(node).
6097  * @param node
6098  * The node that is to be inquired.
6099  * @return
6100  * Permission bits as of stat(2)
6101  *
6102  * @since 0.6.14
6103  */
6104 mode_t iso_node_get_perms_wo_acl(const IsoNode *node);
6105 
6106 
6107 /**
6108  * Get the list of xattr which is associated with the node.
6109  * The resulting data may finally be disposed by a call to this function
6110  * with flag bit15 set, or its components may be freed one-by-one.
6111  * The following values are either NULL or malloc() memory:
6112  * *names, *value_lengths, *values, (*names)[i], (*values)[i]
6113  * with 0 <= i < *num_attrs.
6114  * It is allowed to replace or reallocate those memory items in order to
6115  * to manipulate the attribute list before submitting it to other calls.
6116  *
6117  * If enabled by flag bit0, this list possibly includes the ACLs of the node.
6118  * They are eventually encoded in a pair with empty name. It is not advisable
6119  * to alter the value or name of that pair. One may decide to erase both ACLs
6120  * by deleting this pair or to copy both ACLs by copying the content of this
6121  * pair to an empty named pair of another node.
6122  * For all other ACL purposes use iso_node_get_acl_text().
6123  *
6124  * @param node
6125  * The node that is to be inquired.
6126  * @param num_attrs
6127  * Will return the number of name-value pairs
6128  * @param names
6129  * Will return an array of pointers to 0-terminated names
6130  * @param value_lengths
6131  * Will return an arry with the lenghts of values
6132  * @param values
6133  * Will return an array of pointers to strings of 8-bit bytes
6134  * @param flag
6135  * Bitfield for control purposes
6136  * bit0= obtain eventual ACLs as attribute with empty name
6137  * bit2= with bit0: do not obtain attributes other than ACLs
6138  * bit15= free memory (node may be NULL)
6139  * @return
6140  * 1 = ok (but *num_attrs may be 0)
6141  * < 0 = error
6142  *
6143  * @since 0.6.14
6144  */
6145 int iso_node_get_attrs(IsoNode *node, size_t *num_attrs,
6146  char ***names, size_t **value_lengths, char ***values, int flag);
6147 
6148 
6149 /**
6150  * Obtain the value of a particular xattr name. Eventually make a copy of
6151  * that value and add a trailing 0 byte for caller convenience.
6152  * @param node
6153  * The node that is to be inquired.
6154  * @param name
6155  * The xattr name that shall be looked up.
6156  * @param value_length
6157  * Will return the lenght of value
6158  * @param value
6159  * Will return a string of 8-bit bytes. free() it when no longer needed.
6160  * @param flag
6161  * Bitfield for control purposes, unused yet, submit 0
6162  * @return
6163  * 1= name found , 0= name not found , <0 indicates error
6164  *
6165  * @since 0.6.18
6166  */
6167 int iso_node_lookup_attr(IsoNode *node, char *name,
6168  size_t *value_length, char **value, int flag);
6169 
6170 /**
6171  * Set the list of xattr which is associated with the node.
6172  * The data get copied so that you may dispose your input data afterwards.
6173  *
6174  * If enabled by flag bit0 then the submitted list of attributes will not only
6175  * overwrite xattr but also both eventual ACLs of the node. Eventual ACL in
6176  * the submitted list have to reside in an attribute with empty name.
6177  *
6178  * @param node
6179  * The node that is to be manipulated.
6180  * @param num_attrs
6181  * Number of attributes
6182  * @param names
6183  * Array of pointers to 0 terminated name strings
6184  * @param value_lengths
6185  * Array of byte lengths for each value
6186  * @param values
6187  * Array of pointers to the value bytes
6188  * @param flag
6189  * Bitfield for control purposes
6190  * bit0= Do not maintain eventual existing ACL of the node.
6191  * Set eventual new ACL from value of empty name.
6192  * bit1= Do not clear the existing attribute list but merge it with
6193  * the list given by this call.
6194  * The given values override the values of their eventually existing
6195  * names. If no xattr with a given name exists, then it will be
6196  * added as new xattr. So this bit can be used to set a single
6197  * xattr without inquiring any other xattr of the node.
6198  * bit2= Delete the attributes with the given names
6199  * bit3= Allow to affect non-user attributes.
6200  * I.e. those with a non-empty name which does not begin by "user."
6201  * (The empty name is always allowed and governed by bit0.) This
6202  * deletes all previously existing attributes if not bit1 is set.
6203  * bit4= Do not affect attributes from namespace "isofs".
6204  * To be combined with bit3 for copying attributes from local
6205  * filesystem to ISO image.
6206  * @since 1.2.4
6207  * @return
6208  * 1 = ok
6209  * < 0 = error
6210  *
6211  * @since 0.6.14
6212  */
6213 int iso_node_set_attrs(IsoNode *node, size_t num_attrs, char **names,
6214  size_t *value_lengths, char **values, int flag);
6215 
6216 
6217 /* ----- This is an interface to ACL and xattr of the local filesystem ----- */
6218 
6219 /**
6220  * libisofs has an internal system dependent adapter to ACL and xattr
6221  * operations. For the sake of completeness and simplicity it exposes this
6222  * functionality to its applications which might want to get and set ACLs
6223  * from local files.
6224  */
6225 
6226 /**
6227  * Inquire whether local filesystem operations with ACL or xattr are enabled
6228  * inside libisofs. They may be disabled because of compile time decisions.
6229  * E.g. because the operating system does not support these features or
6230  * because libisofs has not yet an adapter to use them.
6231  *
6232  * @param flag
6233  * Bitfield for control purposes
6234  * bit0= inquire availability of ACL
6235  * bit1= inquire availability of xattr
6236  * bit2 - bit7= Reserved for future types.
6237  * It is permissibile to set them to 1 already now.
6238  * bit8 and higher: reserved, submit 0
6239  * @return
6240  * Bitfield corresponding to flag. If bits are set, th
6241  * bit0= ACL adapter is enabled
6242  * bit1= xattr adapter is enabled
6243  * bit2 - bit7= Reserved for future types.
6244  * bit8 and higher: reserved, do not interpret these
6245  *
6246  * @since 1.1.6
6247  */
6248 int iso_local_attr_support(int flag);
6249 
6250 /**
6251  * Get an ACL of the given file in the local filesystem in long text form.
6252  *
6253  * @param disk_path
6254  * Absolute path to the file
6255  * @param text
6256  * Will return a pointer to the ACL text. If not NULL the text will be
6257  * 0 terminated and finally has to be disposed by a call to this function
6258  * with bit15 set.
6259  * @param flag
6260  * Bitfield for control purposes
6261  * bit0= get "default" ACL rather than "access" ACL
6262  * bit4= set *text = NULL and return 2
6263  * if the ACL matches st_mode permissions.
6264  * bit5= in case of symbolic link: inquire link target
6265  * bit15= free text and return 1
6266  * @return
6267  * 1 ok
6268  * 2 ok, trivial ACL found while bit4 is set, *text is NULL
6269  * 0 no ACL manipulation adapter available / ACL not supported on fs
6270  * -1 failure of system ACL service (see errno)
6271  * -2 attempt to inquire ACL of a symbolic link without bit4 or bit5
6272  * resp. with no suitable link target
6273  *
6274  * @since 0.6.14
6275  */
6276 int iso_local_get_acl_text(char *disk_path, char **text, int flag);
6277 
6278 
6279 /**
6280  * Set the ACL of the given file in the local filesystem to a given list
6281  * in long text form.
6282  *
6283  * @param disk_path
6284  * Absolute path to the file
6285  * @param text
6286  * The input text (0 terminated, ACL long text form)
6287  * @param flag
6288  * Bitfield for control purposes
6289  * bit0= set "default" ACL rather than "access" ACL
6290  * bit5= in case of symbolic link: manipulate link target
6291  * @return
6292  * > 0 ok
6293  * 0 no ACL manipulation adapter available for desired ACL type
6294  * -1 failure of system ACL service (see errno)
6295  * -2 attempt to manipulate ACL of a symbolic link without bit5
6296  * resp. with no suitable link target
6297  *
6298  * @since 0.6.14
6299  */
6300 int iso_local_set_acl_text(char *disk_path, char *text, int flag);
6301 
6302 
6303 /**
6304  * Obtain permissions of a file in the local filesystem which shall reflect
6305  * ACL entry "group::" in S_IRWXG rather than ACL entry "mask::". This is
6306  * necessary if the permissions of a disk file with ACL shall be copied to
6307  * an object which has no ACL.
6308  * @param disk_path
6309  * Absolute path to the local file which may have an "access" ACL or not.
6310  * @param flag
6311  * Bitfield for control purposes
6312  * bit5= in case of symbolic link: inquire link target
6313  * @param st_mode
6314  * Returns permission bits as of stat(2)
6315  * @return
6316  * 1 success
6317  * -1 failure of lstat() resp. stat() (see errno)
6318  *
6319  * @since 0.6.14
6320  */
6321 int iso_local_get_perms_wo_acl(char *disk_path, mode_t *st_mode, int flag);
6322 
6323 
6324 /**
6325  * Get xattr and non-trivial ACLs of the given file in the local filesystem.
6326  * The resulting data has finally to be disposed by a call to this function
6327  * with flag bit15 set.
6328  *
6329  * Eventual ACLs will get encoded as attribute pair with empty name if this is
6330  * enabled by flag bit0. An ACL which simply replects stat(2) permissions
6331  * will not be put into the result.
6332  *
6333  * @param disk_path
6334  * Absolute path to the file
6335  * @param num_attrs
6336  * Will return the number of name-value pairs
6337  * @param names
6338  * Will return an array of pointers to 0-terminated names
6339  * @param value_lengths
6340  * Will return an arry with the lenghts of values
6341  * @param values
6342  * Will return an array of pointers to 8-bit values
6343  * @param flag
6344  * Bitfield for control purposes
6345  * bit0= obtain eventual ACLs as attribute with empty name
6346  * bit2= do not obtain attributes other than ACLs
6347  * bit3= do not ignore eventual non-user attributes.
6348  * I.e. those with a name which does not begin by "user."
6349  * bit5= in case of symbolic link: inquire link target
6350  * bit15= free memory
6351  * @return
6352  * 1 ok
6353  * < 0 failure
6354  *
6355  * @since 0.6.14
6356  */
6357 int iso_local_get_attrs(char *disk_path, size_t *num_attrs, char ***names,
6358  size_t **value_lengths, char ***values, int flag);
6359 
6360 
6361 /**
6362  * Attach a list of xattr and ACLs to the given file in the local filesystem.
6363  *
6364  * Eventual ACLs have to be encoded as attribute pair with empty name.
6365  *
6366  * @param disk_path
6367  * Absolute path to the file
6368  * @param num_attrs
6369  * Number of attributes
6370  * @param names
6371  * Array of pointers to 0 terminated name strings
6372  * @param value_lengths
6373  * Array of byte lengths for each attribute payload
6374  * @param values
6375  * Array of pointers to the attribute payload bytes
6376  * @param flag
6377  * Bitfield for control purposes
6378  * bit0= do not attach ACLs from an eventual attribute with empty name
6379  * bit3= do not ignore eventual non-user attributes.
6380  * I.e. those with a name which does not begin by "user."
6381  * bit5= in case of symbolic link: manipulate link target
6382  * bit6= @since 1.1.6
6383  tolerate inappropriate presence or absence of
6384  * directory "default" ACL
6385  * @return
6386  * 1 = ok
6387  * < 0 = error
6388  *
6389  * @since 0.6.14
6390  */
6391 int iso_local_set_attrs(char *disk_path, size_t num_attrs, char **names,
6392  size_t *value_lengths, char **values, int flag);
6393 
6394 
6395 /* Default in case that the compile environment has no macro PATH_MAX.
6396 */
6397 #define Libisofs_default_path_maX 4096
6398 
6399 
6400 /* --------------------------- Filters in General -------------------------- */
6401 
6402 /*
6403  * A filter is an IsoStream which uses another IsoStream as input. It gets
6404  * attached to an IsoFile by specialized calls iso_file_add_*_filter() which
6405  * replace its current IsoStream by the filter stream which takes over the
6406  * current IsoStream as input.
6407  * The consequences are:
6408  * iso_file_get_stream() will return the filter stream.
6409  * iso_stream_get_size() will return the (cached) size of the filtered data,
6410  * iso_stream_open() will start eventual child processes,
6411  * iso_stream_close() will kill eventual child processes,
6412  * iso_stream_read() will return filtered data. E.g. as data file content
6413  * during ISO image generation.
6414  *
6415  * There are external filters which run child processes
6416  * iso_file_add_external_filter()
6417  * and internal filters
6418  * iso_file_add_zisofs_filter()
6419  * iso_file_add_gzip_filter()
6420  * which may or may not be available depending on compile time settings and
6421  * installed software packages like libz.
6422  *
6423  * During image generation filters get not in effect if the original IsoStream
6424  * is an "fsrc" stream based on a file in the loaded ISO image and if the
6425  * image generation type is set to 1 by iso_write_opts_set_appendable().
6426  */
6427 
6428 /**
6429  * Delete the top filter stream from a data file. This is the most recent one
6430  * which was added by iso_file_add_*_filter().
6431  * Caution: One should not do this while the IsoStream of the file is opened.
6432  * For now there is no general way to determine this state.
6433  * Filter stream implementations are urged to eventually call .close()
6434  * inside method .free() . This will close the input stream too.
6435  * @param file
6436  * The data file node which shall get rid of one layer of content
6437  * filtering.
6438  * @param flag
6439  * Bitfield for control purposes, unused yet, submit 0.
6440  * @return
6441  * 1 on success, 0 if no filter was present
6442  * <0 on error
6443  *
6444  * @since 0.6.18
6445  */
6446 int iso_file_remove_filter(IsoFile *file, int flag);
6447 
6448 /**
6449  * Obtain the eventual input stream of a filter stream.
6450  * @param stream
6451  * The eventual filter stream to be inquired.
6452  * @param flag
6453  * Bitfield for control purposes.
6454  * bit0= Follow the chain of input streams and return the one at the
6455  * end of the chain.
6456  * @since 1.3.2
6457  * @return
6458  * The input stream, if one exists. Elsewise NULL.
6459  * No extra reference to the stream is taken by this call.
6460  *
6461  * @since 0.6.18
6462  */
6463 IsoStream *iso_stream_get_input_stream(IsoStream *stream, int flag);
6464 
6465 
6466 /* ---------------------------- External Filters --------------------------- */
6467 
6468 /**
6469  * Representation of an external program that shall serve as filter for
6470  * an IsoStream. This object may be shared among many IsoStream objects.
6471  * It is to be created and disposed by the application.
6472  *
6473  * The filter will act as proxy between the original IsoStream of an IsoFile.
6474  * Up to completed image generation it will be run at least twice:
6475  * for IsoStream.class.get_size() and for .open() with subsequent .read().
6476  * So the original IsoStream has to return 1 by its .class.is_repeatable().
6477  * The filter program has to be repeateable too. I.e. it must produce the same
6478  * output on the same input.
6479  *
6480  * @since 0.6.18
6481  */
6483 {
6484  /* Will indicate future extensions. It has to be 0 for now. */
6485  int version;
6486 
6487  /* Tells how many IsoStream objects depend on this command object.
6488  * One may only dispose an IsoExternalFilterCommand when this count is 0.
6489  * Initially this value has to be 0.
6490  */
6492 
6493  /* An optional instance id.
6494  * Set to empty text if no individual name for this object is intended.
6495  */
6496  char *name;
6497 
6498  /* Absolute local filesystem path to the executable program. */
6499  char *path;
6500 
6501  /* Tells the number of arguments. */
6502  int argc;
6503 
6504  /* NULL terminated list suitable for system call execv(3).
6505  * I.e. argv[0] points to the alleged program name,
6506  * argv[1] to argv[argc] point to program arguments (if argc > 0)
6507  * argv[argc+1] is NULL
6508  */
6509  char **argv;
6510 
6511  /* A bit field which controls behavior variations:
6512  * bit0= Do not install filter if the input has size 0.
6513  * bit1= Do not install filter if the output is not smaller than the input.
6514  * bit2= Do not install filter if the number of output blocks is
6515  * not smaller than the number of input blocks. Block size is 2048.
6516  * Assume that non-empty input yields non-empty output and thus do
6517  * not attempt to attach a filter to files smaller than 2049 bytes.
6518  * bit3= suffix removed rather than added.
6519  * (Removal and adding suffixes is the task of the application.
6520  * This behavior bit serves only as reminder for the application.)
6521  */
6523 
6524  /* The eventual suffix which is supposed to be added to the IsoFile name
6525  * resp. to be removed from the name.
6526  * (This is to be done by the application, not by calls
6527  * iso_file_add_external_filter() or iso_file_remove_filter().
6528  * The value recorded here serves only as reminder for the application.)
6529  */
6530  char *suffix;
6531 };
6532 
6534 
6535 /**
6536  * Install an external filter command on top of the content stream of a data
6537  * file. The filter process must be repeatable. It will be run once by this
6538  * call in order to cache the output size.
6539  * @param file
6540  * The data file node which shall show filtered content.
6541  * @param cmd
6542  * The external program and its arguments which shall do the filtering.
6543  * @param flag
6544  * Bitfield for control purposes, unused yet, submit 0.
6545  * @return
6546  * 1 on success, 2 if filter installation revoked (e.g. cmd.behavior bit1)
6547  * <0 on error
6548  *
6549  * @since 0.6.18
6550  */
6552  int flag);
6553 
6554 /**
6555  * Obtain the IsoExternalFilterCommand which is eventually associated with the
6556  * given stream. (Typically obtained from an IsoFile by iso_file_get_stream()
6557  * or from an IsoStream by iso_stream_get_input_stream()).
6558  * @param stream
6559  * The stream to be inquired.
6560  * @param cmd
6561  * Will return the external IsoExternalFilterCommand. Valid only if
6562  * the call returns 1. This does not increment cmd->refcount.
6563  * @param flag
6564  * Bitfield for control purposes, unused yet, submit 0.
6565  * @return
6566  * 1 on success, 0 if the stream is not an external filter
6567  * <0 on error
6568  *
6569  * @since 0.6.18
6570  */
6572  IsoExternalFilterCommand **cmd, int flag);
6573 
6574 
6575 /* ---------------------------- Internal Filters --------------------------- */
6576 
6577 
6578 /**
6579  * Install a zisofs filter on top of the content stream of a data file.
6580  * zisofs is a compression format which is decompressed by some Linux kernels.
6581  * See also doc/zisofs_format.txt .
6582  * The filter will not be installed if its output size is not smaller than
6583  * the size of the input stream.
6584  * This is only enabled if the use of libz was enabled at compile time.
6585  * @param file
6586  * The data file node which shall show filtered content.
6587  * @param flag
6588  * Bitfield for control purposes
6589  * bit0= Do not install filter if the number of output blocks is
6590  * not smaller than the number of input blocks. Block size is 2048.
6591  * bit1= Install a decompression filter rather than one for compression.
6592  * bit2= Only inquire availability of zisofs filtering. file may be NULL.
6593  * If available return 2, else return error.
6594  * bit3= is reserved for internal use and will be forced to 0
6595  * @return
6596  * 1 on success, 2 if filter available but installation revoked
6597  * <0 on error, e.g. ISO_ZLIB_NOT_ENABLED
6598  *
6599  * @since 0.6.18
6600  */
6601 int iso_file_add_zisofs_filter(IsoFile *file, int flag);
6602 
6603 /**
6604  * Inquire the number of zisofs compression and uncompression filters which
6605  * are in use.
6606  * @param ziso_count
6607  * Will return the number of currently installed compression filters.
6608  * @param osiz_count
6609  * Will return the number of currently installed uncompression filters.
6610  * @param flag
6611  * Bitfield for control purposes, unused yet, submit 0
6612  * @return
6613  * 1 on success, <0 on error
6614  *
6615  * @since 0.6.18
6616  */
6617 int iso_zisofs_get_refcounts(off_t *ziso_count, off_t *osiz_count, int flag);
6618 
6619 
6620 /**
6621  * Parameter set for iso_zisofs_set_params().
6622  *
6623  * @since 0.6.18
6624  */
6626 
6627  /* Set to 0 for this version of the structure */
6628  int version;
6629 
6630  /* Compression level for zlib function compress2(). From <zlib.h>:
6631  * "between 0 and 9:
6632  * 1 gives best speed, 9 gives best compression, 0 gives no compression"
6633  * Default is 6.
6634  */
6636 
6637  /* Log2 of the block size for compression filters. Allowed values are:
6638  * 15 = 32 kiB , 16 = 64 kiB , 17 = 128 kiB
6639  */
6641 
6642 };
6643 
6644 /**
6645  * Set the global parameters for zisofs filtering.
6646  * This is only allowed while no zisofs compression filters are installed.
6647  * i.e. ziso_count returned by iso_zisofs_get_refcounts() has to be 0.
6648  * @param params
6649  * Pointer to a structure with the intended settings.
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_zisofs_set_params(struct iso_zisofs_ctrl *params, int flag);
6658 
6659 /**
6660  * Get the current global parameters for zisofs filtering.
6661  * @param params
6662  * Pointer to a caller provided structure which shall take the settings.
6663  * @param flag
6664  * Bitfield for control purposes, unused yet, submit 0
6665  * @return
6666  * 1 on success, <0 on error
6667  *
6668  * @since 0.6.18
6669  */
6670 int iso_zisofs_get_params(struct iso_zisofs_ctrl *params, int flag);
6671 
6672 
6673 /**
6674  * Check for the given node or for its subtree whether the data file content
6675  * effectively bears zisofs file headers and eventually mark the outcome
6676  * by an xinfo data record if not already marked by a zisofs compressor filter.
6677  * This does not install any filter but only a hint for image generation
6678  * that the already compressed files shall get written with zisofs ZF entries.
6679  * Use this if you insert the compressed reults of program mkzftree from disk
6680  * into the image.
6681  * @param node
6682  * The node which shall be checked and eventually marked.
6683  * @param flag
6684  * Bitfield for control purposes, unused yet, submit 0
6685  * bit0= prepare for a run with iso_write_opts_set_appendable(,1).
6686  * Take into account that files from the imported image
6687  * do not get their content filtered.
6688  * bit1= permission to overwrite existing zisofs_zf_info
6689  * bit2= if no zisofs header is found:
6690  * create xinfo with parameters which indicate no zisofs
6691  * bit3= no tree recursion if node is a directory
6692  * bit4= skip files which stem from the imported image
6693  * @return
6694  * 0= no zisofs data found
6695  * 1= zf xinfo added
6696  * 2= found existing zf xinfo and flag bit1 was not set
6697  * 3= both encountered: 1 and 2
6698  * <0 means error
6699  *
6700  * @since 0.6.18
6701  */
6702 int iso_node_zf_by_magic(IsoNode *node, int flag);
6703 
6704 
6705 /**
6706  * Install a gzip or gunzip filter on top of the content stream of a data file.
6707  * gzip is a compression format which is used by programs gzip and gunzip.
6708  * The filter will not be installed if its output size is not smaller than
6709  * the size of the input stream.
6710  * This is only enabled if the use of libz was enabled at compile time.
6711  * @param file
6712  * The data file node which shall show filtered content.
6713  * @param flag
6714  * Bitfield for control purposes
6715  * bit0= Do not install filter if the number of output blocks is
6716  * not smaller than the number of input blocks. Block size is 2048.
6717  * bit1= Install a decompression filter rather than one for compression.
6718  * bit2= Only inquire availability of gzip filtering. file may be NULL.
6719  * If available return 2, else return error.
6720  * bit3= is reserved for internal use and will be forced to 0
6721  * @return
6722  * 1 on success, 2 if filter available but installation revoked
6723  * <0 on error, e.g. ISO_ZLIB_NOT_ENABLED
6724  *
6725  * @since 0.6.18
6726  */
6727 int iso_file_add_gzip_filter(IsoFile *file, int flag);
6728 
6729 
6730 /**
6731  * Inquire the number of gzip compression and uncompression filters which
6732  * are in use.
6733  * @param gzip_count
6734  * Will return the number of currently installed compression filters.
6735  * @param gunzip_count
6736  * Will return the number of currently installed uncompression filters.
6737  * @param flag
6738  * Bitfield for control purposes, unused yet, submit 0
6739  * @return
6740  * 1 on success, <0 on error
6741  *
6742  * @since 0.6.18
6743  */
6744 int iso_gzip_get_refcounts(off_t *gzip_count, off_t *gunzip_count, int flag);
6745 
6746 
6747 /* ---------------------------- MD5 Checksums --------------------------- */
6748 
6749 /* Production and loading of MD5 checksums is controlled by calls
6750  iso_write_opts_set_record_md5() and iso_read_opts_set_no_md5().
6751  For data representation details see doc/checksums.txt .
6752 */
6753 
6754 /**
6755  * Eventually obtain the recorded MD5 checksum of the session which was
6756  * loaded as ISO image. Such a checksum may be stored together with others
6757  * in a contiguous array at the end of the session. The session checksum
6758  * covers the data blocks from address start_lba to address end_lba - 1.
6759  * It does not cover the recorded array of md5 checksums.
6760  * Layout, size, and position of the checksum array is recorded in the xattr
6761  * "isofs.ca" of the session root node.
6762  * @param image
6763  * The image to inquire
6764  * @param start_lba
6765  * Eventually returns the first block address covered by md5
6766  * @param end_lba
6767  * Eventually returns the first block address not covered by md5 any more
6768  * @param md5
6769  * Eventually returns 16 byte of MD5 checksum
6770  * @param flag
6771  * Bitfield for control purposes, unused yet, submit 0
6772  * @return
6773  * 1= md5 found , 0= no md5 available , <0 indicates error
6774  *
6775  * @since 0.6.22
6776  */
6777 int iso_image_get_session_md5(IsoImage *image, uint32_t *start_lba,
6778  uint32_t *end_lba, char md5[16], int flag);
6779 
6780 /**
6781  * Eventually obtain the recorded MD5 checksum of a data file from the loaded
6782  * ISO image. Such a checksum may be stored with others in a contiguous
6783  * array at the end of the loaded session. The data file eventually has an
6784  * xattr "isofs.cx" which gives the index in that array.
6785  * @param image
6786  * The image from which file stems.
6787  * @param file
6788  * The file object to inquire
6789  * @param md5
6790  * Eventually returns 16 byte of MD5 checksum
6791  * @param flag
6792  * Bitfield for control purposes
6793  * bit0= only determine return value, do not touch parameter md5
6794  * @return
6795  * 1= md5 found , 0= no md5 available , <0 indicates error
6796  *
6797  * @since 0.6.22
6798  */
6799 int iso_file_get_md5(IsoImage *image, IsoFile *file, char md5[16], int flag);
6800 
6801 /**
6802  * Read the content of an IsoFile object, compute its MD5 and attach it to
6803  * the IsoFile. It can then be inquired by iso_file_get_md5() and will get
6804  * written into the next session if this is enabled at write time and if the
6805  * image write process does not compute an MD5 from content which it copies.
6806  * So this call can be used to equip nodes from the old image with checksums
6807  * or to make available checksums of newly added files before the session gets
6808  * written.
6809  * @param file
6810  * The file object to read data from and to which to attach the checksum.
6811  * If the file is from the imported image, then its most original stream
6812  * will be checksummed. Else the eventual filter streams will get into
6813  * effect.
6814  * @param flag
6815  * Bitfield for control purposes. Unused yet. Submit 0.
6816  * @return
6817  * 1= ok, MD5 is computed and attached , <0 indicates error
6818  *
6819  * @since 0.6.22
6820  */
6821 int iso_file_make_md5(IsoFile *file, int flag);
6822 
6823 /**
6824  * Check a data block whether it is a libisofs session checksum tag and
6825  * eventually obtain its recorded parameters. These tags get written after
6826  * volume descriptors, directory tree and checksum array and can be detected
6827  * without loading the image tree.
6828  * One may start reading and computing MD5 at the suspected image session
6829  * start and look out for a session tag on the fly. See doc/checksum.txt .
6830  * @param data
6831  * A complete and aligned data block read from an ISO image session.
6832  * @param tag_type
6833  * 0= no tag
6834  * 1= session tag
6835  * 2= superblock tag
6836  * 3= tree tag
6837  * 4= relocated 64 kB superblock tag (at LBA 0 of overwriteable media)
6838  * @param pos
6839  * Returns the LBA where the tag supposes itself to be stored.
6840  * If this does not match the data block LBA then the tag might be
6841  * image data payload and should be ignored for image checksumming.
6842  * @param range_start
6843  * Returns the block address where the session is supposed to start.
6844  * If this does not match the session start on media then the image
6845  * volume descriptors have been been relocated.
6846  * A proper checksum will only emerge if computing started at range_start.
6847  * @param range_size
6848  * Returns the number of blocks beginning at range_start which are
6849  * covered by parameter md5.
6850  * @param next_tag
6851  * Returns the predicted block address of the next tag.
6852  * next_tag is valid only if not 0 and only with return values 2, 3, 4.
6853  * With tag types 2 and 3, reading shall go on sequentially and the MD5
6854  * computation shall continue up to that address.
6855  * With tag type 4, reading shall resume either at LBA 32 for the first
6856  * session or at the given address for the session which is to be loaded
6857  * by default. In both cases the MD5 computation shall be re-started from
6858  * scratch.
6859  * @param md5
6860  * Returns 16 byte of MD5 checksum.
6861  * @param flag
6862  * Bitfield for control purposes:
6863  * bit0-bit7= tag type being looked for
6864  * 0= any checksum tag
6865  * 1= session tag
6866  * 2= superblock tag
6867  * 3= tree tag
6868  * 4= relocated superblock tag
6869  * @return
6870  * 0= not a checksum tag, return parameters are invalid
6871  * 1= checksum tag found, return parameters are valid
6872  * <0= error
6873  * (return parameters are valid with error ISO_MD5_AREA_CORRUPTED
6874  * but not trustworthy because the tag seems corrupted)
6875  *
6876  * @since 0.6.22
6877  */
6878 int iso_util_decode_md5_tag(char data[2048], int *tag_type, uint32_t *pos,
6879  uint32_t *range_start, uint32_t *range_size,
6880  uint32_t *next_tag, char md5[16], int flag);
6881 
6882 
6883 /* The following functions allow to do own MD5 computations. E.g for
6884  comparing the result with a recorded checksum.
6885 */
6886 /**
6887  * Create a MD5 computation context and hand out an opaque handle.
6888  *
6889  * @param md5_context
6890  * Returns the opaque handle. Submitted *md5_context must be NULL or
6891  * point to freeable memory.
6892  * @return
6893  * 1= success , <0 indicates error
6894  *
6895  * @since 0.6.22
6896  */
6897 int iso_md5_start(void **md5_context);
6898 
6899 /**
6900  * Advance the computation of a MD5 checksum by a chunk of data bytes.
6901  *
6902  * @param md5_context
6903  * An opaque handle once returned by iso_md5_start() or iso_md5_clone().
6904  * @param data
6905  * The bytes which shall be processed into to the checksum.
6906  * @param datalen
6907  * The number of bytes to be processed.
6908  * @return
6909  * 1= success , <0 indicates error
6910  *
6911  * @since 0.6.22
6912  */
6913 int iso_md5_compute(void *md5_context, char *data, int datalen);
6914 
6915 /**
6916  * Create a MD5 computation context as clone of an existing one. One may call
6917  * iso_md5_clone(old, &new, 0) and then iso_md5_end(&new, result, 0) in order
6918  * to obtain an intermediate MD5 sum before the computation goes on.
6919  *
6920  * @param old_md5_context
6921  * An opaque handle once returned by iso_md5_start() or iso_md5_clone().
6922  * @param new_md5_context
6923  * Returns the opaque handle to the new MD5 context. Submitted
6924  * *md5_context must be NULL or point to freeable memory.
6925  * @return
6926  * 1= success , <0 indicates error
6927  *
6928  * @since 0.6.22
6929  */
6930 int iso_md5_clone(void *old_md5_context, void **new_md5_context);
6931 
6932 /**
6933  * Obtain the MD5 checksum from a MD5 computation context and dispose this
6934  * context. (If you want to keep the context then call iso_md5_clone() and
6935  * apply iso_md5_end() to the clone.)
6936  *
6937  * @param md5_context
6938  * A pointer to an opaque handle once returned by iso_md5_start() or
6939  * iso_md5_clone(). *md5_context will be set to NULL in this call.
6940  * @param result
6941  * Gets filled with the 16 bytes of MD5 checksum.
6942  * @return
6943  * 1= success , <0 indicates error
6944  *
6945  * @since 0.6.22
6946  */
6947 int iso_md5_end(void **md5_context, char result[16]);
6948 
6949 /**
6950  * Inquire whether two MD5 checksums match. (This is trivial but such a call
6951  * is convenient and completes the interface.)
6952  * @param first_md5
6953  * A MD5 byte string as returned by iso_md5_end()
6954  * @param second_md5
6955  * A MD5 byte string as returned by iso_md5_end()
6956  * @return
6957  * 1= match , 0= mismatch
6958  *
6959  * @since 0.6.22
6960  */
6961 int iso_md5_match(char first_md5[16], char second_md5[16]);
6962 
6963 
6964 /* -------------------------------- For HFS+ ------------------------------- */
6965 
6966 
6967 /**
6968  * HFS+ attributes which may be attached to IsoNode objects as data parameter
6969  * of iso_node_add_xinfo(). As parameter proc use iso_hfsplus_xinfo_func().
6970  * Create instances of this struct by iso_hfsplus_xinfo_new().
6971  *
6972  * @since 1.2.4
6973  */
6975 
6976  /* Currently set to 0 by iso_hfsplus_xinfo_new() */
6977  int version;
6978 
6979  /* Attributes available with version 0.
6980  * See: http://en.wikipedia.org/wiki/Creator_code , .../Type_code
6981  * @since 1.2.4
6982  */
6983  uint8_t creator_code[4];
6984  uint8_t type_code[4];
6985 };
6986 
6987 /**
6988  * The function that is used to mark struct iso_hfsplus_xinfo_data at IsoNodes
6989  * and finally disposes such structs when their IsoNodes get disposed.
6990  * Usually an application does not call this function, but only uses it as
6991  * parameter of xinfo calls like iso_node_add_xinfo() or iso_node_get_xinfo().
6992  *
6993  * @since 1.2.4
6994  */
6995 int iso_hfsplus_xinfo_func(void *data, int flag);
6996 
6997 /**
6998  * Create an instance of struct iso_hfsplus_xinfo_new().
6999  *
7000  * @param flag
7001  * Bitfield for control purposes. Unused yet. Submit 0.
7002  * @return
7003  * A pointer to the new object
7004  * NULL indicates failure to allocate memory
7005  *
7006  * @since 1.2.4
7007  */
7009 
7010 
7011 /**
7012  * HFS+ blessings are relationships between HFS+ enhanced ISO images and
7013  * particular files in such images. Except for ISO_HFSPLUS_BLESS_INTEL_BOOTFILE
7014  * and ISO_HFSPLUS_BLESS_MAX, these files have to be directories.
7015  * No file may have more than one blessing. Each blessing can only be issued
7016  * to one file.
7017  *
7018  * @since 1.2.4
7019  */
7021  /* The blessing that is issued by mkisofs option -hfs-bless. */
7023 
7024  /* To be applied to a data file */
7026 
7027  /* Further blessings for directories */
7031 
7032  /* Not a blessing, but telling the number of blessings in this list */
7034 };
7035 
7036 /**
7037  * Issue a blessing to a particular IsoNode. If the blessing is already issued
7038  * to some file, then it gets revoked from that one.
7039  *
7040  * @param image
7041  * The image to manipulate.
7042  * @param blessing
7043  * The kind of blessing to be issued.
7044  * @param node
7045  * The file that shall be blessed. It must actually be an IsoDir or
7046  * IsoFile as is appropriate for the kind of blessing. (See above enum.)
7047  * The node may not yet bear a blessing other than the desired one.
7048  * If node is NULL, then the blessing will be revoked from any node
7049  * which bears it.
7050  * @param flag
7051  * Bitfield for control purposes.
7052  * bit0= Revoke blessing if node != NULL bears it.
7053  * bit1= Revoke any blessing of the node, regardless of parameter
7054  * blessing. If node is NULL, then revoke all blessings in
7055  * the image.
7056  * @return
7057  * 1 means successful blessing or revokation of an existing blessing.
7058  * 0 means the node already bears another blessing, or is of wrong type,
7059  * or that the node was not blessed and revokation was desired.
7060  * <0 is one of the listed error codes.
7061  *
7062  * @since 1.2.4
7063  */
7064 int iso_image_hfsplus_bless(IsoImage *img, enum IsoHfsplusBlessings blessing,
7065  IsoNode *node, int flag);
7066 
7067 /**
7068  * Get the array of nodes which are currently blessed.
7069  * Array indice correspond to enum IsoHfsplusBlessings.
7070  * Array element value NULL means that no node bears that blessing.
7071  *
7072  * Several usage restrictions apply. See parameter blessed_nodes.
7073  *
7074  * @param image
7075  * The image to inquire.
7076  * @param blessed_nodes
7077  * Will return a pointer to an internal node array of image.
7078  * This pointer is valid only as long as image exists and only until
7079  * iso_image_hfsplus_bless() gets used to manipulate the blessings.
7080  * Do not free() this array. Do not alter the content of the array
7081  * directly, but rather use iso_image_hfsplus_bless() and re-inquire
7082  * by iso_image_hfsplus_get_blessed().
7083  * This call does not impose an extra reference on the nodes in the
7084  * array. So do not iso_node_unref() them.
7085  * Nodes listed here are not necessarily grafted into the tree of
7086  * the IsoImage.
7087  * @param bless_max
7088  * Will return the number of elements in the array.
7089  * It is unlikely but not outruled that it will be larger than
7090  * ISO_HFSPLUS_BLESS_MAX in this libisofs.h file.
7091  * @param flag
7092  * Bitfield for control purposes. Submit 0.
7093  * @return
7094  * 1 means success, <0 means error
7095  *
7096  * @since 1.2.4
7097  */
7098 int iso_image_hfsplus_get_blessed(IsoImage *img, IsoNode ***blessed_nodes,
7099  int *bless_max, int flag);
7100 
7101 
7102 /************ Error codes and return values for libisofs ********************/
7103 
7104 /** successfully execution */
7105 #define ISO_SUCCESS 1
7106 
7107 /**
7108  * special return value, it could be or not an error depending on the
7109  * context.
7110  */
7111 #define ISO_NONE 0
7112 
7113 /** Operation canceled (FAILURE,HIGH, -1) */
7114 #define ISO_CANCELED 0xE830FFFF
7115 
7116 /** Unknown or unexpected fatal error (FATAL,HIGH, -2) */
7117 #define ISO_FATAL_ERROR 0xF030FFFE
7118 
7119 /** Unknown or unexpected error (FAILURE,HIGH, -3) */
7120 #define ISO_ERROR 0xE830FFFD
7121 
7122 /** Internal programming error. Please report this bug (FATAL,HIGH, -4) */
7123 #define ISO_ASSERT_FAILURE 0xF030FFFC
7124 
7125 /**
7126  * NULL pointer as value for an arg. that doesn't allow NULL (FAILURE,HIGH, -5)
7127  */
7128 #define ISO_NULL_POINTER 0xE830FFFB
7129 
7130 /** Memory allocation error (FATAL,HIGH, -6) */
7131 #define ISO_OUT_OF_MEM 0xF030FFFA
7132 
7133 /** Interrupted by a signal (FATAL,HIGH, -7) */
7134 #define ISO_INTERRUPTED 0xF030FFF9
7135 
7136 /** Invalid parameter value (FAILURE,HIGH, -8) */
7137 #define ISO_WRONG_ARG_VALUE 0xE830FFF8
7138 
7139 /** Can't create a needed thread (FATAL,HIGH, -9) */
7140 #define ISO_THREAD_ERROR 0xF030FFF7
7141 
7142 /** Write error (FAILURE,HIGH, -10) */
7143 #define ISO_WRITE_ERROR 0xE830FFF6
7144 
7145 /** Buffer read error (FAILURE,HIGH, -11) */
7146 #define ISO_BUF_READ_ERROR 0xE830FFF5
7147 
7148 /** Trying to add to a dir a node already added to a dir (FAILURE,HIGH, -64) */
7149 #define ISO_NODE_ALREADY_ADDED 0xE830FFC0
7150 
7151 /** Node with same name already exists (FAILURE,HIGH, -65) */
7152 #define ISO_NODE_NAME_NOT_UNIQUE 0xE830FFBF
7153 
7154 /** Trying to remove a node that was not added to dir (FAILURE,HIGH, -65) */
7155 #define ISO_NODE_NOT_ADDED_TO_DIR 0xE830FFBE
7156 
7157 /** A requested node does not exist (FAILURE,HIGH, -66) */
7158 #define ISO_NODE_DOESNT_EXIST 0xE830FFBD
7159 
7160 /**
7161  * Try to set the boot image of an already bootable image (FAILURE,HIGH, -67)
7162  */
7163 #define ISO_IMAGE_ALREADY_BOOTABLE 0xE830FFBC
7164 
7165 /** Trying to use an invalid file as boot image (FAILURE,HIGH, -68) */
7166 #define ISO_BOOT_IMAGE_NOT_VALID 0xE830FFBB
7167 
7168 /** Too many boot images (FAILURE,HIGH, -69) */
7169 #define ISO_BOOT_IMAGE_OVERFLOW 0xE830FFBA
7170 
7171 /** No boot catalog created yet ((FAILURE,HIGH, -70) */ /* @since 0.6.34 */
7172 #define ISO_BOOT_NO_CATALOG 0xE830FFB9
7173 
7174 
7175 /**
7176  * Error on file operation (FAILURE,HIGH, -128)
7177  * (take a look at more specified error codes below)
7178  */
7179 #define ISO_FILE_ERROR 0xE830FF80
7180 
7181 /** Trying to open an already opened file (FAILURE,HIGH, -129) */
7182 #define ISO_FILE_ALREADY_OPENED 0xE830FF7F
7183 
7184 /* @deprecated use ISO_FILE_ALREADY_OPENED instead */
7185 #define ISO_FILE_ALREADY_OPENNED 0xE830FF7F
7186 
7187 /** Access to file is not allowed (FAILURE,HIGH, -130) */
7188 #define ISO_FILE_ACCESS_DENIED 0xE830FF7E
7189 
7190 /** Incorrect path to file (FAILURE,HIGH, -131) */
7191 #define ISO_FILE_BAD_PATH 0xE830FF7D
7192 
7193 /** The file does not exist in the filesystem (FAILURE,HIGH, -132) */
7194 #define ISO_FILE_DOESNT_EXIST 0xE830FF7C
7195 
7196 /** Trying to read or close a file not openned (FAILURE,HIGH, -133) */
7197 #define ISO_FILE_NOT_OPENED 0xE830FF7B
7198 
7199 /* @deprecated use ISO_FILE_NOT_OPENED instead */
7200 #define ISO_FILE_NOT_OPENNED ISO_FILE_NOT_OPENED
7201 
7202 /** Directory used where no dir is expected (FAILURE,HIGH, -134) */
7203 #define ISO_FILE_IS_DIR 0xE830FF7A
7204 
7205 /** Read error (FAILURE,HIGH, -135) */
7206 #define ISO_FILE_READ_ERROR 0xE830FF79
7207 
7208 /** Not dir used where a dir is expected (FAILURE,HIGH, -136) */
7209 #define ISO_FILE_IS_NOT_DIR 0xE830FF78
7210 
7211 /** Not symlink used where a symlink is expected (FAILURE,HIGH, -137) */
7212 #define ISO_FILE_IS_NOT_SYMLINK 0xE830FF77
7213 
7214 /** Can't seek to specified location (FAILURE,HIGH, -138) */
7215 #define ISO_FILE_SEEK_ERROR 0xE830FF76
7216 
7217 /** File not supported in ECMA-119 tree and thus ignored (WARNING,MEDIUM, -139) */
7218 #define ISO_FILE_IGNORED 0xD020FF75
7219 
7220 /* A file is bigger than supported by used standard (WARNING,MEDIUM, -140) */
7221 #define ISO_FILE_TOO_BIG 0xD020FF74
7222 
7223 /* File read error during image creation (MISHAP,HIGH, -141) */
7224 #define ISO_FILE_CANT_WRITE 0xE430FF73
7225 
7226 /* Can't convert filename to requested charset (WARNING,MEDIUM, -142) */
7227 #define ISO_FILENAME_WRONG_CHARSET 0xD020FF72
7228 /* This was once a HINT. Deprecated now. */
7229 #define ISO_FILENAME_WRONG_CHARSET_OLD 0xC020FF72
7230 
7231 /* File can't be added to the tree (SORRY,HIGH, -143) */
7232 #define ISO_FILE_CANT_ADD 0xE030FF71
7233 
7234 /**
7235  * File path break specification constraints and will be ignored
7236  * (WARNING,MEDIUM, -144)
7237  */
7238 #define ISO_FILE_IMGPATH_WRONG 0xD020FF70
7239 
7240 /**
7241  * Offset greater than file size (FAILURE,HIGH, -150)
7242  * @since 0.6.4
7243  */
7244 #define ISO_FILE_OFFSET_TOO_BIG 0xE830FF6A
7245 
7246 
7247 /** Charset conversion error (FAILURE,HIGH, -256) */
7248 #define ISO_CHARSET_CONV_ERROR 0xE830FF00
7249 
7250 /**
7251  * Too many files to mangle, i.e. we cannot guarantee unique file names
7252  * (FAILURE,HIGH, -257)
7253  */
7254 #define ISO_MANGLE_TOO_MUCH_FILES 0xE830FEFF
7255 
7256 /* image related errors */
7257 
7258 /**
7259  * Wrong or damaged Primary Volume Descriptor (FAILURE,HIGH, -320)
7260  * This could mean that the file is not a valid ISO image.
7261  */
7262 #define ISO_WRONG_PVD 0xE830FEC0
7263 
7264 /** Wrong or damaged RR entry (SORRY,HIGH, -321) */
7265 #define ISO_WRONG_RR 0xE030FEBF
7266 
7267 /** Unsupported RR feature (SORRY,HIGH, -322) */
7268 #define ISO_UNSUPPORTED_RR 0xE030FEBE
7269 
7270 /** Wrong or damaged ECMA-119 (FAILURE,HIGH, -323) */
7271 #define ISO_WRONG_ECMA119 0xE830FEBD
7272 
7273 /** Unsupported ECMA-119 feature (FAILURE,HIGH, -324) */
7274 #define ISO_UNSUPPORTED_ECMA119 0xE830FEBC
7275 
7276 /** Wrong or damaged El-Torito catalog (WARN,HIGH, -325) */
7277 #define ISO_WRONG_EL_TORITO 0xD030FEBB
7278 
7279 /** Unsupported El-Torito feature (WARN,HIGH, -326) */
7280 #define ISO_UNSUPPORTED_EL_TORITO 0xD030FEBA
7281 
7282 /** Can't patch an isolinux boot image (SORRY,HIGH, -327) */
7283 #define ISO_ISOLINUX_CANT_PATCH 0xE030FEB9
7284 
7285 /** Unsupported SUSP feature (SORRY,HIGH, -328) */
7286 #define ISO_UNSUPPORTED_SUSP 0xE030FEB8
7287 
7288 /** Error on a RR entry that can be ignored (WARNING,HIGH, -329) */
7289 #define ISO_WRONG_RR_WARN 0xD030FEB7
7290 
7291 /** Error on a RR entry that can be ignored (HINT,MEDIUM, -330) */
7292 #define ISO_SUSP_UNHANDLED 0xC020FEB6
7293 
7294 /** Multiple ER SUSP entries found (WARNING,HIGH, -331) */
7295 #define ISO_SUSP_MULTIPLE_ER 0xD030FEB5
7296 
7297 /** Unsupported volume descriptor found (HINT,MEDIUM, -332) */
7298 #define ISO_UNSUPPORTED_VD 0xC020FEB4
7299 
7300 /** El-Torito related warning (WARNING,HIGH, -333) */
7301 #define ISO_EL_TORITO_WARN 0xD030FEB3
7302 
7303 /** Image write cancelled (MISHAP,HIGH, -334) */
7304 #define ISO_IMAGE_WRITE_CANCELED 0xE430FEB2
7305 
7306 /** El-Torito image is hidden (WARNING,HIGH, -335) */
7307 #define ISO_EL_TORITO_HIDDEN 0xD030FEB1
7308 
7309 
7310 /** AAIP info with ACL or xattr in ISO image will be ignored
7311  (NOTE, HIGH, -336) */
7312 #define ISO_AAIP_IGNORED 0xB030FEB0
7313 
7314 /** Error with decoding ACL from AAIP info (FAILURE, HIGH, -337) */
7315 #define ISO_AAIP_BAD_ACL 0xE830FEAF
7316 
7317 /** Error with encoding ACL for AAIP (FAILURE, HIGH, -338) */
7318 #define ISO_AAIP_BAD_ACL_TEXT 0xE830FEAE
7319 
7320 /** AAIP processing for ACL or xattr not enabled at compile time
7321  (FAILURE, HIGH, -339) */
7322 #define ISO_AAIP_NOT_ENABLED 0xE830FEAD
7323 
7324 /** Error with decoding AAIP info for ACL or xattr (FAILURE, HIGH, -340) */
7325 #define ISO_AAIP_BAD_AASTRING 0xE830FEAC
7326 
7327 /** Error with reading ACL or xattr from local file (FAILURE, HIGH, -341) */
7328 #define ISO_AAIP_NO_GET_LOCAL 0xE830FEAB
7329 
7330 /** Error with attaching ACL or xattr to local file (FAILURE, HIGH, -342) */
7331 #define ISO_AAIP_NO_SET_LOCAL 0xE830FEAA
7332 
7333 /** Unallowed attempt to set an xattr with non-userspace name
7334  (FAILURE, HIGH, -343) */
7335 #define ISO_AAIP_NON_USER_NAME 0xE830FEA9
7336 
7337 /** Too many references on a single IsoExternalFilterCommand
7338  (FAILURE, HIGH, -344) */
7339 #define ISO_EXTF_TOO_OFTEN 0xE830FEA8
7340 
7341 /** Use of zlib was not enabled at compile time (FAILURE, HIGH, -345) */
7342 #define ISO_ZLIB_NOT_ENABLED 0xE830FEA7
7343 
7344 /** Cannot apply zisofs filter to file >= 4 GiB (FAILURE, HIGH, -346) */
7345 #define ISO_ZISOFS_TOO_LARGE 0xE830FEA6
7346 
7347 /** Filter input differs from previous run (FAILURE, HIGH, -347) */
7348 #define ISO_FILTER_WRONG_INPUT 0xE830FEA5
7349 
7350 /** zlib compression/decompression error (FAILURE, HIGH, -348) */
7351 #define ISO_ZLIB_COMPR_ERR 0xE830FEA4
7352 
7353 /** Input stream is not in zisofs format (FAILURE, HIGH, -349) */
7354 #define ISO_ZISOFS_WRONG_INPUT 0xE830FEA3
7355 
7356 /** Cannot set global zisofs parameters while filters exist
7357  (FAILURE, HIGH, -350) */
7358 #define ISO_ZISOFS_PARAM_LOCK 0xE830FEA2
7359 
7360 /** Premature EOF of zlib input stream (FAILURE, HIGH, -351) */
7361 #define ISO_ZLIB_EARLY_EOF 0xE830FEA1
7362 
7363 /**
7364  * Checksum area or checksum tag appear corrupted (WARNING,HIGH, -352)
7365  * @since 0.6.22
7366 */
7367 #define ISO_MD5_AREA_CORRUPTED 0xD030FEA0
7368 
7369 /**
7370  * Checksum mismatch between checksum tag and data blocks
7371  * (FAILURE, HIGH, -353)
7372  * @since 0.6.22
7373 */
7374 #define ISO_MD5_TAG_MISMATCH 0xE830FE9F
7375 
7376 /**
7377  * Checksum mismatch in System Area, Volume Descriptors, or directory tree.
7378  * (FAILURE, HIGH, -354)
7379  * @since 0.6.22
7380 */
7381 #define ISO_SB_TREE_CORRUPTED 0xE830FE9E
7382 
7383 /**
7384  * Unexpected checksum tag type encountered. (WARNING, HIGH, -355)
7385  * @since 0.6.22
7386 */
7387 #define ISO_MD5_TAG_UNEXPECTED 0xD030FE9D
7388 
7389 /**
7390  * Misplaced checksum tag encountered. (WARNING, HIGH, -356)
7391  * @since 0.6.22
7392 */
7393 #define ISO_MD5_TAG_MISPLACED 0xD030FE9C
7394 
7395 /**
7396  * Checksum tag with unexpected address range encountered.
7397  * (WARNING, HIGH, -357)
7398  * @since 0.6.22
7399 */
7400 #define ISO_MD5_TAG_OTHER_RANGE 0xD030FE9B
7401 
7402 /**
7403  * Detected file content changes while it was written into the image.
7404  * (MISHAP, HIGH, -358)
7405  * @since 0.6.22
7406 */
7407 #define ISO_MD5_STREAM_CHANGE 0xE430FE9A
7408 
7409 /**
7410  * Session does not start at LBA 0. scdbackup checksum tag not written.
7411  * (WARNING, HIGH, -359)
7412  * @since 0.6.24
7413 */
7414 #define ISO_SCDBACKUP_TAG_NOT_0 0xD030FE99
7415 
7416 /**
7417  * The setting of iso_write_opts_set_ms_block() leaves not enough room
7418  * for the prescibed size of iso_write_opts_set_overwrite_buf().
7419  * (FAILURE, HIGH, -360)
7420  * @since 0.6.36
7421  */
7422 #define ISO_OVWRT_MS_TOO_SMALL 0xE830FE98
7423 
7424 /**
7425  * The partition offset is not 0 and leaves not not enough room for
7426  * system area, volume descriptors, and checksum tags of the first tree.
7427  * (FAILURE, HIGH, -361)
7428  */
7429 #define ISO_PART_OFFST_TOO_SMALL 0xE830FE97
7430 
7431 /**
7432  * The ring buffer is smaller than 64 kB + partition offset.
7433  * (FAILURE, HIGH, -362)
7434  */
7435 #define ISO_OVWRT_FIFO_TOO_SMALL 0xE830FE96
7436 
7437 /** Use of libjte was not enabled at compile time (FAILURE, HIGH, -363) */
7438 #define ISO_LIBJTE_NOT_ENABLED 0xE830FE95
7439 
7440 /** Failed to start up Jigdo Template Extraction (FAILURE, HIGH, -364) */
7441 #define ISO_LIBJTE_START_FAILED 0xE830FE94
7442 
7443 /** Failed to finish Jigdo Template Extraction (FAILURE, HIGH, -365) */
7444 #define ISO_LIBJTE_END_FAILED 0xE830FE93
7445 
7446 /** Failed to process file for Jigdo Template Extraction
7447  (MISHAP, HIGH, -366) */
7448 #define ISO_LIBJTE_FILE_FAILED 0xE430FE92
7449 
7450 /** Too many MIPS Big Endian boot files given (max. 15) (FAILURE, HIGH, -367)*/
7451 #define ISO_BOOT_TOO_MANY_MIPS 0xE830FE91
7452 
7453 /** Boot file missing in image (MISHAP, HIGH, -368) */
7454 #define ISO_BOOT_FILE_MISSING 0xE430FE90
7455 
7456 /** Partition number out of range (FAILURE, HIGH, -369) */
7457 #define ISO_BAD_PARTITION_NO 0xE830FE8F
7458 
7459 /** Cannot open data file for appended partition (FAILURE, HIGH, -370) */
7460 #define ISO_BAD_PARTITION_FILE 0xE830FE8E
7461 
7462 /** May not combine MBR partition with non-MBR system area
7463  (FAILURE, HIGH, -371) */
7464 #define ISO_NON_MBR_SYS_AREA 0xE830FE8D
7465 
7466 /** Displacement offset leads outside 32 bit range (FAILURE, HIGH, -372) */
7467 #define ISO_DISPLACE_ROLLOVER 0xE830FE8C
7468 
7469 /** File name cannot be written into ECMA-119 untranslated
7470  (FAILURE, HIGH, -373) */
7471 #define ISO_NAME_NEEDS_TRANSL 0xE830FE8B
7472 
7473 /** Data file input stream object offers no cloning method
7474  (FAILURE, HIGH, -374) */
7475 #define ISO_STREAM_NO_CLONE 0xE830FE8A
7476 
7477 /** Extended information class offers no cloning method
7478  (FAILURE, HIGH, -375) */
7479 #define ISO_XINFO_NO_CLONE 0xE830FE89
7480 
7481 /** Found copied superblock checksum tag (WARNING, HIGH, -376) */
7482 #define ISO_MD5_TAG_COPIED 0xD030FE88
7483 
7484 /** Rock Ridge leaf name too long (FAILURE, HIGH, -377) */
7485 #define ISO_RR_NAME_TOO_LONG 0xE830FE87
7486 
7487 /** Reserved Rock Ridge leaf name (FAILURE, HIGH, -378) */
7488 #define ISO_RR_NAME_RESERVED 0xE830FE86
7489 
7490 /** Rock Ridge path too long (FAILURE, HIGH, -379) */
7491 #define ISO_RR_PATH_TOO_LONG 0xE830FE85
7492 
7493 /** Attribute name cannot be represented (FAILURE, HIGH, -380) */
7494 #define ISO_AAIP_BAD_ATTR_NAME 0xE830FE84
7495 
7496 /** ACL text contains multiple entries of user::, group::, other::
7497  (FAILURE, HIGH, -381) */
7498 #define ISO_AAIP_ACL_MULT_OBJ 0xE830FE83
7499 
7500 /** File sections do not form consecutive array of blocks
7501  (FAILURE, HIGH, -382) */
7502 #define ISO_SECT_SCATTERED 0xE830FE82
7503 
7504 /** Too many Apple Partition Map entries requested (FAILURE, HIGH, -383) */
7505 #define ISO_BOOT_TOO_MANY_APM 0xE830FE81
7506 
7507 /** Overlapping Apple Partition Map entries requested (FAILURE, HIGH, -384) */
7508 #define ISO_BOOT_APM_OVERLAP 0xE830FE80
7509 
7510 /** Too many GPT entries requested (FAILURE, HIGH, -385) */
7511 #define ISO_BOOT_TOO_MANY_GPT 0xE830FE7F
7512 
7513 /** Overlapping GPT entries requested (FAILURE, HIGH, -386) */
7514 #define ISO_BOOT_GPT_OVERLAP 0xE830FE7E
7515 
7516 /** Too many MBR partition entries requested (FAILURE, HIGH, -387) */
7517 #define ISO_BOOT_TOO_MANY_MBR 0xE830FE7D
7518 
7519 /** Overlapping MBR partition entries requested (FAILURE, HIGH, -388) */
7520 #define ISO_BOOT_MBR_OVERLAP 0xE830FE7C
7521 
7522 /** Attempt to use an MBR partition entry twice (FAILURE, HIGH, -389) */
7523 #define ISO_BOOT_MBR_COLLISION 0xE830FE7B
7524 
7525 /** No suitable El Torito EFI boot image for exposure as GPT partition
7526  (FAILURE, HIGH, -390) */
7527 #define ISO_BOOT_NO_EFI_ELTO 0xE830FE7A
7528 
7529 /** Not a supported HFS+ or APM block size (FAILURE, HIGH, -391) */
7530 #define ISO_BOOT_HFSP_BAD_BSIZE 0xE830FE79
7531 
7532 /** APM block size prevents coexistence with GPT (FAILURE, HIGH, -392) */
7533 #define ISO_BOOT_APM_GPT_BSIZE 0xE830FE78
7534 
7535 /** Name collision in HFS+, mangling not possible (FAILURE, HIGH, -393) */
7536 #define ISO_HFSP_NO_MANGLE 0xE830FE77
7537 
7538 /** Symbolic link cannot be resolved (FAILURE, HIGH, -394) */
7539 #define ISO_DEAD_SYMLINK 0xE830FE76
7540 
7541 /** Too many chained symbolic links (FAILURE, HIGH, -395) */
7542 #define ISO_DEEP_SYMLINK 0xE830FE75
7543 
7544 /** Unrecognized file type in ISO image (FAILURE, HIGH, -396) */
7545 #define ISO_BAD_ISO_FILETYPE 0xE830FE74
7546 
7547 
7548 /* Internal developer note:
7549  Place new error codes directly above this comment.
7550  Newly introduced errors must get a message entry in
7551  libisofs/messages.c, function iso_error_to_msg()
7552 */
7553 
7554 /* ! PLACE NEW ERROR CODES ABOVE. NOT AFTER THIS LINE ! */
7555 
7556 
7557 /** Read error occured with IsoDataSource (SORRY,HIGH, -513) */
7558 #define ISO_DATA_SOURCE_SORRY 0xE030FCFF
7559 
7560 /** Read error occured with IsoDataSource (MISHAP,HIGH, -513) */
7561 #define ISO_DATA_SOURCE_MISHAP 0xE430FCFF
7562 
7563 /** Read error occured with IsoDataSource (FAILURE,HIGH, -513) */
7564 #define ISO_DATA_SOURCE_FAILURE 0xE830FCFF
7565 
7566 /** Read error occured with IsoDataSource (FATAL,HIGH, -513) */
7567 #define ISO_DATA_SOURCE_FATAL 0xF030FCFF
7568 
7569 
7570 /* ! PLACE NEW ERROR CODES SEVERAL LINES ABOVE. NOT HERE ! */
7571 
7572 
7573 /* ------------------------------------------------------------------------- */
7574 
7575 #ifdef LIBISOFS_WITHOUT_LIBBURN
7576 
7577 /**
7578  This is a copy from the API of libburn-0.6.0 (under GPL).
7579  It is supposed to be as stable as any overall include of libburn.h.
7580  I.e. if this definition is out of sync then you cannot rely on any
7581  contract that was made with libburn.h.
7582 
7583  Libisofs does not need to be linked with libburn at all. But if it is
7584  linked with libburn then it must be libburn-0.4.2 or later.
7585 
7586  An application that provides own struct burn_source objects and does not
7587  include libburn/libburn.h has to define LIBISOFS_WITHOUT_LIBBURN before
7588  including libisofs/libisofs.h in order to make this copy available.
7589 */
7590 
7591 
7592 /** Data source interface for tracks.
7593  This allows to use arbitrary program code as provider of track input data.
7594 
7595  Objects compliant to this interface are either provided by the application
7596  or by API calls of libburn: burn_fd_source_new(), burn_file_source_new(),
7597  and burn_fifo_source_new().
7598 
7599  libisofs acts as "application" and implements an own class of burn_source.
7600  Instances of that class are handed out by iso_image_create_burn_source().
7601 
7602 */
7603 struct burn_source {
7604 
7605  /** Reference count for the data source. MUST be 1 when a new source
7606  is created and thus the first reference is handed out. Increment
7607  it to take more references for yourself. Use burn_source_free()
7608  to destroy your references to it. */
7609  int refcount;
7610 
7611 
7612  /** Read data from the source. Semantics like with read(2), but MUST
7613  either deliver the full buffer as defined by size or MUST deliver
7614  EOF (return 0) or failure (return -1) at this call or at the
7615  next following call. I.e. the only incomplete buffer may be the
7616  last one from that source.
7617  libburn will read a single sector by each call to (*read).
7618  The size of a sector depends on BURN_MODE_*. The known range is
7619  2048 to 2352.
7620 
7621  If this call is reading from a pipe then it will learn
7622  about the end of data only when that pipe gets closed on the
7623  feeder side. So if the track size is not fixed or if the pipe
7624  delivers less than the predicted amount or if the size is not
7625  block aligned, then burning will halt until the input process
7626  closes the pipe.
7627 
7628  IMPORTANT:
7629  If this function pointer is NULL, then the struct burn_source is of
7630  version >= 1 and the job of .(*read)() is done by .(*read_xt)().
7631  See below, member .version.
7632  */
7633  int (*read)(struct burn_source *, unsigned char *buffer, int size);
7634 
7635 
7636  /** Read subchannel data from the source (NULL if lib generated)
7637  WARNING: This is an obscure feature with CD raw write modes.
7638  Unless you checked the libburn code for correctness in that aspect
7639  you should not rely on raw writing with own subchannels.
7640  ADVICE: Set this pointer to NULL.
7641  */
7642  int (*read_sub)(struct burn_source *, unsigned char *buffer, int size);
7643 
7644 
7645  /** Get the size of the source's data. Return 0 means unpredictable
7646  size. If application provided (*get_size) allows return 0, then
7647  the application MUST provide a fully functional (*set_size).
7648  */
7649  off_t (*get_size)(struct burn_source *);
7650 
7651 
7652  /* @since 0.3.2 */
7653  /** Program the reply of (*get_size) to a fixed value. It is advised
7654  to implement this by a attribute off_t fixed_size; in *data .
7655  The read() function does not have to take into respect this fake
7656  setting. It is rather a note of libburn to itself. Eventually
7657  necessary truncation or padding is done in libburn. Truncation
7658  is usually considered a misburn. Padding is considered ok.
7659 
7660  libburn is supposed to work even if (*get_size) ignores the
7661  setting by (*set_size). But your application will not be able to
7662  enforce fixed track sizes by burn_track_set_size() and possibly
7663  even padding might be left out.
7664  */
7665  int (*set_size)(struct burn_source *source, off_t size);
7666 
7667 
7668  /** Clean up the source specific data. This function will be called
7669  once by burn_source_free() when the last referer disposes the
7670  source.
7671  */
7672  void (*free_data)(struct burn_source *);
7673 
7674 
7675  /** Next source, for when a source runs dry and padding is disabled
7676  WARNING: This is an obscure feature. Set to NULL at creation and
7677  from then on leave untouched and uninterpreted.
7678  */
7679  struct burn_source *next;
7680 
7681 
7682  /** Source specific data. Here the various source classes express their
7683  specific properties and the instance objects store their individual
7684  management data.
7685  E.g. data could point to a struct like this:
7686  struct app_burn_source
7687  {
7688  struct my_app *app_handle;
7689  ... other individual source parameters ...
7690  off_t fixed_size;
7691  };
7692 
7693  Function (*free_data) has to be prepared to clean up and free
7694  the struct.
7695  */
7696  void *data;
7697 
7698 
7699  /* @since 0.4.2 */
7700  /** Valid only if above member .(*read)() is NULL. This indicates a
7701  version of struct burn_source younger than 0.
7702  From then on, member .version tells which further members exist
7703  in the memory layout of struct burn_source. libburn will only touch
7704  those announced extensions.
7705 
7706  Versions:
7707  0 has .(*read)() != NULL, not even .version is present.
7708  1 has .version, .(*read_xt)(), .(*cancel)()
7709  */
7710  int version;
7711 
7712  /** This substitutes for (*read)() in versions above 0. */
7713  int (*read_xt)(struct burn_source *, unsigned char *buffer, int size);
7714 
7715  /** Informs the burn_source that the consumer of data prematurely
7716  ended reading. This call may or may not be issued by libburn
7717  before (*free_data)() is called.
7718  */
7719  int (*cancel)(struct burn_source *source);
7720 };
7721 
7722 #endif /* LIBISOFS_WITHOUT_LIBBURN */
7723 
7724 /* ----------------------------- Bug Fixes ----------------------------- */
7725 
7726 /* currently none being tested */
7727 
7728 
7729 /* ---------------------------- Improvements --------------------------- */
7730 
7731 /* currently none being tested */
7732 
7733 
7734 /* ---------------------------- Experiments ---------------------------- */
7735 
7736 
7737 /* Experiment: Write obsolete RR entries with Rock Ridge.
7738  I suspect Solaris wants to see them.
7739  DID NOT HELP: Solaris knows only RRIP_1991A.
7740 
7741  #define Libisofs_with_rrip_rR yes
7742 */
7743 
7744 
7745 #endif /*LIBISO_LIBISOFS_H_*/

Generated for libisofs by  doxygen 1.8.3.1