Implement m_dbg_line and m_dbg_column matchers

Author: AmrDeveloper

docs/matchers/debug.md

@@ -0,0 +1,6 @@
+### Constants Instructions Matchers functions
+
+|   Function   | Parameters |   Return    |                      Description                       |
+| :----------: | :--------: | :---------: | :----------------------------------------------------: |
+|  m_dbg_line  |   (Int)    | InstMatcher |  Build Inst Matcher that match debug into line number  |
+| m_dbg_column |   (Int)    | InstMatcher | Build Inst Matcher that match debug into column number |

mkdocs.yml

@@ -99,6 +99,7 @@ nav:
     - Cast: matchers/cast.md
     - Combine: matchers/combine.md
     - Types: matchers/types.md
+    - Debug: matchers/debug.md
 
 extra:
   social:

src/functions/matchers/debug.rs

@@ -0,0 +1,50 @@
+use std::collections::HashMap;
+
+use crate::ir::types::InstMatcherType;
+use crate::ir::values::InstMatcherValue;
+use crate::matchers::debug::DebugInfoColumnMatcher;
+use crate::matchers::debug::DebugInfoLineMatcher;
+
+use gitql_ast::types::integer::IntType;
+use gitql_core::signature::Signature;
+use gitql_core::signature::StandardFunction;
+use gitql_core::values::Value;
+
+#[inline(always)]
+pub fn register_debug_inst_matchers_functions(map: &mut HashMap<&'static str, StandardFunction>) {
+    map.insert("m_dbg_line", match_debug_info_line);
+    map.insert("m_dbg_column", match_debug_info_column);
+}
+
+#[inline(always)]
+pub fn register_debug_inst_matchers_function_signatures(
+    map: &mut HashMap<&'static str, Signature>,
+) {
+    map.insert(
+        "m_dbg_line",
+        Signature {
+            parameters: vec![Box::new(IntType)],
+            return_type: Box::new(InstMatcherType),
+        },
+    );
+
+    map.insert(
+        "m_dbg_column",
+        Signature {
+            parameters: vec![Box::new(IntType)],
+            return_type: Box::new(InstMatcherType),
+        },
+    );
+}
+
+fn match_debug_info_line(values: &[Box<dyn Value>]) -> Box<dyn Value> {
+    let line = values[0].as_int().unwrap() as u32;
+    let matcher = Box::new(DebugInfoLineMatcher { line });
+    Box::new(InstMatcherValue { matcher })
+}
+
+fn match_debug_info_column(values: &[Box<dyn Value>]) -> Box<dyn Value> {
+    let column = values[0].as_int().unwrap() as u32;
+    let matcher = Box::new(DebugInfoColumnMatcher { column });
+    Box::new(InstMatcherValue { matcher })
+}

src/functions/matchers/mod.rs

@@ -4,6 +4,7 @@ pub mod call;
 pub mod cast;
 pub mod combine;
 pub mod constants;
+pub mod debug;
 pub mod exception;
 pub mod fcmp;
 pub mod icmp;

src/functions/mod.rs

@@ -21,6 +21,8 @@ use matchers::combine::register_combine_matchers_function;
 use matchers::combine::register_combine_matchers_function_signatures;
 use matchers::constants::register_constants_matchers_function_signatures;
 use matchers::constants::register_constants_matchers_functions;
+use matchers::debug::register_debug_inst_matchers_function_signatures;
+use matchers::debug::register_debug_inst_matchers_functions;
 use matchers::exception::register_exception_inst_matchers_function_signatures;
 use matchers::exception::register_exception_inst_matchers_functions;
 use matchers::fcmp::register_float_comparisons_matchers_function_signatures;
@@ -61,6 +63,7 @@ pub fn llvm_ir_functions() -> &'static HashMap<&'static str, StandardFunction> {
         register_combine_matchers_function(&mut map);
         register_call_inst_matchers_functions(&mut map);
         register_cast_matchers_function(&mut map);
+        register_debug_inst_matchers_functions(&mut map);
         map
     })
 }
@@ -81,6 +84,7 @@ pub fn llvm_ir_function_signatures() -> HashMap<&'static str, Signature> {
     register_combine_matchers_function_signatures(&mut map);
     register_call_inst_matchers_function_signatures(&mut map);
     register_cast_matchers_function_signatures(&mut map);
+    register_debug_inst_matchers_function_signatures(&mut map);
     map
 }
 

src/matchers/debug.rs

@@ -0,0 +1,29 @@
+use inkwell::llvm_sys::core::LLVMGetDebugLocColumn;
+use inkwell::llvm_sys::core::LLVMGetDebugLocLine;
+use inkwell::llvm_sys::prelude::LLVMValueRef;
+
+use super::Matcher;
+
+#[derive(Clone)]
+pub struct DebugInfoLineMatcher {
+    pub line: u32,
+}
+
+impl Matcher<LLVMValueRef> for DebugInfoLineMatcher {
+    #[allow(clippy::not_unsafe_ptr_arg_deref)]
+    fn is_match(&self, instruction: &LLVMValueRef) -> bool {
+        unsafe { self.line == LLVMGetDebugLocLine(*instruction) }
+    }
+}
+
+#[derive(Clone)]
+pub struct DebugInfoColumnMatcher {
+    pub column: u32,
+}
+
+impl Matcher<LLVMValueRef> for DebugInfoColumnMatcher {
+    #[allow(clippy::not_unsafe_ptr_arg_deref)]
+    fn is_match(&self, instruction: &LLVMValueRef) -> bool {
+        unsafe { self.column == LLVMGetDebugLocColumn(*instruction) }
+    }
+}

src/matchers/mod.rs

@@ -5,6 +5,7 @@ pub mod call;
 pub mod cast;
 pub mod combine;
 pub mod constants;
+pub mod debug;
 pub mod exception;
 pub mod fcmp;
 pub mod icmp;