1 /****************************************************************************** 2 * tmem.h 3 * 4 * Guest OS interface to Xen Transcendent Memory. 5 * 6 * Permission is hereby granted, free of charge, to any person obtaining a copy 7 * of this software and associated documentation files (the "Software"), to 8 * deal in the Software without restriction, including without limitation the 9 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or 10 * sell copies of the Software, and to permit persons to whom the Software is 11 * furnished to do so, subject to the following conditions: 12 * 13 * The above copyright notice and this permission notice shall be included in 14 * all copies or substantial portions of the Software. 15 * 16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 22 * DEALINGS IN THE SOFTWARE. 23 * 24 * Copyright (c) 2004, K A Fraser 25 */ 26 27 #ifndef __XEN_PUBLIC_TMEM_H__ 28 #define __XEN_PUBLIC_TMEM_H__ 29 30 #include "xen.h" 31 32 #if __XEN_INTERFACE_VERSION__ < 0x00041300 33 34 /* version of ABI */ 35 #define TMEM_SPEC_VERSION 1 36 37 #define TMEM_NEW_POOL 1 38 #define TMEM_DESTROY_POOL 2 39 #define TMEM_PUT_PAGE 4 40 #define TMEM_GET_PAGE 5 41 #define TMEM_FLUSH_PAGE 6 42 #define TMEM_FLUSH_OBJECT 7 43 #if __XEN_INTERFACE_VERSION__ < 0x00040400 44 #define TMEM_NEW_PAGE 3 45 #define TMEM_READ 8 46 #define TMEM_WRITE 9 47 #define TMEM_XCHG 10 48 #endif 49 50 /* Privileged commands now called via XEN_SYSCTL_tmem_op. */ 51 #define TMEM_AUTH 101 /* as XEN_SYSCTL_TMEM_OP_SET_AUTH. */ 52 #define TMEM_RESTORE_NEW 102 /* as XEN_SYSCTL_TMEM_OP_SET_POOL. */ 53 54 /* Bits for HYPERVISOR_tmem_op(TMEM_NEW_POOL) */ 55 #define TMEM_POOL_PERSIST 1 56 #define TMEM_POOL_SHARED 2 57 #define TMEM_POOL_PRECOMPRESSED 4 58 #define TMEM_POOL_PAGESIZE_SHIFT 4 59 #define TMEM_POOL_PAGESIZE_MASK 0xf 60 #define TMEM_POOL_VERSION_SHIFT 24 61 #define TMEM_POOL_VERSION_MASK 0xff 62 #define TMEM_POOL_RESERVED_BITS 0x00ffff00 63 64 /* Bits for client flags (save/restore) */ 65 #define TMEM_CLIENT_COMPRESS 1 66 #define TMEM_CLIENT_FROZEN 2 67 68 /* Special errno values */ 69 #define EFROZEN 1000 70 #define EEMPTY 1001 71 72 struct xen_tmem_oid { 73 uint64_t oid[3]; 74 }; 75 typedef struct xen_tmem_oid xen_tmem_oid_t; 76 DEFINE_XEN_GUEST_HANDLE(xen_tmem_oid_t); 77 78 #ifndef __ASSEMBLY__ 79 #if __XEN_INTERFACE_VERSION__ < 0x00040400 80 typedef xen_pfn_t tmem_cli_mfn_t; 81 #endif 82 typedef XEN_GUEST_HANDLE(char) tmem_cli_va_t; 83 struct tmem_op { 84 uint32_t cmd; 85 int32_t pool_id; 86 union { 87 struct { 88 uint64_t uuid[2]; 89 uint32_t flags; 90 uint32_t arg1; 91 } creat; /* for cmd == TMEM_NEW_POOL. */ 92 struct { 93 #if __XEN_INTERFACE_VERSION__ < 0x00040600 94 uint64_t oid[3]; 95 #else 96 xen_tmem_oid_t oid; 97 #endif 98 uint32_t index; 99 uint32_t tmem_offset; 100 uint32_t pfn_offset; 101 uint32_t len; 102 xen_pfn_t cmfn; /* client machine page frame */ 103 } gen; /* for all other cmd ("generic") */ 104 } u; 105 }; 106 typedef struct tmem_op tmem_op_t; 107 DEFINE_XEN_GUEST_HANDLE(tmem_op_t); 108 #endif 109 110 #endif /* __XEN_INTERFACE_VERSION__ < 0x00041300 */ 111 112 #endif /* __XEN_PUBLIC_TMEM_H__ */ 113 114 /* 115 * Local variables: 116 * mode: C 117 * c-file-style: "BSD" 118 * c-basic-offset: 4 119 * tab-width: 4 120 * indent-tabs-mode: nil 121 * End: 122 */ 123