Merge pull request #78 from dawidpawliczek4/macos-support

Add macOS support

Author: qbojj

.github/workflows/build.yml

@@ -23,7 +23,7 @@ jobs:
 
       - uses: lukka/get-cmake@latest
         with:
-          cmakeVersion: '~3.24.0'
+          cmakeVersion: '~3.29.0'
 
       - name: Install dependencies
         run: |
@@ -55,7 +55,7 @@ jobs:
 
       - uses: lukka/get-cmake@latest
         with:
-          cmakeVersion: '~3.24.0'
+          cmakeVersion: '~3.29.0'
 
       - name: Install dependencies
         run: |
@@ -88,7 +88,7 @@ jobs:
 
       - uses: lukka/get-cmake@latest
         with:
-          cmakeVersion: '~3.24.0'
+          cmakeVersion: '~3.29.0'
 
       - name: Install dependencies
         run: |
@@ -119,7 +119,7 @@ jobs:
 
       - uses: lukka/get-cmake@latest
         with:
-          cmakeVersion: '~3.24.0'
+          cmakeVersion: '~3.29.0'
 
       - name: Install dependencies
         run: |
@@ -141,3 +141,59 @@ jobs:
         with:
           name: build-artifacts-clang-lto
           path: build/
+
+  build-clang-macos:
+    runs-on: macos-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+
+      - uses: lukka/get-cmake@latest
+        with:
+          cmakeVersion: '~3.29.0'
+
+      - name: Install dependencies
+        run: |
+          brew install llvm lld cmake qemu dosfstools e2fsprogs mtools include-what-you-use
+
+      - name: Generate and build
+        uses: lukka/run-cmake@v10
+        with:
+          configurePreset: 'ci-clang'
+          buildPreset: 'ci-clang'
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: build-artifacts-clang-macos
+          path: build/
+
+  build-clang-macos-lto:
+    runs-on: macos-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+
+      - uses: lukka/get-cmake@latest
+        with:
+          cmakeVersion: '~3.29.0'
+
+      - name: Install dependencies
+        run: |
+          brew install llvm lld cmake qemu dosfstools e2fsprogs mtools include-what-you-use
+
+      - name: Generate and build
+        uses: lukka/run-cmake@v10
+        with:
+          configurePreset: 'ci-clang-lto'
+          buildPreset: 'ci-clang-lto'
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: build-artifacts-clang-macos-lto
+          path: build/

.gitignore

@@ -77,3 +77,9 @@ CMakeUserPresets.json
 docs/xml/
 # HTML of the sphinx page
 docs/build/
+
+# JetBrains IDEs files
+.idea/
+
+# macOS files
+.DS_Store

CMake/toolchains/riscv64-clang.cmake

@@ -1,11 +1,21 @@
-cmake_minimum_required(VERSION 3.13)
-
 if(RISCV_CLANG_TOOLCHAIN_INCLUDED)
   return()
 endif()
 set(RISCV_CLANG_TOOLCHAIN_INCLUDED TRUE)
 
 include(${CMAKE_CURRENT_LIST_DIR}/riscv64-common.cmake)
 
-set(CMAKE_ASM_COMPILER clang)
-set(CMAKE_C_COMPILER clang)
+if(CMAKE_HOST_SYSTEM_NAME STREQUAL "Darwin")
+    execute_process(
+        COMMAND brew --prefix llvm
+        OUTPUT_VARIABLE LLVM_PREFIX
+        OUTPUT_STRIP_TRAILING_WHITESPACE
+    )
+    set(CMAKE_PREFIX_PATH "${LLVM_PREFIX}")
+    set(CMAKE_C_USING_LINKER_LLD "-fuse-ld=lld")
+    set(CMAKE_ASM_USING_LINKER_LLD "-fuse-ld=lld")
+    set(CMAKE_LINKER_TYPE LLD)
+endif()
+
+find_program(CMAKE_C_COMPILER clang REQUIRED)
+find_program(CMAKE_ASM_COMPILER clang REQUIRED)

CMake/toolchains/riscv64-gcc.cmake

@@ -1,5 +1,3 @@
-cmake_minimum_required(VERSION 3.13)
-
 if(RISCV_GCC_TOOLCHAIN_INCLUDED)
   return()
 endif()

CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.24)
+cmake_minimum_required(VERSION 3.29)
 project(BigOS LANGUAGES C ASM)
 
 set_property(GLOBAL PROPERTY USE_FOLDERS ON)

CMakePresets.json

@@ -2,7 +2,7 @@
     "version": 5,
     "cmakeMinimumRequired": {
         "major": 3,
-        "minor": 24,
+        "minor": 29,
         "patch": 0
     },
     "include": [

docs/source/pages/developers/env/index.rst

@@ -6,3 +6,4 @@ If You are using a different operating system and a guide for it doesn't work or
 
 .. toctree::
    arch_linux
+   macos

docs/source/pages/developers/env/macos.rst

@@ -0,0 +1,19 @@
+macOS
+=====
+
+Before you begin, ensure you have the `Homebrew <https://brew.sh/>`_ package manager installed on your system.
+
+You will also need the Xcode Command Line Tools, which can be installed by running ``xcode-select --install`` in your terminal.
+
+To install all necessary packages, run:
+
+    .. code-block:: bash
+
+        brew install llvm lld cmake qemu dosfstools e2fsprogs mtools include-what-you-use
+
+To build the project, use one of the Clang presets, e.g.:
+
+    .. code-block:: bash
+
+        cmake --preset debug-clang
+        cmake --build build

src/example_dtree/startup.c

@@ -24,16 +24,6 @@ extern u8 __bss_end [[gnu::weak]][];
 
 extern int main(u32 hartid, const void* fdt);
 
-[[gnu::section(".init.enter"), gnu::naked]]
-void _enter(void) { // NOLINT
-	__asm__ volatile(".option push\n\t"
-	                 ".option norelax\n\t"
-	                 "la    gp, __global_pointer$\n\t"
-	                 ".option pop\n\t"
-	                 "la    sp, _sp\n\t"
-	                 "jal   zero, _start");
-}
-
 [[noreturn, gnu::noinline]]
 void _Exit([[maybe_unused]] int return_code) { // NOLINT
 	while (1) wfi();

src/example_dtree/startup_enter.S

@@ -0,0 +1,9 @@
+.section .init.enter, "ax"
+.global _enter
+_enter:
+    .option push
+    .option norelax
+    la    gp, __global_pointer$
+    .option pop
+    la    sp, _sp
+    jal   zero, _start