Skip to content

Latest commit

 

History

History
65 lines (55 loc) · 2.55 KB

README.md

File metadata and controls

65 lines (55 loc) · 2.55 KB
Raw

What is?

Rather than trying to describe what it is, I'll describe what it can be used for:

  • there exists a process that loads/unloads a number of - same or different - shared libraries that conform to the FMI / Functional Mockup Interface standard.
  • it does so repeatedly - being a long running process, akin to a service
  • once loaded, one such FMU library is executed ("co-simulation" in FMI-speak)
  • depending on a configuration flag, upon initialization, a library might need be supplied with pointers to two memory management functions:
    • void* (*allocateMemory)(size_t nobj, size_t size) - calloc like
    • void (*freeMemory)(void* obj) - free like
  • for various reasons, during execution of said libraries things might not work as expected:
    • abnormal execution termination
    • hang
    • implementation itself might be leaking memory
  • it is where this library comes into place:
    • it keeps a bookkeeping of all allocations and it will free unfreed memory once not needed anymore

What is not?

It is not a calloc/free implementation. So it will use whatever memory allocator happens to be present.

How does it work?

TODO

Building

The build can consist of 3 actual steps:

  • boilerplate code generation
    • off by default
    • by default there are 10 slots
    • depending on need, these can either be shrinked or extended to a custom number of slots
  • the actual build of the lib
  • unit tests build
    • off by default To build:
  • mkdir build_dir && cd build_dir
    • anywhere, in order to achieve an out of code-tree build as is customary for CMake
  • cmake <path to source tree>
    • default build, no boilerplate code generation, no unit tests
  • cmake -DFMI2AG_START_ID=1 -DFMI2AG_END_ID=42 <path to source tree>
    • activate boilerplate code generation with 42 slots
  • cmake -DFMI2AG_TEST=ON <path to source tree>
    • enable building of unit tests
    • these can be, of course, combined
  • ctest
    • executes tests

Usage

There is no installation script. To use, just include inc/fmi2AllocGuard.h and link against the shared lib.

Details

Due to the nature of FMI-standard and various environments where it is used, the author is aware that advanced features of the c/c++ language would not always be readily available. Therefore, the implementation is C99 compliant.

For convenient [modern] C++ usage, wrapping in a [RAII-style] class should do.

Thread safety

There is no thread safety built in.

Platform

  • Linux/GCC
  • Win32/Visual C++

Example

TODO

License

BSD. See LICENSE.md.