Add SIMD escape

askama_escape/Cargo.toml

@@ -15,6 +15,12 @@ appveyor = { repository = "djc/askama" }
 maintenance = { status = "actively-developed" }
 travis-ci = { repository = "djc/askama" }
 
+[dependencies]
+cfg-if ="0.1.6"
+
+[build-dependencies]
+version_check = "0.1.4"
+
 [dev-dependencies]
 criterion = "0.2"
 

askama_escape/benches/all.rs

@@ -2,77 +2,77 @@ extern crate askama_escape;
 #[macro_use]
 extern crate criterion;
 
-use askama_escape::MarkupDisplay;
+use askama_escape::escape;
 use criterion::Criterion;
 
 criterion_main!(benches);
 criterion_group!(benches, functions);
 
 fn functions(c: &mut Criterion) {
-    c.bench_function("Escaping", escaping);
+    c.bench_function("toString 1 bytes", format_short);
+    c.bench_function("No Escaping 1 bytes", no_escaping_short);
+    c.bench_function("Escaping 1 bytes", escaping_short);
+    c.bench_function("toString 10 bytes", format);
+    c.bench_function("No Escaping 10 bytes", no_escaping);
+    c.bench_function("Escaping 10 bytes", escaping);
+    c.bench_function("toString 5 MB", format_long);
+    c.bench_function("No Escaping 5 MB", no_escaping_long);
+    c.bench_function("Escaping 5 MB", escaping_long);
 }
 
-fn escaping(b: &mut criterion::Bencher) {
-    let string_long = r#"
-    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris consequat tellus sit
-    amet ornare fermentum. Etiam nec erat ante. In at metus a orci mollis scelerisque.
-    Sed eget ultrices turpis, at sollicitudin erat. Integer hendrerit nec magna quis
-    venenatis. Vivamus non dolor hendrerit, vulputate velit sed, varius nunc. Quisque
-    in pharetra mi. Sed ullamcorper nibh malesuada commodo porttitor. Ut scelerisque
-    sodales felis quis dignissim. Morbi aliquam finibus justo, sit amet consectetur
-    mauris efficitur sit amet. Donec posuere turpis felis, eu lacinia magna accumsan
-    quis. Fusce egestas lacus vel fermentum tincidunt. Phasellus a nulla eget lectus
-    placerat commodo at eget nisl. Fusce cursus dui quis purus accumsan auctor.
-    Donec iaculis felis quis metus consectetur porttitor.
-<p>
-    Etiam nibh mi, <b>accumsan</b> quis purus sed, posuere fermentum lorem. In pulvinar porta
-    maximus. Fusce tincidunt lacinia tellus sit amet tincidunt. Aliquam lacus est, pulvinar
-    non metus a, <b>facilisis</b> ultrices quam. Nulla feugiat leo in cursus eleifend. Suspendisse
-    eget nisi ac justo sagittis interdum id a ipsum. Nulla mauris justo, scelerisque ac
-    rutrum vitae, consequat vel ex.
-</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-<p>
-    Sed sollicitudin <b>sem</b> mauris, at rutrum nibh egestas vel. Ut eu nisi tellus. Praesent dignissim
-    orci elementum, mattis turpis eget, maximus ante. Suspendisse luctus eu felis a tempor. Morbi
-    ac risus vitae sem molestie ullamcorper. Curabitur ligula augue, sollicitudin quis maximus vel,
-    facilisis sed nibh. Aenean auctor magna sem, id rutrum metus convallis quis. Nullam non arcu
-    dictum, lobortis erat quis, rhoncus est. Suspendisse venenatis, mi sed venenatis vehicula,
-    tortor dolor egestas lectus, et efficitur turpis odio non augue. Integer velit sapien, dictum
-    non egestas vitae, hendrerit sed quam. Phasellus a nunc eu erat varius imperdiet. Etiam id
-    sollicitudin turpis, vitae molestie orci. Quisque ornare magna quis metus rhoncus commodo.
-    Phasellus non mauris velit.
-</p>
-<p>
-    Etiam dictum tellus ipsum, nec varius quam ornare vel. Cras vehicula diam nec sollicitudin
-    ultricies. Pellentesque rhoncus sagittis nisl id facilisis. Nunc viverra convallis risus ut
-    luctus. Aliquam vestibulum <b>efficitur massa</b>, id tempus nisi posuere a. Aliquam scelerisque
-    elit justo. Nullam a ante felis. Cras vitae lorem eu nisi feugiat hendrerit. Maecenas vitae
-    suscipit leo, lacinia dignissim lacus. Sed eget volutpat mi. In eu bibendum neque. Pellentesque
-    finibus velit a fermentum rhoncus. Maecenas leo purus, eleifend eu lacus a, condimentum sagittis
-    justo.
-</p>"#;
-    let string_short = "Lorem ipsum dolor sit amet,<foo>bar&foo\"bar\\foo/bar";
-    let empty = "";
-    let no_escape = "Lorem ipsum dolor sit amet,";
-    let no_escape_long = r#"
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin scelerisque eu urna in aliquet.
-Phasellus ac nulla a urna sagittis consequat id quis est. Nullam eu ex eget erat accumsan dictum
-ac lobortis urna. Etiam fermentum ut quam at dignissim. Curabitur vestibulum luctus tellus, sit
-amet lobortis augue tempor faucibus. Nullam sed felis eget odio elementum euismod in sit amet massa.
-Vestibulum sagittis purus sit amet eros auctor, sit amet pharetra purus dapibus. Donec ornare metus
-vel dictum porta. Etiam ut nisl nisi. Nullam rutrum porttitor mi. Donec aliquam ac ipsum eget
-hendrerit. Cras faucibus, eros ut pharetra imperdiet, est tellus aliquet felis, eget convallis
-lacus ipsum eget quam. Vivamus orci lorem, maximus ac mi eget, bibendum vulputate massa. In
-vestibulum dui hendrerit, vestibulum lacus sit amet, posuere erat. Vivamus euismod massa diam,
-vulputate euismod lectus vestibulum nec. Donec sit amet massa magna. Nunc ipsum nulla, euismod
-quis lacus at, gravida maximus elit. Duis tristique, nisl nullam.
-    "#;
+static A: &str = "a";
+static E: &str = "<";
+
+fn escaping_short(b: &mut criterion::Bencher) {
+    b.iter(|| escape(E).to_string());
+}
 
+fn no_escaping_short(b: &mut criterion::Bencher) {
     b.iter(|| {
-        format!("{}", MarkupDisplay::from(string_long));
-        format!("{}", MarkupDisplay::from(string_short));
-        format!("{}", MarkupDisplay::from(empty));
-        format!("{}", MarkupDisplay::from(no_escape));
-        format!("{}", MarkupDisplay::from(no_escape_long));
+        escape(A).to_string();
     });
 }
+
+fn format_short(b: &mut criterion::Bencher) {
+    b.iter(|| A.to_string());
+}
+
+fn escaping(b: &mut criterion::Bencher) {
+    // 10 bytes at 10% escape
+    let string: &str = &[A, A, A, A, A, E, A, A, A, A, A].join("");
+
+    b.iter(|| escape(string).to_string());
+}
+
+fn no_escaping(b: &mut criterion::Bencher) {
+    let no_escape: &str = &A.repeat(10);
+
+    b.iter(|| escape(no_escape).to_string());
+}
+
+fn format(b: &mut criterion::Bencher) {
+    let string: &str = &A.repeat(10);
+
+    b.iter(|| string.to_string());
+}
+
+fn escaping_long(b: &mut criterion::Bencher) {
+    // 5 MB at 3.125% escape
+    let string: &str = &[&A.repeat(15), E, &A.repeat(16)]
+        .join("")
+        .repeat(160 * 1024);
+
+    b.iter(|| escape(string).to_string());
+}
+
+fn no_escaping_long(b: &mut criterion::Bencher) {
+    let no_escape: &str = &A.repeat(5 * 1024 * 1024);
+
+    b.iter(|| escape(no_escape).to_string());
+}
+
+fn format_long(b: &mut criterion::Bencher) {
+    let string: &str = &A.repeat(5 * 1024 * 1024);
+
+    b.iter(|| string.to_string());
+}

askama_escape/build.rs

@@ -0,0 +1,29 @@
+extern crate version_check;
+
+use std::env;
+
+use version_check::is_min_version;
+
+fn main() {
+    enable_simd_optimizations();
+}
+
+fn enable_simd_optimizations() {
+    if is_env_set("CARGO_CFG_ASKAMA_DISABLE_AUTO_SIMD") {
+        return;
+    }
+    if !is_min_version("1.27.0")
+        .map(|(yes, _)| yes)
+        .unwrap_or(false)
+    {
+        return;
+    }
+
+    println!("cargo:rustc-cfg=askama_runtime_simd");
+    println!("cargo:rustc-cfg=askama_runtime_avx");
+    println!("cargo:rustc-cfg=askama_runtime_sse");
+}
+
+fn is_env_set(name: &str) -> bool {
+    env::var(name).is_ok()
+}