Merge pull request #1 from numpy1314/no_std

bump to v0.1.4-pre.1

Author: hky1999

.github/workflows/check.yml

@@ -0,0 +1,27 @@
+name: Check
+
+on:
+  push:
+    branches: [ no_std ]
+  pull_request:
+    branches: [ no_std ]
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          components: rustfmt, clippy
+
+      - name: Check Formatting
+        run: cargo fmt --all -- --check
+
+      - name: Clippy
+        run: cargo clippy --all-features -- -D warnings
+
+      - name: Build
+        run: cargo build --all-features

.github/workflows/deploy.yml

@@ -0,0 +1,29 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches: [ no_std ]
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Build Documentation
+        run: cargo doc --no-deps --all-features
+
+      - name: Create index.html
+        run: echo '<meta http-equiv="refresh" content="0;url=range_alloc_arceos/index.html">' > target/doc/index.html
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./target/doc

.github/workflows/release.yml

@@ -0,0 +1,85 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+      - 'v*.*.*-pre.*'
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  check:
+    if: github.repository_owner == 'arceos-hypervisor'
+    name: Check
+    uses: ./.github/workflows/check.yml
+
+  test:
+    if: github.repository_owner == 'arceos-hypervisor'
+    name: Test
+    uses: ./.github/workflows/test.yml
+    needs: check
+
+  publish-crates:
+    if: github.repository_owner == 'arceos-hypervisor'
+    name: Publish to crates.io
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Validate tag and branch (HEAD-based)
+        shell: bash
+        run: |
+          set -e
+
+          TAG="${{ github.ref_name }}"
+          TAG_COMMIT=$(git rev-list -n 1 "$TAG")
+
+          git fetch origin no_std
+
+          NO_STD_HEAD=$(git rev-parse origin/no_std)
+
+          echo "Tag:         $TAG"
+          echo "Tag commit:  $TAG_COMMIT"
+          echo "no_std HEAD: $NO_STD_HEAD"
+
+          if [ "$TAG_COMMIT" != "$NO_STD_HEAD" ]; then
+            echo "❌ release tag must be created from no_std HEAD"
+            exit 1
+          fi
+          echo "✅ tag validated on no_std"
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Publish to crates.io
+        run: cargo publish --token ${{ secrets.CARGO_REGISTRY_TOKEN }}
+
+  create-release:
+    if: github.repository_owner == 'arceos-hypervisor'
+    name: Create GitHub Release
+    runs-on: ubuntu-latest
+    needs: publish-crates
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          draft: false
+          prerelease: ${{ contains(github.ref_name, '-pre.') }}
+          generate_release_notes: true
+          body: |
+            ## ${{ github.ref_name }}
+
+            - Documentation: https://docs.rs/range-alloc-arceos
+            - crates.io: https://crates.io/crates/range-alloc-arceos

.github/workflows/test.yml

@@ -0,0 +1,19 @@
+name: Test
+
+on:
+  push:
+    branches: [ no_std ]
+  pull_request:
+    branches: [ no_std ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Run Tests
+        run: cargo test --all-features

Cargo.toml

@@ -1,12 +1,13 @@
 [package]
-name = "range-alloc"
-version = "0.1.4"
+name = "range-alloc-arceos"
+version = "0.1.4-pre.1"
 description = "Generic range allocator"
-homepage = "https://github.com/gfx-rs/range-alloc"
-repository = "https://github.com/gfx-rs/range-alloc"
+homepage = "https://github.com/arceos-hypervisor/range-alloc"
+repository = "https://github.com/arceos-hypervisor/range-alloc"
 keywords = ["allocator"]
 license = "MIT OR Apache-2.0"
 authors = ["the gfx-rs Developers"]
-documentation = "https://docs.rs/range-alloc"
+documentation = "https://docs.rs/range-alloc-arceos"
 categories = ["memory-management"]
 edition = "2018"
+readme = "README.md"

README.md

@@ -0,0 +1,66 @@
+# range-alloc-arceos
+
+[![Crates.io](https://img.shields.io/crates/v/range-alloc-arceos.svg)](https://crates.io/crates/range-alloc-arceos)
+[![Docs](https://img.shields.io/badge/docs-latest-blue.svg)](https://numpy1314.github.io/range-alloc)
+[![License](https://img.shields.io/crates/l/range-alloc-arceos.svg)](https://github.com/numpy1314/range-alloc/blob/main/LICENSE)
+[![CI](https://github.com/numpy1314/range-alloc/actions/workflows/check.yml/badge.svg)](https://github.com/numpy1314/range-alloc/actions/workflows/check.yml)
+
+**range-alloc-arceos** is a generic range allocator tailored for the ArceOS ecosystem. 
+
+It is a fork of the excellent [gfx-rs/range-alloc](https://github.com/gfx-rs/range-alloc), adapted for use in kernel development and embedded scenarios (`no_std`). It allows you to dynamically allocate and free ranges from a predefined memory block or address space.
+
+## Features
+
+- **`no_std` Support**: Designed for bare-metal and kernel environments.
+- **Generic**: Works with any type that satisfies the `Range` requirements (e.g., memory addresses, port numbers).
+- **`markdown
+# range-alloc-arceos
+
+[![Crates.io](https://img.shields.io/crates/v/range-alloc-arceos.svg)](https://crates.io/crates/range-alloc-arceos)
+[![Docs](https://img.shields.io/badge/docs-latest-blue.svg)](https://numpy1314.github.io/range-alloc)
+[![License](https://img.shields.io/crates/l/range-alloc-arceos.svg)](https://github.com/numpy1314/range-alloc/blob/main/LICENSE)
+[![CI](https://github.com/numpy1314/range-alloc/actions/workflows/check.yml/badge.svg)](https://github.com/numpy1314/range-alloc/actions/workflows/check.yml)
+
+**range-alloc-arceos** is a generic range allocator tailored for the ArceOS ecosystem. 
+
+It is a fork of the excellent [gfx-rs/range-alloc](https://github.com/gfx-rs/range-alloc), adapted for use in kernel development and embedded scenarios (`no_std`). It allows you to dynamically allocate and free ranges from a predefined memory block or address space.
+
+## Features
+
+- **`no_std` Support**: Designed for bare-metal and kernel environments.
+- **Generic**: Works with any type that satisfies the `Range` requirements (e.g., memory addresses, port numbers).
+- **Efficient**: Merges adjacent free ranges to minimize fragmentation.
+
+## Usage
+
+Add this to your `Cargo.toml`:
+
+```toml
+[dependencies]
+range-alloc-arceos = "0.1.0-alpha.1"
+```
+
+## Example
+```rust
+use range_alloc_arceos::RangeAllocator;
+
+fn main() {
+    // Initialize the allocator with a range (e.g., 0..100)
+    let mut allocator = RangeAllocator::new(0..100);
+
+}
+
+```
+
+## License
+This project is licensed under either of
+
+- Apache License, Version 2.0, (LICENSE-APACHE
+ or http://www.apache.org/licenses/LICENSE-2.0
+)
+
+- MIT license (LICENSE-MIT
+ or http://opensource.org/licenses/MIT
+)
+
+at your option.

tests/test.rs

@@ -0,0 +1,60 @@
+use range_alloc_arceos::RangeAllocator;
+
+#[test]
+fn test_simple_allocation() {
+    let mut allocator = RangeAllocator::new(0..100);
+
+    let r1 = allocator.allocate_range(10).expect("Alloc 10 failed");
+    assert_eq!(r1, 0..10);
+
+    let r2 = allocator.allocate_range(20).expect("Alloc 20 failed");
+    assert_eq!(r2, 10..30);
+
+    allocator.free_range(r1);
+
+    let r3 = allocator.allocate_range(5).expect("Alloc 5 failed");
+    assert_eq!(r3, 0..5);
+}
+
+#[test]
+fn test_out_of_memory() {
+    let mut allocator = RangeAllocator::new(0..10);
+
+    let _r1 = allocator.allocate_range(10).unwrap();
+
+    let r2 = allocator.allocate_range(1);
+    assert!(r2.is_err(), "Should return error when OOM");
+}
+
+#[test]
+fn test_fragmentation_and_merge() {
+    let mut allocator = RangeAllocator::new(0..100);
+
+    let a = allocator.allocate_range(20).unwrap();
+    let b = allocator.allocate_range(20).unwrap();
+    let c = allocator.allocate_range(20).unwrap();
+    let _d = allocator.allocate_range(40).unwrap();
+
+    allocator.free_range(a);
+    allocator.free_range(c);
+
+    assert!(allocator.allocate_range(30).is_err());
+
+    allocator.free_range(b);
+
+    let big = allocator
+        .allocate_range(60)
+        .expect("Should merge ranges A, B, C");
+    assert_eq!(big, 0..60);
+}
+
+#[test]
+fn test_alignment_gaps() {
+    let mut allocator = RangeAllocator::new(1000..2000);
+
+    let r1 = allocator.allocate_range(100).unwrap();
+    assert_eq!(r1, 1000..1100);
+
+    let r2 = allocator.allocate_range(100).unwrap();
+    assert_eq!(r2, 1100..1200);
+}