xref: /libCEED/python/build_ceed_cffi.py (revision 56c48462b0d39517237dc0770653f43cb7356d08)
13d8e8822SJeremy L Thompson# Copyright (c) 2017-2022, Lawrence Livermore National Security, LLC and other CEED contributors
23d8e8822SJeremy L Thompson# All Rights Reserved. See the top-level LICENSE and NOTICE files for details.
37b8bbb42Svaleriabarra#
43d8e8822SJeremy L Thompson# SPDX-License-Identifier: BSD-2-Clause
57b8bbb42Svaleriabarra#
63d8e8822SJeremy L Thompson# This file is part of CEED:  http://github.com/ceed
77b8bbb42Svaleriabarra
87b8bbb42Svaleriabarraimport os
9477729cfSJeremy L Thompsonimport re
107b8bbb42Svaleriabarrafrom cffi import FFI
117b8bbb42Svaleriabarraffibuilder = FFI()
127b8bbb42Svaleriabarra
13b3bcc043SJed Brownceed_version_ge = re.compile(r'\s+\(!?CEED_VERSION.*')
14bd4df462SJed Brown
15dd8ab4d9SJed Brown
16dd8ab4d9SJed Browndef get_ceed_dirs():
17dd8ab4d9SJed Brown    here = os.path.dirname(os.path.abspath(__file__))
18dd8ab4d9SJed Brown    prefix = os.path.dirname(here)
19dd8ab4d9SJed Brown    # make install links the installed library in build/lbiceed.so Sadly, it
20dd8ab4d9SJed Brown    # does not seem possible to obtain the bath that libceed_build_ext has/will
21dd8ab4d9SJed Brown    # install to.
22dd8ab4d9SJed Brown    libdir = os.path.join(prefix, "build")
23dd8ab4d9SJed Brown    return prefix, libdir
24dd8ab4d9SJed Brown
25dd8ab4d9SJed Brown
26dd8ab4d9SJed Brownceed_dir, ceed_libdir = get_ceed_dirs()
27dd8ab4d9SJed Brown
287b8bbb42Svaleriabarra# ------------------------------------------------------------------------------
297b8bbb42Svaleriabarra# Provide C definitions to CFFI
307b8bbb42Svaleriabarra# ------------------------------------------------------------------------------
31c9c2c079SJeremy L Thompsonlines = []
32c9c2c079SJeremy L Thompsonfor header_path in ["include/ceed/types.h", "include/ceed/ceed.h"]:
33c9c2c079SJeremy L Thompson    with open(os.path.abspath(header_path)) as f:
34c9c2c079SJeremy L Thompson        lines += [line.strip() for line in f if
3580a9ef05SNatalie Beams                  not (line.startswith("#") and not line.startswith("#include")) and
367b8bbb42Svaleriabarra                  not line.startswith("  static") and
37228d9efbSJames Wright                  not line.startswith("  CEED_QFUNCTION_ATTR") and
387b8bbb42Svaleriabarra                  "CeedErrorImpl" not in line and
397b8bbb42Svaleriabarra                  "const char *, ...);" not in line and
40bd4df462SJed Brown                  not line.startswith("CEED_EXTERN const char *const") and
41bd4df462SJed Brown                  not ceed_version_ge.match(line)]
427b8bbb42Svaleriabarralines = [line.replace("CEED_EXTERN", "extern") for line in lines]
43c9c2c079SJeremy L Thompson
4480a9ef05SNatalie Beams# Find scalar type inclusion line and insert definitions
4580a9ef05SNatalie Beamsfor line in lines:
4680a9ef05SNatalie Beams    if re.search("ceed-f32.h", line) is not None:
4780a9ef05SNatalie Beams        insert_index = lines.index(line) + 1
4880a9ef05SNatalie Beams        extra_lines = ['typedef float CeedScalar;']
4980a9ef05SNatalie Beams        extra_lines.append('static const int CEED_SCALAR_TYPE;')
5080a9ef05SNatalie Beams        extra_lines.append('static const double CEED_EPSILON;')
5180a9ef05SNatalie Beams    elif re.search("ceed-f64.h", line) is not None:
5280a9ef05SNatalie Beams        insert_index = lines.index(line) + 1
5380a9ef05SNatalie Beams        extra_lines = ['typedef double CeedScalar;']
5480a9ef05SNatalie Beams        extra_lines.append('static const int CEED_SCALAR_TYPE;')
5580a9ef05SNatalie Beams        extra_lines.append('static const double CEED_EPSILON;')
5680a9ef05SNatalie Beamslines[insert_index: insert_index] = extra_lines
57c9c2c079SJeremy L Thompson
5880a9ef05SNatalie Beams# Remove all include statements now that scalar type has been dealt with
5980a9ef05SNatalie Beamslines = [line for line in lines if not line.startswith("#include")]
60c9c2c079SJeremy L Thompson
6180a9ef05SNatalie Beams# Build header from lines
621d83af80SJed Brownheader = '\n'.join(lines)
637b8bbb42Svaleriabarraheader = header.split("static inline CeedInt CeedIntPow", 1)[0]
6419798369SJed Brownheader += '\nextern int CeedVectorGetState(CeedVector, uint64_t*);'
65*56c48462SJeremy L Thompsonheader += '\nextern int CeedElemRestrictionGetLLayout(CeedElemRestriction, CeedInt layout[3]);'
66*56c48462SJeremy L Thompsonheader += '\nextern int CeedElemRestrictionGetELayout(CeedElemRestriction, CeedInt layout[3]);'
67c9c2c079SJeremy L Thompson
68477729cfSJeremy L Thompson# Note: cffi cannot handle vargs
69477729cfSJeremy L Thompsonheader = re.sub("va_list", "const char *", header)
70c9c2c079SJeremy L Thompson
717b8bbb42Svaleriabarraffibuilder.cdef(header)
727b8bbb42Svaleriabarra
737b8bbb42Svaleriabarraffibuilder.set_source("_ceed_cffi",
747b8bbb42Svaleriabarra                      """
75477729cfSJeremy L Thompson  #define va_list const char *
7649aac155SJeremy L Thompson  #include <ceed.h>   // the C header of the library
77dd8ab4d9SJed Brown  #include <ceed/backend.h> // declarations for the backend functions above
787b8bbb42Svaleriabarra  """,
79450bb777Svaleriabarra                      include_dirs=[
80dd8ab4d9SJed Brown                          os.path.join(ceed_dir, "include")],  # include path
817b8bbb42Svaleriabarra                      libraries=["ceed"],   # library name, for the linker
82dd8ab4d9SJed Brown                      # library path, for the linker
83dd8ab4d9SJed Brown                      library_dirs=[ceed_libdir],
847a7b0fa3SJed Brown                      # use libceed.so as installed
857a7b0fa3SJed Brown                      runtime_library_dirs=['$ORIGIN/libceed/lib']
867b8bbb42Svaleriabarra                      )
877b8bbb42Svaleriabarra
887b8bbb42Svaleriabarra# ------------------------------------------------------------------------------
897b8bbb42Svaleriabarra# Builder
907b8bbb42Svaleriabarra# ------------------------------------------------------------------------------
917b8bbb42Svaleriabarraif __name__ == "__main__":
927b8bbb42Svaleriabarra    ffibuilder.compile(verbose=True)
937b8bbb42Svaleriabarra
947b8bbb42Svaleriabarra# ------------------------------------------------------------------------------
95