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_PART_BUF_LEN (128 * 1024)
28 #define VTOY_FILT_MIN_FILE_SIZE 32768
30 #define VTOY_SIZE_1GB 1073741824
31 #define VTOY_SIZE_512KB (512 * 1024)
33 #define JSON_SUCCESS 0
35 #define JSON_NOT_FOUND 2
37 #define ulong unsigned long
38 #define ulonglong unsigned long long
40 #define vtoy_to_upper(c) (((char)(c) >= 'a' && (char)(c) <= 'z') ? ((char)(c) - 'a' + 'A') : (char)(c))
42 #define VENTOY_CMD_RETURN(err) grub_errno = (err); return (err)
43 #define VENTOY_FILE_TYPE (GRUB_FILE_TYPE_NO_DECOMPRESS | GRUB_FILE_TYPE_LINUX_INITRD)
45 #define ventoy_env_op1(op, a) grub_env_##op(a)
46 #define ventoy_env_op2(op, a, b) grub_env_##op((a), (b))
48 #define ventoy_get_env(key) ventoy_env_op1(get, key)
49 #define ventoy_set_env(key, val) ventoy_env_op2(set, key, val)
51 typedef struct ventoy_initrd_ctx
53 const char *path_prefix
;
54 const char *dir_prefix
;
57 typedef struct cmd_para
60 grub_extcmd_func_t func
;
61 grub_command_flags_t flags
;
62 const struct grub_arg_option
*parser
;
65 const char *description
;
70 #define ventoy_align_2k(value) ((value + 2047) / 2048 * 2048)
71 #define ventoy_align(value, align) (((value) + ((align) - 1)) & (~((align) - 1)))
74 typedef struct cpio_newc_header
94 #define cmd_raw_name ctxt->extcmd->cmd->name
95 #define check_free(p, func) if (p) { func(p); p = NULL; }
96 #define grub_check_free(p) if (p) { grub_free(p); p = NULL; }
98 typedef int (*grub_char_check_func
)(int c
);
99 #define ventoy_is_decimal(str) ventoy_string_check(str, grub_isdigit)
102 // El Torito Boot Record Volume Descriptor
104 typedef struct eltorito_descriptor
108 grub_uint8_t version
;
109 grub_uint8_t system_id
[32];
110 grub_uint8_t reserved
[32];
111 grub_uint32_t sector
;
112 }eltorito_descriptor
;
114 typedef struct ventoy_iso9660_override
116 grub_uint32_t first_sector
;
117 grub_uint32_t first_sector_be
;
119 grub_uint32_t size_be
;
120 }ventoy_iso9660_override
;
122 typedef struct ventoy_udf_override
124 grub_uint32_t length
;
125 grub_uint32_t position
;
126 }ventoy_udf_override
;
128 typedef struct ventoy_iso9660_vd
140 #define img_type_iso 0
141 #define img_type_wim 1
142 #define img_type_efi 2
143 #define img_type_img 3
145 typedef struct img_info
153 const char *menu_prefix
;
163 struct img_info
*next
;
164 struct img_info
*prev
;
167 typedef struct img_iterator_node
169 struct img_iterator_node
*next
;
177 struct img_iterator_node
*parent
;
178 struct img_iterator_node
*firstchild
;
185 typedef struct initrd_info
189 grub_uint64_t offset
;
192 grub_uint8_t iso_type
; // 0: iso9660 1:udf
193 grub_uint32_t udf_start_block
;
195 grub_uint64_t override_offset
;
196 grub_uint32_t override_length
;
197 char override_data
[32];
199 struct initrd_info
*next
;
200 struct initrd_info
*prev
;
203 extern initrd_info
*g_initrd_img_list
;
204 extern initrd_info
*g_initrd_img_tail
;
205 extern int g_initrd_img_count
;
206 extern int g_valid_initrd_count
;
208 extern img_info
*g_ventoy_img_list
;
209 extern int g_ventoy_img_count
;
211 extern grub_uint8_t
*g_ventoy_cpio_buf
;
212 extern grub_uint32_t g_ventoy_cpio_size
;
213 extern cpio_newc_header
*g_ventoy_initrd_head
;
214 extern grub_uint8_t
*g_ventoy_runtime_buf
;
216 extern ventoy_guid g_ventoy_guid
;
218 extern ventoy_img_chunk_list g_img_chunk_list
;
219 extern ventoy_img_chunk_list g_wimiso_chunk_list
;
220 extern char *g_wimiso_path
;
222 extern int g_ventoy_debug
;
223 void ventoy_debug(const char *fmt
, ...);
224 #define debug(fmt, ...) if (g_ventoy_debug) ventoy_debug("[VTOY]: "fmt, __VA_ARGS__)
226 #define vtoy_ssprintf(buf, pos, fmt, ...) \
227 pos += grub_snprintf(buf + pos, VTOY_MAX_SCRIPT_BUF - pos, fmt, __VA_ARGS__)
229 #define FLAG_HEADER_RESERVED 0x00000001
230 #define FLAG_HEADER_COMPRESSION 0x00000002
231 #define FLAG_HEADER_READONLY 0x00000004
232 #define FLAG_HEADER_SPANNED 0x00000008
233 #define FLAG_HEADER_RESOURCE_ONLY 0x00000010
234 #define FLAG_HEADER_METADATA_ONLY 0x00000020
235 #define FLAG_HEADER_WRITE_IN_PROGRESS 0x00000040
236 #define FLAG_HEADER_RP_FIX 0x00000080 // reparse point fixup
237 #define FLAG_HEADER_COMPRESS_RESERVED 0x00010000
238 #define FLAG_HEADER_COMPRESS_XPRESS 0x00020000
239 #define FLAG_HEADER_COMPRESS_LZX 0x00040000
240 #define FLAG_HEADER_COMPRESS_LZMS 0x00080000
242 #define RESHDR_FLAG_FREE 0x01
243 #define RESHDR_FLAG_METADATA 0x02
244 #define RESHDR_FLAG_COMPRESSED 0x04
245 #define RESHDR_FLAG_SPANNED 0x08
249 /* A WIM resource header */
250 typedef struct wim_resource_header
252 grub_uint64_t size_in_wim
:56; /* Compressed length */
253 grub_uint64_t flags
:8; /* flags */
254 grub_uint64_t offset
; /* Offset */
255 grub_uint64_t raw_size
; /* Uncompressed length */
256 }wim_resource_header
;
258 /* WIM resource header length mask */
259 #define WIM_RESHDR_ZLEN_MASK 0x00ffffffffffffffULL
261 /* WIM resource header flags */
262 typedef enum wim_resource_header_flags
264 WIM_RESHDR_METADATA
= ( 0x02ULL
<< 56 ), /* Resource contains metadata */
265 WIM_RESHDR_COMPRESSED
= ( 0x04ULL
<< 56 ), /* Resource is compressed */
266 WIM_RESHDR_PACKED_STREAMS
= ( 0x10ULL
<< 56 ), /* Resource is compressed using packed streams */
267 }wim_resource_header_flags
;
269 #define WIM_HEAD_SIGNATURE "MSWIM\0\0"
272 typedef struct wim_header
274 grub_uint8_t signature
[8]; /* Signature */
275 grub_uint32_t header_len
; /* Header length */
276 grub_uint32_t version
; /* Verson */
277 grub_uint32_t flags
; /* Flags */
278 grub_uint32_t chunk_len
; /* Chunk length */
279 grub_uint8_t guid
[16]; /* GUID */
280 grub_uint16_t part
; /* Part number */
281 grub_uint16_t parts
; /* Total number of parts */
282 grub_uint32_t images
; /* number of images */
283 wim_resource_header lookup
; /* Lookup table */
284 wim_resource_header xml
; /* XML data */
285 wim_resource_header metadata
; /* Boot metadata */
286 grub_uint32_t boot_index
; /* Boot index */
287 wim_resource_header integrity
; /* Integrity table */
288 grub_uint8_t reserved
[60]; /* Reserved */
291 /* WIM header flags */
292 typedef enum wim_header_flags
294 WIM_HDR_XPRESS
= 0x00020000, /* WIM uses Xpress compresson */
295 WIM_HDR_LZX
= 0x00040000, /* WIM uses LZX compression */
298 /* A WIM file hash */
299 typedef struct wim_hash
302 grub_uint8_t sha1
[20];
305 /* A WIM lookup table entry */
306 typedef struct wim_lookup_entry
308 wim_resource_header resource
; /* Resource header */
309 grub_uint16_t part
; /* Part number */
310 grub_uint32_t refcnt
; /* Reference count */
311 wim_hash hash
; /* Hash */
314 /* WIM chunk length */
315 #define WIM_CHUNK_LEN 32768
317 /* A WIM chunk buffer */
318 typedef struct wim_chunk_buffer
320 grub_uint8_t data
[WIM_CHUNK_LEN
]; /*Data */
324 typedef struct wim_security_header
326 grub_uint32_t len
; /* Length */
327 grub_uint32_t count
; /* Number of entries */
328 }wim_security_header
;
330 /* Directory entry */
331 typedef struct wim_directory_entry
333 grub_uint64_t len
; /* Length */
334 grub_uint32_t attributes
; /* Attributes */
335 grub_uint32_t security
; /* Security ID */
336 grub_uint64_t subdir
; /* Subdirectory offset */
337 grub_uint8_t reserved1
[16]; /* Reserved */
338 grub_uint64_t created
; /* Creation time */
339 grub_uint64_t accessed
; /* Last access time */
340 grub_uint64_t written
; /* Last written time */
341 wim_hash hash
; /* Hash */
342 grub_uint8_t reserved2
[12]; /* Reserved */
343 grub_uint16_t streams
; /* Streams */
344 grub_uint16_t short_name_len
; /* Short name length */
345 grub_uint16_t name_len
; /* Name length */
346 }wim_directory_entry
;
349 #define WIM_ATTR_NORMAL 0x00000080UL
351 /** No security information exists for this file */
352 #define WIM_NO_SECURITY 0xffffffffUL
357 typedef struct wim_tail
359 grub_uint32_t wim_raw_size
;
360 grub_uint32_t wim_align_size
;
362 grub_uint8_t iso_type
;
363 grub_uint64_t file_offset
;
364 grub_uint32_t udf_start_block
;
365 grub_uint64_t fe_entry_size_offset
;
366 grub_uint64_t override_offset
;
367 grub_uint32_t override_len
;
368 grub_uint8_t override_data
[32];
370 wim_header wim_header
;
373 grub_uint32_t jump_exe_len
;
374 grub_uint8_t
*jump_bin_data
;
375 grub_uint32_t bin_raw_len
;
376 grub_uint32_t bin_align_len
;
378 grub_uint8_t
*new_meta_data
;
379 grub_uint32_t new_meta_len
;
380 grub_uint32_t new_meta_align_len
;
382 grub_uint8_t
*new_lookup_data
;
383 grub_uint32_t new_lookup_len
;
384 grub_uint32_t new_lookup_align_len
;
387 typedef struct wim_patch
394 wim_lookup_entry
*replace_look
;
398 struct wim_patch
*next
;
402 typedef enum _JSON_TYPE
404 JSON_TYPE_NUMBER
= 0,
414 typedef struct _VTOY_JSON
416 struct _VTOY_JSON
*pstPrev
;
417 struct _VTOY_JSON
*pstNext
;
418 struct _VTOY_JSON
*pstChild
;
420 JSON_TYPE enDataType
;
425 grub_uint64_t lValue
;
431 typedef struct _JSON_PARSE
435 grub_uint32_t uiBufSize
;
438 #define JSON_NEW_ITEM(pstJson, ret) \
440 (pstJson) = (VTOY_JSON *)grub_zalloc(sizeof(VTOY_JSON)); \
441 if (NULL == (pstJson)) \
443 json_debug("Failed to alloc memory for json.\n"); \
448 typedef int (*ventoy_plugin_entry_pf
)(VTOY_JSON
*json
, const char *isodisk
);
449 typedef int (*ventoy_plugin_check_pf
)(VTOY_JSON
*json
, const char *isodisk
);
451 typedef struct plugin_entry
454 ventoy_plugin_entry_pf entryfunc
;
455 ventoy_plugin_check_pf checkfunc
;
459 void ventoy_fill_os_param(grub_file_t file
, ventoy_os_param
*param
);
460 grub_err_t
ventoy_cmd_isolinux_initrd_collect(grub_extcmd_context_t ctxt
, int argc
, char **args
);
461 grub_err_t
ventoy_cmd_grub_initrd_collect(grub_extcmd_context_t ctxt
, int argc
, char **args
);
462 grub_err_t
ventoy_cmd_specify_initrd_file(grub_extcmd_context_t ctxt
, int argc
, char **args
);
463 grub_err_t
ventoy_cmd_dump_initrd_list(grub_extcmd_context_t ctxt
, int argc
, char **args
);
464 grub_err_t
ventoy_cmd_clear_initrd_list(grub_extcmd_context_t ctxt
, int argc
, char **args
);
465 grub_uint32_t
ventoy_get_iso_boot_catlog(grub_file_t file
);
466 int ventoy_has_efi_eltorito(grub_file_t file
, grub_uint32_t sector
);
467 grub_err_t
ventoy_cmd_linux_chain_data(grub_extcmd_context_t ctxt
, int argc
, char **args
);
468 grub_err_t
ventoy_cmd_linux_locate_initrd(grub_extcmd_context_t ctxt
, int argc
, char **args
);
469 grub_err_t
ventoy_cmd_initrd_count(grub_extcmd_context_t ctxt
, int argc
, char **args
);
470 grub_err_t
ventoy_cmd_valid_initrd_count(grub_extcmd_context_t ctxt
, int argc
, char **args
);
471 grub_err_t
ventoy_cmd_load_cpio(grub_extcmd_context_t ctxt
, int argc
, char **args
);
472 grub_err_t
ventoy_cmd_trailer_cpio(grub_extcmd_context_t ctxt
, int argc
, char **args
);
473 int ventoy_cpio_newc_fill_head(void *buf
, int filesize
, const void *filedata
, const char *name
);
474 grub_file_t
ventoy_grub_file_open(enum grub_file_type type
, const char *fmt
, ...);
475 grub_uint64_t
ventoy_grub_get_file_size(const char *fmt
, ...);
476 int ventoy_is_file_exist(const char *fmt
, ...);
477 int ventoy_is_dir_exist(const char *fmt
, ...);
478 int ventoy_fill_data(grub_uint32_t buflen
, char *buffer
);
479 grub_err_t
ventoy_cmd_load_plugin(grub_extcmd_context_t ctxt
, int argc
, char **args
);
480 grub_err_t
ventoy_cmd_wimdows_reset(grub_extcmd_context_t ctxt
, int argc
, char **args
);
481 grub_err_t
ventoy_cmd_windows_chain_data(grub_extcmd_context_t ctxt
, int argc
, char **args
);
482 grub_err_t
ventoy_cmd_wim_chain_data(grub_extcmd_context_t ctxt
, int argc
, char **args
);
483 grub_err_t
ventoy_cmd_dump_wim_patch(grub_extcmd_context_t ctxt
, int argc
, char **args
);
485 VTOY_JSON
*vtoy_json_find_item
488 JSON_TYPE enDataType
,
491 int vtoy_json_parse_value
499 VTOY_JSON
* vtoy_json_create(void);
500 int vtoy_json_parse(VTOY_JSON
*pstJson
, const char *szJsonData
);
502 int vtoy_json_scan_parse
504 const VTOY_JSON
*pstJson
,
505 grub_uint32_t uiParseNum
,
506 JSON_PARSE
*pstJsonParse
509 int vtoy_json_scan_array
513 VTOY_JSON
**ppstArrayItem
516 int vtoy_json_scan_array_ex
520 VTOY_JSON
**ppstArrayItem
522 int vtoy_json_scan_object
526 VTOY_JSON
**ppstObjectItem
528 int vtoy_json_get_int
534 int vtoy_json_get_uint
538 grub_uint32_t
*puiValue
540 int vtoy_json_get_uint64
544 grub_uint64_t
*pui64Value
546 int vtoy_json_get_bool
550 grub_uint8_t
*pbValue
552 int vtoy_json_get_string
556 grub_uint32_t uiBufLen
,
559 const char * vtoy_json_get_string_ex(VTOY_JSON
*pstJson
, const char *szKey
);
560 int vtoy_json_destroy(VTOY_JSON
*pstJson
);
563 grub_uint32_t CalculateCrc32
566 grub_uint32_t Length
,
567 grub_uint32_t InitValue
570 static inline int ventoy_isspace (int c
)
572 return (c
== '\n' || c
== '\r' || c
== ' ' || c
== '\t');
575 static inline int ventoy_is_word_end(int c
)
577 return (c
== 0 || c
== ',' || ventoy_isspace(c
));
581 typedef struct ventoy_part_table
583 grub_uint8_t Active
; // 0x00 0x80
585 grub_uint8_t StartHead
;
586 grub_uint16_t StartSector
: 6;
587 grub_uint16_t StartCylinder
: 10;
591 grub_uint8_t EndHead
;
592 grub_uint16_t EndSector
: 6;
593 grub_uint16_t EndCylinder
: 10;
595 grub_uint32_t StartSectorId
;
596 grub_uint32_t SectorCount
;
599 typedef struct ventoy_mbr_head
601 grub_uint8_t BootCode
[446];
602 ventoy_part_table PartTbl
[4];
608 typedef struct file_fullpath
613 typedef struct install_template
621 file_fullpath
*templatepath
;
623 struct install_template
*next
;
626 typedef struct persistence_config
634 file_fullpath
*backendpath
;
636 struct persistence_config
*next
;
639 #define vtoy_alias_image_file 0
640 #define vtoy_alias_directory 1
642 typedef struct menu_alias
649 struct menu_alias
*next
;
652 #define vtoy_class_image_file 0
653 #define vtoy_class_directory 1
655 typedef struct menu_class
662 struct menu_class
*next
;
665 typedef struct injection_config
671 struct injection_config
*next
;
674 extern int g_ventoy_menu_esc
;
675 extern int g_ventoy_suppress_esc
;
676 extern int g_ventoy_last_entry
;
677 extern int g_ventoy_memdisk_mode
;
678 extern int g_ventoy_iso_raw
;
679 extern int g_ventoy_iso_uefi_drv
;
680 extern int g_ventoy_case_insensitive
;
681 extern grub_uint8_t g_ventoy_chain_type
;
684 #define ventoy_unix_fill_virt(new_data, new_len) \
686 data_secs = (new_len + 2047) / 2048; \
687 cur->mem_sector_start = sector; \
688 cur->mem_sector_end = cur->mem_sector_start + data_secs; \
689 cur->mem_sector_offset = offset; \
690 cur->remap_sector_start = 0; \
691 cur->remap_sector_end = 0; \
692 cur->org_sector_start = 0; \
693 grub_memcpy(override + offset, new_data, new_len); \
695 sector += data_secs; \
697 chain->virt_img_size_in_bytes += data_secs * 2048; \
700 char * ventoy_get_line(char *start
);
701 int ventoy_cmp_img(img_info
*img1
, img_info
*img2
);
702 void ventoy_swap_img(img_info
*img1
, img_info
*img2
);
703 char * ventoy_plugin_get_cur_install_template(const char *isopath
);
704 install_template
* ventoy_plugin_find_install_template(const char *isopath
);
705 persistence_config
* ventoy_plugin_find_persistent(const char *isopath
);
706 void ventoy_plugin_dump_injection(void);
707 void ventoy_plugin_dump_auto_install(void);
708 int ventoy_fill_windows_rtdata(void *buf
, char *isopath
);
709 int ventoy_plugin_get_persistent_chunklist(const char *isopath
, int index
, ventoy_img_chunk_list
*chunk_list
);
710 const char * ventoy_plugin_get_injection(const char *isopath
);
711 const char * ventoy_plugin_get_menu_alias(int type
, const char *isopath
);
712 const char * ventoy_plugin_get_menu_class(int type
, const char *name
);
713 int ventoy_get_block_list(grub_file_t file
, ventoy_img_chunk_list
*chunklist
, grub_disk_addr_t start
);
714 int ventoy_check_block_list(grub_file_t file
, ventoy_img_chunk_list
*chunklist
, grub_disk_addr_t start
);
715 void ventoy_plugin_dump_persistence(void);
716 grub_err_t
ventoy_cmd_plugin_check_json(grub_extcmd_context_t ctxt
, int argc
, char **args
);
717 grub_err_t
ventoy_cmd_linux_get_main_initrd_index(grub_extcmd_context_t ctxt
, int argc
, char **args
);
718 grub_err_t
ventoy_cmd_collect_wim_patch(grub_extcmd_context_t ctxt
, int argc
, char **args
);
719 grub_err_t
ventoy_cmd_wim_patch_count(grub_extcmd_context_t ctxt
, int argc
, char **args
);
720 grub_err_t
ventoy_cmd_locate_wim_patch(grub_extcmd_context_t ctxt
, int argc
, char **args
);
721 grub_err_t
ventoy_cmd_unix_chain_data(grub_extcmd_context_t ctxt
, int argc
, char **args
);
722 int ventoy_get_disk_guid(const char *filename
, grub_uint8_t
*guid
);
723 grub_err_t
ventoy_cmd_unix_reset(grub_extcmd_context_t ctxt
, int argc
, char **args
);
724 grub_err_t
ventoy_cmd_unix_replace_conf(grub_extcmd_context_t ctxt
, int argc
, char **args
);
725 grub_err_t
ventoy_cmd_unix_replace_ko(grub_extcmd_context_t ctxt
, int argc
, char **args
);
726 grub_err_t
ventoy_cmd_unix_freebsd_ver(grub_extcmd_context_t ctxt
, int argc
, char **args
);
727 grub_err_t
ventoy_cmd_parse_freenas_ver(grub_extcmd_context_t ctxt
, int argc
, char **args
);
729 #endif /* __VENTOY_DEF_H__ */