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
//! Inter-contract call supporting structures

use fuel_asm::{
    PanicReason,
    RegId,
};
use fuel_types::{
    bytes::{
        self,
        SizedBytes,
    },
    mem_layout,
    AssetId,
    ContractId,
    MemLayout,
    MemLocType,
    Word,
};

use crate::consts::{
    WORD_SIZE,
    *,
};
use std::io::{
    self,
    Write,
};

#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
/// Call structure representation, composed of a called contract `to` and two
/// word arguments.
///
/// <https://github.com/FuelLabs/fuel-specs/blob/master/src/vm/instruction_set.md#call-call-contract>
pub struct Call {
    to: ContractId,
    a: Word,
    b: Word,
}

mem_layout!(
    CallLayout for Call
    to: ContractId = {ContractId::LEN},
    a: Word = WORD_SIZE,
    b: Word = WORD_SIZE
);

impl Call {
    /// The size of the call structures in memory representation.
    pub const LEN: usize = <Call as MemLayout>::LEN;

    /// Create a new call structure representation.
    pub const fn new(to: ContractId, a: Word, b: Word) -> Self {
        Self { to, a, b }
    }

    /// Called contract.
    pub const fn to(&self) -> &ContractId {
        &self.to
    }

    /// `a` argument.
    pub const fn a(&self) -> Word {
        self.a
    }

    /// `b` argument.
    pub const fn b(&self) -> Word {
        self.b
    }

    /// Expose the internal attributes of the call description.
    pub const fn into_inner(self) -> (ContractId, Word, Word) {
        (self.to, self.a, self.b)
    }
}

impl From<Call> for [u8; Call::LEN] {
    fn from(val: Call) -> [u8; Call::LEN] {
        let mut buf = [0u8; Call::LEN];
        bytes::store_at(&mut buf, Call::layout(Call::LAYOUT.to), &val.to);
        bytes::store_number_at(&mut buf, Call::layout(Call::LAYOUT.a), val.a);
        bytes::store_number_at(&mut buf, Call::layout(Call::LAYOUT.b), val.b);
        buf
    }
}

impl From<[u8; Self::LEN]> for Call {
    fn from(buf: [u8; Self::LEN]) -> Self {
        let to = bytes::restore_at(&buf, Self::layout(Self::LAYOUT.to));
        let a = bytes::restore_number_at(&buf, Self::layout(Self::LAYOUT.a));
        let b = bytes::restore_number_at(&buf, Self::layout(Self::LAYOUT.b));

        Self {
            to: to.into(),
            a,
            b,
        }
    }
}

impl SizedBytes for Call {
    fn serialized_size(&self) -> usize {
        Self::LEN
    }
}

impl io::Read for Call {
    fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
        let buf: &mut [_; Self::LEN] = buf
            .get_mut(..Self::LEN)
            .and_then(|slice| slice.try_into().ok())
            .ok_or(bytes::eof())?;

        let bytes: [u8; Self::LEN] = (*self).into();
        buf.copy_from_slice(&bytes);

        Ok(Self::LEN)
    }
}

impl io::Write for Call {
    fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
        let buf: &[_; Self::LEN] = buf
            .get(..Self::LEN)
            .and_then(|slice| slice.try_into().ok())
            .ok_or(bytes::eof())?;

        *self = Self::from(*buf);

        Ok(Self::LEN)
    }

    fn flush(&mut self) -> io::Result<()> {
        Ok(())
    }
}

impl TryFrom<&[u8]> for Call {
    type Error = PanicReason;

    fn try_from(bytes: &[u8]) -> Result<Self, PanicReason> {
        let mut call = Self::default();

        call.write(bytes)
            .map_err(|_| PanicReason::MalformedCallStructure)?;

        Ok(call)
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
/// Call frame representation in the VM stack.
///
/// <https://github.com/FuelLabs/fuel-specs/blob/master/src/vm/index.md#call-frames>
pub struct CallFrame {
    to: ContractId,
    asset_id: AssetId,
    registers: [Word; VM_REGISTER_COUNT],
    code_size: Word,
    a: Word,
    b: Word,
}

mem_layout!(
    CallFrameLayout for CallFrame
    to: ContractId = {ContractId::LEN},
    asset_id: AssetId = {AssetId::LEN},
    registers: [u8; WORD_SIZE * VM_REGISTER_COUNT] = {WORD_SIZE * VM_REGISTER_COUNT},
    code_size: Word = WORD_SIZE,
    a: Word = WORD_SIZE,
    b: Word = WORD_SIZE
);

#[cfg(test)]
impl Default for CallFrame {
    fn default() -> Self {
        Self {
            to: ContractId::default(),
            asset_id: AssetId::default(),
            registers: [0; VM_REGISTER_COUNT],
            code_size: 0,
            a: 0,
            b: 0,
        }
    }
}

impl CallFrame {
    /// Create a new call frame.
    pub const fn new(
        to: ContractId,
        asset_id: AssetId,
        registers: [Word; VM_REGISTER_COUNT],
        code_size: Word,
        a: Word,
        b: Word,
    ) -> Self {
        Self {
            to,
            asset_id,
            registers,
            code_size,
            a,
            b,
        }
    }

    /// Start of the contract id offset from the beginning of the call frame.
    pub const fn contract_id_offset() -> usize {
        0
    }

    /// Start of the asset id offset from the beginning of the call frame.
    pub const fn asset_id_offset() -> usize {
        Self::contract_id_offset() + ContractId::LEN
    }

    /// Start of the registers offset from the beginning of the call frame.
    pub const fn registers_offset() -> usize {
        Self::asset_id_offset() + AssetId::LEN
    }

    /// Start of the code size offset from the beginning of the call frame.
    pub const fn code_size_offset() -> usize {
        Self::registers_offset() + WORD_SIZE * (VM_REGISTER_COUNT)
    }

    /// Start of the `a` argument offset from the beginning of the call frame.
    pub const fn a_offset() -> usize {
        Self::code_size_offset() + WORD_SIZE
    }

    /// Start of the `b` argument offset from the beginning of the call frame.
    pub const fn b_offset() -> usize {
        Self::a_offset() + WORD_SIZE
    }

    /// Size of the call frame in bytes.
    pub const fn serialized_size() -> usize {
        Self::b_offset() + WORD_SIZE
    }

    /// Registers prior to the called execution.
    pub const fn registers(&self) -> &[Word] {
        &self.registers
    }

    /// Called contract id.
    pub const fn to(&self) -> &ContractId {
        &self.to
    }

    /// Contract code length in bytes.
    pub fn code_size(&self) -> Word {
        self.code_size
    }

    /// Padding to the next word boundary.
    pub fn code_size_padding(&self) -> Word {
        const WORD_SIZE: Word = crate::consts::WORD_SIZE as Word;
        (WORD_SIZE - self.code_size() % WORD_SIZE) % WORD_SIZE
    }

    /// Total code size including padding.
    pub fn total_code_size(&self) -> Word {
        self.code_size() + self.code_size_padding()
    }

    /// `a` argument.
    pub const fn a(&self) -> Word {
        self.a
    }

    /// `b` argument.
    pub const fn b(&self) -> Word {
        self.b
    }

    /// Gas context prior to the called execution.
    pub fn context_gas(&self) -> Word {
        self.registers[RegId::CGAS]
    }

    /// Asset ID of forwarded coins.
    pub const fn asset_id(&self) -> &AssetId {
        &self.asset_id
    }

    /// Returns the mutable value of the context gas for this call frame.
    pub fn context_gas_mut(&mut self) -> &mut Word {
        &mut self.registers[RegId::CGAS]
    }

    /// Returns the mutable value of the global gas for this call frame.
    pub fn global_gas_mut(&mut self) -> &mut Word {
        &mut self.registers[RegId::GGAS]
    }
}

impl SizedBytes for CallFrame {
    fn serialized_size(&self) -> usize {
        Self::serialized_size()
    }
}

impl io::Read for CallFrame {
    fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
        let buf: &mut [_; Self::LEN] = buf
            .get_mut(..Self::LEN)
            .and_then(|slice| slice.try_into().ok())
            .ok_or(bytes::eof())?;

        bytes::store_at(buf, Self::layout(Self::LAYOUT.to), &self.to);
        bytes::store_at(buf, Self::layout(Self::LAYOUT.asset_id), &self.asset_id);
        let mut registers = [0u8; Self::LAYOUT.registers.size()];
        for (reg, out) in self
            .registers
            .iter()
            .zip(registers.chunks_exact_mut(WORD_SIZE))
        {
            bytes::store_number(
                out.try_into().expect("Can't fail as chunks are exact"),
                *reg,
            );
        }
        bytes::store_at(buf, Self::layout(Self::LAYOUT.registers), &registers);
        bytes::store_number_at(buf, Self::layout(Self::LAYOUT.code_size), self.code_size);
        bytes::store_number_at(buf, Self::layout(Self::LAYOUT.a), self.a);
        bytes::store_number_at(buf, Self::layout(Self::LAYOUT.b), self.b);

        Ok(Self::LEN)
    }
}

impl io::Write for CallFrame {
    fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
        let buf: &[_; Self::LEN] = buf
            .get(..Self::LEN)
            .and_then(|slice| slice.try_into().ok())
            .ok_or(bytes::eof())?;

        let to = bytes::restore_at(buf, Self::layout(Self::LAYOUT.to));
        let asset_id = bytes::restore_at(buf, Self::layout(Self::LAYOUT.asset_id));
        let registers = bytes::restore_at(buf, Self::layout(Self::LAYOUT.registers));
        let code_size =
            bytes::restore_number_at(buf, Self::layout(Self::LAYOUT.code_size));
        let a = bytes::restore_number_at(buf, Self::layout(Self::LAYOUT.a));
        let b = bytes::restore_number_at(buf, Self::layout(Self::LAYOUT.b));

        for (reg, word) in self
            .registers
            .iter_mut()
            .zip(registers.chunks_exact(WORD_SIZE))
        {
            *reg = bytes::restore_number(
                word.try_into().expect("Can't fail as chunks are exact"),
            );
        }

        self.to = to.into();
        self.asset_id = asset_id.into();
        self.code_size = code_size;
        self.a = a;
        self.b = b;

        Ok(Self::LEN)
    }

    fn flush(&mut self) -> io::Result<()> {
        Ok(())
    }
}

#[cfg(test)]
impl From<Call> for Vec<u8> {
    fn from(mut call: Call) -> Self {
        use io::Read;
        let mut buf = [0; Call::LEN];
        call.read_exact(&mut buf[..]).unwrap();
        buf.to_vec()
    }
}

#[cfg(test)]
impl From<CallFrame> for Vec<u8> {
    fn from(mut call: CallFrame) -> Self {
        use io::Read;
        let mut buf = [0; CallFrame::serialized_size()];
        call.read_exact(&mut buf[..]).unwrap();
        buf.to_vec()
    }
}