1 // Copyright (c) 2017-2024, 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 <stdio.h> 12 #include <valgrind/memcheck.h> 13 14 #include "ceed-memcheck.h" 15 16 //------------------------------------------------------------------------------ 17 // QFunction Apply 18 //------------------------------------------------------------------------------ 19 static int CeedQFunctionApply_Memcheck(CeedQFunction qf, CeedInt Q, CeedVector *U, CeedVector *V) { 20 Ceed ceed; 21 void *ctx_data = NULL; 22 int input_block_ids[CEED_FIELD_MAX], output_block_ids[CEED_FIELD_MAX]; 23 CeedInt num_in, num_out; 24 CeedQFunctionUser f = NULL; 25 CeedQFunctionField *output_fields; 26 CeedQFunction_Memcheck *impl; 27 28 CeedCallBackend(CeedQFunctionGetCeed(qf, &ceed)); 29 CeedCallBackend(CeedQFunctionGetData(qf, &impl)); 30 CeedCallBackend(CeedQFunctionGetContextData(qf, CEED_MEM_HOST, &ctx_data)); 31 CeedCallBackend(CeedQFunctionGetUserFunction(qf, &f)); 32 CeedCallBackend(CeedQFunctionGetNumArgs(qf, &num_in, &num_out)); 33 34 // Get input arrays 35 for (CeedInt i = 0; i < num_in; i++) { 36 CeedSize len; 37 char name[32] = ""; 38 39 CeedCallBackend(CeedVectorGetArrayRead(U[i], CEED_MEM_HOST, &impl->inputs[i])); 40 41 CeedCallBackend(CeedVectorGetLength(U[i], &len)); 42 43 snprintf(name, 32, "QFunction input %" CeedInt_FMT, i); 44 input_block_ids[i] = VALGRIND_CREATE_BLOCK(impl->inputs[i], len, name); 45 } 46 47 // Get output arrays 48 for (CeedInt i = 0; i < num_out; i++) { 49 CeedSize len; 50 char name[32] = ""; 51 52 CeedCallBackend(CeedVectorGetArrayWrite(V[i], CEED_MEM_HOST, &impl->outputs[i])); 53 54 CeedCallBackend(CeedVectorGetLength(V[i], &len)); 55 VALGRIND_MAKE_MEM_UNDEFINED(impl->outputs[i], len); 56 57 snprintf(name, 32, "QFunction output %" CeedInt_FMT, i); 58 output_block_ids[i] = VALGRIND_CREATE_BLOCK(impl->outputs[i], len, name); 59 } 60 61 // Call user function 62 CeedCallBackend(f(ctx_data, Q, impl->inputs, impl->outputs)); 63 64 // Restore input arrays 65 for (CeedInt i = 0; i < num_in; i++) { 66 CeedCallBackend(CeedVectorRestoreArrayRead(U[i], &impl->inputs[i])); 67 VALGRIND_DISCARD(input_block_ids[i]); 68 } 69 70 // Check for unset output values and restore arrays 71 { 72 const char *kernel_name, *kernel_path; 73 74 CeedCallBackend(CeedQFunctionGetSourcePath(qf, &kernel_path)); 75 CeedCallBackend(CeedQFunctionGetKernelName(qf, &kernel_name)); 76 CeedCallBackend(CeedQFunctionGetFields(qf, NULL, NULL, NULL, &output_fields)); 77 for (CeedInt i = 0; i < num_out; i++) { 78 const char *field_name; 79 CeedInt field_size; 80 81 // Note: need field size because vector may be longer than needed for output 82 CeedCallBackend(CeedQFunctionFieldGetSize(output_fields[i], &field_size)); 83 CeedCallBackend(CeedQFunctionFieldGetName(output_fields[i], &field_name)); 84 for (CeedSize j = 0; j < field_size * (CeedSize)Q; j++) { 85 CeedCheck(!isnan(impl->outputs[i][j]), ceed, CEED_ERROR_BACKEND, 86 "QFunction output %" CeedInt_FMT " '%s' entry %" CeedSize_FMT " is NaN after restoring write-only access: %s:%s ", i, field_name, j, 87 kernel_path, kernel_name); 88 } 89 CeedCallBackend(CeedVectorRestoreArray(V[i], &impl->outputs[i])); 90 VALGRIND_DISCARD(output_block_ids[i]); 91 } 92 } 93 CeedCallBackend(CeedQFunctionRestoreContextData(qf, &ctx_data)); 94 return CEED_ERROR_SUCCESS; 95 } 96 97 //------------------------------------------------------------------------------ 98 // QFunction Destroy 99 //------------------------------------------------------------------------------ 100 static int CeedQFunctionDestroy_Memcheck(CeedQFunction qf) { 101 CeedQFunction_Memcheck *impl; 102 103 CeedCallBackend(CeedQFunctionGetData(qf, &impl)); 104 CeedCallBackend(CeedFree(&impl->inputs)); 105 CeedCallBackend(CeedFree(&impl->outputs)); 106 CeedCallBackend(CeedFree(&impl)); 107 return CEED_ERROR_SUCCESS; 108 } 109 110 //------------------------------------------------------------------------------ 111 // QFunction Create 112 //------------------------------------------------------------------------------ 113 int CeedQFunctionCreate_Memcheck(CeedQFunction qf) { 114 Ceed ceed; 115 CeedQFunction_Memcheck *impl; 116 117 CeedCallBackend(CeedQFunctionGetCeed(qf, &ceed)); 118 CeedCallBackend(CeedCalloc(1, &impl)); 119 CeedCallBackend(CeedCalloc(CEED_FIELD_MAX, &impl->inputs)); 120 CeedCallBackend(CeedCalloc(CEED_FIELD_MAX, &impl->outputs)); 121 CeedCallBackend(CeedQFunctionSetData(qf, impl)); 122 CeedCallBackend(CeedSetBackendFunction(ceed, "QFunction", qf, "Apply", CeedQFunctionApply_Memcheck)); 123 CeedCallBackend(CeedSetBackendFunction(ceed, "QFunction", qf, "Destroy", CeedQFunctionDestroy_Memcheck)); 124 return CEED_ERROR_SUCCESS; 125 } 126 127 //------------------------------------------------------------------------------ 128