Merge branch 'develop' into 'master'

Pipeline Cleanup & Expansion

See merge request spexeah/asuro!28

.drone.yml

@@ -1,66 +0,0 @@
-kind: pipeline
-type: docker
-name: build
-
-steps:
-  - name: build-image
-    image: plugins/docker
-    settings:
-      repo: t3hn3rd/asuro-build
-      tags: latest
-      dockerfile: Dockerfile
-      registry: docker.io
-      username:
-        from_secret: docker_username
-      password:
-        from_secret: docker_password
-
-  - name: compile
-    image: t3hn3rd/asuro-build:latest
-    depends_on:
-      - build-image
-    commands:
-      - git fetch --tags
-      - find . -type f -print0 | xargs -0 dos2unix
-      - chmod +x /drone/src/*.sh
-      - /drone/src/compile.sh
-      
-  - name: upload-iso-artifact
-    image: alpine/git
-    depends_on:
-      - compile
-    when:
-      branch:
-        - master
-    environment:
-      GITEA_TOKEN:
-        from_secret: gitea_token
-    commands:
-      - apk add --no-cache curl
-      - chmod +w Asuro.iso
-      - cp Asuro.iso "Asuro-$(git rev-parse --short HEAD).iso"
-      - echo "Uploading Asuro-$(git rev-parse --short HEAD).iso to Gitea Packages..."
-      - |
-         curl -X PUT "https://gitea.spexeah.com/api/packages/Spexeah/generic/asuro-iso/$(git rev-parse --short HEAD)/Asuro.iso" \
-         -H "Authorization: token $GITEA_TOKEN" --upload-file "Asuro-$(git rev-parse --short HEAD).iso"
-      - echo "Updating latest ISO reference..."
-      - |
-        curl -X DELETE https://gitea.spexeah.com/api/packages/Spexeah/generic/asuro-iso/latest/Asuro.iso \
-        -H "Authorization: token $GITEA_TOKEN" || echo "No previous latest version found."
-      - |
-        curl -X PUT https://gitea.spexeah.com/api/packages/Spexeah/generic/asuro-iso/latest/Asuro.iso \
-        -H "Authorization: token $GITEA_TOKEN" --upload-file "Asuro-$(git rev-parse --short HEAD).iso"
-
-  - name: msg status
-    image: appleboy/drone-discord
-    failure: ignore
-    depends_on:
-      - compile
-    when:
-      status: [success, failure, changed]
-    settings:
-      webhook_id:
-        from_secret: discord_webhook_id
-      webhook_token:
-        from_secret: discord_webhook_secret
-      message: "**Asuro Build**\n\n{{#success build.status}}✅ Build successful!\n\n{{else}}❌ Build failed!\n\n{{/success}}Repository: `{{repo.namespace}}/{{repo.name}}`\nBranch: `{{commit.branch}}`\nCommit: `{{commit.sha}}`\nAuthor: `{{commit.author}} <{{commit.email}}>`\n\nGitea Diff: [Link](<{{commit.link}}>)\nDrone Build: [Link](<{{build.link}}>)\n\nMessage: {{commit.message}}"

.gitattributes

@@ -1,8 +1 @@
-* text=auto eol=lf
+* text=auto eol=lf
-lvglh/** linguist-vendored
-lvgl/** linguist-vendored
-.vscode/* linguist-vendored
-lib/* linguist-generated
-release/* linguist-generated
-iso/* linguist-generated
-*.asm linguist-detectable

.gitignore

@@ -10,9 +10,5 @@
 /*.sh~
 /*.img
 src/include/asuro.pas
-localenv.json
+.vscode/launch.json
-/lvgl/
+.vscode
-dockerout.txt
-AGENTS.md
-*.log
-/doc/*.md

.gitlab-ci.yml

@@ -0,0 +1,73 @@
+stages:
+  - Compile Versions
+  - Compile Sources
+  - Link
+  - Generate Documentation
+  - Deploy
+
+cache:
+  - key: ${CI_COMMIT_REF_SLUG}
+    paths:
+      - lib/*.o
+      - bin/kernel.bin
+      - doc
+
+before_script:
+  - chmod +x *.sh
+
+versions:
+  stage: Compile Versions
+  script:
+    - ./compile_vergen.sh
+  artifacts:
+    paths:
+      - release/*.svg
+      - src/include/asuro.pas
+
+compile_sources:
+  stage: Compile Sources
+  script:
+    - rm -f lib/*.so
+    - ./compile_sources.sh
+  needs:
+    - versions
+
+link:
+  stage: Link
+  script:
+    - ./compile_stub.sh
+    - ./compile_link.sh
+  needs:
+    - versions
+    - compile_sources
+
+isogen:
+  stage: Deploy
+  script:
+    - ./compile_isogen.sh
+    - ./compile_sumgen.sh
+  artifacts:
+    paths:
+      - ./Asuro.iso
+      - ./release/checksum.svg
+  needs:
+    - link
+
+docgen:
+  stage: Generate Documentation
+  only:
+    - master
+    - develop
+  script:
+    - ./compile_sourcelist.sh
+    - ./compile_docs.sh
+    # Remove comments when we want to use gitlab pages.
+    #- cp doc public
+  allow_failure: true
+  artifacts:
+    paths:
+      - doc
+      #- public/*
+      #- ./sources.list
+  needs:
+    - versions

.mailmap

@@ -1,13 +0,0 @@
-# Map all Aaron identities to a single preferred identity
-Aaron Hance <[email protected]> aaron <aaron@6dbc8c32-bb84-406f-8558-d1cf31a0ab0c>
-Aaron Hance <[email protected]> aaronhance <[email protected]>
-Aaron Hance <[email protected]> aaron hance <[email protected]>
-Aaron Hance <[email protected]> Aaron <[email protected]>
-
-# Map all Kieron identities to a single preferred identity
-Kieron Morris <[email protected]> kieron <kieron@6dbc8c32-bb84-406f-8558-d1cf31a0ab0c>
-Kieron Morris <[email protected]> Kieron <[email protected]>
-Kieron Morris <[email protected]> t3hn3rd <[email protected]>
-
-# Map goose's multiple identities
-goose <goose@6dbc8c32-bb84-406f-8558-d1cf31a0ab0c> goose <[email protected]>

.vscode/launch.json

@@ -3,11 +3,18 @@
         {
             "name":"Run",
             "request": "launch",
-            "type": "PowerShell",
+            "type": "coreclr",
             "preLaunchTask": "Build",
-            "script": "${workspaceFolder}/virtualbox-wrapper.ps1",
+            "program": "VBoxSDL",
-            "args": ["-Command", "up"],
+            "args": [
+                "--comment", 
+                "Asuro", 
+                "--startvm", 
+                "7d395c96-891c-4139-b77d-9b6b144b0b93"
+            ],
             "cwd": "${workspaceFolder}",
+            "console": "internalConsole",
+            "internalConsoleOptions": "neverOpen"
         }
     ]
 }

.vscode/tasks.json

@@ -9,18 +9,14 @@
             "command": "docker-compose",
             "args": [
                 "run",
-                "builder",
+                "builder"
             ],
             "type": "shell",
             "problemMatcher": [],
             "group": {
                 "kind": "build",
                 "isDefault": true
-            },
+            }
-            "dependsOn": [
-                "Close VirtualBox",
-                "Clean"
-            ]
         },
         {
             "label": "Build (Builder)",
@@ -30,24 +26,6 @@
                 "builder"
             ],
             "type": "shell"
-        },
-        {
-            "label": "Clean",
-            "command": "docker-compose",
-            "args": [
-                "down",
-                "--remove-orphans"
-            ],
-            "type": "shell"
-        },
-        {
-            "label": "Close VirtualBox",
-            "command": "./virtualbox-wrapper.ps1",
-            "args": [
-                "-Command", 
-                "down"
-            ],
-            "type": "shell"
         }
     ]
 }

Dockerfile

@@ -5,18 +5,18 @@ VOLUME ["/code"]
 ENV DEBIAN_FRONTEND=noninteractive
 RUN dpkg --add-architecture i386
 RUN apt-get update && apt-get install -y \
-	curl dos2unix wget git make nasm binutils xorriso grub-pc-bin gcc gcc-multilib && \
+	curl dos2unix wget git make nasm binutils:i386 xorriso grub-pc-bin && \
 	apt-get clean my room
 
 SHELL ["/bin/bash", "-c"]
-ARG FPC_VERSION=3.2.2
+ARG FPC_VERSION=2.6.4
 RUN curl -sL https://sourceforge.net/projects/freepascal/files/Linux/$FPC_VERSION/fpc-$FPC_VERSION.i386-linux.tar/download | tar -xf - && \
 	pushd fpc-$FPC_VERSION.i386-linux && ./install.sh && popd && \
 	rm -rf fpc-$FPC_VERSION.i386-linux
 
 COPY compile.sh /compile.sh
 ADD https://raw.githubusercontent.com/fsaintjacques/semver-tool/master/src/semver /usr/bin/semver
-RUN chmod +x /usr/bin/semver
+RUN mkdir /code && chmod +x /usr/bin/semver
 WORKDIR /code
 RUN find . -type f -print0 | xargs -0 dos2unix
 ENTRYPOINT ["/bin/bash", "-c"]

compile.sh

@@ -7,7 +7,7 @@ echo "Asuro Compilation"
 echo " "
 
 #Compile Stub.asm
-rm -f lib/*
+rm lib/*
 
 runOrFail() {
 	local binary=$1
@@ -20,31 +20,26 @@ runOrFail() {
 	fi
 }
 
-declare -a run_steps=(
+runOrFail $(pwd)/compile_stub.sh "Failed to compile stub!"
-	"compile_stub.sh" "Failed to compile stub!"
-	"compile_vergen.sh" "Versions failed to compile"
-	"compile_lvgl.sh" "Failed to compile LVGL!"
-	"compile_sources.sh" "Failed to compile FPC Sources!"
-	"compile_link.sh" "Failed linking!"
-	"compile_isogen.sh" "Failed to create ISO!"
-)
 
-for ((i=0; i<${#run_steps[@]}; i+=2))
+#Generate .pas with versioning headers.
-do
+runOrFail $(pwd)/compile_vergen.sh "Versions failed to compile"
-	if [ "$ERRCOUNT" -eq "0" ]
+
-	then
+#Compile all .pas sources
-			script=$(pwd)/"${run_steps[$i]}"
+runOrFail $(pwd)/compile_sources.sh "Failed to compile FPC Sources!"
-			message="${run_steps[$i+1]}"
+
-			runOrFail "$script" "$message"
+#Link into a binary.
-	fi
+runOrFail $(pwd)/compile_link.sh "Failed linking!"
-done
+
+#Generate an ISO with GRUB as the Bootloader.
+runOrFail ./compile_isogen.sh "Failed to create ISO!"
 
 #Call generate final artifacts based on failure or success of the above.
 if [ "$ERRCOUNT" -ne "0" ]
 then
-	. ./compile_finish.sh "failed"
+	./compile_finish.sh "failed"
 else
-	. ./compile_finish.sh "success"
+	./compile_finish.sh "success"
 fi
 
 cd ..

compile_link.sh

@@ -14,9 +14,4 @@ done;
 objstring=lib/stub.o" "$objstring 
 echo "Object Files: "$objstring
 echo " "
-
+ld -m elf_i386 -s --gc-sections -Tlinker.script -o bin/kernel.bin $objstring
-# Find libgcc for i386 (needed by LVGL compiled with gcc)
-LIBGCC=$(gcc -m32 -print-libgcc-file-name)
-echo "libgcc: ${LIBGCC}"
-
-ld -m elf_i386 -s --gc-sections -Tlinker.script -o bin/kernel.bin $objstring --start-group lib/liblvgl.a ${LIBGCC} --end-group

compile_lvgl.sh

@@ -1,118 +0,0 @@
-#!/usr/bin/env bash
-# compile_lvgl.sh — Download LVGL v9.2 source and compile into lib/liblvgl.a
-# Clone & compile in /tmp (fast container-local fs).
-# Copy source + objects to /lvgl (host mount) for debugging.
-set -e
-
-LVGL_VERSION="v9.2.2"
-LVGL_REPO="https://github.com/lvgl/lvgl.git"
-LVGL_DIR="/tmp/lvgl"
-OBJ_DIR="/tmp/lvgl_obj"
-CONF_DIR="$(pwd)/lvglh"
-OUT_DIR="$(pwd)/lib"
-
-CC="gcc"
-CFLAGS="-m32 -march=i686 -ffreestanding \
-    -fno-builtin -fno-stack-protector -fno-pic -fno-pie \
-    -O2 -Wall -Wno-unused-function -Wno-unused-variable \
-    -I${CONF_DIR} \
-    -I${LVGL_DIR} \
-    -I${LVGL_DIR}/.. \
-    -DLV_CONF_INCLUDE_SIMPLE"
-
-echo " "
-echo "======================="
-echo " "
-echo "Compiling LVGL..."
-echo " "
-
-# Clone LVGL into /tmp (container-local)
-rm -rf "$LVGL_DIR"
-echo "Downloading LVGL ${LVGL_VERSION}..."
-git clone --depth 1 --branch "${LVGL_VERSION}" "${LVGL_REPO}" "${LVGL_DIR}" 2>&1
-echo "Download complete."
-
-# Gather all LVGL .c source files (core library only, no demos/examples)
-SOURCES=$(find "${LVGL_DIR}/src" -name '*.c' -not -path '*/test/*')
-TOTAL=$(echo "$SOURCES" | wc -l)
-echo "Found ${TOTAL} LVGL source files."
-
-# Compile each .c file to .o (container-local)
-rm -rf "$OBJ_DIR"
-mkdir -p "$OBJ_DIR"
-
-COUNT=0
-ERRORS=0
-for src in $SOURCES; do
-    COUNT=$((COUNT + 1))
-    rel="${src#${LVGL_DIR}/src/}"
-    obj_path="${OBJ_DIR}/${rel%.c}.o"
-    mkdir -p "$(dirname "$obj_path")"
-
-    if ! $CC $CFLAGS -c "$src" -o "$obj_path" 2>&1; then
-        echo "FAILED: $rel"
-        ERRORS=$((ERRORS + 1))
-    fi
-
-    if [ $((COUNT % 50)) -eq 0 ]; then
-        echo "  Compiled ${COUNT}/${TOTAL}..."
-    fi
-done
-
-echo "Compiled ${COUNT} files (${ERRORS} errors)."
-
-if [ "$ERRORS" -ne 0 ]; then
-    echo "LVGL compilation FAILED with ${ERRORS} errors."
-    exit 1
-fi
-
-# Archive into static library
-OBJECTS=$(find "$OBJ_DIR" -name '*.o')
-ar rcs "${OUT_DIR}/liblvgl.a" $OBJECTS
-echo "Created ${OUT_DIR}/liblvgl.a"
-
-# Compile custom LVGL extension files from lvglh/
-LVGLH_SOURCES=$(find "${CONF_DIR}" -name '*.c' 2>/dev/null || true)
-if [ -n "$LVGLH_SOURCES" ]; then
-    echo " "
-    echo "Compiling custom LVGL files from lvglh/..."
-    LVGLH_OBJ_DIR="/tmp/lvglh_obj"
-    rm -rf "$LVGLH_OBJ_DIR"
-    mkdir -p "$LVGLH_OBJ_DIR"
-    HCOUNT=0
-    HERRORS=0
-    for src in $LVGLH_SOURCES; do
-        HCOUNT=$((HCOUNT + 1))
-        rel="${src#${CONF_DIR}/}"
-        obj_path="${LVGLH_OBJ_DIR}/${rel%.c}.o"
-        mkdir -p "$(dirname "$obj_path")"
-        echo "  [lvglh] $rel"
-        if ! $CC $CFLAGS -c "$src" -o "$obj_path" 2>&1; then
-            echo "  FAILED: $rel"
-            HERRORS=$((HERRORS + 1))
-        fi
-    done
-    echo "Compiled ${HCOUNT} custom files (${HERRORS} errors)."
-    if [ "$HERRORS" -ne 0 ]; then
-        echo "Custom LVGL compilation FAILED."
-        exit 1
-    fi
-    # Append custom objects into the existing archive
-    HOBJECTS=$(find "$LVGLH_OBJ_DIR" -name '*.o')
-    ar rcs "${OUT_DIR}/liblvgl.a" $HOBJECTS
-    echo "Updated ${OUT_DIR}/liblvgl.a with custom objects."
-else
-    echo "No custom LVGL files in lvglh/."
-fi
-
-# Copy source + objects to /lvgl host mount for debugging
-echo "Copying LVGL source and objects to host mount..."
-mkdir /code/lvgl 2>/dev/null || true
-rm -rf /code/lvgl/* /code/lvgl/.[!.]* /code/lvgl/..?* 2>/dev/null || true
-cp -a "$LVGL_DIR/src" /code/lvgl/src
-cp -a "$OBJ_DIR" /code/lvgl/obj
-echo "Done."
-
-echo " "
-echo "LVGL compilation complete."
-echo " "

compile_sources.sh

@@ -4,4 +4,4 @@ echo "======================="
 echo " "
 echo "Compiling FPC Sources..."
 echo " "
-fpc -Aelf -gw -g -gl -n -v0ew -O3 -OpPENTIUM3 -Si -Sc -Sg -Xd -CX -XXs -CfSSE -CfSSE2 -Rintel -Pi386 -Tlinux -FElib/ -Fusrc/* -Fusrc/driver/* -Fusrc/driver/net/* -Fusrc/driver/bus/* -Fusrc/driver/bus/usb/* -Fusrc/driver/hid/* src/kernel.pas
+fpc -Aelf -gw -n -va -O3 -Op3 -Si -Sc -Sg -Xd -CX -XXs -CfSSE -CfSSE2 -Rintel -Pi386 -Tlinux -FElib/ -Fusrc/* -Fusrc/driver/* -Fusrc/driver/net/* src/kernel.pas

docker-compose.yml

@@ -1,3 +1,4 @@
+version: "3.9"
 services:
   builder:
     build: .

linker.script

@@ -2,7 +2,7 @@ ENTRY(loader)
 SECTIONS
 {
   . = 0xC0100000;
-  kernel_start = .;
+
   .text : AT(ADDR(.text) - 0xC0000000)
   {
     text = .; _text = .; __text = .;
@@ -33,15 +33,4 @@ SECTIONS
     . = ALIGN(4096);
   }
   end = .; _end = .; __end = .;
-  kernel_end = .;
-
-  /DISCARD/ : {
-    *(.init_array*)
-    *(.fini_array*)
-    *(.ctors)
-    *(.dtors)
-    *(.eh_frame*)
-    *(.gcc_except_table*)
-    *(.note.GNU-stack)
-  }
 }

readme.md

@@ -13,8 +13,8 @@ We welcome everyone to give building/breaking/fixing/shooting Asuro a go, feel f
     I don't think this needs an explaination.
 * [VSCode (Optional, but highly recommended)](https://code.visualstudio.com/)
     Visual Studio code is our IDE of choice, and we have a number of recommended plugins.
-    * [PowerShell Plugin by Microsoft](https://marketplace.visualstudio.com/items?itemName=ms-vscode.powershell)
+    * [C# Plugin by Microsoft](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp)
-        This plugin gives you the ability to use the 'PowerShell' task type, allowing the automatic launching of virtualbox with the resulting image generated during compilation of Asuro.
+        This plugin gives you the ability to use the 'coreclr' task type, allowing the automatic launching of virtualbox with the resulting image generated during compilation of Asuro.
 * [VirtualBox](https://www.virtualbox.org/)
     Virtualbox is our Virtualisation environment of choice, don't ask why, it just is.
 
@@ -27,15 +27,15 @@ We welcome everyone to give building/breaking/fixing/shooting Asuro a go, feel f
 3. Install Docker for Windows.
 4. Install Git for Windows.
 5. Install VSCode & the listed plugins.
-6. Install VirtualBox (v7+).
+6. Install VirtualBox.
 7. Clone this repository.
 8. Run the following command in the root of the repo to build the docker image:
     ```powershell
-    docker compose build builder
+    docker-compose build builder
     ```
 9. Run the following command to compile Asuro:
     ```powershell
-    docker compose run builder
+    docker-compose run builder
     ```
 10. Create a new virtual machine in Virtualbox and mount the `Asuro.iso` generated in step 9 as a boot image.
 11. Add the virtualbox installation directory to your `%PATH%` environment variable, usually:
@@ -50,29 +50,32 @@ We welcome everyone to give building/breaking/fixing/shooting Asuro a go, feel f
     ```xml
     <Machine uuid="{7d395c96-891c-4139-b77d-9b6b144b0b93}" name="Asuro" OSType="Linux" snapshotFolder="Snapshots" lastStateChange="2021-06-20T20:33:07Z">
     ```
-    Copy the uuid, in our case `7d395c96-891c-4139-b77d-9b6b144b0b93` & create a `localenv.json` file in the project root with the following content:
+    Copy the uuid, in our case `7d395c96-891c-4139-b77d-9b6b144b0b93` and replace the uuid found in `.vscode\launch.json` under `args`, so that it looks something like this:
     ```json
     {
-        "VirtualBox":{
+        "configurations": [
-            "MachineName":"<YOUR_UUID_OR_MACHINE_NAME>"
+            {
-        }
+                "name":"Run",
+                "request": "launch",
+                "type": "coreclr",
+                "preLaunchTask": "Build",
+                "program": "VBoxSDL",
+                "args": [
+                    "--comment", 
+                    "Asuro", 
+                    "--startvm", 
+                    "<YOUR UUID HERE>"
+                ],
+                "cwd": "${workspaceFolder}",
+                "console": "internalConsole",
+                "internalConsoleOptions": "neverOpen"
+            }
+        ]
     }
     ```
     This will allow VSCode to automatically launch VirtualBox once Asuro has been compiled.
-    
-    You can also enable the serial adapter "COM1" in mode "Raw File", give it a path, and provide this path in the `localenv.json` as follows:
-    ```json
-    {
-        "VirtualBox" : {
-            "MachineName": "<YOUR_UUID_OR_MACHINE_NAME>",
-            "LogLocation": "Fully\\Qualified\\Path\\To\\Your\\Log\\File"
-        }
-    }
-    ```
-    This will allow you to see the console output from Asuro in your host terminal.
 13. Open your project folder in VSCode, use CTRL+SHIFT+B to build & F5 to build + run in VBox.
 14. Congratulations! You can now play with Asuro!
 
-### Notes & Gotchas
+### Gotchas
-- The above process has been updated to be compatible with VirtualBox 7+, in which VBoxSDL was removed and vboxmanage should be used in its place. A small wrapper powershell script is used to achieve this.
+- It was noted that Windows builds above `20H2` seem to have issues installing WSL2. We may have to wait for a patch from Microsoft to fix this. Our devs are currently using build `20H2`.
-- It was noted that Windows builds above `20H2` seem to have issues installing WSL2. We may have to wait for a patch from Microsoft to fix this. Our devs are currently using build `20H2`.