rustorb-giop 0.6.0

GIOP/IIOP message types, IOR and corbaloc handling for rustorb
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
use std::io::IoSlice;

use rustorb_cdr::{ByteOrder, CdrEncode, Encoder, Octets};

use crate::{
    CancelRequestHeader, Error, LocateReplyHeader, LocateRequestHeader, MessageHeader, MsgType,
    ReplyHeader, RequestHeader, Result, Version,
};

/// Writes one GIOP message.
///
/// A constructor writes the message header and the message-specific
/// header; [`body`](MessageEncoder::body) gives an encoder for the body,
/// aligned as the version requires; [`finish`](MessageEncoder::finish)
/// fills in the message size.
#[derive(Debug)]
pub struct MessageEncoder {
    enc: Encoder,
    version: Version,
    align_body: bool,
    /// Length before body padding, and length after it, once `body` was
    /// called.
    body_start: Option<(usize, usize)>,
}

impl MessageEncoder {
    /// Starts a message of any type with an empty body.
    pub fn new(
        version: Version,
        order: ByteOrder,
        msg_type: MsgType,
        more_fragments: bool,
    ) -> Result<MessageEncoder> {
        if !version.is_supported() {
            return Err(Error::UnsupportedVersion(version));
        }
        if msg_type == MsgType::Fragment && version == Version::V1_0
            || more_fragments && version == Version::V1_0
        {
            return Err(Error::FragmentNotSupported);
        }
        let header = MessageHeader {
            version,
            byte_order: order,
            more_fragments,
            msg_type,
            message_size: 0,
        };
        let mut enc = Encoder::new(order, version.cdr_version());
        // Room for the headers and a small body without growing.
        enc.reserve(256);
        enc.write_octets(&header.to_bytes());
        Ok(MessageEncoder {
            enc,
            version,
            align_body: false,
            body_start: None,
        })
    }

    /// Starts a `Request`.
    pub fn request(
        version: Version,
        order: ByteOrder,
        header: &RequestHeader,
    ) -> Result<MessageEncoder> {
        let mut m = MessageEncoder::new(version, order, MsgType::Request, false)?;
        let enc = &mut m.enc;
        if version >= Version::V1_2 {
            enc.write_u32(header.request_id);
            enc.write_octet(header.response_flags);
            enc.write_octets(&[0; 3]);
            header.target.encode(enc)?;
            enc.write_string(&header.operation)?;
            header.service_context.encode(enc)?;
            m.align_body = true;
        } else {
            let key = header.target.object_key().ok_or(Error::TargetNotKey)?;
            header.service_context.encode(enc)?;
            enc.write_u32(header.request_id);
            enc.write_bool(header.response_expected());
            if version.minor == 1 {
                enc.write_octets(&[0; 3]);
            }
            enc.write_octet_seq(key)?;
            enc.write_string(&header.operation)?;
            enc.write_octet_seq(&header.requesting_principal)?;
        }
        Ok(m)
    }

    /// Starts a `Reply`.
    pub fn reply(
        version: Version,
        order: ByteOrder,
        header: &ReplyHeader,
    ) -> Result<MessageEncoder> {
        let mut m = MessageEncoder::new(version, order, MsgType::Reply, false)?;
        let enc = &mut m.enc;
        if version >= Version::V1_2 {
            enc.write_u32(header.request_id);
            enc.write_u32(header.reply_status.to_u32());
            header.service_context.encode(enc)?;
            m.align_body = true;
        } else {
            header.service_context.encode(enc)?;
            enc.write_u32(header.request_id);
            enc.write_u32(header.reply_status.to_u32());
        }
        Ok(m)
    }

    /// Writes a `CancelRequest`.
    pub fn cancel_request(
        version: Version,
        order: ByteOrder,
        header: &CancelRequestHeader,
    ) -> Result<Vec<u8>> {
        let mut m = MessageEncoder::new(version, order, MsgType::CancelRequest, false)?;
        m.enc.write_u32(header.request_id);
        m.finish()
    }

    /// Writes a `LocateRequest`.
    pub fn locate_request(
        version: Version,
        order: ByteOrder,
        header: &LocateRequestHeader,
    ) -> Result<Vec<u8>> {
        let mut m = MessageEncoder::new(version, order, MsgType::LocateRequest, false)?;
        m.enc.write_u32(header.request_id);
        if version >= Version::V1_2 {
            header.target.encode(&mut m.enc)?;
        } else {
            let key = header.target.object_key().ok_or(Error::TargetNotKey)?;
            m.enc.write_octet_seq(key)?;
        }
        m.finish()
    }

    /// Starts a `LocateReply`.
    pub fn locate_reply(
        version: Version,
        order: ByteOrder,
        header: &LocateReplyHeader,
    ) -> Result<MessageEncoder> {
        let mut m = MessageEncoder::new(version, order, MsgType::LocateReply, false)?;
        m.enc.write_u32(header.request_id);
        m.enc.write_u32(header.locate_status.to_u32());
        m.align_body = version >= Version::V1_2;
        Ok(m)
    }

    /// Writes a `CloseConnection`.
    pub fn close_connection(version: Version, order: ByteOrder) -> Result<Vec<u8>> {
        MessageEncoder::new(version, order, MsgType::CloseConnection, false)?.finish()
    }

    /// Writes a `MessageError`.
    pub fn message_error(version: Version, order: ByteOrder) -> Result<Vec<u8>> {
        MessageEncoder::new(version, order, MsgType::MessageError, false)?.finish()
    }

    /// Starts a `Fragment`. `request_id` is required for GIOP 1.2 and
    /// ignored for GIOP 1.1. The caller writes the continuation bytes with
    /// [`body`](MessageEncoder::body).
    pub fn fragment(
        version: Version,
        order: ByteOrder,
        request_id: u32,
        more_fragments: bool,
    ) -> Result<MessageEncoder> {
        let mut m = MessageEncoder::new(version, order, MsgType::Fragment, more_fragments)?;
        if version >= Version::V1_2 {
            m.enc.write_u32(request_id);
        }
        Ok(m)
    }

    /// The encoder for the message body. In GIOP 1.2 the first call pads
    /// to an 8-byte boundary for Request, Reply and LocateReply bodies.
    pub fn body(&mut self) -> &mut Encoder {
        if self.body_start.is_none() {
            let before = self.enc.len();
            if self.align_body {
                self.enc.align(8);
            }
            self.body_start = Some((before, self.enc.len()));
            self.enc.allow_shared(true);
            if self.version < Version::V1_2 {
                // So that `OutMessage::with_reply_header` can move the
                // body by 4 bytes.
                self.enc.track_align8();
            }
        }
        &mut self.enc
    }

    /// The version of the message.
    pub fn version(&self) -> Version {
        self.version
    }

    /// Fills in the message size and returns the message bytes. Body
    /// padding is dropped again if no body was written.
    pub fn finish(self) -> Result<Vec<u8>> {
        Ok(self.finish_shared()?.into_vec())
    }

    /// Like [`finish`](MessageEncoder::finish), but large octet sequences
    /// written with
    /// [`write_octet_seq_shared`](Encoder::write_octet_seq_shared) stay
    /// where they are, for a vectored write.
    pub fn finish_shared(mut self) -> Result<OutMessage> {
        let align8 = self.enc.take_align8();
        if let Some((before, after)) = self.body_start {
            if self.enc.len() == after {
                self.enc.truncate(before);
            }
        }
        let len = self.enc.len();
        let header_len = match self.body_start {
            Some((before, _)) => before,
            None => len,
        };
        let size =
            u32::try_from(len - MessageHeader::SIZE).map_err(|_| Error::MessageTooLarge(len))?;
        let size = match self.enc.byte_order() {
            ByteOrder::Big => size.to_be_bytes(),
            ByteOrder::Little => size.to_le_bytes(),
        };
        self.enc.as_bytes_mut()[8..12].copy_from_slice(&size);
        let (bytes, shared) = self.enc.into_parts();
        Ok(OutMessage {
            bytes,
            shared,
            len,
            header_len,
            align8,
        })
    }
}

/// A whole message to send: its bytes, with large octet sequences that
/// were not copied in kept apart.
#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub struct OutMessage {
    bytes: Vec<u8>,
    /// Each with the length of `bytes` at which it goes.
    shared: Vec<(usize, Octets)>,
    len: usize,
    /// Where the body starts (before its padding): the message header and
    /// the message-specific header come before it.
    header_len: usize,
    /// Before GIOP 1.2, the 8-byte alignment points of the body (indexes
    /// in `bytes` before the padding, and the padding), if its bytes
    /// depend on stream offsets only through them.
    align8: Option<Vec<(usize, usize)>>,
}

impl OutMessage {
    /// The length of the message.
    pub fn len(&self) -> usize {
        self.len
    }

    /// Whether the message has no bytes.
    pub fn is_empty(&self) -> bool {
        self.len == 0
    }

    /// The whole message, if it is one piece.
    pub fn as_single(&self) -> Option<&[u8]> {
        self.shared.is_empty().then_some(&self.bytes[..])
    }

    /// The pieces of the message from offset `from` on, in order, for a
    /// vectored write; at most `max` of them.
    pub fn slices_from(&self, from: usize, max: usize) -> Vec<IoSlice<'_>> {
        let mut out = Vec::new();
        let mut offset = 0;
        for piece in self.pieces() {
            if out.len() == max {
                break;
            }
            let end = offset + piece.len();
            if end > from {
                out.push(IoSlice::new(&piece[from.saturating_sub(offset)..]));
            }
            offset = end;
        }
        out
    }

    /// The pieces of the message in order.
    pub fn pieces(&self) -> impl Iterator<Item = &[u8]> {
        let mut from = 0;
        let mut shared = self.shared.iter();
        let mut pending: Option<&[u8]> = None;
        std::iter::from_fn(move || {
            if let Some(octets) = pending.take() {
                return Some(octets);
            }
            match shared.next() {
                Some((at, octets)) => {
                    let piece = &self.bytes[from..*at];
                    from = *at;
                    pending = Some(octets.as_slice());
                    Some(piece)
                }
                None if from != usize::MAX => {
                    let piece = &self.bytes[from..];
                    from = usize::MAX;
                    Some(piece)
                }
                None => None,
            }
        })
    }

    /// Splits a GIOP 1.2 `Request`, `Reply` or `LocateReply` longer than
    /// `size` bytes into a first message and `Fragment` messages of at
    /// most `size` bytes each (`size` rounded down to a multiple of 8, at
    /// least 64), returned one after the other in one `OutMessage`. Other
    /// messages, and messages that fit, are returned as they are.
    ///
    /// The first message keeps the whole message-specific header. Every
    /// message but the last is a multiple of 8 bytes long, so the body
    /// keeps its alignment whether it is read relative to the start of
    /// the whole message or of each `Fragment` (16 bytes of headers).
    pub fn fragment(self, size: usize) -> OutMessage {
        if self.len <= size || self.bytes.len() < MessageHeader::SIZE + 4 {
            return self;
        }
        let size = (size & !7).max(64);
        if self.len <= size {
            return self;
        }
        let head = &self.bytes[..MessageHeader::SIZE];
        let version = Version {
            major: head[4],
            minor: head[5],
        };
        let flags = head[6];
        let fragmentable = matches!(head[7], 0 | 1 | 4); // Request, Reply, LocateReply
        if version != Version::V1_2 || !fragmentable || flags & 2 != 0 {
            return self;
        }
        let first = size.max((self.header_len + 7) & !7);
        if first >= self.len {
            return self;
        }
        let order = if flags & 1 != 0 {
            ByteOrder::Little
        } else {
            ByteOrder::Big
        };
        let u32_bytes = |v: u32| match order {
            ByteOrder::Big => v.to_be_bytes(),
            ByteOrder::Little => v.to_le_bytes(),
        };
        let request_id = [
            self.bytes[12],
            self.bytes[13],
            self.bytes[14],
            self.bytes[15],
        ];
        let len = self.len;
        let whole = self.into_vec();
        let per = size - MessageHeader::SIZE - 4;
        let count = 1 + (len - first).div_ceil(per);
        let mut out = Vec::with_capacity(len + count * (MessageHeader::SIZE + 4));
        out.extend_from_slice(&whole[..first]);
        out[6] |= 2;
        out[8..12].copy_from_slice(&u32_bytes((first - MessageHeader::SIZE) as u32));
        let mut at = first;
        while at < len {
            let end = (at + per).min(len);
            let more = end < len;
            out.extend_from_slice(&whole[..6]);
            out.push(flags & 1 | if more { 2 } else { 0 });
            out.push(7); // Fragment
            out.extend_from_slice(&u32_bytes((end - at + 4) as u32));
            out.extend_from_slice(&request_id);
            out.extend_from_slice(&whole[at..end]);
            at = end;
        }
        OutMessage::from(out)
    }

    /// The same `Reply` (made with [`MessageEncoder::reply`]) with the
    /// message-specific header `header` instead, for service contexts that
    /// are known only once the body has been written. The body is kept as
    /// it is: in GIOP 1.2 it starts on an 8-byte boundary after the
    /// header, so it does not depend on the header's length. Before GIOP
    /// 1.2 it follows the header directly and is aligned from the start of
    /// the message, so a header whose length differs by 4 modulo 8 moves
    /// it off its alignment. Then the padding before each 8-byte aligned
    /// item of the body is written again (data aligned to at most 4 bytes
    /// is unaffected), unless the body holds something else whose bytes
    /// depend on stream offsets (a valuetype, a `TypeCode` indirection):
    /// then `Err` returns the message unchanged.
    pub fn with_reply_header(
        self,
        header: &ReplyHeader,
    ) -> std::result::Result<OutMessage, OutMessage> {
        if self.bytes.len() < MessageHeader::SIZE || self.bytes[7] != 1 {
            return Err(self);
        }
        let version = Version {
            major: self.bytes[4],
            minor: self.bytes[5],
        };
        let order = if self.bytes[6] & 1 != 0 {
            ByteOrder::Little
        } else {
            ByteOrder::Big
        };
        let Ok(head) = MessageEncoder::reply(version, order, header) else {
            return Err(self);
        };
        let (mut bytes, _) = head.enc.into_parts();
        let new_header_len = bytes.len();
        let has_body = self.len > self.header_len;
        let (old_start, new_start) = if version >= Version::V1_2 && has_body {
            ((self.header_len + 7) & !7, (new_header_len + 7) & !7)
        } else {
            (self.header_len, new_header_len)
        };
        if version < Version::V1_2 && (new_start % 8) != (old_start % 8) {
            // Each point grows the body by at most 4 bytes.
            let grown =
                |points: &Vec<(usize, usize)>| self.len - old_start + new_start + 4 * points.len();
            return match &self.align8 {
                Some(points) if u32::try_from(grown(points)).is_ok() => {
                    Ok(self.realigned(bytes, old_start, new_start, order))
                }
                _ => Err(self),
            };
        }
        let size = self.len - old_start + new_start;
        let Ok(message_size) = u32::try_from(size - MessageHeader::SIZE) else {
            return Err(self);
        };
        bytes.resize(new_start, 0);
        bytes.extend_from_slice(&self.bytes[old_start..]);
        let size_bytes = match order {
            ByteOrder::Big => message_size.to_be_bytes(),
            ByteOrder::Little => message_size.to_le_bytes(),
        };
        bytes[8..12].copy_from_slice(&size_bytes);
        let shared = self
            .shared
            .into_iter()
            .map(|(at, octets)| (at - old_start + new_start, octets))
            .collect();
        Ok(OutMessage {
            bytes,
            shared,
            len: size,
            header_len: new_header_len,
            align8: None,
        })
    }

    /// The body (from `old_start`) after the new header `bytes`, which
    /// ends at `new_start`, with the padding at each 8-byte alignment
    /// point of the body written again for its new offset.
    fn realigned(
        self,
        mut bytes: Vec<u8>,
        old_start: usize,
        new_start: usize,
        order: ByteOrder,
    ) -> OutMessage {
        bytes.resize(new_start, 0);
        let header_len = new_start;
        let mut shared = Vec::with_capacity(self.shared.len());
        let mut pending = self.shared.into_iter().peekable();
        // Shared octets placed so far: they come between buffer bytes.
        let mut extra = 0;
        let mut from = old_start;
        for (at, old_pad) in self.align8.unwrap_or_default() {
            // Shared octets written before this point come before its
            // padding.
            while let Some((j, octets)) = pending.next_if(|(j, _)| *j <= at) {
                extra += octets.len();
                shared.push((bytes.len() + j - from, octets));
            }
            bytes.extend_from_slice(&self.bytes[from..at]);
            let pad = (8 - (bytes.len() + extra) % 8) % 8;
            bytes.resize(bytes.len() + pad, 0);
            from = at + old_pad;
        }
        for (j, octets) in pending {
            extra += octets.len();
            shared.push((bytes.len() + j - from, octets));
        }
        bytes.extend_from_slice(&self.bytes[from..]);
        let len = bytes.len() + extra;
        let message_size = (len - MessageHeader::SIZE) as u32;
        let size_bytes = match order {
            ByteOrder::Big => message_size.to_be_bytes(),
            ByteOrder::Little => message_size.to_le_bytes(),
        };
        bytes[8..12].copy_from_slice(&size_bytes);
        OutMessage {
            bytes,
            shared,
            len,
            header_len,
            align8: None,
        }
    }

    /// The message as one buffer; copies only if octets were kept apart.
    pub fn into_vec(self) -> Vec<u8> {
        if self.shared.is_empty() {
            return self.bytes;
        }
        let mut out = Vec::with_capacity(self.len);
        for piece in self.pieces() {
            out.extend_from_slice(piece);
        }
        out
    }
}

impl From<Vec<u8>> for OutMessage {
    fn from(bytes: Vec<u8>) -> OutMessage {
        let len = bytes.len();
        OutMessage {
            bytes,
            shared: Vec::new(),
            len,
            header_len: len,
            align8: None,
        }
    }
}