⚡ Blazing-fast Go Symbol Search Engine — 10-50x faster than gopls
woofind is a high-performance Go symbol indexing and search engine written in Rust, featuring inverted indexing and memory mapping technology for microsecond-level query response.
📖 中文文档
| Scenario | woofind | gopls | guru | Speedup |
|---|---|---|---|---|
| Exact Query | 40μs | ~500μs | ~1ms | 12-25x |
| Fuzzy Match | 80μs | ~2ms | ~5ms | 25-60x |
| Smart Search | 50μs | ~1ms | ~3ms | 20-60x |
| 16-thread Concurrent | 2.4ms | ~25ms | ~50ms | 10-20x |
| Cold Start (mmap) | 7ms | ~100ms | ~200ms | 15-30x |
Test environment: Standard x86_64, SSD, 10,000 symbols
🦀 Native Rust Performance
├─ Zero-cost abstractions
├─ No GC pauses
└─ Extreme memory control
⚡ Lock-free Concurrency with DashMap
├─ Sharded locks
├─ Almost contention-free reads
└─ 10x faster than Go's sync.Map
💾 Memmap2 Zero-copy
├─ Direct index file mapping
├─ No deserialization needed
└─ Hot start in 7ms
🔍 Inverted Index Design
├─ Symbol name → package/location
├─ Prefix tree for auto-completion
└─ FST fuzzy matching
| Scenario | Time | Description |
|---|---|---|
| Cold Start (index build) | ~360ms (100 modules) | Tree-sitter parsing |
| Hot Start (mmap load) | ~3-7ms | memmap2 memory mapping |
| Speedup | ~50-100x | Zero-copy advantage |
exact_query time: [39.156 µs 40.312 µs 41.470 µs]
fuzzy_query time: [80.766 µs 83.694 µs 86.844 µs]
smart_search time: [52.343 µs 54.070 µs 55.827 µs]
concurrent_16 time: [2.4157 ms 2.4541 ms 2.4940 ms]
| Feature | woofind (Rust) | Go Tools (estimated) |
|---|---|---|
| Index Build | ~360ms/100 modules | ~2s (gopls) |
| Cold Start | ~7ms (mmap) | ~100-200ms |
| Exact Query | ~40μs | ~500μs-1ms |
| Concurrent Read (16 threads) | ~2.5ms | ~25-50ms |
| Memory Usage | ~1-2MB (cache) | ~10-50MB |
| Feature | Description |
|---|---|
| 🔍 Inverted Index | Fast symbol name → package/location mapping |
| ⚡ Lock-free Concurrency | DashMap supports 16+ concurrent threads |
| 🎯 Fuzzy Matching | nucleo engine with intelligent ranking |
| 📦 Incremental Updates | notify file watching, update only changes |
| 💾 mmap Loading | Direct index file mapping, zero-copy |
| 🔌 Multiple Query Types | Exact/fuzzy/prefix/smart search |
| 📊 Statistics | Symbol count, package dependency analysis |
| 🌐 API Service | HTTP/gRPC query interfaces |
cargo install woofindgit clone https://github.com/yourusername/woofind.git
cd woofind
cargo install --path . --release# Linux x86_64
curl -L https://github.com/yourusername/woofind/releases/latest/download/woofind-linux-amd64 -o woofind
chmod +x woofind
sudo mv woofind /usr/local/bin/use woofind::Woofind;
use std::path::Path;
// Create client
let client = Woofind::new();
// Or load/build index from directory
let client = Woofind::load_or_build(Path::new("./my-project")).unwrap();
// Exact lookup
let symbols = client.lookup("NewClient");
// Fuzzy search
let results = client.fuzzy_search("NewCli", 10);
// Smart search (auto-select strategy)
let results = client.search("context", 10);
// Autocomplete
let suggestions = client.autocomplete("New", 5);use woofind::index::{IndexBuilder, InvertedIndex, QueryEngine};
use std::sync::Arc;
// Build index manually
let index = Arc::new(InvertedIndex::new());
let builder = IndexBuilder::with_index(Arc::clone(&index)).unwrap();
// Build from directory
builder.build_from_directory(Path::new("./project")).unwrap();
// Save to cache
builder.save_to_cache().unwrap();
// Create query engine
let engine = QueryEngine::new(Arc::clone(&index));
// Execute queries
let symbols = engine.exact_lookup("http.Client");
let fuzzy_results = engine.fuzzy_search("htp.Clint", 10);# Scan Go project and build index
woofind index .
# Specify output file
woofind index . --output myproject.idx
# Include private symbols
woofind index . --include-private# Exact query
woofind query "NewClient" --index myproject.idx
# Fuzzy match
woofind query "NewCli" --fuzzy
# Query in specific package
woofind query "Handler" --package "github.com/gin-gonic/gin"
# Smart search (hybrid strategy)
woofind query "ctx" --smart# Prefix completion
woofind complete "New" --index myproject.idx
# Export as JSON
woofind complete "New" --format json# HTTP service
woofind serve --port 8080 --index myproject.idx
# gRPC service
woofind grpc --port 50051┌─────────────────────────────────────────────────────────────┐
│ woofind Architecture │
├─────────────────────────────────────────────────────────────┤
│ │
│ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐ │
│ │ Parser │ │ Index │ │ Search │ │
│ │(tree-sitter)│───▶│ (Inverted) │◀───│ Engine │ │
│ │ │ │ │ │ │ │
│ └─────────────┘ └──────┬──────┘ └─────────────┘ │
│ │ │
│ ┌──────────────────────────┼──────────────────────────┐ │
│ │ Index Structure (DashMap) │ │
│ │ │ │
│ │ ┌──────────────┐ ┌──────────────┐ ┌──────────┐ │ │
│ │ │ name_index │ │ package_index│ │prefix_idx│ │ │
│ │ │ (symbol→loc) │ │ (pkg→symbols)│ │(autocomp)│ │ │
│ │ └──────────────┘ └──────────────┘ └──────────┘ │ │
│ └──────────────────────────────────────────────────────┘ │
│ │ │
│ ┌──────────────────────────┼──────────────────────────┐ │
│ │ Storage Layer │ │
│ │ │ │
│ │ ┌──────────────┐ ┌──────────────┐ ┌──────────┐ │ │
│ │ │ MmapCache │ │ File Watch │ │ Increment│ │ │
│ │ │ (mmap) │ │ (notify) │ │ Update │ │ │
│ │ └──────────────┘ └──────────────┘ └──────────┘ │ │
│ └──────────────────────────────────────────────────────┘ │
│ │
└─────────────────────────────────────────────────────────────┘
| Technology | Purpose | Effect |
|---|---|---|
| DashMap | Concurrent Index | Sharded locks, contention-free reads |
| Memmap2 | Index Loading | Zero-copy, 7ms startup |
| Tree-sitter | Go Parsing | Accurate, incremental |
| Notify | File Watching | Incremental updates |
| Nucleo | Fuzzy Matching | Intelligent ranking |
| Rayon | Parallel Indexing | Parallel builds |
User Input → woofind complete → Return candidate list
Latency: ~80μs (fuzzy match)
Experience: ✅ Instant response
# Find symbol definition
woofind jump "http.Client" --index project.idx
# Output: file path + line number + offset# Find all types implementing an interface
woofind impl "io.Reader" --project .
# Find unused exported symbols
woofind unused --package "mypkg"- name: Build symbol index
run: woofind index . --output symbols.idx
- name: Check for unused symbols
run: woofind unused --index symbols.idx --fail-on-foundContributions welcome! Please see CONTRIBUTING.md.
# Development environment
git clone https://github.com/yourusername/woofind.git
cd woofind
cargo test
cargo benchMIT License © [Your Name]
Made with ❤️ and 🦀 Rust
"woofind makes Go symbol search so fast you forget it exists."