RustFS Lock - Distributed Locking

📖 Overview

RustFS Lock provides distributed locking and synchronization primitives for the RustFS distributed object storage system. It ensures data consistency and prevents race conditions in multi-node environments through various locking mechanisms and coordination protocols.

Note: This is a core submodule of RustFS that provides essential distributed locking capabilities for the distributed object storage system. For the complete RustFS experience, please visit the main RustFS repository.

✨ Features

🔒 Distributed Locking

Exclusive Locks: Mutual exclusion across cluster nodes
Shared Locks: Reader-writer lock semantics
Timeout Support: Configurable lock timeouts and expiration
Deadlock Prevention: Automatic deadlock detection and resolution

🔄 Synchronization Primitives

Distributed Mutex: Cross-node mutual exclusion
Distributed Semaphore: Resource counting across nodes
Distributed Barrier: Coordination point for multiple nodes
Distributed Condition Variables: Wait/notify across nodes

🛡️ Consistency Guarantees

Linearizable Operations: Strong consistency guarantees
Fault Tolerance: Automatic recovery from node failures
Network Partition Handling: CAP theorem aware implementations
Consensus Integration: Raft-based consensus for critical locks

🚀 Performance Features

Lock Coalescing: Efficient batching of lock operations
Adaptive Timeouts: Dynamic timeout adjustment
Lock Hierarchy: Hierarchical locking for better scalability
Optimistic Locking: Reduced contention through optimistic approaches

📦 Installation

Add this to your Cargo.toml:

[dependencies]
rustfs-lock = "0.0.3"

🔧 Usage

📋 Requirements

Rust: 1.70.0 or later
Platforms: Linux, macOS, Windows
Network: Cluster connectivity required
Consensus: Raft consensus for critical operations

🌍 Related Projects

This module is part of the RustFS ecosystem:

RustFS Main - Core distributed storage system
RustFS Common - Common types and utilities
RustFS Protos - Protocol buffer definitions

📚 Documentation

For comprehensive documentation, visit:

🔗 Links

Documentation - Complete RustFS manual
Changelog - Release notes and updates
GitHub Discussions - Community support

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

📄 License

Licensed under the Apache License, Version 2.0. See LICENSE for details.

rustfs-lock 0.0.3