1 // Copyright 2016 The Fuchsia Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4 
5 #ifndef LIB_ZX_VMO_H_
6 #define LIB_ZX_VMO_H_
7 
8 #include <lib/zx/handle.h>
9 #include <lib/zx/object.h>
10 #include <lib/zx/resource.h>
11 
12 namespace zx {
13 
14 class bti;
15 
16 class vmo : public object<vmo> {
17 public:
18     static constexpr zx_obj_type_t TYPE = ZX_OBJ_TYPE_VMO;
19 
20     constexpr vmo() = default;
21 
vmo(zx_handle_t value)22     explicit vmo(zx_handle_t value) : object(value) {}
23 
vmo(handle && h)24     explicit vmo(handle&& h) : object(h.release()) {}
25 
vmo(vmo && other)26     vmo(vmo&& other) : object(other.release()) {}
27 
28     vmo& operator=(vmo&& other) {
29         reset(other.release());
30         return *this;
31     }
32 
33     static zx_status_t create(uint64_t size, uint32_t options, vmo* result);
34     static zx_status_t create_contiguous(
35         const bti& bti, size_t size, uint32_t alignment_log2, vmo* result);
36     static zx_status_t create_physical(
37         const resource& resource, zx_paddr_t paddr, size_t size, vmo* result);
38 
read(void * data,uint64_t offset,size_t len)39     zx_status_t read(void* data, uint64_t offset, size_t len) const {
40         return zx_vmo_read(get(), data, offset, len);
41     }
42 
write(const void * data,uint64_t offset,size_t len)43     zx_status_t write(const void* data, uint64_t offset, size_t len) const {
44         return zx_vmo_write(get(), data, offset, len);
45     }
46 
get_size(uint64_t * size)47     zx_status_t get_size(uint64_t* size) const {
48         return zx_vmo_get_size(get(), size);
49     }
50 
set_size(uint64_t size)51     zx_status_t set_size(uint64_t size) const {
52         return zx_vmo_set_size(get(), size);
53     }
54 
clone(uint32_t options,uint64_t offset,uint64_t size,vmo * result)55     zx_status_t clone(uint32_t options, uint64_t offset, uint64_t size,
56                       vmo* result) const {
57         // Allow for the caller aliasing |result| to |this|.
58         vmo h;
59         zx_status_t status = zx_vmo_clone(
60             get(), options, offset, size, h.reset_and_get_address());
61         result->reset(h.release());
62         return status;
63     }
64 
op_range(uint32_t op,uint64_t offset,uint64_t size,void * buffer,size_t buffer_size)65     zx_status_t op_range(uint32_t op, uint64_t offset, uint64_t size,
66                          void* buffer, size_t buffer_size) const {
67         return zx_vmo_op_range(get(), op, offset, size, buffer, buffer_size);
68     }
69 
set_cache_policy(uint32_t cache_policy)70     zx_status_t set_cache_policy(uint32_t cache_policy) {
71         return zx_vmo_set_cache_policy(get(), cache_policy);
72     }
73 
replace_as_executable(const handle & vmex,vmo * result)74     zx_status_t replace_as_executable(const handle& vmex, vmo* result) {
75         zx_handle_t h = ZX_HANDLE_INVALID;
76         zx_status_t status = zx_vmo_replace_as_executable(value_, vmex.get(), &h);
77         // We store ZX_HANDLE_INVALID to value_ before calling reset on result
78         // in case result == this.
79         value_ = ZX_HANDLE_INVALID;
80         result->reset(h);
81         return status;
82     }
83 };
84 
85 using unowned_vmo = unowned<vmo>;
86 
87 } // namespace zx
88 
89 #endif  // LIB_ZX_VMO_H_
90