Merge pull request #4 from mebrahimaleem/apic

APIC and IOAPIC drivers. ACPICA stubs with minimal osl. Working local APIC timer interrupts at 50ms

Author: mebrahimaleem

.github/workflows/build.yml

@@ -0,0 +1,39 @@
+name: Run test suite
+on:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install apt packages
+        run: |
+          sudo apt update
+          sudo apt install clang lld llvm grub-efi-amd64-bin mtools
+
+      - name: Build ModulOS
+        run: |
+          make -j$(nproc) build
+
+      - name: Run test suite
+        run: |
+          make test-all | tee build/test-log.txt
+
+      - name: Archive debugging symbols
+        uses: actions/upload-artifact@v4
+        with:
+          name: dbg-symbols
+          path: build/modulos-dbg
+          retention-days: 2
+
+      - name: Archive testsuite log
+        uses: actions/upload-artifact@v4
+        with:
+          name: testsuite-log
+          path: build/test-log.txt
+          retention-days: 2

.github/workflows/test.yml

@@ -8,3 +8,4 @@ tags
 compile_commands.json
 
 !.gitignore
+!.github

.gitignore

@@ -6,26 +6,10 @@ By default, debugging related logging is disabled and optimizations are enabled.
 
 The built modules can be customized by commenting/uncommenting the various `export BUILD_<MODULENAME> = 1` lines near the beginning of the top level Makefile
 
-## Cross Compilation Instructions
+ModulOS must be compiled with clang/lld. The following packages are also needed:
+- mtools
+- x86_64-efi grub
+- llvm binary utilities
 
-- binutils 2.45 was built with the following configuration: `--target=x86_64-elf --program-prefix=x86_64-elf- --with-sysroot --disable-nls --disable-werror`
-
-- gcc 15.2.0 was built with the following configuration: `--target=x86_64-elf --program-prefix=x86_64-elf- --disable-nls --enable-languages=c --without-headers`
-
-- grub 2.06 was built with the following configuration: `--with-platform=efi --target=x86_64 --program-prefix=x86_64-elf- --with-sysroot --disable-nls --disable-werror CFLAGS='-std=gnu99'`
-
-
-- Patch files can be found in `contrib/`
-
-The compiler and binutils should be built in the following order:
-
-1. Build and install binutils: `make && make install`
-2. Patch gcc source using noredzone.patch
-3. Build and install gcc: `make all-gcc && make install-gcc`
-4. Try building libgcc (this will fail due to PIC being enabled): `make all-target-libgcc CFLAGS_FOR_TARGET='-g -O2 -mcmodel=kernel' || true`
-5. Patch gcc `objdir/x86_64-elf/libgcc/Makefile`: `sed -i 's/PICFLAG/DISABLED_PICFLAG/g' x86_64-elf/libgcc/Makefile`
-6. Patch gcc `objdir/x86_64-elf/libgcc-noredzone/libgcc/Makefile`: `sed -i 's/PICFLAG/DISABLED_PICFLAG/g' x86_64-elf/libgcc-noredzone/libgcc/Makefile`
-7. Rebuild and install libgcc: `make all-target-libgcc CFLAGS_FOR_TARGET='-g -O2 -mcmodel=kernel' && make install-target-libgcc`
-
-Grub can be built the same way as binutils
-Optionally, gdb can be built the same way as binutils
+On debian based systems, all dependencies can be installed with the apt package manager:
+`apt install clang lld llvm grub-efi-amd64-bin mtools`

INSTALL

@@ -0,0 +1,187 @@
+The ACPICA source code has been modified in the following ways on January 9th 2026:
+* The platform/acmodulos.h file as been added, heavily based on platform/aclinux.h and platform/aclinuxex.h
+* The platform/acenv.h file now includes platform/acmodulos.h
+
+Most of ACPICA is under the following license:
+
+1. Copyright Notice
+
+Some or all of this work - Copyright (c) 1999 - 2025, Intel Corp.
+All rights reserved.
+
+2. License
+
+2.1. This is your license from Intel Corp. under its intellectual property
+rights. You may have additional license terms from the party that provided
+you this software, covering your right to use that party's intellectual
+property rights.
+
+2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
+copy of the source code appearing in this file ("Covered Code") an
+irrevocable, perpetual, worldwide license under Intel's copyrights in the
+base code distributed originally by Intel ("Original Intel Code") to copy,
+make derivatives, distribute, use and display any portion of the Covered
+Code in any form, with the right to sublicense such rights; and
+
+2.3. Intel grants Licensee a non-exclusive and non-transferable patent
+license (with the right to sublicense), under only those claims of Intel
+patents that are infringed by the Original Intel Code, to make, use, sell,
+offer to sell, and import the Covered Code and derivative works thereof
+solely to the minimum extent necessary to exercise the above copyright
+license, and in no event shall the patent license extend to any additions
+to or modifications of the Original Intel Code. No other license or right
+is granted directly or by implication, estoppel or otherwise;
+
+The above copyright and patent license is granted only if the following
+conditions are met:
+
+3. Conditions
+
+3.1. Redistribution of Source with Rights to Further Distribute Source.
+Redistribution of source code of any substantial portion of the Covered
+Code or modification with rights to further distribute source must include
+the above Copyright Notice, the above License, this list of Conditions,
+and the following Disclaimer and Export Compliance provision. In addition,
+Licensee must cause all Covered Code to which Licensee contributes to
+contain a file documenting the changes Licensee made to create that Covered
+Code and the date of any change. Licensee must include in that file the
+documentation of any changes made by any predecessor Licensee. Licensee
+must include a prominent statement that the modification is derived,
+directly or indirectly, from Original Intel Code.
+
+3.2. Redistribution of Source with no Rights to Further Distribute Source.
+Redistribution of source code of any substantial portion of the Covered
+Code or modification without rights to further distribute source must
+include the following Disclaimer and Export Compliance provision in the
+documentation and/or other materials provided with distribution. In
+addition, Licensee may not authorize further sublicense of source of any
+portion of the Covered Code, and must include terms to the effect that the
+license from Licensee to its licensee is limited to the intellectual
+property embodied in the software Licensee provides to its licensee, and
+not to intellectual property embodied in modifications its licensee may
+make.
+
+3.3. Redistribution of Executable. Redistribution in executable form of any
+substantial portion of the Covered Code or modification must reproduce the
+above Copyright Notice, and the following Disclaimer and Export Compliance
+provision in the documentation and/or other materials provided with the
+distribution.
+
+3.4. Intel retains all right, title, and interest in and to the Original
+Intel Code.
+
+3.5. Neither the name Intel nor any other trademark owned or controlled by
+Intel shall be used in advertising or otherwise to promote the sale, use or
+other dealings in products derived from or relating to the Covered Code
+without prior written authorization from Intel.
+
+4. Disclaimer and Export Compliance
+
+4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
+HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
+IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
+INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
+UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
+IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
+PARTICULAR PURPOSE.
+
+4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
+OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
+COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
+SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
+CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
+HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
+SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
+LIMITED REMEDY.
+
+4.3. Licensee shall not export, either directly or indirectly, any of this
+software or system incorporating such software without first obtaining any
+required license or other approval from the U. S. Department of Commerce or
+any other agency or department of the United States Government. In the
+event Licensee exports any such software from the United States or
+re-exports any such software from a foreign destination, Licensee shall
+ensure that the distribution and export/re-export of the software is in
+compliance with all laws, regulations, orders, or other restrictions of the
+U.S. Export Administration Regulations. Licensee agrees that neither it nor
+any of its subsidiaries will export/re-export any technical data, process,
+software, or service, directly or indirectly, to any country for which the
+United States government or any agency thereof requires an export license,
+other governmental approval, or letter of assurance, without first obtaining
+such license, approval or letter.
+
+***************************************************************************
+
+Submitting Contributions to ACPICA:
+Any contribution (including patches, bug fixes, improvements, or new features)
+submitted to the ACPICA project is governed by the “simplified” BSD license 
+reproduced below. Contributions to ACPICA are accepted under this license in 
+order to preserve ACPICA’s ability to license ACPICA under all three of the 
+licenses described above. The way to submit patches and/or bug reports or 
+fixes is by creating the appropriate ticket (Issue, PR) on our GitHub page.
+
+License for Contributions to ACPICA:
+Copyright © 2000 – 2025 Intel Corp.
+All rights reserved.
+
+Alternatively, you may choose to be licensed under the terms of the
+following license:
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions, and the following disclaimer,
+   without modification.
+2. Redistributions in binary form must reproduce at minimum a disclaimer
+   substantially similar to the "NO WARRANTY" disclaimer below
+   ("Disclaimer") and any redistribution must be conditioned upon
+   including a substantially similar Disclaimer requirement for further
+   binary redistribution.
+3. Neither the names of the above-listed copyright holders nor the names
+   of any contributors may be used to endorse or promote products derived
+   from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+Alternatively, you may choose to be licensed under the terms of the
+GNU General Public License ("GPL") version 2 as published by the Free
+Software Foundation.
+
+----------------------------------
+tests/misc/grammar.asl is under the following license:
+
+Some or all of this work - Copyright (c) 2006 - 2025, Intel Corp.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
+Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation
+and/or other materials provided with the distribution.
+Neither the name of Intel Corporation nor the names of its contributors
+may be used to endorse or promote products derived from this software
+without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.