Merge pull request #63 from lquenti/complete-recode

WIP COMPLETE RECODE

.github/workflows/c.yml

@@ -0,0 +1,19 @@
+name: Everything C
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+jobs:
+  static_analysis:
+    name: Run gcc with warnings
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install Dependencies
+        run: sudo apt-get install gcc cppcheck
+      - name: Compile Library with Warnings
+        run: gcc -Wall -Wextra -Wpedantic -Werror -std=c11 -c -o /dev/null ./blackheap-benchmarker/src/c_code/benchmarker_internal.c
+      - name: Run cppcheck
+        # This is everything but `unusedFunction` enabled
+        run: cppcheck --enable=warning,style,performance,portability,information,missingInclude --error-exitcode=1 ./blackheap-benchmarker/src/c_code/benchmarker.c

.github/workflows/rust.yml

@@ -7,21 +7,69 @@ on:
 env:
   CARGO_TERM_COLOR: always
 jobs:
-  build:
+  build_works:
+    name: Build Works
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-    - run: |
-        rustup update
-        rustup component add clippy
-        rustup component add rustfmt
-    - name: Check
-      working-directory: ./blackheap-modeller
-      run: cargo check
-    - name: Run clippy
-      working-directory: ./blackheap-modeller
-      run: cargo clippy -- -Dwarnings
-    - name: Run Fmt
-      working-directory: ./blackheap-modeller
-      run: cargo fmt --check
+      - uses: actions/checkout@v3
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+      - name: run cargo build --release
+        run: |
+          cargo build --release 
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+      - name: run cargo test
+        run: |
+          cargo test
+  fmt:
+    name: fmt
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+      - name: run cargo fmt --check
+        run: |
+          cargo fmt --check
+  clippy:
+    name: clippy
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+      - name: run cargo clippy
+        run: |
+          cargo clippy
+  doc:
+    name: Doc
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+      - name: run cargo doc
+        run: |
+          cargo doc
 

.gitignore

@@ -1,5 +1,15 @@
-.vscode
-blackheap
+# Generated by Cargo
+# will have compiled files and executables
+debug/
+target/
+
+# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
+# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
+Cargo.lock
+
+# These are backup files generated by rustfmt
+**/*.rs.bk
+
+# MSVC Windows builds of rustc generate these, which store debugging information
+*.pdb
 
-# If you just use blackheap locally, please don't commit
-/**/default-model

Cargo.toml

@@ -0,0 +1,8 @@
+[workspace]
+
+members = [
+    "blackheap",
+    "blackheap-benchmarker"
+]
+
+resolver = "2"

LICENSE

@@ -1,19 +1,7 @@
-Copyright (c) 2022 Lars Quentin
+Copyright (c) 2022-2024 Lars Quentin
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,7 +1,65 @@
-# RECODE IN PROGRESS SEE BRANCH ETA MID 2024
+# Blackheap
 
-![Blackheap Logo](./icon.png)
+# BIG RECODE, `old-v0` is the old branch
 
 This tool creates a performance model of your I/O speed and further allows to predict future preformance.
 
-# [Link to the Documentation](https://lquenti.github.io/blackheap/book/)
+## Note
+
+There is a **big recode** right now. But how does one eat an elephant...
+
+## Progress
+- [x] Start new repo
+- [ ] Requirements Engineering
+  - [x] Find out how to formalize what the code should do
+    - fuck formalization, we use pseudocode
+  - [ ] Look what the code did before by looking through...
+    - [ ] <https://lquenti.github.io/blackheap/book/>
+    - [ ] <https://gwdg.github.io/iofs/book/>
+    - [ ] `blackheap-benchmark`
+    - [ ] `blackheap-modeller`
+    - [ ] `blackheap-frontend`
+    - [ ] `preloadee`
+    - [ ] All open issues
+    - [ ] All closed isses
+    - Unstructured ideas:
+      - Has to be resumeable
+      - be able to re-analyze raw data again
+      - Provide machine generated README in the data
+      - `blackheap-benchmarker` does not rely on bindgen compile time since this would create LLVM as dep
+      - [ ] Also provide a standalone binary for the benchmarker?
+      - [ ] Find a way to have C linting (all warnings, formatter, pedantic C standard)
+- [ ] Design a high level architecture based on the requirements
+- [x] Finish the benchmarker
+- [ ] Finish the Rust Code
+
+- [ ] Try to move stuff out of the `bin` into the `lib` crates
+
+## Issues for when the recode is done
+- Add `O_DIRECT` support
+
+## Architecture
+Cargo workspace with the following crates
+```
+- blackheap-core (lib): stuff all other libraries need (like Definitions)
+- blackheap-benchmarker (lib): C code with Rust wrapper
+- blackheap-analyzer (lib): Analysis of the benchmarks
+- blackheap (bin): The user facing code
+```
+
+High level workflow:
+```
+- user starts blackheap with config parameters
+- blackheap checks which benchmarks are already done
+  - If folder doesnt exist / was not provided, do all benchmarks
+- based on those benchmarks, do the analysis
+- Create (human-readable) plots
+- Create (machine-readable) parsing data
+```
+
+Benchmarker:
+```
+- get input from Rust struct
+- give output in Rust struct
+- Rust part should support a to json function for persistence
+```