This patchset is to ask opinions from folks, whether LKL codes is good to integrate into UML code base. We wish to have any kind of feedback from your kind reviews. There are numbers of commits which should be asked for reviews to other mailing lists; we will do it later once we got discussed in this mailing list. Changes in rfc v3: - use UML drivers (net, block) from LKL programs - drop virtio device implementations - drop mingw32 (Windows) host - drop android (arm/aarch64) host - drop FreeBSD (x86_64) host - drop LD_PRELOAD (hijack) support - update milestone rfc v2: - use UMMODE instead of SUBARCH to switch UML or LKL - tools/lkl directory is still there. I confirmed we can move under arch/um (e.g., arch/um/lkl/hosts). I will move it IF this is preferable. - drop several patches involved non-uml directory - drop several patches which are not required - refine commit logs - document updated LKL (Linux Kernel Library) is aiming to allow reusing the Linux kernel code as extensively as possible with minimal effort and reduced maintenance overhead. Examples of how LKL can be used are: creating userspace applications (running on Linux and other operating systems) that can read or write Linux filesystems or can use the Linux networking stack, creating kernel drivers for other operating systems that can read Linux filesystems, bootloaders support for reading/writing Linux filesystems, etc. With LKL, the kernel code is compiled into an object file that can be directly linked by applications. The API offered by LKL is based on the Linux system call interface. LKL is originally implemented as an architecture port in arch/lkl, but this series of commits tries to integrate this into arch/um as one of the mode of UML. This was discussed during RFC email of LKL (*1). The latest LKL version can be found at https://github.com/lkl/linux Milestone ========= This patches is a first step toward upstreaming *library mode* of Linux kernel, but we think we need to have several steps toward our goal, describing in the below. 1. Put LKL code under arch/um (arch/um/lkl), and build it in a separate way from UML. 2. Use UML driver implementations in LKL as a minimum set of patches - Only support x86 sub architecture (dependency to UML drivers) 3. Support broader host supports - add virtio device features For the step 1, we put LKL as one of UMMODE in order to make less effort to integrate (make ARCH=um UMMODE=library). The modification to existing UML code is trying to be minimized. Building LKL the host library and LKL applications ================================================== % cd tools/lkl % make will build LKL as a object file, it will install it in tools/lkl/lib together with the headers files in tools/lkl/include then will build the host library, tests and a few of application examples: * tests/boot - a simple applications that uses LKL and exercises the basic LKL APIs * tests/net-test - a simple applications that uses network feature of LKL and exercises the basic network-related APIs * fs2tar - a tool that converts a filesystem image to a tar archive * cptofs/cpfromfs - a tool that copies files to/from a filesystem image * lklfuse - a tool that can mount a filesystem image in userspace, without root priviledges, using FUSE % make run-tests should run the above `tests/boot` and `tests/net-test` and report errors if there are any. Supported hosts =============== Currently LKL supports Linux userspace applications. New hosts can be added relatively easy if the host supports gcc and GNU ld. Previous versions of LKL supported Windows kernel and Haiku kernel hosts, and we also have WIP patches with rump-hypercall interface, used in UEFI, as well as macOS userspace (part of POSIX). There is also musl-libc port for LKL, which might be interested in for some folks. Further readings about LKL ========================= - Discussion in github LKL issue https://github.com/lkl/linux/issues/304 - LKL (an article) https://www.researchgate.net/profile/Nicolae_Tapus2/publication/224164682_LKL_The_Linux_kernel_library/links/02bfe50fd921ab4f7c000000.pdf *1 RFC email to LKML (back in 2015) https://www.mail-archive.com/linux-kernel@xxxxxxxxxxxxxxx/msg1012277.html Please review the following changes for suitability for inclusion. If you have any objections or suggestions for improvement, please respond to the patches. If you agree with the changes, please provide your Acked-by. The following changes since commit d65197ad52494bed3b5e64708281b8295f76c391: um: Fix time-travel=inf-cpu with xor/raid6 (2020-01-19 22:42:06 +0100) are available in the Git repository at: git://github.com/thehajime/linux b3072caaef01f2cef5f34bc012e066826798500c https://github.com/thehajime/linux/tree/upstream-to-uml-5.6-rc1-v3 Hajime Tazaki (6): lkl tools: host lib: filesystem helpers lkl tools: host lib: networking helpers um lkl: add CI scripts to conduct regression tests um lkl: add UML network driver for lkl um lkl: add UML block device driver (ubd) for lkl um: fix clone flags to be familar with valgrind Octavian Purdila (20): asm-generic: atomic64: allow using generic atomic64 on 64bit platforms arch: add __SYSCALL_DEFINE_ARCH um lkl: architecture skeleton for Linux kernel library um lkl: host interface um lkl: memory handling um lkl: kernel threads support um lkl: interrupt support um lkl: system call interface and application API um lkl: timers, time and delay support um lkl: basic kernel console support um lkl: initialization and cleanup um lkl: plug in the build system lkl tools: skeleton for host side library lkl tools: host lib: add utilities functions lkl tools: host lib: posix host operations lkl tools: add test programs lkl tools: cptofs that reads/writes to/from a filesystem image lkl tools: fs2tar that converts a filesystem image to tar lkl tools: add lklfuse um lkl: add documentation .circleci/config.yml | 198 ++++ Documentation/virt/uml/lkl.txt | 64 ++ MAINTAINERS | 8 + arch/um/Kconfig | 13 + arch/um/Makefile | 19 +- arch/um/Makefile.um | 10 + arch/um/drivers/Makefile | 2 + arch/um/drivers/ubd_kern.c | 6 +- arch/um/drivers/ubd_user.c | 3 +- arch/um/kernel/Makefile | 4 + arch/um/kernel/irq.c | 4 + arch/um/lkl/.gitignore | 2 + arch/um/lkl/Kconfig | 88 ++ arch/um/lkl/Kconfig.debug | 0 arch/um/lkl/Makefile | 69 ++ arch/um/lkl/auto.conf | 1 + arch/um/lkl/configs/lkl_defconfig | 1052 ++++++++++++++++++++ arch/um/lkl/include/asm/Kbuild | 80 ++ arch/um/lkl/include/asm/bitsperlong.h | 11 + arch/um/lkl/include/asm/byteorder.h | 7 + arch/um/lkl/include/asm/cpu.h | 14 + arch/um/lkl/include/asm/elf.h | 15 + arch/um/lkl/include/asm/host_ops.h | 10 + arch/um/lkl/include/asm/irq.h | 13 + arch/um/lkl/include/asm/page.h | 14 + arch/um/lkl/include/asm/pgtable.h | 57 ++ arch/um/lkl/include/asm/processor.h | 60 ++ arch/um/lkl/include/asm/ptrace.h | 25 + arch/um/lkl/include/asm/sched.h | 23 + arch/um/lkl/include/asm/setup.h | 7 + arch/um/lkl/include/asm/syscalls.h | 18 + arch/um/lkl/include/asm/syscalls_32.h | 43 + arch/um/lkl/include/asm/thread_info.h | 70 ++ arch/um/lkl/include/asm/tlb.h | 12 + arch/um/lkl/include/asm/uaccess.h | 64 ++ arch/um/lkl/include/asm/unistd.h | 27 + arch/um/lkl/include/asm/unistd_32.h | 31 + arch/um/lkl/include/asm/vmlinux.lds.h | 14 + arch/um/lkl/include/asm/xor.h | 9 + arch/um/lkl/include/uapi/asm/Kbuild | 9 + arch/um/lkl/include/uapi/asm/bitsperlong.h | 13 + arch/um/lkl/include/uapi/asm/byteorder.h | 11 + arch/um/lkl/include/uapi/asm/host_ops.h | 143 +++ arch/um/lkl/include/uapi/asm/irq.h | 36 + arch/um/lkl/include/uapi/asm/sigcontext.h | 16 + arch/um/lkl/include/uapi/asm/siginfo.h | 11 + arch/um/lkl/include/uapi/asm/swab.h | 11 + arch/um/lkl/include/uapi/asm/syscalls.h | 349 +++++++ arch/um/lkl/include/uapi/asm/unistd.h | 16 + arch/um/lkl/kernel/Makefile | 4 + arch/um/lkl/kernel/asm-offsets.c | 3 + arch/um/lkl/kernel/console.c | 42 + arch/um/lkl/kernel/cpu.c | 223 +++++ arch/um/lkl/kernel/irq.c | 209 ++++ arch/um/lkl/kernel/misc.c | 60 ++ arch/um/lkl/kernel/setup.c | 198 ++++ arch/um/lkl/kernel/syscalls.c | 192 ++++ arch/um/lkl/kernel/syscalls_32.c | 159 +++ arch/um/lkl/kernel/threads.c | 227 +++++ arch/um/lkl/kernel/time.c | 145 +++ arch/um/lkl/kernel/vmlinux.lds.S | 51 + arch/um/lkl/mm/Makefile | 1 + arch/um/lkl/mm/bootmem.c | 99 ++ arch/um/lkl/scripts/headers_install.py | 196 ++++ arch/um/os-Linux/Makefile | 5 + arch/um/os-Linux/file.c | 9 + include/asm-generic/atomic64.h | 2 + include/linux/syscalls.h | 6 + tools/lkl/.gitignore | 13 + tools/lkl/Build | 6 + tools/lkl/Makefile | 131 +++ tools/lkl/Makefile.autoconf | 67 ++ tools/lkl/Targets | 17 + tools/lkl/cptofs.c | 636 ++++++++++++ tools/lkl/fs2tar.c | 412 ++++++++ tools/lkl/include/.gitignore | 1 + tools/lkl/include/lkl.h | 788 +++++++++++++++ tools/lkl/include/lkl_config.h | 61 ++ tools/lkl/include/lkl_host.h | 112 +++ tools/lkl/lib/.gitignore | 3 + tools/lkl/lib/Build | 13 + tools/lkl/lib/config.c | 750 ++++++++++++++ tools/lkl/lib/dbg.c | 300 ++++++ tools/lkl/lib/dbg_handler.c | 44 + tools/lkl/lib/endian.h | 31 + tools/lkl/lib/fs.c | 471 +++++++++ tools/lkl/lib/jmp_buf.c | 14 + tools/lkl/lib/jmp_buf.h | 8 + tools/lkl/lib/net.c | 818 +++++++++++++++ tools/lkl/lib/posix-host.c | 356 +++++++ tools/lkl/lib/um/Build | 3 + tools/lkl/lib/um/um_block.c | 17 + tools/lkl/lib/um/um_glue.c | 58 ++ tools/lkl/lib/um/um_net.c | 25 + tools/lkl/lib/utils.c | 266 +++++ tools/lkl/lklfuse.c | 659 ++++++++++++ tools/lkl/scripts/checkpatch.sh | 60 ++ tools/lkl/scripts/lkl-jenkins.sh | 21 + tools/lkl/tests/Build | 3 + tools/lkl/tests/boot.c | 562 +++++++++++ tools/lkl/tests/boot.sh | 9 + tools/lkl/tests/cla.c | 159 +++ tools/lkl/tests/cla.h | 33 + tools/lkl/tests/disk.c | 203 ++++ tools/lkl/tests/disk.sh | 61 ++ tools/lkl/tests/lklfuse.sh | 110 ++ tools/lkl/tests/net-setup.sh | 74 ++ tools/lkl/tests/net-test.c | 291 ++++++ tools/lkl/tests/net.sh | 108 ++ tools/lkl/tests/run.py | 180 ++++ tools/lkl/tests/tap13.py | 209 ++++ tools/lkl/tests/test.c | 126 +++ tools/lkl/tests/test.h | 72 ++ tools/lkl/tests/test.sh | 182 ++++ tools/lkl/tests/valgrind.supp | 105 ++ tools/lkl/tests/valgrind2xunit.py | 69 ++ 116 files changed, 13327 insertions(+), 3 deletions(-) create mode 100644 .circleci/config.yml create mode 100644 Documentation/virt/uml/lkl.txt create mode 100644 arch/um/Makefile.um create mode 100644 arch/um/lkl/.gitignore create mode 100644 arch/um/lkl/Kconfig create mode 100644 arch/um/lkl/Kconfig.debug create mode 100644 arch/um/lkl/Makefile create mode 100644 arch/um/lkl/auto.conf create mode 100644 arch/um/lkl/configs/lkl_defconfig create mode 100644 arch/um/lkl/include/asm/Kbuild create mode 100644 arch/um/lkl/include/asm/bitsperlong.h create mode 100644 arch/um/lkl/include/asm/byteorder.h create mode 100644 arch/um/lkl/include/asm/cpu.h create mode 100644 arch/um/lkl/include/asm/elf.h create mode 100644 arch/um/lkl/include/asm/host_ops.h create mode 100644 arch/um/lkl/include/asm/irq.h create mode 100644 arch/um/lkl/include/asm/page.h create mode 100644 arch/um/lkl/include/asm/pgtable.h create mode 100644 arch/um/lkl/include/asm/processor.h create mode 100644 arch/um/lkl/include/asm/ptrace.h create mode 100644 arch/um/lkl/include/asm/sched.h create mode 100644 arch/um/lkl/include/asm/setup.h create mode 100644 arch/um/lkl/include/asm/syscalls.h create mode 100644 arch/um/lkl/include/asm/syscalls_32.h create mode 100644 arch/um/lkl/include/asm/thread_info.h create mode 100644 arch/um/lkl/include/asm/tlb.h create mode 100644 arch/um/lkl/include/asm/uaccess.h create mode 100644 arch/um/lkl/include/asm/unistd.h create mode 100644 arch/um/lkl/include/asm/unistd_32.h create mode 100644 arch/um/lkl/include/asm/vmlinux.lds.h create mode 100644 arch/um/lkl/include/asm/xor.h create mode 100644 arch/um/lkl/include/uapi/asm/Kbuild create mode 100644 arch/um/lkl/include/uapi/asm/bitsperlong.h create mode 100644 arch/um/lkl/include/uapi/asm/byteorder.h create mode 100644 arch/um/lkl/include/uapi/asm/host_ops.h create mode 100644 arch/um/lkl/include/uapi/asm/irq.h create mode 100644 arch/um/lkl/include/uapi/asm/sigcontext.h create mode 100644 arch/um/lkl/include/uapi/asm/siginfo.h create mode 100644 arch/um/lkl/include/uapi/asm/swab.h create mode 100644 arch/um/lkl/include/uapi/asm/syscalls.h create mode 100644 arch/um/lkl/include/uapi/asm/unistd.h create mode 100644 arch/um/lkl/kernel/Makefile create mode 100644 arch/um/lkl/kernel/asm-offsets.c create mode 100644 arch/um/lkl/kernel/console.c create mode 100644 arch/um/lkl/kernel/cpu.c create mode 100644 arch/um/lkl/kernel/irq.c create mode 100644 arch/um/lkl/kernel/misc.c create mode 100644 arch/um/lkl/kernel/setup.c create mode 100644 arch/um/lkl/kernel/syscalls.c create mode 100644 arch/um/lkl/kernel/syscalls_32.c create mode 100644 arch/um/lkl/kernel/threads.c create mode 100644 arch/um/lkl/kernel/time.c create mode 100644 arch/um/lkl/kernel/vmlinux.lds.S create mode 100644 arch/um/lkl/mm/Makefile create mode 100644 arch/um/lkl/mm/bootmem.c create mode 100755 arch/um/lkl/scripts/headers_install.py create mode 100644 tools/lkl/.gitignore create mode 100644 tools/lkl/Build create mode 100644 tools/lkl/Makefile create mode 100644 tools/lkl/Makefile.autoconf create mode 100644 tools/lkl/Targets create mode 100644 tools/lkl/cptofs.c create mode 100644 tools/lkl/fs2tar.c create mode 100644 tools/lkl/include/.gitignore create mode 100644 tools/lkl/include/lkl.h create mode 100644 tools/lkl/include/lkl_config.h create mode 100644 tools/lkl/include/lkl_host.h create mode 100644 tools/lkl/lib/.gitignore create mode 100644 tools/lkl/lib/Build create mode 100644 tools/lkl/lib/config.c create mode 100644 tools/lkl/lib/dbg.c create mode 100644 tools/lkl/lib/dbg_handler.c create mode 100644 tools/lkl/lib/endian.h create mode 100644 tools/lkl/lib/fs.c create mode 100644 tools/lkl/lib/jmp_buf.c create mode 100644 tools/lkl/lib/jmp_buf.h create mode 100644 tools/lkl/lib/net.c create mode 100644 tools/lkl/lib/posix-host.c create mode 100644 tools/lkl/lib/um/Build create mode 100644 tools/lkl/lib/um/um_block.c create mode 100644 tools/lkl/lib/um/um_glue.c create mode 100644 tools/lkl/lib/um/um_net.c create mode 100644 tools/lkl/lib/utils.c create mode 100644 tools/lkl/lklfuse.c create mode 100755 tools/lkl/scripts/checkpatch.sh create mode 100755 tools/lkl/scripts/lkl-jenkins.sh create mode 100644 tools/lkl/tests/Build create mode 100644 tools/lkl/tests/boot.c create mode 100755 tools/lkl/tests/boot.sh create mode 100644 tools/lkl/tests/cla.c create mode 100644 tools/lkl/tests/cla.h create mode 100644 tools/lkl/tests/disk.c create mode 100755 tools/lkl/tests/disk.sh create mode 100755 tools/lkl/tests/lklfuse.sh create mode 100644 tools/lkl/tests/net-setup.sh create mode 100644 tools/lkl/tests/net-test.c create mode 100755 tools/lkl/tests/net.sh create mode 100755 tools/lkl/tests/run.py create mode 100644 tools/lkl/tests/tap13.py create mode 100644 tools/lkl/tests/test.c create mode 100644 tools/lkl/tests/test.h create mode 100644 tools/lkl/tests/test.sh create mode 100644 tools/lkl/tests/valgrind.supp create mode 100755 tools/lkl/tests/valgrind2xunit.py -- 2.21.0 (Apple Git-122.2)
