ryo-analysis 0.1.0

Code graph and discovery engine for the RYO project
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
//! LockGranularityAnalyzerV2 - VarId-based lock granularity analysis.
//!
//! Key improvements over V1:
//! - Uses VarId instead of petgraph::NodeIndex
//! - Integrates with LockTrackerV2

use std::cmp::Reverse;

use super::{AccessKind, CriticalSectionV2, LockSuggestion, LockTrackerV2, LockType};

/// Lightweight lock granularity analyzer using LockTrackerV2 (V2 - uses VarId).
///
/// This analyzer detects:
/// - Coarse-grained locks that can be split
/// - Critical sections that are too wide
/// - Mutex that can be replaced with RwLock
/// - Locks held across await points
pub struct LockGranularityAnalyzerV2<'a> {
    tracker: &'a LockTrackerV2,
}

impl<'a> LockGranularityAnalyzerV2<'a> {
    /// Create a new analyzer.
    pub fn new(tracker: &'a LockTrackerV2) -> Self {
        Self { tracker }
    }

    /// Analyze all critical sections and generate suggestions.
    pub fn analyze(&self) -> Vec<LockSuggestion> {
        let mut suggestions = Vec::new();

        for cs in self.tracker.critical_sections() {
            suggestions.extend(self.analyze_critical_section(cs));
        }

        // Sort by severity (most important first)
        suggestions.sort_by_key(|b| Reverse(b.severity()));
        suggestions
    }

    /// Analyze a single critical section.
    fn analyze_critical_section(&self, cs: &CriticalSectionV2) -> Vec<LockSuggestion> {
        let mut suggestions = Vec::new();

        // Check for await in async lock
        if cs.contains_await {
            suggestions.push(LockSuggestion::LockAcrossAwait {
                guard_name: cs.acquisition.guard_name.clone(),
                lock_line: cs.acquisition.line,
                await_line: cs.start_line, // Approximate
            });
        }

        // Check for atomic opportunity
        suggestions.extend(self.check_atomic_opportunity(cs));

        // Check for split lock opportunity
        if let Some(split) = self.check_split_opportunity(cs) {
            suggestions.push(split);
        }

        // Check for RwLock opportunity
        if let Some(rwlock) = self.check_rwlock_opportunity(cs) {
            suggestions.push(rwlock);
        }

        // Check for scope reduction
        if let Some(reduce) = self.check_scope_reduction(cs) {
            suggestions.push(reduce);
        }

        suggestions
    }

    /// Check if a field can be replaced with atomic type.
    fn check_atomic_opportunity(&self, cs: &CriticalSectionV2) -> Vec<LockSuggestion> {
        let mut suggestions = Vec::new();
        let unique_fields = cs.unique_fields();

        // If only one field is accessed, it might be a candidate for atomic
        if unique_fields.len() == 1 {
            let field = unique_fields[0];
            let access_kind = cs.field_access_kind(field);

            // Simple heuristic: if field name suggests a counter/flag
            let suggested_type = self.suggest_atomic_type(field, access_kind);

            if let Some(atomic_type) = suggested_type {
                suggestions.push(LockSuggestion::UseAtomic {
                    field: field.to_string(),
                    current_type: None,
                    suggested_type: atomic_type,
                    line: cs.start_line,
                });
            }
        }

        suggestions
    }

    /// Suggest an atomic type based on field name and access pattern.
    fn suggest_atomic_type(&self, field: &str, _access_kind: Option<AccessKind>) -> Option<String> {
        let field_lower = field.to_lowercase();

        // Counter-like fields
        if field_lower.contains("count")
            || field_lower.contains("counter")
            || field_lower.contains("num")
            || field_lower.contains("total")
            || field_lower.contains("size")
            || field_lower.contains("len")
        {
            return Some("AtomicUsize".to_string());
        }

        // Flag-like fields
        if field_lower.contains("flag")
            || field_lower.contains("enabled")
            || field_lower.contains("active")
            || field_lower.contains("ready")
            || field_lower.contains("done")
            || field_lower.contains("is_")
        {
            return Some("AtomicBool".to_string());
        }

        // ID-like fields
        if field_lower.contains("id")
            || field_lower.contains("index")
            || field_lower.contains("seq")
        {
            return Some("AtomicU64".to_string());
        }

        None
    }

    /// Check if lock can be split into multiple finer locks.
    fn check_split_opportunity(&self, cs: &CriticalSectionV2) -> Option<LockSuggestion> {
        let unique_fields = cs.unique_fields();

        // Need at least 2 fields to consider splitting
        if unique_fields.len() < 2 {
            return None;
        }

        // Check if fields have different access patterns
        let mut suggested_splits = Vec::new();

        for field in unique_fields {
            let access_kind = cs.field_access_kind(field);
            let wrapper = match access_kind {
                Some(AccessKind::Read) => "Arc<RwLock<_>>".to_string(),
                Some(AccessKind::Write) | Some(AccessKind::ReadWrite) => {
                    "Arc<Mutex<_>>".to_string()
                }
                None => continue,
            };
            suggested_splits.push((field.to_string(), wrapper));
        }

        if suggested_splits.len() >= 2 {
            Some(LockSuggestion::SplitLock {
                lock_name: cs.acquisition.lock_name.clone(),
                suggested_splits,
                line: cs.acquisition.line,
            })
        } else {
            None
        }
    }

    /// Check if Mutex can be replaced with RwLock.
    fn check_rwlock_opportunity(&self, cs: &CriticalSectionV2) -> Option<LockSuggestion> {
        // Only suggest for Mutex (not already RwLock)
        if !matches!(
            cs.acquisition.lock_type,
            LockType::Mutex | LockType::ParkingLotMutex | LockType::TokioMutex
        ) {
            return None;
        }

        let mut read_count = 0;
        let mut write_count = 0;

        for access in &cs.field_accesses {
            match access.access_kind {
                AccessKind::Read => read_count += 1,
                AccessKind::Write => write_count += 1,
                AccessKind::ReadWrite => {
                    read_count += 1;
                    write_count += 1;
                }
            }
        }

        // Suggest RwLock if reads significantly outnumber writes
        if read_count > write_count * 2 && read_count >= 3 {
            Some(LockSuggestion::UseRwLock {
                lock_name: cs.acquisition.lock_name.clone(),
                read_count,
                write_count,
                line: cs.acquisition.line,
            })
        } else {
            None
        }
    }

    /// Check if critical section scope can be reduced.
    fn check_scope_reduction(&self, cs: &CriticalSectionV2) -> Option<LockSuggestion> {
        let end_line = cs.end_line?;
        let span = end_line.saturating_sub(cs.start_line);

        // If CS is large and contains expensive ops, suggest reduction
        if span > 5 && cs.contains_expensive_ops {
            // Find the actual usage range
            let first_access = cs.field_accesses.iter().map(|a| a.line).min()?;
            let last_access = cs.field_accesses.iter().map(|a| a.line).max()?;

            // If there's significant gap between lock and first use, or last use and unlock
            if first_access > cs.start_line + 2 || end_line > last_access + 2 {
                return Some(LockSuggestion::ReduceScope {
                    guard_name: cs.acquisition.guard_name.clone(),
                    current_span: (cs.start_line, end_line),
                    suggested_span: (first_access.saturating_sub(1), last_access + 1),
                    reason: "lock held across non-critical operations".to_string(),
                });
            }
        }

        None
    }

    /// Get lock statistics.
    pub fn stats(&self) -> LockStatsV2 {
        let sections = self.tracker.critical_sections();

        let mut mutex_count = 0;
        let mut rwlock_count = 0;
        let mut refcell_count = 0;
        let mut total_field_accesses = 0;
        let mut max_cs_span = 0u32;

        for cs in sections {
            match cs.acquisition.lock_type {
                LockType::Mutex | LockType::ParkingLotMutex | LockType::TokioMutex => {
                    mutex_count += 1
                }
                LockType::RwLockRead
                | LockType::RwLockWrite
                | LockType::ParkingLotRwLock
                | LockType::TokioRwLock => rwlock_count += 1,
                LockType::RefCell | LockType::RefCellMut => refcell_count += 1,
            }

            total_field_accesses += cs.field_accesses.len();

            if let Some(span) = cs.span() {
                max_cs_span = max_cs_span.max(span);
            }
        }

        LockStatsV2 {
            total_locks: sections.len(),
            mutex_count,
            rwlock_count,
            refcell_count,
            total_field_accesses,
            max_cs_span,
        }
    }

    /// Get the underlying LockTrackerV2.
    pub fn tracker(&self) -> &LockTrackerV2 {
        self.tracker
    }
}

/// Statistics about lock usage (V2).
#[derive(Debug, Clone, Default)]
pub struct LockStatsV2 {
    /// Total number of lock acquisitions.
    pub total_locks: usize,
    /// Number of Mutex locks.
    pub mutex_count: usize,
    /// Number of RwLock locks.
    pub rwlock_count: usize,
    /// Number of RefCell borrows.
    pub refcell_count: usize,
    /// Total field accesses within critical sections.
    pub total_field_accesses: usize,
    /// Maximum critical section span (lines).
    pub max_cs_span: u32,
}

#[cfg(test)]
mod tests {
    use super::super::{LockAcquisitionV2, VarSymbolMapping};
    use super::*;
    use crate::symbol::SymbolId;
    use crate::VarId;
    use slotmap::SlotMap;

    /// Test helper to create VarIds from a shared mapping.
    struct TestVars {
        symbols: SlotMap<SymbolId, &'static str>,
        mapping: VarSymbolMapping,
    }

    impl TestVars {
        fn new() -> Self {
            Self {
                symbols: SlotMap::with_key(),
                mapping: VarSymbolMapping::new(),
            }
        }

        fn var(&mut self, name: &'static str) -> VarId {
            let sym = self.symbols.insert(name);
            self.mapping.register(sym)
        }
    }

    #[test]
    fn test_atomic_suggestion_counter() {
        let mut tracker = LockTrackerV2::new();
        let mut vars = TestVars::new();

        let lock_var = vars.var("lock");
        let guard_var = vars.var("guard");

        // Acquire lock
        tracker.acquire(LockAcquisitionV2::new(
            lock_var,
            guard_var,
            LockType::Mutex,
            10,
            "mutex",
            "guard",
        ));

        // Access only 'counter' field
        tracker.record_field_access(guard_var, "counter", AccessKind::Write, 11);

        // Release lock
        tracker.release(guard_var, 15);

        let analyzer = LockGranularityAnalyzerV2::new(&tracker);
        let suggestions = analyzer.analyze();

        assert!(suggestions
            .iter()
            .any(|s| matches!(s, LockSuggestion::UseAtomic { field, .. } if field == "counter")));
    }

    #[test]
    fn test_rwlock_suggestion() {
        let mut tracker = LockTrackerV2::new();
        let mut vars = TestVars::new();

        let lock_var = vars.var("lock");
        let guard_var = vars.var("guard");

        tracker.acquire(LockAcquisitionV2::new(
            lock_var,
            guard_var,
            LockType::Mutex,
            10,
            "cache",
            "guard",
        ));

        // Many reads, few writes
        tracker.record_field_access(guard_var, "data", AccessKind::Read, 11);
        tracker.record_field_access(guard_var, "data", AccessKind::Read, 12);
        tracker.record_field_access(guard_var, "data", AccessKind::Read, 13);
        tracker.record_field_access(guard_var, "data", AccessKind::Read, 14);
        tracker.record_field_access(guard_var, "data", AccessKind::Write, 15);

        tracker.release(guard_var, 20);

        let analyzer = LockGranularityAnalyzerV2::new(&tracker);
        let suggestions = analyzer.analyze();

        assert!(suggestions.iter().any(
            |s| matches!(s, LockSuggestion::UseRwLock { read_count, write_count, .. }
                if *read_count == 4 && *write_count == 1)
        ));
    }

    #[test]
    fn test_split_lock_suggestion() {
        let mut tracker = LockTrackerV2::new();
        let mut vars = TestVars::new();

        let lock_var = vars.var("lock");
        let guard_var = vars.var("guard");

        tracker.acquire(LockAcquisitionV2::new(
            lock_var,
            guard_var,
            LockType::Mutex,
            10,
            "state",
            "guard",
        ));

        // Access multiple independent fields
        tracker.record_field_access(guard_var, "counter", AccessKind::Write, 11);
        tracker.record_field_access(guard_var, "name", AccessKind::Read, 12);
        tracker.record_field_access(guard_var, "config", AccessKind::Read, 13);

        tracker.release(guard_var, 20);

        let analyzer = LockGranularityAnalyzerV2::new(&tracker);
        let suggestions = analyzer.analyze();

        assert!(suggestions.iter().any(
            |s| matches!(s, LockSuggestion::SplitLock { suggested_splits, .. }
                if suggested_splits.len() == 3)
        ));
    }

    #[test]
    fn test_lock_stats() {
        let mut tracker = LockTrackerV2::new();
        let mut vars = TestVars::new();

        let lock1 = vars.var("lock1");
        let guard1 = vars.var("guard1");
        let lock2 = vars.var("lock2");
        let guard2 = vars.var("guard2");

        // Add two locks
        tracker.acquire(LockAcquisitionV2::new(
            lock1,
            guard1,
            LockType::Mutex,
            10,
            "m1",
            "g1",
        ));
        tracker.record_field_access(guard1, "field1", AccessKind::Write, 11);
        tracker.release(guard1, 15);

        tracker.acquire(LockAcquisitionV2::new(
            lock2,
            guard2,
            LockType::RwLockRead,
            20,
            "r1",
            "g2",
        ));
        tracker.record_field_access(guard2, "field2", AccessKind::Read, 21);
        tracker.release(guard2, 25);

        let analyzer = LockGranularityAnalyzerV2::new(&tracker);
        let stats = analyzer.stats();

        assert_eq!(stats.total_locks, 2);
        assert_eq!(stats.mutex_count, 1);
        assert_eq!(stats.rwlock_count, 1);
        assert_eq!(stats.total_field_accesses, 2);
    }
}