cartel-pg 0.22.0

Async PostgreSQL driver for the dope runtime
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
use std::{mem, num::NonZero};

mod error;
use cartel_core::{
    memory::{self, Ingress, Layout},
    reply,
};
use dope::{
    core::{
        driver::route::table::{self, conn},
        io::transfer,
    },
    manifold::client::side,
};
pub use error::Error;
use o3::{
    base::{num::bounded, time::Positive},
    buffer::{
        hold::{self, limits},
        pool,
    },
    depot::{capacity, queue::pool::fair},
};
use reply::{layout, usage};

use crate::{port::replies::groups, protocol::runtime::ready::plan};

const FRAME_HEADER_BYTES: usize = 5;
pub const DEFAULT_OPERATION_WINDOW: Positive = Positive::from_secs::<30>();

#[derive(Clone)]
pub struct Config {
    capacities: Bounds,
    pub(super) operation_window: Positive,
    memory_bound: Memory,
    response_retention: Layout,
    runtime: Runtime,
}

#[derive(Clone, Copy)]
struct Bounds {
    connections: side::Capacity,
    inflight: usize,
    admission_waiters: usize,
    requests: Request,
    responses: Frames,
    notifications: Notification,
}

#[derive(Clone, Copy)]
pub(super) struct Runtime {
    request_pool: pool::Layout,
    request_queue: fair::Plan,
    response_arena: layout::Layout,
    ready: plan::Plan,
    notifications: NonZero<u32>,
    groups: Option<groups::Layout>,
}

#[derive(Clone, Copy, PartialEq, Eq)]
pub struct Capacities {
    pub connections: usize,
    pub inflight: usize,
    pub admission_waiters: usize,
    pub requests: Request,
    pub responses: Response,
    pub notifications: Notification,
}

#[derive(Clone, Copy, PartialEq, Eq)]
pub struct Request {
    pub frames: usize,
    pub frame_bytes: usize,
}

#[derive(Clone, Copy, PartialEq, Eq)]
pub struct Response {
    pub items: usize,
    pub bytes: usize,
    /// Largest complete backend frame, including type and length fields.
    pub frame_bytes: usize,
}

#[derive(Clone, Copy)]
struct Frames {
    items: usize,
    bytes: usize,
    wire: bounded::NonZeroU32<{ FRAME_HEADER_BYTES as u32 }, { transfer::MAX_BYTES as u32 }>,
}

#[derive(Clone, Copy, PartialEq, Eq)]
pub struct Notification {
    pub items: usize,
    pub bytes: usize,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct Groups {
    pub active: NonZero<usize>,
    pub records: NonZero<usize>,
    pub bytes: NonZero<usize>,
}

/// Physical upper bound for driver-retained PostgreSQL payloads and the exact
/// ready/transaction selector allocation. Other fixed metadata, credentials,
/// and values transferred into caller ownership are intentionally excluded.
#[derive(Clone, Copy, PartialEq, Eq)]
pub struct Memory {
    pub request_bytes: usize,
    pub cancel_bytes: usize,
    /// Logical completed-response allowance.
    pub response_bytes: usize,
    pub ingress: Ingress,
    pub resident_bytes: limits::Bound,
    pub notification_bytes: usize,
    pub diagnostic_bytes: usize,
    pub total_bytes: limits::Bound,
}

impl Config {
    pub fn new(caps: Capacities) -> Result<Self, Error> {
        Self::with_window(caps, DEFAULT_OPERATION_WINDOW)
    }

    pub fn with_window(caps: Capacities, window: Positive) -> Result<Self, Error> {
        let Capacities {
            connections: conns,
            inflight,
            admission_waiters: waiters,
            requests:
                Request {
                    frames,
                    frame_bytes: frame,
                },
            responses:
                Response {
                    items,
                    bytes,
                    frame_bytes: wire,
                },
            notifications:
                Notification {
                    items: notices,
                    bytes: notice,
                },
        } = caps;
        let primary = conn::Capacity::try_from(conns)
            .map_err(|error| Error::Connections(Connection::Primary(error)))?;
        let sides = side::Capacity::try_new(primary)
            .map_err(|error| Error::Connections(Connection::Side(error)))?;
        let capacity = sides.primary();
        let conns = capacity.entries().get();
        if inflight < conns || inflight > frames {
            return Err(Error::Inflight {
                actual: inflight,
                minimum: conns,
                maximum: frames,
            });
        }
        if waiters == 0 {
            return Err(Error::AdmissionWaitersZero);
        }
        if frames < conns || frames > u32::MAX as usize / 2 {
            return Err(Error::RequestFrames {
                actual: frames,
                minimum: conns,
                maximum: u32::MAX as usize / 2,
            });
        }
        if frame == 0 || frame > transfer::MAX_BYTES {
            return Err(Error::RequestFrameBytes {
                actual: frame,
                maximum: transfer::MAX_BYTES,
            });
        }
        let pool = pool::Layout::new(frames, frame).map_err(Error::RequestPool)?;
        let queue = fair::Plan::new(frames, conns).map_err(Error::RequestQueue)?;
        if items < inflight || items > u32::MAX as usize {
            return Err(Error::ResponseItems {
                actual: items,
                minimum: inflight,
                maximum: u32::MAX as usize,
            });
        }
        if bytes == 0 {
            return Err(Error::ResponseBytesZero);
        }
        let bound = bounded::NonZeroU32::from_usize(wire).ok_or(Error::ResponseFrameBytes {
            actual: wire,
            minimum: FRAME_HEADER_BYTES,
            maximum: transfer::MAX_BYTES,
        })?;
        let payload = wire - FRAME_HEADER_BYTES;
        if payload > bytes {
            return Err(Error::ResponseFrameExceedsCapacity {
                frame_bytes: wire,
                payload_bytes: payload,
                available_payload_bytes: bytes,
            });
        }
        let notices = capacity::Count::try_from(notices)
            .map_err(Error::NotificationItems)?
            .nonzero()
            .ok_or(Error::NotificationItemsZero)?;
        if notice == 0 {
            return Err(Error::NotificationBytesZero);
        }
        let capacity = layout::Capacity::new(
            layout::Lanes::new(conns),
            layout::Entries::new(inflight),
            layout::Data::new(items),
            usage::Bytes::new(bytes),
            usage::Values::new(items),
        );
        let arena = layout::Layout::bounded(capacity).map_err(Error::Arena)?;
        let ready = plan::Plan::new(sides.primary(), arena).map_err(Error::Ready)?;
        let limit = arena.limit().bytes().get();
        if payload > limit {
            return Err(Error::ResponseFrameExceedsLaneCapacity {
                frame_bytes: wire,
                payload_bytes: payload,
                available_payload_bytes: limit,
            });
        }
        let request = pool.bytes();
        let cancel = conns
            .checked_mul(16)
            .ok_or(Error::CancelBytesOverflow { connections: conns })?;
        let retained = Layout::try_framed(memory::RETENTION, bytes, conns, wire, notice)
            .map_err(Error::Memory)?;
        let slots = items.checked_add(conns).ok_or(Error::OwnerSlotsOverflow {
            items,
            connections: conns,
        })?;
        let owners = slots
            .checked_add(notices.get() as usize)
            .ok_or(Error::OwnersOverflow {
                slots,
                notifications: notices.get() as usize,
            })?;
        let owners = capacity::Count::try_from(owners).map_err(Error::Owners)?;
        let ingress = retained.ingress(owners);
        let resident = retained.resident();
        let base = request
            .checked_add(cancel)
            .ok_or(Error::FixedBaseOverflow {
                request_bytes: request,
                cancel_bytes: cancel,
            })?;
        let fixed = base
            .checked_add(ready.bytes())
            .ok_or(Error::FixedReadyOverflow {
                base_bytes: base,
                ready_bytes: ready.bytes(),
            })?;
        let total = resident.try_add(fixed).map_err(Error::ResidentFixed)?;
        let total = total.try_add(wire).map_err(Error::ResidentDiagnostic)?;
        Ok(Self {
            capacities: Bounds {
                connections: sides,
                inflight,
                admission_waiters: waiters,
                requests: caps.requests,
                responses: Frames {
                    items,
                    bytes,
                    wire: bound,
                },
                notifications: caps.notifications,
            },
            operation_window: window,
            response_retention: retained,
            memory_bound: Memory {
                request_bytes: request,
                cancel_bytes: cancel,
                response_bytes: bytes,
                ingress,
                resident_bytes: resident,
                notification_bytes: notice,
                diagnostic_bytes: wire,
                total_bytes: total,
            },
            runtime: Runtime {
                request_pool: pool,
                request_queue: queue,
                response_arena: arena,
                ready,
                notifications: notices,
                groups: None,
            },
        })
    }

    pub const fn capacities(&self) -> Capacities {
        let bounds = self.capacities;
        Capacities {
            connections: bounds.connections.primary().entries().get(),
            inflight: bounds.inflight,
            admission_waiters: bounds.admission_waiters,
            requests: bounds.requests,
            responses: Response {
                items: bounds.responses.items,
                bytes: bounds.responses.bytes,
                frame_bytes: bounds.responses.wire.into_usize(),
            },
            notifications: bounds.notifications,
        }
    }

    /// Reserves fixed group storage without charging scalar or streaming calls.
    /// Replacements debit the prior group bytes; diagnostics remain bounded by
    /// the checked total, preserving every previously validated base limit.
    pub fn with_groups(mut self, limits: Groups) -> Result<Self, Error> {
        let layout = groups::Layout::try_new(limits)?;
        let limit = self.runtime.response_arena.limit();
        if limits.records.get() > limit.values().get() {
            return Err(Error::GroupRecordsCapacity {
                requested: limits.records,
                available: limit.values().get(),
            });
        }
        if limits.bytes.get() > limit.bytes().get() {
            return Err(Error::GroupBytesCapacity {
                requested: limits.bytes,
                available: limit.bytes().get(),
            });
        }
        let prior = match self.runtime.groups {
            Some(layout) => layout.allocated(),
            None => 0,
        };
        let base = limits::Bound::new(self.memory_bound.total_bytes.bytes() - prior);
        let total = base
            .try_add(layout.allocated())
            .map_err(Error::ResidentDiagnostic)?;
        let bytes = self.memory_bound.diagnostic_bytes - prior + layout.allocated();
        self.memory_bound.diagnostic_bytes = bytes;
        self.memory_bound.total_bytes = total;
        self.runtime.groups = Some(layout);
        Ok(self)
    }

    pub const fn groups(&self) -> Option<Groups> {
        match self.runtime.groups {
            Some(layout) => Some(layout.limits()),
            None => None,
        }
    }

    pub const fn memory_bound(&self) -> &Memory {
        &self.memory_bound
    }

    pub(crate) const fn retention(&self) -> hold::Policy {
        self.response_retention.policy()
    }

    pub(crate) const fn frame_limit(&self) -> u32 {
        self.capacities.responses.wire.get()
    }

    pub(crate) const fn ready_layout(&self) -> plan::Plan {
        self.runtime.ready
    }

    pub(crate) const fn notice_limit(&self) -> NonZero<u32> {
        self.runtime.notifications
    }

    /// Maximum connector sockets reserved by this port: one session and one
    /// bounded cancellation socket for every logical connection.
    pub const fn socket_limit(&self) -> usize {
        self.capacities.connections.primary().scale::<2>().get()
    }

    pub(crate) const fn side(&self) -> side::Capacity {
        self.capacities.connections
    }

    pub(super) const fn runtime(&self) -> &Runtime {
        &self.runtime
    }
}

impl Runtime {
    pub(crate) const fn groups(&self) -> Option<groups::Layout> {
        self.groups
    }
    pub(super) const fn request_pool(&self) -> pool::Layout {
        self.request_pool
    }

    pub(super) const fn queue(&self) -> fair::Plan {
        self.request_queue
    }

    pub(super) const fn arena(&self) -> layout::Layout {
        self.response_arena
    }
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Connection {
    Primary(table::Invalid),
    Side(table::Invalid),
}

const _: () = assert!(mem::size_of::<Bounds>() == mem::size_of::<Capacities>());