concuring 0.1.0

A synchronous, concurrent HTTP client library for Rust that uses io_uring.
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
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
use std::{
    collections::VecDeque,
    mem::{ManuallyDrop, MaybeUninit},
    os::fd::IntoRawFd,
};

use color_eyre::{
    Result,
    eyre::{Context, ContextCompat, bail, eyre},
};
use heapless::index_map::FnvIndexMap;
use io_uring::{IoUring, cqueue};
use smallvec::SmallVec;

use crate::request::Request;

const BUF_SIZE: usize = 16 * 1024;

// struct IdleConn {
//     fd: io_uring::types::Fd,
// }

#[derive(Default, Debug, Clone)]
struct RecvTypeSized {
    header_boundary: usize,
    expect_body_size: usize,
}

#[derive(Default, Debug, Clone)]
enum RecvType {
    #[default]
    NotYetKnown,
    Sized(RecvTypeSized),
    Chunked,
}

impl RecvType {
    fn from_headers(headers: &[httparse::Header], header_boundary: usize) -> Result<Self> {
        for h in headers.iter() {
            if h.name.eq_ignore_ascii_case("content-length") {
                let size: usize = str::from_utf8(h.value)?.parse()?;
                return Ok(Self::Sized(RecvTypeSized {
                    header_boundary,
                    expect_body_size: size,
                }));
            } else if h.name.eq_ignore_ascii_case("transfer-encoding")
                && h.value.eq_ignore_ascii_case("chunked".as_bytes())
            {
                return Ok(Self::Chunked);
            }
        }
        Ok(Self::NotYetKnown)
    }
}

#[derive(Default, Debug)]
struct RecvState {
    typ: RecvType,
    resp: Option<Vec<u8>>,
    half_packet: Option<Vec<u8>>,
}

impl RecvState {
    #[tracing::instrument(skip(packet), fields(packet_len = %packet.len()))]
    fn try_from_first_packet(packet: &mut &[u8]) -> Result<Self> {
        let mut headers = [httparse::EMPTY_HEADER; 128];
        let mut response = httparse::Response::new(&mut headers);
        let header_boundary = match response.parse(packet) {
            Ok(httparse::Status::Complete(header_boundary)) => header_boundary,
            Ok(httparse::Status::Partial) => {
                return Ok(Self {
                    typ: RecvType::NotYetKnown,
                    resp: None,
                    half_packet: Some(packet.to_vec()),
                });
            }
            Err(e) => return Err(e.into()),
        };
        let recv_type = RecvType::from_headers(response.headers, header_boundary)
            .wrap_err("todo recv type parsing failed")?;

        tracing::debug!(header_boundary, recv_type = ?recv_type, "parsed headers from first packet");

        let capacity = match (recv_type.clone(), packet.len() == BUF_SIZE) {
            (RecvType::Sized(size), _) => size.expect_body_size,
            (RecvType::NotYetKnown, false) => packet.len(),
            _ => BUF_SIZE * 2,
        };
        let mut v = Vec::with_capacity(capacity);
        v.extend_from_slice(&packet[..header_boundary]);
        *packet = &packet[header_boundary..];
        Ok(Self {
            typ: recv_type,
            resp: Some(v),
            half_packet: None,
        })
    }
    fn try_from_next_packet(&mut self, packet: &mut &[u8]) -> Result<()> {
        let half_packet = self
            .half_packet
            .as_mut()
            .expect("should be called on half filled one");
        half_packet.extend_from_slice(packet);
        let mut headers = [httparse::EMPTY_HEADER; 128];
        let mut response = httparse::Response::new(&mut headers);
        let header_boundary = match response.parse(half_packet) {
            Ok(httparse::Status::Complete(header_boundary)) => header_boundary,
            Ok(httparse::Status::Partial) => {
                return Ok(());
            }
            Err(e) => return Err(e.into()),
        };
        let recv_type = RecvType::from_headers(response.headers, header_boundary)
            .wrap_err("todo recv type parsing failed")?;

        let capacity = match (recv_type.clone(), half_packet.len() == BUF_SIZE) {
            (RecvType::Sized(size), _) => size.expect_body_size,
            (RecvType::NotYetKnown, false) => half_packet.len(),
            _ => BUF_SIZE * 2,
        };
        let mut v = Vec::with_capacity(capacity);
        v.extend_from_slice(&half_packet[..header_boundary]);
        self.resp.replace(v);
        let _ = half_packet.drain(..header_boundary);
        Ok(())
    }
}

#[derive(Clone, Debug, PartialEq)]
enum FlowState {
    Connecting,
    Sending,
    Receiving,
    // UnparkedSend,
    Closing,
}

struct FlowMetadataConnecting {
    socket_address: socket2::SockAddr,
    request: Request,
}

#[repr(C)]
union FlowMetadata {
    connecting: ManuallyDrop<FlowMetadataConnecting>,
    // sending: ManuallyDrop<Pin<Box<[u8]>>>,
    // closing: ManuallyDrop<io_uring::squeue::Entry>,
}

#[derive(Debug, Clone)]
struct Flow {
    pool_id: u16,
    state: FlowState,
    fd: io_uring::types::Fd,
}

pub struct Concuring<const C: usize>
where
    bitmaps::BitsImpl<C>: bitmaps::Bits,
{
    ring: IoUring,
    occupancy: bitmaps::Bitmap<C>,
    flows: FnvIndexMap<u32, Flow, C>,
    metadata: [MaybeUninit<FlowMetadata>; C],
    buffers: [MaybeUninit<[u8; BUF_SIZE]>; C],

    recv_states: [RecvState; C],
    pub finished_responses: VecDeque<(u32, Result<http::Response<Vec<u8>>>)>,
    // idle_conns: HashMap<Conn, SmallVec<[IdleConn; 8]>>,
}

impl<const C: usize> Concuring<C>
where
    bitmaps::BitsImpl<C>: bitmaps::Bits,
{
    pub fn new() -> Result<Self> {
        assert!(
            C.is_power_of_two() && C <= 1024 && C >= 2,
            // It's good practice to include the invalid value in the message.
            "C must be a power of two between 2 and 1024, but was {}",
            C
        );

        Ok(Self {
            ring: io_uring::IoUring::new((C * 4) as u32)?,
            occupancy: Default::default(),
            flows: Default::default(),
            buffers: unsafe { MaybeUninit::uninit().assume_init() },
            metadata: unsafe { MaybeUninit::uninit().assume_init() },
            recv_states: array_init::array_init(|_| Default::default()),
            finished_responses: Default::default(),
            // idle_conns: Default::default(),
        })
    }

    #[tracing::instrument(skip(self, request), fields(flow_id, occupancy = %self.occupancy.len()))]
    pub fn try_submit(&mut self, flow_id: u32, request: Request) -> Result<()> {
        let pool_id = self
            .occupancy
            .first_false_index()
            .wrap_err("concurrency limit")? as u16;

        tracing::debug!(slot = %pool_id, "found available slot");

        // BEWARE! this is sync blocking :/
        let (socket, socket_address) = request
            .create_socket()
            .wrap_err_with(|| format!("create_socket for flow {}", flow_id))?;

        let fd = io_uring::types::Fd(socket.into_raw_fd());

        let flow = Flow {
            pool_id,
            state: FlowState::Connecting,
            fd,
        };
        match self.flows.entry(flow_id) {
            heapless::index_map::Entry::Occupied(_) => bail!("duplicate flow_id: {}", flow_id),
            heapless::index_map::Entry::Vacant(vacant) => vacant
                .insert(flow)
                .expect("map should not be full after occupancy check"),
        };

        let metadata_slot = &mut self.metadata[pool_id as usize];
        metadata_slot.write(FlowMetadata {
            connecting: ManuallyDrop::new(FlowMetadataConnecting {
                socket_address,
                request,
            }),
        });
        let addr = unsafe { &metadata_slot.assume_init_ref().connecting.socket_address };

        self.occupancy.set(pool_id as usize, true);
        let addr_ptr = addr.as_ptr() as *const _;
        let addr_len = addr.len();
        let sqe_connect = io_uring::opcode::Connect::new(fd, addr_ptr, addr_len)
            .build()
            .user_data(flow_id as u64);

        unsafe {
            self.ring
                .submission()
                .push(&sqe_connect)
                .expect("submission queue is full");
        }

        self.ring.submit().wrap_err("submitting to io_uring")?;

        Ok(())
    }

    #[tracing::instrument(skip(self, cqe), fields(flow_id = %cqe.user_data(), result = %cqe.result()))]
    fn handle_negative_cqe(&mut self, cqe: &cqueue::Entry) {
        // A negative cqe.result() indicates a kernel-level error. The value
        // is a negated errno code. Here are common errors for each state:

        let flow_id = cqe.user_data() as u32;
        let mut flow_entry = match self.flows.entry(flow_id) {
            heapless::index_map::Entry::Occupied(occupied_entry) => occupied_entry,
            heapless::index_map::Entry::Vacant(_) => panic!("should always exist"),
        };
        let flow = flow_entry.get();
        let pool_id = flow.pool_id as usize;

        let mut sub_q = self.ring.submission();

        let close_sqe = io_uring::opcode::Close::new(flow.fd)
            .build()
            .user_data(cqe.user_data());

        match flow.state {
            FlowState::Connecting => {
                // ECONNREFUSED: Server actively refused the connection.
                // ETIMEDOUT: Connection timed out.
                // ENETUNREACH / EHOSTUNREACH: Network or host is unreachable.

                tracing::error!(fd = %flow.fd.0, "connect failed");
                flow_entry.get_mut().state = FlowState::Closing;
                unsafe {
                    sub_q.push(&close_sqe).expect("submission for queue failed");
                }
                self.finished_responses
                    .push_back((flow_id, Err(eyre!("conn error {}", cqe.result()))));
            }
            FlowState::Sending => {
                // EPIPE: "Broken pipe," the server closed the connection.
                // ECONNRESET: Connection reset by the server.

                tracing::error!(fd = %flow.fd.0, "send failed");
                // TODO err handling
                self.recv_states[pool_id] = Default::default();

                flow_entry.get_mut().state = FlowState::Closing;
                unsafe {
                    sub_q.push(&close_sqe).expect("submission for queue failed");
                }
                self.finished_responses
                    .push_back((flow_id, Err(eyre!("send error {}", cqe.result()))));
            }
            FlowState::Receiving => {
                // ECONNRESET: Server closed the connection unexpectedly.
                // ETIMEDOUT: A timeout occurred on the socket.

                todo!();
            }
            FlowState::Closing => {
                // EBADF: "Bad file descriptor," indicates a double-close bug.

                // do nothing other than free occupancy
                let _ = flow_entry.remove();
                self.occupancy.set(pool_id, false);
            } // FlowState::UnparkedSend => {
              //     // Here dump the conn and take another from idleconns
              // }
        };
    }

    #[tracing::instrument(skip(self, cqe, flow), fields(flow_id = %cqe.user_data(), fd = %flow.fd.0, slot = %flow.pool_id))]
    fn handle_connecting(&mut self, cqe: &cqueue::Entry, flow: Flow) -> FlowState {
        tracing::debug!("connection established, transitioning to Sending");
        let metadata_slot = &mut self.metadata[flow.pool_id as usize];
        let metadata_connecting = unsafe { &metadata_slot.assume_init_ref().connecting };

        let serialized = &metadata_connecting.request.data;

        let sqe_send = io_uring::opcode::Send::new(
            flow.fd,
            serialized.as_ptr() as *const _,
            serialized.len() as _,
        )
        .build()
        .user_data(cqe.user_data());

        let mut sub_q = self.ring.submission();
        unsafe {
            sub_q.push(&sqe_send).expect("submission queue is full");
        }
        FlowState::Sending
    }

    #[tracing::instrument(skip(self, cqe, flow), fields(flow_id = %cqe.user_data(), fd = %flow.fd.0, slot = %flow.pool_id, bytes_sent = %cqe.result()))]
    fn handle_sending(&mut self, cqe: &cqueue::Entry, flow: Flow) -> FlowState {
        tracing::debug!("send completed, transitioning to Receiving");
        let pool_id = flow.pool_id as usize;
        let metadata_slot = &mut self.metadata[pool_id];
        unsafe {
            let metadata_connecting = &mut metadata_slot.assume_init_mut().connecting;
            ManuallyDrop::drop(metadata_connecting);
        }
        let sqe_recv = io_uring::opcode::Recv::new(
            flow.fd,
            self.buffers[pool_id].as_mut_ptr() as *mut u8,
            BUF_SIZE as _,
        )
        .build()
        .user_data(cqe.user_data());

        let mut sub_q = self.ring.submission();
        unsafe {
            sub_q.push(&sqe_recv).expect("submission queue is full");
        }

        FlowState::Receiving
    }

    /// returns true if there are more chunks
    fn read_chunks(
        prev_packet: &mut Option<Vec<u8>>,
        packet: &[u8],
        into: &mut Vec<u8>,
    ) -> Result<bool, httparse::InvalidChunkSize> {
        let mut packet = if let Some(prev_packet) = prev_packet
            && !prev_packet.is_empty()
        {
            prev_packet.extend_from_slice(packet);
            prev_packet.as_slice()
        } else {
            packet
        };

        while !packet.is_empty() {
            match httparse::parse_chunk_size(packet)? {
                httparse::Status::Complete((offset, length)) => {
                    let length = length as usize;
                    let next_start = offset + length + 2;
                    if next_start > packet.len() {
                        break; // need more data
                    }
                    if length == 0 {
                        // last chunk do something
                        if let Some(prev_packet) = prev_packet {
                            prev_packet.clear();
                        }
                        return Ok(false);
                    }

                    into.extend_from_slice(&packet[offset..offset + length]);
                    packet = &packet[next_start..];
                }
                httparse::Status::Partial => {
                    break; // need more data
                }
            }
        }
        // there is partial data, store it properly
        // TODO make more efficient
        let v = packet.to_vec();
        let _ = prev_packet.replace(v);

        Ok(true)
    }

    #[tracing::instrument(skip(self, cqe, flow), fields(flow_id = %cqe.user_data(), fd = %flow.fd.0, slot = %flow.pool_id, bytes_received = %cqe.result()))]
    fn handle_receiving(&mut self, cqe: &cqueue::Entry, flow: Flow) -> FlowState {
        let pool_id = flow.pool_id as usize;
        let flow_id = cqe.user_data() as u32;

        macro_rules! finalize {
            () => {{
                tracing::debug!(slot = %pool_id, "finalizing response");
                let partial = self.recv_states[pool_id].resp.take();
                let res_resp = match partial {
                    Some(partial) => parse_response(&partial),
                    None => Err(eyre!("response parsing {}", flow_id)),
                };
                self.finished_responses.push_back((flow_id, res_resp));

                // TODO make conn idle instead of close?
                // Also cleanup for flow at indices pool_id

                let sqe_close = io_uring::opcode::Close::new(flow.fd)
                    .build()
                    .user_data(cqe.user_data());

                unsafe {
                    self.ring
                        .submission()
                        .push(&sqe_close)
                        .expect("submission queue is full");
                }
                FlowState::Closing
            }};
        }

        let bytes_read = cqe.result();
        if bytes_read > 0 {
            // Read a chunk
            let buf = &mut self.buffers[pool_id];
            let buf = unsafe { buf.assume_init_mut() };

            macro_rules! recv_more {
                () => {{
                    let buf = &mut self.buffers[pool_id];
                    let buf = unsafe { buf.assume_init_mut() };

                    let sqe_recv =
                        io_uring::opcode::Recv::new(flow.fd, buf.as_mut_ptr(), buf.len() as _)
                            .build()
                            .user_data(cqe.user_data());
                    unsafe {
                        self.ring
                            .submission()
                            .push(&sqe_recv)
                            .expect("submission queue is full");
                    }

                    FlowState::Receiving
                }};
            }

            let mut packet = &buf[..(bytes_read as _)];
            let recv_state = &mut self.recv_states[pool_id];

            tracing::trace!(
                slot = %pool_id,
                recv_type = ?recv_state.typ,
                has_resp = %recv_state.resp.is_some(),
                has_half_packet = %recv_state.half_packet.is_some(),
                "processing received data"
            );

            if recv_state.half_packet.is_none() && recv_state.resp.is_none() {
                // first packet
                *recv_state = RecvState::try_from_first_packet(&mut packet).expect("todo");
                if recv_state.resp.is_none() {
                    // packet is partial
                    return recv_more!();
                }
            } else if recv_state.resp.is_none() {
                // handling partial now
                recv_state.try_from_next_packet(&mut packet).expect("todo");
                if recv_state.resp.is_none() {
                    // packet is still partial
                    return recv_more!();
                }
            }
            // Headers in recv_state.resp, and start of body is in packet now.
            let recv_buf = recv_state.resp.as_mut().expect("its not none we checked");

            match &recv_state.typ {
                RecvType::Sized(size) => {
                    recv_buf.extend_from_slice(packet);
                    if recv_buf.len() >= size.expect_body_size + size.header_boundary {
                        finalize!()
                    } else {
                        recv_more!()
                    }
                }
                RecvType::Chunked => {
                    match Self::read_chunks(&mut recv_state.half_packet, packet, recv_buf) {
                        Ok(true) => recv_more!(),
                        Ok(false) => finalize!(),
                        Err(e) => panic!("{}", e),
                    }
                }
                RecvType::NotYetKnown => {
                    recv_buf.extend_from_slice(packet);
                    recv_more!()
                }
            }
        } else if bytes_read == 0 {
            // Finished receiving
            finalize!()
        } else {
            unreachable!("we checked the cqe.result() before");
        }
    }

    #[tracing::instrument(skip(self), fields(active_flows = %self.flows.len(), occupancy = %self.occupancy.len()))]
    pub fn wait(&mut self) -> Option<()> {
        let finished_resp_len_prev = self.finished_responses.len();
        loop {
            if self.flows.is_empty() {
                return None;
            }
            self.ring.submit_and_wait(1).expect("waiting ring");

            let cqes: SmallVec<[cqueue::Entry; 32]> = self.ring.completion().collect();

            tracing::trace!(cqe_count = %cqes.len(), "processing completion queue entries");

            for cqe in cqes {
                let flow_id = cqe.user_data() as u32;

                if cqe.result() < 0 {
                    self.handle_negative_cqe(&cqe);
                    continue;
                }

                let flow = self
                    .flows
                    .get(&flow_id)
                    .expect("should always exist")
                    .clone();
                let pool_id = flow.pool_id as usize;

                if flow.state == FlowState::Closing {
                    // metadata can be left alone, we needed the sqe for closing to be alive at this point
                    // but its now useless
                    // only cree the occupancy and flow
                    self.occupancy.set(pool_id, false);
                    let _ = self.flows.remove(&flow_id);
                    continue;
                }

                let old_state = flow.state.clone();
                let new_state = match flow.state.clone() {
                    FlowState::Connecting => {
                        // Connected. Send request
                        self.handle_connecting(&cqe, flow)
                    }
                    // FlowState::Sending | FlowState::UnparkedSend => {
                    FlowState::Sending => {
                        // Send succeeded, start receiving.
                        self.handle_sending(&cqe, flow)
                    }
                    FlowState::Receiving => {
                        // Received one chunk
                        self.handle_receiving(&cqe, flow)
                    }
                    FlowState::Closing => unreachable!("we checked this above"),
                };

                tracing::debug!(
                    flow_id,
                    slot = %pool_id,
                    from_state = ?old_state,
                    to_state = ?new_state,
                    "state transition"
                );

                self.flows
                    .get_mut(&flow_id)
                    .expect("should always exist")
                    .state = new_state;
            }
            if self.finished_responses.len() != finished_resp_len_prev {
                return Some(());
            }
        }
    }
}

fn parse_response(buf: &[u8]) -> Result<http::Response<Vec<u8>>> {
    let mut headers = [httparse::EMPTY_HEADER; 64];
    let mut parsed_response = httparse::Response::new(&mut headers);

    let header_size = match parsed_response.parse(buf)? {
        httparse::Status::Complete(size) => size,
        httparse::Status::Partial => bail!("incomplete HTTP response"),
    };

    let body_bytes = &buf[header_size..];
    let mut response_builder = http::Response::builder()
        .status(parsed_response.code.unwrap_or(0))
        .version(if parsed_response.version.unwrap_or(0) == 1 {
            http::Version::HTTP_11
        } else {
            http::Version::HTTP_10
        });
    for header in parsed_response.headers {
        response_builder = response_builder.header(header.name, header.value);
    }
    response_builder
        .body(Vec::from(body_bytes))
        .wrap_err("parsing resp body")
}