Merge branch 'release/v0.4.0'

.clang-format

@@ -11,23 +11,24 @@
 ---
 AccessModifierOffset: -4
 AlignAfterOpenBracket: Align
-AlignConsecutiveAssignments: false
+AlignConsecutiveAssignments: true
 AlignConsecutiveDeclarations: false
+AlignConsecutiveMacros: true
 #AlignEscapedNewlines: Left # Unknown to clang-format-4.0
-AlignOperands: true
-AlignTrailingComments: false
+AlignOperands: AlignAfterOperator
+AlignTrailingComments: true
 AllowAllParametersOfDeclarationOnNextLine: false
-AllowShortBlocksOnASingleLine: false
 AllowShortCaseLabelsOnASingleLine: false
 AllowShortFunctionsOnASingleLine: None
-AllowShortIfStatementsOnASingleLine: false
-AllowShortLoopsOnASingleLine: false
+AllowShortIfStatementsOnASingleLine: Never
+AllowShortLoopsOnASingleLine: true
+AllowShortBlocksOnASingleLine: Always
 AlwaysBreakAfterDefinitionReturnType: None
 AlwaysBreakAfterReturnType: None
 AlwaysBreakBeforeMultilineStrings: false
-AlwaysBreakTemplateDeclarations: false
+AlwaysBreakTemplateDeclarations: Yes
 BinPackArguments: true
-BinPackParameters: true
+BinPackParameters: false
 BraceWrapping:
   AfterClass: false
   AfterControlStatement: false
@@ -52,7 +53,7 @@ BreakConstructorInitializersBeforeComma: false
 #BreakConstructorInitializers: BeforeComma # Unknown to clang-format-4.0
 BreakAfterJavaFieldAnnotations: false
 BreakStringLiterals: false
-ColumnLimit: 80
+ColumnLimit: 0
 CommentPragmas: '^ IWYU pragma:'
 #CompactNamespaces: false # Unknown to clang-format-4.0
 ConstructorInitializerAllOnOneLineOrOnePerLine: false
@@ -463,7 +464,7 @@ SpacesInContainerLiterals: false
 SpacesInCStyleCastParentheses: false
 SpacesInParentheses: false
 SpacesInSquareBrackets: false
-Standard: Cpp03
+Standard: Auto
 TabWidth: 4
-UseTab: Always
+UseTab: Never
 ...

.gitignore

@@ -99,3 +99,6 @@ src/initscp/initfscp
 
 # OS generated files
 .DS_Store
+
+# OS filesystem files.
+files/bin/**

CMakeLists.txt

@@ -1,111 +1,158 @@
-# ------------------------------------------------------------------------------
+# =============================================================================
+# Set the minimum required version of cmake.
+cmake_minimum_required(VERSION 2.8)
 # Initialize the project.
 project(MentOs)
-cmake_minimum_required(VERSION 2.8.4)
 
-message(STATUS "Crosscompiling: ${CMAKE_CROSSCOMPILING}")
+# =============================================================================
+# Set the default build type to Debug.
+if(NOT CMAKE_BUILD_TYPE)
+  message(STATUS "Setting build type to 'Debug' as none was specified.")
+  set(CMAKE_BUILD_TYPE
+      "Debug"
+      CACHE STRING "Choose the type of build." FORCE)
+endif()
 
-# ------------------------------------------------------------------------------
+# =============================================================================
 # Add operating system specific option.
-message(STATUS "System name: ${CMAKE_HOST_SYSTEM_NAME}")
-message(STATUS "Kernel version: ${CMAKE_SYSTEM_VERSION}")
-if ((${CMAKE_HOST_SYSTEM_NAME} STREQUAL "Darwin") OR APPLE)
-    # Apple MacOSx
-elseif ((${CMAKE_HOST_SYSTEM_NAME} STREQUAL "Windows") OR WIN32)
-    # Windows
-    set(EMULATOR_FLAGS ${EMULATOR_FLAGS} -sdl)
+message(STATUS "Crosscompiling : ${CMAKE_CROSSCOMPILING}")
+message(STATUS "System name    : ${CMAKE_HOST_SYSTEM_NAME}")
+message(STATUS "Kernel version : ${CMAKE_SYSTEM_VERSION}")
+if((${CMAKE_HOST_SYSTEM_NAME} STREQUAL "Darwin") OR APPLE)
+  # Set the Apple MacOSx compilers.
+  if(CMAKE_VERSION VERSION_LESS "3.6.0")
+    include(CMakeForceCompiler)
+    cmake_force_c_compiler(i386-elf-gcc Clang)
+    cmake_force_cxx_compiler(i386-elf-g++ Clang)
+  else()
+    set(CMAKE_C_COMPILER i386-elf-gcc)
+    set(CMAKE_CXX_COMPILER i386-elf-g++)
+    set(CMAKE_AR i386-elf-ar)
+  endif()
+  # Speicfy the linker.
+  set(CMAKE_LINKER i386-elf-ld)
+  # Specify the linker flags.
+  set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -nostdlib")
+
+elseif((${CMAKE_HOST_SYSTEM_NAME} STREQUAL "Windows") OR WIN32)
+  # Windows set(EMULATOR_FLAGS ${EMULATOR_FLAGS} -sdl)
+
 else()
-    # Generic Unix System
-    find_program(LSB_RELEASE_EXEC lsb_release)
-    execute_process(COMMAND "${LSB_RELEASE_EXEC}" --short --release
-        OUTPUT_VARIABLE LSB_RELEASE_VERSION_SHORT
-        OUTPUT_STRIP_TRAILING_WHITESPACE)
-    message(STATUS "LSB version: ${LSB_RELEASE_VERSION_SHORT}")
-    if (${LSB_RELEASE_VERSION_SHORT} MATCHES "^18")
-        # Ubuntu 18
-        set(EMULATOR_FLAGS ${EMULATOR_FLAGS} -sdl)
-    elseif (${LSB_RELEASE_VERSION_SHORT} MATCHES "^19")
-        # Ubuntu 19
-        set(EMULATOR_FLAGS ${EMULATOR_FLAGS} -display gtk)
-    elseif (${LSB_RELEASE_VERSION_SHORT} MATCHES "^20")
-        # Ubuntu 20
-        set(EMULATOR_FLAGS ${EMULATOR_FLAGS} -display gtk)
-    else()
-        set(EMULATOR_FLAGS ${EMULATOR_FLAGS} -sdl)
-    endif()
+  # Generic Unix System
+  find_program(LSB_RELEASE_EXEC lsb_release)
+  execute_process(
+    COMMAND "${LSB_RELEASE_EXEC}" --short --release
+    OUTPUT_VARIABLE LSB_RELEASE_VERSION_SHORT
+    OUTPUT_STRIP_TRAILING_WHITESPACE)
+  message(STATUS "LSB version    : ${LSB_RELEASE_VERSION_SHORT}")
+  if(${LSB_RELEASE_VERSION_SHORT} MATCHES "^18")
+    # Ubuntu 18 set(EMULATOR_FLAGS ${EMULATOR_FLAGS} -sdl)
+  elseif(${LSB_RELEASE_VERSION_SHORT} MATCHES "^19")
+    # Ubuntu 19
+    set(EMULATOR_FLAGS ${EMULATOR_FLAGS} -display gtk)
+  elseif(${LSB_RELEASE_VERSION_SHORT} MATCHES "^20")
+    # Ubuntu 20
+    set(EMULATOR_FLAGS ${EMULATOR_FLAGS} -display gtk)
+  else()
+    # set(EMULATOR_FLAGS ${EMULATOR_FLAGS} -sdl)
+  endif()
 endif()
 
-# ------------------------------------------------------------------------------
+# =============================================================================
 # Add the debugging option.
-set(DEBUGGING_TYPE "DEBUG_STDIO" CACHE STRING
-    "Chose the type of debugging: DEBUG_STDIO DEBUG_LOG")
-set_property(
-    CACHE DEBUGGING_TYPE PROPERTY STRINGS
-    DEBUG_STDIO
-    DEBUG_LOG)
-if ("${DEBUGGING_TYPE}" STREQUAL "DEBUG_STDIO" OR
-    "${DEBUGGING_TYPE}" STREQUAL "DEBUG_LOG")
-    set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -D${DEBUGGING_TYPE}")
-    message(STATUS "Setting debugging type to ${DEBUGGING_TYPE}.")
-else ()
-    message(FATAL_ERROR "Debugging type ${DEBUGGING_TYPE} is not valid.")
-endif ()
+set(DEBUGGING_TYPE
+    "DEBUG_STDIO"
+    CACHE STRING "Chose the type of debugging: DEBUG_STDIO DEBUG_LOG")
+set_property(CACHE DEBUGGING_TYPE PROPERTY STRINGS DEBUG_STDIO DEBUG_LOG)
+if("${DEBUGGING_TYPE}" STREQUAL "DEBUG_STDIO" OR "${DEBUGGING_TYPE}" STREQUAL "DEBUG_LOG")
+  set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -D${DEBUGGING_TYPE}")
+  message(STATUS "Setting debugging type to ${DEBUGGING_TYPE}.")
+else()
+  message(FATAL_ERROR "Debugging type ${DEBUGGING_TYPE} is not valid.")
+endif()
 
-# ------------------------------------------------------------------------------
+# =============================================================================
 # Add the sub-directories.
+add_subdirectory(programs)
+add_subdirectory(programs/tests)
 add_subdirectory(mentos)
 add_subdirectory(initscp)
+add_subdirectory(libc)
+add_subdirectory(doc)
+
+# =============================================================================
+# Target to generate the initrd filesystem.
+add_custom_target(
+  initrd
+  COMMAND echo "---------------------------------------------"
+  COMMAND echo "Initializing 'initrd'..."
+  COMMAND echo "---------------------------------------------"
+  COMMAND initfscp -s ${CMAKE_SOURCE_DIR}/files -t ${CMAKE_BINARY_DIR}/initrd -m /dev
+  COMMAND echo "---------------------------------------------"
+  COMMAND echo "Done!"
+  COMMAND echo "---------------------------------------------"
+  DEPENDS initfscp
+  DEPENDS all_programs all_tests)
+
+# =============================================================================
+# Update GDB symbol file.
+add_custom_target(
+  gdb_file
+  COMMAND echo "symbol-file ${CMAKE_BINARY_DIR}/mentos/kernel-bootloader.bin" >> ${CMAKE_BINARY_DIR}/.gdbinit
+  COMMAND echo "exec-file   ${CMAKE_BINARY_DIR}/mentos/kernel-bootloader.bin" >> ${CMAKE_BINARY_DIR}/.gdbinit
+  COMMAND bash ${CMAKE_SOURCE_DIR}/scripts/get_text_address.sh ${CMAKE_BINARY_DIR}/mentos/kernel.bin > ${CMAKE_BINARY_DIR}/.gdbinit
+  COMMAND bash ${CMAKE_SOURCE_DIR}/scripts/get_text_address.sh ${CMAKE_BINARY_DIR}/mentos/kernel-bootloader.bin >> ${CMAKE_BINARY_DIR}/.gdbinit
+  COMMAND bash ${CMAKE_SOURCE_DIR}/scripts/get_text_address.sh ${CMAKE_BINARY_DIR}/programs/tests/test_* >> ${CMAKE_BINARY_DIR}/.gdbinit
+  COMMAND bash ${CMAKE_SOURCE_DIR}/scripts/get_text_address.sh ${CMAKE_BINARY_DIR}/programs/prog_* >> ${CMAKE_BINARY_DIR}/.gdbinit
+  COMMAND echo "break boot.c: boot_main" >> ${CMAKE_BINARY_DIR}/.gdbinit
+  COMMAND echo "break kernel.c: kmain" >> ${CMAKE_BINARY_DIR}/.gdbinit
+  COMMAND echo "target remote localhost:1234" >> ${CMAKE_BINARY_DIR}/.gdbinit
+  DEPENDS ${PROJECT_NAME}_bootloader
+  DEPENDS all_programs all_tests
+  DEPENDS libc)
 
-# ------------------------------------------------------------------------------
-# Generate the initrd filesystem.
+# =============================================================================
+# Update GDB symbol file.
 add_custom_target(
-    initfs
-    COMMAND echo "---------------------------------------------"
-    COMMAND echo "Initializing 'initfs'..."
-    COMMAND echo "---------------------------------------------"
-    COMMAND ./initscp/initfscp -s ${CMAKE_SOURCE_DIR}/files -t ${CMAKE_BINARY_DIR}/initfs -m /dev
-    COMMAND echo "---------------------------------------------"
-    COMMAND echo "Done!"
-    COMMAND echo "---------------------------------------------"
-    DEPENDS initfscp
-)
+  gdb_file_clion_embedded
+  COMMAND echo "symbol-file ${CMAKE_BINARY_DIR}/mentos/kernel-bootloader.bin" >> ${CMAKE_BINARY_DIR}/.gdbinit
+  COMMAND echo "exec-file   ${CMAKE_BINARY_DIR}/mentos/kernel-bootloader.bin" >> ${CMAKE_BINARY_DIR}/.gdbinit
+  COMMAND bash ${CMAKE_SOURCE_DIR}/scripts/get_text_address.sh ${CMAKE_BINARY_DIR}/mentos/kernel.bin > ${CMAKE_BINARY_DIR}/.gdbinit
+  COMMAND bash ${CMAKE_SOURCE_DIR}/scripts/get_text_address.sh ${CMAKE_BINARY_DIR}/mentos/kernel-bootloader.bin >> ${CMAKE_BINARY_DIR}/.gdbinit
+  COMMAND bash ${CMAKE_SOURCE_DIR}/scripts/get_text_address.sh ${CMAKE_BINARY_DIR}/programs/prog_* >> ${CMAKE_BINARY_DIR}/.gdbinit
+  DEPENDS ${PROJECT_NAME}_bootloader
+  DEPENDS all_programs all_tests
+  DEPENDS libc)
 
-# ------------------------------------------------------------------------------
+# =============================================================================
 # Set memory size.
-SET(MEMORY_SIZE 1096M)
+set(MEMORY_SIZE 1096M)
 
-# ------------------------------------------------------------------------------
+# =============================================================================
 # Builds the code and runs qemu with the built Os.
-SET(EMULATOR qemu-system-i386)
-if (${DEBUGGING_TYPE} STREQUAL DEBUG_LOG)
-    SET(EMULATOR_FLAGS ${EMULATOR_FLAGS} -serial file:serial.log)
-elseif (${DEBUGGING_TYPE} STREQUAL DEBUG_STDIO)
-    SET(EMULATOR_FLAGS ${EMULATOR_FLAGS} -serial stdio)
-endif ()
-SET(EMULATOR_FLAGS ${EMULATOR_FLAGS} -vga std)
-SET(EMULATOR_FLAGS ${EMULATOR_FLAGS} -k it)
-SET(EMULATOR_FLAGS ${EMULATOR_FLAGS} -m ${MEMORY_SIZE})
-SET(EMULATOR_KERNEL -kernel mentos/kernel.bin)
-SET(EMULATOR_FS -initrd initfs)
+set(EMULATOR qemu-system-i386)
+if(${DEBUGGING_TYPE} STREQUAL DEBUG_LOG)
+  set(EMULATOR_FLAGS ${EMULATOR_FLAGS} -serial file:serial.log)
+elseif(${DEBUGGING_TYPE} STREQUAL DEBUG_STDIO)
+  set(EMULATOR_FLAGS ${EMULATOR_FLAGS} -serial stdio)
+endif(${DEBUGGING_TYPE} STREQUAL DEBUG_LOG)
+set(EMULATOR_FLAGS ${EMULATOR_FLAGS} -vga std)
+set(EMULATOR_FLAGS ${EMULATOR_FLAGS} -m ${MEMORY_SIZE})
+set(EMULATOR_KERNEL -kernel mentos/kernel-bootloader.bin)
+set(EMULATOR_FS -initrd initrd)
 
 add_custom_target(
-    qemu
-    COMMAND ${EMULATOR} ${EMULATOR_FLAGS} ${EMULATOR_KERNEL} ${EMULATOR_FS}
-    DEPENDS MentOs
-    DEPENDS initfs
-)
+  qemu
+  COMMAND ${EMULATOR} ${EMULATOR_FLAGS} ${EMULATOR_KERNEL} ${EMULATOR_FS}
+  DEPENDS kernel-bootloader.bin initrd all_programs all_tests libc)
 
-# ------------------------------------------------------------------------------
+# =============================================================================
 # Builds the code and runs qemu with the built Os.
-SET(EMULATOR_FLAGS_GDB ${EMULATOR_FLAGS} -s -S)
-SET(GDB_PROG cgdb)
-SET(GDB_ARGS -x ${CMAKE_SOURCE_DIR}/.gdb.debug)
+set(EMULATOR_FLAGS_GDB ${EMULATOR_FLAGS} -s -S)
 
 add_custom_target(
-    qemu-gdb
-    COMMAND xterm -geometry 160x30-0-0 -e ${EMULATOR} ${EMULATOR_FLAGS_GDB} ${EMULATOR_KERNEL} ${EMULATOR_FS} &
-    COMMAND xterm -geometry 160x30-0+0 -e ${GDB_PROG} ${GDB_ARGS} &
-    DEPENDS MentOs
-    DEPENDS initfs
-)
+  qemu-gdb
+  COMMAND ${EMULATOR} ${EMULATOR_FLAGS_GDB} ${EMULATOR_KERNEL} ${EMULATOR_FS} &
+  DEPENDS gdb_file kernel-bootloader.bin initrd)
 
+add_custom_target(all-execs-clion-embedded DEPENDS gdb_file_clion_embedded kernel-bootloader.bin initrd)

CODING_STYLE.md

@@ -1,7 +1,4 @@
-Code Styles for this project
-============================
-
-
+# Coding Style
 If you'd like to contribute you are welcome, thus refer to the following coding
 styles please: