1 /******************************************************************************
4 * Copyright (c) 2020, longpanda <admin@ventoy.net>
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License as
8 * published by the Free Software Foundation; either version 3 of the
9 * License, or (at your option) any later version.
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, see <http://www.gnu.org/licenses/>.
21 #ifndef __VENTOY_DEF_H__
22 #define __VENTOY_DEF_H__
24 #define VTOY_MAX_SCRIPT_BUF (4 * 1024 * 1024)
26 #define VTOY_FILT_MIN_FILE_SIZE 32768
28 #define VTOY_SIZE_1GB 1073741824
29 #define VTOY_SIZE_512KB (512 * 1024)
31 #define JSON_SUCCESS 0
33 #define JSON_NOT_FOUND 2
35 #define ulong unsigned long
36 #define ulonglong unsigned long long
38 #define vtoy_to_upper(c) (((char)(c) >= 'a' && (char)(c) <= 'z') ? ((char)(c) - 'a' + 'A') : (char)(c))
40 #define VENTOY_CMD_RETURN(err) grub_errno = (err); return (err)
41 #define VENTOY_FILE_TYPE (GRUB_FILE_TYPE_NO_DECOMPRESS | GRUB_FILE_TYPE_LINUX_INITRD)
43 #define ventoy_env_op1(op, a) grub_env_##op(a)
44 #define ventoy_env_op2(op, a, b) grub_env_##op((a), (b))
46 #define ventoy_get_env(key) ventoy_env_op1(get, key)
47 #define ventoy_set_env(key, val) ventoy_env_op2(set, key, val)
49 typedef struct ventoy_initrd_ctx
51 const char *path_prefix
;
52 const char *dir_prefix
;
55 typedef struct cmd_para
58 grub_extcmd_func_t func
;
59 grub_command_flags_t flags
;
60 const struct grub_arg_option
*parser
;
63 const char *description
;
68 #define ventoy_align_2k(value) ((value + 2047) / 2048 * 2048)
69 #define ventoy_align(value, align) (((value) + ((align) - 1)) & (~((align) - 1)))
72 typedef struct cpio_newc_header
92 #define cmd_raw_name ctxt->extcmd->cmd->name
93 #define check_free(p, func) if (p) { func(p); p = NULL; }
94 #define grub_check_free(p) if (p) { grub_free(p); p = NULL; }
96 typedef int (*grub_char_check_func
)(int c
);
97 #define ventoy_is_decimal(str) ventoy_string_check(str, grub_isdigit)
100 // El Torito Boot Record Volume Descriptor
102 typedef struct eltorito_descriptor
106 grub_uint8_t version
;
107 grub_uint8_t system_id
[32];
108 grub_uint8_t reserved
[32];
109 grub_uint32_t sector
;
110 }eltorito_descriptor
;
112 typedef struct ventoy_iso9660_override
114 grub_uint32_t first_sector
;
115 grub_uint32_t first_sector_be
;
117 grub_uint32_t size_be
;
118 }ventoy_iso9660_override
;
120 typedef struct ventoy_udf_override
122 grub_uint32_t length
;
123 grub_uint32_t position
;
124 }ventoy_udf_override
;
128 #define img_type_iso 0
129 #define img_type_wim 1
130 #define img_type_efi 2
131 #define img_type_img 3
133 typedef struct img_info
141 const char *menu_prefix
;
151 struct img_info
*next
;
152 struct img_info
*prev
;
155 typedef struct img_iterator_node
157 struct img_iterator_node
*next
;
165 struct img_iterator_node
*parent
;
166 struct img_iterator_node
*firstchild
;
173 typedef struct initrd_info
177 grub_uint64_t offset
;
180 grub_uint8_t iso_type
; // 0: iso9660 1:udf
181 grub_uint32_t udf_start_block
;
183 grub_uint64_t override_offset
;
184 grub_uint32_t override_length
;
185 char override_data
[32];
187 struct initrd_info
*next
;
188 struct initrd_info
*prev
;
191 extern initrd_info
*g_initrd_img_list
;
192 extern initrd_info
*g_initrd_img_tail
;
193 extern int g_initrd_img_count
;
194 extern int g_valid_initrd_count
;
196 extern img_info
*g_ventoy_img_list
;
197 extern int g_ventoy_img_count
;
199 extern grub_uint8_t
*g_ventoy_cpio_buf
;
200 extern grub_uint32_t g_ventoy_cpio_size
;
201 extern cpio_newc_header
*g_ventoy_initrd_head
;
202 extern grub_uint8_t
*g_ventoy_runtime_buf
;
204 extern ventoy_guid g_ventoy_guid
;
206 extern ventoy_img_chunk_list g_img_chunk_list
;
207 extern ventoy_img_chunk_list g_wimiso_chunk_list
;
208 extern char *g_wimiso_path
;
210 extern int g_ventoy_debug
;
211 void ventoy_debug(const char *fmt
, ...);
212 #define debug(fmt, ...) if (g_ventoy_debug) ventoy_debug("[VTOY]: "fmt, __VA_ARGS__)
214 #define vtoy_ssprintf(buf, pos, fmt, ...) \
215 pos += grub_snprintf(buf + pos, VTOY_MAX_SCRIPT_BUF - pos, fmt, __VA_ARGS__)
217 #define FLAG_HEADER_RESERVED 0x00000001
218 #define FLAG_HEADER_COMPRESSION 0x00000002
219 #define FLAG_HEADER_READONLY 0x00000004
220 #define FLAG_HEADER_SPANNED 0x00000008
221 #define FLAG_HEADER_RESOURCE_ONLY 0x00000010
222 #define FLAG_HEADER_METADATA_ONLY 0x00000020
223 #define FLAG_HEADER_WRITE_IN_PROGRESS 0x00000040
224 #define FLAG_HEADER_RP_FIX 0x00000080 // reparse point fixup
225 #define FLAG_HEADER_COMPRESS_RESERVED 0x00010000
226 #define FLAG_HEADER_COMPRESS_XPRESS 0x00020000
227 #define FLAG_HEADER_COMPRESS_LZX 0x00040000
228 #define FLAG_HEADER_COMPRESS_LZMS 0x00080000
230 #define RESHDR_FLAG_FREE 0x01
231 #define RESHDR_FLAG_METADATA 0x02
232 #define RESHDR_FLAG_COMPRESSED 0x04
233 #define RESHDR_FLAG_SPANNED 0x08
237 /* A WIM resource header */
238 typedef struct wim_resource_header
240 grub_uint64_t size_in_wim
:56; /* Compressed length */
241 grub_uint64_t flags
:8; /* flags */
242 grub_uint64_t offset
; /* Offset */
243 grub_uint64_t raw_size
; /* Uncompressed length */
244 }wim_resource_header
;
246 /* WIM resource header length mask */
247 #define WIM_RESHDR_ZLEN_MASK 0x00ffffffffffffffULL
249 /* WIM resource header flags */
250 typedef enum wim_resource_header_flags
252 WIM_RESHDR_METADATA
= ( 0x02ULL
<< 56 ), /* Resource contains metadata */
253 WIM_RESHDR_COMPRESSED
= ( 0x04ULL
<< 56 ), /* Resource is compressed */
254 WIM_RESHDR_PACKED_STREAMS
= ( 0x10ULL
<< 56 ), /* Resource is compressed using packed streams */
255 }wim_resource_header_flags
;
257 #define WIM_HEAD_SIGNATURE "MSWIM\0\0"
260 typedef struct wim_header
262 grub_uint8_t signature
[8]; /* Signature */
263 grub_uint32_t header_len
; /* Header length */
264 grub_uint32_t version
; /* Verson */
265 grub_uint32_t flags
; /* Flags */
266 grub_uint32_t chunk_len
; /* Chunk length */
267 grub_uint8_t guid
[16]; /* GUID */
268 grub_uint16_t part
; /* Part number */
269 grub_uint16_t parts
; /* Total number of parts */
270 grub_uint32_t images
; /* number of images */
271 wim_resource_header lookup
; /* Lookup table */
272 wim_resource_header xml
; /* XML data */
273 wim_resource_header metadata
; /* Boot metadata */
274 grub_uint32_t boot_index
; /* Boot index */
275 wim_resource_header integrity
; /* Integrity table */
276 grub_uint8_t reserved
[60]; /* Reserved */
279 /* WIM header flags */
280 typedef enum wim_header_flags
282 WIM_HDR_XPRESS
= 0x00020000, /* WIM uses Xpress compresson */
283 WIM_HDR_LZX
= 0x00040000, /* WIM uses LZX compression */
286 /* A WIM file hash */
287 typedef struct wim_hash
290 grub_uint8_t sha1
[20];
293 /* A WIM lookup table entry */
294 typedef struct wim_lookup_entry
296 wim_resource_header resource
; /* Resource header */
297 grub_uint16_t part
; /* Part number */
298 grub_uint32_t refcnt
; /* Reference count */
299 wim_hash hash
; /* Hash */
302 /* WIM chunk length */
303 #define WIM_CHUNK_LEN 32768
305 /* A WIM chunk buffer */
306 typedef struct wim_chunk_buffer
308 grub_uint8_t data
[WIM_CHUNK_LEN
]; /*Data */
312 typedef struct wim_security_header
314 grub_uint32_t len
; /* Length */
315 grub_uint32_t count
; /* Number of entries */
316 }wim_security_header
;
318 /* Directory entry */
319 typedef struct wim_directory_entry
321 grub_uint64_t len
; /* Length */
322 grub_uint32_t attributes
; /* Attributes */
323 grub_uint32_t security
; /* Security ID */
324 grub_uint64_t subdir
; /* Subdirectory offset */
325 grub_uint8_t reserved1
[16]; /* Reserved */
326 grub_uint64_t created
; /* Creation time */
327 grub_uint64_t accessed
; /* Last access time */
328 grub_uint64_t written
; /* Last written time */
329 wim_hash hash
; /* Hash */
330 grub_uint8_t reserved2
[12]; /* Reserved */
331 grub_uint16_t streams
; /* Streams */
332 grub_uint16_t short_name_len
; /* Short name length */
333 grub_uint16_t name_len
; /* Name length */
334 }wim_directory_entry
;
337 #define WIM_ATTR_NORMAL 0x00000080UL
339 /** No security information exists for this file */
340 #define WIM_NO_SECURITY 0xffffffffUL
345 typedef struct wim_tail
347 grub_uint32_t wim_raw_size
;
348 grub_uint32_t wim_align_size
;
350 grub_uint8_t iso_type
;
351 grub_uint64_t file_offset
;
352 grub_uint32_t udf_start_block
;
353 grub_uint64_t fe_entry_size_offset
;
354 grub_uint64_t override_offset
;
355 grub_uint32_t override_len
;
356 grub_uint8_t override_data
[32];
358 wim_header wim_header
;
361 grub_uint32_t jump_exe_len
;
362 grub_uint8_t
*jump_bin_data
;
363 grub_uint32_t bin_raw_len
;
364 grub_uint32_t bin_align_len
;
366 grub_uint8_t
*new_meta_data
;
367 grub_uint32_t new_meta_len
;
368 grub_uint32_t new_meta_align_len
;
370 grub_uint8_t
*new_lookup_data
;
371 grub_uint32_t new_lookup_len
;
372 grub_uint32_t new_lookup_align_len
;
375 typedef struct wim_patch
382 wim_lookup_entry
*replace_look
;
386 struct wim_patch
*next
;
390 typedef enum _JSON_TYPE
392 JSON_TYPE_NUMBER
= 0,
402 typedef struct _VTOY_JSON
404 struct _VTOY_JSON
*pstPrev
;
405 struct _VTOY_JSON
*pstNext
;
406 struct _VTOY_JSON
*pstChild
;
408 JSON_TYPE enDataType
;
413 grub_uint64_t lValue
;
419 typedef struct _JSON_PARSE
423 grub_uint32_t uiBufSize
;
426 #define JSON_NEW_ITEM(pstJson, ret) \
428 (pstJson) = (VTOY_JSON *)grub_zalloc(sizeof(VTOY_JSON)); \
429 if (NULL == (pstJson)) \
431 json_debug("Failed to alloc memory for json.\n"); \
436 typedef int (*ventoy_plugin_entry_pf
)(VTOY_JSON
*json
, const char *isodisk
);
437 typedef int (*ventoy_plugin_check_pf
)(VTOY_JSON
*json
, const char *isodisk
);
439 typedef struct plugin_entry
442 ventoy_plugin_entry_pf entryfunc
;
443 ventoy_plugin_check_pf checkfunc
;
447 void ventoy_fill_os_param(grub_file_t file
, ventoy_os_param
*param
);
448 grub_err_t
ventoy_cmd_isolinux_initrd_collect(grub_extcmd_context_t ctxt
, int argc
, char **args
);
449 grub_err_t
ventoy_cmd_grub_initrd_collect(grub_extcmd_context_t ctxt
, int argc
, char **args
);
450 grub_err_t
ventoy_cmd_specify_initrd_file(grub_extcmd_context_t ctxt
, int argc
, char **args
);
451 grub_err_t
ventoy_cmd_dump_initrd_list(grub_extcmd_context_t ctxt
, int argc
, char **args
);
452 grub_err_t
ventoy_cmd_clear_initrd_list(grub_extcmd_context_t ctxt
, int argc
, char **args
);
453 grub_uint32_t
ventoy_get_iso_boot_catlog(grub_file_t file
);
454 int ventoy_has_efi_eltorito(grub_file_t file
, grub_uint32_t sector
);
455 grub_err_t
ventoy_cmd_linux_chain_data(grub_extcmd_context_t ctxt
, int argc
, char **args
);
456 grub_err_t
ventoy_cmd_linux_locate_initrd(grub_extcmd_context_t ctxt
, int argc
, char **args
);
457 grub_err_t
ventoy_cmd_initrd_count(grub_extcmd_context_t ctxt
, int argc
, char **args
);
458 grub_err_t
ventoy_cmd_valid_initrd_count(grub_extcmd_context_t ctxt
, int argc
, char **args
);
459 grub_err_t
ventoy_cmd_load_cpio(grub_extcmd_context_t ctxt
, int argc
, char **args
);
460 int ventoy_cpio_newc_fill_head(void *buf
, int filesize
, const void *filedata
, const char *name
);
461 grub_file_t
ventoy_grub_file_open(enum grub_file_type type
, const char *fmt
, ...);
462 grub_uint64_t
ventoy_grub_get_file_size(const char *fmt
, ...);
463 int ventoy_is_file_exist(const char *fmt
, ...);
464 int ventoy_is_dir_exist(const char *fmt
, ...);
465 int ventoy_fill_data(grub_uint32_t buflen
, char *buffer
);
466 grub_err_t
ventoy_cmd_load_plugin(grub_extcmd_context_t ctxt
, int argc
, char **args
);
467 grub_err_t
ventoy_cmd_wimdows_reset(grub_extcmd_context_t ctxt
, int argc
, char **args
);
468 grub_err_t
ventoy_cmd_windows_chain_data(grub_extcmd_context_t ctxt
, int argc
, char **args
);
469 grub_err_t
ventoy_cmd_wim_chain_data(grub_extcmd_context_t ctxt
, int argc
, char **args
);
470 grub_err_t
ventoy_cmd_dump_wim_patch(grub_extcmd_context_t ctxt
, int argc
, char **args
);
472 VTOY_JSON
*vtoy_json_find_item
475 JSON_TYPE enDataType
,
478 int vtoy_json_parse_value
486 VTOY_JSON
* vtoy_json_create(void);
487 int vtoy_json_parse(VTOY_JSON
*pstJson
, const char *szJsonData
);
489 int vtoy_json_scan_parse
491 const VTOY_JSON
*pstJson
,
492 grub_uint32_t uiParseNum
,
493 JSON_PARSE
*pstJsonParse
496 int vtoy_json_scan_array
500 VTOY_JSON
**ppstArrayItem
503 int vtoy_json_scan_array_ex
507 VTOY_JSON
**ppstArrayItem
509 int vtoy_json_scan_object
513 VTOY_JSON
**ppstObjectItem
515 int vtoy_json_get_int
521 int vtoy_json_get_uint
525 grub_uint32_t
*puiValue
527 int vtoy_json_get_uint64
531 grub_uint64_t
*pui64Value
533 int vtoy_json_get_bool
537 grub_uint8_t
*pbValue
539 int vtoy_json_get_string
543 grub_uint32_t uiBufLen
,
546 const char * vtoy_json_get_string_ex(VTOY_JSON
*pstJson
, const char *szKey
);
547 int vtoy_json_destroy(VTOY_JSON
*pstJson
);
550 grub_uint32_t CalculateCrc32
553 grub_uint32_t Length
,
554 grub_uint32_t InitValue
557 static inline int ventoy_isspace (int c
)
559 return (c
== '\n' || c
== '\r' || c
== ' ' || c
== '\t');
562 static inline int ventoy_is_word_end(int c
)
564 return (c
== 0 || c
== ',' || ventoy_isspace(c
));
568 typedef struct ventoy_part_table
570 grub_uint8_t Active
; // 0x00 0x80
572 grub_uint8_t StartHead
;
573 grub_uint16_t StartSector
: 6;
574 grub_uint16_t StartCylinder
: 10;
578 grub_uint8_t EndHead
;
579 grub_uint16_t EndSector
: 6;
580 grub_uint16_t EndCylinder
: 10;
582 grub_uint32_t StartSectorId
;
583 grub_uint32_t SectorCount
;
586 typedef struct ventoy_mbr_head
588 grub_uint8_t BootCode
[446];
589 ventoy_part_table PartTbl
[4];
595 typedef struct file_fullpath
600 typedef struct install_template
608 file_fullpath
*templatepath
;
610 struct install_template
*next
;
613 typedef struct persistence_config
621 file_fullpath
*backendpath
;
623 struct persistence_config
*next
;
626 #define vtoy_alias_image_file 0
627 #define vtoy_alias_directory 1
629 typedef struct menu_alias
636 struct menu_alias
*next
;
639 #define vtoy_class_image_file 0
640 #define vtoy_class_directory 1
642 typedef struct menu_class
649 struct menu_class
*next
;
652 typedef struct injection_config
658 struct injection_config
*next
;
661 extern int g_ventoy_menu_esc
;
662 extern int g_ventoy_suppress_esc
;
663 extern int g_ventoy_last_entry
;
664 extern int g_ventoy_memdisk_mode
;
665 extern int g_ventoy_iso_raw
;
666 extern int g_ventoy_iso_uefi_drv
;
667 extern int g_ventoy_case_insensitive
;
668 extern grub_uint8_t g_ventoy_chain_type
;
670 int ventoy_cmp_img(img_info
*img1
, img_info
*img2
);
671 void ventoy_swap_img(img_info
*img1
, img_info
*img2
);
672 char * ventoy_plugin_get_cur_install_template(const char *isopath
);
673 install_template
* ventoy_plugin_find_install_template(const char *isopath
);
674 persistence_config
* ventoy_plugin_find_persistent(const char *isopath
);
675 void ventoy_plugin_dump_injection(void);
676 void ventoy_plugin_dump_auto_install(void);
677 int ventoy_fill_windows_rtdata(void *buf
, char *isopath
);
678 int ventoy_plugin_get_persistent_chunklist(const char *isopath
, int index
, ventoy_img_chunk_list
*chunk_list
);
679 const char * ventoy_plugin_get_injection(const char *isopath
);
680 const char * ventoy_plugin_get_menu_alias(int type
, const char *isopath
);
681 const char * ventoy_plugin_get_menu_class(int type
, const char *name
);
682 int ventoy_get_block_list(grub_file_t file
, ventoy_img_chunk_list
*chunklist
, grub_disk_addr_t start
);
683 int ventoy_check_block_list(grub_file_t file
, ventoy_img_chunk_list
*chunklist
, grub_disk_addr_t start
);
684 void ventoy_plugin_dump_persistence(void);
685 grub_err_t
ventoy_cmd_plugin_check_json(grub_extcmd_context_t ctxt
, int argc
, char **args
);
686 grub_err_t
ventoy_cmd_linux_get_main_initrd_index(grub_extcmd_context_t ctxt
, int argc
, char **args
);
687 grub_err_t
ventoy_cmd_collect_wim_patch(grub_extcmd_context_t ctxt
, int argc
, char **args
);
688 grub_err_t
ventoy_cmd_wim_patch_count(grub_extcmd_context_t ctxt
, int argc
, char **args
);
689 grub_err_t
ventoy_cmd_locate_wim_patch(grub_extcmd_context_t ctxt
, int argc
, char **args
);
691 #endif /* __VENTOY_DEF_H__ */