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
//! Storage imports.
use std::convert::TryInto;

use oasis_contract_sdk_types::storage::StoreKind;
use oasis_runtime_sdk::{context::Context, storage::Store};

use super::{memory::Region, OasisV1};
use crate::{
    abi::{gas, ExecutionContext},
    store, Config, Error,
};

impl<Cfg: Config> OasisV1<Cfg> {
    /// Link storage functions.
    pub fn link_storage<C: Context>(
        instance: &mut wasm3::Instance<'_, '_, ExecutionContext<'_, C>>,
    ) -> Result<(), Error> {
        // storage.get(store, key) -> value
        let _ = instance.link_function(
            "storage",
            "get",
            |ctx, (store, key): (u32, (u32, u32))| -> Result<u32, wasm3::Trap> {
                // Make sure function was called in valid context.
                let ec = ctx.context.ok_or(wasm3::Trap::Abort)?;
                let store_kind: StoreKind = store.try_into().map_err(|_| wasm3::Trap::Abort)?;

                ensure_key_size(ec, key.1)?;

                // Charge base gas amount plus size-dependent gas.
                let total_gas = (|| {
                    let (base, key_base) = match store_kind {
                        StoreKind::Public => (
                            ec.params.gas_costs.wasm_public_storage_get_base,
                            ec.params.gas_costs.wasm_public_storage_key_byte,
                        ),
                        StoreKind::Confidential => (
                            ec.params.gas_costs.wasm_confidential_storage_get_base,
                            ec.params.gas_costs.wasm_confidential_storage_key_byte,
                        ),
                    };
                    let key = key_base.checked_mul(key.1.into())?;
                    let total = base.checked_add(key)?;
                    Some(total)
                })()
                .ok_or(wasm3::Trap::Abort)?;
                gas::use_gas(ctx.instance, total_gas)?;

                // Read from contract state.
                let value = ctx.instance.runtime().try_with_memory(
                    |memory| -> Result<_, wasm3::Trap> {
                        let key = Region::from_arg(key).as_slice(&memory)?;
                        with_instance_store(ec, store_kind, |store| store.get(key))
                    },
                )??;

                let value = match value {
                    Some(value) => value,
                    None => return Ok(0),
                };

                // Charge gas for size of value.
                let value_byte_cost = match store_kind {
                    StoreKind::Public => ec.params.gas_costs.wasm_public_storage_value_byte,
                    StoreKind::Confidential => {
                        ec.params.gas_costs.wasm_confidential_storage_value_byte
                    }
                };
                gas::use_gas(
                    ctx.instance,
                    value_byte_cost
                        .checked_mul(value.len().try_into()?)
                        .ok_or(wasm3::Trap::Abort)?,
                )?;

                // Create new region by calling `allocate`.
                //
                // This makes sure that the call context is unset to avoid any potential issues
                // with reentrancy as attempting to re-enter one of the linked functions will fail.
                let value_region = Self::allocate_and_copy(ctx.instance, &value)?;

                // Return a pointer to the region.
                Self::allocate_region(ctx.instance, value_region).map_err(|e| e.into())
            },
        );

        // storage.insert(store, key, value)
        let _ = instance.link_function(
            "storage",
            "insert",
            |ctx, (store, key, value): (u32, (u32, u32), (u32, u32))| {
                // Make sure function was called in valid context.
                let ec = ctx.context.ok_or(wasm3::Trap::Abort)?;
                let store_kind: StoreKind = store.try_into().map_err(|_| wasm3::Trap::Abort)?;

                ensure_key_size(ec, key.1)?;
                ensure_value_size(ec, value.1)?;

                // Charge base gas amount plus size-dependent gas.
                let total_gas = (|| {
                    let (base, key_base, value_base) = match store_kind {
                        StoreKind::Public => (
                            ec.params.gas_costs.wasm_public_storage_insert_base,
                            ec.params.gas_costs.wasm_public_storage_key_byte,
                            ec.params.gas_costs.wasm_public_storage_value_byte,
                        ),
                        StoreKind::Confidential => (
                            ec.params.gas_costs.wasm_confidential_storage_insert_base,
                            ec.params.gas_costs.wasm_confidential_storage_key_byte,
                            ec.params.gas_costs.wasm_confidential_storage_value_byte,
                        ),
                    };
                    let key = key_base.checked_mul(key.1.into())?;
                    let value = value_base.checked_mul(value.1.into())?;
                    let total = base.checked_add(key)?.checked_add(value)?;
                    Some(total)
                })()
                .ok_or(wasm3::Trap::Abort)?;
                gas::use_gas(ctx.instance, total_gas)?;

                // Insert into contract state.
                ctx.instance
                    .runtime()
                    .try_with_memory(|memory| -> Result<(), wasm3::Trap> {
                        let key = Region::from_arg(key).as_slice(&memory)?;
                        let value = Region::from_arg(value).as_slice(&memory)?;
                        with_instance_store(ec, store_kind, |store| store.insert(key, value))
                    })??;

                Ok(())
            },
        );

        // storage.remove(store, key)
        let _ = instance.link_function(
            "storage",
            "remove",
            |ctx, (store, key): (u32, (u32, u32))| {
                // Make sure function was called in valid context.
                let ec = ctx.context.ok_or(wasm3::Trap::Abort)?;
                let store_kind: StoreKind = store.try_into().map_err(|_| wasm3::Trap::Abort)?;

                ensure_key_size(ec, key.1)?;

                // Charge base gas amount plus size-dependent gas.
                let total_gas = (|| {
                    let (base, key_base) = match store_kind {
                        StoreKind::Public => (
                            ec.params.gas_costs.wasm_public_storage_remove_base,
                            ec.params.gas_costs.wasm_public_storage_key_byte,
                        ),
                        StoreKind::Confidential => (
                            ec.params.gas_costs.wasm_confidential_storage_remove_base,
                            ec.params.gas_costs.wasm_confidential_storage_key_byte,
                        ),
                    };
                    let key = key_base.checked_mul(key.1.into())?;
                    let total = base.checked_add(key)?;
                    Some(total)
                })()
                .ok_or(wasm3::Trap::Abort)?;
                gas::use_gas(ctx.instance, total_gas)?;

                // Remove from contract state.
                ctx.instance
                    .runtime()
                    .try_with_memory(|memory| -> Result<(), wasm3::Trap> {
                        let key = Region::from_arg(key).as_slice(&memory)?;
                        with_instance_store(ec, store_kind, |store| store.remove(key))
                    })??;

                Ok(())
            },
        );

        Ok(())
    }
}

/// Run a closure with the contract instance store.
fn with_instance_store<C, F, R>(
    ec: &mut ExecutionContext<'_, C>,
    store_kind: StoreKind,
    f: F,
) -> Result<R, wasm3::Trap>
where
    C: Context,
    F: FnOnce(&mut dyn Store) -> R,
{
    store::with_instance_store(ec.tx_context, ec.instance_info, store_kind, |store| {
        f(store)
    })
    .map_err(|err| {
        // Propagate the underlying error.
        ec.aborted = Some(err);
        wasm3::Trap::Abort
    })
}

/// Make sure that the key size is within the range specified in module parameters.
fn ensure_key_size<C: Context>(
    ec: &mut ExecutionContext<'_, C>,
    size: u32,
) -> Result<(), wasm3::Trap> {
    if size > ec.params.max_storage_key_size_bytes {
        ec.aborted = Some(Error::StorageKeyTooLarge(
            size,
            ec.params.max_storage_key_size_bytes,
        ));
        return Err(wasm3::Trap::Abort);
    }
    Ok(())
}

/// Make sure that the value size is within the range specified in module parameters.
fn ensure_value_size<C: Context>(
    ec: &mut ExecutionContext<'_, C>,
    size: u32,
) -> Result<(), wasm3::Trap> {
    if size > ec.params.max_storage_value_size_bytes {
        ec.aborted = Some(Error::StorageValueTooLarge(
            size,
            ec.params.max_storage_value_size_bytes,
        ));
        return Err(wasm3::Trap::Abort);
    }
    Ok(())
}

#[cfg(all(feature = "benchmarks", test))]
mod bench {
    extern crate test;
    use super::*;
    use std::{cell::RefCell, rc::Rc};
    use test::Bencher;

    use oasis_runtime_sdk::{context::Context, storage, testing::mock::Mock};

    // cargo build --target wasm32-unknown-unknown --release
    const BENCH_CODE: &[u8] = include_bytes!(
        "../../../../../../tests/contracts/bench/target/wasm32-unknown-unknown/release/bench.wasm"
    );

    fn make_items(num: usize) -> Vec<(Vec<u8>, Vec<u8>)> {
        let mut items = Vec::new();
        for i in 0..num {
            items.push((
                format!("key{}", i).into_bytes(),
                format!("value{}", i).into_bytes(),
            ));
        }
        items
    }

    struct StoreContext<'a> {
        store: Box<dyn storage::Store + 'a>,
    }

    #[bench]
    fn bench_wasm_plain_get(b: &mut Bencher) {
        // Set up storage stack and insert some items into it.
        let mut mock = Mock::default();
        let mut ctx = mock.create_ctx();
        let inner = storage::PrefixStore::new(
            storage::PrefixStore::new(
                storage::PrefixStore::new(ctx.runtime_state(), "test module"),
                "instance prefix",
            ),
            "type prefix",
        );
        let mut store_ctx = StoreContext {
            store: Box::new(storage::HashedStore::<_, blake3::Hasher>::new(inner)),
        };

        let items = make_items(10_000);
        for i in 0..10_000 {
            let item = &items[i % items.len()];
            store_ctx.store.insert(&item.0, &item.1);
        }

        // Set up wasm runtime.
        let env =
            wasm3::Environment::new().expect("creating a new wasm3 environment should succeed");
        let module = env
            .parse_module(BENCH_CODE)
            .expect("parsing the code should succeed");
        let rt: wasm3::Runtime<'_, StoreContext<'_>> = env
            .new_runtime(1 * 1024 * 1024, None)
            .expect("creating a new wasm3 runtime should succeed");
        let mut instance = rt
            .load_module(module)
            .expect("instance creation should succeed");
        let _ = instance.link_function(
            "bench",
            "plain_get",
            |ctx, key: (u32, u32)| -> Result<u32, wasm3::Trap> {
                let key = ctx.instance.runtime().try_with_memory(
                    |memory| -> Result<Vec<u8>, wasm3::Trap> {
                        Ok(Region::from_arg(key)
                            .as_slice(&memory)
                            .map_err(|_| wasm3::Trap::Abort)?
                            .into())
                    },
                )??;
                let store_ctx = ctx.context.ok_or(wasm3::Trap::Abort)?;
                match store_ctx.store.get(&key) {
                    None => Ok(0),
                    Some(value) => {
                        let alloc = ctx
                            .instance
                            .find_function::<u32, u32>("alloc")
                            .expect("finding alloc function should succeed");
                        let val_len = value.len() as u32;
                        let target_offset = alloc
                            .call(val_len + std::mem::size_of::<u32>() as u32)
                            .expect("alloc should succeed")
                            as usize;

                        ctx.instance.runtime().try_with_memory(
                            |mut memory| -> Result<_, wasm3::Trap> {
                                let len_bytes = &mut memory.as_slice_mut()
                                    [target_offset..target_offset + std::mem::size_of::<u32>()];
                                len_bytes.copy_from_slice(&val_len.to_le_bytes());

                                let val_start = target_offset + std::mem::size_of::<u32>();
                                let target =
                                    &mut memory.as_slice_mut()[val_start..val_start + value.len()];
                                target.copy_from_slice(&value);
                                Ok(target_offset as u32)
                            },
                        )?
                    }
                }
            },
        );
        let func = instance
            .find_function::<(), ()>("bench_storage_get")
            .expect("finding the entrypoint function should succeed");
        b.iter(|| {
            func.call_with_context(&mut store_ctx, ())
                .expect("function call should succeed");
        });
    }

    #[bench]
    fn bench_wasm_plain_insert(b: &mut Bencher) {
        // Set up storage stack and insert some items into it.
        let mut mock = Mock::default();
        let mut ctx = mock.create_ctx();
        let inner = storage::PrefixStore::new(
            storage::PrefixStore::new(
                storage::PrefixStore::new(ctx.runtime_state(), "test module"),
                "instance prefix",
            ),
            "type prefix",
        );
        let mut store_ctx = StoreContext {
            store: Box::new(storage::HashedStore::<_, blake3::Hasher>::new(inner)),
        };

        // Set up wasm runtime.
        let env =
            wasm3::Environment::new().expect("creating a new wasm3 environment should succeed");
        let module = env
            .parse_module(BENCH_CODE)
            .expect("parsing the code should succeed");
        let rt: wasm3::Runtime<'_, StoreContext<'_>> = env
            .new_runtime(1 * 1024 * 1024, None)
            .expect("creating a new wasm3 runtime should succeed");
        let mut instance = rt
            .load_module(module)
            .expect("instance creation should succeed");
        let _ = instance.link_function(
            "bench",
            "plain_insert",
            |ctx, (key, value): ((u32, u32), (u32, u32))| -> Result<u32, wasm3::Trap> {
                let key = ctx.instance.runtime().try_with_memory(
                    |memory| -> Result<Vec<u8>, wasm3::Trap> {
                        Ok(Region::from_arg(key)
                            .as_slice(&memory)
                            .map_err(|_| wasm3::Trap::Abort)?
                            .into())
                    },
                )??;
                let value = ctx.instance.runtime().try_with_memory(
                    |memory| -> Result<Vec<u8>, wasm3::Trap> {
                        Ok(Region::from_arg(value)
                            .as_slice(&memory)
                            .map_err(|_| wasm3::Trap::Abort)?
                            .into())
                    },
                )??;
                let store_ctx = ctx.context.ok_or(wasm3::Trap::Abort)?;
                store_ctx.store.insert(&key, &value);
                Ok(0)
            },
        );
        let func = instance
            .find_function::<u32, u32>("bench_storage_insert")
            .expect("finding the entrypoint function should succeed");
        let mut counter_base: u32 = 0;
        b.iter(|| {
            counter_base += func
                .call_with_context(&mut store_ctx, counter_base)
                .expect("function call should succeed");
        });
    }

    #[bench]
    fn bench_wasm_plain_remove(b: &mut Bencher) {
        // Set up storage stack and insert some items into it.
        let mut mock = Mock::default();
        let mut ctx = mock.create_ctx();
        let inner = storage::PrefixStore::new(
            storage::PrefixStore::new(
                storage::PrefixStore::new(ctx.runtime_state(), "test module"),
                "instance prefix",
            ),
            "type prefix",
        );
        let mut store_ctx = StoreContext {
            store: Box::new(storage::HashedStore::<_, blake3::Hasher>::new(inner)),
        };

        for i in 0..2_000_000 {
            store_ctx.store.insert(
                format!("key{}", i).as_bytes(),
                format!("value{}", i).as_bytes(),
            );
        }

        // Set up wasm runtime.
        let env =
            wasm3::Environment::new().expect("creating a new wasm3 environment should succeed");
        let module = env
            .parse_module(BENCH_CODE)
            .expect("parsing the code should succeed");
        let rt: wasm3::Runtime<'_, StoreContext<'_>> = env
            .new_runtime(1 * 1024 * 1024, None)
            .expect("creating a new wasm3 runtime should succeed");
        let mut instance = rt
            .load_module(module)
            .expect("instance creation should succeed");
        let _ = instance.link_function(
            "bench",
            "plain_remove",
            |ctx, key: (u32, u32)| -> Result<u32, wasm3::Trap> {
                let key = ctx.instance.runtime().try_with_memory(
                    |memory| -> Result<Vec<u8>, wasm3::Trap> {
                        Ok(Region::from_arg(key)
                            .as_slice(&memory)
                            .map_err(|_| wasm3::Trap::Abort)?
                            .into())
                    },
                )??;
                let store_ctx = ctx.context.ok_or(wasm3::Trap::Abort)?;
                store_ctx.store.remove(&key);
                Ok(0)
            },
        );
        let func = instance
            .find_function::<u32, u32>("bench_storage_remove")
            .expect("finding the entrypoint function should succeed");
        let mut counter_base: u32 = 0;
        b.iter(|| {
            counter_base += func
                .call_with_context(&mut store_ctx, counter_base)
                .expect("function call should succeed");
        });
    }

    #[bench]
    fn bench_nowasm_get(b: &mut Bencher) {
        // Set up storage stack and insert some items into it.
        let mut mock = Mock::default();
        let mut ctx = mock.create_ctx();
        let inner = storage::PrefixStore::new(
            storage::PrefixStore::new(
                storage::PrefixStore::new(ctx.runtime_state(), "test module"),
                "instance prefix",
            ),
            "type prefix",
        );
        let mut store = Box::new(storage::HashedStore::<_, blake3::Hasher>::new(inner));

        let items = make_items(10_000);
        for i in 0..10_000 {
            let item = &items[i % items.len()];
            store.insert(&item.0, &item.1);
        }
        b.iter(move || {
            for i in 0..5_000 {
                let key = format!("key{}", i);
                let exp_value = format!("value{}", i);
                let value = store.get(key.as_bytes()).unwrap();
                assert_eq!(exp_value.as_bytes(), value.as_slice());
            }
        });
    }

    #[bench]
    fn bench_wasm_reach_gas_limit(_b: &mut Bencher) {
        // Set up storage stack and insert some items into it.
        let mut mock = Mock::default();
        let mut ctx = mock.create_ctx();
        let inner = storage::PrefixStore::new(
            storage::PrefixStore::new(
                storage::PrefixStore::new(ctx.runtime_state(), "test module"),
                "instance prefix",
            ),
            "type prefix",
        );
        let mut store_ctx = StoreContext {
            store: Box::new(storage::HashedStore::<_, blake3::Hasher>::new(inner)),
        };

        let params = crate::Parameters::default();
        let params_cb = params.clone();

        // Set up wasm runtime.
        let mut module = walrus::ModuleConfig::new()
            .generate_producers_section(false)
            .parse(&BENCH_CODE)
            .unwrap();
        gas::transform(&mut module);
        let instrumented_code = module.emit_wasm();
        let env =
            wasm3::Environment::new().expect("creating a new wasm3 environment should succeed");
        let module = env
            .parse_module(&instrumented_code)
            .expect("parsing the code should succeed");
        let rt: wasm3::Runtime<'_, StoreContext<'_>> = env
            .new_runtime(1 * 1024 * 1024, None)
            .expect("creating a new wasm3 runtime should succeed");
        let mut instance = rt
            .load_module(module)
            .expect("instance creation should succeed");
        let initial_gas: u64 = 1_000_000_000;
        instance
            .set_global(gas::EXPORT_GAS_LIMIT, initial_gas)
            .expect("setting gas limit should succeed");

        let bytes_written: Rc<RefCell<usize>> = Rc::new(RefCell::new(0));
        let bytes_written_cb = bytes_written.clone();

        let _ = instance.link_function(
            "bench",
            "plain_insert",
            move |ctx, (key, value): ((u32, u32), (u32, u32))| -> Result<u32, wasm3::Trap> {
                let key = ctx.instance.runtime().try_with_memory(
                    |memory| -> Result<Vec<u8>, wasm3::Trap> {
                        Ok(Region::from_arg(key)
                            .as_slice(&memory)
                            .map_err(|_| wasm3::Trap::Abort)?
                            .into())
                    },
                )??;
                let value = ctx.instance.runtime().try_with_memory(
                    |memory| -> Result<Vec<u8>, wasm3::Trap> {
                        Ok(Region::from_arg(value)
                            .as_slice(&memory)
                            .map_err(|_| wasm3::Trap::Abort)?
                            .into())
                    },
                )??;

                let total_gas = (|| {
                    let key_cost = params_cb
                        .gas_costs
                        .wasm_public_storage_key_byte
                        .checked_mul(key.len() as u64)?;
                    let value_cost = params_cb
                        .gas_costs
                        .wasm_public_storage_value_byte
                        .checked_mul(value.len() as u64)?;
                    let total = params_cb
                        .gas_costs
                        .wasm_public_storage_insert_base
                        .checked_add(key_cost)?
                        .checked_add(value_cost)?;
                    Some(total)
                })()
                .ok_or(wasm3::Trap::Abort)?;
                gas::use_gas(ctx.instance, total_gas)?;

                *bytes_written_cb.borrow_mut() += value.len();
                let store_ctx = ctx.context.ok_or(wasm3::Trap::Abort)?;
                store_ctx.store.insert(&key, &value);
                Ok(0)
            },
        );
        let func = instance
            .find_function::<u32, u32>("bench_storage_gas_consumer")
            .expect("finding the entrypoint function should succeed");
        let _ = func.call_with_context(&mut store_ctx, params.max_storage_value_size_bytes as u32);
        let gas_limit: u64 = instance
            .get_global(gas::EXPORT_GAS_LIMIT)
            .expect("getting gas limit global should succeed");
        let gas_limit_exhausted: u64 = instance
            .get_global(gas::EXPORT_GAS_LIMIT_EXHAUSTED)
            .expect("getting gas limit exhausted global should succeed");
        println!(
            "  storage waster: gas remaining {} [used: {}, exhausted flag: {}], value bytes written: {}",
            gas_limit,
            initial_gas - gas_limit,
            gas_limit_exhausted,
            *bytes_written.borrow()
        );
    }
}