openkache 0.1.0

Maintained Rust client for the OpenKache cache server
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
//! Operation-neutral request frame encoding.

use smallvec::SmallVec;

use crate::internal_protocol::request::{
    MAX_REQUEST_FRAME_STATE_SLOTS, RequestFrameLayout, RequestFrameStep,
};
use crate::internal_protocol::segments::RequestPrefix;
use crate::internal_protocol::{
    MAX_OPERATION_REQUEST_FIELDS, MAX_REQUEST_FRAME_BYTES, OPCODE_BYTES, Opcode, OwnedRequestFrame,
    ProtocolError, Result, WireSegment,
};

const NO_REQUEST_FIELD: usize = usize::MAX;

/// Encodes canonical numeric fields through one generated request layout.
///
/// Field positions are the generated numeric indexes in the layout. Fixed and
/// scalar fields use their canonical codec bytes; retained byte owners are
/// moved into the returned frame only after the complete active plan passes
/// validation.
///
/// # Arguments
///
/// * `opcode` - Operation discriminator written as the first frame byte.
/// * `layout` - Generated operation-neutral compact request layout.
/// * `fields` - Canonical field owners in generated numeric-index order.
///
/// # Returns
///
/// An ordered frame that keeps common prefixes inline and retains large field
/// owners without copying their bytes.
///
/// # Errors
///
/// Returns an error when field cardinality, presence, width, packed mapping,
/// scalar encoding, or the generated layout is invalid, or when the complete
/// frame exceeds its generated bound.
pub fn encode_request_frame(
    opcode: Opcode,
    layout: RequestFrameLayout,
    fields: impl IntoIterator<Item = Option<WireSegment>>,
) -> Result<OwnedRequestFrame> {
    encode_request_frame_with_id(0, opcode, layout, fields)
}

/// Encodes a request with an explicit canonical request ID.
///
/// The request ID is emitted immediately after the fixed-width opcode and is
/// retained by the server for response correlation. The legacy
/// [`encode_request_frame`] entry point uses the valid zero token.
pub fn encode_request_frame_with_id(
    request_id: u64,
    opcode: Opcode,
    layout: RequestFrameLayout,
    fields: impl IntoIterator<Item = Option<WireSegment>>,
) -> Result<OwnedRequestFrame> {
    if layout.field_count > MAX_OPERATION_REQUEST_FIELDS {
        return Err(invalid_layout(
            "request field count exceeds the generated bound",
        ));
    }
    let mut fields: SmallVec<[Option<WireSegment>; 8]> = fields
        .into_iter()
        .take(layout.field_count.saturating_add(1))
        .collect();
    if fields.len() != layout.field_count {
        return Err(invalid_layout(
            "request fields do not match the generated layout",
        ));
    }

    let mut plan = EncodePlan::new(layout.field_count, request_id);
    plan.visit(layout.steps, &fields)?;
    plan.finish(&fields)?;

    let mut output = FrameOutput::new(plan.prefix_len);
    output.append_inline(&[opcode as u8])?;
    let (request_id_bytes, request_id_len) = crate::internal_protocol::encode_varuint(request_id);
    output.append_inline(&request_id_bytes[..request_id_len])?;
    for piece in plan.pieces {
        match piece {
            FramePiece::Static(bytes) => output.append_inline(bytes)?,
            FramePiece::Encoded { bytes, len } => {
                output.append_inline(&bytes[..usize::from(len)])?;
            }
            FramePiece::Field(field) => {
                output.append_field(
                    fields[field]
                        .take()
                        .expect("request field passed preflight"),
                )?;
            }
        }
    }
    let frame = output.finish()?;
    debug_assert_eq!(frame.len(), plan.encoded_len);
    Ok(frame)
}

enum FramePiece {
    Static(&'static [u8]),
    Encoded {
        bytes: [u8; crate::internal_protocol::MAX_VARUINT_BYTES],
        len: u8,
    },
    Field(usize),
}

struct EncodePlan {
    encoded_len: usize,
    prefix_len: usize,
    prefix_open: bool,
    pieces: SmallVec<[FramePiece; 8]>,
    used_fields: SmallVec<[bool; 8]>,
    selectors: Selectors,
    byte_length_fields: [usize; MAX_REQUEST_FRAME_STATE_SLOTS],
    value_field: usize,
    terminal_body: bool,
}

impl EncodePlan {
    fn new(field_count: usize, request_id: u64) -> Self {
        let request_id_len = crate::internal_protocol::encode_varuint(request_id).1;
        Self {
            encoded_len: OPCODE_BYTES + request_id_len,
            prefix_len: OPCODE_BYTES + request_id_len,
            prefix_open: true,
            pieces: SmallVec::new(),
            used_fields: SmallVec::from_elem(false, field_count),
            selectors: Selectors::new(),
            byte_length_fields: [NO_REQUEST_FIELD; MAX_REQUEST_FRAME_STATE_SLOTS],
            value_field: NO_REQUEST_FIELD,
            terminal_body: false,
        }
    }

    fn visit(&mut self, steps: &[RequestFrameStep], fields: &[Option<WireSegment>]) -> Result<()> {
        for step in steps {
            if self.terminal_body {
                return Err(invalid_layout("request body must be the final frame step"));
            }
            match *step {
                RequestFrameStep::FixedField { field, bytes } => {
                    let value = self.use_field(fields, field)?;
                    if value.len() != bytes {
                        return Err(invalid_layout("fixed request field has the wrong width"));
                    }
                    self.push_field(field, value)?;
                }
                RequestFrameStep::Packed {
                    fields: packed_fields,
                    reserved_mask,
                    constant_bits,
                } => {
                    if constant_bits & reserved_mask != 0 {
                        return Err(invalid_layout("packed constant bits overlap reserved bits"));
                    }
                    let mut assigned_mask = reserved_mask | constant_bits;
                    let mut encoded = constant_bits;
                    for packed in packed_fields {
                        if assigned_mask & packed.mask != 0 {
                            return Err(invalid_layout("packed request field masks overlap"));
                        }
                        assigned_mask |= packed.mask;
                        let value = self.use_field(fields, packed.field)?;
                        let mut selected = None;
                        for (index, candidate) in packed.values.iter().enumerate() {
                            if candidate.bits & !packed.mask != 0 {
                                return Err(invalid_layout(
                                    "packed request value exceeds its field mask",
                                ));
                            }
                            if packed.values[..index]
                                .iter()
                                .any(|previous| previous.bits == candidate.bits)
                            {
                                return Err(invalid_layout(
                                    "packed request field has duplicate wire bits",
                                ));
                            }
                            if packed.values[..index]
                                .iter()
                                .any(|previous| previous.bytes == candidate.bytes)
                            {
                                return Err(invalid_layout(
                                    "packed request field has duplicate canonical bytes",
                                ));
                            }
                            if candidate.bytes == value.as_slice() {
                                selected = Some(candidate);
                            }
                        }
                        let selected = selected.ok_or_else(|| {
                            invalid_layout("packed request field has no canonical mapping")
                        })?;
                        encoded |= selected.bits;
                        self.selectors.assign(packed.slot, selected.bits)?;
                    }
                    self.push_encoded(&[encoded])?;
                }
                RequestFrameStep::Conditional {
                    selector,
                    expected,
                    steps,
                } => {
                    if self.selectors.get(selector)? == expected {
                        self.visit(steps, fields)?;
                    }
                }
                RequestFrameStep::Constant { bytes } => {
                    self.add_inline_len(bytes.len())?;
                    self.pieces.push(FramePiece::Static(bytes));
                }
                RequestFrameStep::ByteLengthField { field } => {
                    let value = self.use_field(fields, field)?;
                    if value.len() > usize::from(u8::MAX) {
                        return Err(invalid_layout(
                            "byte-length request field exceeds 255 bytes",
                        ));
                    }
                    self.push_encoded(&[u8::try_from(value.len()).expect("length was validated")])?;
                    self.push_field(field, value)?;
                }
                RequestFrameStep::ByteLengthPrefix { slot, field } => {
                    let value = self.use_field(fields, field)?;
                    if value.len() > usize::from(u8::MAX) {
                        return Err(invalid_layout(
                            "byte-length request field exceeds 255 bytes",
                        ));
                    }
                    let stored = self
                        .byte_length_fields
                        .get_mut(slot)
                        .ok_or_else(|| invalid_layout("byte-length slot is out of range"))?;
                    if *stored != NO_REQUEST_FIELD {
                        return Err(invalid_layout(
                            "byte-length slot is assigned more than once",
                        ));
                    }
                    *stored = field;
                    self.push_encoded(&[u8::try_from(value.len()).expect("length was validated")])?;
                }
                RequestFrameStep::ByteLengthBodyField { slot, field } => {
                    let stored = self
                        .byte_length_fields
                        .get_mut(slot)
                        .ok_or_else(|| invalid_layout("byte-length slot is out of range"))?;
                    if *stored != field {
                        return Err(invalid_layout(
                            "byte-length body does not match its prefix field",
                        ));
                    }
                    *stored = NO_REQUEST_FIELD;
                    self.push_field(field, self.field(fields, field)?)?;
                }
                RequestFrameStep::VarUIntField { field } => {
                    let value = self.use_field(fields, field)?;
                    let (encoded, len) =
                        crate::internal_protocol::encode_varuint(canonical_u64(value)?);
                    self.push_encoded(&encoded[..len])?;
                }
                RequestFrameStep::TrailingField { field }
                | RequestFrameStep::ValueLengthPrefixField { field } => {
                    if self.value_field != NO_REQUEST_FIELD {
                        return Err(invalid_layout(
                            "request layout declares more than one value body",
                        ));
                    }
                    let value = self.use_field(fields, field)?;
                    validate_value_length(value.len())?;
                    self.value_field = field;
                    let (encoded, len) =
                        crate::internal_protocol::encode_varuint(value.len() as u64);
                    self.push_encoded(&encoded[..len])?;
                    self.terminal_body = matches!(*step, RequestFrameStep::TrailingField { .. });
                }
                RequestFrameStep::Fixed { .. }
                | RequestFrameStep::FixedBody { .. }
                | RequestFrameStep::ValueLength
                | RequestFrameStep::ValueLengthPrefix
                | RequestFrameStep::VarUInt
                | RequestFrameStep::ByteLength
                | RequestFrameStep::ByteLengthBody { .. } => {
                    return Err(invalid_layout(
                        "request encoder requires field-addressable dynamic steps",
                    ));
                }
            }
        }
        Ok(())
    }

    fn use_field<'a>(
        &mut self,
        fields: &'a [Option<WireSegment>],
        field: usize,
    ) -> Result<&'a WireSegment> {
        let used = self
            .used_fields
            .get_mut(field)
            .ok_or_else(|| invalid_layout("request field index is out of range"))?;
        if *used {
            return Err(invalid_layout("request field is encoded more than once"));
        }
        let value = fields[field]
            .as_ref()
            .ok_or_else(|| invalid_layout("active request field is missing"))?;
        *used = true;
        Ok(value)
    }

    fn field<'a>(
        &self,
        fields: &'a [Option<WireSegment>],
        field: usize,
    ) -> Result<&'a WireSegment> {
        fields
            .get(field)
            .and_then(Option::as_ref)
            .ok_or_else(|| invalid_layout("request field index is out of range"))
    }

    fn push_field(&mut self, field: usize, value: &WireSegment) -> Result<()> {
        self.add_len(value.len())?;
        if self.prefix_open && !value.is_empty() {
            match value {
                WireSegment::Inline(_) => {
                    self.add_prefix_len(value.len())?;
                }
                WireSegment::Owned(_) | WireSegment::External(_) => {
                    self.prefix_open = false;
                }
            }
        }
        self.pieces.push(FramePiece::Field(field));
        Ok(())
    }

    fn push_encoded(&mut self, value: &[u8]) -> Result<()> {
        let mut bytes = [0; crate::internal_protocol::MAX_VARUINT_BYTES];
        bytes[..value.len()].copy_from_slice(value);
        self.add_inline_len(value.len())?;
        self.pieces.push(FramePiece::Encoded {
            bytes,
            len: u8::try_from(value.len()).expect("encoded request primitive length fits in u8"),
        });
        Ok(())
    }

    fn add_inline_len(&mut self, bytes: usize) -> Result<()> {
        self.add_len(bytes)?;
        if self.prefix_open {
            self.add_prefix_len(bytes)?;
        }
        Ok(())
    }

    fn add_len(&mut self, bytes: usize) -> Result<()> {
        self.encoded_len = self
            .encoded_len
            .checked_add(bytes)
            .ok_or(ProtocolError::FrameLengthOverflow)?;
        Ok(())
    }

    fn add_prefix_len(&mut self, bytes: usize) -> Result<()> {
        self.prefix_len = self
            .prefix_len
            .checked_add(bytes)
            .ok_or(ProtocolError::FrameLengthOverflow)?;
        Ok(())
    }

    fn finish(&mut self, fields: &[Option<WireSegment>]) -> Result<()> {
        if self
            .byte_length_fields
            .iter()
            .any(|field| *field != NO_REQUEST_FIELD)
        {
            return Err(invalid_layout(
                "byte-length prefix has no matching body step",
            ));
        }
        if fields
            .iter()
            .zip(&self.used_fields)
            .any(|(field, used)| field.is_some() && !used)
        {
            return Err(invalid_layout(
                "request contains a field outside the active layout",
            ));
        }
        if self.value_field != NO_REQUEST_FIELD {
            self.push_field(self.value_field, self.field(fields, self.value_field)?)?;
        }
        if self.encoded_len > MAX_REQUEST_FRAME_BYTES {
            return Err(ProtocolError::ValueTooLarge {
                size: self.encoded_len,
                maximum: MAX_REQUEST_FRAME_BYTES,
            });
        }
        Ok(())
    }
}

struct Selectors {
    values: [u8; MAX_REQUEST_FRAME_STATE_SLOTS],
    present: u8,
}

impl Selectors {
    const fn new() -> Self {
        Self {
            values: [0; MAX_REQUEST_FRAME_STATE_SLOTS],
            present: 0,
        }
    }

    fn assign(&mut self, slot: usize, value: u8) -> Result<()> {
        if slot >= MAX_REQUEST_FRAME_STATE_SLOTS || self.present & (1u8 << slot) != 0 {
            return Err(invalid_layout(
                "packed selector slot is invalid or assigned more than once",
            ));
        }
        self.values[slot] = value;
        self.present |= 1u8 << slot;
        Ok(())
    }

    fn get(&self, slot: usize) -> Result<u8> {
        if slot >= MAX_REQUEST_FRAME_STATE_SLOTS || self.present & (1u8 << slot) == 0 {
            return Err(invalid_layout(
                "conditional references an unavailable packed selector",
            ));
        }
        Ok(self.values[slot])
    }
}

struct FrameOutput {
    prefix: RequestPrefix,
    suffix: SmallVec<[WireSegment; 2]>,
    inline_suffix: SmallVec<[u8; 32]>,
    retained_owner_seen: bool,
}

impl FrameOutput {
    fn new(prefix_len: usize) -> Self {
        Self {
            prefix: RequestPrefix::with_capacity(prefix_len),
            suffix: SmallVec::new(),
            inline_suffix: SmallVec::new(),
            retained_owner_seen: false,
        }
    }

    fn append_inline(&mut self, bytes: &[u8]) -> Result<()> {
        if self.retained_owner_seen {
            self.inline_suffix.extend_from_slice(bytes);
            Ok(())
        } else {
            self.prefix.try_extend_from_slice(bytes)
        }
    }

    fn append_field(&mut self, field: WireSegment) -> Result<()> {
        if field.is_empty() {
            return Ok(());
        }
        match field {
            WireSegment::Inline(bytes) => self.append_inline(&bytes),
            retained @ (WireSegment::Owned(_) | WireSegment::External(_)) => {
                self.flush_inline_suffix();
                self.retained_owner_seen = true;
                self.suffix.push(retained);
                Ok(())
            }
        }
    }

    fn flush_inline_suffix(&mut self) {
        if !self.inline_suffix.is_empty() {
            self.suffix
                .push(WireSegment::Inline(std::mem::take(&mut self.inline_suffix)));
        }
    }

    fn finish(mut self) -> Result<OwnedRequestFrame> {
        self.flush_inline_suffix();
        OwnedRequestFrame::from_parts(self.prefix, self.suffix)
    }
}

fn canonical_u64(value: &WireSegment) -> Result<u64> {
    let bytes: [u8; 8] = value
        .as_slice()
        .try_into()
        .map_err(|_| invalid_layout("varuint request field must be canonical u64 bytes"))?;
    Ok(u64::from_be_bytes(bytes))
}

fn validate_value_length(value_len: usize) -> Result<()> {
    if value_len > crate::internal_protocol::MAX_VALUE_BYTES {
        return Err(ProtocolError::ValueTooLarge {
            size: value_len,
            maximum: crate::internal_protocol::MAX_VALUE_BYTES,
        });
    }
    Ok(())
}

const fn invalid_layout(message: &'static str) -> ProtocolError {
    ProtocolError::InvalidFieldSequence(message)
}