From c5889ecef0ebdc52ad4537b3b281b858a031731f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andrius=20=C5=A0tikonas?= Date: Tue, 5 Jul 2022 01:46:29 +0100 Subject: [PATCH] Add high level prototype for hex0. --- .gitignore | 4 + Development/Makefile | 56 ++ Development/efi/boot_table.h | 103 +++ Development/efi/device_path_protocol.h | 14 + Development/efi/efi.h | 15 + Development/efi/file_protocol.h | 74 +++ Development/efi/loaded_image_protocol.h | 35 + Development/efi/simple_file_system_protocol.h | 19 + Development/efi/simple_text_output_protocol.h | 30 + Development/efi/system_table.h | 27 + Development/efi/types.h | 83 +++ Development/hex0.c | 121 ++++ Development/rootfs/hex0_AMD64_POSIX.hex0 | 234 +++++++ Development/rootfs/startup.nsh | 3 + LICENSES/GPL-3.0-or-later.txt | 604 ++++++++++++++++++ LICENSES/MIT.txt | 20 + LICENSES/Unlicense.txt | 22 + 17 files changed, 1464 insertions(+) create mode 100644 .gitignore create mode 100644 Development/Makefile create mode 100644 Development/efi/boot_table.h create mode 100644 Development/efi/device_path_protocol.h create mode 100644 Development/efi/efi.h create mode 100644 Development/efi/file_protocol.h create mode 100644 Development/efi/loaded_image_protocol.h create mode 100644 Development/efi/simple_file_system_protocol.h create mode 100644 Development/efi/simple_text_output_protocol.h create mode 100644 Development/efi/system_table.h create mode 100644 Development/efi/types.h create mode 100644 Development/hex0.c create mode 100644 Development/rootfs/hex0_AMD64_POSIX.hex0 create mode 100644 Development/rootfs/startup.nsh create mode 100644 LICENSES/GPL-3.0-or-later.txt create mode 100644 LICENSES/MIT.txt create mode 100644 LICENSES/Unlicense.txt diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b641b3e --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +# SPDX-License-Identifier: MIT + +*~ +Development/build/ diff --git a/Development/Makefile b/Development/Makefile new file mode 100644 index 0000000..a260fab --- /dev/null +++ b/Development/Makefile @@ -0,0 +1,56 @@ +# SPDX-FileCopyrightText: 2022 Andrius Štikonas +# +# SPDX-License-Identifier: GPL-3.0-or-later + +targets = hex0 +ESP_SIZE = 50 # MiB +QEMU = qemu-system-x86_64 +OVMF_IMG = /usr/share/edk2-ovmf/OVMF_CODE.fd + +ESP_SIZE_SECTORS = $$(($(ESP_SIZE) * 2048)) +DISK_SIZE_SECTORS=$$(($(ESP_SIZE_SECTORS) + 2048 + 33)) + +cc = clang +cflags = -ffreestanding -MMD -mno-red-zone -std=c11 -target x86_64-unknown-windows -Wall -Werror -pedantic +ld = lld-link +lflags = -subsystem:efi_application -nodefaultlib -dll +build_dir = build +rootfs_dir = $(build_dir)/rootfs + +targets2 = $(addsuffix .efi, $(addprefix $(build_dir)/, $(targets))) + +$(build_dir)/%.efi : $(build_dir)/%.o + $(ld) $(lflags) -entry:efi_main $< -out:$@ + +$(build_dir)/%.o : %.c + mkdir -p $(build_dir) + $(cc) $(cflags) -c $< -o $@ + +.PHONY : clean rootfs qemu + +qemu: $(build_dir)/disk.img $(OVMF_IMG) + $(QEMU) -cpu qemu64 -enable-kvm -net none \ + -drive if=pflash,format=raw,unit=0,file=$(OVMF_IMG),readonly=on \ + -drive if=ide,format=raw,file=$< + +all : $(targets2) + +$(build_dir)/disk.img: $(build_dir)/esp.img + dd if=/dev/zero of=$@ bs=512 count=$(DISK_SIZE_SECTORS) + parted $@ -s -a minimal mklabel gpt + parted $@ -s -a minimal mkpart EFI FAT32 2048s $(ESP_SIZE_SECTORS)s + parted $@ -s -a minimal toggle 1 boot + dd if=$< of=$@ bs=512 seek=2048 conv=notrunc + +$(build_dir)/esp.img: rootfs + dd if=/dev/zero of=$@ bs=512 count=$(ESP_SIZE_SECTORS) + mformat -i $@ -h 32 -t 32 -n 64 -c 1 + mcopy -s -i $@ $(rootfs_dir)/* :: + +rootfs: $(targets2) + cp -R rootfs $(build_dir) + mkdir -p $(rootfs_dir)/EFI/BOOT/ + cp $(build_dir)/hex0.efi $(rootfs_dir)/EFI/BOOT/BOOTX64.EFI + +clean: + rm -rf $(build_dir) diff --git a/Development/efi/boot_table.h b/Development/efi/boot_table.h new file mode 100644 index 0000000..ee5518d --- /dev/null +++ b/Development/efi/boot_table.h @@ -0,0 +1,103 @@ +/* SPDX-License-Identifier: Unlicense */ + +#ifndef __EFI_BOOT_TABLE_H__ +#define __EFI_BOOT_TABLE_H__ + +#include "types.h" + +static const uint32_t EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL = 0x00000001; + +struct efi_boot_table +{ + struct efi_table_header header; + + // Task Priority Services + void (*unused1)(); + void (*unused2)(); + + // Memory Services + efi_status_t (*allocate_pages)( + enum efi_allocate_type, + enum efi_memory_type, + efi_uint_t, + uint64_t *); + efi_status_t (*free_pages)(uint64_t, efi_uint_t); + efi_status_t (*get_memory_map)( + efi_uint_t *, + struct efi_memory_descriptor *, + efi_uint_t *, + efi_uint_t *, + uint32_t *); + efi_status_t (*allocate_pool)( + enum efi_memory_type, efi_uint_t, void **); + efi_status_t (*free_pool)(void *); + + // Event & Timer Services + void (*unused7)(); + void (*unused8)(); + void (*unused9)(); + void (*unused10)(); + void (*unused11)(); + void (*unused12)(); + + // Protocol Handler Services + void (*unused13)(); + void (*unused14)(); + void (*unused15)(); + void (*unused16)(); + void *reserved; + void (*unused17)(); + void (*unused18)(); + void (*unused19)(); + void (*unused20)(); + + // Image Services + void (*unused21)(); + void (*unused22)(); + void (*unused23)(); + void (*unused24)(); + + efi_status_t (*exit_boot_services)(efi_handle_t, efi_uint_t); + + // Miscellaneius Services + void (*unused26)(); + void (*unused27)(); + void (*unused28)(); + + // DriverSupport Services + void (*unused29)(); + void (*unused30)(); + + // Open and Close Protocol Services + efi_status_t (*open_protocol)( + efi_handle_t, + struct efi_guid *, + void **, + efi_handle_t, + efi_handle_t, + uint32_t); + efi_status_t (*close_protocol)( + efi_handle_t, + struct efi_guid *, + efi_handle_t, + efi_handle_t); + void (*unused33)(); + + // Library Services + efi_status_t (*protocols_per_handle)( + efi_handle_t, struct efi_guid ***, efi_uint_t *); + void (*unused35)(); + void (*unused36)(); + void (*unused37)(); + void (*unused38)(); + + // 32-bit CRC Services + void (*unused39)(); + + // Miscellaneius Services (cont) + void (*unused40)(); + void (*unused41)(); + void (*unused42)(); +}; + +#endif // __EFI_BOOT_TABLE_H__ diff --git a/Development/efi/device_path_protocol.h b/Development/efi/device_path_protocol.h new file mode 100644 index 0000000..a703697 --- /dev/null +++ b/Development/efi/device_path_protocol.h @@ -0,0 +1,14 @@ +/* SPDX-License-Identifier: Unlicense */ + +#ifndef __EFI_DEVICE_PATH_PROTOCOL_H__ +#define __EFI_DEVICE_PATH_PROTOCOL_H__ + +#include "types.h" + +struct efi_device_path_protocol { + uint8_t type; + uint8_t subtype; + uint16_t length; +}; + +#endif // __EFI_DEVICE_PATH_PROTOCOL_H__ diff --git a/Development/efi/efi.h b/Development/efi/efi.h new file mode 100644 index 0000000..bab88c5 --- /dev/null +++ b/Development/efi/efi.h @@ -0,0 +1,15 @@ +/* SPDX-License-Identifier: Unlicense */ + +#ifndef __EFI_H__ +#define __EFI_H__ + +#include "boot_table.h" +#include "device_path_protocol.h" +#include "file_protocol.h" +#include "loaded_image_protocol.h" +#include "simple_file_system_protocol.h" +#include "simple_text_output_protocol.h" +#include "system_table.h" +#include "types.h" + +#endif // __EFI_H__ diff --git a/Development/efi/file_protocol.h b/Development/efi/file_protocol.h new file mode 100644 index 0000000..93d1478 --- /dev/null +++ b/Development/efi/file_protocol.h @@ -0,0 +1,74 @@ +/* SPDX-License-Identifier: Unlicense */ + +#ifndef __EFI_FILE_PROTOCOL_H__ +#define __EFI_FILE_PROTOCOL_H__ + +#include "types.h" + +#define EFI_FILE_INFO_GUID \ + { 0x09576e92, 0x6d3f, 0x11d2, \ + { 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b } } + +// Open modes +static const uint64_t EFI_FILE_MODE_READ = 0x0000000000000001; +static const uint64_t EFI_FILE_MODE_WRITE = 0x0000000000000002; +static const uint64_t EFI_FILE_MODE_CREATE = 0x8000000000000000; + +// File attributes +static const uint64_t EFI_FILE_READ_ONLY = 0x1; +static const uint64_t EFI_FILE_HIDDEN = 0x2; +static const uint64_t EFI_FILE_SYSTEM = 0x4; +static const uint64_t EFI_FILE_RESERVED = 0x8; +static const uint64_t EFI_FILE_DIRECTORY = 0x10; +static const uint64_t EFI_FILE_ARCHIVE = 0x20; + +struct efi_file_info { + uint64_t size; + uint64_t file_size; + uint64_t physical_size; + struct efi_time create_time; + struct efi_time last_access_time; + struct efi_time modifiction_time; + uint64_t attribute; + // The efi_file_info structure is supposed to be a variable size structure, + // but it's really a pain to always dynamically allocate enough space for + // the structure, so I explicitly allocated some space in the structure, so + // we will be able to cover at least some simple cases without dynamic + // memory allocation. + uint16_t file_name[256]; +}; + +struct efi_file_protocol { + uint64_t revision; + efi_status_t (*open)( + struct efi_file_protocol *, + struct efi_file_protocol **, + uint16_t *, + uint64_t, + uint64_t); + efi_status_t (*close)(struct efi_file_protocol *); + + void (*unused1)(); + + efi_status_t (*read)(struct efi_file_protocol *, efi_uint_t *, void *); + + efi_status_t (*write)(struct efi_file_protocol *, efi_uint_t *, void *); + + efi_status_t (*get_position)(struct efi_file_protocol *, uint64_t *); + efi_status_t (*set_position)(struct efi_file_protocol *, uint64_t); + + efi_status_t (*get_info)( + struct efi_file_protocol *, struct efi_guid *, efi_uint_t *, void *); + + efi_status_t (*set_info)( + struct efi_file_protocol *, struct efi_guid *, efi_uint_t *, void *); + + void (*unused7)(); + void (*unused8)(); + void (*unused9)(); + void (*unused10)(); + void (*unused11)(); +}; + +#endif // __EFI_FILE_PROTOCOL_H__ + diff --git a/Development/efi/loaded_image_protocol.h b/Development/efi/loaded_image_protocol.h new file mode 100644 index 0000000..4d04315 --- /dev/null +++ b/Development/efi/loaded_image_protocol.h @@ -0,0 +1,35 @@ +/* SPDX-License-Identifier: Unlicense */ + +#ifndef __EFI_LOADED_IMAGE_PROTOCOL_H__ +#define __EFI_LOADED_IMAGE_PROTOCOL_H__ + +#include "device_path_protocol.h" +#include "types.h" + +#define EFI_LOADED_IMAGE_PROTOCOL_GUID \ + { 0x5b1b31a1, 0x9562, 0x11d2, \ + { 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b } } + +struct efi_loaded_image_protocol { + uint32_t revision; + efi_handle_t parent; + struct efi_system_table *system; + + // Source location of the image + efi_handle_t device; + struct efi_device_path_protocol *filepath; + void *reserved; + + // Image's load options + uint32_t load_options_size; + void *load_options; + + // Location of the image in memory + void *image_base; + uint64_t image_size; + enum efi_memory_type image_code_type; + enum efi_memory_type image_data_type; + void (*unused)(); +}; + +#endif // __EFI_LOADED_IMAGE_PROTOCOL_H__ diff --git a/Development/efi/simple_file_system_protocol.h b/Development/efi/simple_file_system_protocol.h new file mode 100644 index 0000000..dd77072 --- /dev/null +++ b/Development/efi/simple_file_system_protocol.h @@ -0,0 +1,19 @@ +/* SPDX-License-Identifier: Unlicense */ + +#ifndef __EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_H__ +#define __EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_H__ + +#include "file_protocol.h" +#include "types.h" + +#define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID \ + { 0x0964e5b22, 0x6459, 0x11d2, \ + { 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b } } + +struct efi_simple_file_system_protocol { + uint64_t revision; + efi_status_t (*open_volume)( + struct efi_simple_file_system_protocol *, struct efi_file_protocol **); +}; + +#endif // __EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_H__ diff --git a/Development/efi/simple_text_output_protocol.h b/Development/efi/simple_text_output_protocol.h new file mode 100644 index 0000000..0169147 --- /dev/null +++ b/Development/efi/simple_text_output_protocol.h @@ -0,0 +1,30 @@ +/* SPDX-License-Identifier: Unlicense */ + +#ifndef __EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_H__ +#define __EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_H__ + +#include "types.h" + +struct efi_simple_text_output_protocol +{ + void (*unused1)(); + + efi_status_t (*output_string)( + struct efi_simple_text_output_protocol *, + uint16_t *); + + void (*unused2)(); + void (*unused3)(); + void (*unused4)(); + void (*unused5)(); + + efi_status_t (*clear_screen)( + struct efi_simple_text_output_protocol *); + + void (*unused6)(); + void (*unused7)(); + + void *unused8; +}; + +#endif // __EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_H__ diff --git a/Development/efi/system_table.h b/Development/efi/system_table.h new file mode 100644 index 0000000..cd1d948 --- /dev/null +++ b/Development/efi/system_table.h @@ -0,0 +1,27 @@ +/* SPDX-License-Identifier: Unlicense */ + +#ifndef __EFI_SYSTEM_TABLE_H__ +#define __EFI_SYSTEM_TABLE_H__ + +#include "boot_table.h" +#include "simple_text_output_protocol.h" +#include "types.h" + +struct efi_system_table +{ + struct efi_table_header header; + uint16_t *unused1; + uint32_t unused2; + void *unused3; + void *unused4; + void *unused5; + struct efi_simple_text_output_protocol *out; + void *unused6; + struct efi_simple_text_output_protocol *err; + void *unused8; + struct efi_boot_table *boot; + efi_uint_t unused10; + void *unused11; +}; + +#endif // __EFI_SYSTEM_TABLE_H__ diff --git a/Development/efi/types.h b/Development/efi/types.h new file mode 100644 index 0000000..b2c9176 --- /dev/null +++ b/Development/efi/types.h @@ -0,0 +1,83 @@ +/* SPDX-License-Identifier: Unlicense */ + +#ifndef __EFI_TYPES_H__ +#define __EFI_TYPES_H__ + +#include +#include +#include + +typedef void *efi_handle_t; +typedef uint64_t efi_status_t; +typedef uint64_t efi_uint_t; + +static const efi_status_t EFI_SUCCESS = 0; +static const efi_status_t EFI_LOAD_ERROR = 1; +static const efi_status_t EFI_INVALID_PARAMETER = 2; +static const efi_status_t EFI_UNSUPPORTED = 3; +static const efi_status_t EFI_BUFFER_TOO_SMALL = 5; + +struct efi_time { + uint16_t year; + uint8_t month; + uint8_t day; + uint8_t hour; + uint8_t minute; + uint8_t second; + uint8_t pad1; + uint32_t nanosecond; + int16_t time_zone; + uint8_t daylight; + uint8_t pad2; +}; + +struct efi_guid { + uint32_t data1; + uint16_t data2; + uint16_t data3; + uint8_t data4[8]; +}; + +struct efi_table_header { + uint64_t signature; + uint32_t revision; + uint32_t header_size; + uint32_t crc32; + uint32_t reserved; +}; + +struct efi_memory_descriptor { + uint32_t type; + uint64_t physical_start; + uint64_t virtual_start; + uint64_t pages; + uint64_t attributes; +}; + +enum efi_allocate_type { + EFI_ALLOCATE_ANY_PAGES, + EFI_ALLOCATE_MAX_ADDRESS, + EFI_ALLOCATE_ADDRESS, + EFI_MAX_ALLOCATE_TYPE, +}; + +enum efi_memory_type { + EFI_RESERVED_MEMORY_TYPE, + EFI_LOADER_CODE, + EFI_LOADER_DATA, + EFI_BOOT_SERVICES_CODE, + EFI_BOOT_SERVICES_DATA, + EFI_RUNTIME_SERVICES_CODE, + EFI_RUNTIME_SERVICES_DATA, + EFI_CONVENTIAL_MEMORY, + EFI_UNUSABLE_MEMORY, + EFI_ACPI_RECLAIM_MEMORY, + EFI_ACPI_MEMORY_NVS, + EFI_MEMORY_MAPPED_IO, + EFI_MEMORY_MAPPED_IO_PORT_SPACE, + EFI_PAL_CODE, + EFI_PERSISTENT_MEMORY, + EFI_MAX_MEMORY_TYPE, +}; + +#endif // __EFI_TYPES_H__ diff --git a/Development/hex0.c b/Development/hex0.c new file mode 100644 index 0000000..991cf52 --- /dev/null +++ b/Development/hex0.c @@ -0,0 +1,121 @@ +/* SPDX-FileCopyrightText: 2022 Andrius Štikonas + * + * SPDX-License-Identifier: GPL-3.0-or-later */ + +/* Written in a low level C that is close to assembly. + * We skip error checking since this is a prototype for hex0 code */ + +#include "efi/efi.h" + +efi_status_t efi_main(efi_handle_t image_handle, struct efi_system_table *system) +{ + struct efi_loaded_image_protocol *image; + struct efi_simple_file_system_protocol *rootfs; + struct efi_file_protocol *rootdir; + struct efi_guid guid1 = EFI_LOADED_IMAGE_PROTOCOL_GUID; + struct efi_guid guid2 = EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID; + + /* Open Loaded Image protocol */ + system->boot->open_protocol(image_handle, &guid1, (void **) &image, image_handle, 0, + EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL); + + /* Command line args */ + uint16_t *options = image->load_options; + uint16_t *in; + uint16_t *out; + do { + ++options; + } while (*options != ' '); /* Skip app name */ + in = ++options; + do { + ++options; + } while (*options != ' '); + *options = 0; + out = ++options; + + /* Get root device */ + efi_handle_t root_device = image->device; + system->boot->open_protocol(root_device, &guid2, (void **) &rootfs, image_handle, 0, + EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL); + /* Get root fs */ + rootfs->open_volume(rootfs, &rootdir); + + /* Open file for reading */ + struct efi_file_protocol *fin; + rootdir->open(rootdir, &fin, in, EFI_FILE_MODE_READ, EFI_FILE_READ_ONLY); + + /* Open file for writing */ + struct efi_file_protocol *fout; + rootdir->open(rootdir, &fout, out, EFI_FILE_MODE_CREATE| EFI_FILE_MODE_WRITE | EFI_FILE_MODE_READ, 0); + + uint8_t c; + uint64_t size; + + uint8_t toggle = 0; + uint8_t hold; + +next_byte: + size = 1; + fin->read(fin, &size, &c); + + /* If the file ended (0 bytes read) terminate */ + if (size == 0) { + goto terminate; + } + + /* Check if it's a comment */ + if (c == '#' || c == ';') { + goto loop; + } + goto not_comment; + + loop: + fin->read(fin, &size, &c); + /* If the file ended (0 bytes read) terminate */ + if (size == 0) { + goto terminate; + } + + /* Check if read byte is the end of the comment (i.e. a newline character), + * in that case we continue processing */ + if (c == '\n' || c == '\r') { + goto next_byte; + } + goto loop; + +not_comment: + /* Check if it's a hex character: + * in the case it's not, ignores and reads next byte */ + + if (c >= '0' && c <= '9') { + c -= 48; + } + else if (c >= 'A' && c <= 'F') { + c -= 55; + } + else if (c >= 'a' && c <= 'f') { + c -= 87; + } + else { + goto next_byte; + } + + if (!toggle) { + hold = c; + toggle = 1; + } + else { + c = (hold << 4) + c; + fout->write(fout, &size, &c); + hold = 0; + toggle = 0; + } + + goto next_byte; + +terminate: + /* rootdir->close(fin); + rootdir->close(fout); */ + + return 0; +} diff --git a/Development/rootfs/hex0_AMD64_POSIX.hex0 b/Development/rootfs/hex0_AMD64_POSIX.hex0 new file mode 100644 index 0000000..52da31d --- /dev/null +++ b/Development/rootfs/hex0_AMD64_POSIX.hex0 @@ -0,0 +1,234 @@ +### Copyright (C) 2016 Jeremiah Orians +### Copyright (C) 2017 Jan Nieuwenhuizen +### This file is part of stage0. +### +### stage0 is free software: you can redistribute it and/or modify +### it under the terms of the GNU General Public License as published by +### the Free Software Foundation, either version 3 of the License, or +### (at your option) any later version. +### +### stage0 is distributed in the hope that it will be useful, +### but WITHOUT ANY WARRANTY; without even the implied warranty of +### MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +### GNU General Public License for more details. +### +### You should have received a copy of the GNU General Public License +### along with stage0. If not, see . + +### elf64.hex2: 64 bit elf header in hex2 +### if you wish to use this header, you need to add :ELF_end to the end of your +### M1 or hex2 files. + +## ELF Header +#:ELF_base +7F 45 4C 46 ## e_ident[EI_MAG0-3] ELF's magic number + +02 ## e_ident[EI_CLASS] Indicating 64 bit +01 ## e_ident[EI_DATA] Indicating little endianness +01 ## e_ident[EI_VERSION] Indicating original elf + +03 ## e_ident[EI_OSABI] Set at 3 because FreeBSD is strict +00 ## e_ident[EI_ABIVERSION] Set at 0 because none cares + +00 00 00 00 00 00 00 ## e_ident[EI_PAD] +02 00 ## e_type Indicating Executable +3E 00 ## e_machine Indicating AMD64 +01 00 00 00 ## e_version Indicating original elf + +78 00 60 00 00 00 00 00 ## e_entry Address of the entry point (Number of bytes this header is + Base Address) +40 00 00 00 00 00 00 00 ## e_phoff Address of program header table +00 00 00 00 00 00 00 00 ## e_shoff Address of section header table + +00 00 00 00 ## e_flags +40 00 ## e_ehsize Indicating our 64 Byte header + +38 00 ## e_phentsize size of a program header table +01 00 ## e_phnum number of entries in program table + +00 00 ## e_shentsize size of a section header table +00 00 ## e_shnum number of entries in section table + +00 00 ## e_shstrndx index of the section names + +## Program Header +#:ELF_program_headers +01 00 00 00 ## p_type +07 00 00 00 ## ph_flags: PF-X|PF-W|PF-R = 7 +00 00 00 00 00 00 00 00 ## p_offset + +00 00 60 00 00 00 00 00 ## p_vaddr +00 00 60 00 00 00 00 00 ## p_physaddr + +95 01 00 00 00 00 00 00 ## p_filesz +95 01 00 00 00 00 00 00 ## p_memsz + +01 00 00 00 00 00 00 00 ## Required alignment + +#:ELF_text + +# Where the ELF Header is going to hit +# Simply jump to _start +# Our main function +#:_start + 58 ; POP_RAX # Get the number of arguments + 5F ; POP_RDI # Get the program name + 5F ; POP_RDI # Get the actual input name + BE 00000000 ; LOADI32_ESI %0 # prepare read_only + B8 02000000 ; LOADI32_EAX %2 # the syscall number for open() + 0F05 ; SYSCALL # Now open that damn file + 4989C1 ; COPY_RAX_to_R9 # Preserve the file pointer we were given + + 5F ; POP_RDI # Get the actual output name + BE 41020000 ; LOADI32_ESI %577 # Prepare file as O_WRONLY|O_CREAT|O_TRUNC + BA C0010000 ; LOADI32_EDX %448 # Prepare file as RWX for owner only (700 in octal) + B8 02000000 ; LOADI32_EAX %2 # the syscall number for open() + 0F05 ; SYSCALL # Now open that damn file + 4989C2 ; COPY_RAX_to_R10 # Preserve the file pointer we were given + + # Our flag for byte processing + 49C7C7 FFFFFFFF ; LOADI32_R15 %-1 + + # temp storage for the sum + 49C7C6 00000000 ; LOADI32_R14 %0 + +#:loop + # Read a byte + E8 BA000000 ; CALLI32 %read_byte + + # process byte + E8 34000000 ; CALLI32 %hex + + # deal with -1 values + 4883F8 00 ; CMP_RAX_Immediate8 !0 + 7C F0 ; JL8 !loop + + # deal with toggle + 4983FF 00 ; CMP_R15_Immediate8 !0 + 7D 0C ; JGE8 !print + + # process first byte of pair + 4989C6 ; MOVE_R14_RAX + 49C7C7 00000000 ; LOADI32_R15 %0 + EB DE ; JMP8 !loop + +# process second byte of pair +#:print + # update the sum and store in output + 49C1E6 04 ; SHL_R14_Immediate8 !4 + 4C01F0 ; ADD_RAX_R14 + 880425 68016000 ; STORE8_al_Absolute32 &output + + # flip the toggle + 49C7C7 FFFFFFFF ; LOADI32_R15 %-1 + + E8 6A000000 ; CALLI32 %write_byte + + EB C2 ; JMP8 !loop + +#:hex + # Purge Comment Lines (#) + 4883F8 23 ; CMP_RAX_Immediate8 !35 + 74 2C ; JE8 !purge_comment + + # Purge Comment Lines (;) + 4883F8 3B ; CMP_RAX_Immediate8 !59 + 74 26 ; JE8 !purge_comment + + # deal all ascii less than '0' + 4883F8 30 ; CMP_RAX_Immediate8 !48 + 7C 42 ; JL8 !ascii_other + + # deal with 0-9 + 4883F8 3A ; CMP_RAX_Immediate8 !58 + 7C 2D ; JL8 !ascii_num + + # deal with all ascii less than 'A' + 4883F8 41 ; CMP_RAX_Immediate8 !65 + 7C 36 ; JL8 !ascii_other + + # deal with 'A'-'F' + 4883F8 47 ; CMP_RAX_Immediate8 !71 + 7C 2B ; JL8 !ascii_high + + # deal with all ascii less than 'a' + 4883F8 61 ; CMP_RAX_Immediate8 !97 + 7C 2A ; JL8 !ascii_other + + #deal with 'a'-'f' + 4883F8 67 ; CMP_RAX_Immediate8 !103 + 7C 1A ; JL8 !ascii_low + + # The rest that remains needs to be ignored + EB 22 ; JMP8 !ascii_other + +#:purge_comment + # Read a byte + E8 4A000000 ; CALLI32 %read_byte + + # Loop if not LF + 4883F8 0A ; CMP_RAX_Immediate8 !10 + 75 F5 ; JNE8 !purge_comment + + + # Otherwise return -1 + 48C7C0 FFFFFFFF ; LOADI32_RAX %-1 + C3 ; RETQ + +#:ascii_num + 4883E8 30 ; SUB_RAX_Immediate8 !48 + C3 ; RETQ + +#:ascii_low + 4883E8 57 ; SUB_RAX_Immediate8 !87 + C3 ; RETQ + +#:ascii_high + 4883E8 37 ; SUB_RAX_Immediate8 !55 + C3 ; RETQ + +#:ascii_other + 48C7C0 FFFFFFFF ; LOADI32_RAX %-1 + C3 ; RETQ + +#:Done + # program completed Successfully + BF 00000000 ; LOADI32_EDI %0 # All is well + B8 3C000000 ; LOADI32_RAX %60 # put the exit syscall number in rax + 0F05 ; SYSCALL # Call it a good day + +#:write_byte + # Print our Hex + BA 01000000 ; LOADI32_EDX %1 # set the size of chars we want + BE 68016000 ; LOADI32_ESI %output # What we are writing + 4C89D7 ; COPY_R10_to_RDI # Where are we writing to + B8 01000000 ; LOADI32_EAX %1 # the syscall number for write + 0F05 ; SYSCALL # call the Kernel + C3 ; RET + +# Where we are putting our output +#:output + # Reserve 4bytes of Zeros + 00000000 ; NULL + +#:read_byte + # Attempt to read 1 byte from STDIN + BA 01000000 ; LOADI32_EDX %1 # set the size of chars we want + BE 91016000 ; LOADI32_ESI &input # Where to put it + 4C89CF ; COPY_R9_to_RDI # Where are we reading from + B8 00000000 ; LOADI32_EAX %0 # the syscall number for read + 0F05 ; SYSCALL # call the Kernel + + 4885C0 ; TEST_RAX_RAX # check what we got + 74 C2 ; JE8 !Done # Got EOF call it done + + # load byte + 8A0425 91016000 ; LOAD8_al_Absolute32 &input # load char + 480FB6C0 ; MOVZBQ_RAX_AL # We have to zero extend it to use it + C3 ; RET + +# Where we get our input +#:input + # Reserve 4bytes of Zeros + 00000000 ; NULL + +#:ELF_end diff --git a/Development/rootfs/startup.nsh b/Development/rootfs/startup.nsh new file mode 100644 index 0000000..8a0d4cb --- /dev/null +++ b/Development/rootfs/startup.nsh @@ -0,0 +1,3 @@ +# SPDX-License-Identifier: Unlicense + +BOOTX64 hex0_AMD64_POSIX.hex0 hex0 diff --git a/LICENSES/GPL-3.0-or-later.txt b/LICENSES/GPL-3.0-or-later.txt new file mode 100644 index 0000000..5990771 --- /dev/null +++ b/LICENSES/GPL-3.0-or-later.txt @@ -0,0 +1,604 @@ +GNU GENERAL PUBLIC LICENSE +Version 3, 29 June 2007 + +Copyright © 2007 Free Software Foundation, Inc. + +Everyone is permitted to copy and distribute verbatim copies of this license +document, but changing it is not allowed. + +Preamble + +The GNU General Public License is a free, copyleft license for software and +other kinds of works. + +The licenses for most software and other practical works are designed to take +away your freedom to share and change the works. By contrast, the GNU General +Public License is intended to guarantee your freedom to share and change all +versions of a program--to make sure it remains free software for all its users. +We, the Free Software Foundation, use the GNU General Public License for most +of our software; it applies also to any other work released this way by its +authors. You can apply it to your programs, too. + +When we speak of free software, we are referring to freedom, not price. Our +General Public Licenses are designed to make sure that you have the freedom +to distribute copies of free software (and charge for them if you wish), that +you receive source code or can get it if you want it, that you can change +the software or use pieces of it in new free programs, and that you know you +can do these things. + +To protect your rights, we need to prevent others from denying you these rights +or asking you to surrender the rights. Therefore, you have certain responsibilities +if you distribute copies of the software, or if you modify it: responsibilities +to respect the freedom of others. + +For example, if you distribute copies of such a program, whether gratis or +for a fee, you must pass on to the recipients the same freedoms that you received. +You must make sure that they, too, receive or can get the source code. And +you must show them these terms so they know their rights. + +Developers that use the GNU GPL protect your rights with two steps: (1) assert +copyright on the software, and (2) offer you this License giving you legal +permission to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains that +there is no warranty for this free software. For both users' and authors' +sake, the GPL requires that modified versions be marked as changed, so that +their problems will not be attributed erroneously to authors of previous versions. + +Some devices are designed to deny users access to install or run modified +versions of the software inside them, although the manufacturer can do so. +This is fundamentally incompatible with the aim of protecting users' freedom +to change the software. The systematic pattern of such abuse occurs in the +area of products for individuals to use, which is precisely where it is most +unacceptable. Therefore, we have designed this version of the GPL to prohibit +the practice for those products. If such problems arise substantially in other +domains, we stand ready to extend this provision to those domains in future +versions of the GPL, as needed to protect the freedom of users. + +Finally, every program is threatened constantly by software patents. States +should not allow patents to restrict development and use of software on general-purpose +computers, but in those that do, we wish to avoid the special danger that +patents applied to a free program could make it effectively proprietary. To +prevent this, the GPL assures that patents cannot be used to render the program +non-free. + +The precise terms and conditions for copying, distribution and modification +follow. + +TERMS AND CONDITIONS + +0. Definitions. + +“This License” refers to version 3 of the GNU General Public License. + +“Copyright” also means copyright-like laws that apply to other kinds of works, +such as semiconductor masks. + +“The Program” refers to any copyrightable work licensed under this License. +Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals +or organizations. + +To “modify” a work means to copy from or adapt all or part of the work in +a fashion requiring copyright permission, other than the making of an exact +copy. The resulting work is called a “modified version” of the earlier work +or a work “based on” the earlier work. + +A “covered work” means either the unmodified Program or a work based on the +Program. + +To “propagate” a work means to do anything with it that, without permission, +would make you directly or secondarily liable for infringement under applicable +copyright law, except executing it on a computer or modifying a private copy. +Propagation includes copying, distribution (with or without modification), +making available to the public, and in some countries other activities as +well. + +To “convey” a work means any kind of propagation that enables other parties +to make or receive copies. Mere interaction with a user through a computer +network, with no transfer of a copy, is not conveying. + +An interactive user interface displays “Appropriate Legal Notices” to the +extent that it includes a convenient and prominently visible feature that +(1) displays an appropriate copyright notice, and (2) tells the user that +there is no warranty for the work (except to the extent that warranties are +provided), that licensees may convey the work under this License, and how +to view a copy of this License. If the interface presents a list of user commands +or options, such as a menu, a prominent item in the list meets this criterion. + +1. Source Code. +The “source code” for a work means the preferred form of the work for making +modifications to it. “Object code” means any non-source form of a work. + +A “Standard Interface” means an interface that either is an official standard +defined by a recognized standards body, or, in the case of interfaces specified +for a particular programming language, one that is widely used among developers +working in that language. + +The “System Libraries” of an executable work include anything, other than +the work as a whole, that (a) is included in the normal form of packaging +a Major Component, but which is not part of that Major Component, and (b) +serves only to enable use of the work with that Major Component, or to implement +a Standard Interface for which an implementation is available to the public +in source code form. A “Major Component”, in this context, means a major essential +component (kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to produce +the work, or an object code interpreter used to run it. + +The “Corresponding Source” for a work in object code form means all the source +code needed to generate, install, and (for an executable work) run the object +code and to modify the work, including scripts to control those activities. +However, it does not include the work's System Libraries, or general-purpose +tools or generally available free programs which are used unmodified in performing +those activities but which are not part of the work. For example, Corresponding +Source includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically linked +subprograms that the work is specifically designed to require, such as by +intimate data communication or control flow between those subprograms and +other parts of the work. + +The Corresponding Source need not include anything that users can regenerate +automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same work. + +2. Basic Permissions. +All rights granted under this License are granted for the term of copyright +on the Program, and are irrevocable provided the stated conditions are met. +This License explicitly affirms your unlimited permission to run the unmodified +Program. The output from running a covered work is covered by this License +only if the output, given its content, constitutes a covered work. This License +acknowledges your rights of fair use or other equivalent, as provided by copyright +law. + +You may make, run and propagate covered works that you do not convey, without +conditions so long as your license otherwise remains in force. You may convey +covered works to others for the sole purpose of having them make modifications +exclusively for you, or provide you with facilities for running those works, +provided that you comply with the terms of this License in conveying all material +for which you do not control copyright. Those thus making or running the covered +works for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of your copyrighted +material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the conditions +stated below. Sublicensing is not allowed; section 10 makes it unnecessary. + +3. Protecting Users' Legal Rights From Anti-Circumvention Law. +No covered work shall be deemed part of an effective technological measure +under any applicable law fulfilling obligations under article 11 of the WIPO +copyright treaty adopted on 20 December 1996, or similar laws prohibiting +or restricting circumvention of such measures. + +When you convey a covered work, you waive any legal power to forbid circumvention +of technological measures to the extent such circumvention is effected by +exercising rights under this License with respect to the covered work, and +you disclaim any intention to limit operation or modification of the work +as a means of enforcing, against the work's users, your or third parties' +legal rights to forbid circumvention of technological measures. + +4. Conveying Verbatim Copies. +You may convey verbatim copies of the Program's source code as you receive +it, in any medium, provided that you conspicuously and appropriately publish +on each copy an appropriate copyright notice; keep intact all notices stating +that this License and any non-permissive terms added in accord with section +7 apply to the code; keep intact all notices of the absence of any warranty; +and give all recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, and you +may offer support or warranty protection for a fee. + +5. Conveying Modified Source Versions. +You may convey a work based on the Program, or the modifications to produce +it from the Program, in the form of source code under the terms of section +4, provided that you also meet all of these conditions: + +a) The work must carry prominent notices stating that you modified it, and +giving a relevant date. + +b) The work must carry prominent notices stating that it is released under +this License and any conditions added under section 7. This requirement modifies +the requirement in section 4 to “keep intact all notices”. + +c) You must license the entire work, as a whole, under this License to anyone +who comes into possession of a copy. This License will therefore apply, along +with any applicable section 7 additional terms, to the whole of the work, +and all its parts, regardless of how they are packaged. This License gives +no permission to license the work in any other way, but it does not invalidate +such permission if you have separately received it. + +d) If the work has interactive user interfaces, each must display Appropriate +Legal Notices; however, if the Program has interactive interfaces that do +not display Appropriate Legal Notices, your work need not make them do so. + +A compilation of a covered work with other separate and independent works, +which are not by their nature extensions of the covered work, and which are +not combined with it such as to form a larger program, in or on a volume of +a storage or distribution medium, is called an “aggregate” if the compilation +and its resulting copyright are not used to limit the access or legal rights +of the compilation's users beyond what the individual works permit. Inclusion +of a covered work in an aggregate does not cause this License to apply to +the other parts of the aggregate. + +6. Conveying Non-Source Forms. +You may convey a covered work in object code form under the terms of sections +4 and 5, provided that you also convey the machine-readable Corresponding +Source under the terms of this License, in one of these ways: + +a) Convey the object code in, or embodied in, a physical product (including +a physical distribution medium), accompanied by the Corresponding Source fixed +on a durable physical medium customarily used for software interchange. + +b) Convey the object code in, or embodied in, a physical product (including +a physical distribution medium), accompanied by a written offer, valid for +at least three years and valid for as long as you offer spare parts or customer +support for that product model, to give anyone who possesses the object code +either (1) a copy of the Corresponding Source for all the software in the +product that is covered by this License, on a durable physical medium customarily +used for software interchange, for a price no more than your reasonable cost +of physically performing this conveying of source, or (2) access to copy the +Corresponding Source from a network server at no charge. + +c) Convey individual copies of the object code with a copy of the written +offer to provide the Corresponding Source. This alternative is allowed only +occasionally and noncommercially, and only if you received the object code +with such an offer, in accord with subsection 6b. + +d) Convey the object code by offering access from a designated place (gratis +or for a charge), and offer equivalent access to the Corresponding Source +in the same way through the same place at no further charge. You need not +require recipients to copy the Corresponding Source along with the object +code. If the place to copy the object code is a network server, the Corresponding +Source may be on a different server (operated by you or a third party) that +supports equivalent copying facilities, provided you maintain clear directions +next to the object code saying where to find the Corresponding Source. Regardless +of what server hosts the Corresponding Source, you remain obligated to ensure +that it is available for as long as needed to satisfy these requirements. + +e) Convey the object code using peer-to-peer transmission, provided you inform +other peers where the object code and Corresponding Source of the work are +being offered to the general public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded from +the Corresponding Source as a System Library, need not be included in conveying +the object code work. + +A “User Product” is either (1) a “consumer product”, which means any tangible +personal property which is normally used for personal, family, or household +purposes, or (2) anything designed or sold for incorporation into a dwelling. +In determining whether a product is a consumer product, doubtful cases shall +be resolved in favor of coverage. For a particular product received by a particular +user, “normally used” refers to a typical or common use of that class of product, +regardless of the status of the particular user or of the way in which the +particular user actually uses, or expects or is expected to use, the product. +A product is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent the +only significant mode of use of the product. + +“Installation Information” for a User Product means any methods, procedures, +authorization keys, or other information required to install and execute modified +versions of a covered work in that User Product from a modified version of +its Corresponding Source. The information must suffice to ensure that the +continued functioning of the modified object code is in no case prevented +or interfered with solely because modification has been made. + +If you convey an object code work under this section in, or with, or specifically +for use in, a User Product, and the conveying occurs as part of a transaction +in which the right of possession and use of the User Product is transferred +to the recipient in perpetuity or for a fixed term (regardless of how the +transaction is characterized), the Corresponding Source conveyed under this +section must be accompanied by the Installation Information. But this requirement +does not apply if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has been installed +in ROM). + +The requirement to provide Installation Information does not include a requirement +to continue to provide support service, warranty, or updates for a work that +has been modified or installed by the recipient, or for the User Product in +which it has been modified or installed. Access to a network may be denied +when the modification itself materially and adversely affects the operation +of the network or violates the rules and protocols for communication across +the network. + +Corresponding Source conveyed, and Installation Information provided, in accord +with this section must be in a format that is publicly documented (and with +an implementation available to the public in source code form), and must require +no special password or key for unpacking, reading or copying. + +7. Additional Terms. +“Additional permissions” are terms that supplement the terms of this License +by making exceptions from one or more of its conditions. Additional permissions +that are applicable to the entire Program shall be treated as though they +were included in this License, to the extent that they are valid under applicable +law. If additional permissions apply only to part of the Program, that part +may be used separately under those permissions, but the entire Program remains +governed by this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option remove any +additional permissions from that copy, or from any part of it. (Additional +permissions may be written to require their own removal in certain cases when +you modify the work.) You may place additional permissions on material, added +by you to a covered work, for which you have or can give appropriate copyright +permission. + +Notwithstanding any other provision of this License, for material you add +to a covered work, you may (if authorized by the copyright holders of that +material) supplement the terms of this License with terms: + +a) Disclaiming warranty or limiting liability differently from the terms of +sections 15 and 16 of this License; or + +b) Requiring preservation of specified reasonable legal notices or author +attributions in that material or in the Appropriate Legal Notices displayed +by works containing it; or + +c) Prohibiting misrepresentation of the origin of that material, or requiring +that modified versions of such material be marked in reasonable ways as different +from the original version; or + +d) Limiting the use for publicity purposes of names of licensors or authors +of the material; or + +e) Declining to grant rights under trademark law for use of some trade names, +trademarks, or service marks; or + +f) Requiring indemnification of licensors and authors of that material by +anyone who conveys the material (or modified versions of it) with contractual +assumptions of liability to the recipient, for any liability that these contractual +assumptions directly impose on those licensors and authors. + +All other non-permissive additional terms are considered “further restrictions” +within the meaning of section 10. If the Program as you received it, or any +part of it, contains a notice stating that it is governed by this License +along with a term that is a further restriction, you may remove that term. +If a license document contains a further restriction but permits relicensing +or conveying under this License, you may add to a covered work material governed +by the terms of that license document, provided that the further restriction +does not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you must place, +in the relevant source files, a statement of the additional terms that apply +to those files, or a notice indicating where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the form +of a separately written license, or stated as exceptions; the above requirements +apply either way. + +8. Termination. +You may not propagate or modify a covered work except as expressly provided +under this License. Any attempt otherwise to propagate or modify it is void, +and will automatically terminate your rights under this License (including +any patent licenses granted under the third paragraph of section 11). + +However, if you cease all violation of this License, then your license from +a particular copyright holder is reinstated (a) provisionally, unless and +until the copyright holder explicitly and finally terminates your license, +and (b) permanently, if the copyright holder fails to notify you of the violation +by some reasonable means prior to 60 days after the cessation. + +Moreover, your license from a particular copyright holder is reinstated permanently +if the copyright holder notifies you of the violation by some reasonable means, +this is the first time you have received notice of violation of this License +(for any work) from that copyright holder, and you cure the violation prior +to 30 days after your receipt of the notice. + +Termination of your rights under this section does not terminate the licenses +of parties who have received copies or rights from you under this License. +If your rights have been terminated and not permanently reinstated, you do +not qualify to receive new licenses for the same material under section 10. + +9. Acceptance Not Required for Having Copies. +You are not required to accept this License in order to receive or run a copy +of the Program. Ancillary propagation of a covered work occurring solely as +a consequence of using peer-to-peer transmission to receive a copy likewise +does not require acceptance. However, nothing other than this License grants +you permission to propagate or modify any covered work. These actions infringe +copyright if you do not accept this License. Therefore, by modifying or propagating +a covered work, you indicate your acceptance of this License to do so. + +10. Automatic Licensing of Downstream Recipients. +Each time you convey a covered work, the recipient automatically receives +a license from the original licensors, to run, modify and propagate that work, +subject to this License. You are not responsible for enforcing compliance +by third parties with this License. + +An “entity transaction” is a transaction transferring control of an organization, +or substantially all assets of one, or subdividing an organization, or merging +organizations. If propagation of a covered work results from an entity transaction, +each party to that transaction who receives a copy of the work also receives +whatever licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the Corresponding +Source of the work from the predecessor in interest, if the predecessor has +it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the rights +granted or affirmed under this License. For example, you may not impose a +license fee, royalty, or other charge for exercise of rights granted under +this License, and you may not initiate litigation (including a cross-claim +or counterclaim in a lawsuit) alleging that any patent claim is infringed +by making, using, selling, offering for sale, or importing the Program or +any portion of it. + +11. Patents. +A “contributor” is a copyright holder who authorizes use under this License +of the Program or a work on which the Program is based. The work thus licensed +is called the contributor's “contributor version”. + +A contributor's “essential patent claims” are all patent claims owned or controlled +by the contributor, whether already acquired or hereafter acquired, that would +be infringed by some manner, permitted by this License, of making, using, +or selling its contributor version, but do not include claims that would be +infringed only as a consequence of further modification of the contributor +version. For purposes of this definition, “control” includes the right to +grant patent sublicenses in a manner consistent with the requirements of this +License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free patent +license under the contributor's essential patent claims, to make, use, sell, +offer for sale, import and otherwise run, modify and propagate the contents +of its contributor version. + +In the following three paragraphs, a “patent license” is any express agreement +or commitment, however denominated, not to enforce a patent (such as an express +permission to practice a patent or covenant not to sue for patent infringement). +To “grant” such a patent license to a party means to make such an agreement +or commitment not to enforce a patent against the party. + +If you convey a covered work, knowingly relying on a patent license, and the +Corresponding Source of the work is not available for anyone to copy, free +of charge and under the terms of this License, through a publicly available +network server or other readily accessible means, then you must either (1) +cause the Corresponding Source to be so available, or (2) arrange to deprive +yourself of the benefit of the patent license for this particular work, or +(3) arrange, in a manner consistent with the requirements of this License, +to extend the patent license to downstream recipients. “Knowingly relying” +means you have actual knowledge that, but for the patent license, your conveying +the covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that country +that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or arrangement, +you convey, or propagate by procuring conveyance of, a covered work, and grant +a patent license to some of the parties receiving the covered work authorizing +them to use, propagate, modify or convey a specific copy of the covered work, +then the patent license you grant is automatically extended to all recipients +of the covered work and works based on it. + +A patent license is “discriminatory” if it does not include within the scope +of its coverage, prohibits the exercise of, or is conditioned on the non-exercise +of one or more of the rights that are specifically granted under this License. +You may not convey a covered work if you are a party to an arrangement with +a third party that is in the business of distributing software, under which +you make payment to the third party based on the extent of your activity of +conveying the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by you +(or copies made from those copies), or (b) primarily for and in connection +with specific products or compilations that contain the covered work, unless +you entered into that arrangement, or that patent license was granted, prior +to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting any implied +license or other defenses to infringement that may otherwise be available +to you under applicable patent law. + +12. No Surrender of Others' Freedom. +If conditions are imposed on you (whether by court order, agreement or otherwise) +that contradict the conditions of this License, they do not excuse you from +the conditions of this License. If you cannot convey a covered work so as +to satisfy simultaneously your obligations under this License and any other +pertinent obligations, then as a consequence you may not convey it at all. +For example, if you agree to terms that obligate you to collect a royalty +for further conveying from those to whom you convey the Program, the only +way you could satisfy both those terms and this License would be to refrain +entirely from conveying the Program. + +13. Use with the GNU Affero General Public License. +Notwithstanding any other provision of this License, you have permission to +link or combine any covered work with a work licensed under version 3 of the +GNU Affero General Public License into a single combined work, and to convey +the resulting work. The terms of this License will continue to apply to the +part which is the covered work, but the special requirements of the GNU Affero +General Public License, section 13, concerning interaction through a network +will apply to the combination as such. + +14. Revised Versions of this License. +The Free Software Foundation may publish revised and/or new versions of the +GNU General Public License from time to time. Such new versions will be similar +in spirit to the present version, but may differ in detail to address new +problems or concerns. + +Each version is given a distinguishing version number. If the Program specifies +that a certain numbered version of the GNU General Public License “or any +later version” applies to it, you have the option of following the terms and +conditions either of that numbered version or of any later version published +by the Free Software Foundation. If the Program does not specify a version +number of the GNU General Public License, you may choose any version ever +published by the Free Software Foundation. + +If the Program specifies that a proxy can decide which future versions of +the GNU General Public License can be used, that proxy's public statement +of acceptance of a version permanently authorizes you to choose that version +for the Program. + +Later license versions may give you additional or different permissions. However, +no additional obligations are imposed on any author or copyright holder as +a result of your choosing to follow a later version. + +15. Disclaimer of Warranty. +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE +LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER +EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM +PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +16. Limitation of Liability. +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL +ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM +AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, +INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO +USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED +INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE +PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +17. Interpretation of Sections 15 and 16. +If the disclaimer of warranty and limitation of liability provided above cannot +be given local legal effect according to their terms, reviewing courts shall +apply local law that most closely approximates an absolute waiver of all civil +liability in connection with the Program, unless a warranty or assumption +of liability accompanies a copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS + +How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest possible +use to the public, the best way to achieve this is to make it free software +which everyone can redistribute and change under these terms. + +To do so, attach the following notices to the program. It is safest to attach +them to the start of each source file to most effectively state the exclusion +of warranty; and each file should have at least the “copyright” line and a +pointer to where the full notice is found. + + + Copyright (C) + +This program is free software: you can redistribute it and/or modify it under +the terms of the GNU General Public License as published by the Free Software +Foundation, either version 3 of the License, or (at your option) any later +version. + +This program is distributed in the hope that it will be useful, but WITHOUT +ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. + +You should have received a copy of the GNU General Public License along with +this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + +If the program does terminal interaction, make it output a short notice like +this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. +This is free software, and you are welcome to redistribute it under certain +conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands might +be different; for a GUI interface, you would use an “about box”. + +You should also get your employer (if you work as a programmer) or school, +if any, to sign a “copyright disclaimer” for the program, if necessary. For +more information on this, and how to apply and follow the GNU GPL, see . + +The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General Public +License instead of this License. But first, please read . diff --git a/LICENSES/MIT.txt b/LICENSES/MIT.txt new file mode 100644 index 0000000..f0fd20a --- /dev/null +++ b/LICENSES/MIT.txt @@ -0,0 +1,20 @@ +MIT License + +Copyright (c) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is furnished +to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS +OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF +OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/LICENSES/Unlicense.txt b/LICENSES/Unlicense.txt new file mode 100644 index 0000000..5227a51 --- /dev/null +++ b/LICENSES/Unlicense.txt @@ -0,0 +1,22 @@ +This is free and unencumbered software released into the public domain. + +Anyone is free to copy, modify, publish, use, compile, sell, or distribute +this software, either in source code form or as a compiled binary, for any +purpose, commercial or non-commercial, and by any means. + +In jurisdictions that recognize copyright laws, the author or authors of this +software dedicate any and all copyright interest in the software to the public +domain. We make this dedication for the benefit of the public at large and +to the detriment of our heirs and +successors. We intend this dedication to be an overt act of relinquishment +in perpetuity of all present and future rights to this software under copyright +law. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS +BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH +THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +For more information, please refer to