abi.rs 8.13 KB
Newer Older
Sebastian Dröge's avatar
Sebastian Dröge committed
1 2
// This file was generated by gir (https://github.com/gtk-rs/gir @ d1e88f9)
// from gir-files (https://github.com/gtk-rs/gir-files @ 63dd366)
3 4 5 6
// DO NOT EDIT

extern crate gstreamer_check_sys;
extern crate shell_words;
7
extern crate tempfile;
8
use gstreamer_check_sys::*;
9 10 11
use std::env;
use std::error::Error;
use std::mem::{align_of, size_of};
12
use std::path::Path;
13 14
use std::process::Command;
use std::str;
15
use tempfile::Builder;
16 17 18 19 20 21 22 23 24

static PACKAGES: &[&str] = &["gstreamer-check-1.0"];

#[derive(Clone, Debug)]
struct Compiler {
    pub args: Vec<String>,
}

impl Compiler {
25
    pub fn new() -> Result<Compiler, Box<dyn Error>> {
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
        let mut args = get_var("CC", "cc")?;
        args.push("-Wno-deprecated-declarations".to_owned());
        // For %z support in printf when using MinGW.
        args.push("-D__USE_MINGW_ANSI_STDIO".to_owned());
        args.extend(get_var("CFLAGS", "")?);
        args.extend(get_var("CPPFLAGS", "")?);
        args.extend(pkg_config_cflags(PACKAGES)?);
        Ok(Compiler { args })
    }

    pub fn define<'a, V: Into<Option<&'a str>>>(&mut self, var: &str, val: V) {
        let arg = match val.into() {
            None => format!("-D{}", var),
            Some(val) => format!("-D{}={}", var, val),
        };
        self.args.push(arg);
    }

44
    pub fn compile(&self, src: &Path, out: &Path) -> Result<(), Box<dyn Error>> {
45 46 47 48 49 50
        let mut cmd = self.to_command();
        cmd.arg(src);
        cmd.arg("-o");
        cmd.arg(out);
        let status = cmd.spawn()?.wait()?;
        if !status.success() {
51
            return Err(format!("compilation command {:?} failed, {}", &cmd, status).into());
52 53 54 55 56 57 58 59 60 61 62
        }
        Ok(())
    }

    fn to_command(&self) -> Command {
        let mut cmd = Command::new(&self.args[0]);
        cmd.args(&self.args[1..]);
        cmd
    }
}

63
fn get_var(name: &str, default: &str) -> Result<Vec<String>, Box<dyn Error>> {
64 65 66 67 68 69 70
    match env::var(name) {
        Ok(value) => Ok(shell_words::split(&value)?),
        Err(env::VarError::NotPresent) => Ok(shell_words::split(default)?),
        Err(err) => Err(format!("{} {}", name, err).into()),
    }
}

71
fn pkg_config_cflags(packages: &[&str]) -> Result<Vec<String>, Box<dyn Error>> {
72 73 74 75 76 77 78 79
    if packages.is_empty() {
        return Ok(Vec::new());
    }
    let mut cmd = Command::new("pkg-config");
    cmd.arg("--cflags");
    cmd.args(packages);
    let out = cmd.output()?;
    if !out.status.success() {
80
        return Err(format!("command {:?} returned {}", &cmd, out.status).into());
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
    }
    let stdout = str::from_utf8(&out.stdout)?;
    Ok(shell_words::split(stdout.trim())?)
}

#[derive(Copy, Clone, Debug, Eq, PartialEq)]
struct Layout {
    size: usize,
    alignment: usize,
}

#[derive(Copy, Clone, Debug, Default, Eq, PartialEq)]
struct Results {
    /// Number of successfully completed tests.
    passed: usize,
    /// Total number of failed tests (including those that failed to compile).
    failed: usize,
    /// Number of tests that failed to compile.
    failed_to_compile: usize,
}

impl Results {
    fn record_passed(&mut self) {
        self.passed += 1;
    }
    fn record_failed(&mut self) {
        self.failed += 1;
    }
    fn record_failed_to_compile(&mut self) {
        self.failed += 1;
        self.failed_to_compile += 1;
    }
    fn summary(&self) -> String {
        format!(
            "{} passed; {} failed (compilation errors: {})",
116 117
            self.passed, self.failed, self.failed_to_compile
        )
118 119 120 121 122 123 124 125 126 127 128 129
    }
    fn expect_total_success(&self) {
        if self.failed == 0 {
            println!("OK: {}", self.summary());
        } else {
            panic!("FAILED: {}", self.summary());
        };
    }
}

#[test]
fn cross_validate_constants_with_c() {
130 131 132 133
    let tmpdir = Builder::new()
        .prefix("abi")
        .tempdir()
        .expect("temporary directory");
134 135
    let cc = Compiler::new().expect("configured compiler");

136 137 138 139 140
    assert_eq!(
        "1",
        get_c_value(tmpdir.path(), &cc, "1").expect("C constant"),
        "failed to obtain correct constant value for 1"
    );
141

142
    let mut results: Results = Default::default();
143 144 145 146 147
    for (i, &(name, rust_value)) in RUST_CONSTANTS.iter().enumerate() {
        match get_c_value(tmpdir.path(), &cc, name) {
            Err(e) => {
                results.record_failed_to_compile();
                eprintln!("{}", e);
148
            }
149 150 151 152 153
            Ok(ref c_value) => {
                if rust_value == c_value {
                    results.record_passed();
                } else {
                    results.record_failed();
154 155 156 157
                    eprintln!(
                        "Constant value mismatch for {}\nRust: {:?}\nC:    {:?}",
                        name, rust_value, c_value
                    );
158 159 160 161 162 163 164 165 166 167 168 169
                }
            }
        };
        if (i + 1) % 25 == 0 {
            println!("constants ... {}", results.summary());
        }
    }
    results.expect_total_success();
}

#[test]
fn cross_validate_layout_with_c() {
170 171 172 173
    let tmpdir = Builder::new()
        .prefix("abi")
        .tempdir()
        .expect("temporary directory");
174 175
    let cc = Compiler::new().expect("configured compiler");

176 177 178 179 180 181 182 183
    assert_eq!(
        Layout {
            size: 1,
            alignment: 1
        },
        get_c_layout(tmpdir.path(), &cc, "char").expect("C layout"),
        "failed to obtain correct layout for char type"
    );
184

185
    let mut results: Results = Default::default();
186 187 188 189 190
    for (i, &(name, rust_layout)) in RUST_LAYOUTS.iter().enumerate() {
        match get_c_layout(tmpdir.path(), &cc, name) {
            Err(e) => {
                results.record_failed_to_compile();
                eprintln!("{}", e);
191
            }
192 193 194 195 196
            Ok(c_layout) => {
                if rust_layout == c_layout {
                    results.record_passed();
                } else {
                    results.record_failed();
197 198 199 200
                    eprintln!(
                        "Layout mismatch for {}\nRust: {:?}\nC:    {:?}",
                        name, rust_layout, &c_layout
                    );
201 202 203 204 205 206 207 208 209 210
                }
            }
        };
        if (i + 1) % 25 == 0 {
            println!("layout    ... {}", results.summary());
        }
    }
    results.expect_total_success();
}

211
fn get_c_layout(dir: &Path, cc: &Compiler, name: &str) -> Result<Layout, Box<dyn Error>> {
212 213 214 215 216 217 218 219
    let exe = dir.join("layout");
    let mut cc = cc.clone();
    cc.define("ABI_TYPE_NAME", name);
    cc.compile(Path::new("tests/layout.c"), &exe)?;

    let mut abi_cmd = Command::new(exe);
    let output = abi_cmd.output()?;
    if !output.status.success() {
220
        return Err(format!("command {:?} failed, {:?}", &abi_cmd, &output).into());
221 222 223 224 225 226
    }

    let stdout = str::from_utf8(&output.stdout)?;
    let mut words = stdout.trim().split_whitespace();
    let size = words.next().unwrap().parse().unwrap();
    let alignment = words.next().unwrap().parse().unwrap();
227
    Ok(Layout { size, alignment })
228 229
}

230
fn get_c_value(dir: &Path, cc: &Compiler, name: &str) -> Result<String, Box<dyn Error>> {
231 232 233 234 235 236 237 238
    let exe = dir.join("constant");
    let mut cc = cc.clone();
    cc.define("ABI_CONSTANT_NAME", name);
    cc.compile(Path::new("tests/constant.c"), &exe)?;

    let mut abi_cmd = Command::new(exe);
    let output = abi_cmd.output()?;
    if !output.status.success() {
239
        return Err(format!("command {:?} failed, {:?}", &abi_cmd, &output).into());
240 241
    }

242
    let output = str::from_utf8(&output.stdout)?.trim();
243 244 245 246 247 248
    if !output.starts_with("###gir test###") || !output.ends_with("###gir test###") {
        return Err(format!(
            "command {:?} return invalid output, {:?}",
            &abi_cmd, &output
        )
        .into());
249 250 251
    }

    Ok(String::from(&output[14..(output.len() - 14)]))
252 253 254
}

const RUST_LAYOUTS: &[(&str, Layout)] = &[
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
    (
        "GstHarness",
        Layout {
            size: size_of::<GstHarness>(),
            alignment: align_of::<GstHarness>(),
        },
    ),
    (
        "GstTestClock",
        Layout {
            size: size_of::<GstTestClock>(),
            alignment: align_of::<GstTestClock>(),
        },
    ),
    (
        "GstTestClockClass",
        Layout {
            size: size_of::<GstTestClockClass>(),
            alignment: align_of::<GstTestClockClass>(),
        },
    ),
276 277
];

278
const RUST_CONSTANTS: &[(&str, &str)] = &[];