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

MXS-2205 Combine maxscale/server.h with maxscale/server.hh

Browse Source 
The server-struct is still used in several .h-files.
This commit is contained in:
Esa Korhonen 2018-12-03 16:38:28 +02:00
parent 756593a718
commit d9ae298102
29 changed files with 526 additions and 551 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

522
include/maxscale/server.h
View File

@ -1,522 +0,0 @@
/*
* Copyright (c) 2018 MariaDB Corporation Ab
*
* Use of this software is governed by the Business Source License included
* in the LICENSE.TXT file and at www.mariadb.com/bsl11.
*
* Change Date: 2022-01-01
*
* On the date above, in accordance with the Business Source License, use
* of this software will be governed by version 2 or later of the General
* Public License.
*/
#pragma once
/**
* @file server.h
*
* The server level definitions within the gateway
*/
#include <maxscale/cdefs.h>
#include <maxbase/jansson.h>
#include <maxscale/config.hh>
#include <maxscale/dcb.h>
#define MAX_SERVER_ADDRESS_LEN 1024
#define MAX_SERVER_MONUSER_LEN 1024
#define MAX_SERVER_MONPW_LEN 1024
#define MAX_SERVER_VERSION_LEN 256
#define MAX_NUM_SLAVES 128 /**< Maximum number of slaves under a single server*/
/**
* Server configuration parameters names
*/
extern const char CN_MONITORPW[];
extern const char CN_MONITORUSER[];
extern const char CN_PERSISTMAXTIME[];
extern const char CN_PERSISTPOOLMAX[];
extern const char CN_PROXY_PROTOCOL[];
/**
* Maintenance mode request constants.
*/
const int MAINTENANCE_OFF = -100;
const int MAINTENANCE_NO_CHANGE = 0;
const int MAINTENANCE_ON = 100;
const int MAINTENANCE_FLAG_NOCHECK = 0;
const int MAINTENANCE_FLAG_CHECK = -1;
// Default replication lag value
const int MXS_RLAG_UNDEFINED = -1;
/**
* The server parameters used for weighting routing decissions
*/
typedef struct server_params
{
char* name; /**< Parameter name */
char* value; /**< Parameter value */
bool active; /**< Whether the parameter is valid */
struct server_params* next; /**< Next Paramter in the linked list */
} SERVER_PARAM;
/**
* The server statistics structure
*/
typedef struct
{
int n_connections; /**< Number of connections */
int n_current; /**< Current connections */
int n_current_ops; /**< Current active operations */
int n_persistent; /**< Current persistent pool */
uint64_t n_new_conn; /**< Times the current pool was empty */
uint64_t n_from_pool; /**< Times when a connection was available from the pool */
uint64_t packets; /**< Number of packets routed to this server */
} SERVER_STATS;
/**
* The server version.
*/
typedef struct server_version
{
uint32_t major;
uint32_t minor;
uint32_t patch;
} SERVER_VERSION;
typedef enum
{
SERVER_TYPE_MARIADB,
SERVER_TYPE_MYSQL
} server_type_t;
static inline void server_decode_version(uint64_t version, SERVER_VERSION* server_version)
{
uint32_t major = version / 10000;
uint32_t minor = (version - major * 10000) / 100;
uint32_t patch = version - major * 10000 - minor * 100;
server_version->major = major;
server_version->minor = minor;
server_version->patch = patch;
}
static uint64_t server_encode_version(const SERVER_VERSION* server_version)
{
return server_version->major * 10000 + server_version->minor * 100 + server_version->patch;
}
/**
* The SERVER structure defines a backend server. Each server has a name
* or IP address for the server, a port that the server listens on and
* the name of a protocol module that is loaded to implement the protocol
* between the gateway and the server.
*/
typedef struct server
{
// Base settings
char* name; /**< Server config name */
char address[MAX_SERVER_ADDRESS_LEN]; /**< Server hostname/IP-address */
unsigned short port; /**< Server port */
unsigned short extra_port; /**< Server extra_port */
char* protocol; /**< Backend protocol module name */
char* authenticator; /**< Authenticator module name */
// Other settings
char monuser[MAX_SERVER_MONUSER_LEN]; /**< Monitor username, overrides monitor setting */
char monpw[MAX_SERVER_MONPW_LEN]; /**< Monitor password, overrides monitor setting */
long persistpoolmax; /**< Maximum size of persistent connections pool */
long persistmaxtime; /**< Maximum number of seconds connection can live */
bool proxy_protocol; /**< Send proxy-protocol header to backends when connecting
* routing sessions. */
SERVER_PARAM* parameters; /**< Additional custom parameters which may affect routing
* decisions. */
// Base variables
bool is_active; /**< Server is active and has not been "destroyed" */
void* auth_instance; /**< Authenticator instance data */
SSL_LISTENER* server_ssl; /**< SSL data */
DCB** persistent; /**< List of unused persistent connections to the server */
uint8_t charset; /**< Server character set. Read from backend and sent to client. */
// Statistics and events
SERVER_STATS stats; /**< The server statistics, e.g. number of connections */
int persistmax; /**< Maximum pool size actually achieved since startup */
int last_event; /**< The last event that occurred on this server */
int64_t triggered_at; /**< Time when the last event was triggered */
// Status descriptors. Updated automatically by a monitor or manually by the admin
uint64_t status; /**< Current status flag bitmap */
int maint_request; /**< Is admin requesting Maintenance=ON/OFF on the
* server? */
char version_string[MAX_SERVER_VERSION_LEN]; /**< Server version string as given by backend */
uint64_t version; /**< Server version numeric representation */
server_type_t server_type; /**< Server type (MariaDB or MySQL), deduced from
* version string */
long node_id; /**< Node id, server_id for M/S or local_index for
* Galera */
int rlag; /**< Replication Lag for Master/Slave replication
* */
unsigned long node_ts; /**< Last timestamp set from M/S monitor module */
long master_id; /**< Master server id of this node */
// Misc fields
bool master_err_is_logged; /**< If node failed, this indicates whether it is logged. Only
* used
* by rwsplit. TODO: Move to rwsplit */
bool warn_ssl_not_enabled;/**< SSL not used for an SSL enabled server */
MxsDiskSpaceThreshold* disk_space_threshold;/**< Disk space thresholds */
} SERVER;
/**
* Status bits in the SERVER->status member, which describes the general state of a server. Although the
* individual bits are independent, not all combinations make sense or are used. The bitfield is 64bits wide.
*/
// Bits used by most monitors
#define SERVER_RUNNING (1 << 0) /**<< The server is up and running */
#define SERVER_MAINT (1 << 1) /**<< Server is in maintenance mode */
#define SERVER_AUTH_ERROR (1 << 2) /**<< Authentication error from monitor */
#define SERVER_MASTER (1 << 3) /**<< The server is a master, i.e. can handle writes */
#define SERVER_SLAVE (1 << 4) /**<< The server is a slave, i.e. can handle reads */
// Bits used by MariaDB Monitor (mostly)
#define SERVER_SLAVE_OF_EXT_MASTER (1 << 5) /**<< Server is slave of a non-monitored master */
#define SERVER_RELAY (1 << 6) /**<< Server is a relay */
#define SERVER_WAS_MASTER (1 << 7) /**<< Server was a master but lost all slaves. */
// Bits used by other monitors
#define SERVER_JOINED (1 << 8) /**<< The server is joined in a Galera cluster */
#define SERVER_NDB (1 << 9) /**<< The server is part of a MySQL cluster setup */
#define SERVER_MASTER_STICKINESS (1 << 10) /**<< Server Master stickiness */
// Bits providing general information
#define SERVER_DISK_SPACE_EXHAUSTED (1 << 31) /**<< The disk space of the server is exhausted */
#define STRSRVSTATUS(s) \
(server_is_master(s) ? "RUNNING MASTER" \
: (server_is_slave(s) ? "RUNNING SLAVE" \
: (server_is_joined(s) ? "RUNNING JOINED" \
: (server_is_ndb(s) \
? "RUNNING NDB" \
: (( \
server_is_running(s) \
&& \
server_is_in_maint(s)) \
? \
"RUNNING MAINTENANCE" \
: ( \
server_is_relay(s) \
? \
"RUNNING RELAY" \
: ( \
server_is_usable(s) \
? \
"RUNNING (only)" \
: ( \
server_is_down(s) \
? \
"DOWN" \
: \
"UNKNOWN STATUS"))))))))
/**
* Is the server valid and active?
*
* @param server The server
* @return True, if server has not been removed from the runtime configuration.
*/
inline bool server_is_active(const SERVER* server)
{
return server->is_active;
}
inline bool status_is_usable(uint64_t status)
{
return (status & (SERVER_RUNNING | SERVER_MAINT)) == SERVER_RUNNING;
}
/**
* Is the server running and not in maintenance?
*
* @param server The server
* @return True, if server can be used.
*/
inline bool server_is_usable(const SERVER* server)
{
return status_is_usable(server->status);
}
inline bool status_is_running(uint64_t status)
{
return status & SERVER_RUNNING;
}
/**
* Is the server running?
*
* @param server The server
* @return True, if monitor can connect to the server.
*/
inline bool server_is_running(const SERVER* server)
{
return status_is_running(server->status);
}
inline bool status_is_down(uint64_t status)
{
return (status & SERVER_RUNNING) == 0;
}
/**
* Is the server down?
*
* @param server The server
* @return True, if monitor cannot connect to the server.
*/
inline bool server_is_down(const SERVER* server)
{
return status_is_down(server->status);
}
inline bool status_is_in_maint(uint64_t status)
{
return status & SERVER_MAINT;
}
/**
* Is the server in maintenance mode?
*
* @param server The server
* @return True, if server is in maintenance.
*/
inline bool server_is_in_maint(const SERVER* server)
{
return status_is_in_maint(server->status);
}
inline bool status_is_master(uint64_t status)
{
return (status & (SERVER_RUNNING | SERVER_MASTER | SERVER_MAINT)) == (SERVER_RUNNING | SERVER_MASTER);
}
/**
* Is the server a master?
*
* @param server The server
* @return True, if server is running and marked as master.
*/
inline bool server_is_master(const SERVER* server)
{
return status_is_master(server->status);
}
inline bool status_is_slave(uint64_t status)
{
return (status & (SERVER_RUNNING | SERVER_SLAVE | SERVER_MAINT)) == (SERVER_RUNNING | SERVER_SLAVE);
}
/**
* Is the server a slave.
*
* @param server The server
* @return True if server is running and marked as slave.
*/
inline bool server_is_slave(const SERVER* server)
{
return status_is_slave(server->status);
}
inline bool status_is_relay(uint64_t status)
{
return (status & (SERVER_RUNNING | SERVER_RELAY | SERVER_MAINT)) \
== (SERVER_RUNNING | SERVER_RELAY);
}
inline bool server_is_relay(const SERVER* server)
{
return status_is_relay(server->status);
}
inline bool status_is_joined(uint64_t status)
{
return (status & (SERVER_RUNNING | SERVER_JOINED | SERVER_MAINT))
== (SERVER_RUNNING | SERVER_JOINED);
}
/**
* Is the server joined Galera node? The server must be running and joined.
*/
inline bool server_is_joined(const SERVER* server)
{
return status_is_joined(server->status);
}
inline bool status_is_ndb(uint64_t status)
{
return (status & (SERVER_RUNNING | SERVER_NDB | SERVER_MAINT)) == (SERVER_RUNNING | SERVER_NDB);
}
/**
* Is the server a SQL node in MySQL Cluster? The server must be running and with NDB status
*/
inline bool server_is_ndb(const SERVER* server)
{
return status_is_ndb(server->status);
}
inline bool server_is_in_cluster(const SERVER* server)
{
return (server->status
& (SERVER_MASTER | SERVER_SLAVE | SERVER_RELAY | SERVER_JOINED | SERVER_NDB)) != 0;
}
inline bool status_is_slave_of_ext_master(uint64_t status)
{
return (status & (SERVER_RUNNING | SERVER_SLAVE_OF_EXT_MASTER))
== (SERVER_RUNNING | SERVER_SLAVE_OF_EXT_MASTER);
}
inline bool server_is_slave_of_ext_master(const SERVER* server)
{
return status_is_slave_of_ext_master(server->status);
}
inline bool status_is_disk_space_exhausted(uint64_t status)
{
return status & SERVER_DISK_SPACE_EXHAUSTED;
}
inline bool server_is_disk_space_exhausted(const SERVER* server)
{
return status_is_disk_space_exhausted(server->status);
}
/**
* @brief Allocate a new server
*
* This will create a new server that represents a backend server that services
* can use. This function will add the server to the running configuration but
* will not persist the changes.
*
* @param name Unique server name
* @param params Parameters for the server
*
* @return The newly created server or NULL if an error occurred
*/
extern SERVER* server_alloc(const char* name, MXS_CONFIG_PARAMETER* params);
/**
* @brief Serialize a server to a file
*
* This converts @c server into an INI format file. This allows created servers
* to be persisted to disk. This will replace any existing files with the same
* name.
*
* @param server Server to serialize
* @return False if the serialization of the server fails, true if it was successful
*/
bool server_serialize(const SERVER* server);
/**
* @brief Add a server parameter
*
* @param server Server where the parameter is added
* @param name Parameter name
* @param value Parameter value
*/
void server_add_parameter(SERVER* server, const char* name, const char* value);
/**
* @brief Remove a server parameter
*
* @param server Server to remove the parameter from
* @param name The name of the parameter to remove
* @return True if a parameter was removed
*/
bool server_remove_parameter(SERVER* server, const char* name);
/**
* @brief Set server parameter
*
* @param server Server to update
* @param name Parameter to set
* @param value Value of parameter
*/
void server_set_parameter(SERVER* server, const char* name, const char* value);
/**
* @brief Check if a server points to a local MaxScale service
*
* @param server Server to check
* @return True if the server points to a local MaxScale service
*/
bool server_is_mxs_service(const SERVER* server);
/**
* @brief Convert a server to JSON format
*
* @param server Server to convert
* @param host Hostname of this server
*
* @return JSON representation of server or NULL if an error occurred
*/
json_t* server_to_json(const SERVER* server, const char* host);
/**
* @brief Convert all servers into JSON format
*
* @param host Hostname of this server
*
* @return JSON array of servers or NULL if an error occurred
*/
json_t* server_list_to_json(const char* host);
/**
* @brief Set the disk space threshold of the server
*
* @param server The server.
* @param disk_space_threshold The disk space threshold as specified in the config file.
*
* @return True, if the provided string is valid and the threshold could be set.
*/
bool server_set_disk_space_threshold(SERVER* server, const char* disk_space_threshold);
/**
* @brief Add a response average to the server response average.
*
* @param server The server.
* @param ave Average.
* @param num_samples Number of samples the average consists of.
*
*/
void server_add_response_average(SERVER* server, double ave, int num_samples);
extern int server_free(SERVER* server);
extern SERVER* server_find_by_unique_name(const char* name);
extern int server_find_by_unique_names(char** server_names, int size, SERVER*** output);
extern SERVER* server_find(const char* servname, unsigned short port);
extern char* server_status(const SERVER*);
extern void server_clear_set_status_nolock(SERVER* server, uint64_t bits_to_clear, uint64_t bits_to_set);
extern void server_set_status_nolock(SERVER* server, uint64_t bit);
extern void server_clear_status_nolock(SERVER* server, uint64_t 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 size_t server_get_parameter(const SERVER* server, const char* name, char* out, size_t size);
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* ip,
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 void server_update_extra_port(SERVER* server, unsigned short port);
extern uint64_t server_map_status(const char* str);
extern void server_set_version_string(SERVER* server, const char* version_string);
extern void server_set_version(SERVER* server, const char* version_string, uint64_t version);
extern uint64_t server_get_version(const SERVER* server);
extern void printServer(const SERVER*);
extern void printAllServers();
extern void dprintAllServers(DCB*);
extern void dprintAllServersJson(DCB*);
extern void dprintServer(DCB*, const SERVER*);
extern void dprintPersistentDCBs(DCB*, const SERVER*);
extern void dListServers(DCB*);
int server_response_time_num_samples(const SERVER* server);
double server_response_time_average(const SERVER* server);

501
include/maxscale/server.hh
View File

@ -15,9 +15,506 @@
#include <maxscale/ccdefs.hh>
#include <string>
#include <cstdlib>
#include <maxbase/jansson.h>
#include <maxscale/config.hh>
#include <maxscale/dcb.h>
#include <maxscale/server.h>
#define MAX_SERVER_ADDRESS_LEN 1024
#define MAX_SERVER_MONUSER_LEN 1024
#define MAX_SERVER_MONPW_LEN 1024
#define MAX_SERVER_VERSION_LEN 256
#define MAX_NUM_SLAVES 128 /**< Maximum number of slaves under a single server*/
/**
* Server configuration parameters names
*/
extern const char CN_MONITORPW[];
extern const char CN_MONITORUSER[];
extern const char CN_PERSISTMAXTIME[];
extern const char CN_PERSISTPOOLMAX[];
extern const char CN_PROXY_PROTOCOL[];
/**
* Maintenance mode request constants.
*/
const int MAINTENANCE_OFF = -100;
const int MAINTENANCE_NO_CHANGE = 0;
const int MAINTENANCE_ON = 100;
const int MAINTENANCE_FLAG_NOCHECK = 0;
const int MAINTENANCE_FLAG_CHECK = -1;
// Default replication lag value
const int MXS_RLAG_UNDEFINED = -1;
/**
* The server parameters used for weighting routing decisions
*/
typedef struct server_params
{
char* name; /**< Parameter name */
char* value; /**< Parameter value */
bool active; /**< Whether the parameter is valid */
struct server_params* next; /**< Next Paramter in the linked list */
} SERVER_PARAM;
/**
* The server statistics structure
*/
typedef struct
{
int n_connections; /**< Number of connections */
int n_current; /**< Current connections */
int n_current_ops; /**< Current active operations */
int n_persistent; /**< Current persistent pool */
uint64_t n_new_conn; /**< Times the current pool was empty */
uint64_t n_from_pool; /**< Times when a connection was available from the pool */
uint64_t packets; /**< Number of packets routed to this server */
} SERVER_STATS;
/**
* The server version.
*/
typedef struct server_version
{
uint32_t major;
uint32_t minor;
uint32_t patch;
} SERVER_VERSION;
typedef enum
{
SERVER_TYPE_MARIADB,
SERVER_TYPE_MYSQL
} server_type_t;
static inline void server_decode_version(uint64_t version, SERVER_VERSION* server_version)
{
uint32_t major = version / 10000;
uint32_t minor = (version - major * 10000) / 100;
uint32_t patch = version - major * 10000 - minor * 100;
server_version->major = major;
server_version->minor = minor;
server_version->patch = patch;
}
static uint64_t server_encode_version(const SERVER_VERSION* server_version)
{
return server_version->major * 10000 + server_version->minor * 100 + server_version->patch;
}
/**
* The SERVER structure defines a backend server. Each server has a name
* or IP address for the server, a port that the server listens on and
* the name of a protocol module that is loaded to implement the protocol
* between the gateway and the server.
*/
typedef struct server
{
// Base settings
char* name; /**< Server config name */
char address[MAX_SERVER_ADDRESS_LEN]; /**< Server hostname/IP-address */
unsigned short port; /**< Server port */
unsigned short extra_port; /**< Server extra_port */
char* protocol; /**< Backend protocol module name */
char* authenticator; /**< Authenticator module name */
// Other settings
char monuser[MAX_SERVER_MONUSER_LEN]; /**< Monitor username, overrides monitor setting */
char monpw[MAX_SERVER_MONPW_LEN]; /**< Monitor password, overrides monitor setting */
long persistpoolmax; /**< Maximum size of persistent connections pool */
long persistmaxtime; /**< Maximum number of seconds connection can live */
bool proxy_protocol; /**< Send proxy-protocol header to backends when connecting
* routing sessions. */
SERVER_PARAM* parameters; /**< Additional custom parameters which may affect routing
* decisions. */
// Base variables
bool is_active; /**< Server is active and has not been "destroyed" */
void* auth_instance; /**< Authenticator instance data */
SSL_LISTENER* server_ssl; /**< SSL data */
DCB** persistent; /**< List of unused persistent connections to the server */
uint8_t charset; /**< Server character set. Read from backend and sent to client. */
// Statistics and events
SERVER_STATS stats; /**< The server statistics, e.g. number of connections */
int persistmax; /**< Maximum pool size actually achieved since startup */
int last_event; /**< The last event that occurred on this server */
int64_t triggered_at; /**< Time when the last event was triggered */
// Status descriptors. Updated automatically by a monitor or manually by the admin
uint64_t status; /**< Current status flag bitmap */
int maint_request; /**< Is admin requesting Maintenance=ON/OFF on the
* server? */
char version_string[MAX_SERVER_VERSION_LEN]; /**< Server version string as given by backend */
uint64_t version; /**< Server version numeric representation */
server_type_t server_type; /**< Server type (MariaDB or MySQL), deduced from
* version string */
long node_id; /**< Node id, server_id for M/S or local_index for
* Galera */
int rlag; /**< Replication Lag for Master/Slave replication
* */
unsigned long node_ts; /**< Last timestamp set from M/S monitor module */
long master_id; /**< Master server id of this node */
// Misc fields
bool master_err_is_logged; /**< If node failed, this indicates whether it is logged. Only
* used
* by rwsplit. TODO: Move to rwsplit */
bool warn_ssl_not_enabled;/**< SSL not used for an SSL enabled server */
MxsDiskSpaceThreshold* disk_space_threshold;/**< Disk space thresholds */
} SERVER;
/**
* Status bits in the SERVER->status member, which describes the general state of a server. Although the
* individual bits are independent, not all combinations make sense or are used. The bitfield is 64bits wide.
*/
// Bits used by most monitors
#define SERVER_RUNNING (1 << 0) /**<< The server is up and running */
#define SERVER_MAINT (1 << 1) /**<< Server is in maintenance mode */
#define SERVER_AUTH_ERROR (1 << 2) /**<< Authentication error from monitor */
#define SERVER_MASTER (1 << 3) /**<< The server is a master, i.e. can handle writes */
#define SERVER_SLAVE (1 << 4) /**<< The server is a slave, i.e. can handle reads */
// Bits used by MariaDB Monitor (mostly)
#define SERVER_SLAVE_OF_EXT_MASTER (1 << 5) /**<< Server is slave of a non-monitored master */
#define SERVER_RELAY (1 << 6) /**<< Server is a relay */
#define SERVER_WAS_MASTER (1 << 7) /**<< Server was a master but lost all slaves. */
// Bits used by other monitors
#define SERVER_JOINED (1 << 8) /**<< The server is joined in a Galera cluster */
#define SERVER_NDB (1 << 9) /**<< The server is part of a MySQL cluster setup */
#define SERVER_MASTER_STICKINESS (1 << 10) /**<< Server Master stickiness */
// Bits providing general information
#define SERVER_DISK_SPACE_EXHAUSTED (1 << 31) /**<< The disk space of the server is exhausted */
#define STRSRVSTATUS(s) \
(server_is_master(s) ? "RUNNING MASTER" \
: (server_is_slave(s) ? "RUNNING SLAVE" \
: (server_is_joined(s) ? "RUNNING JOINED" \
: (server_is_ndb(s) \
? "RUNNING NDB" \
: (( \
server_is_running(s) \
&& \
server_is_in_maint(s)) \
? \
"RUNNING MAINTENANCE" \
: ( \
server_is_relay(s) \
? \
"RUNNING RELAY" \
: ( \
server_is_usable(s) \
? \
"RUNNING (only)" \
: ( \
server_is_down(s) \
? \
"DOWN" \
: \
"UNKNOWN STATUS"))))))))
/**
* Is the server valid and active?
*
* @param server The server
* @return True, if server has not been removed from the runtime configuration.
*/
inline bool server_is_active(const SERVER* server)
{
return server->is_active;
}
inline bool status_is_usable(uint64_t status)
{
return (status & (SERVER_RUNNING | SERVER_MAINT)) == SERVER_RUNNING;
}
/**
* Is the server running and not in maintenance?
*
* @param server The server
* @return True, if server can be used.
*/
inline bool server_is_usable(const SERVER* server)
{
return status_is_usable(server->status);
}
inline bool status_is_running(uint64_t status)
{
return status & SERVER_RUNNING;
}
/**
* Is the server running?
*
* @param server The server
* @return True, if monitor can connect to the server.
*/
inline bool server_is_running(const SERVER* server)
{
return status_is_running(server->status);
}
inline bool status_is_down(uint64_t status)
{
return (status & SERVER_RUNNING) == 0;
}
/**
* Is the server down?
*
* @param server The server
* @return True, if monitor cannot connect to the server.
*/
inline bool server_is_down(const SERVER* server)
{
return status_is_down(server->status);
}
inline bool status_is_in_maint(uint64_t status)
{
return status & SERVER_MAINT;
}
/**
* Is the server in maintenance mode?
*
* @param server The server
* @return True, if server is in maintenance.
*/
inline bool server_is_in_maint(const SERVER* server)
{
return status_is_in_maint(server->status);
}
inline bool status_is_master(uint64_t status)
{
return (status & (SERVER_RUNNING | SERVER_MASTER | SERVER_MAINT)) == (SERVER_RUNNING | SERVER_MASTER);
}
/**
* Is the server a master?
*
* @param server The server
* @return True, if server is running and marked as master.
*/
inline bool server_is_master(const SERVER* server)
{
return status_is_master(server->status);
}
inline bool status_is_slave(uint64_t status)
{
return (status & (SERVER_RUNNING | SERVER_SLAVE | SERVER_MAINT)) == (SERVER_RUNNING | SERVER_SLAVE);
}
/**
* Is the server a slave.
*
* @param server The server
* @return True if server is running and marked as slave.
*/
inline bool server_is_slave(const SERVER* server)
{
return status_is_slave(server->status);
}
inline bool status_is_relay(uint64_t status)
{
return (status & (SERVER_RUNNING | SERVER_RELAY | SERVER_MAINT)) \
== (SERVER_RUNNING | SERVER_RELAY);
}
inline bool server_is_relay(const SERVER* server)
{
return status_is_relay(server->status);
}
inline bool status_is_joined(uint64_t status)
{
return (status & (SERVER_RUNNING | SERVER_JOINED | SERVER_MAINT))
== (SERVER_RUNNING | SERVER_JOINED);
}
/**
* Is the server joined Galera node? The server must be running and joined.
*/
inline bool server_is_joined(const SERVER* server)
{
return status_is_joined(server->status);
}
inline bool status_is_ndb(uint64_t status)
{
return (status & (SERVER_RUNNING | SERVER_NDB | SERVER_MAINT)) == (SERVER_RUNNING | SERVER_NDB);
}
/**
* Is the server a SQL node in MySQL Cluster? The server must be running and with NDB status
*/
inline bool server_is_ndb(const SERVER* server)
{
return status_is_ndb(server->status);
}
inline bool server_is_in_cluster(const SERVER* server)
{
return (server->status
& (SERVER_MASTER | SERVER_SLAVE | SERVER_RELAY | SERVER_JOINED | SERVER_NDB)) != 0;
}
inline bool status_is_slave_of_ext_master(uint64_t status)
{
return (status & (SERVER_RUNNING | SERVER_SLAVE_OF_EXT_MASTER))
== (SERVER_RUNNING | SERVER_SLAVE_OF_EXT_MASTER);
}
inline bool server_is_slave_of_ext_master(const SERVER* server)
{
return status_is_slave_of_ext_master(server->status);
}
inline bool status_is_disk_space_exhausted(uint64_t status)
{
return status & SERVER_DISK_SPACE_EXHAUSTED;
}
inline bool server_is_disk_space_exhausted(const SERVER* server)
{
return status_is_disk_space_exhausted(server->status);
}
/**
* @brief Allocate a new server
*
* This will create a new server that represents a backend server that services
* can use. This function will add the server to the running configuration but
* will not persist the changes.
*
* @param name Unique server name
* @param params Parameters for the server
*
* @return The newly created server or NULL if an error occurred
*/
extern SERVER* server_alloc(const char* name, MXS_CONFIG_PARAMETER* params);
/**
* @brief Serialize a server to a file
*
* This converts @c server into an INI format file. This allows created servers
* to be persisted to disk. This will replace any existing files with the same
* name.
*
* @param server Server to serialize
* @return False if the serialization of the server fails, true if it was successful
*/
bool server_serialize(const SERVER* server);
/**
* @brief Add a server parameter
*
* @param server Server where the parameter is added
* @param name Parameter name
* @param value Parameter value
*/
void server_add_parameter(SERVER* server, const char* name, const char* value);
/**
* @brief Remove a server parameter
*
* @param server Server to remove the parameter from
* @param name The name of the parameter to remove
* @return True if a parameter was removed
*/
bool server_remove_parameter(SERVER* server, const char* name);
/**
* @brief Set server parameter
*
* @param server Server to update
* @param name Parameter to set
* @param value Value of parameter
*/
void server_set_parameter(SERVER* server, const char* name, const char* value);
/**
* @brief Check if a server points to a local MaxScale service
*
* @param server Server to check
* @return True if the server points to a local MaxScale service
*/
bool server_is_mxs_service(const SERVER* server);
/**
* @brief Convert a server to JSON format
*
* @param server Server to convert
* @param host Hostname of this server
*
* @return JSON representation of server or NULL if an error occurred
*/
json_t* server_to_json(const SERVER* server, const char* host);
/**
* @brief Convert all servers into JSON format
*
* @param host Hostname of this server
*
* @return JSON array of servers or NULL if an error occurred
*/
json_t* server_list_to_json(const char* host);
/**
* @brief Set the disk space threshold of the server
*
* @param server The server.
* @param disk_space_threshold The disk space threshold as specified in the config file.
*
* @return True, if the provided string is valid and the threshold could be set.
*/
bool server_set_disk_space_threshold(SERVER* server, const char* disk_space_threshold);
/**
* @brief Add a response average to the server response average.
*
* @param server The server.
* @param ave Average.
* @param num_samples Number of samples the average consists of.
*
*/
void server_add_response_average(SERVER* server, double ave, int num_samples);
extern int server_free(SERVER* server);
extern SERVER* server_find_by_unique_name(const char* name);
extern int server_find_by_unique_names(char** server_names, int size, SERVER*** output);
extern SERVER* server_find(const char* servname, unsigned short port);
extern char* server_status(const SERVER*);
extern void server_clear_set_status_nolock(SERVER* server, uint64_t bits_to_clear, uint64_t bits_to_set);
extern void server_set_status_nolock(SERVER* server, uint64_t bit);
extern void server_clear_status_nolock(SERVER* server, uint64_t 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 size_t server_get_parameter(const SERVER* server, const char* name, char* out, size_t size);
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* ip,
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 void server_update_extra_port(SERVER* server, unsigned short port);
extern uint64_t server_map_status(const char* str);
extern void server_set_version_string(SERVER* server, const char* version_string);
extern void server_set_version(SERVER* server, const char* version_string, uint64_t version);
extern uint64_t server_get_version(const SERVER* server);
extern void printServer(const SERVER*);
extern void printAllServers();
extern void dprintAllServers(DCB*);
extern void dprintAllServersJson(DCB*);
extern void dprintServer(DCB*, const SERVER*);
extern void dprintPersistentDCBs(DCB*, const SERVER*);
extern void dListServers(DCB*);
int server_response_time_num_samples(const SERVER* server);
double server_response_time_average(const SERVER* server);
namespace maxscale
{

2
include/maxscale/service.hh
View File

@ -27,7 +27,7 @@
#include <maxscale/dcb.h>
#include <maxscale/listener.hh>
#include <maxscale/filter.hh>
#include <maxscale/server.h>
#include <maxscale/server.hh>
struct server;
struct mxs_router;

2
include/maxscale/session_stats.hh
View File

@ -17,7 +17,7 @@
#include <map>
#include <maxscale/server.h>
#include <maxscale/server.hh>
#include <maxbase/average.hh>
#include <maxbase/stopwatch.hh>

2
query_classifier/test/version_sensitivity.cc
View File

@ -15,7 +15,7 @@
#include <maxscale/log.h>
#include <maxscale/paths.h>
#include <maxscale/query_classifier.h>
#include <maxscale/server.h>
#include <maxscale/server.hh>
#include <maxscale/protocol/mysql.h>
using namespace std;

2
server/core/dcb.cc
View File

@ -47,7 +47,7 @@
#include <maxscale/log.h>
#include <maxscale/poll.h>
#include <maxscale/router.hh>
#include <maxscale/server.h>
#include <maxscale/server.hh>
#include <maxscale/service.hh>
#include <maxscale/utils.h>
#include <maxscale/routingworker.hh>

2
server/core/gateway.cc
View File

@ -56,7 +56,7 @@
#include <maxscale/mysql_utils.hh>
#include <maxscale/paths.h>
#include <maxscale/query_classifier.h>
#include <maxscale/server.h>
#include <maxscale/server.hh>
#include <maxscale/sqlite3.h>
#include <maxscale/session.h>
#include <maxscale/utils.h>

2
server/core/internal/resource.hh
View File

@ -19,7 +19,7 @@
#include <string>
#include <deque>
#include <maxscale/server.h>
#include <maxscale/server.hh>
#include <maxscale/http.hh>
#include "httprequest.hh"

2
server/core/internal/server.hh
View File

@ -21,7 +21,7 @@
#include <mutex>
#include <maxbase/average.hh>
#include <maxscale/server.h>
#include <maxscale/server.hh>
#include <maxscale/resultset.hh>
#include <maxscale/routingworker.hh>

2
server/core/poll.cc
View File

@ -32,7 +32,7 @@
#include <maxbase/atomic.h>
#include <maxscale/config.hh>
#include <maxscale/clock.h>
#include <maxscale/server.h>
#include <maxscale/server.hh>
#include <maxscale/statistics.hh>
#include <maxscale/routingworker.hh>

2
server/core/service.cc
View File

@ -47,7 +47,7 @@
#include <maxscale/protocol.h>
#include <maxscale/resultset.hh>
#include <maxscale/router.hh>
#include <maxscale/server.h>
#include <maxscale/server.hh>
#include <maxscale/session.h>
#include <maxscale/users.h>
#include <maxscale/utils.h>

2
server/core/test/test_server.cc
View File

@ -34,7 +34,7 @@
#include <string.h>
#include <maxscale/alloc.h>
#include <maxscale/server.h>
#include <maxscale/server.hh>
#include <maxscale/log.h>
#include <maxscale/paths.h>
#include <maxscale/config.hh>

2
server/modules/authenticator/GSSAPI/GSSAPIBackendAuth/gssapi_backend_auth.cc
View File

@ -18,7 +18,7 @@
#include <maxscale/dcb.h>
#include <maxscale/log.h>
#include <maxscale/protocol/mysql.h>
#include <maxscale/server.h>
#include <maxscale/server.hh>
#include "../gssapi_auth.h"

2
server/modules/authenticator/MySQLBackendAuth/mysql_backend_auth.cc
View File

@ -27,7 +27,7 @@
#include <maxscale/alloc.h>
#include <maxscale/authenticator.h>
#include <maxscale/protocol/mysql.h>
#include <maxscale/server.h>
#include <maxscale/server.hh>
#include <maxscale/utils.h>
/** Authentication states */

2
server/modules/authenticator/PAM/PAMBackendAuth/pam_backend_auth.cc
View File

@ -15,7 +15,7 @@
#include <maxscale/authenticator.h>
#include <maxscale/log.h>
#include <maxscale/server.h>
#include <maxscale/server.hh>
#include "pam_backend_session.hh"
#include "../pam_auth_common.hh"

2
server/modules/authenticator/PAM/PAMBackendAuth/pam_backend_session.cc
View File

@ -12,7 +12,7 @@
*/
#include "pam_backend_session.hh"
#include <maxscale/server.h>
#include <maxscale/server.hh>
namespace
{

2
server/modules/filter/namedserverfilter/namedserverfilter.cc
View File

@ -42,7 +42,7 @@
#include <maxscale/log.h>
#include <maxscale/modinfo.h>
#include <maxscale/modutil.hh>
#include <maxscale/server.h>
#include <maxscale/server.hh>
#include <maxscale/utils.h>
static void generate_param_names(int pairs);

2
server/modules/filter/tpmfilter/tpmfilter.cc
View File

@ -60,7 +60,7 @@
#include <maxscale/modinfo.h>
#include <maxscale/modutil.hh>
#include <maxscale/log.h>
#include <maxscale/server.h>
#include <maxscale/server.hh>
#include <maxbase/atomic.h>
#include <maxscale/query_classifier.h>

2
server/modules/routing/avrorouter/avro.cc
View File

@ -38,7 +38,7 @@
#include <maxscale/protocol/mysql.h>
#include <maxscale/random.h>
#include <maxscale/router.hh>
#include <maxscale/server.h>
#include <maxscale/server.hh>
#include <maxscale/service.hh>
#include <maxscale/utils.hh>
#include <maxscale/pcre2.h>

2
server/modules/routing/avrorouter/avro_client.cc
View File

@ -25,7 +25,7 @@
#include <fstream>
#include <sstream>
#include <maxscale/service.hh>
#include <maxscale/server.h>
#include <maxscale/server.hh>
#include <maxscale/router.hh>
#include <maxbase/atomic.h>
#include <maxscale/dcb.h>

2
server/modules/routing/avrorouter/avro_main.cc
View File

@ -34,7 +34,7 @@
#include <maxscale/protocol/mysql.h>
#include <maxscale/random.h>
#include <maxscale/router.hh>
#include <maxscale/server.h>
#include <maxscale/server.hh>
#include <maxscale/service.hh>
#include <maxscale/utils.h>
#include <maxscale/routingworker.h>

2
server/modules/routing/binlogrouter/blr.cc
View File

@ -45,7 +45,7 @@
#include <maxscale/protocol/mysql.h>
#include <maxscale/router.hh>
#include <maxscale/secrets.h>
#include <maxscale/server.h>
#include <maxscale/server.hh>
#include <maxscale/service.hh>
#include <maxscale/users.h>
#include <maxscale/utils.h>

2
server/modules/routing/binlogrouter/blr_cache.cc
View File

@ -30,7 +30,7 @@
#include <stdlib.h>
#include <string.h>
#include <maxscale/service.hh>
#include <maxscale/server.h>
#include <maxscale/server.hh>
#include <maxscale/router.hh>
#include <maxbase/atomic.h>
#include <maxscale/dcb.h>

2
server/modules/routing/binlogrouter/blr_file.cc
View File

@ -38,7 +38,7 @@
#include <maxscale/paths.h>
#include <maxscale/router.hh>
#include <maxscale/secrets.h>
#include <maxscale/server.h>
#include <maxscale/server.hh>
#include <maxscale/service.hh>
#include <maxscale/utils.h>

2
server/modules/routing/binlogrouter/blr_master.cc
View File

@ -50,7 +50,7 @@
#include <maxscale/router.hh>
#include <maxscale/routingworker.h>
#include <maxbase/worker.hh>
#include <maxscale/server.h>
#include <maxscale/server.hh>
#include <maxscale/service.hh>
#include <maxscale/session.h>
#include <maxscale/utils.h>

2
server/modules/routing/binlogrouter/blr_slave.cc
View File

@ -43,7 +43,7 @@
#include <maxscale/maxscale.h>
#include <maxscale/poll.h>
#include <maxscale/router.hh>
#include <maxscale/server.h>
#include <maxscale/server.hh>
#include <maxscale/service.hh>
#include <maxscale/utils.h>
#include <maxscale/version.h>

2
server/modules/routing/binlogrouter/test/testbinlog.cc
View File

@ -29,7 +29,7 @@
#include <string.h>
#include <ctype.h>
#include <time.h>
#include <maxscale/server.h>
#include <maxscale/server.hh>
#include <maxscale/router.hh>
#include <maxbase/atomic.h>
#include <maxscale/dcb.h>

2
server/modules/routing/maxinfo/maxinfo.cc
View File

@ -35,7 +35,7 @@
#include <maxscale/alloc.h>
#include <maxscale/service.hh>
#include <maxscale/server.h>
#include <maxscale/server.hh>
#include <maxscale/router.hh>
#include <maxscale/modinfo.h>
#include <maxscale/modutil.hh>

2
server/modules/routing/readwritesplit/rwsplit_route_stmt.cc
View File

@ -24,7 +24,7 @@
#include <maxscale/modutil.hh>
#include <maxscale/modutil.hh>
#include <maxscale/router.hh>
#include <maxscale/server.h>
#include <maxscale/server.hh>
#include <maxscale/session_command.hh>
#include <maxscale/utils.hh>