OSAPI  0.29
Open System API
common_types_memory.h
1 // *****************************************************************************************
2 //
3 // File description:
4 //
5 // Author: Joao Costa
6 // Purpose: Common declarations for a generic buffer type
7 //
8 // *****************************************************************************************
9 
10 #ifndef OSAPI_COMMON_TYPES_MEMORY_H_
11 #define OSAPI_COMMON_TYPES_MEMORY_H_
12 
13 // *****************************************************************************************
14 //
15 // Section: Import headers
16 //
17 // *****************************************************************************************
18 
19 // Import OSAPI headers
20 #include "general/general_types.h"
21 
22 // *****************************************************************************************
23 //
24 // Section: Type definitions
25 //
26 // *****************************************************************************************
27 
31 struct osapi_common_memory_S
32 {
33  t_size capacity;
34  Byte canary;
35  Byte type;
36  void * data;
37 };
38 
39 typedef struct osapi_common_memory_S t_memory;
40 
41 
42 #endif /* OSAPI_COMMON_TYPES_MEMORY_H_ */
osapi_common_memory_S::data
void * data
Allocated HEAP memory location.
Definition: common_types_memory.h:36
Byte
uint8_t Byte
Definition of a Byte type.
Definition: general_types.h:58
osapi_common_memory_S::canary
Byte canary
A MAGIC constant to indicate if the data pointer is really pointing to a previously allocated memory.
Definition: common_types_memory.h:34
t_size
uint64_t t_size
Definition of OSAPI size type.
Definition: general_types.h:52
osapi_common_memory_S
Definition: common_types_memory.h:31
osapi_common_memory_S::capacity
t_size capacity
The memory allocated capacity.
Definition: common_types_memory.h:33
osapi_common_memory_S::type
Byte type
The type of memory that was initially requested. A value of 0 means that memory can grow (malloc).
Definition: common_types_memory.h:35