xref: /libCEED/backends/ref/ceed-ref-qfunctioncontext.c (revision f7c1b517c323a719e436874ff6ee79be51545b0d)
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 <stdbool.h>
11 #include <string.h>
12 
13 #include "ceed-ref.h"
14 
15 //------------------------------------------------------------------------------
16 // QFunctionContext has valid data
17 //------------------------------------------------------------------------------
18 static int CeedQFunctionContextHasValidData_Ref(CeedQFunctionContext ctx, bool *has_valid_data) {
19   CeedQFunctionContext_Ref *impl;
20   CeedCallBackend(CeedQFunctionContextGetBackendData(ctx, (void *)&impl));
21 
22   *has_valid_data = !!impl->data;
23 
24   return CEED_ERROR_SUCCESS;
25 }
26 
27 //------------------------------------------------------------------------------
28 // QFunctionContext has borrowed data
29 //------------------------------------------------------------------------------
30 static int CeedQFunctionContextHasBorrowedDataOfType_Ref(CeedQFunctionContext ctx, CeedMemType mem_type, bool *has_borrowed_data_of_type) {
31   CeedQFunctionContext_Ref *impl;
32   CeedCallBackend(CeedQFunctionContextGetBackendData(ctx, (void *)&impl));
33   Ceed ceed;
34   CeedCallBackend(CeedQFunctionContextGetCeed(ctx, &ceed));
35 
36   switch (mem_type) {
37     case CEED_MEM_HOST:
38       *has_borrowed_data_of_type = !!impl->data_borrowed;
39       break;
40     default:
41       // LCOV_EXCL_START
42       return CeedError(ceed, CEED_ERROR_BACKEND, "Can only set HOST memory for this backend");
43       // LCOV_EXCL_STOP
44       break;
45   }
46 
47   return CEED_ERROR_SUCCESS;
48 }
49 
50 //------------------------------------------------------------------------------
51 // QFunctionContext Set Data
52 //------------------------------------------------------------------------------
53 static int CeedQFunctionContextSetData_Ref(CeedQFunctionContext ctx, CeedMemType mem_type, CeedCopyMode copy_mode, void *data) {
54   CeedQFunctionContext_Ref *impl;
55   CeedCallBackend(CeedQFunctionContextGetBackendData(ctx, (void *)&impl));
56   size_t ctx_size;
57   CeedCallBackend(CeedQFunctionContextGetContextSize(ctx, &ctx_size));
58   Ceed ceed;
59   CeedCallBackend(CeedQFunctionContextGetCeed(ctx, &ceed));
60 
61   CeedCheck(mem_type == CEED_MEM_HOST, ceed, CEED_ERROR_BACKEND, "Can only set HOST memory for this backend");
62 
63   CeedCallBackend(CeedFree(&impl->data_owned));
64   switch (copy_mode) {
65     case CEED_COPY_VALUES:
66       CeedCallBackend(CeedMallocArray(1, ctx_size, &impl->data_owned));
67       impl->data_borrowed = NULL;
68       impl->data          = impl->data_owned;
69       memcpy(impl->data, data, ctx_size);
70       break;
71     case CEED_OWN_POINTER:
72       impl->data_owned    = data;
73       impl->data_borrowed = NULL;
74       impl->data          = data;
75       break;
76     case CEED_USE_POINTER:
77       impl->data_borrowed = data;
78       impl->data          = data;
79   }
80   return CEED_ERROR_SUCCESS;
81 }
82 
83 //------------------------------------------------------------------------------
84 // QFunctionContext Take Data
85 //------------------------------------------------------------------------------
86 static int CeedQFunctionContextTakeData_Ref(CeedQFunctionContext ctx, CeedMemType mem_type, void *data) {
87   CeedQFunctionContext_Ref *impl;
88   CeedCallBackend(CeedQFunctionContextGetBackendData(ctx, (void *)&impl));
89   Ceed ceed;
90   CeedCallBackend(CeedQFunctionContextGetCeed(ctx, &ceed));
91 
92   CeedCheck(mem_type == CEED_MEM_HOST, ceed, CEED_ERROR_BACKEND, "Can only provide HOST memory for this backend");
93 
94   *(void **)data      = impl->data;
95   impl->data_borrowed = NULL;
96   impl->data          = NULL;
97 
98   return CEED_ERROR_SUCCESS;
99 }
100 
101 //------------------------------------------------------------------------------
102 // QFunctionContext Get Data
103 //------------------------------------------------------------------------------
104 static int CeedQFunctionContextGetData_Ref(CeedQFunctionContext ctx, CeedMemType mem_type, void *data) {
105   CeedQFunctionContext_Ref *impl;
106   CeedCallBackend(CeedQFunctionContextGetBackendData(ctx, (void *)&impl));
107   Ceed ceed;
108   CeedCallBackend(CeedQFunctionContextGetCeed(ctx, &ceed));
109 
110   CeedCheck(mem_type == CEED_MEM_HOST, ceed, CEED_ERROR_BACKEND, "Can only provide HOST memory for this backend");
111 
112   *(void **)data = impl->data;
113 
114   return CEED_ERROR_SUCCESS;
115 }
116 
117 //------------------------------------------------------------------------------
118 // QFunctionContext Restore Data
119 //------------------------------------------------------------------------------
120 static int CeedQFunctionContextRestoreData_Ref(CeedQFunctionContext ctx) { return CEED_ERROR_SUCCESS; }
121 
122 //------------------------------------------------------------------------------
123 // QFunctionContext Destroy
124 //------------------------------------------------------------------------------
125 static int CeedQFunctionContextDestroy_Ref(CeedQFunctionContext ctx) {
126   CeedQFunctionContext_Ref *impl;
127   CeedCallBackend(CeedQFunctionContextGetBackendData(ctx, &impl));
128 
129   CeedCallBackend(CeedFree(&impl->data_owned));
130   CeedCallBackend(CeedFree(&impl));
131   return CEED_ERROR_SUCCESS;
132 }
133 
134 //------------------------------------------------------------------------------
135 // QFunctionContext Create
136 //------------------------------------------------------------------------------
137 int CeedQFunctionContextCreate_Ref(CeedQFunctionContext ctx) {
138   CeedQFunctionContext_Ref *impl;
139   Ceed                      ceed;
140   CeedCallBackend(CeedQFunctionContextGetCeed(ctx, &ceed));
141 
142   CeedCallBackend(CeedSetBackendFunction(ceed, "QFunctionContext", ctx, "HasValidData", CeedQFunctionContextHasValidData_Ref));
143   CeedCallBackend(CeedSetBackendFunction(ceed, "QFunctionContext", ctx, "HasBorrowedDataOfType", CeedQFunctionContextHasBorrowedDataOfType_Ref));
144   CeedCallBackend(CeedSetBackendFunction(ceed, "QFunctionContext", ctx, "SetData", CeedQFunctionContextSetData_Ref));
145   CeedCallBackend(CeedSetBackendFunction(ceed, "QFunctionContext", ctx, "TakeData", CeedQFunctionContextTakeData_Ref));
146   CeedCallBackend(CeedSetBackendFunction(ceed, "QFunctionContext", ctx, "GetData", CeedQFunctionContextGetData_Ref));
147   CeedCallBackend(CeedSetBackendFunction(ceed, "QFunctionContext", ctx, "GetDataRead", CeedQFunctionContextGetData_Ref));
148   CeedCallBackend(CeedSetBackendFunction(ceed, "QFunctionContext", ctx, "RestoreData", CeedQFunctionContextRestoreData_Ref));
149   CeedCallBackend(CeedSetBackendFunction(ceed, "QFunctionContext", ctx, "RestoreDataRead", CeedQFunctionContextRestoreData_Ref));
150   CeedCallBackend(CeedSetBackendFunction(ceed, "QFunctionContext", ctx, "Destroy", CeedQFunctionContextDestroy_Ref));
151 
152   CeedCallBackend(CeedCalloc(1, &impl));
153   CeedCallBackend(CeedQFunctionContextSetBackendData(ctx, impl));
154 
155   return CEED_ERROR_SUCCESS;
156 }
157 
158 //------------------------------------------------------------------------------
159