1 // Copyright (c) 2017-2022, Lawrence Livermore National Security, LLC and other CEED contributors. 2 // All Rights Reserved. See the top-level LICENSE and NOTICE files for details. 3 // 4 // SPDX-License-Identifier: BSD-2-Clause 5 // 6 // This file is part of CEED: http://github.com/ceed 7 8 #include <ceed.h> 9 #include <ceed/backend.h> 10 #include <math.h> 11 #include <stdbool.h> 12 #include <string.h> 13 #include <valgrind/memcheck.h> 14 15 #include "ceed-memcheck.h" 16 17 //------------------------------------------------------------------------------ 18 // Has Valid Array 19 //------------------------------------------------------------------------------ 20 static int CeedVectorHasValidArray_Memcheck(CeedVector vec, bool *has_valid_array) { 21 CeedVector_Memcheck *impl; 22 23 CeedCallBackend(CeedVectorGetData(vec, &impl)); 24 *has_valid_array = impl->array; 25 return CEED_ERROR_SUCCESS; 26 } 27 28 //------------------------------------------------------------------------------ 29 // Check if has borrowed array of given type 30 //------------------------------------------------------------------------------ 31 static inline int CeedVectorHasBorrowedArrayOfType_Memcheck(const CeedVector vec, CeedMemType mem_type, bool *has_borrowed_array_of_type) { 32 Ceed ceed; 33 CeedVector_Memcheck *impl; 34 35 CeedCallBackend(CeedVectorGetData(vec, &impl)); 36 CeedCallBackend(CeedVectorGetCeed(vec, &ceed)); 37 38 switch (mem_type) { 39 case CEED_MEM_HOST: 40 *has_borrowed_array_of_type = impl->array_borrowed; 41 break; 42 // LCOV_EXCL_START 43 default: 44 return CeedError(ceed, CEED_ERROR_BACKEND, "Can only set HOST memory for this backend"); 45 // LCOV_EXCL_STOP 46 break; 47 } 48 return CEED_ERROR_SUCCESS; 49 } 50 51 //------------------------------------------------------------------------------ 52 // Vector Set Array 53 //------------------------------------------------------------------------------ 54 static int CeedVectorSetArray_Memcheck(CeedVector vec, CeedMemType mem_type, CeedCopyMode copy_mode, CeedScalar *array) { 55 Ceed ceed; 56 CeedSize length; 57 CeedVector_Memcheck *impl; 58 59 CeedCallBackend(CeedVectorGetData(vec, &impl)); 60 CeedCallBackend(CeedVectorGetLength(vec, &length)); 61 CeedCallBackend(CeedVectorGetCeed(vec, &ceed)); 62 63 CeedCheck(mem_type == CEED_MEM_HOST, ceed, CEED_ERROR_BACKEND, "Can only set HOST memory for this backend"); 64 65 CeedCallBackend(CeedFree(&impl->array_allocated)); 66 CeedCallBackend(CeedFree(&impl->array_owned)); 67 switch (copy_mode) { 68 case CEED_COPY_VALUES: 69 CeedCallBackend(CeedCalloc(length, &impl->array_owned)); 70 impl->array_borrowed = NULL; 71 impl->array = impl->array_owned; 72 if (array) { 73 memcpy(impl->array, array, length * sizeof(array[0])); 74 } else { 75 for (CeedInt i = 0; i < length; i++) impl->array[i] = NAN; 76 } 77 break; 78 case CEED_OWN_POINTER: 79 impl->array_owned = array; 80 impl->array_borrowed = NULL; 81 impl->array = array; 82 break; 83 case CEED_USE_POINTER: 84 impl->array_borrowed = array; 85 impl->array = array; 86 } 87 // Copy data to check access 88 CeedCallBackend(CeedCalloc(length, &impl->array_allocated)); 89 memcpy(impl->array_allocated, impl->array, length * sizeof(array[0])); 90 impl->array = impl->array_allocated; 91 VALGRIND_DISCARD(impl->mem_block_id); 92 impl->mem_block_id = VALGRIND_CREATE_BLOCK(impl->array, length * sizeof(array[0]), "'Vector backend array data copy'"); 93 return CEED_ERROR_SUCCESS; 94 } 95 96 //------------------------------------------------------------------------------ 97 // Vector Take Array 98 //------------------------------------------------------------------------------ 99 static int CeedVectorTakeArray_Memcheck(CeedVector vec, CeedMemType mem_type, CeedScalar **array) { 100 Ceed ceed; 101 CeedVector_Memcheck *impl; 102 103 CeedCallBackend(CeedVectorGetData(vec, &impl)); 104 CeedCallBackend(CeedVectorGetCeed(vec, &ceed)); 105 106 CeedCheck(mem_type == CEED_MEM_HOST, ceed, CEED_ERROR_BACKEND, "Can only provide HOST memory for this backend"); 107 108 (*array) = impl->array_borrowed; 109 impl->array_borrowed = NULL; 110 impl->array = NULL; 111 VALGRIND_DISCARD(impl->mem_block_id); 112 CeedCallBackend(CeedFree(&impl->array_allocated)); 113 return CEED_ERROR_SUCCESS; 114 } 115 116 //------------------------------------------------------------------------------ 117 // Vector Get Array 118 //------------------------------------------------------------------------------ 119 static int CeedVectorGetArray_Memcheck(CeedVector vec, CeedMemType mem_type, CeedScalar **array) { 120 Ceed ceed; 121 CeedVector_Memcheck *impl; 122 123 CeedCallBackend(CeedVectorGetData(vec, &impl)); 124 CeedCallBackend(CeedVectorGetCeed(vec, &ceed)); 125 126 CeedCheck(mem_type == CEED_MEM_HOST, ceed, CEED_ERROR_BACKEND, "Can only provide HOST memory for this backend"); 127 128 *array = impl->array; 129 return CEED_ERROR_SUCCESS; 130 } 131 132 //------------------------------------------------------------------------------ 133 // Vector Get Array Read 134 //------------------------------------------------------------------------------ 135 static int CeedVectorGetArrayRead_Memcheck(CeedVector vec, CeedMemType mem_type, const CeedScalar **array) { 136 Ceed ceed; 137 CeedSize length; 138 CeedVector_Memcheck *impl; 139 140 CeedCallBackend(CeedVectorGetData(vec, &impl)); 141 CeedCallBackend(CeedVectorGetLength(vec, &length)); 142 CeedCallBackend(CeedVectorGetCeed(vec, &ceed)); 143 144 CeedCallBackend(CeedVectorGetArray_Memcheck(vec, mem_type, (CeedScalar **)array)); 145 146 // Make copy to verify no write occurred 147 if (!impl->array_read_only_copy) { 148 CeedCallBackend(CeedCalloc(length, &impl->array_read_only_copy)); 149 memcpy(impl->array_read_only_copy, *array, length * sizeof((*array)[0])); 150 } 151 return CEED_ERROR_SUCCESS; 152 } 153 154 //------------------------------------------------------------------------------ 155 // Vector Get Array Write 156 //------------------------------------------------------------------------------ 157 static int CeedVectorGetArrayWrite_Memcheck(CeedVector vec, CeedMemType mem_type, CeedScalar **array) { 158 Ceed ceed; 159 CeedSize length; 160 CeedVector_Memcheck *impl; 161 162 CeedCallBackend(CeedVectorGetData(vec, &impl)); 163 CeedCallBackend(CeedVectorGetLength(vec, &length)); 164 CeedCallBackend(CeedVectorGetCeed(vec, &ceed)); 165 166 // Invalidate data to make sure no read occurs 167 if (!impl->array) CeedCallBackend(CeedVectorSetArray_Memcheck(vec, mem_type, CEED_COPY_VALUES, NULL)); 168 CeedCallBackend(CeedVectorGetArray_Memcheck(vec, mem_type, array)); 169 for (CeedSize i = 0; i < length; i++) (*array)[i] = NAN; 170 impl->is_write_only_access = true; 171 return CEED_ERROR_SUCCESS; 172 } 173 174 //------------------------------------------------------------------------------ 175 // Vector Restore Array 176 //------------------------------------------------------------------------------ 177 static int CeedVectorRestoreArray_Memcheck(CeedVector vec) { 178 Ceed ceed; 179 CeedSize length; 180 CeedVector_Memcheck *impl; 181 182 CeedCallBackend(CeedVectorGetData(vec, &impl)); 183 CeedCallBackend(CeedVectorGetLength(vec, &length)); 184 CeedCallBackend(CeedVectorGetCeed(vec, &ceed)); 185 186 if (impl->is_write_only_access) { 187 for (CeedSize i = 0; i < length; i++) { 188 if (isnan(impl->array[i])) CeedDebug256(ceed, CEED_DEBUG_COLOR_WARNING, "WARNING: Vec entry %ld is NaN after restoring write-only access", i); 189 } 190 impl->is_write_only_access = false; 191 } 192 if (impl->array_borrowed) { 193 memcpy(impl->array_borrowed, impl->array, length * sizeof(impl->array[0])); 194 } 195 if (impl->array_owned) { 196 memcpy(impl->array_owned, impl->array, length * sizeof(impl->array[0])); 197 } 198 return CEED_ERROR_SUCCESS; 199 } 200 201 //------------------------------------------------------------------------------ 202 // Vector Restore Array Read-Only 203 //------------------------------------------------------------------------------ 204 static int CeedVectorRestoreArrayRead_Memcheck(CeedVector vec) { 205 Ceed ceed; 206 CeedSize length; 207 CeedVector_Memcheck *impl; 208 209 CeedCallBackend(CeedVectorGetData(vec, &impl)); 210 CeedCallBackend(CeedVectorGetLength(vec, &length)); 211 CeedCallBackend(CeedVectorGetCeed(vec, &ceed)); 212 213 CeedCheck(!memcmp(impl->array, impl->array_read_only_copy, length * sizeof(impl->array[0])), ceed, CEED_ERROR_BACKEND, 214 "Array data changed while accessed in read-only mode"); 215 216 CeedCallBackend(CeedFree(&impl->array_read_only_copy)); 217 return CEED_ERROR_SUCCESS; 218 } 219 220 //------------------------------------------------------------------------------ 221 // Vector Destroy 222 //------------------------------------------------------------------------------ 223 static int CeedVectorDestroy_Memcheck(CeedVector vec) { 224 CeedVector_Memcheck *impl; 225 226 CeedCallBackend(CeedVectorGetData(vec, &impl)); 227 VALGRIND_DISCARD(impl->mem_block_id); 228 CeedCallBackend(CeedFree(&impl->array_allocated)); 229 CeedCallBackend(CeedFree(&impl->array_owned)); 230 CeedCallBackend(CeedFree(&impl)); 231 return CEED_ERROR_SUCCESS; 232 } 233 234 //------------------------------------------------------------------------------ 235 // Vector Create 236 //------------------------------------------------------------------------------ 237 int CeedVectorCreate_Memcheck(CeedSize n, CeedVector vec) { 238 Ceed ceed; 239 CeedVector_Memcheck *impl; 240 241 CeedCallBackend(CeedVectorGetCeed(vec, &ceed)); 242 CeedCallBackend(CeedSetBackendFunction(ceed, "Vector", vec, "HasValidArray", CeedVectorHasValidArray_Memcheck)); 243 CeedCallBackend(CeedSetBackendFunction(ceed, "Vector", vec, "HasBorrowedArrayOfType", CeedVectorHasBorrowedArrayOfType_Memcheck)); 244 CeedCallBackend(CeedSetBackendFunction(ceed, "Vector", vec, "SetArray", CeedVectorSetArray_Memcheck)); 245 CeedCallBackend(CeedSetBackendFunction(ceed, "Vector", vec, "TakeArray", CeedVectorTakeArray_Memcheck)); 246 CeedCallBackend(CeedSetBackendFunction(ceed, "Vector", vec, "GetArray", CeedVectorGetArray_Memcheck)); 247 CeedCallBackend(CeedSetBackendFunction(ceed, "Vector", vec, "GetArrayRead", CeedVectorGetArrayRead_Memcheck)); 248 CeedCallBackend(CeedSetBackendFunction(ceed, "Vector", vec, "GetArrayWrite", CeedVectorGetArrayWrite_Memcheck)); 249 CeedCallBackend(CeedSetBackendFunction(ceed, "Vector", vec, "RestoreArray", CeedVectorRestoreArray_Memcheck)); 250 CeedCallBackend(CeedSetBackendFunction(ceed, "Vector", vec, "RestoreArrayRead", CeedVectorRestoreArrayRead_Memcheck)); 251 CeedCallBackend(CeedSetBackendFunction(ceed, "Vector", vec, "Destroy", CeedVectorDestroy_Memcheck)); 252 CeedCallBackend(CeedCalloc(1, &impl)); 253 CeedCallBackend(CeedVectorSetData(vec, impl)); 254 return CEED_ERROR_SUCCESS; 255 } 256 257 //------------------------------------------------------------------------------ 258