hcq/MaxScale
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Cleanup server.h

Browse Source 
- All (but the printing/debug functions) are now in snake_case.
- Functions made const correct.
- All function prototypes now have named arguments.

Documentation still to be moved, and file possibly split into
include/mascale/server.h and server/core/maxscale/server.h
This commit is contained in:
Johan Wikman
2017-01-09 11:19:09 +02:00
parent 1b8742781b
commit c3ddc3ac22
7 changed files with 52 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files

73
include/maxscale/server.h
View File

@ -13,32 +13,9 @@
*/ */
/** /**
* @file service.h * @file server.h
* *
* The server level definitions within the gateway * The server level definitions within the gateway
*
* @verbatim
* Revision History
*
* Date Who Description
* 14/06/13 Mark Riddoch Initial implementation
* 21/06/13 Mark Riddoch Addition of server status flags
* 22/07/13 Mark Riddoch Addition of JOINED status for Galera
* 18/05/14 Mark Riddoch Addition of unique_name field
* 20/05/14 Massimiliano Pinto Addition of server_string field
* 20/05/14 Massimiliano Pinto Addition of node_id field
* 23/05/14 Massimiliano Pinto Addition of rlag and node_ts fields
* 03/06/14 Mark Riddoch Addition of maintainance mode
* 20/06/14 Massimiliano Pinto Addition of master_id, depth, slaves fields
* 26/06/14 Mark Riddoch Adidtion of server parameters
* 30/07/14 Massimiliano Pinto Addition of NDB status for MySQL Cluster
* 30/08/14 Massimiliano Pinto Addition of SERVER_STALE_STATUS
* 27/10/14 Massimiliano Pinto Addition of SERVER_MASTER_STICKINESS
* 19/02/15 Mark Riddoch Addition of serverGetList
* 01/06/15 Massimiliano Pinto Addition of server_update_address/port
* 19/06/15 Martin Brampton Extra fields for persistent connections, CHK_SERVER
*
* @endverbatim
*/ */
#include <maxscale/cdefs.h> #include <maxscale/cdefs.h>
@ -54,7 +31,6 @@ MXS_BEGIN_DECLS
/** /**
* The server parameters used for weighting routing decissions * The server parameters used for weighting routing decissions
*
*/ */
typedef struct server_params typedef struct server_params
{ {
@ -66,7 +42,6 @@ typedef struct server_params
/** /**
* The server statistics structure * The server statistics structure
*
*/ */
typedef struct typedef struct
{ {
@ -262,7 +237,7 @@ bool server_serialize(const SERVER *server);
* @param name Parameter name * @param name Parameter name
* @param value Parameter value * @param value Parameter value
*/ */
void serverAddParameter(SERVER *server, const char *name, const char *value); void server_add_parameter(SERVER *server, const char *name, const char *value);
/** /**
* @brief Remove a server parameter * @brief Remove a server parameter
@ -271,34 +246,34 @@ void serverAddParameter(SERVER *server, const char *name, const char *value);
* @param name The name of the parameter to remove * @param name The name of the parameter to remove
* @return True if a parameter was removed * @return True if a parameter was removed
*/ */
bool serverRemoveParameter(SERVER *server, const char *name); bool server_remove_parameter(SERVER *server, const char *name);
extern int server_free(SERVER *); extern int server_free(SERVER *server);
extern SERVER *server_find_by_unique_name(const char *name); extern SERVER *server_find_by_unique_name(const char *name);
extern SERVER *server_find(char *, unsigned short); extern SERVER *server_find(const char *servname, unsigned short port);
extern void printServer(SERVER *); extern char *server_status(const SERVER *);
extern void server_clear_set_status(SERVER *server, int specified_bits, int bits_to_set);
extern void server_set_status_nolock(SERVER *server, int bit);
extern void server_clear_status_nolock(SERVER *server, int bit);
extern void server_transfer_status(SERVER *dest_server, const SERVER *source_server);
extern void server_add_mon_user(SERVER *server, const char *user, const char *passwd);
extern const char *server_get_parameter(const SERVER *server, char *name);
extern void server_update_credentials(SERVER *server, const char *user, const char *passwd);
extern DCB *server_get_persistent(SERVER *server, const char *user, const char *protocol, int id);
extern void server_update_address(SERVER *server, const char *address);
extern void server_update_port(SERVER *server, unsigned short port);
extern unsigned int server_map_status(const char *str);
extern bool server_set_version_string(SERVER* server, const char* string);
extern void server_set_status(SERVER *server, int bit);
extern void server_clear_status(SERVER *server, int bit);
extern void printServer(const SERVER *);
extern void printAllServers(); extern void printAllServers();
extern void dprintAllServers(DCB *); extern void dprintAllServers(DCB *);
extern void dprintAllServersJson(DCB *); extern void dprintAllServersJson(DCB *);
extern void dprintServer(DCB *, SERVER *); extern void dprintServer(DCB *, const SERVER *);
extern void dprintPersistentDCBs(DCB *, SERVER *); extern void dprintPersistentDCBs(DCB *, const SERVER *);
extern void dListServers(DCB *); extern void dListServers(DCB *);
extern char *server_status(SERVER *);
extern void server_clear_set_status(SERVER *server, int specified_bits, int bits_to_set);
extern void server_set_status_nolock(SERVER *, int);
extern void server_clear_status_nolock(SERVER *, int);
extern void server_transfer_status(SERVER *dest_server, SERVER *source_server);
extern void serverAddMonUser(SERVER *, char *, char *);
extern char *serverGetParameter(SERVER *, char *);
extern void server_update_credentials(SERVER *, char *, char *);
extern DCB *server_get_persistent(SERVER *, const char *, const char *, int);
extern void server_update_address(SERVER *, char *);
extern void server_update_port(SERVER *, unsigned short);
extern RESULTSET *serverGetList(); extern RESULTSET *serverGetList();
extern unsigned int server_map_status(char *str);
extern bool server_set_version_string(SERVER* server, const char* string);
extern void server_set_status(SERVER *, int);
extern void server_clear_status(SERVER *, int);
MXS_END_DECLS MXS_END_DECLS

4
server/core/config.c
View File

@ -2602,7 +2602,7 @@ int create_new_server(CONFIG_CONTEXT *obj)
if (monuser && monpw) if (monuser && monpw)
{ {
serverAddMonUser(server, monuser, monpw); server_add_mon_user(server, monuser, monpw);
} }
else if (monuser && monpw == NULL) else if (monuser && monpw == NULL)
{ {
@ -2656,7 +2656,7 @@ int create_new_server(CONFIG_CONTEXT *obj)
{ {
if (!is_normal_server_parameter(params->name)) if (!is_normal_server_parameter(params->name))
{ {
serverAddParameter(obj->element, params->name, params->value); server_add_parameter(obj->element, params->name, params->value);
} }
params = params->next; params = params->next;
} }

4
server/core/config_runtime.c
View File

@ -286,13 +286,13 @@ bool runtime_alter_server(SERVER *server, char *key, char *value)
} }
else else
{ {
if (!serverRemoveParameter(server, key) && !value[0]) if (!server_remove_parameter(server, key) && !value[0])
{ {
valid = false; valid = false;
} }
else if (value[0]) else if (value[0])
{ {
serverAddParameter(server, key, value); server_add_parameter(server, key, value);
/** /**
* It's likely that this parameter is used as a weighting parameter. * It's likely that this parameter is used as a weighting parameter.

32
server/core/server.c
View File

@ -303,7 +303,7 @@ SERVER * server_find_by_unique_name(const char *name)
* @return The server or NULL if not found * @return The server or NULL if not found
*/ */
SERVER * SERVER *
server_find(char *servname, unsigned short port) server_find(const char *servname, unsigned short port)
{ {
spinlock_acquire(&server_spin); spinlock_acquire(&server_spin);
SERVER *server = next_active_server(allServers); SERVER *server = next_active_server(allServers);
@ -328,7 +328,7 @@ server_find(char *servname, unsigned short port)
* @param server Server to print * @param server Server to print
*/ */
void void
printServer(SERVER *server) printServer(const SERVER *server)
{ {
printf("Server %p\n", server); printf("Server %p\n", server);
printf("\tServer: %s\n", server->name); printf("\tServer: %s\n", server->name);
@ -487,7 +487,7 @@ dprintAllServersJson(DCB *dcb)
* to display all active servers within the gateway * to display all active servers within the gateway
*/ */
void void
dprintServer(DCB *dcb, SERVER *server) dprintServer(DCB *dcb, const SERVER *server)
{ {
if (!SERVER_IS_ACTIVE(server)) if (!SERVER_IS_ACTIVE(server))
{ {
@ -559,7 +559,7 @@ dprintServer(DCB *dcb, SERVER *server)
if (server->persistpoolmax) if (server->persistpoolmax)
{ {
dcb_printf(dcb, "\tPersistent pool size: %d\n", server->stats.n_persistent); dcb_printf(dcb, "\tPersistent pool size: %d\n", server->stats.n_persistent);
poll_send_message(POLL_MSG_CLEAN_PERSISTENT, server); poll_send_message(POLL_MSG_CLEAN_PERSISTENT, (void*)server);
dcb_printf(dcb, "\tPersistent measured pool size: %d\n", server->stats.n_persistent); dcb_printf(dcb, "\tPersistent measured pool size: %d\n", server->stats.n_persistent);
dcb_printf(dcb, "\tPersistent actual size max: %d\n", server->persistmax); dcb_printf(dcb, "\tPersistent actual size max: %d\n", server->persistmax);
dcb_printf(dcb, "\tPersistent pool size limit: %ld\n", server->persistpoolmax); dcb_printf(dcb, "\tPersistent pool size limit: %ld\n", server->persistpoolmax);
@ -602,7 +602,7 @@ spin_reporter(void *dcb, char *desc, int value)
* @param server SERVER for which DCBs are to be printed * @param server SERVER for which DCBs are to be printed
*/ */
void void
dprintPersistentDCBs(DCB *pdcb, SERVER *server) dprintPersistentDCBs(DCB *pdcb, const SERVER *server)
{ {
DCB *dcb; DCB *dcb;
int nthr = config_threadcount(); int nthr = config_threadcount();
@ -669,7 +669,7 @@ dListServers(DCB *dcb)
* @return A string representation of the status flags * @return A string representation of the status flags
*/ */
char * char *
server_status(SERVER *server) server_status(const SERVER *server)
{ {
char *status = NULL; char *status = NULL;
@ -794,7 +794,7 @@ server_clear_status_nolock(SERVER *server, int bit)
* @param source_server The server to provide the new bit string * @param source_server The server to provide the new bit string
*/ */
void void
server_transfer_status(SERVER *dest_server, SERVER *source_server) server_transfer_status(SERVER *dest_server, const SERVER *source_server)
{ {
dest_server->status = source_server->status; dest_server->status = source_server->status;
} }
@ -808,7 +808,7 @@ server_transfer_status(SERVER *dest_server, SERVER *source_server)
* @param passwd The password of the user * @param passwd The password of the user
*/ */
void void
serverAddMonUser(SERVER *server, char *user, char *passwd) server_add_mon_user(SERVER *server, const char *user, const char *passwd)
{ {
if (user != server->monuser && if (user != server->monuser &&
snprintf(server->monuser, sizeof(server->monuser), "%s", user) > sizeof(server->monuser)) snprintf(server->monuser, sizeof(server->monuser), "%s", user) > sizeof(server->monuser))
@ -839,11 +839,11 @@ serverAddMonUser(SERVER *server, char *user, char *passwd)
* @param passwd The password to use for the monitor user * @param passwd The password to use for the monitor user
*/ */
void void
server_update_credentials(SERVER *server, char *user, char *passwd) server_update_credentials(SERVER *server, const char *user, const char *passwd)
{ {
if (user != NULL && passwd != NULL) if (user != NULL && passwd != NULL)
{ {
serverAddMonUser(server, user, passwd); server_add_mon_user(server, user, passwd);
} }
} }
@ -858,7 +858,7 @@ server_update_credentials(SERVER *server, char *user, char *passwd)
* @param name The parameter name * @param name The parameter name
* @param value The parameter value * @param value The parameter value
*/ */
void serverAddParameter(SERVER *server, const char *name, const char *value) void server_add_parameter(SERVER *server, const char *name, const char *value)
{ {
char *my_name = MXS_STRDUP(name); char *my_name = MXS_STRDUP(name);
char *my_value = MXS_STRDUP(value); char *my_value = MXS_STRDUP(value);
@ -883,7 +883,7 @@ void serverAddParameter(SERVER *server, const char *name, const char *value)
spinlock_release(&server->lock); spinlock_release(&server->lock);
} }
bool serverRemoveParameter(SERVER *server, const char *name) bool server_remove_parameter(SERVER *server, const char *name)
{ {
bool rval = false; bool rval = false;
spinlock_acquire(&server->lock); spinlock_acquire(&server->lock);
@ -927,8 +927,8 @@ static void server_parameter_free(SERVER_PARAM *tofree)
* @param name The name of the parameter we require * @param name The name of the parameter we require
* @return The parameter value or NULL if not found * @return The parameter value or NULL if not found
*/ */
char * const char *
serverGetParameter(SERVER *server, char *name) server_get_parameter(const SERVER *server, char *name)
{ {
SERVER_PARAM *param = server->parameters; SERVER_PARAM *param = server->parameters;
@ -1028,7 +1028,7 @@ serverGetList()
* *
*/ */
void void
server_update_address(SERVER *server, char *address) server_update_address(SERVER *server, const char *address)
{ {
spinlock_acquire(&server_spin); spinlock_acquire(&server_spin);
if (server && address) if (server && address)
@ -1080,7 +1080,7 @@ static struct
* @return bit value or 0 on error * @return bit value or 0 on error
*/ */
unsigned int unsigned int
server_map_status(char *str) server_map_status(const char *str)
{ {
int i; int i;

4
server/core/service.c
View File

@ -2100,7 +2100,7 @@ static void service_calculate_weights(SERVICE *service)
for (SERVER_REF *server = service->dbref; server; server = server->next) for (SERVER_REF *server = service->dbref; server; server = server->next)
{ {
server->weight = SERVICE_BASE_SERVER_WEIGHT; server->weight = SERVICE_BASE_SERVER_WEIGHT;
char *param = serverGetParameter(server->server, weightby); const char *param = server_get_parameter(server->server, weightby);
if (param) if (param)
{ {
total += atoi(param); total += atoi(param);
@ -2124,7 +2124,7 @@ static void service_calculate_weights(SERVICE *service)
/** Calculate the relative weight of the servers */ /** Calculate the relative weight of the servers */
for (SERVER_REF *server = service->dbref; server; server = server->next) for (SERVER_REF *server = service->dbref; server; server = server->next)
{ {
char *param = serverGetParameter(server->server, weightby); const char *param = server_get_parameter(server->server, weightby);
if (param) if (param)
{ {
int wght = atoi(param); int wght = atoi(param);

6
server/core/test/testserver.c
View File

@ -64,10 +64,10 @@ test1()
//ss_info_dassert(0 != service_isvalid(service), "Service must be valid after creation"); //ss_info_dassert(0 != service_isvalid(service), "Service must be valid after creation");
ss_dfprintf(stderr, "\t..done\nTest Parameter for Server."); ss_dfprintf(stderr, "\t..done\nTest Parameter for Server.");
ss_info_dassert(NULL == serverGetParameter(server, "name"), "Parameter should be null when not set"); ss_info_dassert(NULL == server_get_parameter(server, "name"), "Parameter should be null when not set");
serverAddParameter(server, "name", "value"); server_add_parameter(server, "name", "value");
mxs_log_flush_sync(); mxs_log_flush_sync();
ss_info_dassert(0 == strcmp("value", serverGetParameter(server, "name")), ss_info_dassert(0 == strcmp("value", server_get_parameter(server, "name")),
"Parameter should be returned correctly"); "Parameter should be returned correctly");
ss_dfprintf(stderr, "\t..done\nTesting Unique Name for Server."); ss_dfprintf(stderr, "\t..done\nTesting Unique Name for Server.");
ss_info_dassert(NULL == server_find_by_unique_name("non-existent"), ss_info_dassert(NULL == server_find_by_unique_name("non-existent"),

6
server/modules/monitor/galeramon/galeramon.c
View File

@ -595,7 +595,7 @@ static MONITOR_SERVERS *get_candidate_master(MONITOR* mon)
long min_id = -1; long min_id = -1;
int minval = INT_MAX; int minval = INT_MAX;
int currval; int currval;
char* value; const char* value;
/* set min_id to the lowest value of moitor_servers->server->node_id */ /* set min_id to the lowest value of moitor_servers->server->node_id */
while (moitor_servers) while (moitor_servers)
{ {
@ -604,7 +604,7 @@ static MONITOR_SERVERS *get_candidate_master(MONITOR* mon)
moitor_servers->server->depth = 0; moitor_servers->server->depth = 0;
if (handle->use_priority && (value = serverGetParameter(moitor_servers->server, "priority")) != NULL) if (handle->use_priority && (value = server_get_parameter(moitor_servers->server, "priority")) != NULL)
{ {
/** The server has a priority */ /** The server has a priority */
if ((currval = atoi(value)) > 0) if ((currval = atoi(value)) > 0)
@ -620,7 +620,7 @@ static MONITOR_SERVERS *get_candidate_master(MONITOR* mon)
else if (moitor_servers->server->node_id >= 0 && else if (moitor_servers->server->node_id >= 0 &&
(!handle->use_priority || /** Server priority disabled*/ (!handle->use_priority || /** Server priority disabled*/
candidate_master == NULL || /** No candidate chosen */ candidate_master == NULL || /** No candidate chosen */
serverGetParameter(candidate_master->server, "priority") == NULL)) /** Candidate has no priority */ server_get_parameter(candidate_master->server, "priority") == NULL)) /** Candidate has no priority */
{ {
if (min_id < 0 || moitor_servers->server->node_id < min_id) if (min_id < 0 || moitor_servers->server->node_id < min_id)
{ {