refactor: Modernize Makefile build systems, CI/CD and README conventions

Signed-off-by: Felicitas Pojtinger <felicitas@pojtinger.com>

Author: pojntfx

.github/workflows/hydrun.yaml

@@ -6,27 +6,33 @@ on:
   schedule:
     - cron: "0 0 * * 0"
 
-permissions:
-  contents: write
-
 jobs:
   build-linux:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.target.runner }}
+    permissions:
+      contents: read
     strategy:
       matrix:
         target:
+          # Tests
           - id: test
             src: .
             os: golang:bookworm
-            flags: ""
-            cmd: ./Hydrunfile test
-            dst: out/nonexistent*
+            flags: -e '-v /tmp/ccache:/root/.cache/go-build'
+            cmd: GOFLAGS="-short" ./Hydrunfile test
+            dst: out/nonexistent
+            runner: ubuntu-latest
+
+          # Integration
           - id: integration
             src: .
             os: golang:bookworm
-            flags: "-e '--privileged -v /lib/modules:/lib/modules -v /dev:/dev'"
-            cmd: ./Hydrunfile integration
-            dst: out/nonexistent*
+            flags: "-e '-v /tmp/ccache:/root/.cache/go-build --privileged -v /lib/modules:/lib/modules -v /dev:/dev'"
+            cmd: GOFLAGS="-short" ./Hydrunfile integration
+            dst: out/nonexistent
+            runner: ubuntu-latest
+
+          # We don't vendor the binaries
 
     steps:
       - name: Maximize build space
@@ -35,11 +41,17 @@ jobs:
           sudo rm -rf /usr/local/lib/android
           sudo rm -rf /opt/ghc
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
+      - name: Restore ccache
+        uses: actions/cache/restore@v4
+        with:
+          path: |
+            /tmp/ccache
+          key: cache-ccache-${{ matrix.target.id }}
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v1
+        uses: docker/setup-qemu-action@v3
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v1
+        uses: docker/setup-buildx-action@v3
       - name: Set up hydrun
         run: |
           curl -L -o /tmp/hydrun "https://github.com/pojntfx/hydrun/releases/latest/download/hydrun.linux-$(uname -m)"
@@ -49,40 +61,46 @@ jobs:
         run: hydrun -o ${{ matrix.target.os }} ${{ matrix.target.flags }} "${{ matrix.target.cmd }}"
       - name: Fix permissions for output
         run: sudo chown -R $USER .
+      - name: Save ccache
+        uses: actions/cache/save@v4
+        with:
+          path: |
+            /tmp/ccache
+          key: cache-ccache-${{ matrix.target.id }}
       - name: Upload output
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with:
           name: ${{ matrix.target.id }}
           path: ${{ matrix.target.dst }}
 
   publish-linux:
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
     needs: build-linux
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Download output
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v4
         with:
           path: /tmp/out
       - name: Extract branch name
         id: extract_branch
         run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"
       - name: Publish pre-release to GitHub releases
         if: ${{ github.ref == 'refs/heads/main' }}
-        uses: marvinpinto/action-automatic-releases@latest
+        uses: softprops/action-gh-release@v2
         with:
-          repo_token: "${{ secrets.GITHUB_TOKEN }}"
-          automatic_release_tag: release-${{ steps.extract_branch.outputs.branch }}
+          tag_name: release-${{ steps.extract_branch.outputs.branch }}
           prerelease: true
           files: |
             /tmp/out/*/*
       - name: Publish release to GitHub releases
         if: startsWith(github.ref, 'refs/tags/v')
-        uses: marvinpinto/action-automatic-releases@latest
+        uses: softprops/action-gh-release@v2
         with:
-          repo_token: "${{ secrets.GITHUB_TOKEN }}"
           prerelease: false
           files: |
             /tmp/out/*/*

Makefile

@@ -1,5 +1,8 @@
 # Public variables
+DESTDIR ?=
+PREFIX ?= /usr/local
 OUTPUT_DIR ?= out
+DST ?=
 
 # Private variables
 obj = r3map-benchmark-direct-mount r3map-benchmark-managed-mount r3map-benchmark-migration
@@ -8,7 +11,25 @@ all: $(addprefix build/,$(obj))
 # Build
 build: $(addprefix build/,$(obj))
 $(addprefix build/,$(obj)):
+ifdef DST
+	go build -o $(DST) ./cmd/$(subst build/,,$@)
+else
 	go build -o $(OUTPUT_DIR)/$(subst build/,,$@) ./cmd/$(subst build/,,$@)
+endif
+
+# Install
+install: $(addprefix install/,$(obj))
+$(addprefix install/,$(obj)):
+	install -D -m 0755 $(OUTPUT_DIR)/$(subst install/,,$@) $(DESTDIR)$(PREFIX)/bin/$(subst install/,,$@)
+
+# Uninstall
+uninstall: $(addprefix uninstall/,$(obj))
+$(addprefix uninstall/,$(obj)):
+	rm $(DESTDIR)$(PREFIX)/bin/$(subst uninstall/,,$@)
+
+# Run
+$(addprefix run/,$(obj)):
+	$(subst run/,,$@) $(ARGS)
 
 # Test
 test:
@@ -26,6 +47,10 @@ integration/direct-mount-directory:
 integration/managed-mount-file:
 	$(OUTPUT_DIR)/r3map-benchmark-managed-mount --remote-backend=file
 
+# Benchmark
+benchmark:
+	go test -timeout 3600s -bench=./... ./...
+
 # Clean
 clean:
 	rm -rf out

README.md

@@ -1,9 +1,11 @@
-# r3map
+<img alt="Project icon" style="vertical-align: middle;" src="./docs/icon.svg" width="128" height="128" align="left">
 
-![Logo](./docs/logo-readme.png)
+# r3map
 
 Re**m**ote **mm**ap: High-performance remote memory region mounts and migrations in user space.
 
+<br/>
+
 [![hydrun CI](https://github.com/pojntfx/r3map/actions/workflows/hydrun.yaml/badge.svg)](https://github.com/pojntfx/r3map/actions/workflows/hydrun.yaml)
 ![Go Version](https://img.shields.io/badge/go%20version-%3E=1.20-61CFDD.svg)
 [![Go Reference](https://pkg.go.dev/badge/github.com/pojntfx/r3map.svg)](https://pkg.go.dev/github.com/pojntfx/r3map)
@@ -13,7 +15,7 @@ Re**m**ote **mm**ap: High-performance remote memory region mounts and migrations
 
 r3map is a library that simplifies working with remote memory regions and migrating them between hosts.
 
-It can ...
+It enables you to:
 
 - **Create a virtual `[]byte` or a virtual file that transparently downloads remote chunks only when they are accessed**: By providing multiple frontends (such as a memory region and a file/path) for accessing or migrating a resource, integrating remote memory into existing applications is possible with little to no changes, and fully language-independent.
 - **`mmap` any local or remote resource instead of just files**: By exposing a simple backend interface and being fully transport-independent, r3map makes it possible to map resources such as a **S3 bucket, Cassandra or Redis database**, or even a tape drive into a memory region efficiently, as well as migrating it over an RPC framework of your choice, such as gRPC.
@@ -39,7 +41,7 @@ You can add r3map to your Go project by running the following:
 $ go get github.com/pojntfx/r3map/...@latest
 ```
 
-## Usage
+## Tutorial
 
 ### 1. Mapping a Remote Resource into Memory with the Direct Mount API
 
@@ -733,6 +735,6 @@ Have any questions or need help? Chat with us [on Matrix](https://matrix.to/#/#r
 
 ## License
 
-r3map (c) 2023 Felicitas Pojtinger and contributors
+r3map (c) 2024 Felicitas Pojtinger and contributors
 
 SPDX-License-Identifier: Apache-2.0