1 // SPDX-License-Identifier: GPL-2.0
2 #include <linux/init.h>
3 #include <linux/async.h>
5 #include <linux/slab.h>
6 #include <linux/types.h>
7 #include <linux/fcntl.h>
8 #include <linux/delay.h>
9 #include <linux/string.h>
10 #include <linux/dirent.h>
11 #include <linux/syscalls.h>
12 #include <linux/utime.h>
13 #include <linux/file.h>
14 #include <linux/kstrtox.h>
15 #include <linux/memblock.h>
17 #include <linux/namei.h>
18 #include <linux/init_syscalls.h>
19 #include <linux/umh.h>
20 #include <linux/security.h>
22 #include "do_mounts.h"
24 static __initdata bool csum_present;
25 static __initdata u32 io_csum;
27 static ssize_t __init xwrite(struct file *file, const unsigned char *p,
28 size_t count, loff_t *pos)
32 /* sys_write only can write MAX_RW_COUNT aka 2G-4K bytes at most */
34 ssize_t rv = kernel_write(file, p, count, pos);
37 if (rv == -EINTR || rv == -EAGAIN)
39 return out ? out : rv;
46 for (i = 0; i < rv; i++)
58 static __initdata char *message;
59 static void __init error(char *x)
65 #define panic_show_mem(fmt, ...) \
66 ({ show_mem(); panic(fmt, ##__VA_ARGS__); })
70 #define N_ALIGN(len) ((((len) + 1) & ~3) + 2)
72 static __initdata struct hash {
73 int ino, minor, major;
76 char name[N_ALIGN(PATH_MAX)];
79 static inline int hash(int major, int minor, int ino)
81 unsigned long tmp = ino + minor + (major << 3);
86 static char __init *find_link(int major, int minor, int ino,
87 umode_t mode, char *name)
90 for (p = head + hash(major, minor, ino); *p; p = &(*p)->next) {
93 if ((*p)->minor != minor)
95 if ((*p)->major != major)
97 if (((*p)->mode ^ mode) & S_IFMT)
101 q = kmalloc(sizeof(struct hash), GFP_KERNEL);
103 panic_show_mem("can't allocate link hash entry");
108 strcpy(q->name, name);
114 static void __init free_hash(void)
117 for (p = head; p < head + 32; p++) {
126 #ifdef CONFIG_INITRAMFS_PRESERVE_MTIME
127 static void __init do_utime(char *filename, time64_t mtime)
129 struct timespec64 t[2] = { { .tv_sec = mtime }, { .tv_sec = mtime } };
130 init_utimes(filename, t);
133 static void __init do_utime_path(const struct path *path, time64_t mtime)
135 struct timespec64 t[2] = { { .tv_sec = mtime }, { .tv_sec = mtime } };
139 static __initdata LIST_HEAD(dir_list);
141 struct list_head list;
146 static void __init dir_add(const char *name, time64_t mtime)
148 size_t nlen = strlen(name) + 1;
149 struct dir_entry *de;
151 de = kmalloc(sizeof(struct dir_entry) + nlen, GFP_KERNEL);
153 panic_show_mem("can't allocate dir_entry buffer");
154 INIT_LIST_HEAD(&de->list);
155 strscpy(de->name, name, nlen);
157 list_add(&de->list, &dir_list);
160 static void __init dir_utime(void)
162 struct dir_entry *de, *tmp;
163 list_for_each_entry_safe(de, tmp, &dir_list, list) {
165 do_utime(de->name, de->mtime);
170 static void __init do_utime(char *filename, time64_t mtime) {}
171 static void __init do_utime_path(const struct path *path, time64_t mtime) {}
172 static void __init dir_add(const char *name, time64_t mtime) {}
173 static void __init dir_utime(void) {}
176 static __initdata time64_t mtime;
178 /* cpio header parsing */
180 static __initdata unsigned long ino, major, minor, nlink;
181 static __initdata umode_t mode;
182 static __initdata unsigned long body_len, name_len;
183 static __initdata uid_t uid;
184 static __initdata gid_t gid;
185 static __initdata unsigned rdev;
186 static __initdata u32 hdr_csum;
188 static void __init parse_header(char *s)
190 unsigned long parsed[13];
195 for (i = 0, s += 6; i < 13; i++, s += 8) {
197 parsed[i] = simple_strtoul(buf, NULL, 16);
204 mtime = parsed[5]; /* breaks in y2106 */
205 body_len = parsed[6];
208 rdev = new_encode_dev(MKDEV(parsed[9], parsed[10]));
209 name_len = parsed[11];
210 hdr_csum = parsed[12];
215 static __initdata enum state {
226 static __initdata char *victim;
227 static unsigned long byte_count __initdata;
228 static __initdata loff_t this_header, next_header;
230 static inline void __init eat(unsigned n)
237 static __initdata char *collected;
238 static long remains __initdata;
239 static __initdata char *collect;
241 static void __init read_into(char *buf, unsigned size, enum state next)
243 if (byte_count >= size) {
248 collect = collected = buf;
255 static __initdata char *header_buf, *symlink_buf, *name_buf;
257 static int __init do_start(void)
259 read_into(header_buf, 110, GotHeader);
263 static int __init do_collect(void)
265 unsigned long n = remains;
268 memcpy(collect, victim, n);
271 if ((remains -= n) != 0)
277 static int __init do_header(void)
279 if (!memcmp(collected, "070701", 6)) {
280 csum_present = false;
281 } else if (!memcmp(collected, "070702", 6)) {
284 if (memcmp(collected, "070707", 6) == 0)
285 error("incorrect cpio method used: use -H newc option");
287 error("no cpio magic");
290 parse_header(collected);
291 next_header = this_header + N_ALIGN(name_len) + body_len;
292 next_header = (next_header + 3) & ~3;
294 if (name_len <= 0 || name_len > PATH_MAX)
297 if (body_len > PATH_MAX)
299 collect = collected = symlink_buf;
300 remains = N_ALIGN(name_len) + body_len;
301 next_state = GotSymlink;
305 if (S_ISREG(mode) || !body_len)
306 read_into(name_buf, N_ALIGN(name_len), GotName);
310 static int __init do_skip(void)
312 if (this_header + byte_count < next_header) {
316 eat(next_header - this_header);
322 static int __init do_reset(void)
324 while (byte_count && *victim == '\0')
326 if (byte_count && (this_header & 3))
327 error("broken padding");
331 static void __init clean_path(char *path, umode_t fmode)
335 if (!init_stat(path, &st, AT_SYMLINK_NOFOLLOW) &&
336 (st.mode ^ fmode) & S_IFMT) {
337 if (S_ISDIR(st.mode))
344 static int __init maybe_link(void)
347 char *old = find_link(major, minor, ino, mode, collected);
349 clean_path(collected, 0);
350 return (init_link(old, collected) < 0) ? -1 : 1;
356 static __initdata struct file *wfile;
357 static __initdata loff_t wfile_pos;
359 static int __init do_name(void)
364 /* name_len > 0 && name_len <= PATH_MAX checked in do_header */
365 if (collected[name_len - 1] != '\0') {
366 pr_err("initramfs name without nulterm: %.*s\n",
367 (int)name_len, collected);
368 error("malformed archive");
372 if (strcmp(collected, "TRAILER!!!") == 0) {
376 clean_path(collected, mode);
378 int ml = maybe_link();
380 int openflags = O_WRONLY|O_CREAT|O_LARGEFILE;
382 openflags |= O_TRUNC;
383 wfile = filp_open(collected, openflags, mode);
389 vfs_fchown(wfile, uid, gid);
390 vfs_fchmod(wfile, mode);
392 vfs_truncate(&wfile->f_path, body_len);
395 } else if (S_ISDIR(mode)) {
396 init_mkdir(collected, mode);
397 init_chown(collected, uid, gid, 0);
398 init_chmod(collected, mode);
399 dir_add(collected, mtime);
400 } else if (S_ISBLK(mode) || S_ISCHR(mode) ||
401 S_ISFIFO(mode) || S_ISSOCK(mode)) {
402 if (maybe_link() == 0) {
403 init_mknod(collected, mode, rdev);
404 init_chown(collected, uid, gid, 0);
405 init_chmod(collected, mode);
406 do_utime(collected, mtime);
412 static int __init do_copy(void)
414 if (byte_count >= body_len) {
415 if (xwrite(wfile, victim, body_len, &wfile_pos) != body_len)
416 error("write error");
418 do_utime_path(&wfile->f_path, mtime);
420 if (csum_present && io_csum != hdr_csum)
421 error("bad data checksum");
426 if (xwrite(wfile, victim, byte_count, &wfile_pos) != byte_count)
427 error("write error");
428 body_len -= byte_count;
434 static int __init do_symlink(void)
436 if (collected[name_len - 1] != '\0') {
437 pr_err("initramfs symlink without nulterm: %.*s\n",
438 (int)name_len, collected);
439 error("malformed archive");
442 collected[N_ALIGN(name_len) + body_len] = '\0';
443 clean_path(collected, 0);
444 init_symlink(collected + N_ALIGN(name_len), collected);
445 init_chown(collected, uid, gid, AT_SYMLINK_NOFOLLOW);
446 do_utime(collected, mtime);
452 static __initdata int (*actions[])(void) = {
454 [Collect] = do_collect,
455 [GotHeader] = do_header,
458 [CopyFile] = do_copy,
459 [GotSymlink] = do_symlink,
463 static long __init write_buffer(char *buf, unsigned long len)
468 while (!actions[state]())
470 return len - byte_count;
473 static long __init flush_buffer(void *bufv, unsigned long len)
480 while ((written = write_buffer(buf, len)) < len && !message) {
481 char c = buf[written];
491 error("junk within compressed archive");
496 static unsigned long my_inptr __initdata; /* index of next byte to be processed in inbuf */
498 #include <linux/decompress/generic.h>
500 static char * __init unpack_to_rootfs(char *buf, unsigned long len)
503 decompress_fn decompress;
504 const char *compress_name;
505 static __initdata char msg_buf[64];
507 header_buf = kmalloc(110, GFP_KERNEL);
508 symlink_buf = kmalloc(PATH_MAX + N_ALIGN(PATH_MAX) + 1, GFP_KERNEL);
509 name_buf = kmalloc(N_ALIGN(PATH_MAX), GFP_KERNEL);
511 if (!header_buf || !symlink_buf || !name_buf)
512 panic_show_mem("can't allocate buffers");
517 while (!message && len) {
518 loff_t saved_offset = this_header;
519 if (*buf == '0' && !(this_header & 3)) {
521 written = write_buffer(buf, len);
533 decompress = decompress_method(buf, len, &compress_name);
534 pr_debug("Detected %s compressed data\n", compress_name);
536 int res = decompress(buf, len, NULL, flush_buffer, NULL,
539 error("decompressor failed");
540 } else if (compress_name) {
542 snprintf(msg_buf, sizeof msg_buf,
543 "compression method %s not configured",
548 error("invalid magic at start of compressed archive");
550 error("junk at the end of compressed archive");
551 this_header = saved_offset + my_inptr;
562 static int __initdata do_retain_initrd;
564 static int __init retain_initrd_param(char *str)
568 do_retain_initrd = 1;
571 __setup("retain_initrd", retain_initrd_param);
573 #ifdef CONFIG_ARCH_HAS_KEEPINITRD
574 static int __init keepinitrd_setup(char *__unused)
576 do_retain_initrd = 1;
579 __setup("keepinitrd", keepinitrd_setup);
582 static bool __initdata initramfs_async = true;
583 static int __init initramfs_async_setup(char *str)
585 return kstrtobool(str, &initramfs_async) == 0;
587 __setup("initramfs_async=", initramfs_async_setup);
589 extern char __initramfs_start[];
590 extern unsigned long __initramfs_size;
591 #include <linux/initrd.h>
592 #include <linux/kexec.h>
594 static BIN_ATTR(initrd, 0440, sysfs_bin_attr_simple_read, NULL, 0);
596 void __init reserve_initrd_mem(void)
601 /* Ignore the virtul address computed during device tree parsing */
602 initrd_start = initrd_end = 0;
604 if (!phys_initrd_size)
607 * Round the memory region to page boundaries as per free_initrd_mem()
608 * This allows us to detect whether the pages overlapping the initrd
609 * are in use, but more importantly, reserves the entire set of pages
610 * as we don't want these pages allocated for other purposes.
612 start = round_down(phys_initrd_start, PAGE_SIZE);
613 size = phys_initrd_size + (phys_initrd_start - start);
614 size = round_up(size, PAGE_SIZE);
616 if (!memblock_is_region_memory(start, size)) {
617 pr_err("INITRD: 0x%08llx+0x%08lx is not a memory region",
622 if (memblock_is_region_reserved(start, size)) {
623 pr_err("INITRD: 0x%08llx+0x%08lx overlaps in-use memory region\n",
628 memblock_reserve(start, size);
629 /* Now convert initrd to virtual addresses */
630 initrd_start = (unsigned long)__va(phys_initrd_start);
631 initrd_end = initrd_start + phys_initrd_size;
632 initrd_below_start_ok = 1;
636 pr_cont(" - disabling initrd\n");
641 void __weak __init free_initrd_mem(unsigned long start, unsigned long end)
643 #ifdef CONFIG_ARCH_KEEP_MEMBLOCK
644 unsigned long aligned_start = ALIGN_DOWN(start, PAGE_SIZE);
645 unsigned long aligned_end = ALIGN(end, PAGE_SIZE);
647 memblock_free((void *)aligned_start, aligned_end - aligned_start);
650 free_reserved_area((void *)start, (void *)end, POISON_FREE_INITMEM,
654 #ifdef CONFIG_CRASH_RESERVE
655 static bool __init kexec_free_initrd(void)
657 unsigned long crashk_start = (unsigned long)__va(crashk_res.start);
658 unsigned long crashk_end = (unsigned long)__va(crashk_res.end);
661 * If the initrd region is overlapped with crashkernel reserved region,
662 * free only memory that is not part of crashkernel region.
664 if (initrd_start >= crashk_end || initrd_end <= crashk_start)
668 * Initialize initrd memory region since the kexec boot does not do.
670 memset((void *)initrd_start, 0, initrd_end - initrd_start);
671 if (initrd_start < crashk_start)
672 free_initrd_mem(initrd_start, crashk_start);
673 if (initrd_end > crashk_end)
674 free_initrd_mem(crashk_end, initrd_end);
678 static inline bool kexec_free_initrd(void)
682 #endif /* CONFIG_KEXEC_CORE */
684 #ifdef CONFIG_BLK_DEV_RAM
685 static void __init populate_initrd_image(char *err)
691 printk(KERN_INFO "rootfs image is not initramfs (%s); looks like an initrd\n",
693 file = filp_open("/initrd.image", O_WRONLY|O_CREAT|O_LARGEFILE, 0700);
697 written = xwrite(file, (char *)initrd_start, initrd_end - initrd_start,
699 if (written != initrd_end - initrd_start)
700 pr_err("/initrd.image: incomplete write (%zd != %ld)\n",
701 written, initrd_end - initrd_start);
704 #endif /* CONFIG_BLK_DEV_RAM */
706 static void __init do_populate_rootfs(void *unused, async_cookie_t cookie)
708 /* Load the built in initramfs */
709 char *err = unpack_to_rootfs(__initramfs_start, __initramfs_size);
711 panic_show_mem("%s", err); /* Failed to decompress INTERNAL initramfs */
713 if (!initrd_start || IS_ENABLED(CONFIG_INITRAMFS_FORCE))
716 if (IS_ENABLED(CONFIG_BLK_DEV_RAM))
717 printk(KERN_INFO "Trying to unpack rootfs image as initramfs...\n");
719 printk(KERN_INFO "Unpacking initramfs...\n");
721 err = unpack_to_rootfs((char *)initrd_start, initrd_end - initrd_start);
723 #ifdef CONFIG_BLK_DEV_RAM
724 populate_initrd_image(err);
726 printk(KERN_EMERG "Initramfs unpacking failed: %s\n", err);
731 security_initramfs_populated();
734 * If the initrd region is overlapped with crashkernel reserved region,
735 * free only memory that is not part of crashkernel region.
737 if (!do_retain_initrd && initrd_start && !kexec_free_initrd()) {
738 free_initrd_mem(initrd_start, initrd_end);
739 } else if (do_retain_initrd && initrd_start) {
740 bin_attr_initrd.size = initrd_end - initrd_start;
741 bin_attr_initrd.private = (void *)initrd_start;
742 if (sysfs_create_bin_file(firmware_kobj, &bin_attr_initrd))
743 pr_err("Failed to create initrd sysfs file");
751 static ASYNC_DOMAIN_EXCLUSIVE(initramfs_domain);
752 static async_cookie_t initramfs_cookie;
754 void wait_for_initramfs(void)
756 if (!initramfs_cookie) {
758 * Something before rootfs_initcall wants to access
759 * the filesystem/initramfs. Probably a bug. Make a
760 * note, avoid deadlocking the machine, and let the
761 * caller's access fail as it used to.
763 pr_warn_once("wait_for_initramfs() called before rootfs_initcalls\n");
766 async_synchronize_cookie_domain(initramfs_cookie + 1, &initramfs_domain);
768 EXPORT_SYMBOL_GPL(wait_for_initramfs);
770 static int __init populate_rootfs(void)
772 initramfs_cookie = async_schedule_domain(do_populate_rootfs, NULL,
774 usermodehelper_enable();
775 if (!initramfs_async)
776 wait_for_initramfs();
779 rootfs_initcall(populate_rootfs);