Link List & Common Libs (#15)

* Configuring build for link -list

* Added struct def to linklist

* Commit Logs
- Added backtrace on coredump
- changed declaration of del_mem to free_mem
- added/cleaned up link_list struct and function def

* Create/destroy Link List api'

* Defs.make updated to select tuning params

* moved t_elem datatype to common

* Added get_node and added rule for stacks

* Add end fn (append) defined for SLL,DLL,SCLL,DCLL

* added add_begin functions for SLL,DLL,SCLL,DCLL

* Stack structure definition

* stack source file created

* added full, empty and size fn declartions to stacks

* adding delete functions to link list

* Stack structure definition

* stack source file created

* added full, empty and size fn declartions to stacks

* updated stack structure

* -  Cosmetic changes: Added Function headers and comments
-  Bug fixed in Add begin tail ptr not being updated
-  Tail & Head ptr not set to NULL in after del resulting in empty list causing corruption of data on reusing the list

* COMMIT DETAILS
- Enabled Generic support for link list
- Added generic_def.h/c as helper functions for data type generic lists
- Added Comments
- Test file updated to show link list of diff types such as char, int, float and string
- All link list operations are now data type independent

* Commit Logs
- Fixed bug in delete in SLL

* Moved free fn ptr defn to typedefs.h

* Added generic print for data

* changed generic fn routines

* cosmetics

* Generic ptr compare added to link list

* WIP : Added index delete and xor based linked list

* fixed xor ll  delete

* print for XOR LL and fixed compilation issues

* added function ptr for destroy and print in linklist

* rectified del_idx and added tests, WIP: Circular count is incorrect

* moved destroy to end

* Commit Logs
- Added new struct to be passed along create that populates data type spefic fn ptrs required for maintaining data struct
- two different links for just printing the data and the other for getting detailed info of linklist inlcuding count , addresses and links

* Commit Logs
- Added generic fn ptrs
- Defined get head, tail, end, next and prv fn ptrs in ll struct implementation to be done
- defined get and find node struct in ll
- fn names changed and cosmetic changes

* * defined api's for ll head, tail, end, prev and next
* changed destroy and print api's using head, end and next ll routines
* TODO implement the above 2 points for xor link list
* cosmetics funtion headers and indentations

* Added get next and prev for xor ll. works only when iterating from start to end o f list not otherwise
Del node and del i th node in xor ll need to be debugged

* added find function for linked list

* added get ith node function in the linked list

* Cosmetic changes for Doxygen support
- Added function headers
- Added Structure feild descriptions
- Added File headers
- Added Macro and Enums description comments

* Added util api for printing link_list type

* Del node xor list fixed

* cosmetics

* added delete index for xor link list

* Test link list clean up

* Added Link list get data routine

Co-authored-by: BlindCentaur <harsha.dev21@gmail.com>

Author: jar3m

.gitignore

@@ -50,3 +50,6 @@ modules.order
 Module.symvers
 Mkfile.old
 dkms.conf
+
+#tags
+tags

Defs.make

@@ -6,8 +6,25 @@
 #All defines to be explained in docs/testing_framework.txt
 
 PROJ_PATH=$(PWD)
+LIB_NAME=c_everyting.so
+
+#which Modules to build
 MODULE=test
 
+#build type
+BUILD_TYPE=executable
+#BUILD_TYPE=library
+
+#flags
+SEGFAULT_BACKTRACE=true
+#include submodules of Data structures
+LINK_LIST=true
+STACK=false
+
 .show:
 	@echo "PROJ_PATH= $(PROJ_PATH)"
+	@echo "LIB_NAME=$(LIB_NAME)"
 	@echo "MODULE= $(MODULE)"
+	@echo "BUILD_TYPE=$(BUILD_TYPE)"
+	@echo "LINK_LIST= $(LINK_LIST)"
+	@echo "STACKS= $(STACK)"

Makefile

@@ -3,7 +3,10 @@ include Defs.make
 CC=gcc
 TEST_FILE_DIRECTORY="$(PROJ_PATH)/test/src"
 
-LDLIBS= -lm -pg
+LDLIBS= -lm -pg 
+ifeq ($(SEGFAULT_BACKTRACE), true)
+LDLIBS+=-rdynamic
+endif
 INCLUDES+=-I $(PROJ_PATH)/ds/inc
 INCLUDES+=-I $(PROJ_PATH)/common/inc
 INCLUDES+=-I $(PROJ_PATH)/test/inc
@@ -24,6 +27,7 @@ MODULE_ARCHIVES += $(algo_ARCHIVE)
 endif
 
 ifeq ($(MODULE), test)
+MODULE_ARCHIVES += $(ds_ARCHIVE)
 MODULE_ARCHIVES += $(test_ARCHIVE)
 endif
 
@@ -37,7 +41,11 @@ export
 
 all: $(MODULE_ARCHIVES)
 	@echo "All archives ($(MODULE_ARCHIVES)) created"
-	$(CC) $(INCLUDES) $^ -o foo.out $(MODULE_ARCHIVES) $(LDLIBS) $(CFLAGS)
+ifeq ($(BUILD_TYPE), executable)
+	$(CC) $(INCLUDES) $^  -o foo.out $(MODULE_ARCHIVES) $(LDLIBS) $(CFLAGS)
+else ifeq ($(BUILD_TYPE), library)
+	$(CC) -shared -o $(LIB_NAME) $(MODULE_ARCHIVES) $(LDLIBS) $(CFLAGS)
+endif
 
 $(common_ARCHIVE) :
 	make -C common/ all
@@ -55,9 +63,10 @@ $(test_ARCHIVE) :
 
 clean:
 	make -C test/ clean
-#	make -C ds/ clean
+	make -C ds/ clean
 	find ${PROJ_PATH} -name "*.[ao]" -exec rm -v {} \;
 	find ${PROJ_PATH} -name "*.out" -exec rm -v {} \;
+	find ${PROJ_PATH} -name "*.so" -exec rm -v {} \;
 
 
 

common/Makefile

@@ -14,12 +14,16 @@ fault_SRC=src/fault_manager.c
 fault_OBJ=bin/fault_manager.o
 
 
+generic_SRC=src/generic_def.c
+generic_OBJ=bin/generic_def.o
+
 common_ARCHIVE=$(PROJ_PATH)/common/bin/common.a
 
 OBJS=$(common_OBJ)
 OBJS+=$(logger_OBJ)
 OBJS+=$(mem_OBJ)
 OBJS+=$(fault_OBJ)
+OBJS+=$(generic_OBJ)
 
 
 $(common_OBJ): $(common_SRC)
@@ -34,6 +38,9 @@ $(mem_OBJ): $(mem_SRC)
 $(fault_OBJ): $(fault_SRC)
 	$(CC) $(INCLUDES) -c $^ -o $@ $(CFLAGS)
 
+$(generic_OBJ): $(generic_SRC)
+	$(CC) $(INCLUDES) -c $^ -o $@ $(CFLAGS)
+
 all: $(OBJS)
 	@echo "building common"
 	ar rcs $(common_ARCHIVE) $(OBJS)

common/inc/common.h

@@ -1,6 +1,36 @@
+/*! @file common.h
+    @brief 
+    Top level include containg common headers
+*/
+#pragma once
+
 #include "os.h"
 #include "typedefs.h"
 #include "logger.h"
 #include "memory_manager.h"
 #include "fault_manager.h"
+#include "generic_def.h"
+
+/*! data params struct to be passed to all data structures
+ *  it holds functions pointers for operating on data depending on type of it
+ */
+/// data params struct defn
+typedef struct data_params {
+	// type of datatypes
+	e_data_types type;		///< Holds elem data type
+
+	// data type specific routines	
+	f_cmpr cmpr;			///< Routine used for comparing two given elems of said type
+	f_assign assign;		///< Routine used for creating memory for storing the data
+	f_swap swap;			///< Routine used for swaping two elemnts of goven data
+	f_free free;			///< Routine used for freeing elements of said data
+	f_cmp_idx cmp_idx;		///< Routine used for comparing elems in given array indicies
+	f_swp_idx swp_idx;              ///< Routine used for swapring elems in given array indicies	
+	f_cpy_idx cpy_idx;              ///< Routine used for copying elems in given array indicies
+	f_get_idx get_idx;              ///< Routine used for getting elem in given array index
+	f_print print_data;		///< Routine used for printing elem data
+} t_dparams;
+
+void init_data_params(t_dparams*, e_data_types);
+
 

common/inc/fault_manager.h

@@ -1,7 +1,14 @@
+/*! @file fault_manager.h
+    @brief 
+    Contains declarations of fault manager routines
+*/
+
 #pragma once
+
 #include <os.h>
 
-typedef void (*f_fault_handle)(int,siginfo_t *,void *);
+/// Function pointer for fault handler
+typedef void (*f_fault_handle)(int, siginfo_t *, void *);
 
 
 void fault_manager_init(f_fault_handle h);

common/inc/generic_def.h

@@ -0,0 +1,145 @@
+/*! @file generic_def.h
+    @brief 
+    Contains Macros that are used for defining psuedo data template functions
+*/
+#pragma once
+
+#include "typedefs.h"
+#include "memory_manager.h"
+
+/// Template Compare function for default data types
+#define CMPR(T, NAME)	e_cmpr NAME(t_gen x, t_gen y)\
+					{	\
+						e_cmpr ret = eEQUAL;\
+						T tmp = (*((T*)(x))) - (*((T*)(y)));\
+						if (tmp < 0)	\
+							ret = eLESS;\
+						else if (tmp > 0)\
+							ret = eGREAT;\
+						return ret;\
+					}
+
+
+/// Template Assign memory function for default data types
+#define ASSGN(T, NAME)	t_gen NAME(T y) \
+					{\
+						t_gen x = get_mem(1, sizeof(T));\
+						*((T*)x) = y;\
+						return x;\
+					}
+
+
+/// Template Swap function for default data types
+#define SWAP(T, NAME)	void NAME(t_gen x, t_gen y) \
+					{\
+						T tmp = *((T*)x);\
+						*((T*)x) = *((T*)y);\
+						*((T*)y) = tmp;\
+					}
+
+/// Defines format specfier depending on type of data
+/// used for implementing generic print
+/// Note: Requires C11 compiler since it use _Generic 
+#define FMT_SPF(T) _Generic((T),\
+    char: "%c", \
+    signed char: "%hhd", \
+    unsigned char: "%hhu", \
+    signed short: "%hd", \
+    unsigned short: "%hu", \
+    signed int: "%d", \
+    unsigned int: "%u", \
+    long int: "%ld", \
+    unsigned long int: "%lu", \
+    long long int: "%lld", \
+    unsigned long long int: "%llu", \
+    float: "%f", \
+    double: "%f", \
+    long double: "%Lf", \
+    char *: "%s", \
+    void *: "%p")
+ 
+
+/// Template print function for default data types
+#define PRINT_GEN(T, NAME)	void NAME(t_gen x) \
+				{ \
+					T y;\
+					printf(FMT_SPF(y), *((T*)x)); \
+				}
+
+/// Template function for comparing elemts at given indicies of an array for default data types
+#define CMPR_IDX(T, NAME)	e_cmpr NAME(t_gen x, int idx1, int idx2)\
+					{	\
+						e_cmpr ret = eEQUAL;\
+						T *arr = ((T*)(x));\
+						T tmp = arr[idx1] -arr[idx2];\
+						if (tmp < 0)	\
+							ret = eLESS;\
+						else if (tmp > 0)\
+							ret = eGREAT;\
+						return ret;\
+					}
+
+/// Template function for swaping elemts at given indicies of an array for default data types
+#define SWP_IDX(T, NAME)	void NAME(t_gen x, int idx1, int idx2)\
+					{	\
+						T *arr = ((T*)(x));\
+						T tmp = arr[idx1] ;\
+						arr[idx1] = arr[idx2];\
+						arr[idx2] = tmp;\
+					}
+
+/// Template function for copying element to a given index of an array for default data types
+#define COPY_IDX(T, NAME)	void NAME(t_gen x, int idx1, t_gen data)\
+					{	\
+						T *arr = ((T*)(x));\
+						arr[idx1] = *((T*)(data));\
+					}
+
+/// Template function for getting element at a given index of an array for default data types
+#define GET_IDX(T, NAME)	t_gen NAME(t_gen x, int idx1)\
+					{	\
+						T *arr = ((T*)(x));\
+						t_gen tmp = &arr[idx1] ;\
+						return tmp;\
+					}
+
+/// Below routines defined as reference for basic datatypes
+e_cmpr compare_char(t_gen,t_gen);
+e_cmpr compare_int(t_gen,t_gen);
+e_cmpr compare_float(t_gen,t_gen);
+e_cmpr compare_string(t_gen,t_gen);
+e_cmpr compare_gen(t_gen,t_gen);
+
+t_gen assign_char(char);
+t_gen assign_int(int);
+t_gen assign_float(float);
+t_gen assign_string(char*);
+t_gen assign_gen(t_gen);
+
+void swap_char(t_gen,t_gen);
+void swap_int(t_gen,t_gen);
+void swap_float(t_gen,t_gen);
+void swap_string(t_gen,t_gen);
+void swap_gen(t_gen,t_gen);
+
+void print_char(t_gen);
+void print_float(t_gen);
+void print_int(t_gen);
+void print_str(t_gen);
+void print_gen(t_gen);
+
+e_cmpr compare_idx_char(t_gen,int,int);
+e_cmpr compare_idx_int(t_gen,int,int);
+e_cmpr compare_idx_float(t_gen,int,int);
+
+void swap_idx_char(t_gen,int,int);
+void swap_idx_int(t_gen,int,int);
+void swap_idx_float(t_gen,int,int);
+
+void copy_idx_char(t_gen,int,t_gen);
+void copy_idx_int(t_gen,int,t_gen);
+void copy_idx_float(t_gen,int,t_gen);
+
+t_gen get_idx_char(t_gen,int);
+t_gen get_idx_int(t_gen,int);
+t_gen get_idx_float(t_gen,int);

common/inc/logger.h

@@ -1,14 +1,17 @@
-#ifndef _LOGGER_H
-#define _LOGGER_H
+/*! @file logger.h
+    @brief 
+    Defines Macros for logging 
+*/
+#pragma once
 
-#define __LOG_ERROR__		0
-#define __LOG_WARN__		1
-#define __LOG_INFO__		2
-#define __LOG_DEBUG__		3
-#define __LOG_TRACE__		4
+#define __LOG_ERROR__		0		///< log level Error
+#define __LOG_WARN__		1		///< log level Warn
+#define __LOG_INFO__		2		///< log level Info
+#define __LOG_DEBUG__		3		///< log level Debug
+#define __LOG_TRACE__		4		///< log level Trace
 
-#define MAX_LOG_LEVELS	5
-#define MAX_MODULES			4
+#define MAX_LOG_LEVELS		5
+#define MAX_MODULES		4
 #define	COMMON_MODULE		1
 
 #define LOG_ERROR(mod,fmt, args...)			app_log(mod, __LOG_ERROR__, NULL, fmt, ##args)
@@ -21,4 +24,3 @@
 void logger_init();
 int app_log(char *module, int level, char *prefix, const char *format, ...);
 
-#endif // End of _LOGGER_H

common/inc/memory_manager.h

@@ -1,12 +1,18 @@
+/*! @file memory_manager.h
+    @brief 
+    Contains decalration of structures for maintaing all mem alloc and frees
+*/
+
 #pragma once 
 
 #define get_mem(nmemb, size) tag_alloc(nmemb, size,  __FILE__, __LINE__)
-#define del_mem(mem_addr) untag_alloc(mem_addr, __FILE__, __LINE__) 
+#define free_mem(mem_addr) untag_alloc(mem_addr, __FILE__, __LINE__) 
+#define FREE_MEM untag_alloc
 
 typedef struct memory_record 
 {
 	void *mem;
-  size_t nmemb;
+	size_t nmemb;
 	size_t block_size;
 	char *file;
 	int line;

common/inc/os.h

@@ -1,17 +1,23 @@
+/*! @file os.h
+    @brief 
+    Used for including os specific headers
+*/
+#pragma once
+
 #include <stdio.h>
 #include <stdlib.h>
 #include <stdint.h>
 #include <stdbool.h>
 #include <stdarg.h>
 #include <string.h>
+#include <unistd.h>
 #include <assert.h>
 #include <pthread.h>
 #include <signal.h>
 #include <sys/time.h>
 
-
+/// Custom malloc if not defined use calloc and free
 #ifndef CUSTOM_MALLOC
 	#define os_alloc(nmemb, size)				calloc((nmemb), (size))
 	#define os_free(mem_addr)						free((mem_addr))
-
-#endif
+#endif