wimlib.net Git - wimlib/blob - include/wimlib/wim.h

   1 #ifndef _WIMLIB_WIM_H
   2 #define _WIMLIB_WIM_H
   3
   4 #include "wimlib.h"
   5 #include "wimlib/header.h"
   6 #include "wimlib/types.h"
   7 #include "wimlib/file_io.h"
   8 #include "wimlib/list.h"
   9
  10 struct wim_info;
  11 struct wim_lookup_table;
  12 struct wim_image_metadata;
  13
  14 /* The opaque structure exposed to the wimlib API. */
  15 struct WIMStruct {
  16
  17         /* File descriptor for the WIM file, opened for reading.  in_fd.fd is -1
  18          * if the WIM file has not been opened or there is no associated file
  19          * backing it yet. */
  20         struct filedes in_fd;
  21
  22         /* File descriptor, opened either for writing only or for
  23          * reading+writing, for the WIM file (if any) currently being written.
  24          * */
  25         struct filedes out_fd;
  26
  27         /* The name of the WIM file (if any) that has been opened. */
  28         tchar *filename;
  29
  30         /* The lookup table for the WIM file. */
  31         struct wim_lookup_table *lookup_table;
  32
  33         /* Information retrieved from the XML data, arranged in an orderly
  34          * manner. */
  35         struct wim_info *wim_info;
  36
  37         /* Array of the image metadata, one for each image in the WIM. */
  38         struct wim_image_metadata **image_metadata;
  39
  40         /* The header of the WIM file. */
  41         struct wim_header hdr;
  42
  43         /* Temporary field */
  44         void *private;
  45
  46         struct wimlib_decompressor *decompressor;
  47         u8 decompressor_ctype;
  48         u32 decompressor_max_block_size;
  49
  50         struct list_head subwims;
  51
  52         struct list_head subwim_node;
  53
  54         /* The currently selected image, indexed starting at 1.  If not 0,
  55          * subtract 1 from this to get the index of the current image in the
  56          * image_metadata array. */
  57         int current_image;
  58
  59         /* Have any images been deleted? */
  60         u8 deletion_occurred : 1;
  61
  62         /* Do we know that all the stream reference counts in the WIM are
  63          * correct?  If so, this is set to 1 and deletions are safe; otherwise
  64          * this is set to 0 and deletions are not safe until reference counts
  65          * are recalculated.  (This is due to a bug in M$'s software that
  66          * generates WIMs with invalid reference counts.)  */
  67         u8 refcnts_ok : 1;
  68
  69         /* Has the underlying WIM file been locked for appending?  */
  70         u8 locked_for_append : 1;
  71
  72         /* One of WIMLIB_COMPRESSION_TYPE_*, cached from the header flags. */
  73         u8 compression_type;
  74
  75         /* Overridden compression type for wimlib_overwrite() or wimlib_write().
  76          * Can be changed by wimlib_set_output_compression_type(); otherwise is
  77          * the same as compression_type.  */
  78         u8 out_compression_type;
  79
  80         /* Compression type for writing packed streams; can be set with
  81          * wimlib_set_output_pack_compression_type().  */
  82         u8 out_pack_compression_type;
  83
  84         /* Uncompressed size of compressed chunks in this WIM (cached from
  85          * header).  */
  86         u32 chunk_size;
  87
  88         /* Overridden chunk size for wimlib_overwrite() or wimlib_write().  Can
  89          * be changed by wimlib_set_output_chunk_size(); otherwise is the same
  90          * as chunk_size.  */
  91         u32 out_chunk_size;
  92
  93         /* Chunk size for writing packed streams; can be set with
  94          * wimlib_set_output_pack_chunk_size().  */
  95         u32 out_pack_chunk_size;
  96
  97         /* Currently registered progress function for this WIMStruct, or NULL if
  98          * no progress function is currently registered for this WIMStruct.  */
  99         wimlib_progress_func_t progfunc;
 100         void *progctx;
 101 };
 102
 103 static inline bool wim_is_pipable(const WIMStruct *wim)
 104 {
 105         return (wim->hdr.magic == PWM_MAGIC);
 106 }
 107
 108 static inline bool wim_has_integrity_table(const WIMStruct *wim)
 109 {
 110         return (wim->hdr.integrity_table_reshdr.offset_in_wim != 0);
 111 }
 112
 113 static inline bool wim_has_metadata(const WIMStruct *wim)
 114 {
 115         return (wim->image_metadata != NULL || wim->hdr.image_count == 0);
 116 }
 117
 118 extern int
 119 wim_recalculate_refcnts(WIMStruct *wim);
 120
 121 extern int
 122 set_wim_hdr_cflags(int ctype, struct wim_header *hdr);
 123
 124 extern int
 125 init_wim_header(struct wim_header *hdr, int ctype, u32 chunk_size);
 126
 127 extern int
 128 read_wim_header(WIMStruct *wim, struct wim_header *hdr);
 129
 130 extern int
 131 write_wim_header(const struct wim_header *hdr, struct filedes *out_fd);
 132
 133 extern int
 134 write_wim_header_at_offset(const struct wim_header *hdr, struct filedes *out_fd,
 135                            off_t offset);
 136
 137 extern int
 138 write_wim_header_flags(u32 hdr_flags, struct filedes *out_fd);
 139
 140 extern int
 141 select_wim_image(WIMStruct *wim, int image);
 142
 143 extern int
 144 for_image(WIMStruct *wim, int image, int (*visitor)(WIMStruct *));
 145
 146 extern int
 147 wim_checksum_unhashed_streams(WIMStruct *wim);
 148
 149 /* Internal open flags (pass to open_wim_as_WIMStruct(), not wimlib_open_wim())
 150  */
 151 #define WIMLIB_OPEN_FLAG_FROM_PIPE      0x80000000
 152
 153 extern int
 154 open_wim_as_WIMStruct(const void *wim_filename_or_fd, int open_flags,
 155                       WIMStruct **wim_ret,
 156                       wimlib_progress_func_t progfunc, void *progctx);
 157
 158 extern int
 159 close_wim(WIMStruct *wim);
 160
 161 extern int
 162 can_modify_wim(WIMStruct *wim);
 163
 164 extern int
 165 can_delete_from_wim(WIMStruct *wim);
 166
 167 #endif /* _WIMLIB_WIM_H */