/* * Copyright (C) 2016+ AzerothCore , released under GNU GPL v2 license, you may redistribute it and/or modify it under version 2 of the License, or (at your option), any later version. * Copyright (C) 2021+ WarheadCore */ #ifndef _DATABASEWORKERPOOL_H #define _DATABASEWORKERPOOL_H #include "DatabaseEnvFwd.h" #include "Define.h" #include "StringFormat.h" #include #include #include template class ProducerConsumerQueue; class SQLOperation; struct MySQLConnectionInfo; template class DatabaseWorkerPool { private: enum InternalIndex { IDX_ASYNC, IDX_SYNCH, IDX_SIZE }; public: /* Activity state */ DatabaseWorkerPool(); ~DatabaseWorkerPool(); void SetConnectionInfo(std::string const& infoString, uint8 const asyncThreads, uint8 const synchThreads); uint32 Open(); void Close(); //! Prepares all prepared statements bool PrepareStatements(); inline MySQLConnectionInfo const* GetConnectionInfo() const { return _connectionInfo.get(); } /** Delayed one-way statement methods. */ //! Enqueues a one-way SQL operation in string format that will be executed asynchronously. //! This method should only be used for queries that are only executed once, e.g during startup. void Execute(char const* sql); //! Enqueues a one-way SQL operation in string format -with variable args- that will be executed asynchronously. //! This method should only be used for queries that are only executed once, e.g during startup. template void PExecute(Format&& sql, Args&&... args) { if (Acore::IsFormatEmptyOrNull(sql)) return; Execute(Acore::StringFormat(std::forward(sql), std::forward(args)...).c_str()); } //! Enqueues a one-way SQL operation in prepared statement format that will be executed asynchronously. //! Statement must be prepared with CONNECTION_ASYNC flag. void Execute(PreparedStatement* stmt); /** Direct synchronous one-way statement methods. */ //! Directly executes a one-way SQL operation in string format, that will block the calling thread until finished. //! This method should only be used for queries that are only executed once, e.g during startup. void DirectExecute(char const* sql); //! Directly executes a one-way SQL operation in string format -with variable args-, that will block the calling thread until finished. //! This method should only be used for queries that are only executed once, e.g during startup. template void DirectPExecute(Format&& sql, Args&&... args) { if (Acore::IsFormatEmptyOrNull(sql)) return; DirectExecute(Acore::StringFormat(std::forward(sql), std::forward(args)...).c_str()); } //! Directly executes a one-way SQL operation in prepared statement format, that will block the calling thread until finished. //! Statement must be prepared with the CONNECTION_SYNCH flag. void DirectExecute(PreparedStatement* stmt); /** Synchronous query (with resultset) methods. */ //! Directly executes an SQL query in string format that will block the calling thread until finished. //! Returns reference counted auto pointer, no need for manual memory management in upper level code. QueryResult Query(char const* sql, T* connection = nullptr); //! Directly executes an SQL query in string format -with variable args- that will block the calling thread until finished. //! Returns reference counted auto pointer, no need for manual memory management in upper level code. template QueryResult PQuery(Format&& sql, T* conn, Args&&... args) { if (Acore::IsFormatEmptyOrNull(sql)) return QueryResult(nullptr); return Query(Acore::StringFormat(std::forward(sql), std::forward(args)...).c_str(), conn); } //! Directly executes an SQL query in string format -with variable args- that will block the calling thread until finished. //! Returns reference counted auto pointer, no need for manual memory management in upper level code. template QueryResult PQuery(Format&& sql, Args&&... args) { if (Acore::IsFormatEmptyOrNull(sql)) return QueryResult(nullptr); return Query(Acore::StringFormat(std::forward(sql), std::forward(args)...).c_str()); } //! Directly executes an SQL query in prepared format that will block the calling thread until finished. //! Returns reference counted auto pointer, no need for manual memory management in upper level code. //! Statement must be prepared with CONNECTION_SYNCH flag. PreparedQueryResult Query(PreparedStatement* stmt); /** Asynchronous query (with resultset) methods. */ //! Enqueues a query in string format that will set the value of the QueryResultFuture return object as soon as the query is executed. //! The return value is then processed in ProcessQueryCallback methods. QueryCallback AsyncQuery(char const* sql); //! Enqueues a query in prepared format that will set the value of the PreparedQueryResultFuture return object as soon as the query is executed. //! The return value is then processed in ProcessQueryCallback methods. //! Statement must be prepared with CONNECTION_ASYNC flag. QueryCallback AsyncQuery(PreparedStatement* stmt); //! Enqueues a vector of SQL operations (can be both adhoc and prepared) that will set the value of the QueryResultHolderFuture //! return object as soon as the query is executed. //! The return value is then processed in ProcessQueryCallback methods. //! Any prepared statements added to this holder need to be prepared with the CONNECTION_ASYNC flag. SQLQueryHolderCallback DelayQueryHolder(std::shared_ptr> holder); /** Transaction context methods. */ //! Begins an automanaged transaction pointer that will automatically rollback if not commited. (Autocommit=0) SQLTransaction BeginTransaction(); //! Enqueues a collection of one-way SQL operations (can be both adhoc and prepared). The order in which these operations //! were appended to the transaction will be respected during execution. void CommitTransaction(SQLTransaction transaction); //! Enqueues a collection of one-way SQL operations (can be both adhoc and prepared). The order in which these operations //! were appended to the transaction will be respected during execution. TransactionCallback AsyncCommitTransaction(SQLTransaction transaction); //! Directly executes a collection of one-way SQL operations (can be both adhoc and prepared). The order in which these operations //! were appended to the transaction will be respected during execution. void DirectCommitTransaction(SQLTransaction& transaction); //! Method used to execute ad-hoc statements in a diverse context. //! Will be wrapped in a transaction if valid object is present, otherwise executed standalone. void ExecuteOrAppend(SQLTransaction& trans, char const* sql); //! Method used to execute prepared statements in a diverse context. //! Will be wrapped in a transaction if valid object is present, otherwise executed standalone. void ExecuteOrAppend(SQLTransaction& trans, PreparedStatement* stmt); /** Other */ typedef typename T::Statements PreparedStatementIndex; //! Automanaged (internally) pointer to a prepared statement object for usage in upper level code. //! Pointer is deleted in this->DirectExecute(PreparedStatement*), this->Query(PreparedStatement*) or PreparedStatementTask::~PreparedStatementTask. //! This object is not tied to the prepared statement on the MySQL context yet until execution. PreparedStatement* GetPreparedStatement(PreparedStatementIndex index); //! Apply escape string'ing for current collation. (utf8) void EscapeString(std::string& str); //! Keeps all our MySQL connections alive, prevent the server from disconnecting us. void KeepAlive(); void WarnAboutSyncQueries([[maybe_unused]] bool warn) { #ifdef ACORE_DEBUG _warnSyncQueries = warn; #endif } private: uint32 OpenConnections(InternalIndex type, uint8 numConnections); unsigned long EscapeString(char* to, char const* from, unsigned long length); void Enqueue(SQLOperation* op); //! Gets a free connection in the synchronous connection pool. //! Caller MUST call t->Unlock() after touching the MySQL context to prevent deadlocks. T* GetFreeConnection(); char const* GetDatabaseName() const; //! Queue shared by async worker threads. std::unique_ptr> _queue; std::array>, IDX_SIZE> _connections; std::unique_ptr _connectionInfo; std::vector _preparedStatementSize; uint8 _async_threads, _synch_threads; #ifdef ACORE_DEBUG static inline thread_local bool _warnSyncQueries = false; #endif }; #endif