Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add fuzz target for adapter batching behavior tests. #247

Merged
merged 2 commits into from
Apr 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 8 additions & 23 deletions trustfall_core/fuzz/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 11 additions & 0 deletions trustfall_core/fuzz/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,17 @@ cargo-fuzz = true
[dependencies]
async-graphql-parser = "^2.11.3"
async-graphql-value = "^2.11.3"
byteorder = "1"
lazy_static = "1.4.0"
ron = "0.7.0"
serde = { version = "^1.0", features = ["derive"] }
libfuzzer-sys = "0.4"
trustfall_core = { path = ".." }
regex = "1.5.4"
globset = "0.4.6"
walkdir = "2.3.1"
itertools = "0.10.5"
maplit = "1.0.2"

# Prevent this from interfering with workspaces
[workspace]
Expand All @@ -33,3 +38,9 @@ name = "frontend_numbers"
path = "fuzz_targets/frontend_numbers.rs"
test = false
doc = false

[[bin]]
name = "adapter_batching"
path = "fuzz_targets/adapter_batching/mod.rs"
test = false
doc = false
273 changes: 273 additions & 0 deletions trustfall_core/fuzz/fuzz_targets/adapter_batching/mod.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,273 @@
#![no_main]
use libfuzzer_sys::fuzz_target;

use std::cell::RefCell;
use std::collections::{BTreeMap, VecDeque};
use std::io::Cursor;
use std::marker::PhantomData;
use std::path::PathBuf;
use std::rc::Rc;
use std::sync::Arc;

use byteorder::{LittleEndian, ReadBytesExt};
use globset::GlobBuilder;
use lazy_static::lazy_static;
use serde::Deserialize;
use walkdir::WalkDir;

extern crate trustfall_core;

use trustfall_core::{
interpreter::{execution::interpret_ir, Adapter},
ir::{FieldValue, IndexedQuery},
};

mod numbers_adapter;

struct VariableChunkIterator<I: Iterator> {
iter: I,
buffer: VecDeque<I::Item>,
chunk_sequence: u64,
offset: usize,
}

impl<I: Iterator> VariableChunkIterator<I> {
fn new(iter: I, chunk_sequence: u64) -> Self {
let mut value = Self {
iter,
buffer: VecDeque::with_capacity(4),
chunk_sequence,
offset: 0,
};

// Eagerly advancing the input iterator is important
// because that's how we reproduce: https://github.com/obi1kenobi/trustfall/issues/205
let chunk_size = value.next_chunk_size();
value.buffer.extend(value.iter.by_ref().take(chunk_size));
value
}

fn next_chunk_size(&mut self) -> usize {
let next_chunk = ((self.chunk_sequence >> self.offset) & 3) + 1;
if self.offset >= 62 {
self.offset = 0;
} else {
self.offset += 2;
}
assert!(next_chunk >= 1);
next_chunk as usize
}
}

impl<I: Iterator> Iterator for VariableChunkIterator<I> {
type Item = I::Item;

fn next(&mut self) -> Option<Self::Item> {
if let Some(element) = self.buffer.pop_front() {
Some(element)
} else {
let next = self.iter.next();
if next.is_some() {
let elements_to_buffer = self.next_chunk_size() - 1;
self.buffer
.extend(self.iter.by_ref().take(elements_to_buffer));
}
next
}
}
}

struct VariableBatchingAdapter<'a, AdapterT: Adapter<'a> + 'a> {
adapter: AdapterT,
cursor: Cursor<&'a [u8]>,
_marker: PhantomData<&'a ()>,
}

impl<'a, AdapterT: Adapter<'a> + 'a> VariableBatchingAdapter<'a, AdapterT> {
fn new(adapter: AdapterT, cursor: Cursor<&'a [u8]>) -> Self {
Self {
adapter,
cursor,
_marker: PhantomData,
}
}
}

impl<'a, AdapterT: Adapter<'a> + 'a> Adapter<'a> for VariableBatchingAdapter<'a, AdapterT> {
type Vertex = AdapterT::Vertex;

fn resolve_starting_vertices(
&mut self,
edge_name: &Arc<str>,
parameters: &trustfall_core::ir::EdgeParameters,
resolve_info: &trustfall_core::interpreter::ResolveInfo,
) -> trustfall_core::interpreter::VertexIterator<'a, Self::Vertex> {
let sequence = self.cursor.read_u64::<LittleEndian>().unwrap_or(0);
let inner = self
.adapter
.resolve_starting_vertices(edge_name, parameters, resolve_info);
Box::new(VariableChunkIterator::new(inner, sequence))
}

fn resolve_property(
&mut self,
contexts: trustfall_core::interpreter::ContextIterator<'a, Self::Vertex>,
type_name: &Arc<str>,
property_name: &Arc<str>,
resolve_info: &trustfall_core::interpreter::ResolveInfo,
) -> trustfall_core::interpreter::ContextOutcomeIterator<'a, Self::Vertex, FieldValue> {
let sequence = self.cursor.read_u64::<LittleEndian>().unwrap_or(0);
let inner = self.adapter.resolve_property(
Box::new(contexts),
type_name,
property_name,
resolve_info,
);
Box::new(VariableChunkIterator::new(inner, sequence))
}

fn resolve_neighbors(
&mut self,
contexts: trustfall_core::interpreter::ContextIterator<'a, Self::Vertex>,
type_name: &Arc<str>,
edge_name: &Arc<str>,
parameters: &trustfall_core::ir::EdgeParameters,
resolve_info: &trustfall_core::interpreter::ResolveEdgeInfo,
) -> trustfall_core::interpreter::ContextOutcomeIterator<
'a,
Self::Vertex,
trustfall_core::interpreter::VertexIterator<'a, Self::Vertex>,
> {
let sequence = self.cursor.read_u64::<LittleEndian>().unwrap_or(0);
let inner = self.adapter.resolve_neighbors(
contexts,
type_name,
edge_name,
parameters,
resolve_info,
);
Box::new(VariableChunkIterator::new(inner, sequence))
}

fn resolve_coercion(
&mut self,
contexts: trustfall_core::interpreter::ContextIterator<'a, Self::Vertex>,
type_name: &Arc<str>,
coerce_to_type: &Arc<str>,
resolve_info: &trustfall_core::interpreter::ResolveInfo,
) -> trustfall_core::interpreter::ContextOutcomeIterator<'a, Self::Vertex, bool> {
let sequence = self.cursor.read_u64::<LittleEndian>().unwrap_or(0);
let inner =
self.adapter
.resolve_coercion(contexts, type_name, coerce_to_type, resolve_info);
Box::new(VariableChunkIterator::new(inner, sequence))
}
}

#[derive(Debug, Clone)]
struct TestCase<'a> {
query: Arc<IndexedQuery>,
arguments: Arc<BTreeMap<Arc<str>, FieldValue>>,
cursor: Cursor<&'a [u8]>,
}

#[derive(Debug, Clone, Deserialize)]
pub(crate) struct TestIRQuery {
pub(crate) schema_name: String,

pub(crate) ir_query: trustfall_core::ir::IRQuery,

#[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
pub(crate) arguments: BTreeMap<String, FieldValue>,
}

type QueryAndArgs = (Arc<IndexedQuery>, Arc<BTreeMap<Arc<str>, FieldValue>>);

lazy_static! {
static ref QUERY_DATA: Vec<QueryAndArgs> = load_queries();
}

fn load_queries() -> Vec<QueryAndArgs> {
let mut buf = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
buf.pop();
buf.push("test_data/tests/valid_queries");
let base = buf.as_path();

let glob = GlobBuilder::new("*.ir.ron")
.case_insensitive(true)
.literal_separator(true)
.build()
.unwrap()
.compile_matcher();

let walker = WalkDir::new(base);
let mut paths = vec![];

for file in walker {
let file = file.unwrap();
let path = file.path();
let stripped_path = path.strip_prefix(base).unwrap();
if !glob.is_match(stripped_path) {
continue;
}
paths.push(PathBuf::from(path));
}
paths.sort_unstable();

let mut outputs = vec![];
for path in paths {
let contents = std::fs::read_to_string(path).expect("failed to read file");
let input_data: TestIRQuery = ron::from_str::<Result<TestIRQuery, ()>>(&contents)
.expect("failed to parse file")
.expect("Err result");
if input_data.schema_name == "numbers" {
let indexed_query = Arc::new(input_data.ir_query.try_into().unwrap());
let arguments = Arc::new(
input_data
.arguments
.into_iter()
.map(|(k, v)| (k.into(), v))
.collect(),
);
outputs.push((indexed_query, arguments));
}
}

outputs
}

impl<'a> TryFrom<&'a [u8]> for TestCase<'a> {
type Error = ();

fn try_from(value: &'a [u8]) -> Result<Self, Self::Error> {
if value.len() < 2 {
return Err(());
};
let (file_selector_bytes, rest) = value.split_at(2);
let file_selector = u16::from_le_bytes(file_selector_bytes.try_into().unwrap()) as usize;
let (query, args) = QUERY_DATA.get(file_selector).ok_or(())?;
let cursor = Cursor::new(rest);

Ok(Self {
query: query.clone(),
arguments: args.clone(),
cursor,
})
}
}

fn execute_query_with_fuzzed_batching(test_case: TestCase<'_>) {
let adapter = Rc::new(RefCell::new(VariableBatchingAdapter::new(
numbers_adapter::NumbersAdapter,
test_case.cursor,
)));
interpret_ir(adapter, test_case.query, test_case.arguments)
.unwrap()
.for_each(drop);
}

fuzz_target!(|data: &[u8]| {
if let Ok(test_case) = data.try_into() {
execute_query_with_fuzzed_batching(test_case);
}
});
Loading