Mistake on this page?
Report an issue in GitHub or email us
NanostackMemoryManager.h
1 /* Copyright (c) 2017 ARM Limited
2  *
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 #ifndef NANOSTACK_MEMORY_MANAGER_H
17 #define NANOSTACK_MEMORY_MANAGER_H
18 
19 #include "EMACMemoryManager.h"
20 
22 public:
23 
24  /**
25  * Allocates memory buffer from the heap
26  *
27  * Memory buffer allocated from heap is always contiguous and can be arbitrary size.
28  *
29  * @param size Size of the memory to allocate in bytes
30  * @param align Memory alignment requirement in bytes
31  * @return Allocated memory buffer, or NULL in case of error
32  */
33  emac_mem_buf_t *alloc_heap(uint32_t size, uint32_t align) override;
34 
35  /**
36  * Allocates memory buffer chain from a pool
37  *
38  * Memory allocated from pool is contiguous if size is equal or less than
39  * (aligned) allocation unit, otherwise may be chained. Will typically come from
40  * fixed-size packet pool memory.
41  *
42  * @param size Total size of the memory to allocate in bytes
43  * @param align Memory alignment requirement for each buffer in bytes
44  * @return Allocated memory buffer chain, or NULL in case of error
45  */
46  emac_mem_buf_t *alloc_pool(uint32_t size, uint32_t align) override;
47 
48  /**
49  * Get memory buffer pool allocation unit
50  *
51  * Returns the maximum size of contiguous memory that can be allocated from a pool.
52  *
53  * @param align Memory alignment requirement in bytes
54  * @return Contiguous memory size
55  */
56  uint32_t get_pool_alloc_unit(uint32_t align) const override;
57 
58  /**
59  * Free memory buffer chain
60  *
61  * If memory buffer is chained must point to the start of the chain. Frees all buffers
62  * from the chained list.
63  *
64  * @param buf Memory buffer chain to be freed.
65  */
66  void free(emac_mem_buf_t *buf) override;
67 
68  /**
69  * Return total length of a memory buffer chain
70  *
71  * Returns a total length of this buffer and any following buffers in the chain.
72  *
73  * @param buf Memory buffer chain
74  * @return Total length in bytes
75  */
76  uint32_t get_total_len(const emac_mem_buf_t *buf) const override;
77 
78  /**
79  * Copy a memory buffer chain
80  *
81  * Copies data from one buffer chain to another. Copy operation does not adjust the lengths
82  * of the copied-to memory buffer chain, so chain total lengths must be the same.
83  *
84  * @param to_buf Memory buffer chain to copy to
85  * @param from_buf Memory buffer chain to copy from
86  */
87  void copy(emac_mem_buf_t *to_buf, const emac_mem_buf_t *from_buf) override;
88 
89 
90 
91  /**
92  * Concatenate two memory buffer chains
93  *
94  * Concatenates buffer chain to end of the other buffer chain. Concatenated-to buffer total length
95  * is adjusted accordingly. cat_buf must point to the start of a the chain. After concatenation
96  * to_buf's chain now owns those buffers, and they will be freed when the to_buf chain is freed.
97  *
98  * @param to_buf Memory buffer chain to concatenate to
99  * @param cat_buf Memory buffer chain to concatenate
100  */
101  void cat(emac_mem_buf_t *to_buf, emac_mem_buf_t *cat_buf) override;
102 
103  /**
104  * Returns the next buffer
105  *
106  * Returns the next buffer from the memory buffer chain.
107  *
108  * @param buf Memory buffer
109  * @return The next memory buffer, or NULL if last
110  */
111  emac_mem_buf_t *get_next(const emac_mem_buf_t *buf) const override;
112 
113  /**
114  * Return pointer to the payload of the buffer
115  *
116  * @param buf Memory buffer
117  * @return Pointer to the payload
118  */
119  void *get_ptr(const emac_mem_buf_t *buf) const override;
120 
121  /**
122  * Return payload size of the buffer
123  *
124  * @param buf Memory buffer
125  * @return Size in bytes
126  */
127  uint32_t get_len(const emac_mem_buf_t *buf) const override;
128 
129  /**
130  * Sets the payload size of the buffer
131  *
132  * The allocated payload size will not change. It is not permitted
133  * to change the length of a buffer that is not the first (or only) in a chain.
134  *
135  * @param buf Memory buffer
136  * @param len Payload size, must be less or equal allocated size
137  */
138  void set_len(emac_mem_buf_t *buf, uint32_t len) override;
139 };
140 
141 #endif /* NANOSTACK_MEMORY_MANAGER_H */
emac_mem_buf_t * get_next(const emac_mem_buf_t *buf) const override
Returns the next buffer.
emac_mem_buf_t * alloc_pool(uint32_t size, uint32_t align) override
Allocates memory buffer chain from a pool.
void cat(emac_mem_buf_t *to_buf, emac_mem_buf_t *cat_buf) override
Concatenate two memory buffer chains.
uint32_t get_len(const emac_mem_buf_t *buf) const override
Return payload size of the buffer.
void copy(emac_mem_buf_t *to_buf, const emac_mem_buf_t *from_buf) override
Copy a memory buffer chain.
uint32_t get_total_len(const emac_mem_buf_t *buf) const override
Return total length of a memory buffer chain.
uint32_t get_pool_alloc_unit(uint32_t align) const override
Get memory buffer pool allocation unit.
void free(emac_mem_buf_t *buf) override
Free memory buffer chain.
emac_mem_buf_t * alloc_heap(uint32_t size, uint32_t align) override
Allocates memory buffer from the heap.
void set_len(emac_mem_buf_t *buf, uint32_t len) override
Sets the payload size of the buffer.
void * get_ptr(const emac_mem_buf_t *buf) const override
Return pointer to the payload of the buffer.
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.