docs/api-2.1/stack_8h_source.html

 /*
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
  *
  * Copyright 2017 Mike Becker, Olaf Wintermann All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
  *
  *   1. Redistributions of source code must retain the above copyright
  *      notice, this list of conditions and the following disclaimer.
  *
  *   2. Redistributions in binary form must reproduce the above copyright
  *      notice, this list of conditions and the following disclaimer in the
  *      documentation and/or other materials provided with the distribution.
  *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */

 #ifndef UCX_STACK_H
 #define UCX_STACK_H

 #include "ucx.h"
 #include "allocator.h"

 #ifdef  __cplusplus
 extern "C" {
 #endif


 typedef struct {
     UcxAllocator allocator;

     size_t size;

     char *space;

     char *top;
 } UcxStack;

 struct ucx_stack_metadata {
     char *prev;

     size_t size;
 };

 void ucx_stack_init(UcxStack *stack, char* space, size_t size);

 void *ucx_stack_malloc(UcxStack *stack, size_t n);

 void *ucx_stack_push(UcxStack *stack, size_t n, const void *data);

 void *ucx_stack_calloc(UcxStack *stack, size_t nelem, size_t elsize);

 void *ucx_stack_pusharr(UcxStack *stack,
         size_t nelem, size_t elsize, const void *data);

 void *ucx_stack_realloc(UcxStack *stack, void *ptr, size_t n);

 void ucx_stack_free(UcxStack *stack, void *ptr);


 #define ucx_stack_topsize(stack) ((stack)->top ? ((struct ucx_stack_metadata*)\
                                   (stack)->top - 1)->size : 0)

 #define ucx_stack_pop(stack, dest) ucx_stack_popn(stack, dest, (size_t)-1)

 void ucx_stack_popn(UcxStack *stack, void *dest, size_t n);

 size_t ucx_stack_avail(UcxStack *stack);

 #define ucx_stack_empty(stack) (!(stack)->top)

 #define ucx_stack_dim(size, elems) (size+sizeof(struct ucx_stack_metadata) * \
                                     (elems + 1))


 #ifdef  __cplusplus
 }
 #endif

 #endif  /* UCX_STACK_H */

UcxStack::size
size_t size
Stack size.
Definition: stack.h:57

universe@390: UcxStack
UCX stack structure.
Definition: stack.h:52

universe@390: ucx_stack_free
void ucx_stack_free(UcxStack *stack, void *ptr)
Frees memory on the stack.
Definition: stack.c:106

universe@390: ucx.h
Main UCX Header providing most common definitions.

universe@390: ucx_stack_malloc
void * ucx_stack_malloc(UcxStack *stack, size_t n)
Allocates stack memory.
Definition: stack.c:53

universe@390: ucx_stack_push
void * ucx_stack_push(UcxStack *stack, size_t n, const void *data)
Allocates memory with ucx_stack_malloc() and copies the specified data if the allocation was successf...
Definition: stack.c:148

universe@390: ucx_stack_metadata
Metadata for each UCX stack element.
Definition: stack.h:69

universe@390: ucx_stack_realloc
void * ucx_stack_realloc(UcxStack *stack, void *ptr, size_t n)
Reallocates memory on the stack.
Definition: stack.c:79

universe@390: ucx_stack_metadata::prev
char * prev
Location of the previous element (NULL if this is the first)
Definition: stack.h:73

universe@390: ucx_stack_avail
size_t ucx_stack_avail(UcxStack *stack)
Returns the remaining available memory on the specified stack.
Definition: stack.c:135

universe@390: UcxAllocator
UCX allocator data structure containing memory management functions.
Definition: allocator.h:88

universe@390: UcxStack::space
char * space
Pointer to the bottom of the stack.
Definition: stack.h:60

universe@390: ucx_stack_popn
void ucx_stack_popn(UcxStack *stack, void *dest, size_t n)
Removes the top most element from the stack and copies the content to  dest.
Definition: stack.c:118

universe@390: allocator.h
Allocator for custom memory management.

universe@390: ucx_stack_init
void ucx_stack_init(UcxStack *stack, char *space, size_t size)
Initializes UcxStack structure with memory.
Definition: stack.c:41

universe@390: ucx_stack_metadata::size
size_t size
Size of this element.
Definition: stack.h:76

universe@390: ucx_stack_pusharr
void * ucx_stack_pusharr(UcxStack *stack, size_t nelem, size_t elsize, const void *data)
Allocates memory with ucx_stack_calloc() and copies the specified data if the allocation was successf...
Definition: stack.c:156

universe@390: ucx_stack_calloc
void * ucx_stack_calloc(UcxStack *stack, size_t nelem, size_t elsize)
Allocates an array of stack memory.
Definition: stack.c:73

universe@390: UcxStack::top
char * top
Pointer to the top of the stack.
Definition: stack.h:63

universe@390: UcxStack::allocator
UcxAllocator allocator
UcxAllocator based on this stack.
Definition: stack.h:54

universe@390: