Introduce CI and basic checks

.github/workflows/base.yml

@@ -0,0 +1,36 @@
+name: Bao component base workflow
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+
+  gitlint:
+    runs-on: ubuntu-latest
+    container: baoproject/bao:latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+          fetch-depth: 0
+      - run: git config --global --add safe.directory $(realpath .)
+      - if: ${{ github.event_name == 'pull_request' }}
+        run: make gitlint GITLINT_BASE=${{ github.event.pull_request.base.sha }}
+      - if: ${{ github.event_name == 'push' }}
+        run: make gitlint GITLINT_BASE=${{ github.event.before }}
+      - if: ${{ github.event_name == 'workflow_dispatch' }}
+        run: make gitlint GITLINT_BASE=HEAD
+
+  license:
+    runs-on: ubuntu-latest
+    container: baoproject/bao:latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+          fetch-depth: 0
+      - run: >
+          make license-check

.github/workflows/build-arm.yaml

@@ -0,0 +1,30 @@
+name: Arm Build
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+
+  build-arm:
+    runs-on: ubuntu-latest
+    container: baoproject/bao:latest
+    strategy:
+      matrix:
+        platform: [
+          "fvp-a",
+          "fvp-a-aarch32",
+          "fvp-r",
+          "fvp-r-aarch32"
+        ]
+        gic: [
+          "GICV2",
+          "GICV3",
+        ]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+      - run: make PLATFORM=${{ matrix.platform }} GIC_VERSION=${{ matrix.gic }} CONFIG=null

.github/workflows/build-riscv.yaml

@@ -0,0 +1,27 @@
+name: RISC-V Build
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+
+  build-riscv:
+    runs-on: ubuntu-latest
+    container: baoproject/bao:latest
+    strategy:
+      matrix:
+        platform: [
+          "qemu-riscv64-virt",
+        ]
+        irqc: [
+          "PLIC",
+          "APLIC",
+        ]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+      - run: make PLATFORM=${{ matrix.platform }} IRQC=${{ matrix.irqc }} CONFIG=null

.gitignore

@@ -9,4 +9,4 @@ configs/*
 !configs/configs.mk
 !configs/linker.ld 
 !configs/example/
-
+!configs/null/

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "ci"]
+	path = ci
+	url = [email protected]:bao-project/bao-ci.git

Makefile

@@ -34,9 +34,6 @@ PLATFORM=
 
 version:= baoversion_$(subst -,_,$(shell  git describe --always --dirty --tag --match "v*\.*\.*"))
 
-# List existing submakes
-submakes:=config
-
 # Directories
 cur_dir:=$(current_directory)
 src_dir:=$(cur_dir)/src
@@ -47,11 +44,22 @@ platforms_dir=$(src_dir)/platform
 configs_dir=$(cur_dir)/configs
 CONFIG_REPO?=$(configs_dir)
 scripts_dir:=$(cur_dir)/scripts
+ci_dir:=$(cur_dir)/ci
 src_dirs:=
 
-#Plataform must be defined excpet for clean target
+include $(ci_dir)/ci.mk
+
+targets:=$(MAKECMDGOALS)
+ifeq ($(targets),)
+targets:=all
+endif
+non_build_targets+=ci clean
+build_targets:=$(strip $(foreach target, $(targets), \
+	$(if $(findstring $(target),$(non_build_targets)),,$(target))))
+
+#Plataform must be defined excpet for non-build-targets
 ifeq ($(PLATFORM),)
-ifneq ($(MAKECMDGOALS), clean)
+ifneq ($(build_targets),)
  $(error Target platform argument (PLATFORM) not specified)
 endif
 endif
@@ -142,7 +150,7 @@ gens+=$(platform_defs) $(platform_def_generator)
 inc_dirs+=$(platform_build_dir)
 
 
-ifneq ($(MAKECMDGOALS), clean)
+ifneq ($(build_targets),)
 ifeq ($(CONFIG),)
 $(error Configuration (CONFIG) not defined.)
 endif
@@ -185,6 +193,8 @@ override LDFLAGS+=-build-id=none -nostdlib --fatal-warnings \
 	-z common-page-size=$(PAGE_SIZE) -z max-page-size=$(PAGE_SIZE) \
 	$(arch-ldflags) $(platform-ldflags)
 
+ifneq ($(build_targets),)
+
 .PHONY: all
 all: $(targets-y)
 
@@ -204,7 +214,7 @@ $(ld_script_temp):
 	@$(cc) -E $(addprefix -I, $(inc_dirs)) -x assembler-with-cpp  $(CPPFLAGS) \
 		$(ld_script) | grep -v '^\#' > $(ld_script_temp)
 
-ifeq (, $(findstring $(MAKECMDGOALS), clean $(submakes)))
+ifneq ($(build_targets),)
 -include $(deps)
 endif
 
@@ -279,10 +289,26 @@ $(directories):
 	@echo "Creating directory	$(patsubst $(cur_dir)/%, %, $@)"
 	@mkdir -p $@
 
+endif
+
 #Clean all object, dependency and generated files
 
 .PHONY: clean
 clean:
 	@echo "Erasing directories..."
 	-rm -rf $(build_dir)
 	-rm -rf $(bin_dir)
+
+# Instantiate CI rules
+
+all_files= $(realpath \
+	$(cur_dir)/Makefile \
+	$(call list_dir_files_recursive, $(src_dir), *) \
+	$(call list_dir_files_recursive, $(scripts_dir), *) \
+	$(call list_dir_files_recursive, $(config_dir)/example, *) \
+)
+
+$(call ci, license, "Apache-2.0", $(all_files))
+
+.PHONY: ci
+ci: license-check

README.md

@@ -1,5 +1,7 @@
 # Bao - a lightweight static partitioning hypervisor
 
+![arm build workflow](https://github.com/bao-project/bao-hypervisor/actions/workflows/build-arm.yaml/badge.svg)
+![riscv build workflow](https://github.com/bao-project/bao-hypervisor/actions/workflows/build-riscv.yaml/badge.svg)
 
 Introduction
 ------------

configs/null/config.c

@@ -0,0 +1,23 @@
+/**
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright (c) Bao Project and Contributors. All rights reserved.
+ */
+
+/* THIS CONFIG IS DEFINED FOR TESTING PURPOSES ONLY */
+
+#include <config.h>
+
+struct config config = {
+
+        /**
+         * This configuration has no VMs. It is used to test build the 
+         * hypervisor with an empty configuration. We have to set
+         * `vmlist_size` to 1, because the build scripts will generate
+         * a macro to define an array size from it which automatically
+         * triggers a set of `array subscript i is outside array bounds`
+         * errors and the build which we are testing in the first place
+         *  will fail.
+         */
+        .vmlist_size = 1,
+
+};