Merge remote-tracking branch 'origin/master' into simd-digit-parsing

# Conflicts:
#	src/parser.rs

Cargo.toml

@@ -23,6 +23,7 @@ vncserver = { version ="0.2", optional = true}
 [dev-dependencies]
 criterion = {version = "0.5", features = ["async_tokio"]}
 rstest = "0.17"
+rand = "0.8.5"
 
 [features]
 default = ["vnc"]

benches/benchmarks.rs

@@ -6,6 +6,8 @@ use breakwater::{
 use criterion::{
     BenchmarkId, Criterion, {criterion_group, criterion_main},
 };
+use rand::seq::SliceRandom;
+use rand::thread_rng;
 use std::{sync::Arc, time::Duration};
 
 const FRAMEBUFFER_WIDTH: usize = 1920;
@@ -21,15 +23,34 @@ async fn invoke_parse_pixelflut_commands(
 }
 
 fn from_elem(c: &mut Criterion) {
-    let draw_commands = get_commands_to_draw_rect(FRAMEBUFFER_WIDTH, FRAMEBUFFER_HEIGHT, 0x123456);
-    let draw_commands = draw_commands.as_bytes();
+    let mut draw_commands =
+        get_commands_to_draw_rect(FRAMEBUFFER_WIDTH, FRAMEBUFFER_HEIGHT, 0x123456);
+    let ordered_draw_commands = draw_commands.join("");
 
     c.bench_with_input(
         BenchmarkId::new(
-            "parse_draw_commands",
+            "parse_draw_commands_ordered",
             format!("{FRAMEBUFFER_WIDTH} x {FRAMEBUFFER_HEIGHT}"),
         ),
-        &draw_commands,
+        &ordered_draw_commands.as_bytes(),
+        |b, input| {
+            let fb = Arc::new(FrameBuffer::new(FRAMEBUFFER_WIDTH, FRAMEBUFFER_HEIGHT));
+            let parser_state = ParserState::default();
+            b.to_async(tokio::runtime::Runtime::new().unwrap())
+                .iter(|| invoke_parse_pixelflut_commands(input, &fb, parser_state.clone()));
+        },
+    );
+
+    let mut rng = thread_rng();
+    draw_commands.shuffle(&mut rng);
+    let shuffled_draw_commands = draw_commands.join("");
+
+    c.bench_with_input(
+        BenchmarkId::new(
+            "parse_draw_commands_shuffled",
+            format!("{FRAMEBUFFER_WIDTH} x {FRAMEBUFFER_HEIGHT}"),
+        ),
+        &shuffled_draw_commands.as_bytes(),
         |b, input| {
             let fb = Arc::new(FrameBuffer::new(FRAMEBUFFER_WIDTH, FRAMEBUFFER_HEIGHT));
             let parser_state = ParserState::default();

src/main.rs

@@ -21,6 +21,8 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
     env_logger::Builder::from_env(Env::default().default_filter_or("info")).init();
     let args = Args::parse();
 
+    breakwater::parser::check_cpu_support();
+
     let fb = Arc::new(FrameBuffer::new(args.width, args.height));
 
     // If we make the channel to big, stats will start to lag behind

src/parser.rs

@@ -1,6 +1,6 @@
 use crate::framebuffer::FrameBuffer;
 use const_format::formatcp;
-use std::simd::{u32x4, u32x8, Simd, SimdPartialOrd, SimdUint, ToBitMask, u8x16};
+use std::simd::{u32x8, Simd, SimdUint};
 use std::sync::Arc;
 use tokio::io::AsyncWriteExt;
 
@@ -299,6 +299,25 @@ fn simd_unhex(value: &[u8]) -> u32 {
     shifted.reduce_or()
 }
 
+pub fn check_cpu_support() {
+    #[cfg(target_arch = "x86_64")]
+    {
+        if !is_x86_feature_detected!("avx2") {
+            warn!("Your CPU does not support AVX2. Consider using a CPU supporting AVX2 for best performance");
+        } else if !is_x86_feature_detected!("avx") {
+            warn!("Your CPU does not support AVX. Consider using a CPU supporting AVX2 (or at least AVX) for best performance");
+        } else {
+            // At this point the CPU should support AVX und AVX2
+            // Warn the user when he has compiled breakwater without the needed target features
+            if cfg!(all(target_feature = "avx", target_feature = "avx2")) {
+                info!("Using AVX and AVX2 support");
+            } else {
+                warn!("Your CPU does support AVX and AVX2, but you have not enabled avx and avx2 support. Please re-compile using RUSTFLAGS='-C target-cpu=native' cargo build --release`");
+            }
+        }
+    }
+}
+
 const SIMD_POS: Simd<u8, 16> = u8x16::from_array([
     255, 251, 251, 251, // interesting data
     254, 251, 251, 251, // just zero em all

src/test/helpers/pixelflut_commands.rs

@@ -1,9 +1,9 @@
-pub fn get_commands_to_draw_rect(width: usize, height: usize, color: u32) -> String {
-    let mut draw_commands = String::new();
+pub fn get_commands_to_draw_rect(width: usize, height: usize, color: u32) -> Vec<String> {
+    let mut draw_commands = Vec::new();
 
     for x in 0..width {
         for y in 0..height {
-            draw_commands += &format!("PX {x} {y} {color:06x}\n");
+            draw_commands.push(format!("PX {x} {y} {color:06x}\n"));
         }
     }