Common-lib : Memory management (#14)

* memory mamnagement include file

* Added memory manager code
- memory init support
memory finit (excluding destroying the main tracker list)

* Fixed bugs
- cleanup of code
- test.c updated for testing allocations and free
- included mem_init() and mem_finit()

* Docs: Added Template for future commits

Co-authored-by: ranganathvn <[email protected]>

Author: BlindCentaur

Makefile

@@ -60,6 +60,7 @@ clean:
 	find ${PROJ_PATH} -name "*.out" -exec rm -v {} \;
 
 
+
 help:
 	@echo "Available build options"
 	@echo "#> make <OPTIONS>"

common/Makefile

@@ -7,21 +7,30 @@ common_ARCHIVE=$(PROJ_PATH)/common/bin/common.a
 logger_SRC=src/logger.c
 logger_OBJ=bin/logger.o
 
+mem_SRC=src/memory_manager.c
+mem_OBJ=bin/memory_manager.o
+
 fault_SRC=src/fault_manager.c
 fault_OBJ=bin/fault_manager.o
 
+
 common_ARCHIVE=$(PROJ_PATH)/common/bin/common.a
 
 OBJS=$(common_OBJ)
 OBJS+=$(logger_OBJ)
+OBJS+=$(mem_OBJ)
 OBJS+=$(fault_OBJ)
 
+
 $(common_OBJ): $(common_SRC)
 	$(CC) $(INCLUDES) -c $^ -o $@ $(CFLAGS)
 
 $(logger_OBJ): $(logger_SRC)
 	$(CC) $(INCLUDES) -c $^ -o $@ $(CFLAGS)
 
+$(mem_OBJ): $(mem_SRC)
+	$(CC) $(INCLUDES) -c $^ -o $@ $(CFLAGS)
+
 $(fault_OBJ): $(fault_SRC)
 	$(CC) $(INCLUDES) -c $^ -o $@ $(CFLAGS)
 

common/inc/common.h

@@ -1,4 +1,6 @@
 #include "os.h"
 #include "typedefs.h"
 #include "logger.h"
+#include "memory_manager.h"
 #include "fault_manager.h"
+

common/inc/memory_manager.h

@@ -0,0 +1,31 @@
+#pragma once 
+
+#define get_mem(nmemb, size) tag_alloc(nmemb, size,  __FILE__, __LINE__)
+#define del_mem(mem_addr) untag_alloc(mem_addr, __FILE__, __LINE__) 
+
+typedef struct memory_record 
+{
+	void *mem;
+  size_t nmemb;
+	size_t block_size;
+	char *file;
+	int line;
+	struct memory_record *next;
+}t_mem_record;
+
+
+typedef struct mem_mamnager{
+	t_mem_record *mem_record;
+	int alloc_count;
+	int free_count;
+}t_mem_manager;
+
+
+void mem_init(void);
+void mem_finit(void);
+
+void *tag_alloc(size_t nmemb, size_t size, char *file, int line);
+void untag_alloc(void *mem_addr, char *file, int line);
+
+void mem_alloc_report(void);
+

common/inc/os.h

@@ -8,3 +8,10 @@
 #include <pthread.h>
 #include <signal.h>
 #include <sys/time.h>
+
+
+#ifndef CUSTOM_MALLOC
+	#define os_alloc(nmemb, size)				calloc((nmemb), (size))
+	#define os_free(mem_addr)						free((mem_addr))
+
+#endif

common/src/memory_manager.c

@@ -0,0 +1,89 @@
+#include "common.h"
+
+static t_mem_manager memer; 
+
+void mem_init() 
+{ 
+  memer.mem_record = NULL;
+	memer.alloc_count = 0;
+	memer.free_count = 0;
+}
+
+void mem_finit(void) 
+{
+	t_mem_record *iter = NULL;
+  mem_alloc_report();
+	if (memer.mem_record != NULL) {
+		for (iter = memer.mem_record ; iter != NULL; iter = iter->next) {
+		  printf("cleaning up allocated memory space %p\n", iter);
+			os_free(iter);
+		}
+	}
+	memer.alloc_count = 0;
+	memer.free_count = 0;
+
+}
+
+void *tag_alloc(size_t nmemb, size_t size, char *file, int line)
+{
+	//TODO:add resource lock
+	t_mem_record *new_mem = os_alloc(1, sizeof(t_mem_record));
+	if (new_mem == NULL) {
+		printf("Memory allocation for tracker failed\n");
+	}
+  new_mem->nmemb = nmemb;
+	new_mem->block_size = size;
+	new_mem->file = file;
+	new_mem->line = line;
+  new_mem->next = NULL;
+
+	new_mem->mem = os_alloc(nmemb, size);
+	if (new_mem->mem == NULL) {
+		printf("Memory allocation failed\n");
+	}
+	else {
+		memer.alloc_count++;
+		new_mem->next = memer.mem_record;
+		memer.mem_record = new_mem;
+	}
+
+
+	return (new_mem->mem);
+
+}
+		
+
+
+
+void untag_alloc(void *mem_addr, char *file, int line)
+{
+	t_mem_record * mem_list = NULL, *prev_addr = NULL;
+	if (memer.mem_record == NULL)
+		return;
+
+	for (mem_list = memer.mem_record; mem_list != NULL; prev_addr = mem_list, mem_list = mem_list->next) {
+		if (mem_addr == mem_list->mem) {
+			
+			if (mem_addr == memer.mem_record->mem) {
+				memer.mem_record = mem_list->next;
+			}
+			else {
+				prev_addr->next = mem_list->next;
+			}
+
+			if (mem_addr)	{
+				os_free(mem_addr);
+				memer.free_count++;
+			}
+		
+		os_free(mem_list);
+		}
+	}
+}
+
+
+void mem_alloc_report(void)
+{
+	printf("allocations = %4d , freed allocations = %4d\n", 
+	           memer.alloc_count, memer.free_count);
+}

doc/merge_template.md

@@ -0,0 +1,37 @@
+# **C EVERYTHING Merge**
+
+## Commit details
+* **Description of code changes:**
+    * .
+
+## Milestone Details
+* 
+
+## Change category
+- [ ] Enhancement
+- [ ] Bug-Fix
+- [ ] Cosmetic
+- [ ] Documentation
+- [ ] Unit-testing-fixes
+- [ ] Automation-Scripts
+- [ ] Configuration-files
+- [x] New-feature-addition
+
+## Issue  Details
+* 
+
+## Review information
+* Reviewer Name : @jar3m
+- [x] All Review comments addressed.
+
+## Pre Commit checklist
+- [x] Code build succeeded.
+- [x] Coding guidelines reviewed.
+- [ ] Added comment header for new functions.
+- [x] Code functional review completed.
+- [x] Unit tested the code changes.
+
+## Unit test details
+* 
+
+Author <@jar3m>

test/src/test.c

@@ -2,7 +2,22 @@
 
 int main(int argc, char *argv[])
 {
+
+	printf("Hello Memers\n");
+	mem_init();
 	logger_init();
+	size_t size = 0;
+	int *ptr[100];
+	for (int i = 0; i < 100; i ++) {
+	 ptr[i] = (int *)get_mem(1, sizeof(int));
+	 size += sizeof(*(ptr[i]));
+	 printf("address of allocated memory = %p\n", ptr[i]);
+	}
+	printf("size of allocated memory = %lu\n" , size);
+  for (int i = 0; i < 100; i++) {
+		del_mem(ptr[i]);
+	}
+
 
 	LOG_ERROR("COMMON", "Hello World\n");
 	LOG_WARN("COMMON", "Hello World\n");		
@@ -12,6 +27,7 @@ int main(int argc, char *argv[])
 	LOG_TRACE_OUT("COMMON", "Hello World\n");
 
 	fault_manager_init(NULL);
+	mem_finit();
 
 	return 0;