xref: /libCEED/backends/memcheck/ceed-memcheck.h (revision d4cc18453651bd0f94c1a2e078b2646a92dafdcc)

// Copyright (c) 2017-2026, Lawrence Livermore National Security, LLC and other CEED contributors.
// All Rights Reserved. See the top-level LICENSE and NOTICE files for details.
//
// SPDX-License-Identifier: BSD-2-Clause
//
// This file is part of CEED:  http://github.com/ceed
#pragma once

#include <ceed.h>
#include <ceed/backend.h>

typedef struct {
  // Internal array buffer
  int         allocated_block_id;
  CeedScalar *array_allocated;
  // Owned external array
  int         owned_block_id;
  CeedScalar *array_owned;
  // Borrowed external array
  int         borrowed_block_id;
  CeedScalar *array_borrowed;
  // Externally viewable read-only array
  int         read_only_block_id;
  CeedScalar *array_read_only_copy;
  // Externally viewable writable array
  bool        is_write_only_access;
  int         writable_block_id;
  CeedScalar *array_writable_copy;
} CeedVector_Memcheck;

typedef struct {
  const CeedInt  *offsets;
  CeedInt        *offsets_allocated;
  const bool     *orients; /* Orientation, if it exists, is true when the dof must be flipped */
  bool           *orients_allocated;
  const CeedInt8 *curl_orients; /* Tridiagonal matrix (row-major) for a general transformation during restriction */
  CeedInt8       *curl_orients_allocated;
  int (*Apply)(CeedElemRestriction, CeedInt, CeedInt, CeedInt, CeedInt, CeedInt, CeedTransposeMode, bool, bool, CeedVector, CeedVector,
               CeedRequest *);
} CeedElemRestriction_Memcheck;

typedef struct {
  bool               setup_done;
  const CeedScalar **inputs;
  CeedScalar       **outputs;
} CeedQFunction_Memcheck;

typedef struct {
  // Internal data buffer
  int   allocated_block_id;
  void *data_allocated;
  // Owned external data
  int   owned_block_id;
  void *data_owned;
  // Borrowed external data
  int   borrowed_block_id;
  void *data_borrowed;
  // Externally viewable read-only data
  int   read_only_block_id;
  void *data_read_only_copy;
  // Externally viewable writable data
  int   writable_block_id;
  void *data_writable_copy;
} CeedQFunctionContext_Memcheck;

CEED_INTERN int CeedVectorCreate_Memcheck(CeedSize n, CeedVector vec);

CEED_INTERN int CeedElemRestrictionCreate_Memcheck(CeedMemType mem_type, CeedCopyMode copy_mode, const CeedInt *offsets, const bool *orients,
                                                   const CeedInt8 *curl_orients, CeedElemRestriction r);

CEED_INTERN int CeedQFunctionCreate_Memcheck(CeedQFunction qf);

CEED_INTERN int CeedQFunctionContextCreate_Memcheck(CeedQFunctionContext ctx);