formats/ctf/metadata/objstack.h

   1 #ifndef _OBJSTACK_H
   2 #define _OBJSTACK_H
   3
   4 /*
   5  * objstack.h
   6  *
   7  * Common Trace Format Object Stack.
   8  *
   9  * Copyright 2013 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
  10  *
  11  * Permission is hereby granted, free of charge, to any person obtaining a copy
  12  * of this software and associated documentation files (the "Software"), to deal
  13  * in the Software without restriction, including without limitation the rights
  14  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  15  * copies of the Software, and to permit persons to whom the Software is
  16  * furnished to do so, subject to the following conditions:
  17  *
  18  * The above copyright notice and this permission notice shall be included in
  19  * all copies or substantial portions of the Software.
  20  *
  21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  24  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  26  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  */
  29
  30 struct objstack;
  31
  32 BT_HIDDEN
  33 struct objstack *objstack_create(void);
  34 BT_HIDDEN
  35 void objstack_destroy(struct objstack *objstack);
  36
  37 /*
  38  * Allocate len bytes of zeroed memory.
  39  * Return NULL on error.
  40  */
  41 BT_HIDDEN
  42 void *objstack_alloc(struct objstack *objstack, size_t len);
  43
  44 #endif /* _OBJSTACK_H */