Merge pull request #2 from libplctag/prerelease

Adding code coverage.

Author: kyle-github

.github/workflows/coverage.yml

@@ -0,0 +1,55 @@
+name: coverage
+
+on:
+    push:
+        branches: [release]
+    pull_request:
+
+jobs:
+    coverage:
+        runs-on: ubuntu-latest
+
+        steps:
+            - uses: actions/checkout@v4
+
+            - name: Install dependencies
+              run: |
+                  sudo apt-get update
+                  sudo apt-get install -y lcov cmake build-essential
+
+            - name: Configure
+              run: |
+                  cmake -S . -B build -DENABLE_COVERAGE=ON
+
+            - name: Build
+              run: cmake --build build
+
+            - name: Test
+              run: ctest --test-dir build --output-on-failure
+
+            - name: Generate coverage report
+              run: |
+                  lcov --capture --directory build --output-file coverage.info
+                  lcov --remove coverage.info '/usr/*' --output-file coverage.info
+                  genhtml coverage.info --output-directory docs/coverage --title "yafl Code Coverage"
+
+            - name: Generate coverage badge
+              run: |
+                  chmod +x scripts/make_coverage_badge.sh
+                  scripts/make_coverage_badge.sh docs/coverage.svg coverage.info
+
+            - name: Create GitHub Pages configuration
+              run: |
+                  touch docs/.nojekyll
+
+            - name: Commit and push coverage to repository
+              if: github.event_name == 'push' && github.ref == 'refs/heads/release'
+              run: |
+                  git config user.name "GitHub Actions"
+                  git config user.email "actions@github.com"
+                  git add -A docs/
+                  if git diff --quiet --cached; then
+                    echo "No coverage changes to commit"
+                  else
+                    git commit -m "Update code coverage report" && git push origin release
+                  fi

.github/workflows/release.yml

@@ -14,7 +14,6 @@ on:
             - x86_64-unknown-linux-android
             - aarch64-apple-ios
             - arm-unknown-linux-gnueabihf
-            - aarch64-unknown-linux-gnu
             - riscv64-unknown-linux-gnu
             - mipsel-unknown-linux-gnu
             - mips64el-unknown-linux-gnuabi64
@@ -53,7 +52,6 @@ jobs:
                         "x86_64-unknown-linux-android",
                         "aarch64-apple-ios",
                         "arm-unknown-linux-gnueabihf",
-                        "aarch64-unknown-linux-gnu",
                         "riscv64-unknown-linux-gnu",
                         "mipsel-unknown-linux-gnu",
                         "mips64el-unknown-linux-gnuabi64",

CMakeLists.txt

@@ -68,11 +68,7 @@ set(CMAKE_C_STANDARD_REQUIRED ON)
 
 option(ENABLE_COVERAGE "Enable code coverage generation" OFF)
 if(ENABLE_COVERAGE)
-    if(CMAKE_C_COMPILER_ID MATCHES "GNU|Clang")
-        message(STATUS "Enabling code coverage")
-        add_compile_options(--coverage)
-        set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} --coverage")
-    endif()
+    include(toolchains/coverage.cmake)
 endif()
 
 # Note: Assembly language will be enabled after architecture detection

README.md

@@ -1,34 +1,57 @@
 # yafl - Portable Fiber/Coroutine Library
 
-![x86_64-pc-linux-gnu](https://github.com/libplctag/yafl/actions/workflows/x86_64-pc-linux-gnu.yml/badge.svg)
-![aarch64-pc-linux-gnu](https://github.com/libplctag/yafl/actions/workflows/aarch64-pc-linux-gnu.yml/badge.svg)
-![x86_64-apple-darwin](https://github.com/libplctag/yafl/actions/workflows/x86_64-apple-darwin.yml/badge.svg)
-![aarch64-apple-darwin](https://github.com/libplctag/yafl/actions/workflows/aarch64-apple-darwin.yml/badge.svg)
-![x86_64-pc-windows-msvc](https://github.com/libplctag/yafl/actions/workflows/x86_64-pc-windows-msvc.yml/badge.svg)
-![aarch64-pc-windows-msvc](https://github.com/libplctag/yafl/actions/workflows/aarch64-pc-windows-msvc.yml/badge.svg)
-![x86_64-pc-windows-gnu](https://github.com/libplctag/yafl/actions/workflows/x86_64-pc-windows-gnu.yml/badge.svg)
-![aarch64-pc-windows-gnu](https://github.com/libplctag/yafl/actions/workflows/aarch64-pc-windows-gnu.yml/badge.svg)
-![x86_64-unknown-linux-android](https://github.com/libplctag/yafl/actions/workflows/x86_64-unknown-linux-android.yml/badge.svg)
-![aarch64-apple-ios](https://github.com/libplctag/yafl/actions/workflows/aarch64-apple-ios.yml/badge.svg)
-![arm-unknown-linux-gnueabihf](https://github.com/libplctag/yafl/actions/workflows/arm-unknown-linux-gnueabihf.yml/badge.svg)
-![aarch64-unknown-linux-gnu](https://github.com/libplctag/yafl/actions/workflows/aarch64-unknown-linux-gnu.yml/badge.svg)
-![riscv64-unknown-linux-gnu](https://github.com/libplctag/yafl/actions/workflows/riscv64-unknown-linux-gnu.yml/badge.svg)
-![mipsel-unknown-linux-gnu](https://github.com/libplctag/yafl/actions/workflows/mipsel-unknown-linux-gnu.yml/badge.svg)
-![mips64el-unknown-linux-gnuabi64](https://github.com/libplctag/yafl/actions/workflows/mips64el-unknown-linux-gnuabi64.yml/badge.svg)
-![powerpc64le-unknown-linux-gnu](https://github.com/libplctag/yafl/actions/workflows/powerpc64le-unknown-linux-gnu.yml/badge.svg)
-![s390x-ibm-linux-gnu](https://github.com/libplctag/yafl/actions/workflows/s390x-ibm-linux-gnu.yml/badge.svg)
-![sparc64-unknown-linux-gnu](https://github.com/libplctag/yafl/actions/workflows/sparc64-unknown-linux-gnu.yml/badge.svg)
-![powerpc-unknown-linux-gnu](https://github.com/libplctag/yafl/actions/workflows/powerpc-unknown-linux-gnu.yml/badge.svg)
-![i386-unknown-linux-gnu](https://github.com/libplctag/yafl/actions/workflows/i386-unknown-linux-gnu.yml/badge.svg)
-[![codecov](https://codecov.io/gh/libplctag/yafl/graph/badge.svg)](https://codecov.io/gh/libplctag/yafl)
-
-A portable, low-level C11 fiber/coroutine library derived from Boost.Context, designed to replace the deprecated `ucontext` API.
+## Build Status
+
+| Platform | Status |
+| -------- | ------ |
+| x86_64-pc-linux-gnu | [![x86_64-pc-linux-gnu](https://github.com/libplctag/yafl/actions/workflows/x86_64-pc-linux-gnu.yml/badge.svg)](https://github.com/libplctag/yafl/actions/workflows/x86_64-pc-linux-gnu.yml) |
+| aarch64-pc-linux-gnu | [![aarch64-pc-linux-gnu](https://github.com/libplctag/yafl/actions/workflows/aarch64-pc-linux-gnu.yml/badge.svg)](https://github.com/libplctag/yafl/actions/workflows/aarch64-pc-linux-gnu.yml) |
+| x86_64-apple-darwin | [![x86_64-apple-darwin](https://github.com/libplctag/yafl/actions/workflows/x86_64-apple-darwin.yml/badge.svg)](https://github.com/libplctag/yafl/actions/workflows/x86_64-apple-darwin.yml) |
+| aarch64-apple-darwin | [![aarch64-apple-darwin](https://github.com/libplctag/yafl/actions/workflows/aarch64-apple-darwin.yml/badge.svg)](https://github.com/libplctag/yafl/actions/workflows/aarch64-apple-darwin.yml) |
+| x86_64-pc-windows-msvc | [![x86_64-pc-windows-msvc](https://github.com/libplctag/yafl/actions/workflows/x86_64-pc-windows-msvc.yml/badge.svg)](https://github.com/libplctag/yafl/actions/workflows/x86_64-pc-windows-msvc.yml) |
+| aarch64-pc-windows-msvc | [![aarch64-pc-windows-msvc](https://github.com/libplctag/yafl/actions/workflows/aarch64-pc-windows-msvc.yml/badge.svg)](https://github.com/libplctag/yafl/actions/workflows/aarch64-pc-windows-msvc.yml) |
+| x86_64-pc-windows-gnu | [![x86_64-pc-windows-gnu](https://github.com/libplctag/yafl/actions/workflows/x86_64-pc-windows-gnu.yml/badge.svg)](https://github.com/libplctag/yafl/actions/workflows/x86_64-pc-windows-gnu.yml) |
+| aarch64-pc-windows-gnu | [![aarch64-pc-windows-gnu](https://github.com/libplctag/yafl/actions/workflows/aarch64-pc-windows-gnu.yml/badge.svg)](https://github.com/libplctag/yafl/actions/workflows/aarch64-pc-windows-gnu.yml) |
+| x86_64-unknown-linux-android | [![x86_64-unknown-linux-android](https://github.com/libplctag/yafl/actions/workflows/x86_64-unknown-linux-android.yml/badge.svg)](https://github.com/libplctag/yafl/actions/workflows/x86_64-unknown-linux-android.yml) |
+| aarch64-apple-ios | [![aarch64-apple-ios](https://github.com/libplctag/yafl/actions/workflows/aarch64-apple-ios.yml/badge.svg)](https://github.com/libplctag/yafl/actions/workflows/aarch64-apple-ios.yml) |
+| arm-unknown-linux-gnueabihf | [![arm-unknown-linux-gnueabihf](https://github.com/libplctag/yafl/actions/workflows/arm-unknown-linux-gnueabihf.yml/badge.svg)](https://github.com/libplctag/yafl/actions/workflows/arm-unknown-linux-gnueabihf.yml) |
+| riscv64-unknown-linux-gnu | [![riscv64-unknown-linux-gnu](https://github.com/libplctag/yafl/actions/workflows/riscv64-unknown-linux-gnu.yml/badge.svg)](https://github.com/libplctag/yafl/actions/workflows/riscv64-unknown-linux-gnu.yml) |
+| mipsel-unknown-linux-gnu | [![mipsel-unknown-linux-gnu](https://github.com/libplctag/yafl/actions/workflows/mipsel-unknown-linux-gnu.yml/badge.svg)](https://github.com/libplctag/yafl/actions/workflows/mipsel-unknown-linux-gnu.yml) |
+| mips64el-unknown-linux-gnuabi64 | [![mips64el-unknown-linux-gnuabi64](https://github.com/libplctag/yafl/actions/workflows/mips64el-unknown-linux-gnuabi64.yml/badge.svg)](https://github.com/libplctag/yafl/actions/workflows/mips64el-unknown-linux-gnuabi64.yml) |
+| powerpc64le-unknown-linux-gnu | [![powerpc64le-unknown-linux-gnu](https://github.com/libplctag/yafl/actions/workflows/powerpc64le-unknown-linux-gnu.yml/badge.svg)](https://github.com/libplctag/yafl/actions/workflows/powerpc64le-unknown-linux-gnu.yml) |
+| s390x-ibm-linux-gnu | [![s390x-ibm-linux-gnu](https://github.com/libplctag/yafl/actions/workflows/s390x-ibm-linux-gnu.yml/badge.svg)](https://github.com/libplctag/yafl/actions/workflows/s390x-ibm-linux-gnu.yml) |
+| sparc64-unknown-linux-gnu | [![sparc64-unknown-linux-gnu](https://github.com/libplctag/yafl/actions/workflows/sparc64-unknown-linux-gnu.yml/badge.svg)](https://github.com/libplctag/yafl/actions/workflows/sparc64-unknown-linux-gnu.yml) |
+| powerpc-unknown-linux-gnu | [![powerpc-unknown-linux-gnu](https://github.com/libplctag/yafl/actions/workflows/powerpc-unknown-linux-gnu.yml/badge.svg)](https://github.com/libplctag/yafl/actions/workflows/powerpc-unknown-linux-gnu.yml) |
+| i386-unknown-linux-gnu | [![i386-unknown-linux-gnu](https://github.com/libplctag/yafl/actions/workflows/i386-unknown-linux-gnu.yml/badge.svg)](https://github.com/libplctag/yafl/actions/workflows/i386-unknown-linux-gnu.yml) |
+
+[![Coverage](https://libplctag.github.io/libyafl/coverage/coverage.svg)](https://libplctag.github.io/libyafl/coverage/index.html)
+
+A portable, low-level C11 fiber/coroutine library derived from Boost.Context.
+
+## Why Another Fiber Library?
+
+I wanted to use coroutines/fibers for another project and searched on GitHub and elsewhere and did not find anything that was:
+
+- Portable across many OSes, architectures and compilers.  Aiming for RTOS environments as well.
+- Every release tested across a matrix of architectures and operating systems and compilers.
+- Only C11 and assembly.
+- CMake build system or easy creation of CMake build configuration.
+- Minimal functionality.  Just fibers.
+- Support for guard pages etc. on operating systems that support them and malloc on platforms that do not.
+- The ability to measure stack usage.  This is critical for embedded projects.
+- No dependency on POSIX ucontext.
+- No other dependencies.
+- Appears to be maintained.
+
+Boost.Context is very close but aimed at C++ and in one case seems to require C++ code.  However, the project has large set of assembly for a wide variety of processor architectures.  I decided it would make a good test of using an LLM to wrap/refactor some code.
+
+The C code and documentation was mostly generated by Claude Code.  The assembly is from the Boost.Context project and was written by humans.  I have touched/edited almost every file at some point.
 
 ## Features
 
 - **Pure C11 implementation** - No C++ dependencies
 - **Asymmetric coroutines (fibers)** - Simplified suspend/resume model
-- **Guard pages** - Memory-efficient mmap-based stack with automatic overflow detection
+- **Guard pages** - Memory-efficient mmap-based stack with automatic overflow detection (crashing your program!)
 - **Stack watermark checking** - Measure maximum stack usage
 - **16-byte stack alignment** - ABI-compliant on x86_64 and ARM64
 - **Page-aware allocation** - Handles 4KB (Linux/Windows) and 16KB (macOS ARM) pages

VERSION

@@ -1 +1 @@
-1.81.0-0
+0.1.0

docs/.gitkeep

@@ -0,0 +1,77 @@
+#!/usr/bin/env bash
+set -e
+
+# Color codes for output
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+NC='\033[0m' # No Color
+
+# Script directory
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+PROJECT_DIR="$(dirname "$SCRIPT_DIR")"
+
+echo -e "${YELLOW}=== YAFL Code Coverage Generator ===${NC}"
+echo
+
+# Check for lcov
+if ! command -v lcov &> /dev/null; then
+    echo -e "${RED}Error: lcov is not installed${NC}"
+    echo "Install it with:"
+    echo "  macOS: brew install lcov"
+    echo "  Linux: sudo apt-get install lcov"
+    exit 1
+fi
+
+# Check for cmake
+if ! command -v cmake &> /dev/null; then
+    echo -e "${RED}Error: cmake is not installed${NC}"
+    exit 1
+fi
+
+# Check for genhtml (comes with lcov)
+if ! command -v genhtml &> /dev/null; then
+    echo -e "${RED}Error: genhtml is not installed${NC}"
+    exit 1
+fi
+
+cd "$PROJECT_DIR"
+
+echo -e "${GREEN}Step 1: Configuring CMake with coverage enabled...${NC}"
+cmake -S . -B build -DENABLE_COVERAGE=ON -DCMAKE_BUILD_TYPE=Debug
+echo
+
+echo -e "${GREEN}Step 2: Building project...${NC}"
+cmake --build build
+echo
+
+echo -e "${GREEN}Step 3: Running tests...${NC}"
+ctest --test-dir build --output-on-failure
+echo
+
+echo -e "${GREEN}Step 4: Capturing coverage data...${NC}"
+lcov --capture --directory build --output-file coverage.info
+echo
+
+echo -e "${GREEN}Step 5: Filtering system files from coverage...${NC}"
+lcov --remove coverage.info '/usr/*' --output-file coverage.info
+echo
+
+echo -e "${GREEN}Step 6: Generating HTML report...${NC}"
+genhtml coverage.info --output-directory docs/coverage --title "yafl Code Coverage"
+echo
+
+echo -e "${GREEN}Step 7: Generating coverage badge...${NC}"
+"$SCRIPT_DIR/make_coverage_badge.sh" docs/coverage.svg coverage.info
+echo
+
+echo -e "${GREEN}=== Coverage Generation Complete ===${NC}"
+echo
+echo -e "Coverage report: ${YELLOW}docs/coverage/index.html${NC}"
+echo -e "Coverage badge: ${YELLOW}docs/coverage.svg${NC}"
+echo
+echo "To view the report, open:"
+echo "  file://$(cd "$PROJECT_DIR" && pwd)/docs/coverage/index.html"
+echo
+echo -e "${YELLOW}Note:${NC} Clean the build directory with:"
+echo "  rm -rf build coverage.info docs/coverage docs/coverage.svg"

scripts/generate_coverage.sh

@@ -0,0 +1,62 @@
+#!/usr/bin/env bash
+set -e
+
+# Usage: make_coverage_badge.sh <output_svg_path> [coverage_info_path]
+OUTPUT_SVG="${1:-coverage.svg}"
+COVERAGE_INFO="${2:-coverage.info}"
+
+# Check if coverage.info exists
+if [ ! -f "$COVERAGE_INFO" ]; then
+    echo "Error: Coverage file not found: $COVERAGE_INFO"
+    exit 1
+fi
+
+# Extract coverage percentage
+COVERAGE=$(lcov --summary "$COVERAGE_INFO" | grep "lines" | awk '{print $2}' | sed 's/%//')
+if [ -z "$COVERAGE" ]; then
+    echo "Error: Could not extract coverage from $COVERAGE_INFO"
+    exit 1
+fi
+
+COVERAGE_INT=${COVERAGE%.*}
+
+# Determine color based on coverage percentage
+if [ "$COVERAGE_INT" -ge 90 ]; then
+  COLOR="brightgreen"
+elif [ "$COVERAGE_INT" -ge 75 ]; then
+  COLOR="yellow"
+else
+  COLOR="red"
+fi
+
+# Ensure output directory exists
+OUTPUT_DIR=$(dirname "$OUTPUT_SVG")
+if [ "$OUTPUT_DIR" != "." ]; then
+  mkdir -p "$OUTPUT_DIR"
+fi
+
+# Generate SVG badge
+cat > "$OUTPUT_SVG" <<EOF
+<svg xmlns="http://www.w3.org/2000/svg" width="120" height="20">
+  <linearGradient id="b" x2="0" y2="100%">
+    <stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
+    <stop offset="1" stop-opacity=".1"/>
+  </linearGradient>
+  <mask id="a">
+    <rect width="120" height="20" rx="3" fill="#fff"/>
+  </mask>
+  <g mask="url(#a)">
+    <rect width="70" height="20" fill="#555"/>
+    <rect x="70" width="50" height="20" fill="${COLOR}"/>
+    <rect width="120" height="20" fill="url(#b)"/>
+  </g>
+  <g fill="#fff" text-anchor="middle"
+     font-family="DejaVu Sans,Verdana,Geneva,sans-serif"
+     font-size="11">
+    <text x="35" y="14">coverage</text>
+    <text x="95" y="14">${COVERAGE}%</text>
+  </g>
+</svg>
+EOF
+
+echo "Generated coverage badge: $OUTPUT_SVG ($COVERAGE%)"

scripts/make_coverage_badge.sh

@@ -0,0 +1,20 @@
+option(ENABLE_COVERAGE "Enable code coverage" OFF)
+
+if(ENABLE_COVERAGE)
+    if(CMAKE_C_COMPILER_ID STREQUAL "GNU")
+        message(STATUS "Enabling GCC coverage")
+        add_compile_options(-O0 -g --coverage)
+        add_link_options(--coverage)
+
+    elseif(CMAKE_C_COMPILER_ID STREQUAL "Clang")
+        message(STATUS "Enabling Clang coverage with llvm-cov")
+        # Use GCC-style coverage for lcov compatibility
+        add_compile_options(-O0 -g --coverage)
+        add_link_options(--coverage)
+
+    elseif(MSVC)
+        message(WARNING "Coverage enabled, but MSVC coverage is not supported in CI")
+    else()
+        message(WARNING "Code coverage not configured for this compiler: ${CMAKE_C_COMPILER_ID}")
+    endif()
+endif()