Feat/init export (#1)

Initial commit of DRAMUtils, with streamlined MemSpecs for usage in DRAMPower and DRAMSys

.clang-format

@@ -0,0 +1,11 @@
+AccessModifierOffset: '-4'
+AllowShortFunctionsOnASingleLine: InlineOnly
+AllowShortIfStatementsOnASingleLine: Never
+BinPackArguments: 'false'
+BinPackParameters: 'false'
+BreakBeforeBraces: Allman
+BreakConstructorInitializers: AfterColon
+ColumnLimit: '100'
+IndentWidth: '4'
+PackConstructorInitializers: CurrentLine
+PointerAlignment: Left

.clang-tidy

@@ -0,0 +1,18 @@
+Checks: > 
+  clang-diagnostic-*,
+  clang-analyzer-*,
+  modernize-*,
+  bugprone-*,
+  concurrency-*,
+  cppcoreguidelines-*,
+  performance-*,
+  portability-*,
+  readability-*,
+  -modernize-use-trailing-return-type,
+  -readability-braces-around-statements,
+  -readability-identifier-length,
+  -readability-function-cognitive-complexity
+WarningsAsErrors: ''
+HeaderFilterRegex: ''
+AnalyzeTemporaryDtors: false
+FormatStyle: file

.github/workflows/CI.yml

@@ -0,0 +1,84 @@
+name: Continuous Integration
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+env:
+  # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
+  BUILD_TYPE: Release
+
+jobs:
+  # Compile and test project on Linux based builds
+  build-gcc:
+    # The CMake configure and build commands are platform agnostic and should work equally well on Windows or Mac.
+    # You can convert this to a matrix build if you need cross-platform coverage.
+    # See: https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/managing-complex-workflows#using-a-build-matrix
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Configure CMake
+      # Configure CMake in a 'build' subdirectory. `CMAKE_BUILD_TYPE` is only required if you are using a single-configuration generator such as make.
+      # See https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html?highlight=cmake_build_type
+      run: cmake --preset ci-common
+
+    - name: Build
+      run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}} -j4
+
+    - name: Test
+      working-directory: ${{github.workspace}}/build
+      # Execute tests defined by the CMake configuration.  
+      # See https://cmake.org/cmake/help/latest/manual/ctest.1.html for more detail
+      run: ctest -C ${{env.BUILD_TYPE}}
+
+  # Compile and test project on Linux based builds using clang
+  build-clang:
+    # The CMake configure and build commands are platform agnostic and should work equally well on Windows or Mac.
+    # You can convert this to a matrix build if you need cross-platform coverage.
+    # See: https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/managing-complex-workflows#using-a-build-matrix
+    runs-on: ubuntu-latest
+    env:
+      CC: clang
+      CXX: clang++
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Configure CMake
+      # Configure CMake in a 'build' subdirectory. `CMAKE_BUILD_TYPE` is only required if you are using a single-configuration generator such as make.
+      # See https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html?highlight=cmake_build_type
+      run: cmake --preset ci-common
+
+    - name: Build
+      run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}} -j4
+
+    - name: Test
+      working-directory: ${{github.workspace}}/build
+      # Execute tests defined by the CMake configuration.  
+      # See https://cmake.org/cmake/help/latest/manual/ctest.1.html for more detail
+      run: ctest -C ${{env.BUILD_TYPE}}
+
+  # Compile and test project on Windows based builds
+  build-msvc:
+    runs-on: windows-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Configure CMake
+      # Configure CMake in a 'build' subdirectory.
+      run: cmake --preset ci-msvc
+
+    - name: Build
+      run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}} -j4
+
+    - name: Test
+      working-directory: ${{github.workspace}}/build
+      # Execute tests defined by the CMake configuration.  
+      # See https://cmake.org/cmake/help/latest/manual/ctest.1.html for more detail
+      run: ctest -C ${{env.BUILD_TYPE}}
+

.gitignore

@@ -0,0 +1,28 @@
+/debug
+/release
+/dram/debug
+/dram/release
+/dram/build
+*.user
+*.tdb
+!tests/tests_regression/*/expected/*.tdb
+*.tdb-journal
+*.out
+/build-simulation
+/release-simulation
+*.*~
+build*/
+._.DS_Store
+.DS_Store
+*.swp
+*.swo
+cscope*
+*.pyc
+*.autosave
+*__pycache__*
+.vscode
+cmake-build*
+.idea
+.cache
+.env
+scripts/

CMakeLists.txt

@@ -0,0 +1,134 @@
+# Copyright (c) 2022, Fraunhofer IESE
+# All rights reserved.
+#
+# 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.
+#
+# 2. 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.
+#
+# 3. Neither the name of the copyright holder 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 HOLDER
+# 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.
+#
+# Author: 
+#   Thomas Psota
+#   Marco Mörz
+
+###############################################
+###              DRAMUtils 1.0              ###
+###############################################
+cmake_minimum_required(VERSION 3.14.0)
+
+set(PROJECT_NAME "DRAMUtils 1.0")
+set(PROJECT_SHORTNAME "DRAMUtils")
+
+project(${PROJECT_NAME} VERSION "1.0")
+
+### CMake settings ###
+list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/cmake")
+include(build_source_group)
+include(diagnostics_print)
+include(enable_clang_format)
+include(enable_clang_tidy)
+include(enable_cppcheck)
+include(FetchContent)
+
+# Check if standalone build or being included as submodule
+get_directory_property(DRAMUTILS_IS_SUBMODULE PARENT_DIRECTORY)
+
+set_property(GLOBAL PROPERTY USE_FOLDERS ON)
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+
+### Project settings ###
+message(STATUS "CMAKE_SOURCE_DIR: ${CMAKE_SOURCE_DIR}")
+message(STATUS "CMAKE_BINARY_DIR: ${CMAKE_BINARY_DIR}")
+message(STATUS "" )
+
+if(NOT DRAMUTILS_IS_SUBMODULE)
+set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
+set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
+set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
+endif()
+
+### DRAMUtils directories ###
+set(DRAMUTILS_INCLUDE_DIR  "${CMAKE_CURRENT_SOURCE_DIR}/include")
+set(DRAMUTILS_LIBRARY_DIR "${CMAKE_CURRENT_SOURCE_DIR}/lib")
+set(DRAMUTILS_TEST_DIR    "${CMAKE_CURRENT_SOURCE_DIR}/tests")
+
+### Build options ###
+option(DRAMUTILS_BUILD_TESTS "Build DRAMUtils unit tests" OFF)
+
+### Compiler settings ###
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_EXTENSIONS OFF)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+
+###############################################
+###           Library Settings              ###
+###############################################
+
+### Detect OS threading library ###
+find_package(Threads)
+
+### nlohmann_json ###
+add_subdirectory(${DRAMUTILS_LIBRARY_DIR}/nlohmann_json)
+
+### GoogleTest ###
+if(DRAMUTILS_BUILD_TESTS)
+    FetchContent_Declare(
+	    googletest
+	    GIT_REPOSITORY https://github.com/google/googletest
+		GIT_TAG release-1.12.1)
+
+    # For Windows: Prevent overriding the parent project's compiler/linker settings
+    set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
+    FetchContent_MakeAvailable(googletest)
+    set_target_properties(gmock PROPERTIES FOLDER lib)
+    set_target_properties(gmock_main PROPERTIES FOLDER lib)
+    set_target_properties(gtest PROPERTIES FOLDER lib)
+    set_target_properties(gtest_main PROPERTIES FOLDER lib)
+endif()
+
+###############################################
+###                 DRAMUtils               ###
+###############################################
+
+include(dram_utils.cmake)
+
+###############################################
+###           Test Directory                ###
+###############################################
+
+if(DRAMUTILS_BUILD_TESTS)
+    include( GoogleTest )
+    include( CTest )
+    add_subdirectory(tests)
+endif()
+
+###############################################
+###           Utility Projects              ###
+###############################################
+
+if(${DRAMUTILS_UTILITY_PROJECTS})
+    enable_clang_format()
+    enable_clang_tidy()
+    enable_cppcheck()
+endif()

CMakePresets.json

@@ -0,0 +1,74 @@
+{
+	"version": 3,
+	"cmakeMinimumRequired": {
+		"major": 3,
+		"minor": 14,
+		"patch": 0
+	},
+	"configurePresets": [
+		{
+			"name": "cmake-pedantic",
+			"hidden": true,
+			"warnings": {
+				"dev": true,
+				"deprecated": true,
+				"unusedCli": true,
+				"systemVars": false
+			}
+		},
+		{
+			"name": "dev-mode",
+			"hidden": true,
+			"inherits": "cmake-pedantic",
+			"cacheVariables": {
+				"DRAMUTILS_BUILD_TESTS": "ON",
+				"CMAKE_BUILD_PARALLEL_LEVEL": ""
+			}
+		},
+		{
+			"name": "ci-common",
+			"binaryDir": "${sourceDir}/build",
+			"inherits": [
+				"dev-mode"
+			],
+			"cacheVariables": {
+				"CMAKE_BUILD_TYPE": "Release"
+			}
+		},
+		{
+			"name": "ci-unix",
+			"generator": "Unix Makefiles",
+			"inherits": [
+				"ci-common"
+			]
+		},
+		{
+			"name": "ci-msvc",
+			"generator": "Visual Studio 17 2022",
+			"inherits": [
+				"ci-common"
+			],
+			"cacheVariables": {
+				"CMAKE_CXX_FLAGS": "/MP"
+			}
+		},
+		{
+			"name": "dev-unix",
+			"generator": "Unix Makefiles",
+			"inherits": [
+				"dev-mode"
+			],
+			"cacheVariables": {
+				"CMAKE_BUILD_TYPE": "Debug",
+				"CMAKE_CXX_FLAGS": "-Wall -Wextra -Wpedantic"
+			}
+		},
+		{
+			"name": "dev-msvc",
+			"generator": "Visual Studio 17 2022",
+			"inherits": [
+				"dev-mode"
+			]
+		}
+	]
+}

LICENSE.txt

@@ -0,0 +1,32 @@
+Copyright (c) 2024, RPTU Kaiserslautern-Landau, Fraunhofer IESE
+All rights reserved.
+
+This software is released under the BSD 3-Clause License. 
+By using this software, the user implicitly agrees to the licensing terms.
+
+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.
+
+2. 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.
+
+3. Neither the name of the copyright holder 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 HOLDER
+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.