dotscope 0.6.0

A high-performance, cross-platform framework for analyzing and reverse engineering .NET PE executables
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
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
//! x86 flags modeling for condition code tracking.
//!
//! This module provides infrastructure for tracking x86 flags across instructions
//! and fusing compare/test instructions with subsequent conditional jumps.
//!
//! # Overview
//!
//! x86 uses implicit flags (ZF, SF, OF, CF, PF) set by comparison and arithmetic
//! operations. Conditional jumps test these flags to determine the branch direction.
//!
//! In SSA form, we want to eliminate this implicit state by fusing:
//! - `CMP a, b` + `Jcc target` → `BranchCmp(cmp, a, b, true_target, false_target)`
//! - `TEST a, b` + `Jcc target` → `BranchCmp(eq/ne, a & b, 0, ...)`
//!
//! For Cmovcc and Setcc, we evaluate the condition into a 0/1 SSA variable.
//!
//! # Flag Dependencies
//!
//! | Condition | Flags | Meaning |
//! |-----------|-------|---------|
//! | E/NE | ZF | Equal / Not equal |
//! | L/GE | SF≠OF | Less / Greater-or-equal (signed) |
//! | LE/G | ZF or SF≠OF | Less-or-equal / Greater (signed) |
//! | B/AE | CF | Below / Above-or-equal (unsigned) |
//! | BE/A | CF or ZF | Below-or-equal / Above (unsigned) |
//! | S/NS | SF | Sign / Not sign |
//! | O/NO | OF | Overflow / Not overflow |
//!
//! # Example
//!
//! ```rust,ignore
//! use dotscope::analysis::x86::flags::{FlagState, FlagProducer};
//! use dotscope::analysis::{X86Condition, X86Operand, X86Register, SsaVarId, CmpKind};
//!
//! let mut flags = FlagState::new();
//!
//! // After CMP eax, 10
//! let v0 = SsaVarId::new();  // SSA var for eax
//! let v1 = SsaVarId::new();  // SSA var for constant 10
//! flags.set_compare(v0, v1);
//!
//! // Get SSA comparison for JL
//! let (cmp, left, right, unsigned) = flags.get_branch_operands(X86Condition::L).unwrap();
//! assert_eq!(cmp, CmpKind::Lt);
//! assert!(!unsigned);
//! ```

use crate::analysis::{
    ssa::{CmpKind, SsaVarId},
    x86::types::X86Condition,
};

/// Distinguishes arithmetic operations for overflow flag computation.
///
/// Different arithmetic operations compute the overflow flag (OF) differently:
/// - ADD: OF = sign mismatch between operands and result
/// - SUB/CMP: OF = sign mismatch in subtraction
/// - Logical ops: OF = 0 always
/// - NEG: OF = (operand == INT_MIN)
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ArithmeticKind {
    /// Addition (ADD, INC, ADC, XADD).
    Add,
    /// Subtraction (SUB, DEC, SBB, CMP).
    Sub,
    /// Logical operation (AND, OR, XOR, TEST) — OF always 0.
    LogicalOp,
    /// Negation (NEG) — OF = 1 only when operand is INT_MIN.
    Neg,
    /// Other operations (MUL, DIV, shifts) — OF undefined or complex.
    Other,
}

/// Source of a value for sign/parity flag testing.
///
/// This tells the SSA emitter how to obtain the value whose sign bit
/// or parity should be tested.
#[derive(Debug, Clone)]
pub enum FlagTestSource {
    /// Use an existing SSA variable directly (from arithmetic result).
    Direct(SsaVarId),
    /// Compute left - right (from CMP instruction).
    Subtract {
        /// Left operand of the subtraction.
        left: SsaVarId,
        /// Right operand of the subtraction.
        right: SsaVarId,
    },
    /// Compute left & right (from TEST instruction).
    BitwiseAnd {
        /// Left operand of the AND.
        left: SsaVarId,
        /// Right operand of the AND.
        right: SsaVarId,
    },
}

/// Represents what instruction last set the flags.
///
/// This tracks the operands from the most recent flag-setting instruction
/// so they can be used when translating a subsequent conditional jump.
#[derive(Debug, Clone)]
pub enum FlagProducer {
    /// Flags set by a CMP instruction: `cmp left, right` (computes left - right).
    ///
    /// The operands are SSA variable IDs representing the compared values.
    Compare {
        /// Left operand of the comparison (minuend).
        left: SsaVarId,
        /// Right operand of the comparison (subtrahend).
        right: SsaVarId,
    },

    /// Flags set by a TEST instruction: `test left, right` (computes left & right).
    ///
    /// TEST sets ZF based on whether (left & right) == 0.
    Test {
        /// Left operand of the test.
        left: SsaVarId,
        /// Right operand of the test.
        right: SsaVarId,
    },

    /// Flags set by an arithmetic/bitwise operation.
    ///
    /// These instructions set flags as a side effect. The result variable
    /// can be used for simple zero/sign tests.
    Arithmetic {
        /// The result of the arithmetic operation.
        result: SsaVarId,
        /// The left operand of the operation (needed for signed overflow detection).
        left: SsaVarId,
        /// The right operand of the operation (needed for signed overflow detection).
        right: SsaVarId,
        /// What kind of arithmetic produced these flags (needed for OF computation).
        kind: ArithmeticKind,
    },
}

/// Tracks the current state of x86 flags for SSA translation.
///
/// This state is maintained per basic block during translation and is used
/// to fuse compare/test instructions with subsequent conditional jumps,
/// and to evaluate conditions for Cmovcc and Setcc.
///
/// # Flag Tracking Strategy
///
/// Rather than tracking each flag (ZF, SF, OF, CF) as individual SSA variables,
/// we use two complementary approaches:
///
/// 1. **FlagProducer**: Records the source instruction and its operands.
///    This allows on-demand condition evaluation for Jcc/Cmovcc/Setcc by
///    producing the right comparison (Clt/Cgt/Ceq) when needed.
///
/// 2. **Carry flag (CF)**: Tracked explicitly as an SSA variable because it
///    is consumed by ADC and SBB which need the actual 0/1 value.
///
/// This hybrid approach avoids emitting unused flag computations while still
/// providing correct flag semantics.
#[derive(Debug, Clone, Default)]
pub struct FlagState {
    /// The instruction that last set the flags, if any.
    producer: Option<FlagProducer>,
    /// The current carry flag (CF) as an SSA variable holding 0 or 1.
    ///
    /// Set by:
    /// - ADD/ADC: CF = (result < left) unsigned (unsigned overflow)
    /// - SUB/SBB/CMP: CF = (left < right) unsigned (borrow)
    /// - AND/OR/XOR/TEST: CF = 0
    /// - NEG: CF = (operand != 0)
    ///
    /// Consumed by:
    /// - ADC: dest = left + right + CF
    /// - SBB: dest = left - right - CF
    ///
    /// Preserved by:
    /// - INC/DEC (do NOT modify CF)
    carry: Option<SsaVarId>,
}

impl FlagState {
    /// Creates a new flag state with no known flags.
    #[must_use]
    pub fn new() -> Self {
        Self {
            producer: None,
            carry: None,
        }
    }

    /// Records that a CMP instruction set the flags.
    ///
    /// # Arguments
    ///
    /// * `left` - SSA variable for the left operand
    /// * `right` - SSA variable for the right operand
    pub fn set_compare(&mut self, left: SsaVarId, right: SsaVarId) {
        self.producer = Some(FlagProducer::Compare { left, right });
    }

    /// Records that a TEST instruction set the flags.
    ///
    /// # Arguments
    ///
    /// * `left` - SSA variable for the left operand
    /// * `right` - SSA variable for the right operand
    pub fn set_test(&mut self, left: SsaVarId, right: SsaVarId) {
        self.producer = Some(FlagProducer::Test { left, right });
    }

    /// Records that an arithmetic operation set the flags.
    ///
    /// Stores the result, both operands, and the arithmetic kind so that
    /// all flag conditions (including S/NS/O/NO/P/NP) can be properly evaluated.
    pub fn set_arithmetic(
        &mut self,
        result: SsaVarId,
        left: SsaVarId,
        right: SsaVarId,
        kind: ArithmeticKind,
    ) {
        self.producer = Some(FlagProducer::Arithmetic {
            result,
            left,
            right,
            kind,
        });
    }

    /// Records that a NEG operation set the flags.
    ///
    /// For NEG, the result is the only meaningful value. OF is set only
    /// when the original operand was INT_MIN.
    pub fn set_arithmetic_unary(&mut self, result: SsaVarId) {
        self.producer = Some(FlagProducer::Arithmetic {
            result,
            left: result,
            right: result,
            kind: ArithmeticKind::Neg,
        });
    }

    /// Clears the flag state (flags are now unknown).
    /// Also clears the carry flag.
    pub fn clear(&mut self) {
        self.producer = None;
        self.carry = None;
    }

    /// Clears only the producer (for instructions like MOV that don't set flags)
    /// without affecting the carry flag.
    pub fn clear_producer(&mut self) {
        self.producer = None;
    }

    /// Sets the carry flag to a specific SSA variable (must hold 0 or 1).
    pub fn set_carry(&mut self, carry: SsaVarId) {
        self.carry = Some(carry);
    }

    /// Clears the carry flag to a specific SSA variable representing zero.
    /// Used after AND/OR/XOR/TEST which always clear CF.
    pub fn clear_carry(&mut self, zero: SsaVarId) {
        self.carry = Some(zero);
    }

    /// Returns the current carry flag SSA variable, if known.
    #[must_use]
    pub fn carry(&self) -> Option<SsaVarId> {
        self.carry
    }

    /// Returns the current flag producer, if any.
    #[must_use]
    pub fn producer(&self) -> Option<&FlagProducer> {
        self.producer.as_ref()
    }

    /// Returns true if flags are currently known (set by a tracked instruction).
    #[must_use]
    pub fn is_known(&self) -> bool {
        self.producer.is_some()
    }

    /// Converts an x86 condition to SSA comparison operands for `BranchCmp`.
    ///
    /// Returns the comparison kind, operands, and whether to use unsigned comparison.
    /// Returns `None` if the flags are unknown or the condition cannot be translated.
    ///
    /// # Arguments
    ///
    /// * `condition` - The x86 condition code to translate
    ///
    /// # Returns
    ///
    /// A tuple of `(CmpKind, left, right, unsigned)` for use in `SsaOp::BranchCmp`.
    #[must_use]
    pub fn get_branch_operands(
        &self,
        condition: X86Condition,
    ) -> Option<(CmpKind, SsaVarId, SsaVarId, bool)> {
        match &self.producer {
            Some(FlagProducer::Compare { left, right }) => {
                let (cmp, unsigned) = condition_to_cmp(condition)?;
                Some((cmp, *left, *right, unsigned))
            }
            Some(FlagProducer::Test { left, right }) => {
                // TEST sets ZF = ((left & right) == 0)
                // For E/NE conditions, we can translate directly
                match condition {
                    X86Condition::E => {
                        // JE after TEST: branch if (left & right) == 0
                        Some((CmpKind::Eq, *left, *right, false))
                    }
                    X86Condition::Ne => {
                        // JNE after TEST: branch if (left & right) != 0
                        Some((CmpKind::Ne, *left, *right, false))
                    }
                    // S/NS after TEST: test sign bit of (left & right)
                    // These are handled by the caller computing AND first
                    X86Condition::S | X86Condition::Ns => None,
                    _ => None,
                }
            }
            Some(FlagProducer::Arithmetic {
                result,
                left,
                right,
                ..
            }) => {
                // Arithmetic ops set ZF/SF based on result
                match condition {
                    // Zero flag: result == 0
                    X86Condition::E => Some((CmpKind::Eq, *result, *result, false)),
                    X86Condition::Ne => Some((CmpKind::Ne, *result, *result, false)),
                    // For signed comparisons after arithmetic, we use the original
                    // operands since CIL comparison handles the signed semantics.
                    // This works because ADD/SUB set flags based on (left op right).
                    X86Condition::L | X86Condition::Ge | X86Condition::Le | X86Condition::G => {
                        let (cmp, unsigned) = condition_to_cmp(condition)?;
                        Some((cmp, *left, *right, unsigned))
                    }
                    // Unsigned comparisons after arithmetic
                    X86Condition::B | X86Condition::Ae | X86Condition::Be | X86Condition::A => {
                        let (cmp, unsigned) = condition_to_cmp(condition)?;
                        Some((cmp, *left, *right, unsigned))
                    }
                    // S/NS/O/NO/P/NP handled via evaluate_condition fallback
                    _ => None,
                }
            }
            None => None,
        }
    }

    /// Returns the condition evaluation info for producing a 0/1 SSA value.
    ///
    /// Used by Cmovcc, Setcc, and the Jcc fallback to evaluate conditions into
    /// values rather than branches. Handles all 16 x86 condition codes including
    /// S/NS (sign), O/NO (overflow), and P/NP (parity).
    #[must_use]
    pub fn get_condition_operands(&self, condition: X86Condition) -> Option<ConditionEval> {
        match &self.producer {
            Some(FlagProducer::Compare { left, right }) => match condition {
                X86Condition::S => Some(ConditionEval::SignFlag {
                    source: FlagTestSource::Subtract {
                        left: *left,
                        right: *right,
                    },
                    negated: false,
                }),
                X86Condition::Ns => Some(ConditionEval::SignFlag {
                    source: FlagTestSource::Subtract {
                        left: *left,
                        right: *right,
                    },
                    negated: true,
                }),
                X86Condition::O => Some(ConditionEval::OverflowFlag {
                    left: *left,
                    right: *right,
                    result: None,
                    kind: ArithmeticKind::Sub,
                    negated: false,
                }),
                X86Condition::No => Some(ConditionEval::OverflowFlag {
                    left: *left,
                    right: *right,
                    result: None,
                    kind: ArithmeticKind::Sub,
                    negated: true,
                }),
                X86Condition::P => Some(ConditionEval::ParityFlag {
                    source: FlagTestSource::Subtract {
                        left: *left,
                        right: *right,
                    },
                    negated: false,
                }),
                X86Condition::Np => Some(ConditionEval::ParityFlag {
                    source: FlagTestSource::Subtract {
                        left: *left,
                        right: *right,
                    },
                    negated: true,
                }),
                _ => {
                    let (cmp, unsigned) = condition_to_cmp(condition)?;
                    Some(ConditionEval::Compare {
                        cmp,
                        left: *left,
                        right: *right,
                        unsigned,
                    })
                }
            },
            Some(FlagProducer::Test { left, right }) => match condition {
                X86Condition::E => Some(ConditionEval::Test {
                    cmp: CmpKind::Eq,
                    left: *left,
                    right: *right,
                }),
                X86Condition::Ne => Some(ConditionEval::Test {
                    cmp: CmpKind::Ne,
                    left: *left,
                    right: *right,
                }),
                X86Condition::S => Some(ConditionEval::SignFlag {
                    source: FlagTestSource::BitwiseAnd {
                        left: *left,
                        right: *right,
                    },
                    negated: false,
                }),
                X86Condition::Ns => Some(ConditionEval::SignFlag {
                    source: FlagTestSource::BitwiseAnd {
                        left: *left,
                        right: *right,
                    },
                    negated: true,
                }),
                X86Condition::O => Some(ConditionEval::OverflowFlag {
                    left: *left,
                    right: *right,
                    result: None,
                    kind: ArithmeticKind::LogicalOp,
                    negated: false,
                }),
                X86Condition::No => Some(ConditionEval::OverflowFlag {
                    left: *left,
                    right: *right,
                    result: None,
                    kind: ArithmeticKind::LogicalOp,
                    negated: true,
                }),
                X86Condition::P => Some(ConditionEval::ParityFlag {
                    source: FlagTestSource::BitwiseAnd {
                        left: *left,
                        right: *right,
                    },
                    negated: false,
                }),
                X86Condition::Np => Some(ConditionEval::ParityFlag {
                    source: FlagTestSource::BitwiseAnd {
                        left: *left,
                        right: *right,
                    },
                    negated: true,
                }),
                _ => None,
            },
            Some(FlagProducer::Arithmetic {
                result,
                left,
                right,
                kind,
            }) => match condition {
                X86Condition::E => Some(ConditionEval::ZeroTest {
                    cmp: CmpKind::Eq,
                    result: *result,
                }),
                X86Condition::Ne => Some(ConditionEval::ZeroTest {
                    cmp: CmpKind::Ne,
                    result: *result,
                }),
                X86Condition::S => Some(ConditionEval::SignFlag {
                    source: FlagTestSource::Direct(*result),
                    negated: false,
                }),
                X86Condition::Ns => Some(ConditionEval::SignFlag {
                    source: FlagTestSource::Direct(*result),
                    negated: true,
                }),
                X86Condition::O => Some(ConditionEval::OverflowFlag {
                    left: *left,
                    right: *right,
                    result: Some(*result),
                    kind: *kind,
                    negated: false,
                }),
                X86Condition::No => Some(ConditionEval::OverflowFlag {
                    left: *left,
                    right: *right,
                    result: Some(*result),
                    kind: *kind,
                    negated: true,
                }),
                X86Condition::P => Some(ConditionEval::ParityFlag {
                    source: FlagTestSource::Direct(*result),
                    negated: false,
                }),
                X86Condition::Np => Some(ConditionEval::ParityFlag {
                    source: FlagTestSource::Direct(*result),
                    negated: true,
                }),
                _ => {
                    let (cmp, unsigned) = condition_to_cmp(condition)?;
                    Some(ConditionEval::Compare {
                        cmp,
                        left: *left,
                        right: *right,
                        unsigned,
                    })
                }
            },
            None => None,
        }
    }

    /// Checks if the flags are from a TEST instruction with the same operand.
    ///
    /// Pattern: `TEST reg, reg` followed by `JE/JNE` is testing if reg == 0.
    #[must_use]
    pub fn is_zero_test(&self) -> Option<SsaVarId> {
        match &self.producer {
            Some(FlagProducer::Test { left, right }) if left == right => Some(*left),
            _ => None,
        }
    }
}

/// Describes how to evaluate an x86 condition into a 0/1 SSA value.
///
/// Used by the translator to emit the right SSA instructions for Jcc/Cmovcc/Setcc.
#[derive(Debug, Clone)]
pub enum ConditionEval {
    /// Direct comparison: emit Clt/Cgt/Ceq on left vs right.
    Compare {
        cmp: CmpKind,
        left: SsaVarId,
        right: SsaVarId,
        unsigned: bool,
    },
    /// TEST pattern: emit AND(left, right), then compare result to zero.
    Test {
        cmp: CmpKind,
        left: SsaVarId,
        right: SsaVarId,
    },
    /// Zero test on arithmetic result: compare result to zero.
    ZeroTest { cmp: CmpKind, result: SsaVarId },
    /// Sign flag test: extract MSB of value.
    ///
    /// S (negated=false): result is 1 when SF=1 (negative).
    /// NS (negated=true): result is 1 when SF=0 (non-negative).
    SignFlag {
        source: FlagTestSource,
        negated: bool,
    },
    /// Overflow flag test: signed overflow detection.
    ///
    /// O (negated=false): result is 1 when OF=1 (overflow occurred).
    /// NO (negated=true): result is 1 when OF=0 (no overflow).
    OverflowFlag {
        left: SsaVarId,
        right: SsaVarId,
        /// None for CMP (must emit Sub), Some for arithmetic operations.
        result: Option<SsaVarId>,
        kind: ArithmeticKind,
        negated: bool,
    },
    /// Parity flag test: even parity of low byte.
    ///
    /// P (negated=false): result is 1 when PF=1 (even parity).
    /// NP (negated=true): result is 1 when PF=0 (odd parity).
    ParityFlag {
        source: FlagTestSource,
        negated: bool,
    },
}

/// Converts an x86 condition code to an SSA comparison kind.
///
/// Returns the `CmpKind` and a boolean indicating whether the comparison
/// should be unsigned.
///
/// # Arguments
///
/// * `condition` - The x86 condition code
///
/// # Returns
///
/// `Some((CmpKind, unsigned))` for translatable conditions, `None` for
/// conditions that require special handling (parity, overflow-only, etc.).
#[must_use]
pub fn condition_to_cmp(condition: X86Condition) -> Option<(CmpKind, bool)> {
    match condition {
        // Equality (works for both signed and unsigned)
        X86Condition::E => Some((CmpKind::Eq, false)),
        X86Condition::Ne => Some((CmpKind::Ne, false)),

        // Signed comparisons
        X86Condition::L => Some((CmpKind::Lt, false)),
        X86Condition::Ge => Some((CmpKind::Ge, false)),
        X86Condition::Le => Some((CmpKind::Le, false)),
        X86Condition::G => Some((CmpKind::Gt, false)),

        // Unsigned comparisons
        X86Condition::B => Some((CmpKind::Lt, true)),
        X86Condition::Ae => Some((CmpKind::Ge, true)),
        X86Condition::Be => Some((CmpKind::Le, true)),
        X86Condition::A => Some((CmpKind::Gt, true)),

        // Sign/Overflow/Parity require special handling
        X86Condition::S
        | X86Condition::Ns
        | X86Condition::O
        | X86Condition::No
        | X86Condition::P
        | X86Condition::Np => None,
    }
}

/// Returns true if the condition tests only the zero flag (ZF).
#[must_use]
pub const fn is_zero_flag_only(condition: X86Condition) -> bool {
    matches!(condition, X86Condition::E | X86Condition::Ne)
}

/// Returns true if the condition uses signed comparison semantics.
#[must_use]
pub const fn is_signed_condition(condition: X86Condition) -> bool {
    matches!(
        condition,
        X86Condition::L | X86Condition::Ge | X86Condition::Le | X86Condition::G
    )
}

/// Returns true if the condition uses unsigned comparison semantics.
#[must_use]
pub const fn is_unsigned_condition(condition: X86Condition) -> bool {
    matches!(
        condition,
        X86Condition::B | X86Condition::Ae | X86Condition::Be | X86Condition::A
    )
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_flag_state_compare() {
        let mut flags = FlagState::new();
        assert!(!flags.is_known());

        let v0 = SsaVarId::new();
        let v1 = SsaVarId::new();
        flags.set_compare(v0, v1);

        assert!(flags.is_known());

        // Test signed conditions
        let (cmp, left, right, unsigned) = flags.get_branch_operands(X86Condition::L).unwrap();
        assert_eq!(cmp, CmpKind::Lt);
        assert_eq!(left, v0);
        assert_eq!(right, v1);
        assert!(!unsigned);

        // Test unsigned conditions
        let (cmp, _, _, unsigned) = flags.get_branch_operands(X86Condition::B).unwrap();
        assert_eq!(cmp, CmpKind::Lt);
        assert!(unsigned);
    }

    #[test]
    fn test_flag_state_test() {
        let mut flags = FlagState::new();

        let v0 = SsaVarId::new();
        let v1 = SsaVarId::new();
        flags.set_test(v0, v1);

        // E/NE work with TEST
        let result = flags.get_branch_operands(X86Condition::E);
        assert!(result.is_some());

        let result = flags.get_branch_operands(X86Condition::Ne);
        assert!(result.is_some());

        // Signed comparisons don't work directly with TEST
        let result = flags.get_branch_operands(X86Condition::L);
        assert!(result.is_none());
    }

    #[test]
    fn test_zero_test_pattern() {
        let mut flags = FlagState::new();

        let v0 = SsaVarId::new();
        flags.set_test(v0, v0);

        assert_eq!(flags.is_zero_test(), Some(v0));

        // Different operands - not a zero test
        let v1 = SsaVarId::new();
        flags.set_test(v0, v1);
        assert!(flags.is_zero_test().is_none());
    }

    #[test]
    fn test_condition_to_cmp() {
        // Equality
        assert_eq!(
            condition_to_cmp(X86Condition::E),
            Some((CmpKind::Eq, false))
        );
        assert_eq!(
            condition_to_cmp(X86Condition::Ne),
            Some((CmpKind::Ne, false))
        );

        // Signed
        assert_eq!(
            condition_to_cmp(X86Condition::L),
            Some((CmpKind::Lt, false))
        );
        assert_eq!(
            condition_to_cmp(X86Condition::G),
            Some((CmpKind::Gt, false))
        );

        // Unsigned
        assert_eq!(condition_to_cmp(X86Condition::B), Some((CmpKind::Lt, true)));
        assert_eq!(condition_to_cmp(X86Condition::A), Some((CmpKind::Gt, true)));

        // Unsupported
        assert!(condition_to_cmp(X86Condition::P).is_none());
        assert!(condition_to_cmp(X86Condition::O).is_none());
    }

    #[test]
    fn test_flag_state_clear() {
        let mut flags = FlagState::new();
        flags.set_compare(SsaVarId::new(), SsaVarId::new());
        assert!(flags.is_known());

        flags.clear();
        assert!(!flags.is_known());
    }

    #[test]
    fn test_condition_classification() {
        assert!(is_zero_flag_only(X86Condition::E));
        assert!(is_zero_flag_only(X86Condition::Ne));
        assert!(!is_zero_flag_only(X86Condition::L));

        assert!(is_signed_condition(X86Condition::L));
        assert!(is_signed_condition(X86Condition::G));
        assert!(!is_signed_condition(X86Condition::B));

        assert!(is_unsigned_condition(X86Condition::B));
        assert!(is_unsigned_condition(X86Condition::A));
        assert!(!is_unsigned_condition(X86Condition::L));
    }

    #[test]
    fn test_carry_flag_tracking() {
        let mut flags = FlagState::new();
        assert!(flags.carry().is_none());

        let cf = SsaVarId::new();
        flags.set_carry(cf);
        assert_eq!(flags.carry(), Some(cf));

        let zero = SsaVarId::new();
        flags.clear_carry(zero);
        assert_eq!(flags.carry(), Some(zero));

        flags.clear();
        assert!(flags.carry().is_none());
    }

    #[test]
    fn test_arithmetic_with_signed_conditions() {
        let mut flags = FlagState::new();

        let result = SsaVarId::new();
        let left = SsaVarId::new();
        let right = SsaVarId::new();
        flags.set_arithmetic(result, left, right, ArithmeticKind::Add);

        // Zero test should work
        let branch = flags.get_branch_operands(X86Condition::E);
        assert!(branch.is_some());

        // Signed conditions should also work (using original operands)
        let branch = flags.get_branch_operands(X86Condition::L);
        assert!(branch.is_some());
        let (cmp, l, r, unsigned) = branch.unwrap();
        assert_eq!(cmp, CmpKind::Lt);
        assert_eq!(l, left);
        assert_eq!(r, right);
        assert!(!unsigned);
    }

    #[test]
    fn test_condition_eval() {
        let mut flags = FlagState::new();

        let v0 = SsaVarId::new();
        let v1 = SsaVarId::new();
        flags.set_compare(v0, v1);

        let eval = flags.get_condition_operands(X86Condition::L);
        assert!(eval.is_some());
        assert!(matches!(eval.unwrap(), ConditionEval::Compare { .. }));

        // TEST pattern
        flags.set_test(v0, v1);
        let eval = flags.get_condition_operands(X86Condition::E);
        assert!(eval.is_some());
        assert!(matches!(eval.unwrap(), ConditionEval::Test { .. }));
    }

    #[test]
    fn test_sign_flag_from_compare() {
        let mut flags = FlagState::new();
        let v0 = SsaVarId::new();
        let v1 = SsaVarId::new();
        flags.set_compare(v0, v1);

        // S condition should produce SignFlag with Subtract source
        let eval = flags.get_condition_operands(X86Condition::S);
        assert!(eval.is_some());
        assert!(matches!(
            eval.unwrap(),
            ConditionEval::SignFlag {
                source: FlagTestSource::Subtract { .. },
                negated: false,
            }
        ));

        // NS should be negated
        let eval = flags.get_condition_operands(X86Condition::Ns);
        assert!(matches!(
            eval.unwrap(),
            ConditionEval::SignFlag { negated: true, .. }
        ));
    }

    #[test]
    fn test_sign_flag_from_test() {
        let mut flags = FlagState::new();
        let v0 = SsaVarId::new();
        let v1 = SsaVarId::new();
        flags.set_test(v0, v1);

        let eval = flags.get_condition_operands(X86Condition::S);
        assert!(matches!(
            eval.unwrap(),
            ConditionEval::SignFlag {
                source: FlagTestSource::BitwiseAnd { .. },
                negated: false,
            }
        ));
    }

    #[test]
    fn test_sign_flag_from_arithmetic() {
        let mut flags = FlagState::new();
        let result = SsaVarId::new();
        let left = SsaVarId::new();
        let right = SsaVarId::new();
        flags.set_arithmetic(result, left, right, ArithmeticKind::Add);

        let eval = flags.get_condition_operands(X86Condition::S);
        assert!(matches!(
            eval.unwrap(),
            ConditionEval::SignFlag {
                source: FlagTestSource::Direct(_),
                negated: false,
            }
        ));
    }

    #[test]
    fn test_overflow_flag_from_compare() {
        let mut flags = FlagState::new();
        let v0 = SsaVarId::new();
        let v1 = SsaVarId::new();
        flags.set_compare(v0, v1);

        let eval = flags.get_condition_operands(X86Condition::O);
        assert!(eval.is_some());
        match eval.unwrap() {
            ConditionEval::OverflowFlag {
                result,
                kind,
                negated,
                ..
            } => {
                assert!(result.is_none()); // CMP has no stored result
                assert_eq!(kind, ArithmeticKind::Sub);
                assert!(!negated);
            }
            other => panic!("Expected OverflowFlag, got {other:?}"),
        }

        // NO should be negated
        let eval = flags.get_condition_operands(X86Condition::No);
        assert!(matches!(
            eval.unwrap(),
            ConditionEval::OverflowFlag { negated: true, .. }
        ));
    }

    #[test]
    fn test_overflow_flag_from_test() {
        let mut flags = FlagState::new();
        let v0 = SsaVarId::new();
        let v1 = SsaVarId::new();
        flags.set_test(v0, v1);

        // TEST always clears OF, so OverflowFlag with LogicalOp kind
        let eval = flags.get_condition_operands(X86Condition::O);
        assert!(matches!(
            eval.unwrap(),
            ConditionEval::OverflowFlag {
                kind: ArithmeticKind::LogicalOp,
                negated: false,
                ..
            }
        ));
    }

    #[test]
    fn test_overflow_flag_from_arithmetic() {
        let mut flags = FlagState::new();
        let result = SsaVarId::new();
        let left = SsaVarId::new();
        let right = SsaVarId::new();
        flags.set_arithmetic(result, left, right, ArithmeticKind::Add);

        let eval = flags.get_condition_operands(X86Condition::O);
        match eval.unwrap() {
            ConditionEval::OverflowFlag {
                result: r,
                kind,
                negated,
                ..
            } => {
                assert!(r.is_some());
                assert_eq!(kind, ArithmeticKind::Add);
                assert!(!negated);
            }
            other => panic!("Expected OverflowFlag, got {other:?}"),
        }
    }

    #[test]
    fn test_parity_flag_from_compare() {
        let mut flags = FlagState::new();
        let v0 = SsaVarId::new();
        let v1 = SsaVarId::new();
        flags.set_compare(v0, v1);

        let eval = flags.get_condition_operands(X86Condition::P);
        assert!(matches!(
            eval.unwrap(),
            ConditionEval::ParityFlag {
                source: FlagTestSource::Subtract { .. },
                negated: false,
            }
        ));

        let eval = flags.get_condition_operands(X86Condition::Np);
        assert!(matches!(
            eval.unwrap(),
            ConditionEval::ParityFlag { negated: true, .. }
        ));
    }

    #[test]
    fn test_parity_flag_from_test() {
        let mut flags = FlagState::new();
        let v0 = SsaVarId::new();
        let v1 = SsaVarId::new();
        flags.set_test(v0, v1);

        let eval = flags.get_condition_operands(X86Condition::P);
        assert!(matches!(
            eval.unwrap(),
            ConditionEval::ParityFlag {
                source: FlagTestSource::BitwiseAnd { .. },
                negated: false,
            }
        ));
    }

    #[test]
    fn test_branch_operands_still_none_for_flag_conditions() {
        let mut flags = FlagState::new();
        flags.set_compare(SsaVarId::new(), SsaVarId::new());

        // S/NS/O/NO/P/NP should still return None from get_branch_operands
        // (these go through evaluate_condition fallback in Jcc handler)
        assert!(flags.get_branch_operands(X86Condition::S).is_none());
        assert!(flags.get_branch_operands(X86Condition::Ns).is_none());
        assert!(flags.get_branch_operands(X86Condition::O).is_none());
        assert!(flags.get_branch_operands(X86Condition::No).is_none());
        assert!(flags.get_branch_operands(X86Condition::P).is_none());
        assert!(flags.get_branch_operands(X86Condition::Np).is_none());

        // But the standard conditions should still work
        assert!(flags.get_branch_operands(X86Condition::E).is_some());
        assert!(flags.get_branch_operands(X86Condition::L).is_some());
    }

    #[test]
    fn test_arithmetic_kind_neg() {
        let mut flags = FlagState::new();
        let result = SsaVarId::new();
        flags.set_arithmetic_unary(result);

        // Should have Neg kind
        let eval = flags.get_condition_operands(X86Condition::O);
        match eval.unwrap() {
            ConditionEval::OverflowFlag { kind, .. } => {
                assert_eq!(kind, ArithmeticKind::Neg);
            }
            other => panic!("Expected OverflowFlag, got {other:?}"),
        }
    }
}