Roman Kiryanov | daecd14 | 2018-11-14 14:56:27 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2018 Google, Inc. |
| 3 | * |
| 4 | * This software is licensed under the terms of the GNU General Public |
| 5 | * License version 2, as published by the Free Software Foundation, and |
| 6 | * may be copied, distributed, and modified under those terms. |
| 7 | * |
| 8 | * This program is distributed in the hope that it will be useful, |
| 9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 11 | * GNU General Public License for more details. |
| 12 | * |
| 13 | */ |
| 14 | |
| 15 | #ifndef ANDROID_INCLUDE_HARDWARE_GOLDFISH_ADDRESS_SPACE_H |
| 16 | #define ANDROID_INCLUDE_HARDWARE_GOLDFISH_ADDRESS_SPACE_H |
| 17 | |
| 18 | #include <inttypes.h> |
David Reveman | 74e99bb | 2019-02-15 18:47:25 -0500 | [diff] [blame] | 19 | #include <stddef.h> |
Roman Kiryanov | daecd14 | 2018-11-14 14:56:27 -0800 | [diff] [blame] | 20 | |
David Reveman | aa65ad6 | 2019-05-02 08:23:46 -0400 | [diff] [blame] | 21 | #ifdef __Fuchsia__ |
Yilong Li | b373b39 | 2019-10-17 15:30:14 -0700 | [diff] [blame] | 22 | #include <fuchsia/hardware/goldfish/cpp/fidl.h> |
David Reveman | aa65ad6 | 2019-05-02 08:23:46 -0400 | [diff] [blame] | 23 | #endif |
| 24 | |
Roman Kiryanov | daecd14 | 2018-11-14 14:56:27 -0800 | [diff] [blame] | 25 | class GoldfishAddressSpaceBlock; |
Roman Kiryanov | 136c39a | 2019-06-03 19:41:51 -0700 | [diff] [blame] | 26 | class GoldfishAddressSpaceHostMemoryAllocator; |
Roman Kiryanov | daecd14 | 2018-11-14 14:56:27 -0800 | [diff] [blame] | 27 | |
Lingfeng Yang | c08fbfb | 2018-12-05 21:05:17 -0800 | [diff] [blame] | 28 | #ifdef HOST_BUILD |
Lingfeng Yang | a963ea0 | 2019-03-21 21:27:04 -0700 | [diff] [blame] | 29 | |
Lingfeng Yang | 6a777e9 | 2019-05-23 16:44:51 -0700 | [diff] [blame] | 30 | namespace android { |
Lingfeng Yang | a963ea0 | 2019-03-21 21:27:04 -0700 | [diff] [blame] | 31 | |
Lingfeng Yang | 6a777e9 | 2019-05-23 16:44:51 -0700 | [diff] [blame] | 32 | class HostAddressSpaceDevice; |
Lingfeng Yang | a963ea0 | 2019-03-21 21:27:04 -0700 | [diff] [blame] | 33 | |
Lingfeng Yang | 6a777e9 | 2019-05-23 16:44:51 -0700 | [diff] [blame] | 34 | } // namespace android |
| 35 | |
| 36 | #endif |
| 37 | |
Roman Kiryanov | 754c3eb | 2019-10-10 14:09:23 -0700 | [diff] [blame] | 38 | #if defined(__Fuchsia__) |
| 39 | typedef void* address_space_handle_t; |
| 40 | #elif defined(HOST_BUILD) |
| 41 | typedef uint32_t address_space_handle_t; |
| 42 | #else |
| 43 | typedef int address_space_handle_t; |
| 44 | #endif |
| 45 | |
Lingfeng Yang | 23fef58 | 2019-10-30 18:26:54 -0700 | [diff] [blame] | 46 | enum GoldfishAddressSpaceSubdeviceType { |
| 47 | NoSubdevice = -1, |
| 48 | Graphics = 0, |
bohu | aa0d500 | 2019-12-03 15:08:35 -0800 | [diff] [blame] | 49 | Media = 1, |
Lingfeng Yang | 23fef58 | 2019-10-30 18:26:54 -0700 | [diff] [blame] | 50 | HostMemoryAllocator = 5, |
| 51 | }; |
| 52 | |
Roman Kiryanov | daecd14 | 2018-11-14 14:56:27 -0800 | [diff] [blame] | 53 | class GoldfishAddressSpaceBlockProvider { |
| 54 | public: |
Lingfeng Yang | 23fef58 | 2019-10-30 18:26:54 -0700 | [diff] [blame] | 55 | GoldfishAddressSpaceBlockProvider(GoldfishAddressSpaceSubdeviceType subdevice); |
Roman Kiryanov | daecd14 | 2018-11-14 14:56:27 -0800 | [diff] [blame] | 56 | ~GoldfishAddressSpaceBlockProvider(); |
| 57 | |
| 58 | private: |
Roman Kiryanov | 8939379 | 2019-06-03 12:39:16 -0700 | [diff] [blame] | 59 | GoldfishAddressSpaceBlockProvider(const GoldfishAddressSpaceBlockProvider &rhs); |
| 60 | GoldfishAddressSpaceBlockProvider &operator=(const GoldfishAddressSpaceBlockProvider &rhs); |
Roman Kiryanov | daecd14 | 2018-11-14 14:56:27 -0800 | [diff] [blame] | 61 | |
Roman Kiryanov | 8939379 | 2019-06-03 12:39:16 -0700 | [diff] [blame] | 62 | bool is_opened() const; |
| 63 | void close(); |
Roman Kiryanov | 754c3eb | 2019-10-10 14:09:23 -0700 | [diff] [blame] | 64 | address_space_handle_t release(); |
Roman Kiryanov | 4126ae3 | 2019-10-11 09:30:45 -0700 | [diff] [blame] | 65 | static void closeHandle(address_space_handle_t handle); |
Roman Kiryanov | 754c3eb | 2019-10-10 14:09:23 -0700 | [diff] [blame] | 66 | |
David Reveman | 1b2a779 | 2019-04-08 11:30:05 -0400 | [diff] [blame] | 67 | #ifdef __Fuchsia__ |
Yilong Li | b373b39 | 2019-10-17 15:30:14 -0700 | [diff] [blame] | 68 | fuchsia::hardware::goldfish::AddressSpaceDeviceSyncPtr m_device; |
Lingfeng Yang | 51f58b0 | 2019-12-05 13:44:44 -0800 | [diff] [blame] | 69 | fuchsia::hardware::goldfish::AddressSpaceChildDriverSyncPtr m_child_driver; |
Lingfeng Yang | 6a777e9 | 2019-05-23 16:44:51 -0700 | [diff] [blame] | 70 | #else // __Fuchsia__ |
Roman Kiryanov | 754c3eb | 2019-10-10 14:09:23 -0700 | [diff] [blame] | 71 | address_space_handle_t m_handle; |
Lingfeng Yang | 6a777e9 | 2019-05-23 16:44:51 -0700 | [diff] [blame] | 72 | #endif // !__Fuchsia__ |
Roman Kiryanov | daecd14 | 2018-11-14 14:56:27 -0800 | [diff] [blame] | 73 | |
Roman Kiryanov | 8939379 | 2019-06-03 12:39:16 -0700 | [diff] [blame] | 74 | friend class GoldfishAddressSpaceBlock; |
Roman Kiryanov | 136c39a | 2019-06-03 19:41:51 -0700 | [diff] [blame] | 75 | friend class GoldfishAddressSpaceHostMemoryAllocator; |
Roman Kiryanov | daecd14 | 2018-11-14 14:56:27 -0800 | [diff] [blame] | 76 | }; |
Roman Kiryanov | daecd14 | 2018-11-14 14:56:27 -0800 | [diff] [blame] | 77 | |
| 78 | class GoldfishAddressSpaceBlock { |
| 79 | public: |
| 80 | GoldfishAddressSpaceBlock(); |
| 81 | ~GoldfishAddressSpaceBlock(); |
| 82 | |
| 83 | bool allocate(GoldfishAddressSpaceBlockProvider *provider, size_t size); |
Lingfeng Yang | 8d04bdd | 2019-10-19 10:59:53 -0700 | [diff] [blame] | 84 | bool claimShared(GoldfishAddressSpaceBlockProvider *provider, uint64_t offset, uint64_t size); |
Roman Kiryanov | daecd14 | 2018-11-14 14:56:27 -0800 | [diff] [blame] | 85 | uint64_t physAddr() const; |
| 86 | uint64_t hostAddr() const; |
Roman Kiryanov | 7963259 | 2019-06-03 12:31:49 -0700 | [diff] [blame] | 87 | uint64_t offset() const { return m_offset; } |
| 88 | size_t size() const { return m_size; } |
Roman Kiryanov | daecd14 | 2018-11-14 14:56:27 -0800 | [diff] [blame] | 89 | void *mmap(uint64_t opaque); |
| 90 | void *guestPtr() const; |
Roman Kiryanov | 7963259 | 2019-06-03 12:31:49 -0700 | [diff] [blame] | 91 | void replace(GoldfishAddressSpaceBlock *other); |
Roman Kiryanov | 754c3eb | 2019-10-10 14:09:23 -0700 | [diff] [blame] | 92 | void release(); |
Roman Kiryanov | 2111c06 | 2019-10-14 14:23:51 -0700 | [diff] [blame] | 93 | static int memoryMap(void *addr, size_t len, address_space_handle_t fd, uint64_t off, void** dst); |
Roman Kiryanov | 4126ae3 | 2019-10-11 09:30:45 -0700 | [diff] [blame] | 94 | static void memoryUnmap(void *ptr, size_t size); |
Roman Kiryanov | daecd14 | 2018-11-14 14:56:27 -0800 | [diff] [blame] | 95 | |
| 96 | private: |
| 97 | void destroy(); |
| 98 | GoldfishAddressSpaceBlock &operator=(const GoldfishAddressSpaceBlock &); |
| 99 | |
David Reveman | 5b7c584 | 2019-02-20 01:06:48 -0500 | [diff] [blame] | 100 | #ifdef __Fuchsia__ |
Lingfeng Yang | 51f58b0 | 2019-12-05 13:44:44 -0800 | [diff] [blame] | 101 | fuchsia::hardware::goldfish::AddressSpaceChildDriverSyncPtr* m_driver; |
David Reveman | 5b7c584 | 2019-02-20 01:06:48 -0500 | [diff] [blame] | 102 | uint32_t m_vmo; |
Lingfeng Yang | 6a777e9 | 2019-05-23 16:44:51 -0700 | [diff] [blame] | 103 | #else // __Fuchsia__ |
Roman Kiryanov | 754c3eb | 2019-10-10 14:09:23 -0700 | [diff] [blame] | 104 | address_space_handle_t m_handle; |
Lingfeng Yang | 6a777e9 | 2019-05-23 16:44:51 -0700 | [diff] [blame] | 105 | #endif // !__Fuchsia__ |
Lingfeng Yang | 6a777e9 | 2019-05-23 16:44:51 -0700 | [diff] [blame] | 106 | |
Roman Kiryanov | daecd14 | 2018-11-14 14:56:27 -0800 | [diff] [blame] | 107 | void *m_mmaped_ptr; |
| 108 | uint64_t m_phys_addr; |
| 109 | uint64_t m_host_addr; |
Roman Kiryanov | 2e9eba7 | 2019-05-17 09:25:05 -0700 | [diff] [blame] | 110 | uint64_t m_offset; |
Roman Kiryanov | 7963259 | 2019-06-03 12:31:49 -0700 | [diff] [blame] | 111 | uint64_t m_size; |
Lingfeng Yang | 8d04bdd | 2019-10-19 10:59:53 -0700 | [diff] [blame] | 112 | bool m_is_shared_mapping; |
Roman Kiryanov | daecd14 | 2018-11-14 14:56:27 -0800 | [diff] [blame] | 113 | }; |
| 114 | |
Roman Kiryanov | 136c39a | 2019-06-03 19:41:51 -0700 | [diff] [blame] | 115 | class GoldfishAddressSpaceHostMemoryAllocator { |
| 116 | public: |
| 117 | GoldfishAddressSpaceHostMemoryAllocator(); |
| 118 | |
| 119 | long hostMalloc(GoldfishAddressSpaceBlock *block, size_t size); |
| 120 | void hostFree(GoldfishAddressSpaceBlock *block); |
| 121 | |
Roman Kiryanov | 754c3eb | 2019-10-10 14:09:23 -0700 | [diff] [blame] | 122 | bool is_opened() const; |
| 123 | address_space_handle_t release() { return m_provider.release(); } |
Roman Kiryanov | 4126ae3 | 2019-10-11 09:30:45 -0700 | [diff] [blame] | 124 | static void closeHandle(address_space_handle_t handle) { GoldfishAddressSpaceBlockProvider::closeHandle(handle); } |
Roman Kiryanov | 754c3eb | 2019-10-10 14:09:23 -0700 | [diff] [blame] | 125 | |
Roman Kiryanov | 136c39a | 2019-06-03 19:41:51 -0700 | [diff] [blame] | 126 | private: |
| 127 | GoldfishAddressSpaceBlockProvider m_provider; |
| 128 | }; |
| 129 | |
Lingfeng Yang | 6000a8e | 2019-10-19 11:56:56 -0700 | [diff] [blame] | 130 | // Convenience functions that run address space driver api without wrapping in |
| 131 | // a class. Useful for when a client wants to manage the driver handle directly |
| 132 | // (e.g., mmaping() more than one region associated with a single handle will |
| 133 | // require different lifetime expectations versus GoldfishAddressSpaceBlock). |
| 134 | |
| 135 | // We also expose the ping info struct that is shared between host and guest. |
| 136 | struct goldfish_address_space_ping { |
| 137 | uint64_t offset; |
| 138 | uint64_t size; |
| 139 | uint64_t metadata; |
| 140 | uint32_t version; |
| 141 | uint32_t wait_fd; |
| 142 | uint32_t wait_flags; |
| 143 | uint32_t direction; |
| 144 | }; |
| 145 | |
| 146 | address_space_handle_t goldfish_address_space_open(); |
| 147 | void goldfish_address_space_close(address_space_handle_t); |
| 148 | |
| 149 | bool goldfish_address_space_allocate( |
| 150 | address_space_handle_t, size_t size, uint64_t* phys_addr, uint64_t* offset); |
| 151 | bool goldfish_address_space_free( |
| 152 | address_space_handle_t, uint64_t offset); |
| 153 | |
| 154 | bool goldfish_address_space_claim_shared( |
| 155 | address_space_handle_t, uint64_t offset, uint64_t size); |
| 156 | bool goldfish_address_space_unclaim_shared( |
| 157 | address_space_handle_t, uint64_t offset); |
| 158 | |
| 159 | // pgoff is the offset into the page to return in the result |
| 160 | void* goldfish_address_space_map( |
| 161 | address_space_handle_t, uint64_t offset, uint64_t size, uint64_t pgoff = 0); |
| 162 | void goldfish_address_space_unmap(void* ptr, uint64_t size); |
| 163 | |
Lingfeng Yang | 23fef58 | 2019-10-30 18:26:54 -0700 | [diff] [blame] | 164 | bool goldfish_address_space_set_subdevice_type(address_space_handle_t, GoldfishAddressSpaceSubdeviceType type, address_space_handle_t*); |
Lingfeng Yang | 6000a8e | 2019-10-19 11:56:56 -0700 | [diff] [blame] | 165 | bool goldfish_address_space_ping(address_space_handle_t, struct goldfish_address_space_ping*); |
| 166 | |
Roman Kiryanov | e5f1c65 | 2019-05-14 11:01:22 -0700 | [diff] [blame] | 167 | #endif // #ifndef ANDROID_INCLUDE_HARDWARE_GOLDFISH_ADDRESS_SPACE_H |