b4e8f79c5f
Formatted with nl_func_type_name and related options set to ignore. This keeps the formatting intact for long return types in declarations and definitions.
546 lines
17 KiB
C++
546 lines
17 KiB
C++
/*
|
|
* 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
|
|
|
|
#include <maxscale/ccdefs.hh>
|
|
#include <stdint.h>
|
|
#include <maxbase/jansson.h>
|
|
#include <maxscale/buffer.hh>
|
|
#include <maxscale/routing.h>
|
|
#include <maxscale/service.hh>
|
|
#include <maxscale/session.hh>
|
|
|
|
MXS_BEGIN_DECLS
|
|
|
|
/**
|
|
* MXS_ROUTER is an opaque type representing a particular router instance.
|
|
*
|
|
* MaxScale itself does not do anything with it, except for receiving it
|
|
* from the @c createInstance function of a router module and subsequently
|
|
* passing it back to the API functions of the router.
|
|
*/
|
|
typedef struct mxs_router
|
|
{
|
|
} MXS_ROUTER;
|
|
|
|
/**
|
|
* MXS_ROUTER_SESSION is an opaque type representing the session related
|
|
* data of a particular router instance.
|
|
*
|
|
* MaxScale itself does not do anything with it, except for receiving it
|
|
* from the @c newSession function of a router module and subsequently
|
|
* passing it back to the API functions of the router.
|
|
*/
|
|
typedef struct mxs_router_session
|
|
{
|
|
} MXS_ROUTER_SESSION;
|
|
|
|
typedef enum error_action
|
|
{
|
|
ERRACT_NEW_CONNECTION = 0x001,
|
|
ERRACT_REPLY_CLIENT = 0x002
|
|
} mxs_error_action_t;
|
|
|
|
/**
|
|
* @verbatim
|
|
* The "module object" structure for a query router module. All entry points
|
|
* marked with `(optional)` are optional entry points which can be set to NULL
|
|
* if no implementation is required.
|
|
*
|
|
* The entry points are:
|
|
* createInstance Called by the service to create a new instance of the query router
|
|
* newSession Called to create a new user session within the query router
|
|
* closeSession Called when a session is closed
|
|
* freeSession Called when a session is freed
|
|
* routeQuery Called on each query that requires routing
|
|
* diagnostics Called to force the router to print diagnostic output
|
|
* clientReply Called to reply to client the data from one or all backends (optional)
|
|
* handleError Called to reply to client errors with optional closeSession
|
|
* or make a request for a new backend connection
|
|
* getCapabilities Called to obtain the capabilities of the router (optional)
|
|
* destroyInstance Called for destroying a router instance (optional)
|
|
*
|
|
* @endverbatim
|
|
*
|
|
* @see load_module
|
|
*/
|
|
typedef struct mxs_router_object
|
|
{
|
|
/**
|
|
* @brief Create a new instance of the router
|
|
*
|
|
* This function is called when a new router instance is created. The return
|
|
* value of this function will be passed as the first parameter to the
|
|
* other API functions.
|
|
*
|
|
* @param service The service where the instance is created
|
|
* @param params Parameters for the router
|
|
*
|
|
* @return New router instance on NULL on error
|
|
*/
|
|
MXS_ROUTER*(*createInstance)(SERVICE * service, MXS_CONFIG_PARAMETER* params);
|
|
|
|
/**
|
|
* Called to create a new user session within the router
|
|
*
|
|
* This function is called when a new router session is created for a client.
|
|
* The return value of this function will be passed as the second parameter
|
|
* to the @c routeQuery, @c clientReply, @c closeSession, @c freeSession,
|
|
* and @c handleError functions.
|
|
*
|
|
* @param instance Router instance
|
|
* @param session Client MXS_SESSION object
|
|
*
|
|
* @return New router session or NULL on error
|
|
*/
|
|
MXS_ROUTER_SESSION*(*newSession)(MXS_ROUTER * instance, MXS_SESSION* session);
|
|
|
|
/**
|
|
* @brief Called when a session is closed
|
|
*
|
|
* The router should close all objects (including backend DCBs) but not free any memory.
|
|
*
|
|
* @param instance Router instance
|
|
* @param router_session Router session
|
|
*/
|
|
void (* closeSession)(MXS_ROUTER* instance, MXS_ROUTER_SESSION* router_session);
|
|
|
|
/**
|
|
* @brief Called when a session is freed
|
|
*
|
|
* The session should free all allocated memory in this function.
|
|
*
|
|
* @param instance Router instance
|
|
* @param router_session Router session
|
|
*/
|
|
void (* freeSession)(MXS_ROUTER* instance, MXS_ROUTER_SESSION* router_session);
|
|
|
|
/**
|
|
* @brief Called on each query that requires routing
|
|
*
|
|
* TODO: Document how routeQuery should be used
|
|
*
|
|
* @param instance Router instance
|
|
* @param router_session Router session
|
|
* @param queue Request from the client
|
|
*
|
|
* @return If successful, the function returns 1. If an error occurs
|
|
* and the session should be closed, the function returns 0.
|
|
*/
|
|
int32_t (* routeQuery)(MXS_ROUTER* instance, MXS_ROUTER_SESSION* router_session, GWBUF* queue);
|
|
|
|
|
|
/**
|
|
* @brief Called for diagnostic output
|
|
*
|
|
* @param instance Router instance
|
|
* @param dcb DCB where the diagnostic information should be written
|
|
*/
|
|
void (* diagnostics)(MXS_ROUTER* instance, DCB* dcb);
|
|
|
|
/**
|
|
* @brief Called for diagnostic output
|
|
*
|
|
* @param instance Router instance
|
|
*
|
|
* @return Diagnostic information in JSON format
|
|
*
|
|
* @see jansson.h
|
|
*/
|
|
json_t* (*diagnostics_json)(const MXS_ROUTER * instance);
|
|
|
|
/**
|
|
* @brief Called for each reply packet
|
|
*
|
|
* TODO: Document how clientReply should be used
|
|
*
|
|
* @param instance Router instance
|
|
* @param router_session Router session
|
|
* @param queue Response from the server
|
|
* @param backend_dcb The backend DCB which responded to the query
|
|
*/
|
|
void (* clientReply)(MXS_ROUTER* instance,
|
|
MXS_ROUTER_SESSION* router_session,
|
|
GWBUF* queue,
|
|
DCB* backend_dcb);
|
|
|
|
/**
|
|
* @brief Called when a backend DCB has failed
|
|
*
|
|
* @param instance Router instance
|
|
* @param router_session Router session
|
|
* @param errmsgbuf Error message buffer
|
|
* @param backend_dcb The backend DCB that has failed
|
|
* @param action The type of the action (TODO: Remove this parameter)
|
|
*
|
|
* @param succp Pointer to a `bool` which should be set to true for success or false for error
|
|
*/
|
|
void (* handleError)(MXS_ROUTER* instance,
|
|
MXS_ROUTER_SESSION* router_session,
|
|
GWBUF* errmsgbuf,
|
|
DCB* backend_dcb,
|
|
mxs_error_action_t action,
|
|
bool* succp);
|
|
|
|
/**
|
|
* @brief Called to obtain the capabilities of the router
|
|
*
|
|
* @return Zero or more bitwise-or'd values from the mxs_routing_capability_t enum
|
|
*
|
|
* @see routing.h
|
|
*/
|
|
uint64_t (* getCapabilities)(MXS_ROUTER* instance);
|
|
|
|
/**
|
|
* @brief Called for destroying a router instance
|
|
*
|
|
* @param instance Router instance
|
|
*/
|
|
void (* destroyInstance)(MXS_ROUTER* instance);
|
|
|
|
/**
|
|
* @brief Configure router instance at runtime
|
|
*
|
|
* This function is guaranteed to be called by only one thread at a time.
|
|
* The router must declare the RCAP_TYPE_RUNTIME_CONFIG in its capabilities
|
|
* in order for this function to be called.
|
|
*
|
|
* Modifications to the router should be made in an atomic manner so that
|
|
* existing sessions do not read a partial configuration. One way to do this
|
|
* is to use shared pointers for storing configurations.
|
|
*
|
|
* @param instance Router instance
|
|
* @param params Updated parameters for the service. The parameters are
|
|
* validated before this function is called.
|
|
*
|
|
* @return True if reconfiguration was successful, false if reconfiguration
|
|
* failed. If reconfiguration failed, the state of the router
|
|
* instance should not be modified.
|
|
*/
|
|
bool (* configureInstance)(MXS_ROUTER* instance, MXS_CONFIG_PARAMETER* params);
|
|
} MXS_ROUTER_OBJECT;
|
|
|
|
/**
|
|
* The router module API version. Any change that changes the router API
|
|
* must update these versions numbers in accordance with the rules in
|
|
* modinfo.h.
|
|
*/
|
|
#define MXS_ROUTER_VERSION {4, 0, 0}
|
|
|
|
/**
|
|
* Specifies capabilities specific for routers. Common capabilities
|
|
* are defined by @c routing_capability_t.
|
|
*
|
|
* @see enum routing_capability
|
|
*
|
|
* @note The values of the capabilities here *must* be between 0x00010000
|
|
* and 0x00800000, that is, bits 16 to 23.
|
|
*/
|
|
typedef enum router_capability
|
|
{
|
|
RCAP_TYPE_NO_RSESSION = 0x00010000, /**< Router does not use router sessions */
|
|
RCAP_TYPE_NO_USERS_INIT = 0x00020000, /**< Prevent the loading of authenticator
|
|
* users when the service is started */
|
|
RCAP_TYPE_NO_AUTH = 0x00040000, /**< No `user` or `password` parameter required */
|
|
RCAP_TYPE_RUNTIME_CONFIG = 0x00080000, /**< Router supports runtime cofiguration */
|
|
} mxs_router_capability_t;
|
|
|
|
typedef enum
|
|
{
|
|
TYPE_UNDEFINED = 0,
|
|
TYPE_MASTER,
|
|
TYPE_ALL
|
|
} mxs_target_t;
|
|
|
|
/**
|
|
* @brief Convert mxs_target_t to a string
|
|
*
|
|
* @param target Target to convert
|
|
*
|
|
* @return Target type as string
|
|
*/
|
|
static inline const char* mxs_target_to_str(mxs_target_t target)
|
|
{
|
|
switch (target)
|
|
{
|
|
case TYPE_MASTER:
|
|
return "master";
|
|
|
|
case TYPE_ALL:
|
|
return "all";
|
|
|
|
default:
|
|
return "UNDEFINED";
|
|
}
|
|
}
|
|
|
|
MXS_END_DECLS
|
|
|
|
namespace maxscale
|
|
{
|
|
|
|
/**
|
|
* @class RouterSession router.hh <maxscale/router.hh>
|
|
*
|
|
* RouterSession is a base class for router sessions. A concrete router session
|
|
* class should be derived from this class and override all relevant functions.
|
|
*
|
|
* Note that even though this class is intended to be derived from, no functions
|
|
* are virtual. That is by design, as the class will be used in a context where
|
|
* the concrete class is known. That is, there is no need for the virtual mechanism.
|
|
*/
|
|
class RouterSession : public MXS_ROUTER_SESSION
|
|
{
|
|
public:
|
|
/**
|
|
* The RouterSession instance will be deleted when a client session
|
|
* has terminated. Will be called only after @c close() has been called.
|
|
*/
|
|
~RouterSession();
|
|
|
|
/**
|
|
* Called when a client session has been closed.
|
|
*/
|
|
void close();
|
|
|
|
/**
|
|
* Called when a packet being is routed to the backend. The router should
|
|
* forward the packet to the appropriate server(s).
|
|
*
|
|
* @param pPacket A client packet.
|
|
*/
|
|
int32_t routeQuery(GWBUF* pPacket);
|
|
|
|
/**
|
|
* Called when a packet is routed to the client. The router should
|
|
* forward the packet to the client using `MXS_SESSION_ROUTE_REPLY`.
|
|
*
|
|
* @param pPacket A client packet.
|
|
* @param pBackend The backend the packet is coming from.
|
|
*/
|
|
void clientReply(GWBUF* pPacket, DCB* pBackend);
|
|
|
|
/**
|
|
*
|
|
* @param pMessage The rror message.
|
|
* @param pProblem The DCB on which the error occurred.
|
|
* @param action The context.
|
|
* @param pSuccess On output, if false, the session will be terminated.
|
|
*/
|
|
void handleError(GWBUF* pMessage,
|
|
DCB* pProblem,
|
|
mxs_error_action_t action,
|
|
bool* pSuccess);
|
|
|
|
protected:
|
|
RouterSession(MXS_SESSION* pSession);
|
|
|
|
protected:
|
|
MXS_SESSION* m_pSession; /*< The MXS_SESSION this router session is associated with. */
|
|
};
|
|
|
|
|
|
/**
|
|
* @class Router router.hh <maxscale/router.hh>
|
|
*
|
|
* An instantiation of the Router template is used for creating a router.
|
|
* Router is an example of the "Curiously recurring template pattern"
|
|
* https://en.wikipedia.org/wiki/Curiously_recurring_template_pattern
|
|
* that is used for compile time polymorfism.
|
|
*
|
|
* The typical way for using the template is as follows:
|
|
*
|
|
* @code
|
|
* class MyRouterSession : public maxscale::RouterSession
|
|
* {
|
|
* // Override the relevant functions.
|
|
* };
|
|
*
|
|
* class MyRouter : public maxscale::Router<MyRouter, MyRouterSession>
|
|
* {
|
|
* public:
|
|
* static MyRouter* create(SERVICE* pService, MXS_CONFIG_PARAMETER* params);
|
|
*
|
|
* MyRouterSession* newSession(MXS_SESSION* pSession);
|
|
*
|
|
* void diagnostics(DCB* pDcb);
|
|
* uint64_t getCapabilities();
|
|
* };
|
|
* @endcode
|
|
*
|
|
* The concrete router class must implement the methods @c create, @c newSession,
|
|
* @c diagnostics and @c getCapabilities, with the prototypes as shown above.
|
|
*
|
|
* The plugin function @c GetModuleObject is then implemented as follows:
|
|
*
|
|
* @code
|
|
* extern "C" MXS_MODULE* MXS_CREATE_MODULE()
|
|
* {
|
|
* static MXS_MODULE module_object =
|
|
* {
|
|
* ...
|
|
* &MyRouter::s_object,
|
|
* ...
|
|
* };
|
|
*
|
|
* return &module_object;
|
|
* }
|
|
* @endcode
|
|
*/
|
|
template<class RouterType, class RouterSessionType>
|
|
class Router : public MXS_ROUTER
|
|
{
|
|
public:
|
|
|
|
// The default configure entry point, does nothing and always fails
|
|
bool configure(MXS_CONFIG_PARAMETER* param)
|
|
{
|
|
return false;
|
|
}
|
|
|
|
static MXS_ROUTER* createInstance(SERVICE* pService, MXS_CONFIG_PARAMETER* params)
|
|
{
|
|
RouterType* pRouter = NULL;
|
|
|
|
MXS_EXCEPTION_GUARD(pRouter = RouterType::create(pService, params));
|
|
|
|
return pRouter;
|
|
}
|
|
|
|
static MXS_ROUTER_SESSION* newSession(MXS_ROUTER* pInstance, MXS_SESSION* pSession)
|
|
{
|
|
RouterType* pRouter = static_cast<RouterType*>(pInstance);
|
|
RouterSessionType* pRouter_session = nullptr;
|
|
|
|
MXS_EXCEPTION_GUARD(pRouter_session = pRouter->newSession(pSession));
|
|
|
|
return pRouter_session;
|
|
}
|
|
|
|
static void closeSession(MXS_ROUTER*, MXS_ROUTER_SESSION* pData)
|
|
{
|
|
RouterSessionType* pRouter_session = static_cast<RouterSessionType*>(pData);
|
|
|
|
MXS_EXCEPTION_GUARD(pRouter_session->close());
|
|
}
|
|
|
|
static void freeSession(MXS_ROUTER*, MXS_ROUTER_SESSION* pData)
|
|
{
|
|
RouterSessionType* pRouter_session = static_cast<RouterSessionType*>(pData);
|
|
|
|
MXS_EXCEPTION_GUARD(delete pRouter_session);
|
|
}
|
|
|
|
static int32_t routeQuery(MXS_ROUTER*, MXS_ROUTER_SESSION* pData, GWBUF* pPacket)
|
|
{
|
|
RouterSessionType* pRouter_session = static_cast<RouterSessionType*>(pData);
|
|
|
|
int32_t rv = 0;
|
|
MXS_EXCEPTION_GUARD(rv = pRouter_session->routeQuery(pPacket));
|
|
|
|
return rv;
|
|
}
|
|
|
|
static void diagnostics(MXS_ROUTER* pInstance, DCB* pDcb)
|
|
{
|
|
RouterType* pRouter = static_cast<RouterType*>(pInstance);
|
|
|
|
MXS_EXCEPTION_GUARD(pRouter->diagnostics(pDcb));
|
|
}
|
|
|
|
static json_t* diagnostics_json(const MXS_ROUTER* pInstance)
|
|
{
|
|
const RouterType* pRouter = static_cast<const RouterType*>(pInstance);
|
|
|
|
json_t* rval = NULL;
|
|
|
|
MXS_EXCEPTION_GUARD(rval = pRouter->diagnostics_json());
|
|
|
|
return rval;
|
|
}
|
|
|
|
static void clientReply(MXS_ROUTER*, MXS_ROUTER_SESSION* pData, GWBUF* pPacket, DCB* pBackend)
|
|
{
|
|
RouterSessionType* pRouter_session = static_cast<RouterSessionType*>(pData);
|
|
|
|
MXS_EXCEPTION_GUARD(pRouter_session->clientReply(pPacket, pBackend));
|
|
}
|
|
|
|
static void handleError(MXS_ROUTER* pInstance,
|
|
MXS_ROUTER_SESSION* pData,
|
|
GWBUF* pMessage,
|
|
DCB* pProblem,
|
|
mxs_error_action_t action,
|
|
bool* pSuccess)
|
|
{
|
|
RouterSessionType* pRouter_session = static_cast<RouterSessionType*>(pData);
|
|
|
|
MXS_EXCEPTION_GUARD(pRouter_session->handleError(pMessage, pProblem, action, pSuccess));
|
|
}
|
|
|
|
static uint64_t getCapabilities(MXS_ROUTER* pInstance)
|
|
{
|
|
uint64_t rv = 0;
|
|
|
|
RouterType* pRouter = static_cast<RouterType*>(pInstance);
|
|
|
|
MXS_EXCEPTION_GUARD(rv = pRouter->getCapabilities());
|
|
|
|
return rv;
|
|
}
|
|
|
|
static void destroyInstance(MXS_ROUTER* pInstance)
|
|
{
|
|
RouterType* pRouter = static_cast<RouterType*>(pInstance);
|
|
|
|
MXS_EXCEPTION_GUARD(delete pRouter);
|
|
}
|
|
|
|
static bool configure(MXS_ROUTER* pInstance, MXS_CONFIG_PARAMETER* param)
|
|
{
|
|
RouterType* pRouter = static_cast<RouterType*>(pInstance);
|
|
bool rval = false;
|
|
MXS_EXCEPTION_GUARD(rval = pRouter->configure(param));
|
|
return rval;
|
|
}
|
|
|
|
static MXS_ROUTER_OBJECT s_object;
|
|
|
|
protected:
|
|
Router(SERVICE* pService)
|
|
: m_pService(pService)
|
|
{
|
|
}
|
|
|
|
SERVICE* m_pService;
|
|
};
|
|
|
|
|
|
template<class RouterType, class RouterSessionType>
|
|
MXS_ROUTER_OBJECT Router<RouterType, RouterSessionType>::s_object =
|
|
{
|
|
&Router<RouterType, RouterSessionType>::createInstance,
|
|
&Router<RouterType, RouterSessionType>::newSession,
|
|
&Router<RouterType, RouterSessionType>::closeSession,
|
|
&Router<RouterType, RouterSessionType>::freeSession,
|
|
&Router<RouterType, RouterSessionType>::routeQuery,
|
|
&Router<RouterType, RouterSessionType>::diagnostics,
|
|
&Router<RouterType, RouterSessionType>::diagnostics_json,
|
|
&Router<RouterType, RouterSessionType>::clientReply,
|
|
&Router<RouterType, RouterSessionType>::handleError,
|
|
&Router<RouterType, RouterSessionType>::getCapabilities,
|
|
&Router<RouterType, RouterSessionType>::destroyInstance,
|
|
&Router<RouterType, RouterSessionType>::configure,
|
|
};
|
|
}
|