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

Generated for libisofs by  doxygen 1.8.1.1