Change 'mem' namspace to 'jmem'

The 'mem_' prefix is too general, so it might clash with symbols in other libraries. Renamed the directory, file, funtion and type names. Related issue: #1052 JerryScript-DCO-1.0-Signed-off-by: László Langó llango.u-szeged@partner.samsung.com
2016-05-13 14:09:31 +02:00
parent aaa3d22677
commit 92bb551d45
63 changed files with 1612 additions and 1612 deletions
@@ -0,0 +1,132 @@
+/* Copyright 2014-2016 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Allocator interface
+ */
+#ifndef JMEM_ALLOCATOR_H
+#define JMEM_ALLOCATOR_H
+
+#include "jrt.h"
+#include "jmem-config.h"
+#include "jmem-heap.h"
+#include "jmem-poolman.h"
+
+/** \addtogroup mem Memory allocation
+ * @{
+ */
+
+/**
+ * Compressed pointer
+ */
+typedef uint16_t jmem_cpointer_t;
+
+/**
+ * Representation of NULL value for compressed pointers
+ */
+#define JMEM_CP_NULL ((jmem_cpointer_t) 0)
+
+/**
+ * Required alignment for allocated units/blocks
+ */
+#define JMEM_ALIGNMENT (1u << JMEM_ALIGNMENT_LOG)
+
+/**
+ * Width of compressed memory pointer
+ */
+#define JMEM_CP_WIDTH (JMEM_HEAP_OFFSET_LOG - JMEM_ALIGNMENT_LOG)
+
+/**
+ * Compressed pointer value mask
+ */
+#define JMEM_CP_MASK ((1ull << JMEM_CP_WIDTH) - 1)
+
+/**
+ * Severity of a 'try give memory back' request
+ *
+ * The request are posted sequentially beginning from
+ * low to high until enough memory is freed.
+ *
+ * If not enough memory is freed upon a high request
+ * then the engine is shut down with ERR_OUT_OF_MEMORY.
+ */
+typedef enum
+{
+  JMEM_TRY_GIVE_MEMORY_BACK_SEVERITY_LOW, /* 'low' severity */
+  JMEM_TRY_GIVE_MEMORY_BACK_SEVERITY_HIGH, /* 'high' severity */
+} jmem_try_give_memory_back_severity_t;
+
+/**
+ * A 'try give memory back' callback routine type.
+ */
+typedef void (*jmem_try_give_memory_back_callback_t) (jmem_try_give_memory_back_severity_t);
+
+/**
+ * Get value of pointer from specified non-null compressed pointer value
+ */
+#define JMEM_CP_GET_NON_NULL_POINTER(type, cp_value) \
+  ((type *) (jmem_decompress_pointer (cp_value)))
+
+/**
+ * Get value of pointer from specified compressed pointer value
+ */
+#define JMEM_CP_GET_POINTER(type, cp_value) \
+  (((unlikely ((cp_value) == JMEM_CP_NULL)) ? NULL : JMEM_CP_GET_NON_NULL_POINTER (type, cp_value)))
+
+/**
+ * Set value of non-null compressed pointer so that it will correspond
+ * to specified non_compressed_pointer
+ */
+#define JMEM_CP_SET_NON_NULL_POINTER(cp_value, non_compressed_pointer) \
+  (cp_value) = (jmem_compress_pointer (non_compressed_pointer) & JMEM_CP_MASK)
+
+/**
+ * Set value of compressed pointer so that it will correspond
+ * to specified non_compressed_pointer
+ */
+#define JMEM_CP_SET_POINTER(cp_value, non_compressed_pointer) \
+  do \
+  { \
+    void *ptr_value = (void *) non_compressed_pointer; \
+    \
+    if (unlikely ((ptr_value) == NULL)) \
+    { \
+      (cp_value) = JMEM_CP_NULL; \
+    } \
+    else \
+    { \
+      JMEM_CP_SET_NON_NULL_POINTER (cp_value, ptr_value); \
+    } \
+  } while (false);
+
+extern void jmem_init (void);
+extern void jmem_finalize (bool);
+
+extern uintptr_t jmem_compress_pointer (const void *);
+extern void *jmem_decompress_pointer (uintptr_t);
+
+extern void jmem_register_a_try_give_memory_back_callback (jmem_try_give_memory_back_callback_t);
+extern void jmem_unregister_a_try_give_memory_back_callback (jmem_try_give_memory_back_callback_t);
+
+#ifdef JMEM_STATS
+extern void jmem_stats_reset_peak (void);
+extern void jmem_stats_print (void);
+#endif /* JMEM_STATS */
+
+/**
+ * @}
+ */
+
+#endif /* !JMEM_ALLOCATOR_H */