diff --git a/CMakeLists.txt b/CMakeLists.txt index e21a14d5e..ab5509402 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,5 +1,5 @@ cmake_minimum_required(VERSION 2.6) - +message(STATUS "CMake version: ${CMAKE_VERSION}") include(macros.cmake) enable_testing() @@ -24,9 +24,13 @@ configure_file(${CMAKE_SOURCE_DIR}/etc/ubuntu/init.d/maxscale.in ${CMAKE_SOURCE_ set(CMAKE_C_FLAGS "-Wall -fPIC") set(CMAKE_CXX_FLAGS "-Wall -fPIC") -if(BUILD_TYPE MATCHES Debug) +if(BUILD_TYPE STREQUAL Debug) set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -ggdb -pthread -pipe -DSS_DEBUG -Wformat -Werror=format-security -fstack-protector --param=ssp-buffer-size=4") set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -ggdb -pthread -pipe -DSS_DEBUG -Wformat -Werror=format-security -fstack-protector --param=ssp-buffer-size=4") + message(STATUS "Generating debugging symbols and enabling debugging code") +elseif(BUILD_TYPE STREQUAL DebugSymbols) + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -ggdb -pthread -pipe -Wformat -Werror=format-security -fstack-protector --param=ssp-buffer-size=4") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -ggdb -pthread -pipe -Wformat -Werror=format-security -fstack-protector --param=ssp-buffer-size=4") message(STATUS "Generating debugging symbols") elseif(BUILD_TYPE MATCHES Optimized) if(NOT (DEFINED OLEVEL)) diff --git a/README b/README index eeb103c1d..a939021d0 100644 --- a/README +++ b/README @@ -205,7 +205,10 @@ or define the variables manually at configuration time. All the variables that control the CMake build process: INSTALL_DIR= Installation directory -BUILD_TYPE=[None|Debug|Release] Type of the build, defaults to Release (optimized) + +BUILD_TYPE= Type of the build. One of None, Debug, DebugSymbols, Optimized. (default None) + DebugSymbols enables debugging symbols, Debug enables debugging symbols and code, Optimized builds an optimized version. + INSTALL_SYSTEM_FILES=[Y|N] Install startup scripts and ld configuration files EMBEDDED_LIB= Path to the embedded library location (libmysqld.a for static and libmysqld.so for dynamic) MYSQL_DIR= Path to MySQL headers diff --git a/log_manager/log_manager.cc b/log_manager/log_manager.cc index f690661b6..59e108920 100644 --- a/log_manager/log_manager.cc +++ b/log_manager/log_manager.cc @@ -2073,7 +2073,7 @@ static bool logfile_init( char* c; pid_t pid = getpid(); int len = strlen(shm_pathname_prefix)+ - get_decimal_len((size_t)pid); + get_decimal_len((size_t)pid) + 1; c = (char *)calloc(len, sizeof(char)); diff --git a/macros.cmake b/macros.cmake index cc29a5e09..bc1bd24e6 100644 --- a/macros.cmake +++ b/macros.cmake @@ -82,24 +82,29 @@ macro(check_dirs) set(DEPS_OK TRUE CACHE BOOL "If all the dependencies were found.") # Find the MySQL headers if they were not defined + if(DEFINED MYSQL_DIR) if(DEBUG_OUTPUT) message(STATUS "Searching for MySQL headers at: ${MYSQL_DIR}") endif() find_path(MYSQL_DIR_LOC mysql.h PATHS ${MYSQL_DIR} PATH_SUFFIXES mysql mariadb NO_DEFAULT_PATH) + else() + find_path(MYSQL_DIR_LOC mysql.h PATH_SUFFIXES mysql mariadb) endif() - find_path(MYSQL_DIR_LOC mysql.h PATH_SUFFIXES mysql mariadb) + if(DEBUG_OUTPUT) message(STATUS "Search returned: ${MYSQL_DIR_LOC}") endif() - if(${MYSQL_DIR_LOC} STREQUAL "MYSQL_DIR_LOC-NOTFOUND") + + if(${MYSQL_DIR_LOC} MATCHES "NOTFOUND") set(DEPS_OK FALSE CACHE BOOL "If all the dependencies were found.") message(FATAL_ERROR "Fatal Error: MySQL headers were not found.") else() - message(STATUS "Using MySQL headers found at: ${MYSQL_DIR}") set(MYSQL_DIR ${MYSQL_DIR_LOC} CACHE PATH "Path to MySQL headers" FORCE) + message(STATUS "Using MySQL headers found at: ${MYSQL_DIR}") endif() - set(MYSQL_DIR_LOC "" INTERNAL) + + unset(MYSQL_DIR_LOC) # Find the errmsg.sys file if it was not defied if( DEFINED ERRMSG ) @@ -113,7 +118,7 @@ macro(check_dirs) message(STATUS "Using errmsg.sys found at: ${ERRMSG_FILE}") endif() set(ERRMSG ${ERRMSG_FILE} CACHE FILEPATH "Path to the errmsg.sys file." FORCE) - set(ERRMSG_FILE "" INTERNAL) + unset(ERRMSG_FILE) # Find the embedded mysql library if(STATIC_EMBEDDED) @@ -133,7 +138,7 @@ macro(check_dirs) endif() set(EMBEDDED_LIB ${EMBEDDED_LIB_STATIC} CACHE FILEPATH "Path to libmysqld" FORCE) set(CMAKE_FIND_LIBRARY_SUFFIXES ${OLD_SUFFIXES}) - set(OLD_SUFFIXES "" INTERNAL) + unset(OLD_SUFFIXES) else() if (DEFINED EMBEDDED_LIB) @@ -150,8 +155,8 @@ macro(check_dirs) set(EMBEDDED_LIB ${EMBEDDED_LIB_DYNAMIC} CACHE FILEPATH "Path to libmysqld" FORCE) endif() - set(EMBEDDED_LIB_DYNAMIC "" INTERNAL) - set(EMBEDDED_LIB_STATIC "" INTERNAL) + unset(EMBEDDED_LIB_DYNAMIC) + unset(EMBEDDED_LIB_STATIC) # Inform the user about the embedded library if( (${EMBEDDED_LIB} STREQUAL "EMBEDDED_LIB_STATIC-NOTFOUND") OR (${EMBEDDED_LIB} STREQUAL "EMBEDDED_LIB_DYNAMIC-NOTFOUND")) @@ -176,17 +181,18 @@ macro(check_dirs) else() set(DEB_BASED FALSE CACHE BOOL "If init.d script uses /lib/lsb/init-functions instead of /etc/rc.d/init.d/functions.") endif() - set(DEB_FNC "" INTERNAL) - set(RPM_FNC "" INTERNAL) + unset(DEB_FNC) + unset(RPM_FNC) #Check RabbitMQ headers and libraries if(BUILD_RABBITMQ) if(DEFINED RABBITMQ_LIB) find_library(RMQ_LIB rabbitmq PATHS ${RABBITMQ_LIB} NO_DEFAULT_PATH) + else() + find_library(RMQ_LIB rabbitmq) endif() - find_library(RMQ_LIB rabbitmq) - if(RMQ_LIB STREQUAL "RMQ_LIB-NOTFOUND") + if(RMQ_LIB MATCHES "NOTFOUND") set(DEPS_OK FALSE CACHE BOOL "If all the dependencies were found.") message(FATAL_ERROR "Cannot find RabbitMQ libraries, please define the path to the libraries with -DRABBITMQ_LIB=") else() @@ -196,9 +202,10 @@ macro(check_dirs) if(DEFINED RABBITMQ_HEADERS) find_file(RMQ_HEADERS amqp.h PATHS ${RABBITMQ_HEADERS} NO_DEFAULT_PATH) + else() + find_file(RMQ_HEADERS amqp.h) endif() - find_file(RMQ_HEADERS amqp.h) - if(RMQ_HEADERS STREQUAL "RMQ_HEADERS-NOTFOUND") + if(RMQ_HEADERS MATCHES "NOTFOUND") set(DEPS_OK FALSE CACHE BOOL "If all the dependencies were found.") message(FATAL_ERROR "Cannot find RabbitMQ headers, please define the path to the headers with -DRABBITMQ_HEADERS=") else() diff --git a/makefile.inc b/makefile.inc index 279cea6a4..0d63b5192 100644 --- a/makefile.inc +++ b/makefile.inc @@ -25,7 +25,7 @@ endif # -O2 -g -pipe -Wformat -Werror=format-security -Wp,-D_FORTIFY_SOURCE=2 -fstack-protector --param=ssp-buffer-size=4 -fPIC CFLAGS := $(CFLAGS) -Wall -LDLIBS := $(LDLIBS) -pthread +LDLIBS := $(LDLIBS) -pthread -lm LDMYSQL := -lmysqld CPP_LDLIBS := -lstdc++ diff --git a/query_classifier/query_classifier.h b/query_classifier/query_classifier.h index db2011642..3600bce5a 100644 --- a/query_classifier/query_classifier.h +++ b/query_classifier/query_classifier.h @@ -18,6 +18,7 @@ Copyright MariaDB Corporation Ab */ /** getpid */ +#include #include #include #include diff --git a/query_classifier/test/CMakeLists.txt b/query_classifier/test/CMakeLists.txt index ceaad8110..3ed80e8a6 100644 --- a/query_classifier/test/CMakeLists.txt +++ b/query_classifier/test/CMakeLists.txt @@ -1 +1,14 @@ -add_subdirectory(canonical_tests) \ No newline at end of file +if(${ERRMSG} MATCHES "ERRMSG-NOTFOUND") + message(FATAL_ERROR "The errmsg.sys file was not found, please define the path with -DERRMSG=") +else() + if(${CMAKE_VERSION} VERSION_LESS 2.8) + execute_process(COMMAND cp ${ERRMSG} ${CMAKE_CURRENT_BINARY_DIR}) + else() + file(COPY ${ERRMSG} DESTINATION ${CMAKE_CURRENT_BINARY_DIR}) + endif() +endif() + +add_subdirectory(canonical_tests) +add_executable(classify classify.c) +target_link_libraries(classify query_classifier fullcore) +add_test(TestQueryClassifier classify ${CMAKE_CURRENT_SOURCE_DIR}/input.sql ${CMAKE_CURRENT_SOURCE_DIR}/expected.sql) \ No newline at end of file diff --git a/query_classifier/test/canonical_tests/CMakeLists.txt b/query_classifier/test/canonical_tests/CMakeLists.txt index 4777fad8d..26bc64602 100644 --- a/query_classifier/test/canonical_tests/CMakeLists.txt +++ b/query_classifier/test/canonical_tests/CMakeLists.txt @@ -1,6 +1,11 @@ -file(COPY ${ERRMSG} DESTINATION ${CMAKE_CURRENT_BINARY_DIR}) if(${ERRMSG} MATCHES "ERRMSG-NOTFOUND") message(FATAL_ERROR "The errmsg.sys file was not found, please define the path with -DERRMSG=") +else() + if(${CMAKE_VERSION} VERSION_LESS 2.8) + execute_process(COMMAND cp ${ERRMSG} ${CMAKE_CURRENT_BINARY_DIR}) + else() + file(COPY ${ERRMSG} DESTINATION ${CMAKE_CURRENT_BINARY_DIR}) + endif() endif() add_executable(canonizer canonizer.c) target_link_libraries(canonizer pthread query_classifier z dl ssl aio crypt crypto rt m ${EMBEDDED_LIB} fullcore stdc++) diff --git a/query_classifier/test/canonical_tests/canonizer.c b/query_classifier/test/canonical_tests/canonizer.c index 7e33fe4a1..bffe9c1b9 100644 --- a/query_classifier/test/canonical_tests/canonizer.c +++ b/query_classifier/test/canonical_tests/canonizer.c @@ -1,3 +1,4 @@ +#include #include #include #include diff --git a/query_classifier/test/classify.c b/query_classifier/test/classify.c new file mode 100644 index 000000000..96a001771 --- /dev/null +++ b/query_classifier/test/classify.c @@ -0,0 +1,176 @@ +#include +#include +#include +#include +#include +#include +#include +#include +#include + +static char* server_options[] = { + "SkySQL Gateway", + "--no-defaults", + "--datadir=.", + "--language=.", + "--skip-innodb", + "--default-storage-engine=myisam", + NULL +}; + +const int num_elements = (sizeof(server_options) / sizeof(char *)) - 1; + +static char* server_groups[] = { + "embedded", + "server", + "server", + NULL +}; + +int main(int argc, char** argv) +{ + if(argc < 3){ + fprintf(stderr,"Usage: classify "); + return 1; + } + int rd = 0,buffsz = getpagesize(),strsz = 0,ex_val = 0; + char buffer[buffsz], *strbuff = (char*)calloc(buffsz,sizeof(char)); + FILE *input,*expected; + + if(mysql_library_init(num_elements, server_options, server_groups)) + { + printf("Error: Cannot initialize Embedded Library."); + return 1; + } + + input = fopen(argv[1],"rb"); + expected = fopen(argv[2],"rb"); + + while((rd = fread(buffer,sizeof(char),buffsz,input))){ + + /**Fill the read buffer*/ + if(strsz + rd >= buffsz){ + char* tmp = (char*)calloc((buffsz*2),sizeof(char)); + + if(!tmp){ + fprintf(stderr,"Error: Cannot allocate enough memory."); + return 1; + } + memcpy(tmp,strbuff,buffsz); + free(strbuff); + strbuff = tmp; + buffsz *= 2; + } + + memcpy(strbuff+strsz,buffer,rd); + strsz += rd; + + char *tok,*nlptr; + + /**Remove newlines*/ + while((nlptr = strpbrk(strbuff,"\n")) != NULL && (nlptr - strbuff) < strsz){ + memmove(nlptr,nlptr+1,strsz - (nlptr + 1 - strbuff)); + strsz -= 1; + } + + + /**Parse read buffer for full queries*/ + + while(strpbrk(strbuff,";") != NULL){ + tok = strpbrk(strbuff,";"); + unsigned int qlen = tok - strbuff + 1; + GWBUF* buff = gwbuf_alloc(qlen+6); + *((unsigned char*)(buff->start)) = qlen; + *((unsigned char*)(buff->start + 1)) = (qlen >> 8); + *((unsigned char*)(buff->start + 2)) = (qlen >> 16); + *((unsigned char*)(buff->start + 3)) = 0x00; + *((unsigned char*)(buff->start + 4)) = 0x03; + memcpy(buff->start+5, strbuff, qlen); + memmove(strbuff,tok + 1, strsz - qlen); + strsz -= qlen; + memset(strbuff + strsz,0,buffsz - strsz); + skygw_query_type_t type = query_classifier_get_type(buff); + char qtypestr[64]; + char expbuff[256]; + int expos = 0; + + while((rd = fgetc(expected)) != '\n' && !feof(expected)){ + expbuff[expos++] = rd; + } + expbuff[expos] = '\0'; + + if(type == QUERY_TYPE_UNKNOWN){ + sprintf(qtypestr,"QUERY_TYPE_UNKNOWN"); + } + if(type & QUERY_TYPE_LOCAL_READ){ + sprintf(qtypestr,"QUERY_TYPE_LOCAL_READ"); + } + if(type & QUERY_TYPE_READ){ + sprintf(qtypestr,"QUERY_TYPE_READ"); + } + if(type & QUERY_TYPE_WRITE){ + sprintf(qtypestr,"QUERY_TYPE_WRITE"); + } + if(type & QUERY_TYPE_MASTER_READ){ + sprintf(qtypestr,"QUERY_TYPE_MASTER_READ"); + } + if(type & QUERY_TYPE_SESSION_WRITE){ + sprintf(qtypestr,"QUERY_TYPE_SESSION_WRITE"); + } + if(type & QUERY_TYPE_USERVAR_READ){ + sprintf(qtypestr,"QUERY_TYPE_USERVAR_READ"); + } + if(type & QUERY_TYPE_SYSVAR_READ){ + sprintf(qtypestr,"QUERY_TYPE_SYSVAR_READ"); + } + if(type & QUERY_TYPE_GSYSVAR_READ){ + sprintf(qtypestr,"QUERY_TYPE_GSYSVAR_READ"); + } + if(type & QUERY_TYPE_GSYSVAR_WRITE){ + sprintf(qtypestr,"QUERY_TYPE_GSYSVAR_WRITE"); + } + if(type & QUERY_TYPE_BEGIN_TRX){ + sprintf(qtypestr,"QUERY_TYPE_BEGIN_TRX"); + } + if(type & QUERY_TYPE_ENABLE_AUTOCOMMIT){ + sprintf(qtypestr,"QUERY_TYPE_ENABLE_AUTOCOMMIT"); + } + if(type & QUERY_TYPE_DISABLE_AUTOCOMMIT){ + sprintf(qtypestr,"QUERY_TYPE_DISABLE_AUTOCOMMIT"); + } + if(type & QUERY_TYPE_ROLLBACK){ + sprintf(qtypestr,"QUERY_TYPE_ROLLBACK"); + } + if(type & QUERY_TYPE_COMMIT){ + sprintf(qtypestr,"QUERY_TYPE_COMMIT"); + } + if(type & QUERY_TYPE_PREPARE_NAMED_STMT){ + sprintf(qtypestr,"QUERY_TYPE_PREPARE_NAMED_STMT"); + } + if(type & QUERY_TYPE_PREPARE_STMT){ + sprintf(qtypestr,"QUERY_TYPE_PREPARE_STMT"); + } + if(type & QUERY_TYPE_EXEC_STMT){ + sprintf(qtypestr,"QUERY_TYPE_EXEC_STMT"); + } + if(type & QUERY_TYPE_CREATE_TMP_TABLE){ + sprintf(qtypestr,"QUERY_TYPE_CREATE_TMP_TABLE"); + } + if(type & QUERY_TYPE_READ_TMP_TABLE){ + sprintf(qtypestr,"QUERY_TYPE_READ_TMP_TABLE"); + } + + if(strcmp(qtypestr,expbuff) != 0){ + printf("Error in output: '%s' was expected but got '%s'",expbuff,qtypestr); + ex_val = 1; + } + + gwbuf_free(buff); + } + + } + fclose(input); + fclose(expected); + free(strbuff); + return ex_val; +} diff --git a/query_classifier/test/expected.sql b/query_classifier/test/expected.sql new file mode 100644 index 000000000..23b7c9465 --- /dev/null +++ b/query_classifier/test/expected.sql @@ -0,0 +1,13 @@ +QUERY_TYPE_READ +QUERY_TYPE_READ +QUERY_TYPE_WRITE +QUERY_TYPE_WRITE +QUERY_TYPE_CREATE_TMP_TABLE +QUERY_TYPE_GSYSVAR_WRITE +QUERY_TYPE_SYSVAR_READ +QUERY_TYPE_USERVAR_READ +QUERY_TYPE_COMMIT +QUERY_TYPE_DISABLE_AUTOCOMMIT +QUERY_TYPE_BEGIN_TRX +QUERY_TYPE_ROLLBACK +QUERY_TYPE_COMMIT diff --git a/query_classifier/test/input.sql b/query_classifier/test/input.sql new file mode 100644 index 000000000..1b297b423 --- /dev/null +++ b/query_classifier/test/input.sql @@ -0,0 +1,13 @@ +select sleep(2); +select * from tst where lname like '%e%' order by fname; +insert into tst values ("Jane","Doe"),("Daisy","Duck"),("Marie","Curie"); +update tst set fname="Farmer", lname="McDonald" where lname="%Doe" and fname="John"; +create temporary table tmp as select * from t1; +/*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */; +select @@server_id; +select @OLD_SQL_NOTES; +SET autocommit=1; +SET autocommit=0; +BEGIN; +ROLLBACK; +COMMIT; diff --git a/server/core/Makefile b/server/core/Makefile index a5db8d9fe..26c6482eb 100644 --- a/server/core/Makefile +++ b/server/core/Makefile @@ -47,7 +47,7 @@ CC=cc CFLAGS=-c -I/usr/include -I../include -I../modules/include -I../inih \ $(MYSQL_HEADERS) \ -I$(LOGPATH) -I$(UTILSPATH) \ - -Wall -g + -Wall -pedantic -g LDFLAGS=-rdynamic -L$(LOGPATH) \ -Wl,-rpath,$(DEST)/lib \ diff --git a/server/core/buffer.c b/server/core/buffer.c index 279d793b8..46315cf69 100644 --- a/server/core/buffer.c +++ b/server/core/buffer.c @@ -1,5 +1,5 @@ /* - * This file is distributed as part of the MariaDB Corporation MaxScale. It is free + * This file is distributed as part of the SkySQL Gateway. It is free * software: you can redistribute it and/or modify it under the terms of the * GNU General Public License as published by the Free Software Foundation, * version 2. @@ -13,11 +13,11 @@ * this program; if not, write to the Free Software Foundation, Inc., 51 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. * - * Copyright MariaDB Corporation Ab 2013-2014 + * Copyright SkySQL Ab 2013 */ /** - * @file buffer.h - The MaxScale buffer management functions + * @file buffer.h - The Gateway buffer management functions * * The buffer management is based on the principle of a linked list * of variable size buffer, the intention beign to allow longer @@ -42,6 +42,8 @@ #include #include #include +#include +#include static buffer_object_t* gwbuf_remove_buffer_object( GWBUF* buf, @@ -65,20 +67,20 @@ gwbuf_alloc(unsigned int size) GWBUF *rval; SHARED_BUF *sbuf; - // Allocate the buffer header + /* Allocate the buffer header */ if ((rval = (GWBUF *)malloc(sizeof(GWBUF))) == NULL) { return NULL; } - // Allocate the shared data buffer + /* Allocate the shared data buffer */ if ((sbuf = (SHARED_BUF *)malloc(sizeof(SHARED_BUF))) == NULL) { free(rval); return NULL; } - // Allocate the space for the actual data + /* Allocate the space for the actual data */ if ((sbuf->data = (unsigned char *)malloc(size)) == NULL) { free(rval); @@ -87,7 +89,7 @@ SHARED_BUF *sbuf; } spinlock_init(&rval->gwbuf_lock); rval->start = sbuf->data; - rval->end = (void*)((uint8_t*)rval->start + size); + rval->end = (void *)((char *)rval->start+size); sbuf->refcount = 1; rval->sbuf = sbuf; rval->next = NULL; @@ -197,8 +199,8 @@ GWBUF *gwbuf_clone_portion( atomic_add(&buf->sbuf->refcount, 1); clonebuf->sbuf = buf->sbuf; clonebuf->gwbuf_type = buf->gwbuf_type; /*< clone info bits too */ - clonebuf->start = (void *)((char*)buf->start)+start_offset; - clonebuf->end = (void *)((char *)clonebuf->start)+length; + clonebuf->start = (void *)((char*)buf->start+start_offset); + clonebuf->end = (void *)((char *)clonebuf->start+length); clonebuf->gwbuf_type = buf->gwbuf_type; /*< clone the type for now */ clonebuf->properties = NULL; clonebuf->hint = NULL; @@ -277,8 +279,6 @@ return_clonebuf: GWBUF * gwbuf_append(GWBUF *head, GWBUF *tail) { -GWBUF *ptr = head; - if (!head) return tail; CHK_GWBUF(head); @@ -311,7 +311,7 @@ GWBUF *rval = head; CHK_GWBUF(head); GWBUF_CONSUME(head, length); - CHK_GWBUF(head); + CHK_GWBUF(head); if (GWBUF_EMPTY(head)) { @@ -370,11 +370,36 @@ gwbuf_trim(GWBUF *buf, unsigned int n_bytes) gwbuf_consume(buf, GWBUF_LENGTH(buf)); return NULL; } - buf->end -= n_bytes; + buf->end = (void *)((char *)buf->end - n_bytes); return buf; } +/** + * Trim bytes from the end of a GWBUF structure that may be the first + * in a list. If the buffer has n_bytes or less then it will be freed and + * the next buffer in the list will be returned, or if none, NULL. + * + * @param head The buffer to trim + * @param n_bytes The number of bytes to trim off + * @return The buffer chain or NULL if buffer chain now empty + */ +GWBUF * +gwbuf_rtrim(GWBUF *head, unsigned int n_bytes) +{ +GWBUF *rval = head; + CHK_GWBUF(head); + GWBUF_RTRIM(head, n_bytes); + CHK_GWBUF(head); + + if (GWBUF_EMPTY(head)) + { + rval = head->next; + gwbuf_free(head); + } + return rval; +} + /** * Set given type to all buffers on the list. * * diff --git a/server/core/config.c b/server/core/config.c index 0255f8c2c..61bc6157d 100644 --- a/server/core/config.c +++ b/server/core/config.c @@ -41,6 +41,7 @@ * * @endverbatim */ +#include #include #include #include @@ -131,7 +132,7 @@ CONFIG_PARAMETER *param, *p1; ptr->element = NULL; cntxt->next = ptr; } - /* Check to see if the paramter already exists for the section */ + /* Check to see if the parameter already exists for the section */ p1 = ptr->parameters; while (p1) { diff --git a/server/core/dcb.c b/server/core/dcb.c index e624a4526..36e088dfc 100644 --- a/server/core/dcb.c +++ b/server/core/dcb.c @@ -32,7 +32,7 @@ * 12/06/13 Mark Riddoch Initial implementation * 21/06/13 Massimiliano Pinto free_dcb is used * 25/06/13 Massimiliano Pinto Added checks to session and router_session - * 28/06/13 Mark Riddoch Changed the free mechanism ti + * 28/06/13 Mark Riddoch Changed the free mechanism to * introduce a zombie state for the * dcb * 02/07/2013 Massimiliano Pinto Addition of delayqlock, delayq and @@ -73,7 +73,7 @@ extern int lm_enabled_logfiles_bitmask; -static DCB *allDCBs = NULL; /* Diagnotics need a list of DCBs */ +static DCB *allDCBs = NULL; /* Diagnostics need a list of DCBs */ static DCB *zombies = NULL; static SPINLOCK dcbspin = SPINLOCK_INIT; static SPINLOCK zombiespin = SPINLOCK_INIT; @@ -88,6 +88,7 @@ static DCB* dcb_get_next (DCB* dcb); static int dcb_null_write(DCB *dcb, GWBUF *buf); static int dcb_null_close(DCB *dcb); static int dcb_null_auth(DCB *dcb, SERVER *server, SESSION *session, GWBUF *buf); +static int dcb_isvalid_nolock(DCB *dcb); /** * Return the pointer to the lsit of zombie DCB's @@ -1893,20 +1894,40 @@ dcb_isvalid(DCB *dcb) DCB *ptr; int rval = 0; + if (dcb) + { spinlock_acquire(&dcbspin); + rval = dcb_isvalid_nolock(dcb); + spinlock_release(&dcbspin); + } + + return rval; +} + + +/** + * Check the passed DCB to ensure it is in the list of allDCBS. + * Requires that the DCB list is already locked before call. + * + * @param dcb The DCB to check + * @return 1 if the DCB is in the list, otherwise 0 + */ +static int +dcb_isvalid_nolock(DCB *dcb) +{ +DCB *ptr; +int rval = 0; + + if (dcb) + { ptr = allDCBs; - while (ptr) + while (ptr && ptr != dcb) { - if (ptr == dcb) - { - rval = 1; - break; - } ptr = ptr->next; } - spinlock_release(&dcbspin); - - return rval; + rval = (ptr == dcb); + } + return rval; } @@ -1919,33 +1940,11 @@ int rval = 0; static DCB * dcb_get_next (DCB* dcb) { - DCB* p; - spinlock_acquire(&dcbspin); - - p = allDCBs; - - if (dcb == NULL || p == NULL) - { - dcb = p; - - } - else - { - while (p != NULL && dcb != p) - { - p = p->next; - } - - if (p != NULL) - { - dcb = p->next; - } - else - { - dcb = NULL; - } + if (dcb) { + dcb = dcb_isvalid_nolock(dcb) ? dcb->next : NULL; } + else dcb = allDCBs; spinlock_release(&dcbspin); return dcb; diff --git a/server/core/gateway.c b/server/core/gateway.c index f3724e87d..34783bc52 100644 --- a/server/core/gateway.c +++ b/server/core/gateway.c @@ -40,10 +40,13 @@ * @endverbatim */ #define _XOPEN_SOURCE 700 +#include #include #include +#include #include #include +#include #include #include #include @@ -226,7 +229,6 @@ sigfatal_handler (int i) { void *addrs[128]; - char **strings= NULL; int n, count = backtrace(addrs, 128); char** symbols = backtrace_symbols( addrs, count ); @@ -1088,9 +1090,9 @@ int main(int argc, char **argv) goto return_main; case 'l': - if (strncasecmp(optarg, "file") == 0) + if (strncasecmp(optarg, "file", PATH_MAX) == 0) logtofile = 1; - else if (strncasecmp(optarg, "shm") == 0) + else if (strncasecmp(optarg, "shm", PATH_MAX) == 0) logtofile = 0; else { @@ -1669,6 +1671,8 @@ static void log_flush_cb( void* arg) { ssize_t timeout_ms = *(ssize_t *)arg; + const struct timespec ts1 = {0, 1000000*timeout_ms}; + struct timespec ts2; LOGIF(LM, (skygw_log_write(LOGFILE_MESSAGE, "Started MaxScale log flusher."))); @@ -1677,7 +1681,7 @@ static void log_flush_cb( skygw_log_flush(LOGFILE_MESSAGE); skygw_log_flush(LOGFILE_TRACE); skygw_log_flush(LOGFILE_DEBUG); - usleep(timeout_ms*1000); + nanosleep(&ts1, &ts2); } LOGIF(LM, (skygw_log_write(LOGFILE_MESSAGE, "Finished MaxScale log flusher."))); diff --git a/server/core/gw_utils.c b/server/core/gw_utils.c index e89d72041..d5ee3e429 100644 --- a/server/core/gw_utils.c +++ b/server/core/gw_utils.c @@ -34,6 +34,7 @@ * 25-09-2013 Massimiliano Pinto setipaddress uses getaddrinfo * 06-02-2014 Mark Riddoch Added parse_bindconfig * 10-02-2014 Massimiliano Pinto Added return code to setipaddress + * 02-09-2014 Martin Brampton Replace C++ comment with C comment * *@endverbatim */ @@ -148,7 +149,7 @@ void gw_daemonize(void) { } if (pid != 0) { - // exit from main + /* exit from main */ exit(0); } diff --git a/server/core/poll.c b/server/core/poll.c index 37784176e..bfb1e65c6 100644 --- a/server/core/poll.c +++ b/server/core/poll.c @@ -15,6 +15,7 @@ * * Copyright MariaDB Corporation Ab 2013-2014 */ +#include #include #include #include @@ -257,7 +258,7 @@ poll_add_dcb(DCB *dcb) dcb, STRDCBSTATE(dcb->state)))); } - ss_dassert(rc == 0); /*< trap in debug */ + ss_info_dassert(rc == 0, "Unable to add poll"); /*< trap in debug */ } else { LOGIF(LE, (skygw_log_write_flush( LOGFILE_ERROR, diff --git a/server/core/server.c b/server/core/server.c index 2afe3bd44..167ae4f23 100644 --- a/server/core/server.c +++ b/server/core/server.c @@ -136,7 +136,7 @@ SERVER *ptr; /** * Set a unique name for the server * - * @param server The server to ste the name on + * @param server The server to set the name on * @param name The unique name for the server */ void diff --git a/server/core/service.c b/server/core/service.c index 040746f42..bf32846ce 100644 --- a/server/core/service.c +++ b/server/core/service.c @@ -91,10 +91,10 @@ static void service_add_qualified_param( * @param servname The service name * @param router Name of the router module this service uses * - * @return The newly created service or NULL if an error occured + * @return The newly created service or NULL if an error occurred */ SERVICE * -service_alloc(char *servname, char *router) +service_alloc(const char *servname, const char *router) { SERVICE *service; @@ -152,7 +152,7 @@ SERVICE *service; /** * Check to see if a service pointer is valid * - * @param service The poitner to check + * @param service The pointer to check * @return 1 if the service is in the list of all services */ int diff --git a/server/core/spinlock.c b/server/core/spinlock.c index 614d1249b..871ec42bb 100644 --- a/server/core/spinlock.c +++ b/server/core/spinlock.c @@ -30,6 +30,7 @@ #include #include +#include /** * Initialise a spinlock. @@ -39,13 +40,13 @@ void spinlock_init(SPINLOCK *lock) { - lock->lock = 0; + lock->lock = 0; #if SPINLOCK_PROFILE - lock->spins = 0; - lock->acquired = 0; - lock->waiting = 0; - lock->max_waiting = 0; - lock->contended = 0; + lock->spins = 0; + lock->acquired = 0; + lock->waiting = 0; + lock->max_waiting = 0; + lock->contended = 0; #endif } @@ -62,24 +63,30 @@ int spins = 0; atomic_add(&(lock->waiting), 1); #endif - while (atomic_add(&(lock->lock), 1) != 0) - { - atomic_add(&(lock->lock), -1); + +#ifdef __GNUC__ + while (__sync_lock_test_and_set(&(lock->lock), 1)) + while (lock->lock) { +#else + while (atomic_add(&(lock->lock), 1) != 0) + { + atomic_add(&(lock->lock), -1); +#endif #if SPINLOCK_PROFILE atomic_add(&(lock->spins), 1); spins++; #endif } #if SPINLOCK_PROFILE - if (spins) - { - lock->contended++; - if (lock->maxspins < spins) - lock->maxspins = spins; - } - lock->acquired++; - lock->owner = THREAD_SHELF(); - atomic_add(&(lock->waiting), -1); + if (spins) + { + lock->contended++; + if (lock->maxspins < spins) + lock->maxspins = spins; + } + lock->acquired++; + lock->owner = THREAD_SHELF(); + atomic_add(&(lock->waiting), -1); #endif } @@ -92,16 +99,20 @@ int spins = 0; int spinlock_acquire_nowait(SPINLOCK *lock) { - if (atomic_add(&(lock->lock), 1) != 0) - { - atomic_add(&(lock->lock), -1); - return FALSE; - } -#if SPINLOCK_PROFILE - lock->acquired++; - lock->owner = THREAD_SHELF(); +#ifdef __GNUC__ + if (__sync_lock_test_and_set(&(lock->lock), 1)) return FALSE; +#else + if (atomic_add(&(lock->lock), 1) != 0) + { + atomic_add(&(lock->lock), -1); + return FALSE; + } #endif - return TRUE; +#if SPINLOCK_PROFILE + lock->acquired++; + lock->owner = THREAD_SHELF(); +#endif + return TRUE; } /* @@ -112,11 +123,16 @@ spinlock_acquire_nowait(SPINLOCK *lock) void spinlock_release(SPINLOCK *lock) { -#if SPINLOCK_PROFILE - if (lock->waiting > lock->max_waiting) - lock->max_waiting = lock->waiting; + #if SPINLOCK_PROFILE + if (lock->waiting > lock->max_waiting) + lock->max_waiting = lock->waiting; +#endif +#ifdef __GNUC__ + __sync_synchronize(); /* Memory barrier. */ + lock->lock = 0; +#else + atomic_add(&(lock->lock), -1); #endif - atomic_add(&(lock->lock), -1); } /** diff --git a/server/core/test/CMakeLists.txt b/server/core/test/CMakeLists.txt index fcbd343e2..ea2cb4a95 100644 --- a/server/core/test/CMakeLists.txt +++ b/server/core/test/CMakeLists.txt @@ -1,16 +1,40 @@ add_executable(test_mysql_users test_mysql_users.c) add_executable(test_hash testhash.c) +add_executable(test_hint testhint.c) add_executable(test_spinlock testspinlock.c) add_executable(test_filter testfilter.c) +add_executable(test_buffer testbuffer.c) +add_executable(test_dcb testdcb.c) +add_executable(test_modutil testmodutil.c) +add_executable(test_poll testpoll.c) +add_executable(test_service testservice.c) +add_executable(test_server testserver.c) +add_executable(test_users testusers.c) add_executable(test_adminusers testadminusers.c) target_link_libraries(test_mysql_users fullcore MySQLClient) target_link_libraries(test_hash fullcore) +target_link_libraries(test_hint fullcore) target_link_libraries(test_spinlock fullcore) target_link_libraries(test_filter fullcore) +target_link_libraries(test_buffer fullcore) +target_link_libraries(test_dcb fullcore) +target_link_libraries(test_modutil fullcore) +target_link_libraries(test_poll fullcore) +target_link_libraries(test_service fullcore) +target_link_libraries(test_server fullcore) +target_link_libraries(test_users fullcore) target_link_libraries(test_adminusers fullcore) add_test(testMySQLUsers test_mysql_users) add_test(TestHash test_hash) +add_test(TestHint test_hint) add_test(TestSpinlock test_spinlock) add_test(TestFilter test_filter) +add_test(TestBuffer test_buffer) +add_test(TestDCB test_dcb) +add_test(TestModutil test_modutil) +add_test(TestPoll test_poll) +add_test(TestService test_service) +add_test(TestServer test_server) +add_test(TestUsers test_users) add_test(TestAdminUsers test_adminusers) diff --git a/server/core/test/makefile b/server/core/test/makefile index 14f2828f2..ed0bbc23e 100644 --- a/server/core/test/makefile +++ b/server/core/test/makefile @@ -18,10 +18,11 @@ LDFLAGS=-rdynamic -L$(LOGPATH) -L$(EMBEDDED_LIB) \ -Wl,-rpath,$(LOGPATH) -Wl,-rpath,$(UTILSPATH) \ -Wl,-rpath,$(EMBEDDED_LIB) -LIBS= -lz -lm -lcrypt -lcrypto -ldl -laio -lrt -pthread -llog_manager \ - -L../../inih/extra -linih -lssl -lstdc++ -lmysqld +LIBS= -L$(EMBEDDED_LIB) -lmysqld \ + -lz -lm -lcrypt -lcrypto -ldl -laio -lrt -pthread -llog_manager \ + -L../../inih/extra -linih -lssl -lstdc++ -TESTS=testhash testspinlock testfilter testadminusers +TESTS=testhash testspinlock testbuffer testmodutil testpoll testservice testdcb testfilter testadminusers cleantests: - $(DEL) *.o @@ -47,6 +48,39 @@ testspinlock: testspinlock.c -I$(ROOT_PATH)/utils \ testspinlock.c ../spinlock.o ../atomic.o ../thread.o -o testspinlock +testmodutil: testmodutil.c + $(CC) $(CFLAGS) \ + -I$(ROOT_PATH)/server/include \ + -I$(ROOT_PATH)/utils \ + testmodutil.c ../modutil.o ../buffer.o ../atomic.o -o testmodutil + +testbuffer: testbuffer.c + $(CC) $(CFLAGS) \ + -I$(ROOT_PATH)/server/include \ + -I$(ROOT_PATH)/utils \ + testbuffer.c ../buffer.o ../atomic.o -o testbuffer + +testpoll: testpoll.c + $(CC) $(CFLAGS) $(LDFLAGS) \ + -I$(ROOT_PATH)/server/include \ + -I$(ROOT_PATH)/utils \ + -I$(ROOT_PATH)/log_manager \ + testpoll.c libcore.a $(UTILSPATH)/skygw_utils.o $(LIBS) -o testpoll + +testservice: testservice.c + $(CC) $(CFLAGS) $(LDFLAGS) \ + -I$(ROOT_PATH)/server/include \ + -I$(ROOT_PATH)/utils \ + -I$(ROOT_PATH)/log_manager \ + testservice.c libcore.a $(UTILSPATH)/skygw_utils.o $(LIBS) -o testservice + +testdcb: testdcb.c + $(CC) $(CFLAGS) $(LDFLAGS) \ + -I$(ROOT_PATH)/server/include \ + -I$(ROOT_PATH)/utils \ + -I$(ROOT_PATH)/log_manager \ + testdcb.c libcore.a $(UTILSPATH)/skygw_utils.o $(LIBS) -o testdcb + testfilter: testfilter.c libcore.a $(CC) $(CFLAGS) $(LDFLAGS) \ -I$(ROOT_PATH)/server/include \ diff --git a/server/core/test/testbuffer.c b/server/core/test/testbuffer.c new file mode 100644 index 000000000..87ebf858b --- /dev/null +++ b/server/core/test/testbuffer.c @@ -0,0 +1,158 @@ +/* + * This file is distributed as part of MaxScale. It is free + * software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, + * version 2. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. + * + * You should have received a copy of the GNU General Public License along with + * this program; if not, write to the Free Software Foundation, Inc., 51 + * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Copyright SkySQL Ab 2014 + */ + +/** + * + * @verbatim + * Revision History + * + * Date Who Description + * 29-08-2014 Martin Brampton Initial implementation + * + * @endverbatim + */ + +#include +#include +#include + +#include + +/** + * test1 Allocate a buffer and do lots of things + * + */ +static int +test1() +{ +GWBUF *buffer, *extra, *clone, *partclone, *transform; +int size = 100; +int bite1 = 35; +int bite2 = 60; +int bite3 = 10; +int buflen; + + /* Single buffer tests */ + ss_dfprintf(stderr, + "testbuffer : creating buffer with data size %d bytes", + size); + buffer = gwbuf_alloc(size); + ss_dfprintf(stderr, "\t..done\nAllocated buffer of size %d.", size); + buflen = GWBUF_LENGTH(buffer); + ss_dfprintf(stderr, "\nBuffer length is now %d", buflen); + ss_info_dassert(size == buflen, "Incorrect buffer size"); + ss_info_dassert(0 == GWBUF_EMPTY(buffer), "Buffer should not be empty"); + ss_info_dassert(GWBUF_IS_TYPE_UNDEFINED(buffer), "Buffer type should be undefined"); + ss_dfprintf(stderr, "\t..done\nSet a property for the buffer"); + gwbuf_add_property(buffer, "name", "value"); + ss_info_dassert(0 == strcmp("value", gwbuf_get_property(buffer, "name")), "Should now have correct property"); + strcpy(GWBUF_DATA(buffer), "The quick brown fox jumps over the lazy dog"); + ss_dfprintf(stderr, "\t..done\nLoad some data into the buffer"); + ss_info_dassert('q' == GWBUF_DATA_CHAR(buffer, 4), "Fourth character of buffer must be 'q'"); + ss_info_dassert(-1 == GWBUF_DATA_CHAR(buffer, 105), "Hundred and fifth character of buffer must return -1"); + ss_info_dassert(0 == GWBUF_IS_SQL(buffer), "Must say buffer is not SQL, as it does not have marker"); + strcpy(GWBUF_DATA(buffer), "1234\x03SELECT * FROM sometable"); + ss_dfprintf(stderr, "\t..done\nLoad SQL data into the buffer"); + ss_info_dassert(1 == GWBUF_IS_SQL(buffer), "Must say buffer is SQL, as it does have marker"); + transform = gwbuf_clone_transform(buffer, GWBUF_TYPE_PLAINSQL); + ss_dfprintf(stderr, "\t..done\nAttempt to transform buffer to plain SQL - should fail"); + ss_info_dassert(NULL == transform, "Buffer cannot be transformed to plain SQL"); + gwbuf_set_type(buffer, GWBUF_TYPE_MYSQL); + ss_dfprintf(stderr, "\t..done\nChanged buffer type to MySQL"); + ss_info_dassert(GWBUF_IS_TYPE_MYSQL(buffer), "Buffer type changed to MySQL"); + transform = gwbuf_clone_transform(buffer, GWBUF_TYPE_PLAINSQL); + ss_dfprintf(stderr, "\t..done\nAttempt to transform buffer to plain SQL - should succeed"); + ss_info_dassert((NULL != transform) && (GWBUF_IS_TYPE_PLAINSQL(transform)), "Transformed buffer is plain SQL"); + clone = gwbuf_clone(buffer); + ss_dfprintf(stderr, "\t..done\nCloned buffer"); + buflen = GWBUF_LENGTH(clone); + ss_dfprintf(stderr, "\nCloned buffer length is now %d", buflen); + ss_info_dassert(size == buflen, "Incorrect buffer size"); + ss_info_dassert(0 == GWBUF_EMPTY(clone), "Cloned buffer should not be empty"); + ss_dfprintf(stderr, "\t..done\n"); + gwbuf_free(clone); + ss_dfprintf(stderr, "Freed cloned buffer"); + ss_dfprintf(stderr, "\t..done\n"); + partclone = gwbuf_clone_portion(buffer, 25, 50); + buflen = GWBUF_LENGTH(partclone); + ss_dfprintf(stderr, "Part cloned buffer length is now %d", buflen); + ss_info_dassert(50 == buflen, "Incorrect buffer size"); + ss_info_dassert(0 == GWBUF_EMPTY(partclone), "Part cloned buffer should not be empty"); + ss_dfprintf(stderr, "\t..done\n"); + gwbuf_free(partclone); + ss_dfprintf(stderr, "Freed part cloned buffer"); + ss_dfprintf(stderr, "\t..done\n"); + buffer = gwbuf_consume(buffer, bite1); + ss_info_dassert(NULL != buffer, "Buffer should not be null"); + buflen = GWBUF_LENGTH(buffer); + ss_dfprintf(stderr, "Consumed %d bytes, now have %d, should have %d", bite1, buflen, size-bite1); + ss_info_dassert((size - bite1) == buflen, "Incorrect buffer size"); + ss_info_dassert(0 == GWBUF_EMPTY(buffer), "Buffer should not be empty"); + ss_dfprintf(stderr, "\t..done\n"); + buffer = gwbuf_consume(buffer, bite2); + ss_info_dassert(NULL != buffer, "Buffer should not be null"); + buflen = GWBUF_LENGTH(buffer); + ss_dfprintf(stderr, "Consumed %d bytes, now have %d, should have %d", bite2, buflen, size-bite1-bite2); + ss_info_dassert((size-bite1-bite2) == buflen, "Incorrect buffer size"); + ss_info_dassert(0 == GWBUF_EMPTY(buffer), "Buffer should not be empty"); + ss_dfprintf(stderr, "\t..done\n"); + buffer = gwbuf_consume(buffer, bite3); + ss_dfprintf(stderr, "Consumed %d bytes, should have null buffer", bite3); + ss_info_dassert(NULL == buffer, "Buffer should be null"); + + /* Buffer list tests */ + size = 100000; + buffer = gwbuf_alloc(size); + ss_dfprintf(stderr, "\t..done\nAllocated buffer of size %d.", size); + buflen = GWBUF_LENGTH(buffer); + ss_dfprintf(stderr, "\nBuffer length is now %d", buflen); + ss_info_dassert(size == buflen, "Incorrect buffer size"); + ss_info_dassert(0 == GWBUF_EMPTY(buffer), "Buffer should not be empty"); + ss_info_dassert(GWBUF_IS_TYPE_UNDEFINED(buffer), "Buffer type should be undefined"); + extra = gwbuf_alloc(size); + buflen = GWBUF_LENGTH(buffer); + ss_dfprintf(stderr, "\t..done\nAllocated extra buffer of size %d.", size); + ss_info_dassert(size == buflen, "Incorrect buffer size"); + buffer = gwbuf_append(buffer, extra); + buflen = gwbuf_length(buffer); + ss_dfprintf(stderr, "\t..done\nAppended extra buffer to original buffer to create list of size %d", buflen); + ss_info_dassert((size*2) == gwbuf_length(buffer), "Incorrect size for set of buffers"); + buffer = gwbuf_rtrim(buffer, 60000); + buflen = GWBUF_LENGTH(buffer); + ss_dfprintf(stderr, "\t..done\nTrimmed 60 bytes from buffer, now size is %d.", buflen); + ss_info_dassert((size-60000) == buflen, "Incorrect buffer size"); + buffer = gwbuf_rtrim(buffer, 60000); + buflen = GWBUF_LENGTH(buffer); + ss_dfprintf(stderr, "\t..done\nTrimmed another 60 bytes from buffer, now size is %d.", buflen); + ss_info_dassert(100000 == buflen, "Incorrect buffer size"); + ss_info_dassert(buffer == extra, "The buffer pointer should now point to the extra buffer"); + ss_dfprintf(stderr, "\t..done\n"); + + return 0; +} + +int main(int argc, char **argv) +{ +int result = 0; + + result += test1(); + + exit(result); +} + + diff --git a/server/core/test/testdcb.c b/server/core/test/testdcb.c new file mode 100644 index 000000000..5f8e18601 --- /dev/null +++ b/server/core/test/testdcb.c @@ -0,0 +1,87 @@ +/* + * This file is distributed as part of MaxScale. It is free + * software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, + * version 2. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. + * + * You should have received a copy of the GNU General Public License along with + * this program; if not, write to the Free Software Foundation, Inc., 51 + * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Copyright SkySQL Ab 2014 + */ + +/** + * + * @verbatim + * Revision History + * + * Date Who Description + * 05-09-2014 Martin Brampton Initial implementation + * + * @endverbatim + */ + +#include +#include +#include + +#include + +/** + * test1 Allocate a dcb and do lots of other things + * + */ +static int +test1() +{ +DCB *dcb, *extra, *clone; +int size = 100; +int bite1 = 35; +int bite2 = 60; +int bite3 = 10; +int buflen; + + /* Single buffer tests */ + ss_dfprintf(stderr, + "testdcb : creating buffer with type DCB_ROLE_SERVICE_LISTENER"); + dcb = dcb_alloc(DCB_ROLE_SERVICE_LISTENER); + ss_info_dassert(dcb_isvalid(dcb), "New DCB must be valid"); + ss_dfprintf(stderr, "\t..done\nAllocated dcb."); + clone = dcb_clone(dcb); + ss_dfprintf(stderr, "\t..done\nCloned dcb"); + printAllDCBs(); + ss_info_dassert(true, "Something is true"); + ss_dfprintf(stderr, "\t..done\n"); + dcb_free(dcb); + ss_dfprintf(stderr, "Freed original dcb"); + ss_info_dassert(!dcb_isvalid(dcb), "Freed DCB must not be valid"); + ss_dfprintf(stderr, "\t..done\nMake clone DCB a zombie"); + clone->state = DCB_STATE_NOPOLLING; + dcb_add_to_zombieslist(clone); + ss_info_dassert(dcb_get_zombies() == clone, "Clone DCB must be start of zombie list now"); + ss_dfprintf(stderr, "\t..done\nProcess the zombies list"); + dcb_process_zombies(0); + ss_dfprintf(stderr, "\t..done\nCheck clone no longer valid"); + ss_info_dassert(!dcb_isvalid(clone), "After zombie processing, clone DCB must not be valid"); + ss_dfprintf(stderr, "\t..done\n"); + + return 0; +} + +int main(int argc, char **argv) +{ +int result = 0; + + result += test1(); + + exit(result); +} + + + diff --git a/server/core/test/testhint.c b/server/core/test/testhint.c new file mode 100644 index 000000000..3d2241642 --- /dev/null +++ b/server/core/test/testhint.c @@ -0,0 +1,69 @@ +/* + * This file is distributed as part of MaxScale. It is free + * software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, + * version 2. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. + * + * You should have received a copy of the GNU General Public License along with + * this program; if not, write to the Free Software Foundation, Inc., 51 + * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Copyright SkySQL Ab 2014 + */ + +/** + * + * @verbatim + * Revision History + * + * Date Who Description + * 08-10-2014 Martin Brampton Initial implementation + * + * @endverbatim + */ + +#include +#include +#include + +#include + +/** + * test1 Allocate table of users and mess around with it + * + */ + +static int +test1() +{ +HINT *hint; + + /* Hint tests */ + ss_dfprintf(stderr, + "testhint : Add a parameter hint to a null list"); + hint = hint_create_parameter(NULL, strdup("name"), "value"); + ss_info_dassert(NULL != hint, "New hint list should not be null"); + ss_info_dassert(0 == strcmp("value", hint->value), "Hint value should be correct"); + ss_info_dassert(0 != hint_exists(hint, HINT_PARAMETER), "Hint of parameter type should exist"); + ss_dfprintf(stderr, "\t..done\nFree hints."); + if (NULL != hint) hint_free(hint); + ss_dfprintf(stderr, "\t..done\n"); + + return 0; + +} + +int main(int argc, char **argv) +{ +int result = 0; + + result += test1(); + + exit(result); +} + diff --git a/server/core/test/testmodutil.c b/server/core/test/testmodutil.c new file mode 100644 index 000000000..e83facdc5 --- /dev/null +++ b/server/core/test/testmodutil.c @@ -0,0 +1,78 @@ +/* + * This file is distributed as part of MaxScale. It is free + * software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, + * version 2. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. + * + * You should have received a copy of the GNU General Public License along with + * this program; if not, write to the Free Software Foundation, Inc., 51 + * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Copyright SkySQL Ab 2014 + */ + +/** + * + * @verbatim + * Revision History + * + * Date Who Description + * 17-09-2014 Martin Brampton Initial implementation + * + * @endverbatim + */ + +#include +#include +#include + +#include +#include + +/** + * test1 Allocate a service and do lots of other things + * + */ + +static int +test1() +{ +GWBUF *buffer; +char *(sql[100]); +int result, length, residual; + + /* Poll tests */ + ss_dfprintf(stderr, + "testmodutil : Rudimentary tests."); + buffer = gwbuf_alloc(100); + ss_info_dassert(0 == modutil_is_SQL(buffer), "Default buffer should be diagnosed as not SQL"); + /* There would ideally be some straightforward way to create a SQL buffer? */ + ss_dfprintf(stderr, "\t..done\nExtract SQL from buffer"); + ss_info_dassert(0 == modutil_extract_SQL(buffer, sql, &length), "Default buffer should fail"); + ss_dfprintf(stderr, "\t..done\nExtract SQL from buffer different way?"); + ss_info_dassert(0 == modutil_MySQL_Query(buffer, sql, &length, &residual), "Default buffer should fail"); + ss_dfprintf(stderr, "\t..done\nReplace SQL in buffer"); + ss_info_dassert(0 == modutil_replace_SQL(buffer, "select * from some_table;"), "Default buffer should fail"); + ss_dfprintf(stderr, "\t..done\nTidy up."); + gwbuf_free(buffer); + ss_dfprintf(stderr, "\t..done\n"); + + return 0; + +} + +int main(int argc, char **argv) +{ +int result = 0; + + result += test1(); + + exit(result); +} + + diff --git a/server/core/test/testpoll.c b/server/core/test/testpoll.c new file mode 100644 index 000000000..aee799bb4 --- /dev/null +++ b/server/core/test/testpoll.c @@ -0,0 +1,77 @@ +/* + * This file is distributed as part of MaxScale. It is free + * software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, + * version 2. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. + * + * You should have received a copy of the GNU General Public License along with + * this program; if not, write to the Free Software Foundation, Inc., 51 + * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Copyright SkySQL Ab 2014 + */ + +/** + * + * @verbatim + * Revision History + * + * Date Who Description + * 11-09-2014 Martin Brampton Initial implementation + * + * @endverbatim + */ + +#include +#include +#include + +#include +#include + +/** + * test1 Allocate a service and do lots of other things + * + */ + +static int +test1() +{ +DCB *dcb; +int result; + + /* Poll tests */ + ss_dfprintf(stderr, + "testpoll : Initialise the polling system."); + poll_init(); + ss_dfprintf(stderr, "\t..done\nAdd a DCB"); + dcb = dcb_alloc(DCB_ROLE_SERVICE_LISTENER); + dcb->fd = socket(AF_UNIX, SOCK_STREAM, 0); + poll_add_dcb(dcb); + poll_remove_dcb(dcb); + poll_add_dcb(dcb); + ss_dfprintf(stderr, "\t..done\nStart wait for events."); + sleep(10); + poll_shutdown(); + ss_dfprintf(stderr, "\t..done\nTidy up."); + dcb_free(dcb); + ss_dfprintf(stderr, "\t..done\n"); + + return 0; + +} + +int main(int argc, char **argv) +{ +int result = 0; + + result += test1(); + + exit(result); +} + diff --git a/server/core/test/testserver.c b/server/core/test/testserver.c new file mode 100644 index 000000000..56a69e65d --- /dev/null +++ b/server/core/test/testserver.c @@ -0,0 +1,92 @@ +/* + * This file is distributed as part of MaxScale. It is free + * software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, + * version 2. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. + * + * You should have received a copy of the GNU General Public License along with + * this program; if not, write to the Free Software Foundation, Inc., 51 + * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Copyright SkySQL Ab 2014 + */ + +/** + * + * @verbatim + * Revision History + * + * Date Who Description + * 08-10-2014 Martin Brampton Initial implementation + * + * @endverbatim + */ + +#include +#include +#include + +#include + +/** + * test1 Allocate a server and do lots of other things + * + */ +static int +test1() +{ +SERVER *server; +int result; +char *status; + + /* Server tests */ + ss_dfprintf(stderr, + "testserver : creating server called MyServer"); + server = server_alloc("MyServer", "HTTPD", 9876); + + + //ss_info_dassert(NULL != service, "New server with valid protocol and port must not be null"); + //ss_info_dassert(0 != service_isvalid(service), "Service must be valid after creation"); + + ss_dfprintf(stderr, "\t..done\nTest Parameter for Server."); + ss_info_dassert(NULL == serverGetParameter(server, "name"), "Parameter should be null when not set"); + serverAddParameter(server, "name", "value"); + ss_info_dassert(0 == strcmp("value", serverGetParameter(server, "name")), "Parameter should be returned correctly"); + ss_dfprintf(stderr, "\t..done\nTesting Unique Name for Server."); + ss_info_dassert(NULL == server_find_by_unique_name("uniquename"), "Should not find non-existent unique name."); + server_set_unique_name(server, "uniquename"); + ss_info_dassert(server == server_find_by_unique_name("uniquename"), "Should find by unique name."); + ss_dfprintf(stderr, "\t..done\nTesting Status Setting for Server."); + status = server_status(server); + ss_info_dassert(0 == strcmp("Down", status), "Status of Server should be Down prior to being set."); + if (NULL != status) free(status); + server_set_status(server, SERVER_MASTER); + status = server_status(server); + ss_info_dassert(0 == strcmp("Master, Down", status), "Should find correct status."); + server_clear_status(server, SERVER_MASTER); + ss_info_dassert(0 == strcmp("Down", status), "Status of Server should be Down after status cleared."); + if (NULL != status) free(status); + ss_dfprintf(stderr, "\t..done\nRun Prints for Server and all Servers."); + printServer(server); + printAllServers(); + ss_dfprintf(stderr, "\t..done\nFreeing Server."); + ss_info_dassert(0 != server_free(server), "Free should succeed"); + ss_dfprintf(stderr, "\t..done\n"); + + return 0; + +} + +int main(int argc, char **argv) +{ +int result = 0; + + result += test1(); + + exit(result); +} diff --git a/server/core/test/testservice.c b/server/core/test/testservice.c new file mode 100644 index 000000000..2b12c8062 --- /dev/null +++ b/server/core/test/testservice.c @@ -0,0 +1,86 @@ +/* + * This file is distributed as part of MaxScale. It is free + * software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, + * version 2. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. + * + * You should have received a copy of the GNU General Public License along with + * this program; if not, write to the Free Software Foundation, Inc., 51 + * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Copyright SkySQL Ab 2014 + */ + +/** + * + * @verbatim + * Revision History + * + * Date Who Description + * 08-09-2014 Martin Brampton Initial implementation + * + * @endverbatim + */ + +#include +#include +#include + +#include + +/** + * test1 Allocate a service and do lots of other things + * + */ +static int +test1() +{ +SERVICE *service; +int result; + + /* Service tests */ + ss_dfprintf(stderr, + "testservice : creating service called MyService with router nonexistent"); + service = service_alloc("MyService", "non-existent"); + ss_info_dassert(NULL == service, "New service with invalid router should be null"); + ss_info_dassert(0 == service_isvalid(service), "Service must not be valid after incorrect creation"); + ss_dfprintf(stderr, "\t..done\nValid service creation, router testroute."); + service = service_alloc("MyService", "testroute"); + ss_info_dassert(NULL != service, "New service with valid router must not be null"); + ss_info_dassert(0 != service_isvalid(service), "Service must be valid after creation"); + ss_info_dassert(0 == strcmp("MyService", service_get_name(service)), "Service must have given name"); + ss_dfprintf(stderr, "\t..done\nAdding protocol HTTPD."); + ss_info_dassert(0 != serviceAddProtocol(service, "HTTPD", "localhost", 9876), "Add Protocol should succeed"); + ss_info_dassert(0 != serviceHasProtocol(service, "HTTPD", 9876), "Service should have new protocol as requested"); + serviceStartProtocol(service, "HTTPD", 9876); + ss_dfprintf(stderr, "\t..done\nStarting Service."); + result = serviceStart(service); + ss_info_dassert(0 != result, "Start should succeed"); + result = serviceStop(service); + ss_info_dassert(0 != result, "Stop should succeed"); + result = serviceStartAll(); + ss_info_dassert(0 != result, "Start all should succeed"); + + ss_dfprintf(stderr, "\t..done\nStopping Service."); + ss_info_dassert(0 != serviceStop(service), "Stop should succeed"); + ss_dfprintf(stderr, "\t..done\nFreeing Service."); + ss_info_dassert(0 != service_free(service), "Free should succeed"); + ss_dfprintf(stderr, "\t..done\n"); + + return 0; + +} + +int main(int argc, char **argv) +{ +int result = 0; + + result += test1(); + + exit(result); +} diff --git a/server/core/test/testspinlock.c b/server/core/test/testspinlock.c index f6ea810c8..14501cea5 100644 --- a/server/core/test/testspinlock.c +++ b/server/core/test/testspinlock.c @@ -105,12 +105,16 @@ test2() { SPINLOCK lck; void *handle; +struct timespec sleeptime; + + sleeptime.tv_sec = 10; + sleeptime.tv_nsec = 0; acquire_time = 0; spinlock_init(&lck); spinlock_acquire(&lck); handle = thread_start(test2_helper, (void *)&lck); - sleep(10); + nanosleep(&sleeptime, NULL); spinlock_release(&lck); thread_wait(handle); @@ -122,12 +126,118 @@ void *handle; return 0; } -main(int argc, char **argv) +/** + * test3 spinlock_acquire tests process bound threads + * + * Check that spinlock correctly blocks all other threads whilst the spinlock + * is held. + * + * Start multiple threads that obtain spinlock and run process bound + */ +#define THREADS 5 +#define ITERATIONS 50000 +#define PROCESS_LOOP 10000 +#define SECONDS 15 +#define NANOTIME 100000 + +static int times_run, failures; +static volatile int active; +static int threadrun[THREADS]; +static int nowait[THREADS]; +static SPINLOCK lck; +static void +test3_helper(void *data) +{ +// SPINLOCK *lck = (SPINLOCK *)data; +int i; +int n = *(int *)data; +struct timespec sleeptime; +time_t rawtime; + + sleeptime.tv_sec = 0; + sleeptime.tv_nsec = 1; + + while (1) { + if (spinlock_acquire_nowait(&lck)) { + nowait[n]++; + } + else { + spinlock_acquire(&lck); + } + if (times_run++ > ITERATIONS) { + break; + } + threadrun[n]++; + /* + if (99 == (times_run % 100)) { + time ( &rawtime ); + fprintf(stderr, "%s Done %d iterations of test, in thread %d.\n", asctime (localtime ( &rawtime )), times_run, n); + } + */ + if (0 != active) { + fprintf(stderr, "spinlock: test 3 failed with active non-zero after lock obtained.\n"); + failures++; + } + else { + active = 1; + for (i=0; i +#include +#include + +#include + +/** + * test1 Allocate table of users and mess around with it + * + */ + +static int +test1() +{ +USERS *users; +int result, count; + + /* Poll tests */ + ss_dfprintf(stderr, + "testusers : Initialise the user table."); + users = users_alloc(); + ss_info_dassert(NULL != users, "Allocating user table should not return NULL.") + ss_dfprintf(stderr, "\t..done\nAdd a user"); + count = users_add(users, "username", "authorisation"); + ss_info_dassert(1 == count, "Should add one user"); + ss_info_dassert(strcmp("authorisation", users_fetch(users, "username")), "User authorisation should be correct"); + ss_dfprintf(stderr, "\t..done\nPrint users"); + usersPrint(users); + ss_dfprintf(stderr, "\t..done\nUpdate a user"); + count = users_update(users, "username", "newauth"); + ss_info_dassert(1 == count, "Should update just one user"); + ss_info_dassert(strcmp("newauth", users_fetch(users, "username")), "User authorisation should be correctly updated"); + ss_dfprintf(stderr, "\t..done\nDelete a user."); + count = users_delete(users, "username"); + ss_info_dassert(1 == count, "Should delete just one user"); + ss_dfprintf(stderr, "\t..done\nFree user table."); + users_free(users); + ss_dfprintf(stderr, "\t..done\n"); + + return 0; + +} + +int main(int argc, char **argv) +{ +int result = 0; + + result += test1(); + + exit(result); +} + diff --git a/server/core/utils.c b/server/core/utils.c index 364d97bc6..71c7888ed 100644 --- a/server/core/utils.c +++ b/server/core/utils.c @@ -29,6 +29,7 @@ * the gwbuff strategy * 13-06-2013 Massimiliano Pinto MaxScale local authentication * basics + * 02-09-2014 Martin Brampton Replaced C++ comments by C comments * * @endverbatim */ @@ -44,19 +45,19 @@ extern int lm_enabled_logfiles_bitmask; -// used in the hex2bin function +/* used in the hex2bin function */ #define char_val(X) (X >= '0' && X <= '9' ? X-'0' :\ X >= 'A' && X <= 'Z' ? X-'A'+10 :\ X >= 'a' && X <= 'z' ? X-'a'+10 :\ '\177') -// used in the bin2hex function +/* used in the bin2hex function */ char hex_upper[] = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ"; char hex_lower[] = "0123456789abcdefghijklmnopqrstuvwxyz"; -////////////////////////////////////////// -//backend read event triggered by EPOLLIN -////////////////////////////////////////// +/***************************************** + * backend read event triggered by EPOLLIN +*****************************************/ int setnonblocking(int fd) { @@ -91,17 +92,17 @@ char *gw_strend(register const char *s) { return (char*) (s-1); } -/////////////////////////////// -// generate a random char -////////////////////////////// +/***************************************** +* generate a random char +*****************************************/ static char gw_randomchar() { return (char)((rand() % 78) + 30); } -///////////////////////////////// -// generate a random string -// output must be pre allocated -///////////////////////////////// +/***************************************** + * generate a random string + * output must be pre allocated +*****************************************/ int gw_generate_random_str(char *output, int len) { int i; @@ -116,10 +117,10 @@ int gw_generate_random_str(char *output, int len) { return 0; } -///////////////////////////////// -// hex string to binary data -// output must be pre allocated -///////////////////////////////// +/***************************************** + * hex string to binary data + * output must be pre allocated +*****************************************/ int gw_hex2bin(uint8_t *out, const char *in, unsigned int len) { const char *in_end= in + len; @@ -140,10 +141,10 @@ int gw_hex2bin(uint8_t *out, const char *in, unsigned int len) { return 0; } -///////////////////////////////// -// binary data to hex string -// output must be pre allocated -///////////////////////////////// +/***************************************** + * binary data to hex string + * output must be pre allocated +*****************************************/ char *gw_bin2hex(char *out, const uint8_t *in, unsigned int len) { const uint8_t *in_end= in + len; if (len == 0 || in == NULL) { @@ -159,12 +160,12 @@ char *gw_bin2hex(char *out, const uint8_t *in, unsigned int len) { return out; } -/////////////////////////////////////////////////////// -// fill a preallocated buffer with XOR(str1, str2) -// XOR between 2 equal len strings -// note that XOR(str1, XOR(str1 CONCAT str2)) == str2 -// and that XOR(str1, str2) == XOR(str2, str1) -/////////////////////////////////////////////////////// +/**************************************************** + * fill a preallocated buffer with XOR(str1, str2) + * XOR between 2 equal len strings + * note that XOR(str1, XOR(str1 CONCAT str2)) == str2 + * and that XOR(str1, str2) == XOR(str2, str1) +*****************************************************/ void gw_str_xor(uint8_t *output, const uint8_t *input1, const uint8_t *input2, unsigned int len) { const uint8_t *input1_end = NULL; input1_end = input1 + len; @@ -175,10 +176,10 @@ void gw_str_xor(uint8_t *output, const uint8_t *input1, const uint8_t *input2, u *output = '\0'; } -///////////////////////////////////////////////////////////// -// fill a 20 bytes preallocated with SHA1 digest (160 bits) -// for one input on in_len bytes -///////////////////////////////////////////////////////////// +/********************************************************** + * fill a 20 bytes preallocated with SHA1 digest (160 bits) + * for one input on in_len bytes +**********************************************************/ void gw_sha1_str(const uint8_t *in, int in_len, uint8_t *out) { unsigned char hash[SHA_DIGEST_LENGTH]; @@ -186,10 +187,10 @@ void gw_sha1_str(const uint8_t *in, int in_len, uint8_t *out) { memcpy(out, hash, SHA_DIGEST_LENGTH); } -///////////////////////////////////////////////////////////// -// fill 20 bytes preallocated with SHA1 digest (160 bits) -// for two inputs, in_len and in2_len bytes -///////////////////////////////////////////////////////////// +/******************************************************** + * fill 20 bytes preallocated with SHA1 digest (160 bits) + * for two inputs, in_len and in2_len bytes +********************************************************/ void gw_sha1_2_str(const uint8_t *in, int in_len, const uint8_t *in2, int in2_len, uint8_t *out) { SHA_CTX context; unsigned char hash[SHA_DIGEST_LENGTH]; diff --git a/server/include/buffer.h b/server/include/buffer.h index c8b9f1418..76eebe63d 100644 --- a/server/include/buffer.h +++ b/server/include/buffer.h @@ -40,6 +40,9 @@ * 16/07/2013 Massimiliano Pinto Added command type for the queue * 10/07/2014 Mark Riddoch Addition of hints * 15/07/2014 Mark Riddoch Added buffer properties + * 03/10/2014 Martin Brampton Pointer arithmetic standard conformity + * Add more buffer handling macros + * Add gwbuf_rtrim (handle chains) * * @endverbatim */ @@ -147,19 +150,25 @@ typedef struct gwbuf { /*< * Macros to access the data in the buffers */ -/*< First valid, uncomsumed byte in the buffer */ +/*< First valid, unconsumed byte in the buffer */ #define GWBUF_DATA(b) ((b)->start) /*< Number of bytes in the individual buffer */ -#define GWBUF_LENGTH(b) ((unsigned int)(((uint8_t*)(b)->end) - ((uint8_t*)(b)->start))) +#define GWBUF_LENGTH(b) ((char *)(b)->end - (char *)(b)->start) + +/*< Return the byte at offset byte from the start of the unconsumed portion of the buffer */ +#define GWBUF_DATA_CHAR(b, byte) (GWBUF_LENGTH(b) < ((byte)+1) ? -1 : *(((char *)(b)->start)+4)) + +/*< Check that the data in a buffer has the SQL marker*/ +#define GWBUF_IS_SQL(b) (0x03 == GWBUF_DATA_CHAR(b,4)) /*< True if all bytes in the buffer have been consumed */ -#define GWBUF_EMPTY(b) ((b)->start == (b)->end) +#define GWBUF_EMPTY(b) ((char *)(b)->start >= (char *)(b)->end) /*< Consume a number of bytes in the buffer */ -#define GWBUF_CONSUME(b, bytes) (b)->start = (void*)((uint8_t*)(b)->start + (bytes)) +#define GWBUF_CONSUME(b, bytes) ((b)->start = bytes > ((char *)(b)->end - (char *)(b)->start) ? (b)->end : (void *)((char *)(b)->start + (bytes))); -#define GWBUF_RTRIM(b, bytes) (b)->end = (void*)((uint8_t*)(b)->end - (bytes)) +#define GWBUF_RTRIM(b, bytes) ((b)->end = bytes > ((char *)(b)->end - (char *)(b)->start) ? (b)->start : (void *)((char *)(b)->end - (bytes))); #define GWBUF_TYPE(b) (b)->gwbuf_type /*< @@ -171,6 +180,7 @@ extern GWBUF *gwbuf_clone(GWBUF *buf); extern GWBUF *gwbuf_append(GWBUF *head, GWBUF *tail); extern GWBUF *gwbuf_consume(GWBUF *head, unsigned int length); extern GWBUF *gwbuf_trim(GWBUF *head, unsigned int length); +extern GWBUF *gwbuf_rtrim(GWBUF *head, unsigned int length); extern unsigned int gwbuf_length(GWBUF *head); extern GWBUF *gwbuf_clone_portion(GWBUF *head, size_t offset, size_t len); extern GWBUF *gwbuf_clone_transform(GWBUF *head, gwbuf_type_t type); diff --git a/server/include/service.h b/server/include/service.h index 28daeb1c6..659e422aa 100644 --- a/server/include/service.h +++ b/server/include/service.h @@ -142,7 +142,7 @@ typedef enum count_spec_t {COUNT_NONE=0, COUNT_ATLEAST, COUNT_EXACT, COUNT_ATMOS #define SERVICE_STATE_ALLOC 1 /**< The service has been allocated */ #define SERVICE_STATE_STARTED 2 /**< The service has been started */ -extern SERVICE *service_alloc(char *, char *); +extern SERVICE *service_alloc(const char *, const char *); extern int service_free(SERVICE *); extern SERVICE *service_find(char *); extern int service_isvalid(SERVICE *); diff --git a/server/modules/filter/CMakeLists.txt b/server/modules/filter/CMakeLists.txt index f9dea236d..6e70adaf3 100644 --- a/server/modules/filter/CMakeLists.txt +++ b/server/modules/filter/CMakeLists.txt @@ -24,4 +24,8 @@ add_library(topfilter SHARED topfilter.c) target_link_libraries(topfilter log_manager utils) install(TARGETS topfilter DESTINATION modules) -add_subdirectory(hint) \ No newline at end of file +add_subdirectory(hint) + +if(BUILD_TESTS) + add_subdirectory(test) +endif() \ No newline at end of file diff --git a/server/modules/filter/mqfilter.c b/server/modules/filter/mqfilter.c index e6a6c12b1..ed0096bbf 100644 --- a/server/modules/filter/mqfilter.c +++ b/server/modules/filter/mqfilter.c @@ -58,6 +58,7 @@ *@endverbatim * See the individual struct documentations for logging trigger parameters */ +#include #include #include #include diff --git a/server/modules/filter/test/CMakeLists.txt b/server/modules/filter/test/CMakeLists.txt new file mode 100644 index 000000000..1813a5a26 --- /dev/null +++ b/server/modules/filter/test/CMakeLists.txt @@ -0,0 +1,13 @@ +aux_source_directory(${CMAKE_SOURCE_DIR}/server/core CORE_ALL) +foreach(VAR ${CORE_ALL}) + if(NOT( (${VAR} MATCHES "max[a-z_]*.c") OR (${VAR} MATCHES "gateway.c"))) + list(APPEND CORE ${VAR}) + endif() +endforeach() + +include_directories(${CMAKE_CURRENT_SOURCE_DIR}) +add_executable(harness_ui harness_ui.c harness_common.c) +add_executable(harness harness_util.c harness_common.c ${CORE}) +target_link_libraries(harness_ui fullcore log_manager utils) +target_link_libraries(harness fullcore) +add_test(TestHintfilter /bin/sh -c "MAXSCALE_HOME=\"${CMAKE_BINARY_DIR}\" ${CMAKE_CURRENT_BINARY_DIR}/harness -i ${CMAKE_CURRENT_SOURCE_DIR}/hint_testing.input -o ${CMAKE_CURRENT_BINARY_DIR}/hint_testing.output -c ${CMAKE_CURRENT_SOURCE_DIR}/hint_testing.cnf -t 1 -s 1 && diff ${CMAKE_CURRENT_SOURCE_DIR}/hint_testing.expected ${CMAKE_CURRENT_BINARY_DIR}/hint_testing.output;exit $?") \ No newline at end of file diff --git a/server/modules/filter/test/Makefile b/server/modules/filter/test/Makefile new file mode 100755 index 000000000..5eb6561f7 --- /dev/null +++ b/server/modules/filter/test/Makefile @@ -0,0 +1,80 @@ +# This file is distributed as part of MaxScale form SkySQL. It is free +# software: you can redistribute it and/or modify it under the terms of the +# GNU General Public License as published by the Free Software Foundation, +# version 2. +# +# This program is distributed in the hope that it will be useful, but WITHOUT +# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more +# details. +# +# You should have received a copy of the GNU General Public License along with +# this program; if not, write to the Free Software Foundation, Inc., 51 +# Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. +# +# Copyright SkySQL Ab 2014 + +include ../../../../build_gateway.inc + +LOGPATH := $(ROOT_PATH)/log_manager +UTILSPATH := $(ROOT_PATH)/utils +QCLASSPATH := $(ROOT_PATH)/query_classifier +COREPATH := $(ROOT_PATH)/server/core + +CC=cc +CFLAGS=-c -fPIC -I/usr/include -I../../include -I../../../include \ + -I$(LOGPATH) -I$(UTILSPATH) -I./ -I$(ROOT_PATH)/server/inih -I$(QCLASSPATH) \ + $(MYSQL_HEADERS) -Wall -g + +include ../../../../makefile.inc + +LDFLAGS=-rdynamic -L$(LOGPATH) -L$(UTILSPATH) -L$(EMBEDDED_LIB) \ + -Wl,-rpath,$(DEST)/lib \ + -Wl,-rpath,$(LOGPATH) -Wl,-rpath,$(UTILSPATH) \ + -Wl,-rpath,$(EMBEDDED_LIB) + +SRCS=harness_util.c harness_common.c +OBJ=$(SRCS:.c=.o) +COREOBJ=$(COREPATH)/load_utils.o $(COREPATH)/dcb.o $(COREPATH)/utils.o \ + $(COREPATH)/gw_utils.o $(COREPATH)/buffer.o $(COREPATH)/poll.o \ + $(COREPATH)/spinlock.o $(COREPATH)/gwbitmask.o $(COREPATH)/session.o \ + $(COREPATH)/atomic.o $(COREPATH)/hashtable.o $(COREPATH)/filter.o $(COREPATH)/modutil.o $(ROOT_PATH)/server/inih/ini.o \ + $(COREPATH)/hint.o $(COREPATH)/config.o $(COREPATH)/service.o $(COREPATH)/server.o $(COREPATH)/monitor.o $(COREPATH)/housekeeper.o $(COREPATH)/adminusers.o $(COREPATH)/dbusers.o $(COREPATH)/thread.o $(COREPATH)/users.o $(COREPATH)/secrets.o +LIBS= $(UTILSPATH)/skygw_utils.o -lssl -pthread -llog_manager -lmysqld -ldl -lcrypto -lcrypt -lm +MODULES := $(wildcard ../*.so) + +all: build + +build:$(OBJ) + $(CC) $(OBJ) $(COREOBJ) $(LDFLAGS) $(LIBS) -o harness + $(MAKE) -C ../ + cp ../*.so ./ + +%.o: %.c + $(CC) $(CFLAGS) $< -o $@ + +clean: + rm -f *.o + rm -f *.so + rm -f harness +cleantests:clean + rm *.output +buildtests:build + +testall: + $(MAKE) cleantests + $(MAKE) buildtests + $(MAKE) runtests + +runtests: + @echo "" + @echo "-------------------------------" + @echo "$(shell date)" + @echo "Test Filter harness" + @echo "-------------------------------" + @echo "Testing hints... " + @./hint_tests.sh + @echo "" + +documentation: + doxygen doxygen.conf diff --git a/server/modules/filter/test/README b/server/modules/filter/test/README new file mode 100644 index 000000000..ee8f81edd --- /dev/null +++ b/server/modules/filter/test/README @@ -0,0 +1,20 @@ +Filter Test Harness + +For a more detailed description of the filter harness, either generate the documentation or read the harness.h file. + +Running the program without arguments enters the interactive mode. Type 'help' for a list of all commands. + +The default values for threads and sessions are stored in the 'harness.cnf' file + +Mandatory parameters for the command line mode are -c and -i. + +Parameters for the command line: + + -h Display this information + -c Path to the MaxScale configuration file to parse for filters + -i Name of the input file for buffers + -o Name of the output file for results + -q Suppress printing to stdout + -t Number of threads + -s Number of sessions + -d Routing delay diff --git a/server/modules/filter/test/doxygen.conf b/server/modules/filter/test/doxygen.conf new file mode 100644 index 000000000..a3c6eae77 --- /dev/null +++ b/server/modules/filter/test/doxygen.conf @@ -0,0 +1,2303 @@ +# Doxyfile 1.8.6 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "Filter Harness" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = 1.1 + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "Test harness for independent testing of filters" + +# With the PROJECT_LOGO tag one can specify an logo or icon that is included in +# the documentation. The maximum height of the logo should not exceed 55 pixels +# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo +# to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = doc/ + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a +# new page for each member. If set to NO, the documentation of a member will be +# part of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make +# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C +# (default is Fortran), use: inc=Fortran f=C. +# +# Note For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by by putting a % sign in front of the word +# or globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO these classes will be included in the various overviews. This option has +# no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the +# todo list. This list is created by putting \todo commands in the +# documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the +# test list. This list is created by putting \test commands in the +# documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES the list +# will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. Do not use file names with spaces, bibtex cannot handle them. See +# also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO doxygen will only warn about wrong or incomplete parameter +# documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. +# Note: If this tag is empty the current directory is searched. + +INPUT = + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank the +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, +# *.qsf, *.as and *.js. + +FILE_PATTERNS = + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER ) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES, then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- +# defined cascading style sheet that is included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefor more robust against future updates. +# Doxygen will copy the style sheet file to the output directory. For an example +# see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the stylesheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler ( hhc.exe). If non-empty +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated ( +# YES) or that it should be included in the master .chm file ( NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated ( +# YES) or a normal table of contents ( NO) in the .chm file. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using prerendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /