Clean up

.github/workflows/max-os.yml

@@ -15,7 +15,7 @@ on:
 jobs:
   build-os:
     # The type of runner that the job will run on
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
 
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
@@ -32,7 +32,7 @@ jobs:
         uses: actions/cache@v3
         with:
           path: toolchain/cross_compiler
-          key: ${{ runner.os }}-cross_compiler_2
+          key: ${{ runner.os }}-cross_compiler_3
 
       - name: Build toolchain
         if: steps.cache-toolchain.outputs.cache-hit != 'true'
@@ -42,9 +42,9 @@ jobs:
 
       - name: Build MaxOS (Release)
         run: |
-          cd toolchain
+          cd toolchain/post_process
           ./version.sh --force
-          cd ../
+          cd ../../
           mkdir -p cmake-build
           cd cmake-build
           cmake .. -DCMAKE_TOOLCHAIN_FILE=toolchain/CMakeToolchain.txt

.gitignore

@@ -1,7 +1,5 @@
 *.o
 *.elf
-*.o
-*.elf
 kernel.elf
 .idea/.name
 .idea/max-os.iml
@@ -58,6 +56,5 @@ cmake-build-debug/Testing/Temporary/LastTest.log
 MaxOS.bin
 MaxOS.iso
 README.md
-README.md
 MaxOS.img
 /.hushlogin

CMakeLists.txt

@@ -7,7 +7,7 @@ project(MaxOS C CXX ASM)
 # Logs the compiler commands
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
-# Dont enable runtime type information
+# don't enable runtime type information
 set(CMAKE_SKIP_RPATH TRUE)
 
 # Set the standard to C++20
@@ -20,20 +20,26 @@ INCLUDE_DIRECTORIES(libraries/)
 LINK_DIRECTORIES(${TOOLCHAIN_ROOT_DIR}/lib/gcc/${TOOLCHAIN_PLATFORM}/${GCC_VER}/)
 LINK_DIRECTORIES(${TOOLCHAIN_ROOT_DIR}/${TOOLCHAIN_PLATFORM}/lib/)
 
+# DEBUG / PROD
+IF(NOT CMAKE_BUILD_TYPE)
+    set(CMAKE_BUILD_TYPE Debug CACHE STRING "Choose the type of build." FORCE)
+ENDIF()
+
+## Set flags based on build type
+IF(CMAKE_BUILD_TYPE STREQUAL "Debug")
+    add_definitions(-DTARGET_DEBUG)
+ENDIF()
+
 # Look to build in these directories
 ADD_SUBDIRECTORY(kernel)
 #ADD_SUBDIRECTORY(libraries)
 ADD_SUBDIRECTORY(programs)
 #ADD_SUBDIRECTORY(ports)
 
-ADD_CUSTOM_TARGET(optional_apps
-        # Build the optional apps
-#        COMMENT "Building optional apps"
-#        COMMAND ${CMAKE_COMMAND} -E env "SOURCE_DIR=${CMAKE_SOURCE_DIR}" ${CMAKE_SOURCE_DIR}/toolchain/build_optional_apps.sh
-#        USES_TERMINAL
-)
-
 ADD_CUSTOM_TARGET(image
+        # Everything needs to be installed (compiled) before we can create the disk image
+        # DEPENDS install (TODO Rewrite so auto installs)
+
         # Create the disk image
         COMMENT "Creating disk image"
         COMMAND ${CMAKE_COMMAND} -E env "SOURCE_DIR=${CMAKE_SOURCE_DIR}" ${CMAKE_SOURCE_DIR}/toolchain/create_disk_img.sh
@@ -51,6 +57,9 @@ ADD_CUSTOM_TARGET(image
 )
 
 ADD_CUSTOM_TARGET(run
+        # Requires a bootable image to be created
+        DEPENDS image
+
         # Run qemu
         COMMENT "Running qemu"
         COMMAND ${CMAKE_COMMAND} -E env "SOURCE_DIR=${CMAKE_SOURCE_DIR}" ${CMAKE_SOURCE_DIR}/toolchain/run_qemu.sh
@@ -59,21 +68,18 @@ ADD_CUSTOM_TARGET(run
         USES_TERMINAL
 )
 
-ADD_CUSTOM_TARGET(debug
-        # Run qemu
-        COMMENT "Running qemu"
-        COMMAND ${CMAKE_COMMAND} -E env "SOURCE_DIR=${CMAKE_SOURCE_DIR}" ${CMAKE_SOURCE_DIR}/toolchain/run_qemu.sh --debug
+# Run qemu with debug if the debug flag is set
+IF(CMAKE_BUILD_TYPE STREQUAL "Debug")
+    ADD_CUSTOM_TARGET(gdb
 
-        # Ensure it runs in the terminal
-        USES_TERMINAL
-)
+        # Requires a bootable image to be created
+        DEPENDS image
 
-ADD_CUSTOM_TARGET(gdb
-        # Run GDB
-        COMMENT "Running GDB"
-        COMMAND ${CMAKE_COMMAND} -E env "SOURCE_DIR=${CMAKE_SOURCE_DIR}" ${CMAKE_SOURCE_DIR}/toolchain/run_gdb.sh
-        BYPRODUCTS ${CMAKE_SOURCE_DIR}/MaxOS.sym
+        # Run qemu
+        COMMENT "Running qemu with gdb"
+        COMMAND ${CMAKE_COMMAND} -E env "SOURCE_DIR=${CMAKE_SOURCE_DIR}" ${CMAKE_SOURCE_DIR}/toolchain/run_qemu.sh --debug
 
         # Ensure it runs in the terminal
         USES_TERMINAL
-)
+    )
+ENDIF()

README.md

@@ -1,12 +1,5 @@
 <!-- Improved compatibility of back to top link: See: https://github.com/maxtyson123/MaxOS/pull/73 -->
 <a name="readme-top"></a>
-<!--
-*** Thanks for checking out the Best-README-Template. If you have a suggestion
-*** that would make this better, please fork the repo and create a pull request
-*** or simply open an issue with the tag "enhancement".
-*** Don't forget to give the project a star!
-*** Thanks again! Now go create something AMAZING! :D
--->
 
 
 
@@ -84,16 +77,18 @@ Max OS is a hobby operating system developed for the 64bit platform using C++ an
 
 Max OS supports device drivers, memory management, multitasking, a GUI, and more. The project is being developed with the goal of being able to run on real hardware, however, it is currently only able to run on a virtual machine.
 
-This GitHub repository contains the source code for the operating system, as well as the build scripts required to build the operating system from source. The repository also contains the latest built kernel, which can be downloaded from the workflow artifacts. To ensure a cleaner git history, each feature/change is done in a separate branch and then merged into the main branch once working. To see the history of each feature press on the pull request number. If you are intrested in the active developement find the latest branch <a href="https://github.com/maxtyson123/MaxOS/branches">Here</a>.
+This GitHub repository contains the source code for the operating system, as well as the build scripts required to build the operating system from source. The repository also contains the latest built kernel, which can be downloaded from the workflow artifacts. To ensure a cleaner git history, each feature/change is done in a separate branch and then merged into the main branch once working. To see the history of each feature press on the pull request number. If you are intrested in the active development find the latest branch <a href="https://github.com/maxtyson123/MaxOS/branches">Here</a>.
 
+
+_Note:_ Ignore all the networking code & drivers, they are very outdated, badly written and will soon be ported over to userspace and rewritten.
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 <!-- GETTING STARTED -->
 ## Getting Started
 
 This is how to build the Max OS operating system from source. (Alternatively, you can download the latest built kernel from the workflow artifacts)
 
-Currently Max OS can only be built on a linux machine, but does support WSL. In the future I do plan to port the build system to Mac. 
+Currently, Max OS can only be built on a linux-like machine, but does support WSL & Mac. If you are using WSL, make sure the repo is on the WSL machine and not the Windows machine. 
 
 ### Prerequisites
 
@@ -107,17 +102,29 @@ This is the list of required packages to build the operating system from source.
 * texinfo
 * libisl-dev
 * cmake
+* telnet
+
+Linux:
   ```sh
   sudo apt update
-  sudo apt install -y build-essential bison flex libgmp3-dev libmpc-dev libmpfr-dev texinfo libisl-dev cmake
+  sudo apt install -y build-essential bison flex libgmp3-dev libmpc-dev libmpfr-dev texinfo libisl-dev cmake telnet
   ```
 
+Mac:
+```sh
+  # Install Devtools (via Xcode or some other method)
+  # Install Homebrew
+  brew install coreutils bison gmp libmpc mpfr texinfo gcc@13 cmake nasm telnet
+```
+
+
 Note: If you want to run the operating system in a virtual machine, you will need to install QEMU. (If in WSL the script will look for a Windows installation of QEMU)
+
 ### Installation
 
 - Upon first build follow steps 1-5
 - If you change the file structure (e.g. add a new file) follow steps 3-5
-- If you running on a new boot (eg you rebooted your computer) follow steps 4-5
+- If you're running on a new boot (eg you rebooted your computer) follow steps 4-5
 - If you only change a file follow step 5
 
 1. Clone the repo
@@ -126,7 +133,7 @@ Note: If you want to run the operating system in a virtual machine, you will nee
    cd MaxOS
    ```
 
-2. Create the cross compiler (This will take a while)
+2. Create the cross-compiler (This will take a while)
    ```sh
    cd toolchain
    ./make_cross_compiler.sh
@@ -138,8 +145,8 @@ Note: If you want to run the operating system in a virtual machine, you will nee
    # If you edit the CMakeLists.txt file you will need to delete the build directory contents (not the folder) and regenerate the makefiles
    cd cmake-build
 
-   # Add -DDEBUG=ON to enable debug mode
-   cmake .. -DCMAKE_TOOLCHAIN_FILE=toolchain/CMakeToolchain.txt
+   # Change to -DCMAKE_BUILD_TYPE=Debug to enable debug mode
+   cmake .. -DCMAKE_TOOLCHAIN_FILE=toolchain/CMakeToolchain.txt -DCMAKE_BUILD_TYPE=Release 
    ```
 
 4. Clean the build directory
@@ -149,8 +156,26 @@ Note: If you want to run the operating system in a virtual machine, you will nee
 
 5. Build the operating system & Run it in QEMU
    ```sh
-   make install image run
+   # Replace 'run' with 'gdb' on a debug build to make the kernel wait for gdb to attach on port 1234  
+   make run
    ```
+
+6. (OPTIONAL) I use CLion IDE for development, if  you want to use it too follow these steps for IDE features:
+    - Cmake
+      - Open CLion
+      - Select "Open or Import"
+      - Select the `CMakeLists.txt` file in the root directory of the project
+      - Make sure the profile is set to these settings:
+        - CMake: `cmake .. -DCMAKE_TOOLCHAIN_FILE=toolchain/CMakeToolchain.txt`
+        - Directory: `cmake-[release/debug]`
+      - Click "OK"
+      - Wait for CLion to index the project (this may take a while)
+    - Code Style
+      - Go to Settings -> Editor -> Code Styles -> (cog) -> Import Scheme -> C/C++ -> Import Scheme -> From `docs/Styles/ClionCodeStyleSettings.xml`
+    - Debugger
+      - Run a gdb build with `make gdb`
+      - Create new configuration: Edit Configurations -> Add -> Remote Debugger
+      - 
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
@@ -162,10 +187,10 @@ Note: If you want to run the operating system in a virtual machine, you will nee
 No user usage so far (userland will be added in the future)
 
 #### Boot Console
-![Boot Console](docs/Screenshots/Boot/Console20%v2.png)
+![Boot Console](docs/Screenshots/Boot/Console_v3.png)
 
 #### GUI
-![GUI](docs/Screenshots/GUI/Windows20%VESA.png)
+![GUI](docs/Screenshots/GUI/Windows_VESA.png)
 
 <!-- ROADMAP -->
 ## Roadmap
@@ -196,13 +221,15 @@ No user usage so far (userland will be added in the future)
 - [ ] DOOM Port
 - [ ] UserSpace Drivers
 - [ ] Userspace Networking
-- [ ] Auto Updater & Image Builder
+- [ ] Connect to Clion with SMB for files and GDB for debugging in userspace
+- [ ] Auto Updater & Image Builder (ISO Release)
 - [ ] Store
 - [ ] User Switching
 - [ ] Real Hardware Support
 - [ ] Pretty GUI
 - [ ] Port NeoVim, Wakatime & Some hot reloader
 - [ ] Create port of my 2048
+- [ ] Own LibC
 - [ ] Compatibility Layer(s)
 
 See the [open issues](https://github.com/maxtyson123/MaxOS/issues) for a full list of proposed features (and known issues).

docs/CODE_OF_CONDUCT.md

@@ -33,7 +33,7 @@ The following behaviors are considered harassment and are unacceptable within ou
 
  * Violence, threats of violence or violent language directed against another person.
  * Sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory jokes and language.
- * Posting or displaying sexually explicit or violent material.
+ * Posting or displaying sexually or violent material.
  * Posting or threatening to post other people's personally identifying information ("doxing").
  * Personal insults, particularly those related to gender, sexual orientation, race, religion, or disability.
  * Inappropriate photography or recording.

docs/CONTRIBUTING.md

@@ -11,7 +11,7 @@ We love your input! We want to make contributing to this project as easy and tra
 We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
 
 ## Code Standard
-To keep the code understanble please make sure it is formatted and reable. Please look in the coding style [docs](Styles/Coding%20Style.md) for more information.
+To keep the code understandable please make sure it is formatted and reable. Please look in the coding style [docs](Styles/Coding%20Style.md) for more information.
 
 ## We Use [GitHub Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
 Pull requests are the best way to propose changes to the codebase (we use [GitHub Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:

docs/Goals.md

@@ -30,7 +30,7 @@
 - Chess
 - 2048
 - Conways game of life
-- Solitare
+- Solitaire
 - Minesweeper
 - Snake
 - Paint
@@ -59,6 +59,6 @@
 
 # Other
 - Clipboard
-- Privelges (Rings, read/write)
+- Privileges (Rings, read/write)
 - Apps installer
 - App store

docs/Idle.md

@@ -0,0 +1,9 @@
+## How the idle proc works:
+ I was debugging along and released that on the first ever schedule it will
+ set current_thread->execution_state = cpu_state; where it is assumed cpu_state
+ is the current thread state (ie what we have just been scheduling) and
+ thus saves it in that thread. However, as the first thread has not had a
+ chance to be scheduled yet, the current state is not the expected first
+ thread's state and instead is the cpu state of the kernel.
+ Now I could either fix that or leave it in as a cool way of never fully
+ leaving kernelMain and  also having a idle_proc