threadsafe_zmq 2.0.0

Thread-safe ZeroMQ wrapper with sync and async support
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
use clap::{Parser, ValueEnum};
use std::sync::atomic::{AtomicBool, AtomicU64, Ordering};
use std::sync::{Arc, Mutex};
use std::thread;
use std::time::{Duration, Instant};
use threadsafe_zmq::ChannelPair;
use zmq::Context;

#[cfg(feature = "async")]
use threadsafe_zmq::AsyncChannelPair;

#[derive(Parser)]
#[command(name = "bench", about = "Benchmark threadsafe_zmq")]
struct Args {
    #[arg(short, long, default_value = "all")]
    mode: Mode,

    #[arg(short, long, default_value_t = 10)]
    duration_secs: u64,

    #[arg(short, long, default_value_t = 8)]
    workers: usize,

    #[arg(short = 'c', long, default_value_t = 30)]
    work_complexity: u64,
}

#[derive(Clone, ValueEnum, PartialEq)]
enum Mode {
    Throughput,
    Latency,
    All,
}

static ADDR_INDEX: AtomicU64 = AtomicU64::new(0);

fn unique_addr() -> String {
    let id = ADDR_INDEX.fetch_add(1, Ordering::SeqCst);
    format!("inproc://bench-{}", id)
}

fn fmt_num(n: u64) -> String {
    let s = n.to_string();
    let mut result = String::new();
    for (i, c) in s.chars().rev().enumerate() {
        if i > 0 && i % 3 == 0 {
            result.push(',');
        }
        result.push(c);
    }
    result.chars().rev().collect()
}

fn do_work(n: u64) -> u64 {
    if n <= 1 {
        return n;
    }
    let mut a: u64 = 0;
    let mut b: u64 = 1;
    for _ in 2..=n {
        let temp = a.wrapping_add(b);
        a = b;
        b = temp;
    }
    b
}

fn run_raw_single_producer(args: &Args) -> (u64, f64) {
    let ctx = Context::new();
    let addr = unique_addr();

    let server = ctx.socket(zmq::PAIR).unwrap();
    server.bind(&addr).unwrap();

    let client = ctx.socket(zmq::PAIR).unwrap();
    client.connect(&addr).unwrap();

    let running = Arc::new(AtomicBool::new(true));
    let work = args.work_complexity;
    let duration_secs = args.duration_secs;

    let running_clone = Arc::clone(&running);
    let consumer = thread::spawn(move || loop {
        match server.recv_multipart(zmq::DONTWAIT) {
            Ok(m) if m[0] == b"STOP" => break,
            Ok(_) => {
                do_work(work);
            }
            Err(zmq::Error::EAGAIN) => {
                if !running_clone.load(Ordering::Relaxed) {
                    break;
                }
                thread::yield_now();
            }
            Err(_) => break,
        }
    });

    let msg = vec![b"REQ".to_vec()];
    let duration = Duration::from_secs(duration_secs);
    let start = Instant::now();
    let mut count = 0u64;

    while start.elapsed() < duration {
        client.send_multipart(&msg, 0).unwrap();
        count += 1;
    }

    running.store(false, Ordering::Relaxed);
    client.send_multipart(&[b"STOP".to_vec()], 0).unwrap();
    let _ = consumer.join();

    let throughput = count as f64 / duration_secs as f64;
    (count, throughput)
}

// THE PROBLEM: Raw ZMQ with mutex (N producers sharing socket via lock)
// This is what you have to do without threadsafe_zmq
fn run_raw_mutex(args: &Args) -> (u64, f64) {
    let ctx = Context::new();
    let addr = unique_addr();

    let server = ctx.socket(zmq::PAIR).unwrap();
    server.bind(&addr).unwrap();

    let client = ctx.socket(zmq::PAIR).unwrap();
    client.connect(&addr).unwrap();

    let client = Arc::new(Mutex::new(client));

    let running = Arc::new(AtomicBool::new(true));
    let sent = Arc::new(AtomicU64::new(0));
    let work = args.work_complexity;
    let duration_secs = args.duration_secs;
    let num_producers = args.workers;

    let running_clone = Arc::clone(&running);
    let consumer = thread::spawn(move || loop {
        match server.recv_multipart(zmq::DONTWAIT) {
            Ok(m) if m[0] == b"STOP" => break,
            Ok(_) => {
                do_work(work);
            }
            Err(zmq::Error::EAGAIN) => {
                if !running_clone.load(Ordering::Relaxed) {
                    break;
                }
                thread::yield_now();
            }
            Err(_) => break,
        }
    });

    let mut producers = Vec::new();
    for _ in 0..num_producers {
        let client = Arc::clone(&client);
        let running = Arc::clone(&running);
        let sent = Arc::clone(&sent);

        producers.push(thread::spawn(move || {
            let msg = vec![b"REQ".to_vec()];
            let duration = Duration::from_secs(duration_secs);
            let start = Instant::now();

            while start.elapsed() < duration && running.load(Ordering::Relaxed) {
                // Lock, send, unlock - this serializes all producers
                let guard = client.lock().unwrap();
                if guard.send_multipart(&msg, 0).is_ok() {
                    sent.fetch_add(1, Ordering::Relaxed);
                }
                drop(guard);
            }
        }));
    }

    for p in producers {
        let _ = p.join();
    }

    running.store(false, Ordering::Relaxed);
    {
        let guard = client.lock().unwrap();
        let _ = guard.send_multipart(&[b"STOP".to_vec()], 0);
    }
    let _ = consumer.join();

    let total = sent.load(Ordering::Relaxed);
    let throughput = total as f64 / duration_secs as f64;
    (total, throughput)
}

// ALTERNATIVE: ZMQ Proxy pattern (PUSH/PULL through broker)
// Each producer has own socket, broker forwards to worker
fn run_zmq_proxy(args: &Args) -> (u64, f64) {
    let ctx = Context::new();
    let frontend_addr = unique_addr();
    let backend_addr = unique_addr();

    let running = Arc::new(AtomicBool::new(true));
    let sent = Arc::new(AtomicU64::new(0));
    let work = args.work_complexity;
    let duration_secs = args.duration_secs;
    let num_producers = args.workers;

    // Broker thread: PULL from producers, PUSH to worker
    let ctx_clone = ctx.clone();
    let frontend = frontend_addr.clone();
    let backend = backend_addr.clone();
    let running_broker = Arc::clone(&running);
    let broker = thread::spawn(move || {
        let pull = ctx_clone.socket(zmq::PULL).unwrap();
        pull.bind(&frontend).unwrap();

        let push = ctx_clone.socket(zmq::PUSH).unwrap();
        push.bind(&backend).unwrap();

        while running_broker.load(Ordering::Relaxed) {
            match pull.recv_multipart(zmq::DONTWAIT) {
                Ok(msg) => {
                    let _ = push.send_multipart(&msg, 0);
                }
                Err(zmq::Error::EAGAIN) => {
                    thread::yield_now();
                }
                Err(_) => break,
            }
        }
    });

    // Worker thread: receives from broker
    let ctx_clone = ctx.clone();
    let backend = backend_addr.clone();
    let running_worker = Arc::clone(&running);
    let worker = thread::spawn(move || {
        let pull = ctx_clone.socket(zmq::PULL).unwrap();
        pull.connect(&backend).unwrap();

        while running_worker.load(Ordering::Relaxed) {
            match pull.recv_multipart(zmq::DONTWAIT) {
                Ok(_) => {
                    do_work(work);
                }
                Err(zmq::Error::EAGAIN) => {
                    thread::yield_now();
                }
                Err(_) => break,
            }
        }
    });

    thread::sleep(Duration::from_millis(10));

    // N producer threads, each with own PUSH socket
    let mut producers = Vec::new();
    for _ in 0..num_producers {
        let ctx = ctx.clone();
        let addr = frontend_addr.clone();
        let running = Arc::clone(&running);
        let sent = Arc::clone(&sent);

        producers.push(thread::spawn(move || {
            let push = ctx.socket(zmq::PUSH).unwrap();
            push.connect(&addr).unwrap();

            let msg = vec![b"REQ".to_vec()];
            let duration = Duration::from_secs(duration_secs);
            let start = Instant::now();

            while start.elapsed() < duration && running.load(Ordering::Relaxed) {
                if push.send_multipart(&msg, 0).is_ok() {
                    sent.fetch_add(1, Ordering::Relaxed);
                }
            }
        }));
    }

    for p in producers {
        let _ = p.join();
    }

    running.store(false, Ordering::Relaxed);
    thread::sleep(Duration::from_millis(50));
    let _ = broker.join();
    let _ = worker.join();

    let total = sent.load(Ordering::Relaxed);
    let throughput = total as f64 / duration_secs as f64;
    (total, throughput)
}

// THE SOLUTION: ChannelPair (N producers, thread-safe without mutex contention)
fn run_channelpair(args: &Args) -> (u64, f64) {
    let ctx = Context::new();
    let addr = unique_addr();

    let server_sock = ctx.socket(zmq::PAIR).unwrap();
    server_sock.bind(&addr).unwrap();

    let client_sock = ctx.socket(zmq::PAIR).unwrap();
    client_sock.connect(&addr).unwrap();

    let server = ChannelPair::new(&ctx, server_sock).unwrap();
    let client = ChannelPair::new(&ctx, client_sock).unwrap();

    thread::sleep(Duration::from_millis(10));

    let running = Arc::new(AtomicBool::new(true));
    let sent = Arc::new(AtomicU64::new(0));
    let work = args.work_complexity;
    let duration_secs = args.duration_secs;
    let num_producers = args.workers;

    let server_clone = Arc::clone(&server);
    let running_clone = Arc::clone(&running);
    let consumer = thread::spawn(move || loop {
        match server_clone.recv_timeout(Duration::from_millis(100)) {
            Ok(m) if m[0] == b"STOP" => break,
            Ok(_) => {
                do_work(work);
            }
            Err(_) => {
                if !running_clone.load(Ordering::Relaxed) {
                    break;
                }
            }
        }
    });

    let mut producers = Vec::new();
    for _ in 0..num_producers {
        let client = Arc::clone(&client);
        let running = Arc::clone(&running);
        let sent = Arc::clone(&sent);

        producers.push(thread::spawn(move || {
            let msg = vec![b"REQ".to_vec()];
            let duration = Duration::from_secs(duration_secs);
            let start = Instant::now();

            while start.elapsed() < duration && running.load(Ordering::Relaxed) {
                if client.send(msg.clone()).is_ok() {
                    sent.fetch_add(1, Ordering::Relaxed);
                }
            }
        }));
    }

    for p in producers {
        let _ = p.join();
    }

    running.store(false, Ordering::Relaxed);
    let _ = client.send(vec![b"STOP".to_vec()]);
    let _ = consumer.join();

    server.shutdown();
    client.shutdown();

    let total = sent.load(Ordering::Relaxed);
    let throughput = total as f64 / duration_secs as f64;
    (total, throughput)
}

// Async: Multiple producers via AsyncChannelPair
#[cfg(feature = "async")]
fn run_async_channelpair(args: &Args) -> (u64, f64) {
    use tokio::runtime::Runtime;

    let rt = Runtime::new().unwrap();
    let duration_secs = args.duration_secs;
    let num_producers = args.workers;
    let work = args.work_complexity;

    rt.block_on(async {
        let ctx = Context::new();
        let addr = unique_addr();

        let server_sock = ctx.socket(zmq::PAIR).unwrap();
        server_sock.bind(&addr).unwrap();

        let client_sock = ctx.socket(zmq::PAIR).unwrap();
        client_sock.connect(&addr).unwrap();

        let server = Arc::new(AsyncChannelPair::new(&ctx, server_sock).unwrap());
        let client = Arc::new(AsyncChannelPair::new(&ctx, client_sock).unwrap());

        tokio::time::sleep(Duration::from_millis(10)).await;

        let running = Arc::new(AtomicBool::new(true));
        let sent = Arc::new(AtomicU64::new(0));

        let server_clone = Arc::clone(&server);
        let running_clone = Arc::clone(&running);
        let consumer = tokio::spawn(async move {
            loop {
                match tokio::time::timeout(Duration::from_millis(100), server_clone.recv()).await {
                    Ok(Ok(m)) if m[0] == b"STOP" => break,
                    Ok(Ok(_)) => {
                        do_work(work);
                    }
                    _ => {
                        if !running_clone.load(Ordering::Relaxed) {
                            break;
                        }
                    }
                }
            }
        });

        let mut producers = Vec::new();
        for _ in 0..num_producers {
            let client = Arc::clone(&client);
            let running = Arc::clone(&running);
            let sent = Arc::clone(&sent);

            producers.push(tokio::spawn(async move {
                let msg = vec![b"REQ".to_vec()];
                let duration = Duration::from_secs(duration_secs);
                let start = Instant::now();

                while start.elapsed() < duration && running.load(Ordering::Relaxed) {
                    if client.send(msg.clone()).await.is_ok() {
                        sent.fetch_add(1, Ordering::Relaxed);
                    }
                }
            }));
        }

        for p in producers {
            let _ = p.await;
        }

        running.store(false, Ordering::Relaxed);
        let _ = client.send(vec![b"STOP".to_vec()]).await;
        let _ = consumer.await;

        server.shutdown().await;
        client.shutdown().await;

        let total = sent.load(Ordering::Relaxed);
        let throughput = total as f64 / duration_secs as f64;
        (total, throughput)
    })
}

// Latency: round-trip through ChannelPair
fn run_latency(args: &Args) -> Vec<u64> {
    let ctx = Context::new();
    let addr = unique_addr();

    let server_sock = ctx.socket(zmq::PAIR).unwrap();
    server_sock.bind(&addr).unwrap();

    let client_sock = ctx.socket(zmq::PAIR).unwrap();
    client_sock.connect(&addr).unwrap();

    let server = ChannelPair::new(&ctx, server_sock).unwrap();
    let client = ChannelPair::new(&ctx, client_sock).unwrap();

    thread::sleep(Duration::from_millis(10));

    let running = Arc::new(AtomicBool::new(true));
    let work = args.work_complexity;

    let server_clone = Arc::clone(&server);
    let running_clone = Arc::clone(&running);
    let worker = thread::spawn(move || loop {
        match server_clone.recv_timeout(Duration::from_millis(100)) {
            Ok(m) if m[0] == b"STOP" => break,
            Ok(_) => {
                do_work(work);
                let _ = server_clone.send(vec![b"OK".to_vec()]);
            }
            Err(_) => {
                if !running_clone.load(Ordering::Relaxed) {
                    break;
                }
            }
        }
    });

    let mut latencies = Vec::new();
    let duration = Duration::from_secs(args.duration_secs);
    let start = Instant::now();
    let msg = vec![b"REQ".to_vec()];

    while start.elapsed() < duration {
        let req_start = Instant::now();
        client.send(msg.clone()).unwrap();
        let _ = client.recv_timeout(Duration::from_secs(5)).unwrap();
        latencies.push(req_start.elapsed().as_micros() as u64);
    }

    running.store(false, Ordering::Relaxed);
    let _ = client.send(vec![b"STOP".to_vec()]);
    let _ = worker.join();

    server.shutdown();
    client.shutdown();

    latencies
}

fn print_latency_stats(latencies: &mut [u64]) {
    if latencies.is_empty() {
        return;
    }

    latencies.sort();
    let n = latencies.len();
    let sum: u64 = latencies.iter().sum();
    let mean = sum / n as u64;
    let p50 = latencies[n / 2];
    let p95 = latencies[(n as f64 * 0.95) as usize];
    let p99 = latencies[((n as f64 * 0.99) as usize).min(n - 1)];
    let min = latencies[0];
    let max = latencies[n - 1];

    println!("requests: {}", fmt_num(n as u64));
    println!("min:      {} us", fmt_num(min));
    println!("mean:     {} us", fmt_num(mean));
    println!("p50:      {} us", fmt_num(p50));
    println!("p95:      {} us", fmt_num(p95));
    println!("p99:      {} us", fmt_num(p99));
    println!("max:      {} us", fmt_num(max));
}

fn main() {
    let args = Args::parse();

    println!("threadsafe_zmq benchmark");
    println!("========================");
    println!("duration:   {}s", args.duration_secs);
    println!("producers:  {}", args.workers);
    println!("work:       fib({})", args.work_complexity);
    println!();

    match args.mode {
        Mode::Throughput | Mode::All => {
            println!("Throughput\n");

            // Baseline: what one thread can do
            println!("Raw ZMQ (1 producer, baseline)...");
            let (raw_total, raw_tps) = run_raw_single_producer(&args);
            println!(
                "{} msg/s ({} total)\n",
                fmt_num(raw_tps as u64),
                fmt_num(raw_total)
            );

            // Problem 1: mutex contention when sharing socket
            println!("Raw ZMQ + Mutex ({} producers)...", args.workers);
            let (mutex_total, mutex_tps) = run_raw_mutex(&args);
            println!(
                "{} msg/s ({} total)",
                fmt_num(mutex_tps as u64),
                fmt_num(mutex_total)
            );
            println!("vs baseline: {:.2}x\n", mutex_tps / raw_tps);

            // Problem 2: proxy pattern adds overhead
            println!("ZMQ Proxy ({} producers, PUSH/PULL)...", args.workers);
            let (proxy_total, proxy_tps) = run_zmq_proxy(&args);
            println!(
                "{} msg/s ({} total)",
                fmt_num(proxy_tps as u64),
                fmt_num(proxy_total)
            );
            println!("vs baseline: {:.2}x\n", proxy_tps / raw_tps);

            // Our solution
            println!("ChannelPair ({} producers)...", args.workers);
            let (cp_total, cp_tps) = run_channelpair(&args);
            println!(
                "{} msg/s ({} total)",
                fmt_num(cp_tps as u64),
                fmt_num(cp_total)
            );
            println!("vs baseline: {:.2}x", cp_tps / raw_tps);
            println!("vs mutex:    {:.2}x", cp_tps / mutex_tps);
            println!("vs proxy:    {:.2}x\n", cp_tps / proxy_tps);

            #[cfg(feature = "async")]
            {
                println!("AsyncChannelPair ({} producers)...", args.workers);
                let (async_total, async_tps) = run_async_channelpair(&args);
                println!(
                    "{} msg/s ({} total)",
                    fmt_num(async_tps as u64),
                    fmt_num(async_total)
                );
                println!("vs baseline: {:.2}x\n", async_tps / raw_tps);
            }
        }
        _ => {}
    }

    match args.mode {
        Mode::Latency | Mode::All => {
            println!("Latency (round-trip)\n");
            let mut latencies = run_latency(&args);
            print_latency_stats(&mut latencies);
        }
        _ => {}
    }

    println!();
}