Spinlock Library with potential Deadlock Detection Feature

Cargo.toml

@@ -13,7 +13,7 @@ members = [
     "realm/rsi-test",
     "rmm/",
     "sdk",
-    "model-checking",
+    "model-checking", "lib/spinlock",
 ]
 
 [profile.dev]

lib/spinlock/Cargo.toml

@@ -0,0 +1,14 @@
+[package]
+name = "spinlock"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+lazy_static = "1.4.0"
+spin = "0.9"
+armv9a = { path = "../armv9a" }
+
+[features]
+#default = []
+deadlock_test = []
+p_deadlock_test = []

lib/spinlock/README.md

@@ -0,0 +1,22 @@
+## Usage of the library :
+
+   use spinlock::spinlock
+   use spinlock::Spinlock
+   use spinlock::SpinlockGuard
+
+## Locking mechanism :
+
+   1. lock() - works as normal lock function
+   2. lock_(RMI_ID) - takes RMI Interface Number of the interface holding the lock as argument
+
+## Conditioanl compilation feature :
+
+   add " --deadlock-test " in the command line argumrnt for Real Time Deadlock Test
+   add " --deadlock-test --p-deadlock-test " in the command line for Potential Deadlock Test (runs with much overhead)
+
+## APIS for potential deadlock analysis
+
+   1. spinlock::checkdeadlock() - checks for potential deadlock with the best possible analysis
+   2. spinlock::checkdeadlock_weak() - checks for potentail deadlock with weaker analysis 
+
+      (use spinlock::spinlock must be included)

lib/spinlock/src/lib.rs

@@ -0,0 +1,2 @@
+#![no_std]
+pub mod spinlock;