qmckl/src/qmckl_memory.org

# -*- mode: org -*-
# vim: syntax=c
#+TITLE: Memory management

We override the allocation functions to enable the possibility of
optimized libraries to fine-tune the memory allocation.

3 files are produced:
- a header file : =qmckl_memory.h= 
- a source file : =qmckl_memory.c= 
- a test   file : =test_qmckl_memory.c= 

*** Header 
    #+BEGIN_SRC C :comments link  :tangle qmckl_memory.h
#ifndef QMCKL_MEMORY_H
#define QMCKL_MEMORY_H
#include "qmckl.h"
    #+END_SRC

*** Source
    #+BEGIN_SRC C :comments link :tangle qmckl_memory.c
#include <stdlib.h>
#include "qmckl_memory.h"
    #+END_SRC

*** Test
    #+BEGIN_SRC C :comments link :tangle test_qmckl_memory.c
#include "qmckl.h"
#include "munit.h"
MunitResult test_qmckl_memory() {
    #+END_SRC

** =qmckl_malloc=
  Analogous of =malloc, but passing a context and a signed 64-bit integers as argument.=
*** Header
    #+BEGIN_SRC C :comments link :tangle qmckl_memory.h
void* qmckl_malloc(const qmckl_context ctx, const size_t size);
    #+END_SRC

*** Source
    #+BEGIN_SRC C :comments link :tangle qmckl_memory.c
void* qmckl_malloc(const qmckl_context ctx, const size_t size) {
  if (ctx == (qmckl_context) 0) {
 /* Avoids unused parameter error */
    return malloc( (size_t) size );
  }
  return malloc( (size_t) size );
}

    #+END_SRC
    
*** Test
    #+BEGIN_SRC C :comments link :tangle test_qmckl_memory.c
  int *a;
  a = (int*) qmckl_malloc( (qmckl_context) 1, 3*sizeof(int));
  a[0] = 1;
  a[1] = 2;
  a[2] = 3;
  munit_assert_int(a[0], ==, 1);
  munit_assert_int(a[1], ==, 2);
  munit_assert_int(a[2], ==, 3);
    #+END_SRC

** =qmckl_free=

*** Header
    #+BEGIN_SRC C :comments link :tangle qmckl_memory.h
void qmckl_free(void *ptr);
    #+END_SRC

*** Source
    #+BEGIN_SRC C :comments link :tangle qmckl_memory.c
void qmckl_free(void *ptr) {
  free(ptr);
}
    #+END_SRC
    
*** Test
    #+BEGIN_SRC C :comments link :tangle test_qmckl_memory.c
  qmckl_free(a);
    #+END_SRC

* End of files

*** Header
  #+BEGIN_SRC C :comments link :tangle qmckl_memory.h
#endif
  #+END_SRC

*** Test
  #+BEGIN_SRC C :comments link :tangle test_qmckl_memory.c
  return MUNIT_OK;
} 

  #+END_SRC