#pragma once #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace CurrentMetrics { extern const Metric Query; } namespace DB { class IStorage; using StoragePtr = std::shared_ptr; using Tables = std::map; struct Settings; class IAST; struct ProcessListForUser; /** List of currently executing queries. * Also implements limit on their number. */ /** Information of process list element. * To output in SHOW PROCESSLIST query. Does not contain any complex objects, that do something on copy or destructor. */ struct ProcessInfo { String query; double elapsed_seconds; size_t read_rows; size_t read_bytes; size_t total_rows; size_t written_rows; size_t written_bytes; Int64 memory_usage; Int64 peak_memory_usage; ClientInfo client_info; bool is_cancelled; }; /// Query and information about its execution. class ProcessListElement { friend class ProcessList; private: String query; ClientInfo client_info; Stopwatch watch; /// Progress of input stream Progress progress_in; /// Progress of output stream Progress progress_out; MemoryTracker memory_tracker; QueryPriorities::Handle priority_handle; CurrentMetrics::Increment num_queries {CurrentMetrics::Query}; std::atomic is_killed { false }; /// Be careful using it. For example, queries field could be modified concurrently. const ProcessListForUser * user_process_list = nullptr; mutable std::mutex query_streams_mutex; /// Streams with query results, point to BlockIO from executeQuery() /// This declaration is compatible with notes about BlockIO::process_list_entry: /// there are no cyclic dependencies: BlockIO::in,out point to objects inside ProcessListElement (not whole object) BlockInputStreamPtr query_stream_in; BlockOutputStreamPtr query_stream_out; enum QueryStreamsStatus { NotInitialized, Initialized, Released }; QueryStreamsStatus query_streams_status{NotInitialized}; public: ProcessListElement( const String & query_, const ClientInfo & client_info_, size_t max_memory_usage, double memory_tracker_fault_probability, QueryPriorities::Handle && priority_handle_) : query(query_), client_info(client_info_), memory_tracker(max_memory_usage), priority_handle(std::move(priority_handle_)) { memory_tracker.setDescription("(for query)"); current_memory_tracker = &memory_tracker; if (memory_tracker_fault_probability) memory_tracker.setFaultProbability(memory_tracker_fault_probability); } ~ProcessListElement() { current_memory_tracker = nullptr; } const ClientInfo & getClientInfo() const { return client_info; } ProgressValues getProgressIn() const { return progress_in.getValues(); } ProgressValues getProgressOut() const { return progress_out.getValues(); } ThrottlerPtr getUserNetworkThrottler(); bool updateProgressIn(const Progress & value) { progress_in.incrementPiecewiseAtomically(value); if (priority_handle) priority_handle->waitIfNeed(std::chrono::seconds(1)); /// NOTE Could make timeout customizable. return !is_killed.load(std::memory_order_relaxed); } bool updateProgressOut(const Progress & value) { progress_out.incrementPiecewiseAtomically(value); return !is_killed.load(std::memory_order_relaxed); } ProcessInfo getInfo() const { ProcessInfo res; res.query = query; res.client_info = client_info; res.elapsed_seconds = watch.elapsedSeconds(); res.is_cancelled = is_killed.load(std::memory_order_relaxed); res.read_rows = progress_in.rows; res.read_bytes = progress_in.bytes; res.total_rows = progress_in.total_rows; res.written_rows = progress_out.rows; res.written_bytes = progress_out.bytes; res.memory_usage = memory_tracker.get(); res.peak_memory_usage = memory_tracker.getPeak(); return res; } /// Copies pointers to in/out streams void setQueryStreams(const BlockIO & io); /// Frees in/out streams void releaseQueryStreams(); /// It means that ProcessListEntry still exists, but stream was already destroyed bool streamsAreReleased(); /// Get query in/out pointers from BlockIO bool tryGetQueryStreams(BlockInputStreamPtr & in, BlockOutputStreamPtr & out) const; }; /// Data about queries for one user. struct ProcessListForUser { /// query_id -> ProcessListElement(s). There can be multiple queries with the same query_id as long as all queries except one are cancelled. using QueryToElement = std::unordered_multimap; QueryToElement queries; /// Limit and counter for memory of all simultaneously running queries of single user. MemoryTracker user_memory_tracker; /// Count network usage for all simultaneously running queries of single user. ThrottlerPtr user_throttler; /// Clears MemoryTracker for the user. /// Sometimes it is important to reset the MemoryTracker, because it may accumulate skew /// due to the fact that there are cases when memory can be allocated while processing the query, but released later. /// Clears network bandwidth Throttler, so it will not count periods of inactivity. void reset() { user_memory_tracker.reset(); if (user_throttler) user_throttler.reset(); } }; class ProcessList; /// Keeps iterator to process list and removes element in destructor. class ProcessListEntry { private: using Container = std::list; ProcessList & parent; Container::iterator it; public: ProcessListEntry(ProcessList & parent_, Container::iterator it_) : parent(parent_), it(it_) {} ~ProcessListEntry(); ProcessListElement * operator->() { return &*it; } const ProcessListElement * operator->() const { return &*it; } ProcessListElement & get() { return *it; } const ProcessListElement & get() const { return *it; } }; class ProcessList { friend class ProcessListEntry; public: using Element = ProcessListElement; using Entry = ProcessListEntry; /// list, for iterators not to invalidate. NOTE: could replace with cyclic buffer, but not worth. using Container = std::list; using Info = std::vector; /// User -> queries using UserToQueries = std::unordered_map; private: mutable std::mutex mutex; mutable Poco::Condition have_space; /// Number of currently running queries has become less than maximum. /// List of queries Container cont; size_t cur_size; /// In C++03 or C++11 and old ABI, std::list::size is not O(1). size_t max_size; /// 0 means no limit. Otherwise, when limit exceeded, an exception is thrown. /// Stores per-user info: queries, statistics and limits UserToQueries user_to_queries; /// Stores info about queries grouped by their priority QueryPriorities priorities; /// Limit and counter for memory of all simultaneously running queries. MemoryTracker total_memory_tracker; /// Limit network bandwidth for all users ThrottlerPtr total_network_throttler; /// Call under lock. Finds process with specified current_user and current_query_id. ProcessListElement * tryGetProcessListElement(const String & current_query_id, const String & current_user); public: ProcessList(size_t max_size_ = 0) : cur_size(0), max_size(max_size_) {} using EntryPtr = std::shared_ptr; /** Register running query. Returns refcounted object, that will remove element from list in destructor. * If too many running queries - wait for not more than specified (see settings) amount of time. * If timeout is passed - throw an exception. * Don't count KILL QUERY queries. */ EntryPtr insert(const String & query_, const IAST * ast, const ClientInfo & client_info, const Settings & settings); /// Number of currently executing queries. size_t size() const { return cur_size; } /// Get current state of process list. Info getInfo() const { std::lock_guard lock(mutex); Info res; res.reserve(cur_size); for (const auto & elem : cont) res.emplace_back(elem.getInfo()); return res; } void setMaxSize(size_t max_size_) { std::lock_guard lock(mutex); max_size = max_size_; } enum class CancellationCode { NotFound = 0, /// already cancelled QueryIsNotInitializedYet = 1, CancelCannotBeSent = 2, CancelSent = 3, Unknown }; /// Try call cancel() for input and output streams of query with specified id and user CancellationCode sendCancelToQuery(const String & current_query_id, const String & current_user, bool kill = false); }; }