Deploying to gh-pages from @ GreptimeTeam/greptimedb@97913b4b3a 🚀

This commit is contained in:
github-merge-queue[bot]
2026-10-07 08:03:01 +00:00
commit ff419bc025
25679 changed files with 2969188 additions and 0 deletions
+66
View File
@@ -0,0 +1,66 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/common/runtime/src/error.rs`."><title>error.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="common_runtime" data-themes="" data-resource-suffix="" data-rustdoc-version="1.96.1 (31fca3adb 2026-06-26)" data-channel="1.96.1" data-search-js="search-b5634cc7.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../../static.files/storage-41dd4d93.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-5013f961.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-f7c3ffd8.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content" tabindex="-1"><div class="main-heading"><h1><div class="sub-heading">common_runtime/</div>error.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="comment">// Copyright 2023 Greptime Team
<a href=#2 id=2 data-nosnippet>2</a>//
<a href=#3 id=3 data-nosnippet>3</a>// Licensed under the Apache License, Version 2.0 (the "License");
<a href=#4 id=4 data-nosnippet>4</a>// you may not use this file except in compliance with the License.
<a href=#5 id=5 data-nosnippet>5</a>// You may obtain a copy of the License at
<a href=#6 id=6 data-nosnippet>6</a>//
<a href=#7 id=7 data-nosnippet>7</a>// http://www.apache.org/licenses/LICENSE-2.0
<a href=#8 id=8 data-nosnippet>8</a>//
<a href=#9 id=9 data-nosnippet>9</a>// Unless required by applicable law or agreed to in writing, software
<a href=#10 id=10 data-nosnippet>10</a>// distributed under the License is distributed on an "AS IS" BASIS,
<a href=#11 id=11 data-nosnippet>11</a>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<a href=#12 id=12 data-nosnippet>12</a>// See the License for the specific language governing permissions and
<a href=#13 id=13 data-nosnippet>13</a>// limitations under the License.
<a href=#14 id=14 data-nosnippet>14</a>
<a href=#15 id=15 data-nosnippet>15</a></span><span class="kw">use </span>std::any::Any;
<a href=#16 id=16 data-nosnippet>16</a>
<a href=#17 id=17 data-nosnippet>17</a><span class="kw">use </span>common_error::ext::ErrorExt;
<a href=#18 id=18 data-nosnippet>18</a><span class="kw">use </span>common_macro::stack_trace_debug;
<a href=#19 id=19 data-nosnippet>19</a><span class="kw">use </span>snafu::{Location, Snafu};
<a href=#20 id=20 data-nosnippet>20</a><span class="kw">use </span>tokio::task::JoinError;
<a href=#21 id=21 data-nosnippet>21</a>
<a href=#22 id=22 data-nosnippet>22</a><span class="kw">pub type </span><span class="prelude-ty">Result</span>&lt;T&gt; = std::result::Result&lt;T, Error&gt;;
<a href=#23 id=23 data-nosnippet>23</a>
<a href=#24 id=24 data-nosnippet>24</a><span class="attr">#[derive(Snafu)]
<a href=#25 id=25 data-nosnippet>25</a>#[snafu(visibility(<span class="kw">pub</span>(<span class="kw">crate</span>)))]
<a href=#26 id=26 data-nosnippet>26</a>#[stack_trace_debug]
<a href=#27 id=27 data-nosnippet>27</a></span><span class="kw">pub enum </span>Error {
<a href=#28 id=28 data-nosnippet>28</a> <span class="attr">#[snafu(display(<span class="string">"Failed to build runtime"</span>))]
<a href=#29 id=29 data-nosnippet>29</a> </span>BuildRuntime {
<a href=#30 id=30 data-nosnippet>30</a> <span class="attr">#[snafu(source)]
<a href=#31 id=31 data-nosnippet>31</a> </span>error: std::io::Error,
<a href=#32 id=32 data-nosnippet>32</a> <span class="attr">#[snafu(implicit)]
<a href=#33 id=33 data-nosnippet>33</a> </span>location: Location,
<a href=#34 id=34 data-nosnippet>34</a> },
<a href=#35 id=35 data-nosnippet>35</a>
<a href=#36 id=36 data-nosnippet>36</a> <span class="attr">#[snafu(display(<span class="string">"Failed to build runtime rate limiter"</span>))]
<a href=#37 id=37 data-nosnippet>37</a> </span>BuildRuntimeRateLimiter {
<a href=#38 id=38 data-nosnippet>38</a> <span class="attr">#[snafu(implicit)]
<a href=#39 id=39 data-nosnippet>39</a> </span>location: Location,
<a href=#40 id=40 data-nosnippet>40</a> <span class="attr">#[snafu(source)]
<a href=#41 id=41 data-nosnippet>41</a> </span>error: ratelimit::Error,
<a href=#42 id=42 data-nosnippet>42</a> },
<a href=#43 id=43 data-nosnippet>43</a>
<a href=#44 id=44 data-nosnippet>44</a> <span class="attr">#[snafu(display(<span class="string">"Repeated task {} is already started"</span>, name))]
<a href=#45 id=45 data-nosnippet>45</a> </span>IllegalState {
<a href=#46 id=46 data-nosnippet>46</a> name: String,
<a href=#47 id=47 data-nosnippet>47</a> <span class="attr">#[snafu(implicit)]
<a href=#48 id=48 data-nosnippet>48</a> </span>location: Location,
<a href=#49 id=49 data-nosnippet>49</a> },
<a href=#50 id=50 data-nosnippet>50</a>
<a href=#51 id=51 data-nosnippet>51</a> <span class="attr">#[snafu(display(<span class="string">"Failed to wait for repeated task {} to stop"</span>, name))]
<a href=#52 id=52 data-nosnippet>52</a> </span>WaitGcTaskStop {
<a href=#53 id=53 data-nosnippet>53</a> name: String,
<a href=#54 id=54 data-nosnippet>54</a> <span class="attr">#[snafu(source)]
<a href=#55 id=55 data-nosnippet>55</a> </span>error: JoinError,
<a href=#56 id=56 data-nosnippet>56</a> <span class="attr">#[snafu(implicit)]
<a href=#57 id=57 data-nosnippet>57</a> </span>location: Location,
<a href=#58 id=58 data-nosnippet>58</a> },
<a href=#59 id=59 data-nosnippet>59</a>}
<a href=#60 id=60 data-nosnippet>60</a>
<a href=#61 id=61 data-nosnippet>61</a><span class="kw">impl </span>ErrorExt <span class="kw">for </span>Error {
<a href=#62 id=62 data-nosnippet>62</a> <span class="kw">fn </span>as_any(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span><span class="kw">dyn </span>Any {
<a href=#63 id=63 data-nosnippet>63</a> <span class="self">self
<a href=#64 id=64 data-nosnippet>64</a> </span>}
<a href=#65 id=65 data-nosnippet>65</a>}
</code></pre></div></section></main></body></html>
+822
View File
@@ -0,0 +1,822 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/common/runtime/src/global.rs`."><title>global.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="common_runtime" data-themes="" data-resource-suffix="" data-rustdoc-version="1.96.1 (31fca3adb 2026-06-26)" data-channel="1.96.1" data-search-js="search-b5634cc7.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../../static.files/storage-41dd4d93.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-5013f961.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-f7c3ffd8.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content" tabindex="-1"><div class="main-heading"><h1><div class="sub-heading">common_runtime/</div>global.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="comment">// Copyright 2023 Greptime Team
<a href=#2 id=2 data-nosnippet>2</a>//
<a href=#3 id=3 data-nosnippet>3</a>// Licensed under the Apache License, Version 2.0 (the "License");
<a href=#4 id=4 data-nosnippet>4</a>// you may not use this file except in compliance with the License.
<a href=#5 id=5 data-nosnippet>5</a>// You may obtain a copy of the License at
<a href=#6 id=6 data-nosnippet>6</a>//
<a href=#7 id=7 data-nosnippet>7</a>// http://www.apache.org/licenses/LICENSE-2.0
<a href=#8 id=8 data-nosnippet>8</a>//
<a href=#9 id=9 data-nosnippet>9</a>// Unless required by applicable law or agreed to in writing, software
<a href=#10 id=10 data-nosnippet>10</a>// distributed under the License is distributed on an "AS IS" BASIS,
<a href=#11 id=11 data-nosnippet>11</a>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<a href=#12 id=12 data-nosnippet>12</a>// See the License for the specific language governing permissions and
<a href=#13 id=13 data-nosnippet>13</a>// limitations under the License.
<a href=#14 id=14 data-nosnippet>14</a>
<a href=#15 id=15 data-nosnippet>15</a></span><span class="doccomment">//! Global runtimes
<a href=#16 id=16 data-nosnippet>16</a></span><span class="kw">use </span>std::collections::BTreeMap;
<a href=#17 id=17 data-nosnippet>17</a><span class="kw">use </span>std::future::Future;
<a href=#18 id=18 data-nosnippet>18</a><span class="kw">use </span>std::num::{NonZeroU32, NonZeroUsize};
<a href=#19 id=19 data-nosnippet>19</a><span class="kw">use </span>std::sync::{Mutex, Once};
<a href=#20 id=20 data-nosnippet>20</a>
<a href=#21 id=21 data-nosnippet>21</a><span class="kw">use </span>catio::{Scheduler, SchedulerStats, TaskClass};
<a href=#22 id=22 data-nosnippet>22</a><span class="kw">use </span>common_telemetry::{info, warn};
<a href=#23 id=23 data-nosnippet>23</a><span class="kw">use </span>once_cell::sync::Lazy;
<a href=#24 id=24 data-nosnippet>24</a><span class="kw">use </span>paste::paste;
<a href=#25 id=25 data-nosnippet>25</a><span class="kw">use </span>serde::{Deserialize, Serialize};
<a href=#26 id=26 data-nosnippet>26</a><span class="kw">use </span>tokio::runtime::Handle;
<a href=#27 id=27 data-nosnippet>27</a>
<a href=#28 id=28 data-nosnippet>28</a><span class="kw">use </span><span class="kw">crate</span>::metrics::register_workload_scheduler_metrics;
<a href=#29 id=29 data-nosnippet>29</a><span class="kw">use </span><span class="kw">crate</span>::runtime::{BuilderBuild, RuntimeTrait};
<a href=#30 id=30 data-nosnippet>30</a><span class="kw">use </span>crate::{Builder, JoinHandle, Runtime};
<a href=#31 id=31 data-nosnippet>31</a>
<a href=#32 id=32 data-nosnippet>32</a><span class="kw">const </span>GLOBAL_WORKERS: usize = <span class="number">8</span>;
<a href=#33 id=33 data-nosnippet>33</a><span class="kw">const </span>COMPACT_WORKERS: usize = <span class="number">4</span>;
<a href=#34 id=34 data-nosnippet>34</a><span class="kw">const </span>HB_WORKERS: usize = <span class="number">2</span>;
<a href=#35 id=35 data-nosnippet>35</a><span class="doccomment">/// The minimum number of worker threads for runtimes sized by CPU count.
<a href=#36 id=36 data-nosnippet>36</a>/// A single-threaded runtime can easily deadlock in async code.
<a href=#37 id=37 data-nosnippet>37</a></span><span class="kw">const </span>MIN_RUNTIME_THREADS: usize = <span class="number">2</span>;
<a href=#38 id=38 data-nosnippet>38</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const </span>QUERY_TASK_CLASS: TaskClass = TaskClass::new(<span class="number">1</span>);
<a href=#39 id=39 data-nosnippet>39</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const </span>WRITE_TASK_CLASS: TaskClass = TaskClass::new(<span class="number">2</span>);
<a href=#40 id=40 data-nosnippet>40</a>
<a href=#41 id=41 data-nosnippet>41</a><span class="doccomment">/// Experimental options for sharing Tokio capacity between query and write
<a href=#42 id=42 data-nosnippet>42</a>/// workloads.
<a href=#43 id=43 data-nosnippet>43</a></span><span class="attr">#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
<a href=#44 id=44 data-nosnippet>44</a>#[serde(default)]
<a href=#45 id=45 data-nosnippet>45</a></span><span class="kw">pub struct </span>WorkloadSchedulerOptions {
<a href=#46 id=46 data-nosnippet>46</a> <span class="doccomment">/// Enables policy-controlled query and write task spawning.
<a href=#47 id=47 data-nosnippet>47</a> </span><span class="kw">pub </span>enable: bool,
<a href=#48 id=48 data-nosnippet>48</a> <span class="doccomment">/// Relative share for query polls while writes are also backlogged.
<a href=#49 id=49 data-nosnippet>49</a> </span><span class="kw">pub </span>query_weight: NonZeroU32,
<a href=#50 id=50 data-nosnippet>50</a> <span class="doccomment">/// Relative share for write polls while queries are also backlogged.
<a href=#51 id=51 data-nosnippet>51</a> </span><span class="kw">pub </span>write_weight: NonZeroU32,
<a href=#52 id=52 data-nosnippet>52</a> <span class="doccomment">/// Number of polls between scheduler fairness samples.
<a href=#53 id=53 data-nosnippet>53</a> </span><span class="kw">pub </span>sample_every_polls: NonZeroUsize,
<a href=#54 id=54 data-nosnippet>54</a>}
<a href=#55 id=55 data-nosnippet>55</a>
<a href=#56 id=56 data-nosnippet>56</a><span class="kw">impl </span>Default <span class="kw">for </span>WorkloadSchedulerOptions {
<a href=#57 id=57 data-nosnippet>57</a> <span class="kw">fn </span>default() -&gt; <span class="self">Self </span>{
<a href=#58 id=58 data-nosnippet>58</a> <span class="self">Self </span>{
<a href=#59 id=59 data-nosnippet>59</a> enable: <span class="bool-val">false</span>,
<a href=#60 id=60 data-nosnippet>60</a> query_weight: NonZeroU32::new(<span class="number">2</span>).unwrap(),
<a href=#61 id=61 data-nosnippet>61</a> write_weight: NonZeroU32::new(<span class="number">8</span>).unwrap(),
<a href=#62 id=62 data-nosnippet>62</a> sample_every_polls: NonZeroUsize::new(<span class="number">16</span>).unwrap(),
<a href=#63 id=63 data-nosnippet>63</a> }
<a href=#64 id=64 data-nosnippet>64</a> }
<a href=#65 id=65 data-nosnippet>65</a>}
<a href=#66 id=66 data-nosnippet>66</a>
<a href=#67 id=67 data-nosnippet>67</a><span class="doccomment">/// The options for the global runtimes.
<a href=#68 id=68 data-nosnippet>68</a></span><span class="attr">#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
<a href=#69 id=69 data-nosnippet>69</a>#[serde(default)]
<a href=#70 id=70 data-nosnippet>70</a></span><span class="kw">pub struct </span>RuntimeOptions {
<a href=#71 id=71 data-nosnippet>71</a> <span class="doccomment">/// The number of threads for the global default runtime.
<a href=#72 id=72 data-nosnippet>72</a> </span><span class="kw">pub </span>global_rt_size: usize,
<a href=#73 id=73 data-nosnippet>73</a> <span class="doccomment">/// The number of threads to execute the runtime for compact operations.
<a href=#74 id=74 data-nosnippet>74</a> </span><span class="kw">pub </span>compact_rt_size: usize,
<a href=#75 id=75 data-nosnippet>75</a> <span class="doccomment">/// The maximum number of blocking threads for compact operations.
<a href=#76 id=76 data-nosnippet>76</a> </span><span class="kw">pub </span>compact_rt_max_blocking_threads: usize,
<a href=#77 id=77 data-nosnippet>77</a> <span class="doccomment">/// The number of threads to execute datanode query operations.
<a href=#78 id=78 data-nosnippet>78</a> </span><span class="kw">pub </span>query_rt_size: usize,
<a href=#79 id=79 data-nosnippet>79</a> <span class="doccomment">/// The number of threads to execute datanode ingestion operations.
<a href=#80 id=80 data-nosnippet>80</a> </span><span class="kw">pub </span>ingest_rt_size: usize,
<a href=#81 id=81 data-nosnippet>81</a> <span class="doccomment">/// Experimental weighted scheduler for query and write workloads.
<a href=#82 id=82 data-nosnippet>82</a> </span><span class="kw">pub </span>experimental_workload_scheduler: WorkloadSchedulerOptions,
<a href=#83 id=83 data-nosnippet>83</a>}
<a href=#84 id=84 data-nosnippet>84</a>
<a href=#85 id=85 data-nosnippet>85</a><span class="kw">impl </span>RuntimeOptions {
<a href=#86 id=86 data-nosnippet>86</a> <span class="kw">fn </span>with_num_cpus(cpus: usize) -&gt; <span class="self">Self </span>{
<a href=#87 id=87 data-nosnippet>87</a> <span class="kw">let </span>cpus = usize::max(cpus, MIN_RUNTIME_THREADS);
<a href=#88 id=88 data-nosnippet>88</a> <span class="self">Self </span>{
<a href=#89 id=89 data-nosnippet>89</a> global_rt_size: cpus,
<a href=#90 id=90 data-nosnippet>90</a> compact_rt_size: usize::max(cpus / <span class="number">2</span>, MIN_RUNTIME_THREADS),
<a href=#91 id=91 data-nosnippet>91</a> compact_rt_max_blocking_threads: usize::max(cpus / <span class="number">2</span>, MIN_RUNTIME_THREADS),
<a href=#92 id=92 data-nosnippet>92</a> query_rt_size: usize::max(cpus.saturating_sub(<span class="number">1</span>), MIN_RUNTIME_THREADS),
<a href=#93 id=93 data-nosnippet>93</a> ingest_rt_size: cpus,
<a href=#94 id=94 data-nosnippet>94</a> experimental_workload_scheduler: WorkloadSchedulerOptions::default(),
<a href=#95 id=95 data-nosnippet>95</a> }
<a href=#96 id=96 data-nosnippet>96</a> }
<a href=#97 id=97 data-nosnippet>97</a>}
<a href=#98 id=98 data-nosnippet>98</a>
<a href=#99 id=99 data-nosnippet>99</a><span class="kw">impl </span>Default <span class="kw">for </span>RuntimeOptions {
<a href=#100 id=100 data-nosnippet>100</a> <span class="kw">fn </span>default() -&gt; <span class="self">Self </span>{
<a href=#101 id=101 data-nosnippet>101</a> <span class="self">Self</span>::with_num_cpus(num_cpus::get())
<a href=#102 id=102 data-nosnippet>102</a> }
<a href=#103 id=103 data-nosnippet>103</a>}
<a href=#104 id=104 data-nosnippet>104</a>
<a href=#105 id=105 data-nosnippet>105</a><span class="kw">pub fn </span>create_runtime(runtime_name: <span class="kw-2">&amp;</span>str, thread_name: <span class="kw-2">&amp;</span>str, worker_threads: usize) -&gt; Runtime {
<a href=#106 id=106 data-nosnippet>106</a> <span class="macro">info!</span>(
<a href=#107 id=107 data-nosnippet>107</a> <span class="string">"Creating runtime with runtime_name: {runtime_name}, thread_name: {thread_name}, work_threads: {worker_threads}."
<a href=#108 id=108 data-nosnippet>108</a> </span>);
<a href=#109 id=109 data-nosnippet>109</a> Builder::default()
<a href=#110 id=110 data-nosnippet>110</a> .runtime_name(runtime_name)
<a href=#111 id=111 data-nosnippet>111</a> .thread_name(thread_name)
<a href=#112 id=112 data-nosnippet>112</a> .worker_threads(worker_threads)
<a href=#113 id=113 data-nosnippet>113</a> .build()
<a href=#114 id=114 data-nosnippet>114</a> .expect(<span class="string">"Fail to create runtime"</span>)
<a href=#115 id=115 data-nosnippet>115</a>}
<a href=#116 id=116 data-nosnippet>116</a>
<a href=#117 id=117 data-nosnippet>117</a><span class="kw">fn </span>create_compact_runtime(
<a href=#118 id=118 data-nosnippet>118</a> runtime_name: <span class="kw-2">&amp;</span>str,
<a href=#119 id=119 data-nosnippet>119</a> thread_name: <span class="kw-2">&amp;</span>str,
<a href=#120 id=120 data-nosnippet>120</a> worker_threads: usize,
<a href=#121 id=121 data-nosnippet>121</a> max_blocking_threads: usize,
<a href=#122 id=122 data-nosnippet>122</a>) -&gt; Runtime {
<a href=#123 id=123 data-nosnippet>123</a> <span class="kw">let </span>max_blocking_threads = max_blocking_threads.max(<span class="number">1</span>);
<a href=#124 id=124 data-nosnippet>124</a> <span class="macro">info!</span>(
<a href=#125 id=125 data-nosnippet>125</a> <span class="string">"Creating compact runtime with runtime_name: {runtime_name}, thread_name: {thread_name}, work_threads: {worker_threads}, max_blocking_threads: {max_blocking_threads}."
<a href=#126 id=126 data-nosnippet>126</a> </span>);
<a href=#127 id=127 data-nosnippet>127</a> Builder::default()
<a href=#128 id=128 data-nosnippet>128</a> .runtime_name(runtime_name)
<a href=#129 id=129 data-nosnippet>129</a> .thread_name(thread_name)
<a href=#130 id=130 data-nosnippet>130</a> .worker_threads(worker_threads)
<a href=#131 id=131 data-nosnippet>131</a> .max_blocking_threads(max_blocking_threads)
<a href=#132 id=132 data-nosnippet>132</a> .build()
<a href=#133 id=133 data-nosnippet>133</a> .expect(<span class="string">"Fail to create runtime"</span>)
<a href=#134 id=134 data-nosnippet>134</a>}
<a href=#135 id=135 data-nosnippet>135</a>
<a href=#136 id=136 data-nosnippet>136</a><span class="kw">struct </span>GlobalRuntimes {
<a href=#137 id=137 data-nosnippet>137</a> global_runtime: Runtime,
<a href=#138 id=138 data-nosnippet>138</a> compact_runtime: Runtime,
<a href=#139 id=139 data-nosnippet>139</a> hb_runtime: Runtime,
<a href=#140 id=140 data-nosnippet>140</a> query_runtime: Runtime,
<a href=#141 id=141 data-nosnippet>141</a> ingest_runtime: Runtime,
<a href=#142 id=142 data-nosnippet>142</a> query_handle: Handle,
<a href=#143 id=143 data-nosnippet>143</a> ingest_handle: Handle,
<a href=#144 id=144 data-nosnippet>144</a> workload_scheduler: <span class="prelude-ty">Option</span>&lt;Scheduler&gt;,
<a href=#145 id=145 data-nosnippet>145</a>}
<a href=#146 id=146 data-nosnippet>146</a>
<a href=#147 id=147 data-nosnippet>147</a><span class="macro">macro_rules!</span> define_spawn {
<a href=#148 id=148 data-nosnippet>148</a> (<span class="macro-nonterminal">$type</span>: ident) =&gt; {
<a href=#149 id=149 data-nosnippet>149</a> <span class="macro">paste!</span> {
<a href=#150 id=150 data-nosnippet>150</a>
<a href=#151 id=151 data-nosnippet>151</a> <span class="kw">fn </span>[&lt;spawn_ <span class="macro-nonterminal">$type</span>&gt;]&lt;F&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, future: F) -&gt; JoinHandle&lt;F::Output&gt;
<a href=#152 id=152 data-nosnippet>152</a> <span class="kw">where
<a href=#153 id=153 data-nosnippet>153</a> </span>F: Future + Send + <span class="lifetime">'static</span>,
<a href=#154 id=154 data-nosnippet>154</a> F::Output: Send + <span class="lifetime">'static</span>,
<a href=#155 id=155 data-nosnippet>155</a> {
<a href=#156 id=156 data-nosnippet>156</a> <span class="self">self</span>.[&lt;<span class="macro-nonterminal">$type </span>_runtime&gt;].spawn(future)
<a href=#157 id=157 data-nosnippet>157</a> }
<a href=#158 id=158 data-nosnippet>158</a>
<a href=#159 id=159 data-nosnippet>159</a> <span class="kw">fn </span>[&lt;spawn_blocking_ <span class="macro-nonterminal">$type</span>&gt;]&lt;F, R&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, future: F) -&gt; JoinHandle&lt;R&gt;
<a href=#160 id=160 data-nosnippet>160</a> <span class="kw">where
<a href=#161 id=161 data-nosnippet>161</a> </span>F: FnOnce() -&gt; R + Send + <span class="lifetime">'static</span>,
<a href=#162 id=162 data-nosnippet>162</a> R: Send + <span class="lifetime">'static</span>,
<a href=#163 id=163 data-nosnippet>163</a> {
<a href=#164 id=164 data-nosnippet>164</a> <span class="self">self</span>.[&lt;<span class="macro-nonterminal">$type </span>_runtime&gt;].spawn_blocking(future)
<a href=#165 id=165 data-nosnippet>165</a> }
<a href=#166 id=166 data-nosnippet>166</a>
<a href=#167 id=167 data-nosnippet>167</a> <span class="kw">fn </span>[&lt;block_on_ <span class="macro-nonterminal">$type</span>&gt;]&lt;F: Future&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, future: F) -&gt; F::Output {
<a href=#168 id=168 data-nosnippet>168</a> <span class="self">self</span>.[&lt;<span class="macro-nonterminal">$type </span>_runtime&gt;].block_on(future)
<a href=#169 id=169 data-nosnippet>169</a> }
<a href=#170 id=170 data-nosnippet>170</a> }
<a href=#171 id=171 data-nosnippet>171</a> };
<a href=#172 id=172 data-nosnippet>172</a>}
<a href=#173 id=173 data-nosnippet>173</a>
<a href=#174 id=174 data-nosnippet>174</a><span class="macro">macro_rules!</span> define_scheduled_spawn {
<a href=#175 id=175 data-nosnippet>175</a> (<span class="macro-nonterminal">$type</span>: ident, <span class="macro-nonterminal">$class</span>: ident) =&gt; {
<a href=#176 id=176 data-nosnippet>176</a> <span class="macro">paste!</span> {
<a href=#177 id=177 data-nosnippet>177</a> <span class="kw">fn </span>[&lt;spawn_ <span class="macro-nonterminal">$type</span>&gt;]&lt;F&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, future: F) -&gt; JoinHandle&lt;F::Output&gt;
<a href=#178 id=178 data-nosnippet>178</a> <span class="kw">where
<a href=#179 id=179 data-nosnippet>179</a> </span>F: Future + Send + <span class="lifetime">'static</span>,
<a href=#180 id=180 data-nosnippet>180</a> F::Output: Send + <span class="lifetime">'static</span>,
<a href=#181 id=181 data-nosnippet>181</a> {
<a href=#182 id=182 data-nosnippet>182</a> <span class="kw">match </span><span class="kw-2">&amp;</span><span class="self">self</span>.workload_scheduler {
<a href=#183 id=183 data-nosnippet>183</a> <span class="prelude-val">Some</span>(scheduler) =&gt; scheduler.spawn_in_on(
<a href=#184 id=184 data-nosnippet>184</a> <span class="kw-2">&amp;</span><span class="self">self</span>.[&lt;<span class="macro-nonterminal">$type </span>_handle&gt;],
<a href=#185 id=185 data-nosnippet>185</a> <span class="macro-nonterminal">$class</span>,
<a href=#186 id=186 data-nosnippet>186</a> future,
<a href=#187 id=187 data-nosnippet>187</a> ),
<a href=#188 id=188 data-nosnippet>188</a> <span class="prelude-val">None </span>=&gt; <span class="self">self</span>.[&lt;<span class="macro-nonterminal">$type </span>_runtime&gt;].spawn(future),
<a href=#189 id=189 data-nosnippet>189</a> }
<a href=#190 id=190 data-nosnippet>190</a> }
<a href=#191 id=191 data-nosnippet>191</a>
<a href=#192 id=192 data-nosnippet>192</a> <span class="kw">fn </span>[&lt;spawn_blocking_ <span class="macro-nonterminal">$type</span>&gt;]&lt;F, R&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, future: F) -&gt; JoinHandle&lt;R&gt;
<a href=#193 id=193 data-nosnippet>193</a> <span class="kw">where
<a href=#194 id=194 data-nosnippet>194</a> </span>F: FnOnce() -&gt; R + Send + <span class="lifetime">'static</span>,
<a href=#195 id=195 data-nosnippet>195</a> R: Send + <span class="lifetime">'static</span>,
<a href=#196 id=196 data-nosnippet>196</a> {
<a href=#197 id=197 data-nosnippet>197</a> <span class="self">self</span>.[&lt;<span class="macro-nonterminal">$type </span>_runtime&gt;].spawn_blocking(future)
<a href=#198 id=198 data-nosnippet>198</a> }
<a href=#199 id=199 data-nosnippet>199</a>
<a href=#200 id=200 data-nosnippet>200</a> <span class="kw">fn </span>[&lt;block_on_ <span class="macro-nonterminal">$type</span>&gt;]&lt;F: Future&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, future: F) -&gt; F::Output {
<a href=#201 id=201 data-nosnippet>201</a> <span class="self">self</span>.[&lt;<span class="macro-nonterminal">$type </span>_runtime&gt;].block_on(future)
<a href=#202 id=202 data-nosnippet>202</a> }
<a href=#203 id=203 data-nosnippet>203</a> }
<a href=#204 id=204 data-nosnippet>204</a> };
<a href=#205 id=205 data-nosnippet>205</a>}
<a href=#206 id=206 data-nosnippet>206</a>
<a href=#207 id=207 data-nosnippet>207</a><span class="kw">impl </span>GlobalRuntimes {
<a href=#208 id=208 data-nosnippet>208</a> <span class="macro">define_spawn!</span>(global);
<a href=#209 id=209 data-nosnippet>209</a> <span class="macro">define_spawn!</span>(compact);
<a href=#210 id=210 data-nosnippet>210</a> <span class="macro">define_spawn!</span>(hb);
<a href=#211 id=211 data-nosnippet>211</a> <span class="macro">define_scheduled_spawn!</span>(query, QUERY_TASK_CLASS);
<a href=#212 id=212 data-nosnippet>212</a> <span class="macro">define_scheduled_spawn!</span>(ingest, WRITE_TASK_CLASS);
<a href=#213 id=213 data-nosnippet>213</a>
<a href=#214 id=214 data-nosnippet>214</a> <span class="kw">fn </span>new(
<a href=#215 id=215 data-nosnippet>215</a> global: <span class="prelude-ty">Option</span>&lt;Runtime&gt;,
<a href=#216 id=216 data-nosnippet>216</a> compact: <span class="prelude-ty">Option</span>&lt;Runtime&gt;,
<a href=#217 id=217 data-nosnippet>217</a> heartbeat: <span class="prelude-ty">Option</span>&lt;Runtime&gt;,
<a href=#218 id=218 data-nosnippet>218</a> query: <span class="prelude-ty">Option</span>&lt;Runtime&gt;,
<a href=#219 id=219 data-nosnippet>219</a> ingest: <span class="prelude-ty">Option</span>&lt;Runtime&gt;,
<a href=#220 id=220 data-nosnippet>220</a> workload_scheduler: <span class="prelude-ty">Option</span>&lt;Scheduler&gt;,
<a href=#221 id=221 data-nosnippet>221</a> ) -&gt; <span class="self">Self </span>{
<a href=#222 id=222 data-nosnippet>222</a> <span class="kw">let </span>global_runtime =
<a href=#223 id=223 data-nosnippet>223</a> global.unwrap_or_else(|| create_runtime(<span class="string">"global"</span>, <span class="string">"global-worker"</span>, GLOBAL_WORKERS));
<a href=#224 id=224 data-nosnippet>224</a> <span class="kw">let </span>query_runtime = query.unwrap_or_else(|| global_runtime.clone());
<a href=#225 id=225 data-nosnippet>225</a> <span class="kw">let </span>ingest_runtime = ingest.unwrap_or_else(|| global_runtime.clone());
<a href=#226 id=226 data-nosnippet>226</a> <span class="kw">let </span>query_handle = query_runtime.handle();
<a href=#227 id=227 data-nosnippet>227</a> <span class="kw">let </span>ingest_handle = ingest_runtime.handle();
<a href=#228 id=228 data-nosnippet>228</a> <span class="self">Self </span>{
<a href=#229 id=229 data-nosnippet>229</a> global_runtime,
<a href=#230 id=230 data-nosnippet>230</a> compact_runtime: compact.unwrap_or_else(|| {
<a href=#231 id=231 data-nosnippet>231</a> <span class="kw">let </span>max_blocking_threads =
<a href=#232 id=232 data-nosnippet>232</a> RuntimeOptions::default().compact_rt_max_blocking_threads;
<a href=#233 id=233 data-nosnippet>233</a> create_compact_runtime(
<a href=#234 id=234 data-nosnippet>234</a> <span class="string">"compact"</span>,
<a href=#235 id=235 data-nosnippet>235</a> <span class="string">"compact-worker"</span>,
<a href=#236 id=236 data-nosnippet>236</a> COMPACT_WORKERS,
<a href=#237 id=237 data-nosnippet>237</a> max_blocking_threads,
<a href=#238 id=238 data-nosnippet>238</a> )
<a href=#239 id=239 data-nosnippet>239</a> }),
<a href=#240 id=240 data-nosnippet>240</a> hb_runtime: heartbeat
<a href=#241 id=241 data-nosnippet>241</a> .unwrap_or_else(|| create_runtime(<span class="string">"heartbeat"</span>, <span class="string">"hb-worker"</span>, HB_WORKERS)),
<a href=#242 id=242 data-nosnippet>242</a> query_runtime,
<a href=#243 id=243 data-nosnippet>243</a> ingest_runtime,
<a href=#244 id=244 data-nosnippet>244</a> query_handle,
<a href=#245 id=245 data-nosnippet>245</a> ingest_handle,
<a href=#246 id=246 data-nosnippet>246</a> workload_scheduler,
<a href=#247 id=247 data-nosnippet>247</a> }
<a href=#248 id=248 data-nosnippet>248</a> }
<a href=#249 id=249 data-nosnippet>249</a>}
<a href=#250 id=250 data-nosnippet>250</a>
<a href=#251 id=251 data-nosnippet>251</a><span class="attr">#[derive(Default)]
<a href=#252 id=252 data-nosnippet>252</a></span><span class="kw">struct </span>ConfigRuntimes {
<a href=#253 id=253 data-nosnippet>253</a> global_runtime: <span class="prelude-ty">Option</span>&lt;Runtime&gt;,
<a href=#254 id=254 data-nosnippet>254</a> compact_runtime: <span class="prelude-ty">Option</span>&lt;Runtime&gt;,
<a href=#255 id=255 data-nosnippet>255</a> hb_runtime: <span class="prelude-ty">Option</span>&lt;Runtime&gt;,
<a href=#256 id=256 data-nosnippet>256</a> query_runtime: <span class="prelude-ty">Option</span>&lt;Runtime&gt;,
<a href=#257 id=257 data-nosnippet>257</a> ingest_runtime: <span class="prelude-ty">Option</span>&lt;Runtime&gt;,
<a href=#258 id=258 data-nosnippet>258</a> workload_scheduler: <span class="prelude-ty">Option</span>&lt;Scheduler&gt;,
<a href=#259 id=259 data-nosnippet>259</a> already_init: bool,
<a href=#260 id=260 data-nosnippet>260</a>}
<a href=#261 id=261 data-nosnippet>261</a>
<a href=#262 id=262 data-nosnippet>262</a><span class="kw">static </span>GLOBAL_RUNTIMES: Lazy&lt;GlobalRuntimes&gt; = Lazy::new(|| {
<a href=#263 id=263 data-nosnippet>263</a> <span class="kw">let </span><span class="kw-2">mut </span>c = CONFIG_RUNTIMES.lock().unwrap();
<a href=#264 id=264 data-nosnippet>264</a> <span class="kw">let </span>global = c.global_runtime.take();
<a href=#265 id=265 data-nosnippet>265</a> <span class="kw">let </span>compact = c.compact_runtime.take();
<a href=#266 id=266 data-nosnippet>266</a> <span class="kw">let </span>heartbeat = c.hb_runtime.take();
<a href=#267 id=267 data-nosnippet>267</a> <span class="kw">let </span>query = c.query_runtime.take();
<a href=#268 id=268 data-nosnippet>268</a> <span class="kw">let </span>ingest = c.ingest_runtime.take();
<a href=#269 id=269 data-nosnippet>269</a> <span class="kw">let </span>workload_scheduler = c.workload_scheduler.take();
<a href=#270 id=270 data-nosnippet>270</a> c.already_init = <span class="bool-val">true</span>;
<a href=#271 id=271 data-nosnippet>271</a>
<a href=#272 id=272 data-nosnippet>272</a> GlobalRuntimes::new(
<a href=#273 id=273 data-nosnippet>273</a> global,
<a href=#274 id=274 data-nosnippet>274</a> compact,
<a href=#275 id=275 data-nosnippet>275</a> heartbeat,
<a href=#276 id=276 data-nosnippet>276</a> query,
<a href=#277 id=277 data-nosnippet>277</a> ingest,
<a href=#278 id=278 data-nosnippet>278</a> workload_scheduler,
<a href=#279 id=279 data-nosnippet>279</a> )
<a href=#280 id=280 data-nosnippet>280</a>});
<a href=#281 id=281 data-nosnippet>281</a>
<a href=#282 id=282 data-nosnippet>282</a><span class="kw">static </span>CONFIG_RUNTIMES: Lazy&lt;Mutex&lt;ConfigRuntimes&gt;&gt; =
<a href=#283 id=283 data-nosnippet>283</a> Lazy::new(|| Mutex::new(ConfigRuntimes::default()));
<a href=#284 id=284 data-nosnippet>284</a><span class="kw">static </span>START: Once = Once::new();
<a href=#285 id=285 data-nosnippet>285</a>
<a href=#286 id=286 data-nosnippet>286</a><span class="doccomment">/// Initialize runtimes for frontend, metasrv, and flownode processes.
<a href=#287 id=287 data-nosnippet>287</a>///
<a href=#288 id=288 data-nosnippet>288</a>/// Query and ingest work share the global runtime and no workload scheduler is
<a href=#289 id=289 data-nosnippet>289</a>/// constructed for these process roles.
<a href=#290 id=290 data-nosnippet>290</a></span><span class="kw">pub fn </span>init_global_runtimes(options: <span class="kw-2">&amp;</span>RuntimeOptions) {
<a href=#291 id=291 data-nosnippet>291</a> START.call_once(|| {
<a href=#292 id=292 data-nosnippet>292</a> <span class="kw">let </span><span class="kw-2">mut </span>c = CONFIG_RUNTIMES.lock().unwrap();
<a href=#293 id=293 data-nosnippet>293</a> <span class="macro">assert!</span>(!c.already_init, <span class="string">"Global runtimes already initialized"</span>);
<a href=#294 id=294 data-nosnippet>294</a> init_common_runtimes(<span class="kw-2">&amp;mut </span>c, options);
<a href=#295 id=295 data-nosnippet>295</a> c.already_init = <span class="bool-val">true</span>;
<a href=#296 id=296 data-nosnippet>296</a> });
<a href=#297 id=297 data-nosnippet>297</a>}
<a href=#298 id=298 data-nosnippet>298</a>
<a href=#299 id=299 data-nosnippet>299</a><span class="doccomment">/// Initialize runtimes for a standalone process.
<a href=#300 id=300 data-nosnippet>300</a>///
<a href=#301 id=301 data-nosnippet>301</a>/// Query and ingest work share the global runtime. The scheduler is always
<a href=#302 id=302 data-nosnippet>302</a>/// constructed, with the global runtime size as its internal bound, and starts
<a href=#303 id=303 data-nosnippet>303</a>/// enabled according to configuration.
<a href=#304 id=304 data-nosnippet>304</a></span><span class="kw">pub fn </span>init_standalone_runtimes(options: <span class="kw-2">&amp;</span>RuntimeOptions) {
<a href=#305 id=305 data-nosnippet>305</a> START.call_once(|| {
<a href=#306 id=306 data-nosnippet>306</a> <span class="kw">let </span><span class="kw-2">mut </span>c = CONFIG_RUNTIMES.lock().unwrap();
<a href=#307 id=307 data-nosnippet>307</a> <span class="macro">assert!</span>(!c.already_init, <span class="string">"Global runtimes already initialized"</span>);
<a href=#308 id=308 data-nosnippet>308</a> init_common_runtimes(<span class="kw-2">&amp;mut </span>c, options);
<a href=#309 id=309 data-nosnippet>309</a> c.workload_scheduler = <span class="prelude-val">Some</span>(create_workload_scheduler(options, options.global_rt_size));
<a href=#310 id=310 data-nosnippet>310</a> c.already_init = <span class="bool-val">true</span>;
<a href=#311 id=311 data-nosnippet>311</a> });
<a href=#312 id=312 data-nosnippet>312</a>}
<a href=#313 id=313 data-nosnippet>313</a>
<a href=#314 id=314 data-nosnippet>314</a><span class="doccomment">/// Initialize runtimes for a datanode process.
<a href=#315 id=315 data-nosnippet>315</a>///
<a href=#316 id=316 data-nosnippet>316</a>/// Query and ingest use dedicated runtimes. The scheduler is always
<a href=#317 id=317 data-nosnippet>317</a>/// constructed with their checked combined size as its internal bound, and
<a href=#318 id=318 data-nosnippet>318</a>/// starts enabled according to configuration.
<a href=#319 id=319 data-nosnippet>319</a>///
<a href=#320 id=320 data-nosnippet>320</a>/// # Panics
<a href=#321 id=321 data-nosnippet>321</a>///
<a href=#322 id=322 data-nosnippet>322</a>/// Panics if the configured query and ingest runtime sizes overflow `usize`
<a href=#323 id=323 data-nosnippet>323</a>/// when combined.
<a href=#324 id=324 data-nosnippet>324</a></span><span class="kw">pub fn </span>init_datanode_runtimes(options: <span class="kw-2">&amp;</span>RuntimeOptions) {
<a href=#325 id=325 data-nosnippet>325</a> <span class="kw">let </span>capacity = options
<a href=#326 id=326 data-nosnippet>326</a> .query_rt_size
<a href=#327 id=327 data-nosnippet>327</a> .checked_add(options.ingest_rt_size)
<a href=#328 id=328 data-nosnippet>328</a> .expect(<span class="string">"datanode workload scheduler runtime capacity overflowed usize"</span>);
<a href=#329 id=329 data-nosnippet>329</a> START.call_once(|| {
<a href=#330 id=330 data-nosnippet>330</a> <span class="kw">let </span><span class="kw-2">mut </span>c = CONFIG_RUNTIMES.lock().unwrap();
<a href=#331 id=331 data-nosnippet>331</a> <span class="macro">assert!</span>(!c.already_init, <span class="string">"Global runtimes already initialized"</span>);
<a href=#332 id=332 data-nosnippet>332</a> init_common_runtimes(<span class="kw-2">&amp;mut </span>c, options);
<a href=#333 id=333 data-nosnippet>333</a> c.query_runtime = <span class="prelude-val">Some</span>(create_runtime(
<a href=#334 id=334 data-nosnippet>334</a> <span class="string">"query"</span>,
<a href=#335 id=335 data-nosnippet>335</a> <span class="string">"query-worker"</span>,
<a href=#336 id=336 data-nosnippet>336</a> options.query_rt_size,
<a href=#337 id=337 data-nosnippet>337</a> ));
<a href=#338 id=338 data-nosnippet>338</a> c.ingest_runtime = <span class="prelude-val">Some</span>(create_runtime(
<a href=#339 id=339 data-nosnippet>339</a> <span class="string">"ingest"</span>,
<a href=#340 id=340 data-nosnippet>340</a> <span class="string">"ingest-worker"</span>,
<a href=#341 id=341 data-nosnippet>341</a> options.ingest_rt_size,
<a href=#342 id=342 data-nosnippet>342</a> ));
<a href=#343 id=343 data-nosnippet>343</a> c.workload_scheduler = <span class="prelude-val">Some</span>(create_workload_scheduler(options, capacity));
<a href=#344 id=344 data-nosnippet>344</a> c.already_init = <span class="bool-val">true</span>;
<a href=#345 id=345 data-nosnippet>345</a> });
<a href=#346 id=346 data-nosnippet>346</a>}
<a href=#347 id=347 data-nosnippet>347</a>
<a href=#348 id=348 data-nosnippet>348</a><span class="kw">fn </span>init_common_runtimes(c: <span class="kw-2">&amp;mut </span>ConfigRuntimes, options: <span class="kw-2">&amp;</span>RuntimeOptions) {
<a href=#349 id=349 data-nosnippet>349</a> c.global_runtime = <span class="prelude-val">Some</span>(create_runtime(
<a href=#350 id=350 data-nosnippet>350</a> <span class="string">"global"</span>,
<a href=#351 id=351 data-nosnippet>351</a> <span class="string">"global-worker"</span>,
<a href=#352 id=352 data-nosnippet>352</a> options.global_rt_size,
<a href=#353 id=353 data-nosnippet>353</a> ));
<a href=#354 id=354 data-nosnippet>354</a> c.compact_runtime = <span class="prelude-val">Some</span>(create_compact_runtime(
<a href=#355 id=355 data-nosnippet>355</a> <span class="string">"compact"</span>,
<a href=#356 id=356 data-nosnippet>356</a> <span class="string">"compact-worker"</span>,
<a href=#357 id=357 data-nosnippet>357</a> options.compact_rt_size,
<a href=#358 id=358 data-nosnippet>358</a> options.compact_rt_max_blocking_threads,
<a href=#359 id=359 data-nosnippet>359</a> ));
<a href=#360 id=360 data-nosnippet>360</a> c.hb_runtime = <span class="prelude-val">Some</span>(create_runtime(<span class="string">"heartbeat"</span>, <span class="string">"hb-worker"</span>, HB_WORKERS));
<a href=#361 id=361 data-nosnippet>361</a>}
<a href=#362 id=362 data-nosnippet>362</a>
<a href=#363 id=363 data-nosnippet>363</a><span class="kw">fn </span>create_workload_scheduler(options: <span class="kw-2">&amp;</span>RuntimeOptions, capacity: usize) -&gt; Scheduler {
<a href=#364 id=364 data-nosnippet>364</a> <span class="macro">assert!</span>(
<a href=#365 id=365 data-nosnippet>365</a> capacity &gt; <span class="number">0</span>,
<a href=#366 id=366 data-nosnippet>366</a> <span class="string">"experimental workload scheduler capacity must be greater than zero"
<a href=#367 id=367 data-nosnippet>367</a> </span>);
<a href=#368 id=368 data-nosnippet>368</a> <span class="kw">let </span>scheduler_options = <span class="kw-2">&amp;</span>options.experimental_workload_scheduler;
<a href=#369 id=369 data-nosnippet>369</a> <span class="kw">let </span>scheduler = Scheduler::builder()
<a href=#370 id=370 data-nosnippet>370</a> <span class="comment">// This is deliberately an internal scheduler bound, not public config.
<a href=#371 id=371 data-nosnippet>371</a> </span>.max_concurrent_polls(capacity)
<a href=#372 id=372 data-nosnippet>372</a> .sample_every_polls(scheduler_options.sample_every_polls.get())
<a href=#373 id=373 data-nosnippet>373</a> .weight(QUERY_TASK_CLASS, scheduler_options.query_weight.get())
<a href=#374 id=374 data-nosnippet>374</a> .weight(WRITE_TASK_CLASS, scheduler_options.write_weight.get())
<a href=#375 id=375 data-nosnippet>375</a> .build();
<a href=#376 id=376 data-nosnippet>376</a> scheduler.set_enabled(scheduler_options.enable);
<a href=#377 id=377 data-nosnippet>377</a> register_workload_scheduler_metrics(scheduler.clone());
<a href=#378 id=378 data-nosnippet>378</a> <span class="macro">info!</span>(
<a href=#379 id=379 data-nosnippet>379</a> <span class="string">"Constructed the experimental workload scheduler: internal_capacity={}, \
<a href=#380 id=380 data-nosnippet>380</a> query_weight={}, write_weight={}, sample_every_polls={}, enabled={}"</span>,
<a href=#381 id=381 data-nosnippet>381</a> capacity,
<a href=#382 id=382 data-nosnippet>382</a> scheduler_options.query_weight,
<a href=#383 id=383 data-nosnippet>383</a> scheduler_options.write_weight,
<a href=#384 id=384 data-nosnippet>384</a> scheduler_options.sample_every_polls,
<a href=#385 id=385 data-nosnippet>385</a> scheduler_options.enable
<a href=#386 id=386 data-nosnippet>386</a> );
<a href=#387 id=387 data-nosnippet>387</a> scheduler
<a href=#388 id=388 data-nosnippet>388</a>}
<a href=#389 id=389 data-nosnippet>389</a>
<a href=#390 id=390 data-nosnippet>390</a><span class="macro">macro_rules!</span> define_global_runtime_spawn {
<a href=#391 id=391 data-nosnippet>391</a> (<span class="macro-nonterminal">$type</span>: ident) =&gt; {
<a href=#392 id=392 data-nosnippet>392</a> <span class="macro">paste!</span> {
<a href=#393 id=393 data-nosnippet>393</a> <span class="attr">#[doc = <span class="string">"Returns the global `" </span><span class="macro-nonterminal">$type </span><span class="string">"` thread pool."</span>]
<a href=#394 id=394 data-nosnippet>394</a> </span><span class="kw">pub fn </span>[&lt;<span class="macro-nonterminal">$type </span>_runtime&gt;]() -&gt; Runtime {
<a href=#395 id=395 data-nosnippet>395</a> GLOBAL_RUNTIMES.[&lt;<span class="macro-nonterminal">$type </span>_runtime&gt;].clone()
<a href=#396 id=396 data-nosnippet>396</a> }
<a href=#397 id=397 data-nosnippet>397</a>
<a href=#398 id=398 data-nosnippet>398</a> <span class="attr">#[doc = <span class="string">"Spawn a future and execute it in `" </span><span class="macro-nonterminal">$type </span><span class="string">"` thread pool."</span>]
<a href=#399 id=399 data-nosnippet>399</a> </span><span class="kw">pub fn </span>[&lt;spawn_ <span class="macro-nonterminal">$type</span>&gt;]&lt;F&gt;(future: F) -&gt; JoinHandle&lt;F::Output&gt;
<a href=#400 id=400 data-nosnippet>400</a> <span class="kw">where
<a href=#401 id=401 data-nosnippet>401</a> </span>F: Future + Send + <span class="lifetime">'static</span>,
<a href=#402 id=402 data-nosnippet>402</a> F::Output: Send + <span class="lifetime">'static</span>,
<a href=#403 id=403 data-nosnippet>403</a> {
<a href=#404 id=404 data-nosnippet>404</a> GLOBAL_RUNTIMES.[&lt;spawn_ <span class="macro-nonterminal">$type</span>&gt;](future)
<a href=#405 id=405 data-nosnippet>405</a> }
<a href=#406 id=406 data-nosnippet>406</a>
<a href=#407 id=407 data-nosnippet>407</a> <span class="attr">#[doc = <span class="string">"Run the blocking operation in `" </span><span class="macro-nonterminal">$type </span><span class="string">"` thread pool."</span>]
<a href=#408 id=408 data-nosnippet>408</a> </span><span class="kw">pub fn </span>[&lt;spawn_blocking_ <span class="macro-nonterminal">$type</span>&gt;]&lt;F, R&gt;(future: F) -&gt; JoinHandle&lt;R&gt;
<a href=#409 id=409 data-nosnippet>409</a> <span class="kw">where
<a href=#410 id=410 data-nosnippet>410</a> </span>F: FnOnce() -&gt; R + Send + <span class="lifetime">'static</span>,
<a href=#411 id=411 data-nosnippet>411</a> R: Send + <span class="lifetime">'static</span>,
<a href=#412 id=412 data-nosnippet>412</a> {
<a href=#413 id=413 data-nosnippet>413</a> GLOBAL_RUNTIMES.[&lt;spawn_blocking_ <span class="macro-nonterminal">$type</span>&gt;](future)
<a href=#414 id=414 data-nosnippet>414</a> }
<a href=#415 id=415 data-nosnippet>415</a>
<a href=#416 id=416 data-nosnippet>416</a> <span class="attr">#[doc = <span class="string">"Run a future to complete in `" </span><span class="macro-nonterminal">$type </span><span class="string">"` thread pool."</span>]
<a href=#417 id=417 data-nosnippet>417</a> </span><span class="kw">pub fn </span>[&lt;block_on_ <span class="macro-nonterminal">$type</span>&gt;]&lt;F: Future&gt;(future: F) -&gt; F::Output {
<a href=#418 id=418 data-nosnippet>418</a> GLOBAL_RUNTIMES.[&lt;block_on_ <span class="macro-nonterminal">$type</span>&gt;](future)
<a href=#419 id=419 data-nosnippet>419</a> }
<a href=#420 id=420 data-nosnippet>420</a> }
<a href=#421 id=421 data-nosnippet>421</a> };
<a href=#422 id=422 data-nosnippet>422</a>}
<a href=#423 id=423 data-nosnippet>423</a>
<a href=#424 id=424 data-nosnippet>424</a><span class="macro">define_global_runtime_spawn!</span>(global);
<a href=#425 id=425 data-nosnippet>425</a><span class="macro">define_global_runtime_spawn!</span>(compact);
<a href=#426 id=426 data-nosnippet>426</a><span class="macro">define_global_runtime_spawn!</span>(hb);
<a href=#427 id=427 data-nosnippet>427</a><span class="macro">define_global_runtime_spawn!</span>(query);
<a href=#428 id=428 data-nosnippet>428</a><span class="macro">define_global_runtime_spawn!</span>(ingest);
<a href=#429 id=429 data-nosnippet>429</a>
<a href=#430 id=430 data-nosnippet>430</a><span class="doccomment">/// Returns whether the experimental workload scheduler is currently enabled.
<a href=#431 id=431 data-nosnippet>431</a>/// Returns `false` when no scheduler was constructed at startup.
<a href=#432 id=432 data-nosnippet>432</a></span><span class="kw">pub fn </span>workload_scheduler_enabled() -&gt; bool {
<a href=#433 id=433 data-nosnippet>433</a> GLOBAL_RUNTIMES
<a href=#434 id=434 data-nosnippet>434</a> .workload_scheduler
<a href=#435 id=435 data-nosnippet>435</a> .as_ref()
<a href=#436 id=436 data-nosnippet>436</a> .is_some_and(Scheduler::is_enabled)
<a href=#437 id=437 data-nosnippet>437</a>}
<a href=#438 id=438 data-nosnippet>438</a>
<a href=#439 id=439 data-nosnippet>439</a><span class="doccomment">/// Enables or disables the experimental workload scheduler for new spawn
<a href=#440 id=440 data-nosnippet>440</a>/// submissions. Returns `false` when no scheduler was constructed at startup.
<a href=#441 id=441 data-nosnippet>441</a></span><span class="kw">pub fn </span>set_workload_scheduler_enabled(enabled: bool) -&gt; bool {
<a href=#442 id=442 data-nosnippet>442</a> <span class="kw">let </span><span class="prelude-val">Some</span>(scheduler) = GLOBAL_RUNTIMES.workload_scheduler.as_ref() <span class="kw">else </span>{
<a href=#443 id=443 data-nosnippet>443</a> <span class="macro">warn!</span>(
<a href=#444 id=444 data-nosnippet>444</a> <span class="string">"The experimental workload scheduler was not constructed at startup; ignoring enabled={enabled}"
<a href=#445 id=445 data-nosnippet>445</a> </span>);
<a href=#446 id=446 data-nosnippet>446</a> <span class="kw">return </span><span class="bool-val">false</span>;
<a href=#447 id=447 data-nosnippet>447</a> };
<a href=#448 id=448 data-nosnippet>448</a>
<a href=#449 id=449 data-nosnippet>449</a> scheduler.set_enabled(enabled);
<a href=#450 id=450 data-nosnippet>450</a> <span class="macro">info!</span>(<span class="string">"Experimental workload scheduler enabled={enabled}"</span>);
<a href=#451 id=451 data-nosnippet>451</a> <span class="bool-val">true
<a href=#452 id=452 data-nosnippet>452</a></span>}
<a href=#453 id=453 data-nosnippet>453</a>
<a href=#454 id=454 data-nosnippet>454</a><span class="doccomment">/// Sets the query and write weights atomically. Returns `false` when no
<a href=#455 id=455 data-nosnippet>455</a>/// scheduler was constructed at startup.
<a href=#456 id=456 data-nosnippet>456</a></span><span class="kw">pub fn </span>set_workload_scheduler_weights(query: NonZeroU32, write: NonZeroU32) -&gt; bool {
<a href=#457 id=457 data-nosnippet>457</a> <span class="kw">let </span><span class="prelude-val">Some</span>(scheduler) = GLOBAL_RUNTIMES.workload_scheduler.as_ref() <span class="kw">else </span>{
<a href=#458 id=458 data-nosnippet>458</a> <span class="macro">warn!</span>(
<a href=#459 id=459 data-nosnippet>459</a> <span class="string">"The experimental workload scheduler was not constructed at startup; ignoring query_weight={query}, write_weight={write}"
<a href=#460 id=460 data-nosnippet>460</a> </span>);
<a href=#461 id=461 data-nosnippet>461</a> <span class="kw">return </span><span class="bool-val">false</span>;
<a href=#462 id=462 data-nosnippet>462</a> };
<a href=#463 id=463 data-nosnippet>463</a>
<a href=#464 id=464 data-nosnippet>464</a> <span class="kw">let </span>weights = BTreeMap::from([(QUERY_TASK_CLASS, query), (WRITE_TASK_CLASS, write)]);
<a href=#465 id=465 data-nosnippet>465</a> scheduler.set_weights(<span class="kw-2">&amp;</span>weights);
<a href=#466 id=466 data-nosnippet>466</a> <span class="macro">info!</span>(<span class="string">"Experimental workload scheduler weights query={query}, write={write}"</span>);
<a href=#467 id=467 data-nosnippet>467</a> <span class="bool-val">true
<a href=#468 id=468 data-nosnippet>468</a></span>}
<a href=#469 id=469 data-nosnippet>469</a>
<a href=#470 id=470 data-nosnippet>470</a><span class="doccomment">/// Returns scheduler counters when the experimental workload scheduler was
<a href=#471 id=471 data-nosnippet>471</a>/// constructed at startup, including while it is dynamically disabled.
<a href=#472 id=472 data-nosnippet>472</a></span><span class="kw">pub fn </span>workload_scheduler_stats() -&gt; <span class="prelude-ty">Option</span>&lt;SchedulerStats&gt; {
<a href=#473 id=473 data-nosnippet>473</a> GLOBAL_RUNTIMES
<a href=#474 id=474 data-nosnippet>474</a> .workload_scheduler
<a href=#475 id=475 data-nosnippet>475</a> .as_ref()
<a href=#476 id=476 data-nosnippet>476</a> .map(Scheduler::stats)
<a href=#477 id=477 data-nosnippet>477</a>}
<a href=#478 id=478 data-nosnippet>478</a>
<a href=#479 id=479 data-nosnippet>479</a><span class="attr">#[cfg(test)]
<a href=#480 id=480 data-nosnippet>480</a></span><span class="kw">mod </span>tests {
<a href=#481 id=481 data-nosnippet>481</a> <span class="kw">use </span>std::future::Future;
<a href=#482 id=482 data-nosnippet>482</a> <span class="kw">use </span>std::pin::Pin;
<a href=#483 id=483 data-nosnippet>483</a> <span class="kw">use </span>std::sync::atomic::{AtomicBool, Ordering};
<a href=#484 id=484 data-nosnippet>484</a> <span class="kw">use </span>std::sync::{Arc, mpsc};
<a href=#485 id=485 data-nosnippet>485</a> <span class="kw">use </span>std::task::{Context, Poll};
<a href=#486 id=486 data-nosnippet>486</a> <span class="kw">use </span>std::time::{Duration, Instant};
<a href=#487 id=487 data-nosnippet>487</a>
<a href=#488 id=488 data-nosnippet>488</a> <span class="kw">use </span>tokio_test::assert_ok;
<a href=#489 id=489 data-nosnippet>489</a>
<a href=#490 id=490 data-nosnippet>490</a> <span class="kw">use </span>super::<span class="kw-2">*</span>;
<a href=#491 id=491 data-nosnippet>491</a>
<a href=#492 id=492 data-nosnippet>492</a> <span class="kw">struct </span>CooperativePolls {
<a href=#493 id=493 data-nosnippet>493</a> stop: Arc&lt;AtomicBool&gt;,
<a href=#494 id=494 data-nosnippet>494</a> }
<a href=#495 id=495 data-nosnippet>495</a>
<a href=#496 id=496 data-nosnippet>496</a> <span class="kw">impl </span>Future <span class="kw">for </span>CooperativePolls {
<a href=#497 id=497 data-nosnippet>497</a> <span class="kw">type </span>Output = ();
<a href=#498 id=498 data-nosnippet>498</a>
<a href=#499 id=499 data-nosnippet>499</a> <span class="kw">fn </span>poll(<span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;, cx: <span class="kw-2">&amp;mut </span>Context&lt;<span class="lifetime">'_</span>&gt;) -&gt; Poll&lt;<span class="self">Self</span>::Output&gt; {
<a href=#500 id=500 data-nosnippet>500</a> <span class="kw">let </span>deadline = Instant::now() + Duration::from_micros(<span class="number">100</span>);
<a href=#501 id=501 data-nosnippet>501</a> <span class="kw">while </span>Instant::now() &lt; deadline {
<a href=#502 id=502 data-nosnippet>502</a> std::hint::spin_loop();
<a href=#503 id=503 data-nosnippet>503</a> }
<a href=#504 id=504 data-nosnippet>504</a>
<a href=#505 id=505 data-nosnippet>505</a> <span class="kw">if </span><span class="self">self</span>.stop.load(Ordering::Relaxed) {
<a href=#506 id=506 data-nosnippet>506</a> Poll::Ready(())
<a href=#507 id=507 data-nosnippet>507</a> } <span class="kw">else </span>{
<a href=#508 id=508 data-nosnippet>508</a> cx.waker().wake_by_ref();
<a href=#509 id=509 data-nosnippet>509</a> Poll::Pending
<a href=#510 id=510 data-nosnippet>510</a> }
<a href=#511 id=511 data-nosnippet>511</a> }
<a href=#512 id=512 data-nosnippet>512</a> }
<a href=#513 id=513 data-nosnippet>513</a>
<a href=#514 id=514 data-nosnippet>514</a> <span class="kw">fn </span>wait_until&lt;F&gt;(description: <span class="kw-2">&amp;</span>str, condition: F)
<a href=#515 id=515 data-nosnippet>515</a> <span class="kw">where
<a href=#516 id=516 data-nosnippet>516</a> </span>F: Fn() -&gt; bool,
<a href=#517 id=517 data-nosnippet>517</a> {
<a href=#518 id=518 data-nosnippet>518</a> <span class="kw">let </span>deadline = Instant::now() + Duration::from_secs(<span class="number">5</span>);
<a href=#519 id=519 data-nosnippet>519</a> <span class="kw">while </span>!condition() {
<a href=#520 id=520 data-nosnippet>520</a> <span class="macro">assert!</span>(
<a href=#521 id=521 data-nosnippet>521</a> Instant::now() &lt; deadline,
<a href=#522 id=522 data-nosnippet>522</a> <span class="string">"timed out waiting for {description}"
<a href=#523 id=523 data-nosnippet>523</a> </span>);
<a href=#524 id=524 data-nosnippet>524</a> std::thread::sleep(Duration::from_millis(<span class="number">1</span>));
<a href=#525 id=525 data-nosnippet>525</a> }
<a href=#526 id=526 data-nosnippet>526</a> }
<a href=#527 id=527 data-nosnippet>527</a>
<a href=#528 id=528 data-nosnippet>528</a> <span class="attr">#[test]
<a href=#529 id=529 data-nosnippet>529</a> </span><span class="kw">fn </span>test_datanode_runtime_options_default() {
<a href=#530 id=530 data-nosnippet>530</a> <span class="kw">let </span>options = RuntimeOptions::default();
<a href=#531 id=531 data-nosnippet>531</a> <span class="kw">let </span>cpus = usize::max(num_cpus::get(), MIN_RUNTIME_THREADS);
<a href=#532 id=532 data-nosnippet>532</a>
<a href=#533 id=533 data-nosnippet>533</a> <span class="macro">assert_eq!</span>(cpus, options.global_rt_size);
<a href=#534 id=534 data-nosnippet>534</a> <span class="macro">assert_eq!</span>(
<a href=#535 id=535 data-nosnippet>535</a> usize::max(cpus / <span class="number">2</span>, MIN_RUNTIME_THREADS),
<a href=#536 id=536 data-nosnippet>536</a> options.compact_rt_size
<a href=#537 id=537 data-nosnippet>537</a> );
<a href=#538 id=538 data-nosnippet>538</a> <span class="macro">assert_eq!</span>(
<a href=#539 id=539 data-nosnippet>539</a> usize::max(cpus / <span class="number">2</span>, MIN_RUNTIME_THREADS),
<a href=#540 id=540 data-nosnippet>540</a> options.compact_rt_max_blocking_threads
<a href=#541 id=541 data-nosnippet>541</a> );
<a href=#542 id=542 data-nosnippet>542</a> <span class="macro">assert_eq!</span>(
<a href=#543 id=543 data-nosnippet>543</a> usize::max(cpus.saturating_sub(<span class="number">1</span>), MIN_RUNTIME_THREADS),
<a href=#544 id=544 data-nosnippet>544</a> options.query_rt_size
<a href=#545 id=545 data-nosnippet>545</a> );
<a href=#546 id=546 data-nosnippet>546</a> <span class="macro">assert_eq!</span>(cpus, options.ingest_rt_size);
<a href=#547 id=547 data-nosnippet>547</a> <span class="macro">assert_eq!</span>(
<a href=#548 id=548 data-nosnippet>548</a> WorkloadSchedulerOptions::default(),
<a href=#549 id=549 data-nosnippet>549</a> options.experimental_workload_scheduler
<a href=#550 id=550 data-nosnippet>550</a> );
<a href=#551 id=551 data-nosnippet>551</a> }
<a href=#552 id=552 data-nosnippet>552</a>
<a href=#553 id=553 data-nosnippet>553</a> <span class="attr">#[test]
<a href=#554 id=554 data-nosnippet>554</a> </span><span class="kw">fn </span>test_runtime_options_min_threads() {
<a href=#555 id=555 data-nosnippet>555</a> <span class="kw">for </span>cpus <span class="kw">in </span>[<span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>] {
<a href=#556 id=556 data-nosnippet>556</a> <span class="kw">let </span>options = RuntimeOptions::with_num_cpus(cpus);
<a href=#557 id=557 data-nosnippet>557</a> <span class="macro">assert!</span>(
<a href=#558 id=558 data-nosnippet>558</a> options.global_rt_size &gt;= MIN_RUNTIME_THREADS,
<a href=#559 id=559 data-nosnippet>559</a> <span class="string">"global_rt_size {} &lt; {MIN_RUNTIME_THREADS} with {cpus} cpus"</span>,
<a href=#560 id=560 data-nosnippet>560</a> options.global_rt_size
<a href=#561 id=561 data-nosnippet>561</a> );
<a href=#562 id=562 data-nosnippet>562</a> <span class="macro">assert!</span>(
<a href=#563 id=563 data-nosnippet>563</a> options.compact_rt_size &gt;= MIN_RUNTIME_THREADS,
<a href=#564 id=564 data-nosnippet>564</a> <span class="string">"compact_rt_size {} &lt; {MIN_RUNTIME_THREADS} with {cpus} cpus"</span>,
<a href=#565 id=565 data-nosnippet>565</a> options.compact_rt_size
<a href=#566 id=566 data-nosnippet>566</a> );
<a href=#567 id=567 data-nosnippet>567</a> <span class="macro">assert!</span>(
<a href=#568 id=568 data-nosnippet>568</a> options.compact_rt_max_blocking_threads &gt;= MIN_RUNTIME_THREADS,
<a href=#569 id=569 data-nosnippet>569</a> <span class="string">"compact_rt_max_blocking_threads {} &lt; {MIN_RUNTIME_THREADS} with {cpus} cpus"</span>,
<a href=#570 id=570 data-nosnippet>570</a> options.compact_rt_max_blocking_threads
<a href=#571 id=571 data-nosnippet>571</a> );
<a href=#572 id=572 data-nosnippet>572</a> <span class="macro">assert!</span>(
<a href=#573 id=573 data-nosnippet>573</a> options.query_rt_size &gt;= MIN_RUNTIME_THREADS,
<a href=#574 id=574 data-nosnippet>574</a> <span class="string">"query_rt_size {} &lt; {MIN_RUNTIME_THREADS} with {cpus} cpus"</span>,
<a href=#575 id=575 data-nosnippet>575</a> options.query_rt_size
<a href=#576 id=576 data-nosnippet>576</a> );
<a href=#577 id=577 data-nosnippet>577</a> <span class="macro">assert!</span>(
<a href=#578 id=578 data-nosnippet>578</a> options.ingest_rt_size &gt;= MIN_RUNTIME_THREADS,
<a href=#579 id=579 data-nosnippet>579</a> <span class="string">"ingest_rt_size {} &lt; {MIN_RUNTIME_THREADS} with {cpus} cpus"</span>,
<a href=#580 id=580 data-nosnippet>580</a> options.ingest_rt_size
<a href=#581 id=581 data-nosnippet>581</a> );
<a href=#582 id=582 data-nosnippet>582</a> }
<a href=#583 id=583 data-nosnippet>583</a> }
<a href=#584 id=584 data-nosnippet>584</a>
<a href=#585 id=585 data-nosnippet>585</a> <span class="attr">#[test]
<a href=#586 id=586 data-nosnippet>586</a> </span><span class="kw">fn </span>test_datanode_runtimes_fallback_to_global_runtime() {
<a href=#587 id=587 data-nosnippet>587</a> <span class="kw">let </span>runtimes = GlobalRuntimes::new(
<a href=#588 id=588 data-nosnippet>588</a> <span class="prelude-val">Some</span>(create_runtime(<span class="string">"test-global"</span>, <span class="string">"test-global-worker"</span>, <span class="number">1</span>)),
<a href=#589 id=589 data-nosnippet>589</a> <span class="prelude-val">None</span>,
<a href=#590 id=590 data-nosnippet>590</a> <span class="prelude-val">None</span>,
<a href=#591 id=591 data-nosnippet>591</a> <span class="prelude-val">None</span>,
<a href=#592 id=592 data-nosnippet>592</a> <span class="prelude-val">None</span>,
<a href=#593 id=593 data-nosnippet>593</a> <span class="prelude-val">None</span>,
<a href=#594 id=594 data-nosnippet>594</a> );
<a href=#595 id=595 data-nosnippet>595</a>
<a href=#596 id=596 data-nosnippet>596</a> <span class="macro">assert_eq!</span>(<span class="string">"test-global"</span>, runtimes.global_runtime.name());
<a href=#597 id=597 data-nosnippet>597</a> <span class="macro">assert_eq!</span>(<span class="string">"test-global"</span>, runtimes.query_runtime.name());
<a href=#598 id=598 data-nosnippet>598</a> <span class="macro">assert_eq!</span>(<span class="string">"test-global"</span>, runtimes.ingest_runtime.name());
<a href=#599 id=599 data-nosnippet>599</a> }
<a href=#600 id=600 data-nosnippet>600</a>
<a href=#601 id=601 data-nosnippet>601</a> <span class="attr">#[test]
<a href=#602 id=602 data-nosnippet>602</a> </span><span class="kw">fn </span>test_create_compact_runtime_with_zero_max_blocking_threads() {
<a href=#603 id=603 data-nosnippet>603</a> <span class="kw">let </span>runtime = create_compact_runtime(<span class="string">"test-compact"</span>, <span class="string">"test-compact-worker"</span>, <span class="number">1</span>, <span class="number">0</span>);
<a href=#604 id=604 data-nosnippet>604</a> <span class="kw">let </span>handle = runtime.spawn_blocking(|| <span class="number">1 </span>+ <span class="number">1</span>);
<a href=#605 id=605 data-nosnippet>605</a>
<a href=#606 id=606 data-nosnippet>606</a> <span class="macro">assert_eq!</span>(<span class="number">2</span>, runtime.block_on(handle).unwrap());
<a href=#607 id=607 data-nosnippet>607</a> }
<a href=#608 id=608 data-nosnippet>608</a>
<a href=#609 id=609 data-nosnippet>609</a> <span class="attr">#[test]
<a href=#610 id=610 data-nosnippet>610</a> </span><span class="kw">fn </span>test_compact_runtime_limits_blocking_threads() {
<a href=#611 id=611 data-nosnippet>611</a> <span class="kw">let </span>runtime = create_compact_runtime(<span class="string">"test-compact"</span>, <span class="string">"test-compact-worker"</span>, <span class="number">1</span>, <span class="number">1</span>);
<a href=#612 id=612 data-nosnippet>612</a> <span class="kw">let </span>(first_started_tx, first_started_rx) = mpsc::channel();
<a href=#613 id=613 data-nosnippet>613</a> <span class="kw">let </span>(release_first_tx, release_first_rx) = mpsc::channel();
<a href=#614 id=614 data-nosnippet>614</a> <span class="kw">let </span>first = runtime.spawn_blocking(<span class="kw">move </span>|| {
<a href=#615 id=615 data-nosnippet>615</a> first_started_tx.send(()).unwrap();
<a href=#616 id=616 data-nosnippet>616</a> release_first_rx.recv().unwrap();
<a href=#617 id=617 data-nosnippet>617</a> });
<a href=#618 id=618 data-nosnippet>618</a> first_started_rx
<a href=#619 id=619 data-nosnippet>619</a> .recv_timeout(Duration::from_secs(<span class="number">5</span>))
<a href=#620 id=620 data-nosnippet>620</a> .unwrap();
<a href=#621 id=621 data-nosnippet>621</a>
<a href=#622 id=622 data-nosnippet>622</a> <span class="kw">let </span>(second_started_tx, second_started_rx) = mpsc::channel();
<a href=#623 id=623 data-nosnippet>623</a> <span class="kw">let </span>second = runtime.spawn_blocking(<span class="kw">move </span>|| second_started_tx.send(()).unwrap());
<a href=#624 id=624 data-nosnippet>624</a> <span class="macro">assert!</span>(
<a href=#625 id=625 data-nosnippet>625</a> second_started_rx
<a href=#626 id=626 data-nosnippet>626</a> .recv_timeout(Duration::from_secs(<span class="number">1</span>))
<a href=#627 id=627 data-nosnippet>627</a> .is_err()
<a href=#628 id=628 data-nosnippet>628</a> );
<a href=#629 id=629 data-nosnippet>629</a>
<a href=#630 id=630 data-nosnippet>630</a> release_first_tx.send(()).unwrap();
<a href=#631 id=631 data-nosnippet>631</a> second_started_rx
<a href=#632 id=632 data-nosnippet>632</a> .recv_timeout(Duration::from_secs(<span class="number">5</span>))
<a href=#633 id=633 data-nosnippet>633</a> .unwrap();
<a href=#634 id=634 data-nosnippet>634</a> runtime.block_on(<span class="kw">async </span>{
<a href=#635 id=635 data-nosnippet>635</a> first.<span class="kw">await</span>.unwrap();
<a href=#636 id=636 data-nosnippet>636</a> second.<span class="kw">await</span>.unwrap();
<a href=#637 id=637 data-nosnippet>637</a> });
<a href=#638 id=638 data-nosnippet>638</a> }
<a href=#639 id=639 data-nosnippet>639</a>
<a href=#640 id=640 data-nosnippet>640</a> <span class="attr">#[test]
<a href=#641 id=641 data-nosnippet>641</a> </span><span class="kw">fn </span>test_workload_scheduler_builds_with_initial_enabled_state() {
<a href=#642 id=642 data-nosnippet>642</a> <span class="kw">let </span><span class="kw-2">mut </span>options = RuntimeOptions::default();
<a href=#643 id=643 data-nosnippet>643</a> options.experimental_workload_scheduler.enable = <span class="bool-val">false</span>;
<a href=#644 id=644 data-nosnippet>644</a> options.experimental_workload_scheduler.sample_every_polls = NonZeroUsize::new(<span class="number">7</span>).unwrap();
<a href=#645 id=645 data-nosnippet>645</a> <span class="kw">let </span>scheduler = create_workload_scheduler(<span class="kw-2">&amp;</span>options, options.global_rt_size);
<a href=#646 id=646 data-nosnippet>646</a> <span class="macro">assert_eq!</span>(<span class="number">7</span>, scheduler.stats().sample_every_polls);
<a href=#647 id=647 data-nosnippet>647</a> <span class="macro">assert!</span>(!scheduler.is_enabled());
<a href=#648 id=648 data-nosnippet>648</a>
<a href=#649 id=649 data-nosnippet>649</a> scheduler.set_enabled(<span class="bool-val">true</span>);
<a href=#650 id=650 data-nosnippet>650</a> <span class="macro">assert!</span>(scheduler.is_enabled());
<a href=#651 id=651 data-nosnippet>651</a> }
<a href=#652 id=652 data-nosnippet>652</a>
<a href=#653 id=653 data-nosnippet>653</a> <span class="attr">#[test]
<a href=#654 id=654 data-nosnippet>654</a> </span><span class="kw">fn </span>test_workload_scheduler_bypasses_disabled_query_and_write_spawns() {
<a href=#655 id=655 data-nosnippet>655</a> <span class="kw">let </span>runtime = create_runtime(<span class="string">"test-workload-bypass"</span>, <span class="string">"test-workload-bypass-worker"</span>, <span class="number">2</span>);
<a href=#656 id=656 data-nosnippet>656</a> <span class="kw">let </span>scheduler = Scheduler::builder()
<a href=#657 id=657 data-nosnippet>657</a> .max_concurrent_polls(<span class="number">2</span>)
<a href=#658 id=658 data-nosnippet>658</a> .weight(QUERY_TASK_CLASS, <span class="number">2</span>)
<a href=#659 id=659 data-nosnippet>659</a> .weight(WRITE_TASK_CLASS, <span class="number">8</span>)
<a href=#660 id=660 data-nosnippet>660</a> .build();
<a href=#661 id=661 data-nosnippet>661</a> scheduler.set_enabled(<span class="bool-val">false</span>);
<a href=#662 id=662 data-nosnippet>662</a> <span class="kw">let </span>runtimes = GlobalRuntimes::new(
<a href=#663 id=663 data-nosnippet>663</a> <span class="prelude-val">Some</span>(runtime.clone()),
<a href=#664 id=664 data-nosnippet>664</a> <span class="prelude-val">Some</span>(runtime.clone()),
<a href=#665 id=665 data-nosnippet>665</a> <span class="prelude-val">Some</span>(runtime.clone()),
<a href=#666 id=666 data-nosnippet>666</a> <span class="prelude-val">Some</span>(runtime.clone()),
<a href=#667 id=667 data-nosnippet>667</a> <span class="prelude-val">Some</span>(runtime.clone()),
<a href=#668 id=668 data-nosnippet>668</a> <span class="prelude-val">Some</span>(scheduler.clone()),
<a href=#669 id=669 data-nosnippet>669</a> );
<a href=#670 id=670 data-nosnippet>670</a>
<a href=#671 id=671 data-nosnippet>671</a> <span class="kw">let </span>query = runtimes.spawn_query(<span class="kw">async </span>{ <span class="string">"query" </span>});
<a href=#672 id=672 data-nosnippet>672</a> <span class="kw">let </span>write = runtimes.spawn_ingest(<span class="kw">async </span>{ <span class="string">"write" </span>});
<a href=#673 id=673 data-nosnippet>673</a> <span class="kw">let </span>(query, write) =
<a href=#674 id=674 data-nosnippet>674</a> runtime.block_on(<span class="kw">async </span>{ (query.<span class="kw">await</span>.unwrap(), write.<span class="kw">await</span>.unwrap()) });
<a href=#675 id=675 data-nosnippet>675</a>
<a href=#676 id=676 data-nosnippet>676</a> <span class="macro">assert_eq!</span>(<span class="string">"query"</span>, query);
<a href=#677 id=677 data-nosnippet>677</a> <span class="macro">assert_eq!</span>(<span class="string">"write"</span>, write);
<a href=#678 id=678 data-nosnippet>678</a> <span class="kw">let </span>stats = scheduler.stats();
<a href=#679 id=679 data-nosnippet>679</a> <span class="kw">for </span>class <span class="kw">in </span>[QUERY_TASK_CLASS, WRITE_TASK_CLASS] {
<a href=#680 id=680 data-nosnippet>680</a> <span class="kw">let </span>class_stats = <span class="kw-2">&amp;</span>stats.classes[<span class="kw-2">&amp;</span>class];
<a href=#681 id=681 data-nosnippet>681</a> <span class="macro">assert_eq!</span>(<span class="number">0</span>, class_stats.tasks);
<a href=#682 id=682 data-nosnippet>682</a> <span class="macro">assert_eq!</span>(<span class="number">0</span>, class_stats.admitted);
<a href=#683 id=683 data-nosnippet>683</a> <span class="macro">assert_eq!</span>(<span class="number">0</span>, class_stats.polls);
<a href=#684 id=684 data-nosnippet>684</a> }
<a href=#685 id=685 data-nosnippet>685</a> }
<a href=#686 id=686 data-nosnippet>686</a>
<a href=#687 id=687 data-nosnippet>687</a> <span class="attr">#[test]
<a href=#688 id=688 data-nosnippet>688</a> </span><span class="kw">fn </span>test_workload_scheduler_wraps_query_and_write_spawns() {
<a href=#689 id=689 data-nosnippet>689</a> <span class="kw">let </span>runtime = create_runtime(<span class="string">"test-workload"</span>, <span class="string">"test-workload-worker"</span>, <span class="number">2</span>);
<a href=#690 id=690 data-nosnippet>690</a> <span class="kw">let </span>scheduler = Scheduler::builder()
<a href=#691 id=691 data-nosnippet>691</a> .max_concurrent_polls(<span class="number">2</span>)
<a href=#692 id=692 data-nosnippet>692</a> .weight(QUERY_TASK_CLASS, <span class="number">2</span>)
<a href=#693 id=693 data-nosnippet>693</a> .weight(WRITE_TASK_CLASS, <span class="number">8</span>)
<a href=#694 id=694 data-nosnippet>694</a> .build();
<a href=#695 id=695 data-nosnippet>695</a> <span class="kw">let </span>runtimes = GlobalRuntimes::new(
<a href=#696 id=696 data-nosnippet>696</a> <span class="prelude-val">Some</span>(runtime.clone()),
<a href=#697 id=697 data-nosnippet>697</a> <span class="prelude-val">Some</span>(runtime.clone()),
<a href=#698 id=698 data-nosnippet>698</a> <span class="prelude-val">Some</span>(runtime.clone()),
<a href=#699 id=699 data-nosnippet>699</a> <span class="prelude-val">Some</span>(runtime.clone()),
<a href=#700 id=700 data-nosnippet>700</a> <span class="prelude-val">Some</span>(runtime.clone()),
<a href=#701 id=701 data-nosnippet>701</a> <span class="prelude-val">Some</span>(scheduler.clone()),
<a href=#702 id=702 data-nosnippet>702</a> );
<a href=#703 id=703 data-nosnippet>703</a>
<a href=#704 id=704 data-nosnippet>704</a> <span class="kw">let </span>query = runtimes.spawn_query(<span class="kw">async </span>{ <span class="string">"query" </span>});
<a href=#705 id=705 data-nosnippet>705</a> <span class="kw">let </span>write = runtimes.spawn_ingest(<span class="kw">async </span>{ <span class="string">"write" </span>});
<a href=#706 id=706 data-nosnippet>706</a> <span class="kw">let </span>(query, write) =
<a href=#707 id=707 data-nosnippet>707</a> runtime.block_on(<span class="kw">async </span>{ (query.<span class="kw">await</span>.unwrap(), write.<span class="kw">await</span>.unwrap()) });
<a href=#708 id=708 data-nosnippet>708</a>
<a href=#709 id=709 data-nosnippet>709</a> <span class="macro">assert_eq!</span>(<span class="string">"query"</span>, query);
<a href=#710 id=710 data-nosnippet>710</a> <span class="macro">assert_eq!</span>(<span class="string">"write"</span>, write);
<a href=#711 id=711 data-nosnippet>711</a> <span class="kw">let </span>stats = scheduler.stats();
<a href=#712 id=712 data-nosnippet>712</a> <span class="macro">assert_eq!</span>(<span class="number">1</span>, stats.classes[<span class="kw-2">&amp;</span>QUERY_TASK_CLASS].polls);
<a href=#713 id=713 data-nosnippet>713</a> <span class="macro">assert_eq!</span>(<span class="number">1</span>, stats.classes[<span class="kw-2">&amp;</span>WRITE_TASK_CLASS].polls);
<a href=#714 id=714 data-nosnippet>714</a> }
<a href=#715 id=715 data-nosnippet>715</a>
<a href=#716 id=716 data-nosnippet>716</a> <span class="attr">#[test]
<a href=#717 id=717 data-nosnippet>717</a> </span><span class="kw">fn </span>test_datanode_query_backlog_does_not_starve_ingest() {
<a href=#718 id=718 data-nosnippet>718</a> <span class="kw">let </span>query_runtime = create_runtime(<span class="string">"test-datanode-query"</span>, <span class="string">"test-query-worker"</span>, <span class="number">1</span>);
<a href=#719 id=719 data-nosnippet>719</a> <span class="kw">let </span>ingest_runtime = create_runtime(<span class="string">"test-datanode-ingest"</span>, <span class="string">"test-ingest-worker"</span>, <span class="number">1</span>);
<a href=#720 id=720 data-nosnippet>720</a> <span class="kw">let </span>scheduler = Scheduler::builder()
<a href=#721 id=721 data-nosnippet>721</a> .max_concurrent_polls(<span class="number">2</span>)
<a href=#722 id=722 data-nosnippet>722</a> .sample_every_polls(<span class="number">16</span>)
<a href=#723 id=723 data-nosnippet>723</a> .weight(QUERY_TASK_CLASS, <span class="number">2</span>)
<a href=#724 id=724 data-nosnippet>724</a> .weight(WRITE_TASK_CLASS, <span class="number">8</span>)
<a href=#725 id=725 data-nosnippet>725</a> .build();
<a href=#726 id=726 data-nosnippet>726</a> <span class="kw">let </span>runtimes = GlobalRuntimes::new(
<a href=#727 id=727 data-nosnippet>727</a> <span class="prelude-val">Some</span>(query_runtime.clone()),
<a href=#728 id=728 data-nosnippet>728</a> <span class="prelude-val">Some</span>(query_runtime.clone()),
<a href=#729 id=729 data-nosnippet>729</a> <span class="prelude-val">Some</span>(query_runtime.clone()),
<a href=#730 id=730 data-nosnippet>730</a> <span class="prelude-val">Some</span>(query_runtime),
<a href=#731 id=731 data-nosnippet>731</a> <span class="prelude-val">Some</span>(ingest_runtime),
<a href=#732 id=732 data-nosnippet>732</a> <span class="prelude-val">Some</span>(scheduler.clone()),
<a href=#733 id=733 data-nosnippet>733</a> );
<a href=#734 id=734 data-nosnippet>734</a>
<a href=#735 id=735 data-nosnippet>735</a> <span class="kw">let </span>stop_queries = Arc::new(AtomicBool::new(<span class="bool-val">false</span>));
<a href=#736 id=736 data-nosnippet>736</a> <span class="kw">let </span>query_tasks = (<span class="number">0</span>..<span class="number">3</span>)
<a href=#737 id=737 data-nosnippet>737</a> .map(|<span class="kw">_</span>| {
<a href=#738 id=738 data-nosnippet>738</a> runtimes.spawn_query(CooperativePolls {
<a href=#739 id=739 data-nosnippet>739</a> stop: stop_queries.clone(),
<a href=#740 id=740 data-nosnippet>740</a> })
<a href=#741 id=741 data-nosnippet>741</a> })
<a href=#742 id=742 data-nosnippet>742</a> .collect::&lt;Vec&lt;<span class="kw">_</span>&gt;&gt;();
<a href=#743 id=743 data-nosnippet>743</a>
<a href=#744 id=744 data-nosnippet>744</a> <span class="comment">// Establish the actual datanode topology: two query polls occupy the
<a href=#745 id=745 data-nosnippet>745</a> // scheduler's capacity while the third self-waking query is queued.
<a href=#746 id=746 data-nosnippet>746</a> </span>wait_until(<span class="string">"two active query polls and a queued query"</span>, || {
<a href=#747 id=747 data-nosnippet>747</a> <span class="kw">let </span>stats = scheduler.stats();
<a href=#748 id=748 data-nosnippet>748</a> stats.active_polls == <span class="number">2
<a href=#749 id=749 data-nosnippet>749</a> </span>&amp;&amp; stats
<a href=#750 id=750 data-nosnippet>750</a> .classes
<a href=#751 id=751 data-nosnippet>751</a> .get(<span class="kw-2">&amp;</span>QUERY_TASK_CLASS)
<a href=#752 id=752 data-nosnippet>752</a> .is_some_and(|class| class.tasks == <span class="number">3 </span>&amp;&amp; class.queued &gt;= <span class="number">1</span>)
<a href=#753 id=753 data-nosnippet>753</a> });
<a href=#754 id=754 data-nosnippet>754</a>
<a href=#755 id=755 data-nosnippet>755</a> <span class="kw">let </span>write = runtimes.spawn_ingest(<span class="kw">async </span>{});
<a href=#756 id=756 data-nosnippet>756</a> wait_until(<span class="string">"write body"</span>, || write.is_finished());
<a href=#757 id=757 data-nosnippet>757</a>
<a href=#758 id=758 data-nosnippet>758</a> stop_queries.store(<span class="bool-val">true</span>, Ordering::Relaxed);
<a href=#759 id=759 data-nosnippet>759</a> <span class="kw">for </span>query <span class="kw">in </span><span class="kw-2">&amp;</span>query_tasks {
<a href=#760 id=760 data-nosnippet>760</a> query.abort();
<a href=#761 id=761 data-nosnippet>761</a> }
<a href=#762 id=762 data-nosnippet>762</a> runtimes.block_on_query(<span class="kw">async </span>{
<a href=#763 id=763 data-nosnippet>763</a> <span class="kw">for </span>query <span class="kw">in </span>query_tasks {
<a href=#764 id=764 data-nosnippet>764</a> <span class="kw">let _ </span>= query.<span class="kw">await</span>;
<a href=#765 id=765 data-nosnippet>765</a> }
<a href=#766 id=766 data-nosnippet>766</a> });
<a href=#767 id=767 data-nosnippet>767</a> runtimes.block_on_ingest(<span class="kw">async </span>{
<a href=#768 id=768 data-nosnippet>768</a> write.<span class="kw">await</span>.unwrap();
<a href=#769 id=769 data-nosnippet>769</a> });
<a href=#770 id=770 data-nosnippet>770</a> wait_until(<span class="string">"scheduler polls to drain"</span>, || {
<a href=#771 id=771 data-nosnippet>771</a> scheduler.stats().active_polls == <span class="number">0
<a href=#772 id=772 data-nosnippet>772</a> </span>});
<a href=#773 id=773 data-nosnippet>773</a> }
<a href=#774 id=774 data-nosnippet>774</a>
<a href=#775 id=775 data-nosnippet>775</a> <span class="attr">#[test]
<a href=#776 id=776 data-nosnippet>776</a> </span><span class="kw">fn </span>test_datanode_runtime_spawn_block_on() {
<a href=#777 id=777 data-nosnippet>777</a> <span class="kw">let </span>handle = spawn_query(<span class="kw">async </span>{ <span class="number">1 </span>+ <span class="number">1 </span>});
<a href=#778 id=778 data-nosnippet>778</a> <span class="macro">assert_eq!</span>(<span class="number">2</span>, block_on_query(handle).unwrap());
<a href=#779 id=779 data-nosnippet>779</a>
<a href=#780 id=780 data-nosnippet>780</a> <span class="kw">let </span>handle = spawn_ingest(<span class="kw">async </span>{ <span class="number">2 </span>+ <span class="number">2 </span>});
<a href=#781 id=781 data-nosnippet>781</a> <span class="macro">assert_eq!</span>(<span class="number">4</span>, block_on_ingest(handle).unwrap());
<a href=#782 id=782 data-nosnippet>782</a> }
<a href=#783 id=783 data-nosnippet>783</a>
<a href=#784 id=784 data-nosnippet>784</a> <span class="attr">#[test]
<a href=#785 id=785 data-nosnippet>785</a> </span><span class="kw">fn </span>test_spawn_block_on() {
<a href=#786 id=786 data-nosnippet>786</a> <span class="kw">let </span>handle = spawn_global(<span class="kw">async </span>{ <span class="number">1 </span>+ <span class="number">1 </span>});
<a href=#787 id=787 data-nosnippet>787</a> <span class="macro">assert_eq!</span>(<span class="number">2</span>, block_on_global(handle).unwrap());
<a href=#788 id=788 data-nosnippet>788</a>
<a href=#789 id=789 data-nosnippet>789</a> <span class="kw">let </span>handle = spawn_compact(<span class="kw">async </span>{ <span class="number">2 </span>+ <span class="number">2 </span>});
<a href=#790 id=790 data-nosnippet>790</a> <span class="macro">assert_eq!</span>(<span class="number">4</span>, block_on_compact(handle).unwrap());
<a href=#791 id=791 data-nosnippet>791</a>
<a href=#792 id=792 data-nosnippet>792</a> <span class="kw">let </span>handle = spawn_hb(<span class="kw">async </span>{ <span class="number">4 </span>+ <span class="number">4 </span>});
<a href=#793 id=793 data-nosnippet>793</a> <span class="macro">assert_eq!</span>(<span class="number">8</span>, block_on_hb(handle).unwrap());
<a href=#794 id=794 data-nosnippet>794</a> }
<a href=#795 id=795 data-nosnippet>795</a>
<a href=#796 id=796 data-nosnippet>796</a> <span class="macro">macro_rules!</span> define_spawn_blocking_test {
<a href=#797 id=797 data-nosnippet>797</a> (<span class="macro-nonterminal">$type</span>: ident) =&gt; {
<a href=#798 id=798 data-nosnippet>798</a> <span class="macro">paste!</span> {
<a href=#799 id=799 data-nosnippet>799</a> <span class="attr">#[test]
<a href=#800 id=800 data-nosnippet>800</a> </span><span class="kw">fn </span>[&lt;test_spawn_ <span class="macro-nonterminal">$type </span>_from_blocking&gt;]() {
<a href=#801 id=801 data-nosnippet>801</a> <span class="kw">let </span>runtime = [&lt;<span class="macro-nonterminal">$type </span>_runtime&gt;]();
<a href=#802 id=802 data-nosnippet>802</a> <span class="kw">let </span>out = runtime.block_on(<span class="kw">async move </span>{
<a href=#803 id=803 data-nosnippet>803</a> <span class="kw">let </span>inner = <span class="macro">assert_ok!</span>(
<a href=#804 id=804 data-nosnippet>804</a> [&lt;spawn_blocking_ <span class="macro-nonterminal">$type</span>&gt;](<span class="kw">move </span>|| {
<a href=#805 id=805 data-nosnippet>805</a> [&lt;spawn_ <span class="macro-nonterminal">$type</span>&gt;](<span class="kw">async move </span>{ <span class="string">"hello" </span>})
<a href=#806 id=806 data-nosnippet>806</a> }).<span class="kw">await
<a href=#807 id=807 data-nosnippet>807</a> </span>);
<a href=#808 id=808 data-nosnippet>808</a>
<a href=#809 id=809 data-nosnippet>809</a> <span class="macro">assert_ok!</span>(inner.<span class="kw">await</span>)
<a href=#810 id=810 data-nosnippet>810</a> });
<a href=#811 id=811 data-nosnippet>811</a>
<a href=#812 id=812 data-nosnippet>812</a> <span class="macro">assert_eq!</span>(out, <span class="string">"hello"</span>)
<a href=#813 id=813 data-nosnippet>813</a> }
<a href=#814 id=814 data-nosnippet>814</a> }
<a href=#815 id=815 data-nosnippet>815</a> };
<a href=#816 id=816 data-nosnippet>816</a> }
<a href=#817 id=817 data-nosnippet>817</a>
<a href=#818 id=818 data-nosnippet>818</a> <span class="macro">define_spawn_blocking_test!</span>(global);
<a href=#819 id=819 data-nosnippet>819</a> <span class="macro">define_spawn_blocking_test!</span>(compact);
<a href=#820 id=820 data-nosnippet>820</a> <span class="macro">define_spawn_blocking_test!</span>(hb);
<a href=#821 id=821 data-nosnippet>821</a>}
</code></pre></div></section></main></body></html>
+34
View File
@@ -0,0 +1,34 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/common/runtime/src/lib.rs`."><title>lib.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="common_runtime" data-themes="" data-resource-suffix="" data-rustdoc-version="1.96.1 (31fca3adb 2026-06-26)" data-channel="1.96.1" data-search-js="search-b5634cc7.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../../static.files/storage-41dd4d93.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-5013f961.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-f7c3ffd8.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content" tabindex="-1"><div class="main-heading"><h1><div class="sub-heading">common_runtime/</div>lib.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="comment">// Copyright 2023 Greptime Team
<a href=#2 id=2 data-nosnippet>2</a>//
<a href=#3 id=3 data-nosnippet>3</a>// Licensed under the Apache License, Version 2.0 (the "License");
<a href=#4 id=4 data-nosnippet>4</a>// you may not use this file except in compliance with the License.
<a href=#5 id=5 data-nosnippet>5</a>// You may obtain a copy of the License at
<a href=#6 id=6 data-nosnippet>6</a>//
<a href=#7 id=7 data-nosnippet>7</a>// http://www.apache.org/licenses/LICENSE-2.0
<a href=#8 id=8 data-nosnippet>8</a>//
<a href=#9 id=9 data-nosnippet>9</a>// Unless required by applicable law or agreed to in writing, software
<a href=#10 id=10 data-nosnippet>10</a>// distributed under the License is distributed on an "AS IS" BASIS,
<a href=#11 id=11 data-nosnippet>11</a>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<a href=#12 id=12 data-nosnippet>12</a>// See the License for the specific language governing permissions and
<a href=#13 id=13 data-nosnippet>13</a>// limitations under the License.
<a href=#14 id=14 data-nosnippet>14</a>
<a href=#15 id=15 data-nosnippet>15</a></span><span class="kw">pub mod </span>error;
<a href=#16 id=16 data-nosnippet>16</a><span class="kw">pub mod </span>global;
<a href=#17 id=17 data-nosnippet>17</a><span class="kw">mod </span>metrics;
<a href=#18 id=18 data-nosnippet>18</a><span class="kw">mod </span>repeated_task;
<a href=#19 id=19 data-nosnippet>19</a><span class="kw">pub mod </span>runtime;
<a href=#20 id=20 data-nosnippet>20</a><span class="kw">pub mod </span>runtime_default;
<a href=#21 id=21 data-nosnippet>21</a><span class="kw">pub mod </span>runtime_throttleable;
<a href=#22 id=22 data-nosnippet>22</a>
<a href=#23 id=23 data-nosnippet>23</a><span class="kw">pub use </span>global::{
<a href=#24 id=24 data-nosnippet>24</a> block_on_compact, block_on_global, block_on_ingest, block_on_query, compact_runtime,
<a href=#25 id=25 data-nosnippet>25</a> create_runtime, global_runtime, ingest_runtime, init_datanode_runtimes, init_global_runtimes,
<a href=#26 id=26 data-nosnippet>26</a> init_standalone_runtimes, query_runtime, set_workload_scheduler_enabled,
<a href=#27 id=27 data-nosnippet>27</a> set_workload_scheduler_weights, spawn_blocking_compact, spawn_blocking_global,
<a href=#28 id=28 data-nosnippet>28</a> spawn_blocking_hb, spawn_blocking_ingest, spawn_blocking_query, spawn_compact, spawn_global,
<a href=#29 id=29 data-nosnippet>29</a> spawn_hb, spawn_ingest, spawn_query, workload_scheduler_enabled, workload_scheduler_stats,
<a href=#30 id=30 data-nosnippet>30</a>};
<a href=#31 id=31 data-nosnippet>31</a>
<a href=#32 id=32 data-nosnippet>32</a><span class="kw">pub use </span><span class="kw">crate</span>::repeated_task::{BoxedTaskFunction, RepeatedTask, TaskFunction};
<a href=#33 id=33 data-nosnippet>33</a><span class="kw">pub use </span><span class="kw">crate</span>::runtime::{Builder, JoinError, JoinHandle, Runtime};
</code></pre></div></section></main></body></html>
+328
View File
@@ -0,0 +1,328 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/common/runtime/src/metrics.rs`."><title>metrics.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="common_runtime" data-themes="" data-resource-suffix="" data-rustdoc-version="1.96.1 (31fca3adb 2026-06-26)" data-channel="1.96.1" data-search-js="search-b5634cc7.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../../static.files/storage-41dd4d93.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-5013f961.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-f7c3ffd8.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content" tabindex="-1"><div class="main-heading"><h1><div class="sub-heading">common_runtime/</div>metrics.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="comment">// Copyright 2023 Greptime Team
<a href=#2 id=2 data-nosnippet>2</a>//
<a href=#3 id=3 data-nosnippet>3</a>// Licensed under the Apache License, Version 2.0 (the "License");
<a href=#4 id=4 data-nosnippet>4</a>// you may not use this file except in compliance with the License.
<a href=#5 id=5 data-nosnippet>5</a>// You may obtain a copy of the License at
<a href=#6 id=6 data-nosnippet>6</a>//
<a href=#7 id=7 data-nosnippet>7</a>// http://www.apache.org/licenses/LICENSE-2.0
<a href=#8 id=8 data-nosnippet>8</a>//
<a href=#9 id=9 data-nosnippet>9</a>// Unless required by applicable law or agreed to in writing, software
<a href=#10 id=10 data-nosnippet>10</a>// distributed under the License is distributed on an "AS IS" BASIS,
<a href=#11 id=11 data-nosnippet>11</a>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<a href=#12 id=12 data-nosnippet>12</a>// See the License for the specific language governing permissions and
<a href=#13 id=13 data-nosnippet>13</a>// limitations under the License.
<a href=#14 id=14 data-nosnippet>14</a>
<a href=#15 id=15 data-nosnippet>15</a></span><span class="doccomment">//! Runtime metrics
<a href=#16 id=16 data-nosnippet>16</a></span><span class="kw">use </span>std::collections::BTreeMap;
<a href=#17 id=17 data-nosnippet>17</a><span class="kw">use </span>std::sync::Mutex;
<a href=#18 id=18 data-nosnippet>18</a><span class="kw">use </span>std::time::Duration;
<a href=#19 id=19 data-nosnippet>19</a>
<a href=#20 id=20 data-nosnippet>20</a><span class="kw">use </span>catio::Scheduler;
<a href=#21 id=21 data-nosnippet>21</a><span class="kw">use </span>lazy_static::lazy_static;
<a href=#22 id=22 data-nosnippet>22</a><span class="kw">use </span>prometheus::core::{Collector, Desc};
<a href=#23 id=23 data-nosnippet>23</a><span class="kw">use </span>prometheus::proto::MetricFamily;
<a href=#24 id=24 data-nosnippet>24</a><span class="kw">use </span>prometheus::<span class="kw-2">*</span>;
<a href=#25 id=25 data-nosnippet>25</a>
<a href=#26 id=26 data-nosnippet>26</a><span class="kw">use </span><span class="kw">crate</span>::global::{QUERY_TASK_CLASS, WRITE_TASK_CLASS};
<a href=#27 id=27 data-nosnippet>27</a>
<a href=#28 id=28 data-nosnippet>28</a><span class="kw">pub const </span>THREAD_NAME_LABEL: <span class="kw-2">&amp;</span>str = <span class="string">"thread_name"</span>;
<a href=#29 id=29 data-nosnippet>29</a>
<a href=#30 id=30 data-nosnippet>30</a><span class="macro">lazy_static!</span> {
<a href=#31 id=31 data-nosnippet>31</a> <span class="kw">pub static </span><span class="kw-2">ref </span>METRIC_RUNTIME_THREADS_ALIVE: IntGaugeVec = <span class="macro">register_int_gauge_vec!</span>(
<a href=#32 id=32 data-nosnippet>32</a> <span class="string">"greptime_runtime_threads_alive"</span>,
<a href=#33 id=33 data-nosnippet>33</a> <span class="string">"runtime threads alive"</span>,
<a href=#34 id=34 data-nosnippet>34</a> <span class="kw-2">&amp;</span>[THREAD_NAME_LABEL]
<a href=#35 id=35 data-nosnippet>35</a> )
<a href=#36 id=36 data-nosnippet>36</a> .unwrap();
<a href=#37 id=37 data-nosnippet>37</a> <span class="kw">pub static </span><span class="kw-2">ref </span>METRIC_RUNTIME_THREADS_IDLE: IntGaugeVec = <span class="macro">register_int_gauge_vec!</span>(
<a href=#38 id=38 data-nosnippet>38</a> <span class="string">"greptime_runtime_threads_idle"</span>,
<a href=#39 id=39 data-nosnippet>39</a> <span class="string">"runtime threads idle"</span>,
<a href=#40 id=40 data-nosnippet>40</a> <span class="kw-2">&amp;</span>[THREAD_NAME_LABEL]
<a href=#41 id=41 data-nosnippet>41</a> )
<a href=#42 id=42 data-nosnippet>42</a> .unwrap();
<a href=#43 id=43 data-nosnippet>43</a>}
<a href=#44 id=44 data-nosnippet>44</a>
<a href=#45 id=45 data-nosnippet>45</a><span class="attr">#[derive(Clone, Default)]
<a href=#46 id=46 data-nosnippet>46</a></span><span class="kw">struct </span>ClassSnapshot {
<a href=#47 id=47 data-nosnippet>47</a> polls: u64,
<a href=#48 id=48 data-nosnippet>48</a> total_admission_wait: Duration,
<a href=#49 id=49 data-nosnippet>49</a>}
<a href=#50 id=50 data-nosnippet>50</a>
<a href=#51 id=51 data-nosnippet>51</a><span class="kw">struct </span>WorkloadSchedulerCollector {
<a href=#52 id=52 data-nosnippet>52</a> scheduler: Scheduler,
<a href=#53 id=53 data-nosnippet>53</a> enabled: IntGauge,
<a href=#54 id=54 data-nosnippet>54</a> active: IntGauge,
<a href=#55 id=55 data-nosnippet>55</a> weight: IntGaugeVec,
<a href=#56 id=56 data-nosnippet>56</a> queued: IntGaugeVec,
<a href=#57 id=57 data-nosnippet>57</a> polls: IntCounterVec,
<a href=#58 id=58 data-nosnippet>58</a> total_admission_wait: CounterVec,
<a href=#59 id=59 data-nosnippet>59</a> snapshots: Mutex&lt;BTreeMap&lt;<span class="kw-2">&amp;</span><span class="lifetime">'static </span>str, ClassSnapshot&gt;&gt;,
<a href=#60 id=60 data-nosnippet>60</a>}
<a href=#61 id=61 data-nosnippet>61</a>
<a href=#62 id=62 data-nosnippet>62</a><span class="kw">impl </span>WorkloadSchedulerCollector {
<a href=#63 id=63 data-nosnippet>63</a> <span class="kw">fn </span>new(scheduler: Scheduler) -&gt; <span class="self">Self </span>{
<a href=#64 id=64 data-nosnippet>64</a> <span class="kw">let </span>workload_label = <span class="kw-2">&amp;</span>[<span class="string">"workload"</span>];
<a href=#65 id=65 data-nosnippet>65</a> <span class="self">Self </span>{
<a href=#66 id=66 data-nosnippet>66</a> scheduler,
<a href=#67 id=67 data-nosnippet>67</a> enabled: IntGauge::new(
<a href=#68 id=68 data-nosnippet>68</a> <span class="string">"greptime_workload_scheduler_enabled"</span>,
<a href=#69 id=69 data-nosnippet>69</a> <span class="string">"Whether the workload scheduler is enabled"</span>,
<a href=#70 id=70 data-nosnippet>70</a> )
<a href=#71 id=71 data-nosnippet>71</a> .unwrap(),
<a href=#72 id=72 data-nosnippet>72</a> active: IntGauge::new(
<a href=#73 id=73 data-nosnippet>73</a> <span class="string">"greptime_workload_scheduler_active_polls"</span>,
<a href=#74 id=74 data-nosnippet>74</a> <span class="string">"Task polls admitted to Tokio but not yet completed"</span>,
<a href=#75 id=75 data-nosnippet>75</a> )
<a href=#76 id=76 data-nosnippet>76</a> .unwrap(),
<a href=#77 id=77 data-nosnippet>77</a> weight: IntGaugeVec::new(
<a href=#78 id=78 data-nosnippet>78</a> Opts::new(
<a href=#79 id=79 data-nosnippet>79</a> <span class="string">"greptime_workload_scheduler_weight"</span>,
<a href=#80 id=80 data-nosnippet>80</a> <span class="string">"Configured workload scheduler weight"</span>,
<a href=#81 id=81 data-nosnippet>81</a> ),
<a href=#82 id=82 data-nosnippet>82</a> workload_label,
<a href=#83 id=83 data-nosnippet>83</a> )
<a href=#84 id=84 data-nosnippet>84</a> .unwrap(),
<a href=#85 id=85 data-nosnippet>85</a> queued: IntGaugeVec::new(
<a href=#86 id=86 data-nosnippet>86</a> Opts::new(
<a href=#87 id=87 data-nosnippet>87</a> <span class="string">"greptime_workload_scheduler_queued_tasks"</span>,
<a href=#88 id=88 data-nosnippet>88</a> <span class="string">"Tasks queued in the workload scheduler"</span>,
<a href=#89 id=89 data-nosnippet>89</a> ),
<a href=#90 id=90 data-nosnippet>90</a> workload_label,
<a href=#91 id=91 data-nosnippet>91</a> )
<a href=#92 id=92 data-nosnippet>92</a> .unwrap(),
<a href=#93 id=93 data-nosnippet>93</a> polls: IntCounterVec::new(
<a href=#94 id=94 data-nosnippet>94</a> Opts::new(
<a href=#95 id=95 data-nosnippet>95</a> <span class="string">"greptime_workload_scheduler_polls_total"</span>,
<a href=#96 id=96 data-nosnippet>96</a> <span class="string">"Cumulative task polls admitted by the workload scheduler"</span>,
<a href=#97 id=97 data-nosnippet>97</a> ),
<a href=#98 id=98 data-nosnippet>98</a> workload_label,
<a href=#99 id=99 data-nosnippet>99</a> )
<a href=#100 id=100 data-nosnippet>100</a> .unwrap(),
<a href=#101 id=101 data-nosnippet>101</a> total_admission_wait: CounterVec::new(
<a href=#102 id=102 data-nosnippet>102</a> Opts::new(
<a href=#103 id=103 data-nosnippet>103</a> <span class="string">"greptime_workload_scheduler_admission_wait_seconds_total"</span>,
<a href=#104 id=104 data-nosnippet>104</a> <span class="string">"Cumulative workload scheduler admission wait time in seconds"</span>,
<a href=#105 id=105 data-nosnippet>105</a> ),
<a href=#106 id=106 data-nosnippet>106</a> workload_label,
<a href=#107 id=107 data-nosnippet>107</a> )
<a href=#108 id=108 data-nosnippet>108</a> .unwrap(),
<a href=#109 id=109 data-nosnippet>109</a> snapshots: Mutex::new(BTreeMap::new()),
<a href=#110 id=110 data-nosnippet>110</a> }
<a href=#111 id=111 data-nosnippet>111</a> }
<a href=#112 id=112 data-nosnippet>112</a>
<a href=#113 id=113 data-nosnippet>113</a> <span class="kw">fn </span>update_locked(<span class="kw-2">&amp;</span><span class="self">self</span>, snapshots: <span class="kw-2">&amp;mut </span>BTreeMap&lt;<span class="kw-2">&amp;</span><span class="lifetime">'static </span>str, ClassSnapshot&gt;) {
<a href=#114 id=114 data-nosnippet>114</a> <span class="kw">let </span>stats = <span class="self">self</span>.scheduler.stats();
<a href=#115 id=115 data-nosnippet>115</a> <span class="self">self</span>.enabled.set(i64::from(<span class="self">self</span>.scheduler.is_enabled()));
<a href=#116 id=116 data-nosnippet>116</a> <span class="self">self</span>.active.set(
<a href=#117 id=117 data-nosnippet>117</a> stats
<a href=#118 id=118 data-nosnippet>118</a> .active_polls
<a href=#119 id=119 data-nosnippet>119</a> .min(i64::MAX <span class="kw">as </span>usize)
<a href=#120 id=120 data-nosnippet>120</a> .try_into()
<a href=#121 id=121 data-nosnippet>121</a> .unwrap_or(i64::MAX),
<a href=#122 id=122 data-nosnippet>122</a> );
<a href=#123 id=123 data-nosnippet>123</a>
<a href=#124 id=124 data-nosnippet>124</a> <span class="kw">for </span>(class, workload) <span class="kw">in </span>[(QUERY_TASK_CLASS, <span class="string">"query"</span>), (WRITE_TASK_CLASS, <span class="string">"write"</span>)] {
<a href=#125 id=125 data-nosnippet>125</a> <span class="kw">let </span>class_stats = stats.classes.get(<span class="kw-2">&amp;</span>class).cloned().unwrap_or_default();
<a href=#126 id=126 data-nosnippet>126</a> <span class="kw">let </span>labels = <span class="kw-2">&amp;</span>[workload];
<a href=#127 id=127 data-nosnippet>127</a> <span class="self">self</span>.weight
<a href=#128 id=128 data-nosnippet>128</a> .with_label_values(labels)
<a href=#129 id=129 data-nosnippet>129</a> .set(i64::from(class_stats.weight));
<a href=#130 id=130 data-nosnippet>130</a> <span class="self">self</span>.queued.with_label_values(labels).set(
<a href=#131 id=131 data-nosnippet>131</a> class_stats
<a href=#132 id=132 data-nosnippet>132</a> .queued
<a href=#133 id=133 data-nosnippet>133</a> .min(i64::MAX <span class="kw">as </span>usize)
<a href=#134 id=134 data-nosnippet>134</a> .try_into()
<a href=#135 id=135 data-nosnippet>135</a> .unwrap_or(i64::MAX),
<a href=#136 id=136 data-nosnippet>136</a> );
<a href=#137 id=137 data-nosnippet>137</a> <span class="kw">let </span>previous = snapshots.entry(workload).or_default();
<a href=#138 id=138 data-nosnippet>138</a> <span class="self">self</span>.polls
<a href=#139 id=139 data-nosnippet>139</a> .with_label_values(labels)
<a href=#140 id=140 data-nosnippet>140</a> .inc_by(class_stats.polls.saturating_sub(previous.polls));
<a href=#141 id=141 data-nosnippet>141</a> <span class="self">self</span>.total_admission_wait.with_label_values(labels).inc_by(
<a href=#142 id=142 data-nosnippet>142</a> class_stats
<a href=#143 id=143 data-nosnippet>143</a> .total_admission_wait
<a href=#144 id=144 data-nosnippet>144</a> .saturating_sub(previous.total_admission_wait)
<a href=#145 id=145 data-nosnippet>145</a> .as_secs_f64(),
<a href=#146 id=146 data-nosnippet>146</a> );
<a href=#147 id=147 data-nosnippet>147</a> <span class="kw-2">*</span>previous = ClassSnapshot {
<a href=#148 id=148 data-nosnippet>148</a> polls: class_stats.polls,
<a href=#149 id=149 data-nosnippet>149</a> total_admission_wait: class_stats.total_admission_wait,
<a href=#150 id=150 data-nosnippet>150</a> };
<a href=#151 id=151 data-nosnippet>151</a> }
<a href=#152 id=152 data-nosnippet>152</a> }
<a href=#153 id=153 data-nosnippet>153</a>}
<a href=#154 id=154 data-nosnippet>154</a>
<a href=#155 id=155 data-nosnippet>155</a><span class="kw">impl </span>Collector <span class="kw">for </span>WorkloadSchedulerCollector {
<a href=#156 id=156 data-nosnippet>156</a> <span class="kw">fn </span>desc(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Vec&lt;<span class="kw-2">&amp;</span>Desc&gt; {
<a href=#157 id=157 data-nosnippet>157</a> <span class="kw">let </span><span class="kw-2">mut </span>desc = <span class="self">self</span>.enabled.desc();
<a href=#158 id=158 data-nosnippet>158</a> desc.extend(<span class="self">self</span>.active.desc());
<a href=#159 id=159 data-nosnippet>159</a> desc.extend(<span class="self">self</span>.weight.desc());
<a href=#160 id=160 data-nosnippet>160</a> desc.extend(<span class="self">self</span>.queued.desc());
<a href=#161 id=161 data-nosnippet>161</a> desc.extend(<span class="self">self</span>.polls.desc());
<a href=#162 id=162 data-nosnippet>162</a> desc.extend(<span class="self">self</span>.total_admission_wait.desc());
<a href=#163 id=163 data-nosnippet>163</a> desc
<a href=#164 id=164 data-nosnippet>164</a> }
<a href=#165 id=165 data-nosnippet>165</a>
<a href=#166 id=166 data-nosnippet>166</a> <span class="kw">fn </span>collect(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Vec&lt;MetricFamily&gt; {
<a href=#167 id=167 data-nosnippet>167</a> <span class="kw">let </span><span class="kw-2">mut </span>snapshots = <span class="self">self</span>.snapshots.lock().unwrap();
<a href=#168 id=168 data-nosnippet>168</a> <span class="self">self</span>.update_locked(<span class="kw-2">&amp;mut </span>snapshots);
<a href=#169 id=169 data-nosnippet>169</a> <span class="kw">let </span><span class="kw-2">mut </span>families = <span class="self">self</span>.enabled.collect();
<a href=#170 id=170 data-nosnippet>170</a> families.extend(<span class="self">self</span>.active.collect());
<a href=#171 id=171 data-nosnippet>171</a> families.extend(<span class="self">self</span>.weight.collect());
<a href=#172 id=172 data-nosnippet>172</a> families.extend(<span class="self">self</span>.queued.collect());
<a href=#173 id=173 data-nosnippet>173</a> families.extend(<span class="self">self</span>.polls.collect());
<a href=#174 id=174 data-nosnippet>174</a> families.extend(<span class="self">self</span>.total_admission_wait.collect());
<a href=#175 id=175 data-nosnippet>175</a> families
<a href=#176 id=176 data-nosnippet>176</a> }
<a href=#177 id=177 data-nosnippet>177</a>}
<a href=#178 id=178 data-nosnippet>178</a>
<a href=#179 id=179 data-nosnippet>179</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>register_workload_scheduler_metrics(scheduler: Scheduler) {
<a href=#180 id=180 data-nosnippet>180</a> register(Box::new(WorkloadSchedulerCollector::new(scheduler)))
<a href=#181 id=181 data-nosnippet>181</a> .expect(<span class="string">"workload scheduler metrics collector registration must succeed"</span>);
<a href=#182 id=182 data-nosnippet>182</a>}
<a href=#183 id=183 data-nosnippet>183</a>
<a href=#184 id=184 data-nosnippet>184</a><span class="attr">#[cfg(test)]
<a href=#185 id=185 data-nosnippet>185</a></span><span class="kw">mod </span>tests {
<a href=#186 id=186 data-nosnippet>186</a> <span class="kw">use </span>std::collections::{BTreeMap, BTreeSet};
<a href=#187 id=187 data-nosnippet>187</a> <span class="kw">use </span>std::time::Duration;
<a href=#188 id=188 data-nosnippet>188</a>
<a href=#189 id=189 data-nosnippet>189</a> <span class="kw">use </span>prometheus::proto::{MetricFamily, MetricType};
<a href=#190 id=190 data-nosnippet>190</a>
<a href=#191 id=191 data-nosnippet>191</a> <span class="kw">use </span>super::<span class="kw-2">*</span>;
<a href=#192 id=192 data-nosnippet>192</a>
<a href=#193 id=193 data-nosnippet>193</a> <span class="kw">fn </span>family&lt;<span class="lifetime">'a</span>&gt;(families: <span class="kw-2">&amp;</span><span class="lifetime">'a </span>[MetricFamily], name: <span class="kw-2">&amp;</span>str) -&gt; <span class="kw-2">&amp;</span><span class="lifetime">'a </span>MetricFamily {
<a href=#194 id=194 data-nosnippet>194</a> families
<a href=#195 id=195 data-nosnippet>195</a> .iter()
<a href=#196 id=196 data-nosnippet>196</a> .find(|family| family.name() == name)
<a href=#197 id=197 data-nosnippet>197</a> .unwrap_or_else(|| <span class="macro">panic!</span>(<span class="string">"missing metric family {name}"</span>))
<a href=#198 id=198 data-nosnippet>198</a> }
<a href=#199 id=199 data-nosnippet>199</a>
<a href=#200 id=200 data-nosnippet>200</a> <span class="kw">fn </span>counter_values(families: <span class="kw-2">&amp;</span>[MetricFamily]) -&gt; BTreeMap&lt;String, BTreeMap&lt;String, f64&gt;&gt; {
<a href=#201 id=201 data-nosnippet>201</a> [
<a href=#202 id=202 data-nosnippet>202</a> <span class="string">"greptime_workload_scheduler_polls_total"</span>,
<a href=#203 id=203 data-nosnippet>203</a> <span class="string">"greptime_workload_scheduler_admission_wait_seconds_total"</span>,
<a href=#204 id=204 data-nosnippet>204</a> ]
<a href=#205 id=205 data-nosnippet>205</a> .into_iter()
<a href=#206 id=206 data-nosnippet>206</a> .map(|name| {
<a href=#207 id=207 data-nosnippet>207</a> <span class="kw">let </span>values = family(families, name)
<a href=#208 id=208 data-nosnippet>208</a> .get_metric()
<a href=#209 id=209 data-nosnippet>209</a> .iter()
<a href=#210 id=210 data-nosnippet>210</a> .map(|metric| {
<a href=#211 id=211 data-nosnippet>211</a> (
<a href=#212 id=212 data-nosnippet>212</a> metric.get_label()[<span class="number">0</span>].value().to_string(),
<a href=#213 id=213 data-nosnippet>213</a> metric.get_counter().value(),
<a href=#214 id=214 data-nosnippet>214</a> )
<a href=#215 id=215 data-nosnippet>215</a> })
<a href=#216 id=216 data-nosnippet>216</a> .collect();
<a href=#217 id=217 data-nosnippet>217</a> (name.to_string(), values)
<a href=#218 id=218 data-nosnippet>218</a> })
<a href=#219 id=219 data-nosnippet>219</a> .collect()
<a href=#220 id=220 data-nosnippet>220</a> }
<a href=#221 id=221 data-nosnippet>221</a>
<a href=#222 id=222 data-nosnippet>222</a> <span class="attr">#[test]
<a href=#223 id=223 data-nosnippet>223</a> </span><span class="kw">fn </span>workload_scheduler_collector_reports_class_metrics_and_deltas() {
<a href=#224 id=224 data-nosnippet>224</a> <span class="kw">let </span>scheduler = Scheduler::builder()
<a href=#225 id=225 data-nosnippet>225</a> .max_concurrent_polls(<span class="number">1</span>)
<a href=#226 id=226 data-nosnippet>226</a> .weight(QUERY_TASK_CLASS, <span class="number">2</span>)
<a href=#227 id=227 data-nosnippet>227</a> .weight(WRITE_TASK_CLASS, <span class="number">3</span>)
<a href=#228 id=228 data-nosnippet>228</a> .build();
<a href=#229 id=229 data-nosnippet>229</a> scheduler.set_enabled(<span class="bool-val">true</span>);
<a href=#230 id=230 data-nosnippet>230</a> <span class="kw">let </span>collector = WorkloadSchedulerCollector::new(scheduler.clone());
<a href=#231 id=231 data-nosnippet>231</a>
<a href=#232 id=232 data-nosnippet>232</a> <span class="kw">let </span>first = collector.collect();
<a href=#233 id=233 data-nosnippet>233</a> <span class="kw">let </span>expected = [
<a href=#234 id=234 data-nosnippet>234</a> (
<a href=#235 id=235 data-nosnippet>235</a> <span class="string">"greptime_workload_scheduler_enabled"</span>,
<a href=#236 id=236 data-nosnippet>236</a> MetricType::GAUGE,
<a href=#237 id=237 data-nosnippet>237</a> <span class="bool-val">false</span>,
<a href=#238 id=238 data-nosnippet>238</a> ),
<a href=#239 id=239 data-nosnippet>239</a> (
<a href=#240 id=240 data-nosnippet>240</a> <span class="string">"greptime_workload_scheduler_active_polls"</span>,
<a href=#241 id=241 data-nosnippet>241</a> MetricType::GAUGE,
<a href=#242 id=242 data-nosnippet>242</a> <span class="bool-val">false</span>,
<a href=#243 id=243 data-nosnippet>243</a> ),
<a href=#244 id=244 data-nosnippet>244</a> (
<a href=#245 id=245 data-nosnippet>245</a> <span class="string">"greptime_workload_scheduler_weight"</span>,
<a href=#246 id=246 data-nosnippet>246</a> MetricType::GAUGE,
<a href=#247 id=247 data-nosnippet>247</a> <span class="bool-val">true</span>,
<a href=#248 id=248 data-nosnippet>248</a> ),
<a href=#249 id=249 data-nosnippet>249</a> (
<a href=#250 id=250 data-nosnippet>250</a> <span class="string">"greptime_workload_scheduler_queued_tasks"</span>,
<a href=#251 id=251 data-nosnippet>251</a> MetricType::GAUGE,
<a href=#252 id=252 data-nosnippet>252</a> <span class="bool-val">true</span>,
<a href=#253 id=253 data-nosnippet>253</a> ),
<a href=#254 id=254 data-nosnippet>254</a> (
<a href=#255 id=255 data-nosnippet>255</a> <span class="string">"greptime_workload_scheduler_polls_total"</span>,
<a href=#256 id=256 data-nosnippet>256</a> MetricType::COUNTER,
<a href=#257 id=257 data-nosnippet>257</a> <span class="bool-val">true</span>,
<a href=#258 id=258 data-nosnippet>258</a> ),
<a href=#259 id=259 data-nosnippet>259</a> (
<a href=#260 id=260 data-nosnippet>260</a> <span class="string">"greptime_workload_scheduler_admission_wait_seconds_total"</span>,
<a href=#261 id=261 data-nosnippet>261</a> MetricType::COUNTER,
<a href=#262 id=262 data-nosnippet>262</a> <span class="bool-val">true</span>,
<a href=#263 id=263 data-nosnippet>263</a> ),
<a href=#264 id=264 data-nosnippet>264</a> ];
<a href=#265 id=265 data-nosnippet>265</a> <span class="kw">let </span>expected_names: BTreeSet&lt;<span class="kw">_</span>&gt; = expected.iter().map(|(name, <span class="kw">_</span>, <span class="kw">_</span>)| <span class="kw-2">*</span>name).collect();
<a href=#266 id=266 data-nosnippet>266</a> <span class="kw">let </span>actual_names: BTreeSet&lt;<span class="kw">_</span>&gt; = first.iter().map(MetricFamily::name).collect();
<a href=#267 id=267 data-nosnippet>267</a> <span class="macro">assert_eq!</span>(expected_names, actual_names);
<a href=#268 id=268 data-nosnippet>268</a> <span class="kw">for </span>(name, metric_type, has_workload_label) <span class="kw">in </span>expected {
<a href=#269 id=269 data-nosnippet>269</a> <span class="kw">let </span>metric_family = family(<span class="kw-2">&amp;</span>first, name);
<a href=#270 id=270 data-nosnippet>270</a> <span class="macro">assert_eq!</span>(metric_type, metric_family.get_field_type(), <span class="string">"{name}"</span>);
<a href=#271 id=271 data-nosnippet>271</a> <span class="kw">let </span>workloads: BTreeSet&lt;<span class="kw">_</span>&gt; = metric_family
<a href=#272 id=272 data-nosnippet>272</a> .get_metric()
<a href=#273 id=273 data-nosnippet>273</a> .iter()
<a href=#274 id=274 data-nosnippet>274</a> .flat_map(|metric| {
<a href=#275 id=275 data-nosnippet>275</a> <span class="macro">assert_eq!</span>(has_workload_label, !metric.get_label().is_empty());
<a href=#276 id=276 data-nosnippet>276</a> metric
<a href=#277 id=277 data-nosnippet>277</a> .get_label()
<a href=#278 id=278 data-nosnippet>278</a> .iter()
<a href=#279 id=279 data-nosnippet>279</a> .map(|label| {
<a href=#280 id=280 data-nosnippet>280</a> <span class="macro">assert_eq!</span>(<span class="string">"workload"</span>, label.name());
<a href=#281 id=281 data-nosnippet>281</a> label.value()
<a href=#282 id=282 data-nosnippet>282</a> })
<a href=#283 id=283 data-nosnippet>283</a> .collect::&lt;Vec&lt;<span class="kw">_</span>&gt;&gt;()
<a href=#284 id=284 data-nosnippet>284</a> })
<a href=#285 id=285 data-nosnippet>285</a> .collect();
<a href=#286 id=286 data-nosnippet>286</a> <span class="kw">if </span>has_workload_label {
<a href=#287 id=287 data-nosnippet>287</a> <span class="macro">assert_eq!</span>(BTreeSet::from([<span class="string">"query"</span>, <span class="string">"write"</span>]), workloads);
<a href=#288 id=288 data-nosnippet>288</a> } <span class="kw">else </span>{
<a href=#289 id=289 data-nosnippet>289</a> <span class="macro">assert!</span>(workloads.is_empty());
<a href=#290 id=290 data-nosnippet>290</a> }
<a href=#291 id=291 data-nosnippet>291</a> }
<a href=#292 id=292 data-nosnippet>292</a>
<a href=#293 id=293 data-nosnippet>293</a> <span class="kw">let </span>second = collector.collect();
<a href=#294 id=294 data-nosnippet>294</a> <span class="macro">assert_eq!</span>(counter_values(<span class="kw-2">&amp;</span>first), counter_values(<span class="kw-2">&amp;</span>second));
<a href=#295 id=295 data-nosnippet>295</a>
<a href=#296 id=296 data-nosnippet>296</a> scheduler.set_enabled(<span class="bool-val">true</span>);
<a href=#297 id=297 data-nosnippet>297</a> <span class="kw">let </span>runtime = tokio::runtime::Builder::new_current_thread()
<a href=#298 id=298 data-nosnippet>298</a> .enable_time()
<a href=#299 id=299 data-nosnippet>299</a> .build()
<a href=#300 id=300 data-nosnippet>300</a> .unwrap();
<a href=#301 id=301 data-nosnippet>301</a> runtime.block_on(<span class="kw">async </span>{
<a href=#302 id=302 data-nosnippet>302</a> <span class="kw">let </span>query = scheduler.spawn_in(QUERY_TASK_CLASS, <span class="kw">async </span>{
<a href=#303 id=303 data-nosnippet>303</a> tokio::time::sleep(Duration::from_millis(<span class="number">1</span>)).<span class="kw">await</span>;
<a href=#304 id=304 data-nosnippet>304</a> });
<a href=#305 id=305 data-nosnippet>305</a> <span class="kw">let </span>write = scheduler.spawn_in(WRITE_TASK_CLASS, <span class="kw">async </span>{
<a href=#306 id=306 data-nosnippet>306</a> tokio::time::sleep(Duration::from_millis(<span class="number">1</span>)).<span class="kw">await</span>;
<a href=#307 id=307 data-nosnippet>307</a> });
<a href=#308 id=308 data-nosnippet>308</a> tokio::time::timeout(Duration::from_secs(<span class="number">1</span>), <span class="kw">async </span>{
<a href=#309 id=309 data-nosnippet>309</a> query.<span class="kw">await</span>.unwrap();
<a href=#310 id=310 data-nosnippet>310</a> write.<span class="kw">await</span>.unwrap();
<a href=#311 id=311 data-nosnippet>311</a> })
<a href=#312 id=312 data-nosnippet>312</a> .<span class="kw">await
<a href=#313 id=313 data-nosnippet>313</a> </span>.expect(<span class="string">"scheduled test tasks did not complete"</span>);
<a href=#314 id=314 data-nosnippet>314</a> });
<a href=#315 id=315 data-nosnippet>315</a>
<a href=#316 id=316 data-nosnippet>316</a> <span class="kw">let </span>third = collector.collect();
<a href=#317 id=317 data-nosnippet>317</a> <span class="kw">let </span>before = counter_values(<span class="kw-2">&amp;</span>second);
<a href=#318 id=318 data-nosnippet>318</a> <span class="kw">let </span>after = counter_values(<span class="kw-2">&amp;</span>third);
<a href=#319 id=319 data-nosnippet>319</a> <span class="kw">for </span>workload <span class="kw">in </span>[<span class="string">"query"</span>, <span class="string">"write"</span>] {
<a href=#320 id=320 data-nosnippet>320</a> <span class="kw">let </span>metric = <span class="string">"greptime_workload_scheduler_polls_total"</span>;
<a href=#321 id=321 data-nosnippet>321</a> <span class="macro">assert!</span>(
<a href=#322 id=322 data-nosnippet>322</a> after[metric][workload] &gt; before[metric][workload],
<a href=#323 id=323 data-nosnippet>323</a> <span class="string">"{metric} did not increase for {workload}"
<a href=#324 id=324 data-nosnippet>324</a> </span>);
<a href=#325 id=325 data-nosnippet>325</a> }
<a href=#326 id=326 data-nosnippet>326</a> }
<a href=#327 id=327 data-nosnippet>327</a>}
</code></pre></div></section></main></body></html>
+228
View File
@@ -0,0 +1,228 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/common/runtime/src/repeated_task.rs`."><title>repeated_task.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="common_runtime" data-themes="" data-resource-suffix="" data-rustdoc-version="1.96.1 (31fca3adb 2026-06-26)" data-channel="1.96.1" data-search-js="search-b5634cc7.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../../static.files/storage-41dd4d93.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-5013f961.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-f7c3ffd8.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content" tabindex="-1"><div class="main-heading"><h1><div class="sub-heading">common_runtime/</div>repeated_task.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="comment">// Copyright 2023 Greptime Team
<a href=#2 id=2 data-nosnippet>2</a>//
<a href=#3 id=3 data-nosnippet>3</a>// Licensed under the Apache License, Version 2.0 (the "License");
<a href=#4 id=4 data-nosnippet>4</a>// you may not use this file except in compliance with the License.
<a href=#5 id=5 data-nosnippet>5</a>// You may obtain a copy of the License at
<a href=#6 id=6 data-nosnippet>6</a>//
<a href=#7 id=7 data-nosnippet>7</a>// http://www.apache.org/licenses/LICENSE-2.0
<a href=#8 id=8 data-nosnippet>8</a>//
<a href=#9 id=9 data-nosnippet>9</a>// Unless required by applicable law or agreed to in writing, software
<a href=#10 id=10 data-nosnippet>10</a>// distributed under the License is distributed on an "AS IS" BASIS,
<a href=#11 id=11 data-nosnippet>11</a>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<a href=#12 id=12 data-nosnippet>12</a>// See the License for the specific language governing permissions and
<a href=#13 id=13 data-nosnippet>13</a>// limitations under the License.
<a href=#14 id=14 data-nosnippet>14</a>
<a href=#15 id=15 data-nosnippet>15</a></span><span class="kw">use </span>std::sync::Mutex;
<a href=#16 id=16 data-nosnippet>16</a><span class="kw">use </span>std::sync::atomic::{AtomicBool, Ordering};
<a href=#17 id=17 data-nosnippet>17</a><span class="kw">use </span>std::time::Duration;
<a href=#18 id=18 data-nosnippet>18</a>
<a href=#19 id=19 data-nosnippet>19</a><span class="kw">use </span>common_error::ext::ErrorExt;
<a href=#20 id=20 data-nosnippet>20</a><span class="kw">use </span>common_telemetry::{debug, error};
<a href=#21 id=21 data-nosnippet>21</a><span class="kw">use </span>snafu::{ResultExt, ensure};
<a href=#22 id=22 data-nosnippet>22</a><span class="kw">use </span>tokio::task::JoinHandle;
<a href=#23 id=23 data-nosnippet>23</a><span class="kw">use </span>tokio_util::sync::CancellationToken;
<a href=#24 id=24 data-nosnippet>24</a>
<a href=#25 id=25 data-nosnippet>25</a><span class="kw">use </span><span class="kw">crate</span>::Runtime;
<a href=#26 id=26 data-nosnippet>26</a><span class="kw">use </span><span class="kw">crate</span>::error::{IllegalStateSnafu, <span class="prelude-ty">Result</span>, WaitGcTaskStopSnafu};
<a href=#27 id=27 data-nosnippet>27</a><span class="kw">use </span><span class="kw">crate</span>::runtime::RuntimeTrait;
<a href=#28 id=28 data-nosnippet>28</a>
<a href=#29 id=29 data-nosnippet>29</a><span class="doccomment">/// Task to execute repeatedly.
<a href=#30 id=30 data-nosnippet>30</a></span><span class="attr">#[async_trait::async_trait]
<a href=#31 id=31 data-nosnippet>31</a></span><span class="kw">pub trait </span>TaskFunction&lt;E&gt; {
<a href=#32 id=32 data-nosnippet>32</a> <span class="doccomment">/// Invoke the task.
<a href=#33 id=33 data-nosnippet>33</a> </span><span class="kw">async fn </span>call(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; std::result::Result&lt;(), E&gt;;
<a href=#34 id=34 data-nosnippet>34</a>
<a href=#35 id=35 data-nosnippet>35</a> <span class="doccomment">/// Name of the task.
<a href=#36 id=36 data-nosnippet>36</a> </span><span class="kw">fn </span>name(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>str;
<a href=#37 id=37 data-nosnippet>37</a>}
<a href=#38 id=38 data-nosnippet>38</a>
<a href=#39 id=39 data-nosnippet>39</a><span class="kw">pub type </span>BoxedTaskFunction&lt;E&gt; = Box&lt;<span class="kw">dyn </span>TaskFunction&lt;E&gt; + Send + Sync + <span class="lifetime">'static</span>&gt;;
<a href=#40 id=40 data-nosnippet>40</a>
<a href=#41 id=41 data-nosnippet>41</a><span class="kw">struct </span>TaskInner&lt;E&gt; {
<a href=#42 id=42 data-nosnippet>42</a> <span class="doccomment">/// The repeated task handle. This handle is Some if the task is started.
<a href=#43 id=43 data-nosnippet>43</a> </span>task_handle: <span class="prelude-ty">Option</span>&lt;JoinHandle&lt;()&gt;&gt;,
<a href=#44 id=44 data-nosnippet>44</a>
<a href=#45 id=45 data-nosnippet>45</a> <span class="doccomment">/// The task_fn to run. This is Some if the task is not started.
<a href=#46 id=46 data-nosnippet>46</a> </span>task_fn: <span class="prelude-ty">Option</span>&lt;BoxedTaskFunction&lt;E&gt;&gt;,
<a href=#47 id=47 data-nosnippet>47</a>}
<a href=#48 id=48 data-nosnippet>48</a>
<a href=#49 id=49 data-nosnippet>49</a><span class="kw">pub struct </span>RepeatedTask&lt;E&gt; {
<a href=#50 id=50 data-nosnippet>50</a> name: String,
<a href=#51 id=51 data-nosnippet>51</a> cancel_token: CancellationToken,
<a href=#52 id=52 data-nosnippet>52</a> inner: Mutex&lt;TaskInner&lt;E&gt;&gt;,
<a href=#53 id=53 data-nosnippet>53</a> started: AtomicBool,
<a href=#54 id=54 data-nosnippet>54</a> interval: Duration,
<a href=#55 id=55 data-nosnippet>55</a> initial_delay: <span class="prelude-ty">Option</span>&lt;Duration&gt;,
<a href=#56 id=56 data-nosnippet>56</a>}
<a href=#57 id=57 data-nosnippet>57</a>
<a href=#58 id=58 data-nosnippet>58</a><span class="kw">impl</span>&lt;E&gt; std::fmt::Display <span class="kw">for </span>RepeatedTask&lt;E&gt; {
<a href=#59 id=59 data-nosnippet>59</a> <span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>std::fmt::Formatter&lt;<span class="lifetime">'_</span>&gt;) -&gt; std::fmt::Result {
<a href=#60 id=60 data-nosnippet>60</a> <span class="macro">write!</span>(f, <span class="string">"RepeatedTask({})"</span>, <span class="self">self</span>.name)
<a href=#61 id=61 data-nosnippet>61</a> }
<a href=#62 id=62 data-nosnippet>62</a>}
<a href=#63 id=63 data-nosnippet>63</a>
<a href=#64 id=64 data-nosnippet>64</a><span class="kw">impl</span>&lt;E&gt; std::fmt::Debug <span class="kw">for </span>RepeatedTask&lt;E&gt; {
<a href=#65 id=65 data-nosnippet>65</a> <span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>std::fmt::Formatter&lt;<span class="lifetime">'_</span>&gt;) -&gt; std::fmt::Result {
<a href=#66 id=66 data-nosnippet>66</a> f.debug_tuple(<span class="string">"RepeatedTask"</span>).field(<span class="kw-2">&amp;</span><span class="self">self</span>.name).finish()
<a href=#67 id=67 data-nosnippet>67</a> }
<a href=#68 id=68 data-nosnippet>68</a>}
<a href=#69 id=69 data-nosnippet>69</a>
<a href=#70 id=70 data-nosnippet>70</a><span class="kw">impl</span>&lt;E&gt; Drop <span class="kw">for </span>RepeatedTask&lt;E&gt; {
<a href=#71 id=71 data-nosnippet>71</a> <span class="kw">fn </span>drop(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<a href=#72 id=72 data-nosnippet>72</a> <span class="kw">let </span>inner = <span class="self">self</span>.inner.get_mut().unwrap();
<a href=#73 id=73 data-nosnippet>73</a> <span class="kw">if </span>inner.task_handle.is_some() {
<a href=#74 id=74 data-nosnippet>74</a> <span class="comment">// Cancel the background task.
<a href=#75 id=75 data-nosnippet>75</a> </span><span class="self">self</span>.cancel_token.cancel();
<a href=#76 id=76 data-nosnippet>76</a> }
<a href=#77 id=77 data-nosnippet>77</a> }
<a href=#78 id=78 data-nosnippet>78</a>}
<a href=#79 id=79 data-nosnippet>79</a>
<a href=#80 id=80 data-nosnippet>80</a><span class="kw">impl</span>&lt;E: ErrorExt + <span class="lifetime">'static</span>&gt; RepeatedTask&lt;E&gt; {
<a href=#81 id=81 data-nosnippet>81</a> <span class="doccomment">/// Creates a new repeated task. The `initial_delay` is the delay before the first execution.
<a href=#82 id=82 data-nosnippet>82</a> /// `initial_delay` default is None, the initial interval uses the `interval`.
<a href=#83 id=83 data-nosnippet>83</a> /// You can use `with_initial_delay` to set the `initial_delay`.
<a href=#84 id=84 data-nosnippet>84</a> </span><span class="kw">pub fn </span>new(interval: Duration, task_fn: BoxedTaskFunction&lt;E&gt;) -&gt; <span class="self">Self </span>{
<a href=#85 id=85 data-nosnippet>85</a> <span class="self">Self </span>{
<a href=#86 id=86 data-nosnippet>86</a> name: task_fn.name().to_string(),
<a href=#87 id=87 data-nosnippet>87</a> cancel_token: CancellationToken::new(),
<a href=#88 id=88 data-nosnippet>88</a> inner: Mutex::new(TaskInner {
<a href=#89 id=89 data-nosnippet>89</a> task_handle: <span class="prelude-val">None</span>,
<a href=#90 id=90 data-nosnippet>90</a> task_fn: <span class="prelude-val">Some</span>(task_fn),
<a href=#91 id=91 data-nosnippet>91</a> }),
<a href=#92 id=92 data-nosnippet>92</a> started: AtomicBool::new(<span class="bool-val">false</span>),
<a href=#93 id=93 data-nosnippet>93</a> interval,
<a href=#94 id=94 data-nosnippet>94</a> initial_delay: <span class="prelude-val">None</span>,
<a href=#95 id=95 data-nosnippet>95</a> }
<a href=#96 id=96 data-nosnippet>96</a> }
<a href=#97 id=97 data-nosnippet>97</a>
<a href=#98 id=98 data-nosnippet>98</a> <span class="kw">pub fn </span>with_initial_delay(<span class="kw-2">mut </span><span class="self">self</span>, initial_delay: <span class="prelude-ty">Option</span>&lt;Duration&gt;) -&gt; <span class="self">Self </span>{
<a href=#99 id=99 data-nosnippet>99</a> <span class="self">self</span>.initial_delay = initial_delay;
<a href=#100 id=100 data-nosnippet>100</a> <span class="self">self
<a href=#101 id=101 data-nosnippet>101</a> </span>}
<a href=#102 id=102 data-nosnippet>102</a>
<a href=#103 id=103 data-nosnippet>103</a> <span class="kw">pub fn </span>started(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<a href=#104 id=104 data-nosnippet>104</a> <span class="self">self</span>.started.load(Ordering::Relaxed)
<a href=#105 id=105 data-nosnippet>105</a> }
<a href=#106 id=106 data-nosnippet>106</a>
<a href=#107 id=107 data-nosnippet>107</a> <span class="kw">pub fn </span>start(<span class="kw-2">&amp;</span><span class="self">self</span>, runtime: Runtime) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt; {
<a href=#108 id=108 data-nosnippet>108</a> <span class="kw">let </span><span class="kw-2">mut </span>inner = <span class="self">self</span>.inner.lock().unwrap();
<a href=#109 id=109 data-nosnippet>109</a> <span class="macro">ensure!</span>(
<a href=#110 id=110 data-nosnippet>110</a> inner.task_fn.is_some(),
<a href=#111 id=111 data-nosnippet>111</a> IllegalStateSnafu { name: <span class="kw-2">&amp;</span><span class="self">self</span>.name }
<a href=#112 id=112 data-nosnippet>112</a> );
<a href=#113 id=113 data-nosnippet>113</a>
<a href=#114 id=114 data-nosnippet>114</a> <span class="kw">let </span>child = <span class="self">self</span>.cancel_token.child_token();
<a href=#115 id=115 data-nosnippet>115</a> <span class="comment">// Safety: The task is not started.
<a href=#116 id=116 data-nosnippet>116</a> </span><span class="kw">let </span><span class="kw-2">mut </span>task_fn = inner.task_fn.take().unwrap();
<a href=#117 id=117 data-nosnippet>117</a> <span class="kw">let </span>interval = <span class="self">self</span>.interval;
<a href=#118 id=118 data-nosnippet>118</a> <span class="kw">let </span><span class="kw-2">mut </span>initial_delay = <span class="self">self</span>.initial_delay;
<a href=#119 id=119 data-nosnippet>119</a> <span class="comment">// TODO(hl): Maybe spawn to a blocking runtime.
<a href=#120 id=120 data-nosnippet>120</a> </span><span class="kw">let </span>handle = runtime.spawn(<span class="kw">async move </span>{
<a href=#121 id=121 data-nosnippet>121</a> <span class="kw">loop </span>{
<a href=#122 id=122 data-nosnippet>122</a> <span class="kw">let </span>sleep_time = initial_delay.take().unwrap_or(interval);
<a href=#123 id=123 data-nosnippet>123</a> <span class="kw">if </span>sleep_time &gt; Duration::ZERO {
<a href=#124 id=124 data-nosnippet>124</a> <span class="macro">tokio::select!</span> {
<a href=#125 id=125 data-nosnippet>125</a> <span class="kw">_ </span>= tokio::time::sleep(sleep_time) =&gt; {}
<a href=#126 id=126 data-nosnippet>126</a> <span class="kw">_ </span>= child.cancelled() =&gt; {
<a href=#127 id=127 data-nosnippet>127</a> <span class="kw">return</span>;
<a href=#128 id=128 data-nosnippet>128</a> }
<a href=#129 id=129 data-nosnippet>129</a> }
<a href=#130 id=130 data-nosnippet>130</a> }
<a href=#131 id=131 data-nosnippet>131</a> <span class="kw">if let </span><span class="prelude-val">Err</span>(e) = task_fn.call().<span class="kw">await </span>{
<a href=#132 id=132 data-nosnippet>132</a> <span class="macro">error!</span>(e; <span class="string">"Failed to run repeated task: {}"</span>, task_fn.name());
<a href=#133 id=133 data-nosnippet>133</a> }
<a href=#134 id=134 data-nosnippet>134</a> }
<a href=#135 id=135 data-nosnippet>135</a> });
<a href=#136 id=136 data-nosnippet>136</a> inner.task_handle = <span class="prelude-val">Some</span>(handle);
<a href=#137 id=137 data-nosnippet>137</a> <span class="self">self</span>.started.store(<span class="bool-val">true</span>, Ordering::Relaxed);
<a href=#138 id=138 data-nosnippet>138</a>
<a href=#139 id=139 data-nosnippet>139</a> <span class="macro">debug!</span>(
<a href=#140 id=140 data-nosnippet>140</a> <span class="string">"Repeated task {} started with interval: {:?}"</span>,
<a href=#141 id=141 data-nosnippet>141</a> <span class="self">self</span>.name, <span class="self">self</span>.interval
<a href=#142 id=142 data-nosnippet>142</a> );
<a href=#143 id=143 data-nosnippet>143</a>
<a href=#144 id=144 data-nosnippet>144</a> <span class="prelude-val">Ok</span>(())
<a href=#145 id=145 data-nosnippet>145</a> }
<a href=#146 id=146 data-nosnippet>146</a>
<a href=#147 id=147 data-nosnippet>147</a> <span class="kw">pub async fn </span>stop(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt; {
<a href=#148 id=148 data-nosnippet>148</a> <span class="kw">let </span>handle = {
<a href=#149 id=149 data-nosnippet>149</a> <span class="kw">let </span><span class="kw-2">mut </span>inner = <span class="self">self</span>.inner.lock().unwrap();
<a href=#150 id=150 data-nosnippet>150</a> <span class="kw">if </span>inner.task_handle.is_none() {
<a href=#151 id=151 data-nosnippet>151</a> <span class="comment">// We allow stop the task multiple times.
<a href=#152 id=152 data-nosnippet>152</a> </span><span class="kw">return </span><span class="prelude-val">Ok</span>(());
<a href=#153 id=153 data-nosnippet>153</a> }
<a href=#154 id=154 data-nosnippet>154</a>
<a href=#155 id=155 data-nosnippet>155</a> <span class="self">self</span>.cancel_token.cancel();
<a href=#156 id=156 data-nosnippet>156</a> <span class="self">self</span>.started.store(<span class="bool-val">false</span>, Ordering::Relaxed);
<a href=#157 id=157 data-nosnippet>157</a> <span class="comment">// Safety: The task is not stopped.
<a href=#158 id=158 data-nosnippet>158</a> </span>inner.task_handle.take().unwrap()
<a href=#159 id=159 data-nosnippet>159</a> };
<a href=#160 id=160 data-nosnippet>160</a>
<a href=#161 id=161 data-nosnippet>161</a> handle
<a href=#162 id=162 data-nosnippet>162</a> .<span class="kw">await
<a href=#163 id=163 data-nosnippet>163</a> </span>.context(WaitGcTaskStopSnafu { name: <span class="kw-2">&amp;</span><span class="self">self</span>.name })<span class="question-mark">?</span>;
<a href=#164 id=164 data-nosnippet>164</a>
<a href=#165 id=165 data-nosnippet>165</a> <span class="macro">debug!</span>(<span class="string">"Repeated task {} stopped"</span>, <span class="self">self</span>.name);
<a href=#166 id=166 data-nosnippet>166</a>
<a href=#167 id=167 data-nosnippet>167</a> <span class="prelude-val">Ok</span>(())
<a href=#168 id=168 data-nosnippet>168</a> }
<a href=#169 id=169 data-nosnippet>169</a>}
<a href=#170 id=170 data-nosnippet>170</a>
<a href=#171 id=171 data-nosnippet>171</a><span class="attr">#[cfg(test)]
<a href=#172 id=172 data-nosnippet>172</a></span><span class="kw">mod </span>tests {
<a href=#173 id=173 data-nosnippet>173</a> <span class="kw">use </span>std::sync::Arc;
<a href=#174 id=174 data-nosnippet>174</a> <span class="kw">use </span>std::sync::atomic::AtomicI32;
<a href=#175 id=175 data-nosnippet>175</a>
<a href=#176 id=176 data-nosnippet>176</a> <span class="kw">use </span>super::<span class="kw-2">*</span>;
<a href=#177 id=177 data-nosnippet>177</a> <span class="kw">use </span><span class="kw">crate</span>::error::Error;
<a href=#178 id=178 data-nosnippet>178</a>
<a href=#179 id=179 data-nosnippet>179</a> <span class="kw">struct </span>TickTask {
<a href=#180 id=180 data-nosnippet>180</a> n: Arc&lt;AtomicI32&gt;,
<a href=#181 id=181 data-nosnippet>181</a> }
<a href=#182 id=182 data-nosnippet>182</a>
<a href=#183 id=183 data-nosnippet>183</a> <span class="attr">#[async_trait::async_trait]
<a href=#184 id=184 data-nosnippet>184</a> </span><span class="kw">impl </span>TaskFunction&lt;Error&gt; <span class="kw">for </span>TickTask {
<a href=#185 id=185 data-nosnippet>185</a> <span class="kw">fn </span>name(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>str {
<a href=#186 id=186 data-nosnippet>186</a> <span class="string">"test"
<a href=#187 id=187 data-nosnippet>187</a> </span>}
<a href=#188 id=188 data-nosnippet>188</a>
<a href=#189 id=189 data-nosnippet>189</a> <span class="kw">async fn </span>call(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt; {
<a href=#190 id=190 data-nosnippet>190</a> <span class="kw">let _ </span>= <span class="self">self</span>.n.fetch_add(<span class="number">1</span>, Ordering::Relaxed);
<a href=#191 id=191 data-nosnippet>191</a> <span class="prelude-val">Ok</span>(())
<a href=#192 id=192 data-nosnippet>192</a> }
<a href=#193 id=193 data-nosnippet>193</a> }
<a href=#194 id=194 data-nosnippet>194</a>
<a href=#195 id=195 data-nosnippet>195</a> <span class="attr">#[tokio::test]
<a href=#196 id=196 data-nosnippet>196</a> </span><span class="kw">async fn </span>test_repeated_task() {
<a href=#197 id=197 data-nosnippet>197</a> common_telemetry::init_default_ut_logging();
<a href=#198 id=198 data-nosnippet>198</a>
<a href=#199 id=199 data-nosnippet>199</a> <span class="kw">let </span>n = Arc::new(AtomicI32::new(<span class="number">0</span>));
<a href=#200 id=200 data-nosnippet>200</a> <span class="kw">let </span>task_fn = TickTask { n: n.clone() };
<a href=#201 id=201 data-nosnippet>201</a>
<a href=#202 id=202 data-nosnippet>202</a> <span class="kw">let </span>task = RepeatedTask::new(Duration::from_millis(<span class="number">100</span>), Box::new(task_fn));
<a href=#203 id=203 data-nosnippet>203</a>
<a href=#204 id=204 data-nosnippet>204</a> task.start(<span class="kw">crate</span>::global_runtime()).unwrap();
<a href=#205 id=205 data-nosnippet>205</a> tokio::time::sleep(Duration::from_millis(<span class="number">550</span>)).<span class="kw">await</span>;
<a href=#206 id=206 data-nosnippet>206</a> task.stop().<span class="kw">await</span>.unwrap();
<a href=#207 id=207 data-nosnippet>207</a>
<a href=#208 id=208 data-nosnippet>208</a> <span class="macro">assert!</span>(n.load(Ordering::Relaxed) &gt;= <span class="number">3</span>);
<a href=#209 id=209 data-nosnippet>209</a> }
<a href=#210 id=210 data-nosnippet>210</a>
<a href=#211 id=211 data-nosnippet>211</a> <span class="attr">#[tokio::test]
<a href=#212 id=212 data-nosnippet>212</a> </span><span class="kw">async fn </span>test_repeated_task_prior_exec() {
<a href=#213 id=213 data-nosnippet>213</a> common_telemetry::init_default_ut_logging();
<a href=#214 id=214 data-nosnippet>214</a>
<a href=#215 id=215 data-nosnippet>215</a> <span class="kw">let </span>n = Arc::new(AtomicI32::new(<span class="number">0</span>));
<a href=#216 id=216 data-nosnippet>216</a> <span class="kw">let </span>task_fn = TickTask { n: n.clone() };
<a href=#217 id=217 data-nosnippet>217</a>
<a href=#218 id=218 data-nosnippet>218</a> <span class="kw">let </span>task = RepeatedTask::new(Duration::from_millis(<span class="number">100</span>), Box::new(task_fn))
<a href=#219 id=219 data-nosnippet>219</a> .with_initial_delay(<span class="prelude-val">Some</span>(Duration::ZERO));
<a href=#220 id=220 data-nosnippet>220</a>
<a href=#221 id=221 data-nosnippet>221</a> task.start(<span class="kw">crate</span>::global_runtime()).unwrap();
<a href=#222 id=222 data-nosnippet>222</a> tokio::time::sleep(Duration::from_millis(<span class="number">550</span>)).<span class="kw">await</span>;
<a href=#223 id=223 data-nosnippet>223</a> task.stop().<span class="kw">await</span>.unwrap();
<a href=#224 id=224 data-nosnippet>224</a>
<a href=#225 id=225 data-nosnippet>225</a> <span class="macro">assert!</span>(n.load(Ordering::Relaxed) &gt;= <span class="number">4</span>);
<a href=#226 id=226 data-nosnippet>226</a> }
<a href=#227 id=227 data-nosnippet>227</a>}
</code></pre></div></section></main></body></html>
+364
View File
@@ -0,0 +1,364 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/common/runtime/src/runtime.rs`."><title>runtime.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="common_runtime" data-themes="" data-resource-suffix="" data-rustdoc-version="1.96.1 (31fca3adb 2026-06-26)" data-channel="1.96.1" data-search-js="search-b5634cc7.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../../static.files/storage-41dd4d93.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-5013f961.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-f7c3ffd8.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content" tabindex="-1"><div class="main-heading"><h1><div class="sub-heading">common_runtime/</div>runtime.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="comment">// Copyright 2023 Greptime Team
<a href=#2 id=2 data-nosnippet>2</a>//
<a href=#3 id=3 data-nosnippet>3</a>// Licensed under the Apache License, Version 2.0 (the "License");
<a href=#4 id=4 data-nosnippet>4</a>// you may not use this file except in compliance with the License.
<a href=#5 id=5 data-nosnippet>5</a>// You may obtain a copy of the License at
<a href=#6 id=6 data-nosnippet>6</a>//
<a href=#7 id=7 data-nosnippet>7</a>// http://www.apache.org/licenses/LICENSE-2.0
<a href=#8 id=8 data-nosnippet>8</a>//
<a href=#9 id=9 data-nosnippet>9</a>// Unless required by applicable law or agreed to in writing, software
<a href=#10 id=10 data-nosnippet>10</a>// distributed under the License is distributed on an "AS IS" BASIS,
<a href=#11 id=11 data-nosnippet>11</a>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<a href=#12 id=12 data-nosnippet>12</a>// See the License for the specific language governing permissions and
<a href=#13 id=13 data-nosnippet>13</a>// limitations under the License.
<a href=#14 id=14 data-nosnippet>14</a>
<a href=#15 id=15 data-nosnippet>15</a></span><span class="kw">use </span>std::future::Future;
<a href=#16 id=16 data-nosnippet>16</a><span class="kw">use </span>std::sync::Arc;
<a href=#17 id=17 data-nosnippet>17</a><span class="kw">use </span>std::sync::atomic::{AtomicUsize, Ordering};
<a href=#18 id=18 data-nosnippet>18</a><span class="kw">use </span>std::thread;
<a href=#19 id=19 data-nosnippet>19</a><span class="kw">use </span>std::time::Duration;
<a href=#20 id=20 data-nosnippet>20</a>
<a href=#21 id=21 data-nosnippet>21</a><span class="kw">use </span>snafu::ResultExt;
<a href=#22 id=22 data-nosnippet>22</a><span class="kw">use </span>tokio::runtime::Builder <span class="kw">as </span>RuntimeBuilder;
<a href=#23 id=23 data-nosnippet>23</a><span class="kw">use </span>tokio::sync::oneshot;
<a href=#24 id=24 data-nosnippet>24</a><span class="kw">pub use </span>tokio::task::{JoinError, JoinHandle};
<a href=#25 id=25 data-nosnippet>25</a>
<a href=#26 id=26 data-nosnippet>26</a><span class="kw">use </span><span class="kw">crate</span>::error::<span class="kw-2">*</span>;
<a href=#27 id=27 data-nosnippet>27</a><span class="kw">use </span><span class="kw">crate</span>::metrics::<span class="kw-2">*</span>;
<a href=#28 id=28 data-nosnippet>28</a><span class="kw">use </span><span class="kw">crate</span>::runtime_default::DefaultRuntime;
<a href=#29 id=29 data-nosnippet>29</a><span class="kw">use </span><span class="kw">crate</span>::runtime_throttleable::ThrottleableRuntime;
<a href=#30 id=30 data-nosnippet>30</a>
<a href=#31 id=31 data-nosnippet>31</a><span class="comment">// configurations
<a href=#32 id=32 data-nosnippet>32</a></span><span class="kw">pub type </span>Runtime = DefaultRuntime;
<a href=#33 id=33 data-nosnippet>33</a>
<a href=#34 id=34 data-nosnippet>34</a><span class="kw">static </span>RUNTIME_ID: AtomicUsize = AtomicUsize::new(<span class="number">0</span>);
<a href=#35 id=35 data-nosnippet>35</a>
<a href=#36 id=36 data-nosnippet>36</a><span class="doccomment">/// Dropping the dropper will cause runtime to shutdown.
<a href=#37 id=37 data-nosnippet>37</a></span><span class="attr">#[derive(Debug)]
<a href=#38 id=38 data-nosnippet>38</a></span><span class="kw">pub struct </span>Dropper {
<a href=#39 id=39 data-nosnippet>39</a> close: <span class="prelude-ty">Option</span>&lt;oneshot::Sender&lt;()&gt;&gt;,
<a href=#40 id=40 data-nosnippet>40</a>}
<a href=#41 id=41 data-nosnippet>41</a>
<a href=#42 id=42 data-nosnippet>42</a><span class="kw">impl </span>Drop <span class="kw">for </span>Dropper {
<a href=#43 id=43 data-nosnippet>43</a> <span class="kw">fn </span>drop(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<a href=#44 id=44 data-nosnippet>44</a> <span class="comment">// Send a signal to say i am dropping.
<a href=#45 id=45 data-nosnippet>45</a> </span><span class="kw">let _ </span>= <span class="self">self</span>.close.take().map(|v| v.send(()));
<a href=#46 id=46 data-nosnippet>46</a> }
<a href=#47 id=47 data-nosnippet>47</a>}
<a href=#48 id=48 data-nosnippet>48</a>
<a href=#49 id=49 data-nosnippet>49</a><span class="kw">pub trait </span>RuntimeTrait {
<a href=#50 id=50 data-nosnippet>50</a> <span class="doccomment">/// Get a runtime builder
<a href=#51 id=51 data-nosnippet>51</a> </span><span class="kw">fn </span>builder() -&gt; Builder {
<a href=#52 id=52 data-nosnippet>52</a> Builder::default()
<a href=#53 id=53 data-nosnippet>53</a> }
<a href=#54 id=54 data-nosnippet>54</a>
<a href=#55 id=55 data-nosnippet>55</a> <span class="doccomment">/// Spawn a future and execute it in this thread pool
<a href=#56 id=56 data-nosnippet>56</a> ///
<a href=#57 id=57 data-nosnippet>57</a> /// Similar to tokio::runtime::Runtime::spawn()
<a href=#58 id=58 data-nosnippet>58</a> </span><span class="kw">fn </span>spawn&lt;F&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, future: F) -&gt; JoinHandle&lt;F::Output&gt;
<a href=#59 id=59 data-nosnippet>59</a> <span class="kw">where
<a href=#60 id=60 data-nosnippet>60</a> </span>F: Future + Send + <span class="lifetime">'static</span>,
<a href=#61 id=61 data-nosnippet>61</a> F::Output: Send + <span class="lifetime">'static</span>;
<a href=#62 id=62 data-nosnippet>62</a>
<a href=#63 id=63 data-nosnippet>63</a> <span class="doccomment">/// Run the provided function on an executor dedicated to blocking
<a href=#64 id=64 data-nosnippet>64</a> /// operations.
<a href=#65 id=65 data-nosnippet>65</a> </span><span class="kw">fn </span>spawn_blocking&lt;F, R&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, func: F) -&gt; JoinHandle&lt;R&gt;
<a href=#66 id=66 data-nosnippet>66</a> <span class="kw">where
<a href=#67 id=67 data-nosnippet>67</a> </span>F: FnOnce() -&gt; R + Send + <span class="lifetime">'static</span>,
<a href=#68 id=68 data-nosnippet>68</a> R: Send + <span class="lifetime">'static</span>;
<a href=#69 id=69 data-nosnippet>69</a>
<a href=#70 id=70 data-nosnippet>70</a> <span class="doccomment">/// Run a future to complete, this is the runtime's entry point
<a href=#71 id=71 data-nosnippet>71</a> </span><span class="kw">fn </span>block_on&lt;F: Future&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, future: F) -&gt; F::Output;
<a href=#72 id=72 data-nosnippet>72</a>
<a href=#73 id=73 data-nosnippet>73</a> <span class="doccomment">/// Get the name of the runtime
<a href=#74 id=74 data-nosnippet>74</a> </span><span class="kw">fn </span>name(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>str;
<a href=#75 id=75 data-nosnippet>75</a>}
<a href=#76 id=76 data-nosnippet>76</a>
<a href=#77 id=77 data-nosnippet>77</a><span class="kw">pub trait </span>BuilderBuild&lt;R: RuntimeTrait&gt; {
<a href=#78 id=78 data-nosnippet>78</a> <span class="kw">fn </span>build(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;R&gt;;
<a href=#79 id=79 data-nosnippet>79</a>}
<a href=#80 id=80 data-nosnippet>80</a>
<a href=#81 id=81 data-nosnippet>81</a><span class="kw">pub struct </span>Builder {
<a href=#82 id=82 data-nosnippet>82</a> runtime_name: String,
<a href=#83 id=83 data-nosnippet>83</a> thread_name: String,
<a href=#84 id=84 data-nosnippet>84</a> priority: Priority,
<a href=#85 id=85 data-nosnippet>85</a> builder: RuntimeBuilder,
<a href=#86 id=86 data-nosnippet>86</a>}
<a href=#87 id=87 data-nosnippet>87</a>
<a href=#88 id=88 data-nosnippet>88</a><span class="kw">impl </span>Default <span class="kw">for </span>Builder {
<a href=#89 id=89 data-nosnippet>89</a> <span class="kw">fn </span>default() -&gt; <span class="self">Self </span>{
<a href=#90 id=90 data-nosnippet>90</a> <span class="self">Self </span>{
<a href=#91 id=91 data-nosnippet>91</a> runtime_name: <span class="macro">format!</span>(<span class="string">"runtime-{}"</span>, RUNTIME_ID.fetch_add(<span class="number">1</span>, Ordering::Relaxed)),
<a href=#92 id=92 data-nosnippet>92</a> thread_name: <span class="string">"default-worker"</span>.to_string(),
<a href=#93 id=93 data-nosnippet>93</a> builder: RuntimeBuilder::new_multi_thread(),
<a href=#94 id=94 data-nosnippet>94</a> priority: Priority::VeryHigh,
<a href=#95 id=95 data-nosnippet>95</a> }
<a href=#96 id=96 data-nosnippet>96</a> }
<a href=#97 id=97 data-nosnippet>97</a>}
<a href=#98 id=98 data-nosnippet>98</a>
<a href=#99 id=99 data-nosnippet>99</a><span class="kw">impl </span>Builder {
<a href=#100 id=100 data-nosnippet>100</a> <span class="kw">pub fn </span>priority(<span class="kw-2">&amp;mut </span><span class="self">self</span>, priority: Priority) -&gt; <span class="kw-2">&amp;mut </span><span class="self">Self </span>{
<a href=#101 id=101 data-nosnippet>101</a> <span class="self">self</span>.priority = priority;
<a href=#102 id=102 data-nosnippet>102</a> <span class="self">self
<a href=#103 id=103 data-nosnippet>103</a> </span>}
<a href=#104 id=104 data-nosnippet>104</a>
<a href=#105 id=105 data-nosnippet>105</a> <span class="doccomment">/// Sets the number of worker threads the Runtime will use.
<a href=#106 id=106 data-nosnippet>106</a> ///
<a href=#107 id=107 data-nosnippet>107</a> /// This can be any number above 0. The default value is the number of cores available to the system.
<a href=#108 id=108 data-nosnippet>108</a> </span><span class="kw">pub fn </span>worker_threads(<span class="kw-2">&amp;mut </span><span class="self">self</span>, val: usize) -&gt; <span class="kw-2">&amp;mut </span><span class="self">Self </span>{
<a href=#109 id=109 data-nosnippet>109</a> <span class="kw">let _ </span>= <span class="self">self</span>.builder.worker_threads(val);
<a href=#110 id=110 data-nosnippet>110</a> <span class="self">self
<a href=#111 id=111 data-nosnippet>111</a> </span>}
<a href=#112 id=112 data-nosnippet>112</a>
<a href=#113 id=113 data-nosnippet>113</a> <span class="doccomment">/// Specifies the limit for additional threads spawned by the Runtime.
<a href=#114 id=114 data-nosnippet>114</a> ///
<a href=#115 id=115 data-nosnippet>115</a> /// These threads are used for blocking operations like tasks spawned through spawn_blocking,
<a href=#116 id=116 data-nosnippet>116</a> /// they are not always active and will exit if left idle for too long, You can change this timeout duration
<a href=#117 id=117 data-nosnippet>117</a> /// with thread_keep_alive. The default value is 512.
<a href=#118 id=118 data-nosnippet>118</a> </span><span class="kw">pub fn </span>max_blocking_threads(<span class="kw-2">&amp;mut </span><span class="self">self</span>, val: usize) -&gt; <span class="kw-2">&amp;mut </span><span class="self">Self </span>{
<a href=#119 id=119 data-nosnippet>119</a> <span class="kw">let _ </span>= <span class="self">self</span>.builder.max_blocking_threads(val);
<a href=#120 id=120 data-nosnippet>120</a> <span class="self">self
<a href=#121 id=121 data-nosnippet>121</a> </span>}
<a href=#122 id=122 data-nosnippet>122</a>
<a href=#123 id=123 data-nosnippet>123</a> <span class="doccomment">/// Sets a custom timeout for a thread in the blocking pool.
<a href=#124 id=124 data-nosnippet>124</a> ///
<a href=#125 id=125 data-nosnippet>125</a> /// By default, the timeout for a thread is set to 10 seconds.
<a href=#126 id=126 data-nosnippet>126</a> </span><span class="kw">pub fn </span>thread_keep_alive(<span class="kw-2">&amp;mut </span><span class="self">self</span>, duration: Duration) -&gt; <span class="kw-2">&amp;mut </span><span class="self">Self </span>{
<a href=#127 id=127 data-nosnippet>127</a> <span class="kw">let _ </span>= <span class="self">self</span>.builder.thread_keep_alive(duration);
<a href=#128 id=128 data-nosnippet>128</a> <span class="self">self
<a href=#129 id=129 data-nosnippet>129</a> </span>}
<a href=#130 id=130 data-nosnippet>130</a>
<a href=#131 id=131 data-nosnippet>131</a> <span class="kw">pub fn </span>runtime_name(<span class="kw-2">&amp;mut </span><span class="self">self</span>, val: <span class="kw">impl </span>Into&lt;String&gt;) -&gt; <span class="kw-2">&amp;mut </span><span class="self">Self </span>{
<a href=#132 id=132 data-nosnippet>132</a> <span class="self">self</span>.runtime_name = val.into();
<a href=#133 id=133 data-nosnippet>133</a> <span class="self">self
<a href=#134 id=134 data-nosnippet>134</a> </span>}
<a href=#135 id=135 data-nosnippet>135</a>
<a href=#136 id=136 data-nosnippet>136</a> <span class="doccomment">/// Sets name of threads spawned by the Runtime thread pool
<a href=#137 id=137 data-nosnippet>137</a> </span><span class="kw">pub fn </span>thread_name(<span class="kw-2">&amp;mut </span><span class="self">self</span>, val: <span class="kw">impl </span>Into&lt;String&gt;) -&gt; <span class="kw-2">&amp;mut </span><span class="self">Self </span>{
<a href=#138 id=138 data-nosnippet>138</a> <span class="self">self</span>.thread_name = val.into();
<a href=#139 id=139 data-nosnippet>139</a> <span class="self">self
<a href=#140 id=140 data-nosnippet>140</a> </span>}
<a href=#141 id=141 data-nosnippet>141</a>}
<a href=#142 id=142 data-nosnippet>142</a>
<a href=#143 id=143 data-nosnippet>143</a><span class="kw">impl </span>BuilderBuild&lt;DefaultRuntime&gt; <span class="kw">for </span>Builder {
<a href=#144 id=144 data-nosnippet>144</a> <span class="kw">fn </span>build(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;DefaultRuntime&gt; {
<a href=#145 id=145 data-nosnippet>145</a> <span class="kw">let </span>builder = <span class="self">self
<a href=#146 id=146 data-nosnippet>146</a> </span>.builder
<a href=#147 id=147 data-nosnippet>147</a> .enable_all()
<a href=#148 id=148 data-nosnippet>148</a> .thread_name(<span class="self">self</span>.thread_name.clone())
<a href=#149 id=149 data-nosnippet>149</a> .on_thread_start(on_thread_start(<span class="self">self</span>.thread_name.clone()))
<a href=#150 id=150 data-nosnippet>150</a> .on_thread_stop(on_thread_stop(<span class="self">self</span>.thread_name.clone()))
<a href=#151 id=151 data-nosnippet>151</a> .on_thread_park(on_thread_park(<span class="self">self</span>.thread_name.clone()))
<a href=#152 id=152 data-nosnippet>152</a> .on_thread_unpark(on_thread_unpark(<span class="self">self</span>.thread_name.clone()));
<a href=#153 id=153 data-nosnippet>153</a> <span class="kw">let </span>runtime = <span class="kw">if </span><span class="macro">cfg!</span>(debug_assertions) {
<a href=#154 id=154 data-nosnippet>154</a> <span class="comment">// Set the stack size to 8MB for the thread so it wouldn't overflow on large stack usage in debug mode
<a href=#155 id=155 data-nosnippet>155</a> // This is necessary to avoid stack overflow while running sqlness.
<a href=#156 id=156 data-nosnippet>156</a> // https://github.com/rust-lang/rust/issues/34283
<a href=#157 id=157 data-nosnippet>157</a> </span>builder
<a href=#158 id=158 data-nosnippet>158</a> .thread_stack_size(<span class="number">8 </span>* <span class="number">1024 </span>* <span class="number">1024</span>)
<a href=#159 id=159 data-nosnippet>159</a> .build()
<a href=#160 id=160 data-nosnippet>160</a> .context(BuildRuntimeSnafu)<span class="question-mark">?
<a href=#161 id=161 data-nosnippet>161</a> </span>} <span class="kw">else </span>{
<a href=#162 id=162 data-nosnippet>162</a> builder.build().context(BuildRuntimeSnafu)<span class="question-mark">?
<a href=#163 id=163 data-nosnippet>163</a> </span>};
<a href=#164 id=164 data-nosnippet>164</a>
<a href=#165 id=165 data-nosnippet>165</a> <span class="kw">let </span>name = <span class="self">self</span>.runtime_name.clone();
<a href=#166 id=166 data-nosnippet>166</a> <span class="kw">let </span>handle = runtime.handle().clone();
<a href=#167 id=167 data-nosnippet>167</a> <span class="kw">let </span>(send_stop, recv_stop) = oneshot::channel();
<a href=#168 id=168 data-nosnippet>168</a> <span class="comment">// Block the runtime to shutdown.
<a href=#169 id=169 data-nosnippet>169</a> </span><span class="kw">let _ </span>= thread::Builder::new()
<a href=#170 id=170 data-nosnippet>170</a> .name(<span class="macro">format!</span>(<span class="string">"{}-blocker"</span>, <span class="self">self</span>.thread_name))
<a href=#171 id=171 data-nosnippet>171</a> .spawn(<span class="kw">move </span>|| runtime.block_on(recv_stop));
<a href=#172 id=172 data-nosnippet>172</a>
<a href=#173 id=173 data-nosnippet>173</a> <span class="attr">#[cfg(tokio_unstable)]
<a href=#174 id=174 data-nosnippet>174</a> </span>register_collector(name.clone(), <span class="kw-2">&amp;</span>handle);
<a href=#175 id=175 data-nosnippet>175</a>
<a href=#176 id=176 data-nosnippet>176</a> <span class="prelude-val">Ok</span>(DefaultRuntime::new(
<a href=#177 id=177 data-nosnippet>177</a> <span class="kw-2">&amp;</span>name,
<a href=#178 id=178 data-nosnippet>178</a> handle,
<a href=#179 id=179 data-nosnippet>179</a> Arc::new(Dropper {
<a href=#180 id=180 data-nosnippet>180</a> close: <span class="prelude-val">Some</span>(send_stop),
<a href=#181 id=181 data-nosnippet>181</a> }),
<a href=#182 id=182 data-nosnippet>182</a> ))
<a href=#183 id=183 data-nosnippet>183</a> }
<a href=#184 id=184 data-nosnippet>184</a>}
<a href=#185 id=185 data-nosnippet>185</a>
<a href=#186 id=186 data-nosnippet>186</a><span class="kw">impl </span>BuilderBuild&lt;ThrottleableRuntime&gt; <span class="kw">for </span>Builder {
<a href=#187 id=187 data-nosnippet>187</a> <span class="kw">fn </span>build(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;ThrottleableRuntime&gt; {
<a href=#188 id=188 data-nosnippet>188</a> <span class="kw">let </span>runtime = <span class="self">self
<a href=#189 id=189 data-nosnippet>189</a> </span>.builder
<a href=#190 id=190 data-nosnippet>190</a> .enable_all()
<a href=#191 id=191 data-nosnippet>191</a> .thread_name(<span class="self">self</span>.thread_name.clone())
<a href=#192 id=192 data-nosnippet>192</a> .on_thread_start(on_thread_start(<span class="self">self</span>.thread_name.clone()))
<a href=#193 id=193 data-nosnippet>193</a> .on_thread_stop(on_thread_stop(<span class="self">self</span>.thread_name.clone()))
<a href=#194 id=194 data-nosnippet>194</a> .on_thread_park(on_thread_park(<span class="self">self</span>.thread_name.clone()))
<a href=#195 id=195 data-nosnippet>195</a> .on_thread_unpark(on_thread_unpark(<span class="self">self</span>.thread_name.clone()))
<a href=#196 id=196 data-nosnippet>196</a> .build()
<a href=#197 id=197 data-nosnippet>197</a> .context(BuildRuntimeSnafu)<span class="question-mark">?</span>;
<a href=#198 id=198 data-nosnippet>198</a>
<a href=#199 id=199 data-nosnippet>199</a> <span class="kw">let </span>name = <span class="self">self</span>.runtime_name.clone();
<a href=#200 id=200 data-nosnippet>200</a> <span class="kw">let </span>handle = runtime.handle().clone();
<a href=#201 id=201 data-nosnippet>201</a> <span class="kw">let </span>(send_stop, recv_stop) = oneshot::channel();
<a href=#202 id=202 data-nosnippet>202</a> <span class="comment">// Block the runtime to shutdown.
<a href=#203 id=203 data-nosnippet>203</a> </span><span class="kw">let _ </span>= thread::Builder::new()
<a href=#204 id=204 data-nosnippet>204</a> .name(<span class="macro">format!</span>(<span class="string">"{}-blocker"</span>, <span class="self">self</span>.thread_name))
<a href=#205 id=205 data-nosnippet>205</a> .spawn(<span class="kw">move </span>|| runtime.block_on(recv_stop));
<a href=#206 id=206 data-nosnippet>206</a>
<a href=#207 id=207 data-nosnippet>207</a> <span class="attr">#[cfg(tokio_unstable)]
<a href=#208 id=208 data-nosnippet>208</a> </span>register_collector(name.clone(), <span class="kw-2">&amp;</span>handle);
<a href=#209 id=209 data-nosnippet>209</a>
<a href=#210 id=210 data-nosnippet>210</a> ThrottleableRuntime::new(
<a href=#211 id=211 data-nosnippet>211</a> <span class="kw-2">&amp;</span>name,
<a href=#212 id=212 data-nosnippet>212</a> <span class="self">self</span>.priority,
<a href=#213 id=213 data-nosnippet>213</a> handle,
<a href=#214 id=214 data-nosnippet>214</a> Arc::new(Dropper {
<a href=#215 id=215 data-nosnippet>215</a> close: <span class="prelude-val">Some</span>(send_stop),
<a href=#216 id=216 data-nosnippet>216</a> }),
<a href=#217 id=217 data-nosnippet>217</a> )
<a href=#218 id=218 data-nosnippet>218</a> }
<a href=#219 id=219 data-nosnippet>219</a>}
<a href=#220 id=220 data-nosnippet>220</a>
<a href=#221 id=221 data-nosnippet>221</a><span class="attr">#[cfg(tokio_unstable)]
<a href=#222 id=222 data-nosnippet>222</a></span><span class="kw">pub fn </span>register_collector(name: String, handle: <span class="kw-2">&amp;</span>tokio::runtime::Handle) {
<a href=#223 id=223 data-nosnippet>223</a> <span class="kw">let </span>name = name.replace(<span class="string">"-"</span>, <span class="string">"_"</span>);
<a href=#224 id=224 data-nosnippet>224</a> <span class="kw">let </span>monitor = tokio_metrics::RuntimeMonitor::new(handle);
<a href=#225 id=225 data-nosnippet>225</a> <span class="kw">let </span>collector = tokio_metrics_collector::RuntimeCollector::new(monitor, name);
<a href=#226 id=226 data-nosnippet>226</a> <span class="kw">let _ </span>= prometheus::register(Box::new(collector));
<a href=#227 id=227 data-nosnippet>227</a>}
<a href=#228 id=228 data-nosnippet>228</a>
<a href=#229 id=229 data-nosnippet>229</a><span class="kw">fn </span>on_thread_start(thread_name: String) -&gt; <span class="kw">impl </span>Fn() + <span class="lifetime">'static </span>{
<a href=#230 id=230 data-nosnippet>230</a> <span class="kw">move </span>|| {
<a href=#231 id=231 data-nosnippet>231</a> METRIC_RUNTIME_THREADS_ALIVE
<a href=#232 id=232 data-nosnippet>232</a> .with_label_values(<span class="kw-2">&amp;</span>[thread_name.as_str()])
<a href=#233 id=233 data-nosnippet>233</a> .inc();
<a href=#234 id=234 data-nosnippet>234</a> }
<a href=#235 id=235 data-nosnippet>235</a>}
<a href=#236 id=236 data-nosnippet>236</a>
<a href=#237 id=237 data-nosnippet>237</a><span class="kw">fn </span>on_thread_stop(thread_name: String) -&gt; <span class="kw">impl </span>Fn() + <span class="lifetime">'static </span>{
<a href=#238 id=238 data-nosnippet>238</a> <span class="kw">move </span>|| {
<a href=#239 id=239 data-nosnippet>239</a> METRIC_RUNTIME_THREADS_ALIVE
<a href=#240 id=240 data-nosnippet>240</a> .with_label_values(<span class="kw-2">&amp;</span>[thread_name.as_str()])
<a href=#241 id=241 data-nosnippet>241</a> .dec();
<a href=#242 id=242 data-nosnippet>242</a> }
<a href=#243 id=243 data-nosnippet>243</a>}
<a href=#244 id=244 data-nosnippet>244</a>
<a href=#245 id=245 data-nosnippet>245</a><span class="kw">fn </span>on_thread_park(thread_name: String) -&gt; <span class="kw">impl </span>Fn() + <span class="lifetime">'static </span>{
<a href=#246 id=246 data-nosnippet>246</a> <span class="kw">move </span>|| {
<a href=#247 id=247 data-nosnippet>247</a> METRIC_RUNTIME_THREADS_IDLE
<a href=#248 id=248 data-nosnippet>248</a> .with_label_values(<span class="kw-2">&amp;</span>[thread_name.as_str()])
<a href=#249 id=249 data-nosnippet>249</a> .inc();
<a href=#250 id=250 data-nosnippet>250</a> }
<a href=#251 id=251 data-nosnippet>251</a>}
<a href=#252 id=252 data-nosnippet>252</a>
<a href=#253 id=253 data-nosnippet>253</a><span class="kw">fn </span>on_thread_unpark(thread_name: String) -&gt; <span class="kw">impl </span>Fn() + <span class="lifetime">'static </span>{
<a href=#254 id=254 data-nosnippet>254</a> <span class="kw">move </span>|| {
<a href=#255 id=255 data-nosnippet>255</a> METRIC_RUNTIME_THREADS_IDLE
<a href=#256 id=256 data-nosnippet>256</a> .with_label_values(<span class="kw-2">&amp;</span>[thread_name.as_str()])
<a href=#257 id=257 data-nosnippet>257</a> .dec();
<a href=#258 id=258 data-nosnippet>258</a> }
<a href=#259 id=259 data-nosnippet>259</a>}
<a href=#260 id=260 data-nosnippet>260</a>
<a href=#261 id=261 data-nosnippet>261</a><span class="attr">#[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
<a href=#262 id=262 data-nosnippet>262</a></span><span class="kw">pub enum </span>Priority {
<a href=#263 id=263 data-nosnippet>263</a> VeryLow = <span class="number">0</span>,
<a href=#264 id=264 data-nosnippet>264</a> Low = <span class="number">1</span>,
<a href=#265 id=265 data-nosnippet>265</a> Middle = <span class="number">2</span>,
<a href=#266 id=266 data-nosnippet>266</a> High = <span class="number">3</span>,
<a href=#267 id=267 data-nosnippet>267</a> VeryHigh = <span class="number">4</span>,
<a href=#268 id=268 data-nosnippet>268</a>}
<a href=#269 id=269 data-nosnippet>269</a>
<a href=#270 id=270 data-nosnippet>270</a><span class="attr">#[cfg(test)]
<a href=#271 id=271 data-nosnippet>271</a></span><span class="kw">mod </span>tests {
<a href=#272 id=272 data-nosnippet>272</a>
<a href=#273 id=273 data-nosnippet>273</a> <span class="kw">use </span>std::sync::Arc;
<a href=#274 id=274 data-nosnippet>274</a> <span class="kw">use </span>std::thread;
<a href=#275 id=275 data-nosnippet>275</a> <span class="kw">use </span>std::time::Duration;
<a href=#276 id=276 data-nosnippet>276</a>
<a href=#277 id=277 data-nosnippet>277</a> <span class="kw">use </span>common_telemetry::dump_metrics;
<a href=#278 id=278 data-nosnippet>278</a> <span class="kw">use </span>tokio::sync::oneshot;
<a href=#279 id=279 data-nosnippet>279</a> <span class="kw">use </span>tokio_test::assert_ok;
<a href=#280 id=280 data-nosnippet>280</a>
<a href=#281 id=281 data-nosnippet>281</a> <span class="kw">use </span>super::<span class="kw-2">*</span>;
<a href=#282 id=282 data-nosnippet>282</a>
<a href=#283 id=283 data-nosnippet>283</a> <span class="kw">fn </span>runtime() -&gt; Arc&lt;Runtime&gt; {
<a href=#284 id=284 data-nosnippet>284</a> <span class="kw">let </span>runtime = Builder::default()
<a href=#285 id=285 data-nosnippet>285</a> .worker_threads(<span class="number">2</span>)
<a href=#286 id=286 data-nosnippet>286</a> .thread_name(<span class="string">"test_spawn_join"</span>)
<a href=#287 id=287 data-nosnippet>287</a> .build();
<a href=#288 id=288 data-nosnippet>288</a> Arc::new(runtime.unwrap())
<a href=#289 id=289 data-nosnippet>289</a> }
<a href=#290 id=290 data-nosnippet>290</a>
<a href=#291 id=291 data-nosnippet>291</a> <span class="attr">#[test]
<a href=#292 id=292 data-nosnippet>292</a> </span><span class="kw">fn </span>test_metric() {
<a href=#293 id=293 data-nosnippet>293</a> <span class="kw">let </span>runtime: Runtime = Builder::default()
<a href=#294 id=294 data-nosnippet>294</a> .worker_threads(<span class="number">5</span>)
<a href=#295 id=295 data-nosnippet>295</a> .thread_name(<span class="string">"test_runtime_metric"</span>)
<a href=#296 id=296 data-nosnippet>296</a> .build()
<a href=#297 id=297 data-nosnippet>297</a> .unwrap();
<a href=#298 id=298 data-nosnippet>298</a> <span class="comment">// wait threads create
<a href=#299 id=299 data-nosnippet>299</a> </span>thread::sleep(Duration::from_millis(<span class="number">50</span>));
<a href=#300 id=300 data-nosnippet>300</a>
<a href=#301 id=301 data-nosnippet>301</a> <span class="kw">let </span>_handle = runtime.spawn(<span class="kw">async </span>{
<a href=#302 id=302 data-nosnippet>302</a> thread::sleep(Duration::from_millis(<span class="number">50</span>));
<a href=#303 id=303 data-nosnippet>303</a> });
<a href=#304 id=304 data-nosnippet>304</a>
<a href=#305 id=305 data-nosnippet>305</a> thread::sleep(Duration::from_millis(<span class="number">10</span>));
<a href=#306 id=306 data-nosnippet>306</a>
<a href=#307 id=307 data-nosnippet>307</a> <span class="kw">let </span>metric_text = dump_metrics().unwrap();
<a href=#308 id=308 data-nosnippet>308</a>
<a href=#309 id=309 data-nosnippet>309</a> <span class="macro">assert!</span>(metric_text.contains(<span class="string">"runtime_threads_idle{thread_name=\"test_runtime_metric\"}"</span>));
<a href=#310 id=310 data-nosnippet>310</a> <span class="macro">assert!</span>(metric_text.contains(<span class="string">"runtime_threads_alive{thread_name=\"test_runtime_metric\"}"</span>));
<a href=#311 id=311 data-nosnippet>311</a>
<a href=#312 id=312 data-nosnippet>312</a> <span class="attr">#[cfg(tokio_unstable)]
<a href=#313 id=313 data-nosnippet>313</a> </span>{
<a href=#314 id=314 data-nosnippet>314</a> <span class="macro">assert!</span>(metric_text.contains(<span class="string">"runtime_0_tokio_budget_forced_yield_count 0"</span>));
<a href=#315 id=315 data-nosnippet>315</a> <span class="macro">assert!</span>(metric_text.contains(<span class="string">"runtime_0_tokio_injection_queue_depth 0"</span>));
<a href=#316 id=316 data-nosnippet>316</a> <span class="macro">assert!</span>(metric_text.contains(<span class="string">"runtime_0_tokio_workers_count 5"</span>));
<a href=#317 id=317 data-nosnippet>317</a> }
<a href=#318 id=318 data-nosnippet>318</a> }
<a href=#319 id=319 data-nosnippet>319</a>
<a href=#320 id=320 data-nosnippet>320</a> <span class="attr">#[test]
<a href=#321 id=321 data-nosnippet>321</a> </span><span class="kw">fn </span>block_on_async() {
<a href=#322 id=322 data-nosnippet>322</a> <span class="kw">let </span>runtime = runtime();
<a href=#323 id=323 data-nosnippet>323</a>
<a href=#324 id=324 data-nosnippet>324</a> <span class="kw">let </span>out = runtime.block_on(<span class="kw">async </span>{
<a href=#325 id=325 data-nosnippet>325</a> <span class="kw">let </span>(tx, rx) = oneshot::channel();
<a href=#326 id=326 data-nosnippet>326</a>
<a href=#327 id=327 data-nosnippet>327</a> <span class="kw">let _ </span>= thread::spawn(<span class="kw">move </span>|| {
<a href=#328 id=328 data-nosnippet>328</a> thread::sleep(Duration::from_millis(<span class="number">50</span>));
<a href=#329 id=329 data-nosnippet>329</a> tx.send(<span class="string">"ZOMG"</span>).unwrap();
<a href=#330 id=330 data-nosnippet>330</a> });
<a href=#331 id=331 data-nosnippet>331</a>
<a href=#332 id=332 data-nosnippet>332</a> <span class="macro">assert_ok!</span>(rx.<span class="kw">await</span>)
<a href=#333 id=333 data-nosnippet>333</a> });
<a href=#334 id=334 data-nosnippet>334</a>
<a href=#335 id=335 data-nosnippet>335</a> <span class="macro">assert_eq!</span>(out, <span class="string">"ZOMG"</span>);
<a href=#336 id=336 data-nosnippet>336</a> }
<a href=#337 id=337 data-nosnippet>337</a>
<a href=#338 id=338 data-nosnippet>338</a> <span class="attr">#[test]
<a href=#339 id=339 data-nosnippet>339</a> </span><span class="kw">fn </span>spawn_from_blocking() {
<a href=#340 id=340 data-nosnippet>340</a> <span class="kw">let </span>runtime = runtime();
<a href=#341 id=341 data-nosnippet>341</a> <span class="kw">let </span>runtime1 = runtime.clone();
<a href=#342 id=342 data-nosnippet>342</a> <span class="kw">let </span>out = runtime.block_on(<span class="kw">async move </span>{
<a href=#343 id=343 data-nosnippet>343</a> <span class="kw">let </span>runtime2 = runtime1.clone();
<a href=#344 id=344 data-nosnippet>344</a> <span class="kw">let </span>inner = <span class="macro">assert_ok!</span>(
<a href=#345 id=345 data-nosnippet>345</a> runtime1
<a href=#346 id=346 data-nosnippet>346</a> .spawn_blocking(<span class="kw">move </span>|| { runtime2.spawn(<span class="kw">async move </span>{ <span class="string">"hello" </span>}) })
<a href=#347 id=347 data-nosnippet>347</a> .<span class="kw">await
<a href=#348 id=348 data-nosnippet>348</a> </span>);
<a href=#349 id=349 data-nosnippet>349</a>
<a href=#350 id=350 data-nosnippet>350</a> <span class="macro">assert_ok!</span>(inner.<span class="kw">await</span>)
<a href=#351 id=351 data-nosnippet>351</a> });
<a href=#352 id=352 data-nosnippet>352</a>
<a href=#353 id=353 data-nosnippet>353</a> <span class="macro">assert_eq!</span>(out, <span class="string">"hello"</span>)
<a href=#354 id=354 data-nosnippet>354</a> }
<a href=#355 id=355 data-nosnippet>355</a>
<a href=#356 id=356 data-nosnippet>356</a> <span class="attr">#[test]
<a href=#357 id=357 data-nosnippet>357</a> </span><span class="kw">fn </span>test_spawn_join() {
<a href=#358 id=358 data-nosnippet>358</a> <span class="kw">let </span>runtime = runtime();
<a href=#359 id=359 data-nosnippet>359</a> <span class="kw">let </span>handle = runtime.spawn(<span class="kw">async </span>{ <span class="number">1 </span>+ <span class="number">1 </span>});
<a href=#360 id=360 data-nosnippet>360</a>
<a href=#361 id=361 data-nosnippet>361</a> <span class="macro">assert_eq!</span>(<span class="number">2</span>, runtime.block_on(handle).unwrap());
<a href=#362 id=362 data-nosnippet>362</a> }
<a href=#363 id=363 data-nosnippet>363</a>}
</code></pre></div></section></main></body></html>
@@ -0,0 +1,82 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/common/runtime/src/runtime_default.rs`."><title>runtime_default.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="common_runtime" data-themes="" data-resource-suffix="" data-rustdoc-version="1.96.1 (31fca3adb 2026-06-26)" data-channel="1.96.1" data-search-js="search-b5634cc7.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../../static.files/storage-41dd4d93.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-5013f961.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-f7c3ffd8.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content" tabindex="-1"><div class="main-heading"><h1><div class="sub-heading">common_runtime/</div>runtime_default.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="comment">// Copyright 2023 Greptime Team
<a href=#2 id=2 data-nosnippet>2</a>//
<a href=#3 id=3 data-nosnippet>3</a>// Licensed under the Apache License, Version 2.0 (the "License");
<a href=#4 id=4 data-nosnippet>4</a>// you may not use this file except in compliance with the License.
<a href=#5 id=5 data-nosnippet>5</a>// You may obtain a copy of the License at
<a href=#6 id=6 data-nosnippet>6</a>//
<a href=#7 id=7 data-nosnippet>7</a>// http://www.apache.org/licenses/LICENSE-2.0
<a href=#8 id=8 data-nosnippet>8</a>//
<a href=#9 id=9 data-nosnippet>9</a>// Unless required by applicable law or agreed to in writing, software
<a href=#10 id=10 data-nosnippet>10</a>// distributed under the License is distributed on an "AS IS" BASIS,
<a href=#11 id=11 data-nosnippet>11</a>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<a href=#12 id=12 data-nosnippet>12</a>// See the License for the specific language governing permissions and
<a href=#13 id=13 data-nosnippet>13</a>// limitations under the License.
<a href=#14 id=14 data-nosnippet>14</a>
<a href=#15 id=15 data-nosnippet>15</a></span><span class="kw">use </span>std::future::Future;
<a href=#16 id=16 data-nosnippet>16</a><span class="kw">use </span>std::sync::Arc;
<a href=#17 id=17 data-nosnippet>17</a>
<a href=#18 id=18 data-nosnippet>18</a><span class="kw">use </span>tokio::runtime::Handle;
<a href=#19 id=19 data-nosnippet>19</a><span class="kw">pub use </span>tokio::task::JoinHandle;
<a href=#20 id=20 data-nosnippet>20</a>
<a href=#21 id=21 data-nosnippet>21</a><span class="kw">use </span><span class="kw">crate</span>::Builder;
<a href=#22 id=22 data-nosnippet>22</a><span class="kw">use </span><span class="kw">crate</span>::runtime::{Dropper, RuntimeTrait};
<a href=#23 id=23 data-nosnippet>23</a>
<a href=#24 id=24 data-nosnippet>24</a><span class="doccomment">/// A runtime to run future tasks
<a href=#25 id=25 data-nosnippet>25</a></span><span class="attr">#[derive(Clone, Debug)]
<a href=#26 id=26 data-nosnippet>26</a></span><span class="kw">pub struct </span>DefaultRuntime {
<a href=#27 id=27 data-nosnippet>27</a> name: String,
<a href=#28 id=28 data-nosnippet>28</a> handle: Handle,
<a href=#29 id=29 data-nosnippet>29</a> <span class="comment">// Used to receive a drop signal when dropper is dropped, inspired by databend
<a href=#30 id=30 data-nosnippet>30</a> </span>_dropper: Arc&lt;Dropper&gt;,
<a href=#31 id=31 data-nosnippet>31</a>}
<a href=#32 id=32 data-nosnippet>32</a>
<a href=#33 id=33 data-nosnippet>33</a><span class="kw">impl </span>DefaultRuntime {
<a href=#34 id=34 data-nosnippet>34</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new(name: <span class="kw-2">&amp;</span>str, handle: Handle, dropper: Arc&lt;Dropper&gt;) -&gt; <span class="self">Self </span>{
<a href=#35 id=35 data-nosnippet>35</a> <span class="self">Self </span>{
<a href=#36 id=36 data-nosnippet>36</a> name: name.to_string(),
<a href=#37 id=37 data-nosnippet>37</a> handle,
<a href=#38 id=38 data-nosnippet>38</a> _dropper: dropper,
<a href=#39 id=39 data-nosnippet>39</a> }
<a href=#40 id=40 data-nosnippet>40</a> }
<a href=#41 id=41 data-nosnippet>41</a>
<a href=#42 id=42 data-nosnippet>42</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>handle(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; tokio::runtime::Handle {
<a href=#43 id=43 data-nosnippet>43</a> <span class="self">self</span>.handle.clone()
<a href=#44 id=44 data-nosnippet>44</a> }
<a href=#45 id=45 data-nosnippet>45</a>}
<a href=#46 id=46 data-nosnippet>46</a>
<a href=#47 id=47 data-nosnippet>47</a><span class="kw">impl </span>RuntimeTrait <span class="kw">for </span>DefaultRuntime {
<a href=#48 id=48 data-nosnippet>48</a> <span class="kw">fn </span>builder() -&gt; Builder {
<a href=#49 id=49 data-nosnippet>49</a> Builder::default()
<a href=#50 id=50 data-nosnippet>50</a> }
<a href=#51 id=51 data-nosnippet>51</a>
<a href=#52 id=52 data-nosnippet>52</a> <span class="doccomment">/// Spawn a future and execute it in this thread pool
<a href=#53 id=53 data-nosnippet>53</a> ///
<a href=#54 id=54 data-nosnippet>54</a> /// Similar to tokio::runtime::Runtime::spawn()
<a href=#55 id=55 data-nosnippet>55</a> </span><span class="kw">fn </span>spawn&lt;F&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, future: F) -&gt; JoinHandle&lt;F::Output&gt;
<a href=#56 id=56 data-nosnippet>56</a> <span class="kw">where
<a href=#57 id=57 data-nosnippet>57</a> </span>F: Future + Send + <span class="lifetime">'static</span>,
<a href=#58 id=58 data-nosnippet>58</a> F::Output: Send + <span class="lifetime">'static</span>,
<a href=#59 id=59 data-nosnippet>59</a> {
<a href=#60 id=60 data-nosnippet>60</a> <span class="self">self</span>.handle.spawn(future)
<a href=#61 id=61 data-nosnippet>61</a> }
<a href=#62 id=62 data-nosnippet>62</a>
<a href=#63 id=63 data-nosnippet>63</a> <span class="doccomment">/// Run the provided function on an executor dedicated to blocking
<a href=#64 id=64 data-nosnippet>64</a> /// operations.
<a href=#65 id=65 data-nosnippet>65</a> </span><span class="kw">fn </span>spawn_blocking&lt;F, R&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, func: F) -&gt; JoinHandle&lt;R&gt;
<a href=#66 id=66 data-nosnippet>66</a> <span class="kw">where
<a href=#67 id=67 data-nosnippet>67</a> </span>F: FnOnce() -&gt; R + Send + <span class="lifetime">'static</span>,
<a href=#68 id=68 data-nosnippet>68</a> R: Send + <span class="lifetime">'static</span>,
<a href=#69 id=69 data-nosnippet>69</a> {
<a href=#70 id=70 data-nosnippet>70</a> <span class="self">self</span>.handle.spawn_blocking(func)
<a href=#71 id=71 data-nosnippet>71</a> }
<a href=#72 id=72 data-nosnippet>72</a>
<a href=#73 id=73 data-nosnippet>73</a> <span class="doccomment">/// Run a future to complete, this is the runtime's entry point
<a href=#74 id=74 data-nosnippet>74</a> </span><span class="kw">fn </span>block_on&lt;F: Future&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, future: F) -&gt; F::Output {
<a href=#75 id=75 data-nosnippet>75</a> <span class="self">self</span>.handle.block_on(future)
<a href=#76 id=76 data-nosnippet>76</a> }
<a href=#77 id=77 data-nosnippet>77</a>
<a href=#78 id=78 data-nosnippet>78</a> <span class="kw">fn </span>name(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>str {
<a href=#79 id=79 data-nosnippet>79</a> <span class="kw-2">&amp;</span><span class="self">self</span>.name
<a href=#80 id=80 data-nosnippet>80</a> }
<a href=#81 id=81 data-nosnippet>81</a>}
</code></pre></div></section></main></body></html>
@@ -0,0 +1,286 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/common/runtime/src/runtime_throttleable.rs`."><title>runtime_throttleable.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="common_runtime" data-themes="" data-resource-suffix="" data-rustdoc-version="1.96.1 (31fca3adb 2026-06-26)" data-channel="1.96.1" data-search-js="search-b5634cc7.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../../static.files/storage-41dd4d93.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-5013f961.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-f7c3ffd8.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content" tabindex="-1"><div class="main-heading"><h1><div class="sub-heading">common_runtime/</div>runtime_throttleable.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="comment">// Copyright 2023 Greptime Team
<a href=#2 id=2 data-nosnippet>2</a>//
<a href=#3 id=3 data-nosnippet>3</a>// Licensed under the Apache License, Version 2.0 (the "License");
<a href=#4 id=4 data-nosnippet>4</a>// you may not use this file except in compliance with the License.
<a href=#5 id=5 data-nosnippet>5</a>// You may obtain a copy of the License at
<a href=#6 id=6 data-nosnippet>6</a>//
<a href=#7 id=7 data-nosnippet>7</a>// http://www.apache.org/licenses/LICENSE-2.0
<a href=#8 id=8 data-nosnippet>8</a>//
<a href=#9 id=9 data-nosnippet>9</a>// Unless required by applicable law or agreed to in writing, software
<a href=#10 id=10 data-nosnippet>10</a>// distributed under the License is distributed on an "AS IS" BASIS,
<a href=#11 id=11 data-nosnippet>11</a>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<a href=#12 id=12 data-nosnippet>12</a>// See the License for the specific language governing permissions and
<a href=#13 id=13 data-nosnippet>13</a>// limitations under the License.
<a href=#14 id=14 data-nosnippet>14</a>
<a href=#15 id=15 data-nosnippet>15</a></span><span class="kw">use </span>std::fmt::Debug;
<a href=#16 id=16 data-nosnippet>16</a><span class="kw">use </span>std::future::Future;
<a href=#17 id=17 data-nosnippet>17</a><span class="kw">use </span>std::pin::Pin;
<a href=#18 id=18 data-nosnippet>18</a><span class="kw">use </span>std::sync::Arc;
<a href=#19 id=19 data-nosnippet>19</a><span class="kw">use </span>std::task::{Context, Poll};
<a href=#20 id=20 data-nosnippet>20</a><span class="kw">use </span>std::time::Duration;
<a href=#21 id=21 data-nosnippet>21</a>
<a href=#22 id=22 data-nosnippet>22</a><span class="kw">use </span>futures::FutureExt;
<a href=#23 id=23 data-nosnippet>23</a><span class="kw">use </span>ratelimit::Ratelimiter;
<a href=#24 id=24 data-nosnippet>24</a><span class="kw">use </span>snafu::ResultExt;
<a href=#25 id=25 data-nosnippet>25</a><span class="kw">use </span>tokio::runtime::Handle;
<a href=#26 id=26 data-nosnippet>26</a><span class="kw">pub use </span>tokio::task::JoinHandle;
<a href=#27 id=27 data-nosnippet>27</a><span class="kw">use </span>tokio::time::Sleep;
<a href=#28 id=28 data-nosnippet>28</a>
<a href=#29 id=29 data-nosnippet>29</a><span class="kw">use </span><span class="kw">crate</span>::Builder;
<a href=#30 id=30 data-nosnippet>30</a><span class="kw">use </span><span class="kw">crate</span>::error::{BuildRuntimeRateLimiterSnafu, <span class="prelude-ty">Result</span>};
<a href=#31 id=31 data-nosnippet>31</a><span class="kw">use </span><span class="kw">crate</span>::runtime::{Dropper, Priority, RuntimeTrait};
<a href=#32 id=32 data-nosnippet>32</a>
<a href=#33 id=33 data-nosnippet>33</a><span class="kw">struct </span>RuntimeRateLimiter {
<a href=#34 id=34 data-nosnippet>34</a> <span class="kw">pub </span>ratelimiter: <span class="prelude-ty">Option</span>&lt;Ratelimiter&gt;,
<a href=#35 id=35 data-nosnippet>35</a>}
<a href=#36 id=36 data-nosnippet>36</a>
<a href=#37 id=37 data-nosnippet>37</a><span class="kw">impl </span>Debug <span class="kw">for </span>RuntimeRateLimiter {
<a href=#38 id=38 data-nosnippet>38</a> <span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>std::fmt::Formatter&lt;<span class="lifetime">'_</span>&gt;) -&gt; std::fmt::Result {
<a href=#39 id=39 data-nosnippet>39</a> f.debug_struct(<span class="string">"RuntimeThrottleShareWithFuture"</span>)
<a href=#40 id=40 data-nosnippet>40</a> .field(
<a href=#41 id=41 data-nosnippet>41</a> <span class="string">"ratelimiter_max_tokens"</span>,
<a href=#42 id=42 data-nosnippet>42</a> <span class="kw-2">&amp;</span><span class="self">self</span>.ratelimiter.as_ref().map(|v| v.max_tokens()),
<a href=#43 id=43 data-nosnippet>43</a> )
<a href=#44 id=44 data-nosnippet>44</a> .field(
<a href=#45 id=45 data-nosnippet>45</a> <span class="string">"ratelimiter_refill_amount"</span>,
<a href=#46 id=46 data-nosnippet>46</a> <span class="kw-2">&amp;</span><span class="self">self</span>.ratelimiter.as_ref().map(|v| v.refill_amount()),
<a href=#47 id=47 data-nosnippet>47</a> )
<a href=#48 id=48 data-nosnippet>48</a> .finish()
<a href=#49 id=49 data-nosnippet>49</a> }
<a href=#50 id=50 data-nosnippet>50</a>}
<a href=#51 id=51 data-nosnippet>51</a>
<a href=#52 id=52 data-nosnippet>52</a><span class="doccomment">/// A runtime to run future tasks
<a href=#53 id=53 data-nosnippet>53</a></span><span class="attr">#[derive(Clone, Debug)]
<a href=#54 id=54 data-nosnippet>54</a></span><span class="kw">pub struct </span>ThrottleableRuntime {
<a href=#55 id=55 data-nosnippet>55</a> name: String,
<a href=#56 id=56 data-nosnippet>56</a> handle: Handle,
<a href=#57 id=57 data-nosnippet>57</a> shared_with_future: Arc&lt;RuntimeRateLimiter&gt;,
<a href=#58 id=58 data-nosnippet>58</a> <span class="comment">// Used to receive a drop signal when dropper is dropped, inspired by databend
<a href=#59 id=59 data-nosnippet>59</a> </span>_dropper: Arc&lt;Dropper&gt;,
<a href=#60 id=60 data-nosnippet>60</a>}
<a href=#61 id=61 data-nosnippet>61</a>
<a href=#62 id=62 data-nosnippet>62</a><span class="kw">impl </span>ThrottleableRuntime {
<a href=#63 id=63 data-nosnippet>63</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new(
<a href=#64 id=64 data-nosnippet>64</a> name: <span class="kw-2">&amp;</span>str,
<a href=#65 id=65 data-nosnippet>65</a> priority: Priority,
<a href=#66 id=66 data-nosnippet>66</a> handle: Handle,
<a href=#67 id=67 data-nosnippet>67</a> dropper: Arc&lt;Dropper&gt;,
<a href=#68 id=68 data-nosnippet>68</a> ) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>&gt; {
<a href=#69 id=69 data-nosnippet>69</a> <span class="prelude-val">Ok</span>(<span class="self">Self </span>{
<a href=#70 id=70 data-nosnippet>70</a> name: name.to_string(),
<a href=#71 id=71 data-nosnippet>71</a> handle,
<a href=#72 id=72 data-nosnippet>72</a> shared_with_future: Arc::new(RuntimeRateLimiter {
<a href=#73 id=73 data-nosnippet>73</a> ratelimiter: priority.ratelimiter_count()<span class="question-mark">?</span>,
<a href=#74 id=74 data-nosnippet>74</a> }),
<a href=#75 id=75 data-nosnippet>75</a> _dropper: dropper,
<a href=#76 id=76 data-nosnippet>76</a> })
<a href=#77 id=77 data-nosnippet>77</a> }
<a href=#78 id=78 data-nosnippet>78</a>}
<a href=#79 id=79 data-nosnippet>79</a>
<a href=#80 id=80 data-nosnippet>80</a><span class="kw">impl </span>RuntimeTrait <span class="kw">for </span>ThrottleableRuntime {
<a href=#81 id=81 data-nosnippet>81</a> <span class="kw">fn </span>builder() -&gt; Builder {
<a href=#82 id=82 data-nosnippet>82</a> Builder::default()
<a href=#83 id=83 data-nosnippet>83</a> }
<a href=#84 id=84 data-nosnippet>84</a>
<a href=#85 id=85 data-nosnippet>85</a> <span class="doccomment">/// Spawn a future and execute it in this thread pool
<a href=#86 id=86 data-nosnippet>86</a> ///
<a href=#87 id=87 data-nosnippet>87</a> /// Similar to tokio::runtime::Runtime::spawn()
<a href=#88 id=88 data-nosnippet>88</a> </span><span class="kw">fn </span>spawn&lt;F&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, future: F) -&gt; JoinHandle&lt;F::Output&gt;
<a href=#89 id=89 data-nosnippet>89</a> <span class="kw">where
<a href=#90 id=90 data-nosnippet>90</a> </span>F: Future + Send + <span class="lifetime">'static</span>,
<a href=#91 id=91 data-nosnippet>91</a> F::Output: Send + <span class="lifetime">'static</span>,
<a href=#92 id=92 data-nosnippet>92</a> {
<a href=#93 id=93 data-nosnippet>93</a> <span class="self">self</span>.handle
<a href=#94 id=94 data-nosnippet>94</a> .spawn(ThrottleFuture::new(<span class="self">self</span>.shared_with_future.clone(), future))
<a href=#95 id=95 data-nosnippet>95</a> }
<a href=#96 id=96 data-nosnippet>96</a>
<a href=#97 id=97 data-nosnippet>97</a> <span class="doccomment">/// Run the provided function on an executor dedicated to blocking
<a href=#98 id=98 data-nosnippet>98</a> /// operations.
<a href=#99 id=99 data-nosnippet>99</a> </span><span class="kw">fn </span>spawn_blocking&lt;F, R&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, func: F) -&gt; JoinHandle&lt;R&gt;
<a href=#100 id=100 data-nosnippet>100</a> <span class="kw">where
<a href=#101 id=101 data-nosnippet>101</a> </span>F: FnOnce() -&gt; R + Send + <span class="lifetime">'static</span>,
<a href=#102 id=102 data-nosnippet>102</a> R: Send + <span class="lifetime">'static</span>,
<a href=#103 id=103 data-nosnippet>103</a> {
<a href=#104 id=104 data-nosnippet>104</a> <span class="self">self</span>.handle.spawn_blocking(func)
<a href=#105 id=105 data-nosnippet>105</a> }
<a href=#106 id=106 data-nosnippet>106</a>
<a href=#107 id=107 data-nosnippet>107</a> <span class="doccomment">/// Run a future to complete, this is the runtime's entry point
<a href=#108 id=108 data-nosnippet>108</a> </span><span class="kw">fn </span>block_on&lt;F: Future&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, future: F) -&gt; F::Output {
<a href=#109 id=109 data-nosnippet>109</a> <span class="self">self</span>.handle.block_on(future)
<a href=#110 id=110 data-nosnippet>110</a> }
<a href=#111 id=111 data-nosnippet>111</a>
<a href=#112 id=112 data-nosnippet>112</a> <span class="kw">fn </span>name(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>str {
<a href=#113 id=113 data-nosnippet>113</a> <span class="kw-2">&amp;</span><span class="self">self</span>.name
<a href=#114 id=114 data-nosnippet>114</a> }
<a href=#115 id=115 data-nosnippet>115</a>}
<a href=#116 id=116 data-nosnippet>116</a>
<a href=#117 id=117 data-nosnippet>117</a><span class="kw">enum </span>State {
<a href=#118 id=118 data-nosnippet>118</a> Pollable,
<a href=#119 id=119 data-nosnippet>119</a> Throttled(Pin&lt;Box&lt;Sleep&gt;&gt;),
<a href=#120 id=120 data-nosnippet>120</a>}
<a href=#121 id=121 data-nosnippet>121</a>
<a href=#122 id=122 data-nosnippet>122</a><span class="kw">impl </span>State {
<a href=#123 id=123 data-nosnippet>123</a> <span class="kw">fn </span>unwrap_backoff(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;mut </span>Pin&lt;Box&lt;Sleep&gt;&gt; {
<a href=#124 id=124 data-nosnippet>124</a> <span class="kw">match </span><span class="self">self </span>{
<a href=#125 id=125 data-nosnippet>125</a> State::Throttled(sleep) =&gt; sleep,
<a href=#126 id=126 data-nosnippet>126</a> <span class="kw">_ </span>=&gt; <span class="macro">panic!</span>(<span class="string">"unwrap_backoff failed"</span>),
<a href=#127 id=127 data-nosnippet>127</a> }
<a href=#128 id=128 data-nosnippet>128</a> }
<a href=#129 id=129 data-nosnippet>129</a>}
<a href=#130 id=130 data-nosnippet>130</a>
<a href=#131 id=131 data-nosnippet>131</a><span class="attr">#[pin_project::pin_project]
<a href=#132 id=132 data-nosnippet>132</a></span><span class="kw">pub struct </span>ThrottleFuture&lt;F: Future + Send + <span class="lifetime">'static</span>&gt; {
<a href=#133 id=133 data-nosnippet>133</a> <span class="attr">#[pin]
<a href=#134 id=134 data-nosnippet>134</a> </span>future: F,
<a href=#135 id=135 data-nosnippet>135</a>
<a href=#136 id=136 data-nosnippet>136</a> <span class="doccomment">/// RateLimiter of this future
<a href=#137 id=137 data-nosnippet>137</a> </span>handle: Arc&lt;RuntimeRateLimiter&gt;,
<a href=#138 id=138 data-nosnippet>138</a>
<a href=#139 id=139 data-nosnippet>139</a> state: State,
<a href=#140 id=140 data-nosnippet>140</a>}
<a href=#141 id=141 data-nosnippet>141</a>
<a href=#142 id=142 data-nosnippet>142</a><span class="kw">impl</span>&lt;F&gt; ThrottleFuture&lt;F&gt;
<a href=#143 id=143 data-nosnippet>143</a><span class="kw">where
<a href=#144 id=144 data-nosnippet>144</a> </span>F: Future + Send + <span class="lifetime">'static</span>,
<a href=#145 id=145 data-nosnippet>145</a> F::Output: Send + <span class="lifetime">'static</span>,
<a href=#146 id=146 data-nosnippet>146</a>{
<a href=#147 id=147 data-nosnippet>147</a> <span class="kw">fn </span>new(handle: Arc&lt;RuntimeRateLimiter&gt;, future: F) -&gt; <span class="self">Self </span>{
<a href=#148 id=148 data-nosnippet>148</a> <span class="self">Self </span>{
<a href=#149 id=149 data-nosnippet>149</a> future,
<a href=#150 id=150 data-nosnippet>150</a> handle,
<a href=#151 id=151 data-nosnippet>151</a> state: State::Pollable,
<a href=#152 id=152 data-nosnippet>152</a> }
<a href=#153 id=153 data-nosnippet>153</a> }
<a href=#154 id=154 data-nosnippet>154</a>}
<a href=#155 id=155 data-nosnippet>155</a>
<a href=#156 id=156 data-nosnippet>156</a><span class="kw">impl</span>&lt;F&gt; Future <span class="kw">for </span>ThrottleFuture&lt;F&gt;
<a href=#157 id=157 data-nosnippet>157</a><span class="kw">where
<a href=#158 id=158 data-nosnippet>158</a> </span>F: Future + Send + <span class="lifetime">'static</span>,
<a href=#159 id=159 data-nosnippet>159</a> F::Output: Send + <span class="lifetime">'static</span>,
<a href=#160 id=160 data-nosnippet>160</a>{
<a href=#161 id=161 data-nosnippet>161</a> <span class="kw">type </span>Output = F::Output;
<a href=#162 id=162 data-nosnippet>162</a>
<a href=#163 id=163 data-nosnippet>163</a> <span class="kw">fn </span>poll(<span class="self">self</span>: std::pin::Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;, cx: <span class="kw-2">&amp;mut </span>Context&lt;<span class="lifetime">'_</span>&gt;) -&gt; Poll&lt;<span class="self">Self</span>::Output&gt; {
<a href=#164 id=164 data-nosnippet>164</a> <span class="kw">let </span>this = <span class="self">self</span>.project();
<a href=#165 id=165 data-nosnippet>165</a>
<a href=#166 id=166 data-nosnippet>166</a> <span class="kw">match </span>this.state {
<a href=#167 id=167 data-nosnippet>167</a> State::Pollable =&gt; {}
<a href=#168 id=168 data-nosnippet>168</a> State::Throttled(sleep) =&gt; <span class="kw">match </span>sleep.poll_unpin(cx) {
<a href=#169 id=169 data-nosnippet>169</a> Poll::Ready(<span class="kw">_</span>) =&gt; {
<a href=#170 id=170 data-nosnippet>170</a> <span class="kw-2">*</span>this.state = State::Pollable;
<a href=#171 id=171 data-nosnippet>171</a> }
<a href=#172 id=172 data-nosnippet>172</a> Poll::Pending =&gt; <span class="kw">return </span>Poll::Pending,
<a href=#173 id=173 data-nosnippet>173</a> },
<a href=#174 id=174 data-nosnippet>174</a> };
<a href=#175 id=175 data-nosnippet>175</a>
<a href=#176 id=176 data-nosnippet>176</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(ratelimiter) = <span class="kw-2">&amp;</span>this.handle.ratelimiter
<a href=#177 id=177 data-nosnippet>177</a> &amp;&amp; <span class="kw">let </span><span class="prelude-val">Err</span>(wait) = ratelimiter.try_wait()
<a href=#178 id=178 data-nosnippet>178</a> {
<a href=#179 id=179 data-nosnippet>179</a> <span class="kw-2">*</span>this.state = State::Throttled(Box::pin(tokio::time::sleep(wait)));
<a href=#180 id=180 data-nosnippet>180</a> <span class="kw">match </span>this.state.unwrap_backoff().poll_unpin(cx) {
<a href=#181 id=181 data-nosnippet>181</a> Poll::Ready(<span class="kw">_</span>) =&gt; {
<a href=#182 id=182 data-nosnippet>182</a> <span class="kw-2">*</span>this.state = State::Pollable;
<a href=#183 id=183 data-nosnippet>183</a> }
<a href=#184 id=184 data-nosnippet>184</a> Poll::Pending =&gt; {
<a href=#185 id=185 data-nosnippet>185</a> <span class="kw">return </span>Poll::Pending;
<a href=#186 id=186 data-nosnippet>186</a> }
<a href=#187 id=187 data-nosnippet>187</a> }
<a href=#188 id=188 data-nosnippet>188</a> }
<a href=#189 id=189 data-nosnippet>189</a>
<a href=#190 id=190 data-nosnippet>190</a> <span class="kw">let </span>poll_res = this.future.poll(cx);
<a href=#191 id=191 data-nosnippet>191</a>
<a href=#192 id=192 data-nosnippet>192</a> <span class="kw">match </span>poll_res {
<a href=#193 id=193 data-nosnippet>193</a> Poll::Ready(r) =&gt; Poll::Ready(r),
<a href=#194 id=194 data-nosnippet>194</a> Poll::Pending =&gt; Poll::Pending,
<a href=#195 id=195 data-nosnippet>195</a> }
<a href=#196 id=196 data-nosnippet>196</a> }
<a href=#197 id=197 data-nosnippet>197</a>}
<a href=#198 id=198 data-nosnippet>198</a>
<a href=#199 id=199 data-nosnippet>199</a><span class="kw">impl </span>Priority {
<a href=#200 id=200 data-nosnippet>200</a> <span class="kw">fn </span>ratelimiter_count(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="prelude-ty">Option</span>&lt;Ratelimiter&gt;&gt; {
<a href=#201 id=201 data-nosnippet>201</a> <span class="kw">let </span>max = <span class="number">8000</span>;
<a href=#202 id=202 data-nosnippet>202</a> <span class="kw">let </span>gen_per_10ms = <span class="kw">match </span><span class="self">self </span>{
<a href=#203 id=203 data-nosnippet>203</a> Priority::VeryLow =&gt; <span class="prelude-val">Some</span>(<span class="number">2000</span>),
<a href=#204 id=204 data-nosnippet>204</a> Priority::Low =&gt; <span class="prelude-val">Some</span>(<span class="number">4000</span>),
<a href=#205 id=205 data-nosnippet>205</a> Priority::Middle =&gt; <span class="prelude-val">Some</span>(<span class="number">6000</span>),
<a href=#206 id=206 data-nosnippet>206</a> Priority::High =&gt; <span class="prelude-val">Some</span>(<span class="number">8000</span>),
<a href=#207 id=207 data-nosnippet>207</a> Priority::VeryHigh =&gt; <span class="prelude-val">None</span>,
<a href=#208 id=208 data-nosnippet>208</a> };
<a href=#209 id=209 data-nosnippet>209</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(gen_per_10ms) = gen_per_10ms {
<a href=#210 id=210 data-nosnippet>210</a> Ratelimiter::builder(gen_per_10ms, Duration::from_millis(<span class="number">10</span>)) <span class="comment">// generate poll count per 10ms
<a href=#211 id=211 data-nosnippet>211</a> </span>.max_tokens(max) <span class="comment">// reserved token for batch request
<a href=#212 id=212 data-nosnippet>212</a> </span>.build()
<a href=#213 id=213 data-nosnippet>213</a> .context(BuildRuntimeRateLimiterSnafu)
<a href=#214 id=214 data-nosnippet>214</a> .map(<span class="prelude-val">Some</span>)
<a href=#215 id=215 data-nosnippet>215</a> } <span class="kw">else </span>{
<a href=#216 id=216 data-nosnippet>216</a> <span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>)
<a href=#217 id=217 data-nosnippet>217</a> }
<a href=#218 id=218 data-nosnippet>218</a> }
<a href=#219 id=219 data-nosnippet>219</a>}
<a href=#220 id=220 data-nosnippet>220</a>
<a href=#221 id=221 data-nosnippet>221</a><span class="attr">#[cfg(test)]
<a href=#222 id=222 data-nosnippet>222</a></span><span class="kw">mod </span>tests {
<a href=#223 id=223 data-nosnippet>223</a>
<a href=#224 id=224 data-nosnippet>224</a> <span class="kw">use </span>tokio::fs::File;
<a href=#225 id=225 data-nosnippet>225</a> <span class="kw">use </span>tokio::io::AsyncWriteExt;
<a href=#226 id=226 data-nosnippet>226</a> <span class="kw">use </span>tokio::time::Duration;
<a href=#227 id=227 data-nosnippet>227</a>
<a href=#228 id=228 data-nosnippet>228</a> <span class="kw">use </span>super::<span class="kw-2">*</span>;
<a href=#229 id=229 data-nosnippet>229</a> <span class="kw">use </span><span class="kw">crate</span>::runtime::BuilderBuild;
<a href=#230 id=230 data-nosnippet>230</a>
<a href=#231 id=231 data-nosnippet>231</a> <span class="attr">#[tokio::test]
<a href=#232 id=232 data-nosnippet>232</a> </span><span class="kw">async fn </span>test_throttleable_runtime_spawn_simple() {
<a href=#233 id=233 data-nosnippet>233</a> <span class="kw">for </span>p <span class="kw">in </span>[
<a href=#234 id=234 data-nosnippet>234</a> Priority::VeryLow,
<a href=#235 id=235 data-nosnippet>235</a> Priority::Low,
<a href=#236 id=236 data-nosnippet>236</a> Priority::Middle,
<a href=#237 id=237 data-nosnippet>237</a> Priority::High,
<a href=#238 id=238 data-nosnippet>238</a> Priority::VeryHigh,
<a href=#239 id=239 data-nosnippet>239</a> ] {
<a href=#240 id=240 data-nosnippet>240</a> <span class="kw">let </span>runtime: ThrottleableRuntime = Builder::default()
<a href=#241 id=241 data-nosnippet>241</a> .runtime_name(<span class="string">"test"</span>)
<a href=#242 id=242 data-nosnippet>242</a> .thread_name(<span class="string">"test"</span>)
<a href=#243 id=243 data-nosnippet>243</a> .worker_threads(<span class="number">8</span>)
<a href=#244 id=244 data-nosnippet>244</a> .priority(p)
<a href=#245 id=245 data-nosnippet>245</a> .build()
<a href=#246 id=246 data-nosnippet>246</a> .expect(<span class="string">"Fail to create runtime"</span>);
<a href=#247 id=247 data-nosnippet>247</a>
<a href=#248 id=248 data-nosnippet>248</a> <span class="comment">// Spawn a simple future that returns 42
<a href=#249 id=249 data-nosnippet>249</a> </span><span class="kw">let </span>handle = runtime.spawn(<span class="kw">async </span>{
<a href=#250 id=250 data-nosnippet>250</a> tokio::time::sleep(Duration::from_millis(<span class="number">10</span>)).<span class="kw">await</span>;
<a href=#251 id=251 data-nosnippet>251</a> <span class="number">42
<a href=#252 id=252 data-nosnippet>252</a> </span>});
<a href=#253 id=253 data-nosnippet>253</a> <span class="kw">let </span>result = handle.<span class="kw">await</span>.expect(<span class="string">"Task panicked"</span>);
<a href=#254 id=254 data-nosnippet>254</a> <span class="macro">assert_eq!</span>(result, <span class="number">42</span>);
<a href=#255 id=255 data-nosnippet>255</a> }
<a href=#256 id=256 data-nosnippet>256</a> }
<a href=#257 id=257 data-nosnippet>257</a>
<a href=#258 id=258 data-nosnippet>258</a> <span class="attr">#[tokio::test]
<a href=#259 id=259 data-nosnippet>259</a> </span><span class="kw">async fn </span>test_throttleable_runtime_spawn_complex() {
<a href=#260 id=260 data-nosnippet>260</a> <span class="kw">let </span>tempdir = tempfile::tempdir().unwrap();
<a href=#261 id=261 data-nosnippet>261</a> <span class="kw">for </span>p <span class="kw">in </span>[
<a href=#262 id=262 data-nosnippet>262</a> Priority::VeryLow,
<a href=#263 id=263 data-nosnippet>263</a> Priority::Low,
<a href=#264 id=264 data-nosnippet>264</a> Priority::Middle,
<a href=#265 id=265 data-nosnippet>265</a> Priority::High,
<a href=#266 id=266 data-nosnippet>266</a> Priority::VeryHigh,
<a href=#267 id=267 data-nosnippet>267</a> ] {
<a href=#268 id=268 data-nosnippet>268</a> <span class="kw">let </span>runtime: ThrottleableRuntime = Builder::default()
<a href=#269 id=269 data-nosnippet>269</a> .runtime_name(<span class="string">"test"</span>)
<a href=#270 id=270 data-nosnippet>270</a> .thread_name(<span class="string">"test"</span>)
<a href=#271 id=271 data-nosnippet>271</a> .worker_threads(<span class="number">8</span>)
<a href=#272 id=272 data-nosnippet>272</a> .priority(p)
<a href=#273 id=273 data-nosnippet>273</a> .build()
<a href=#274 id=274 data-nosnippet>274</a> .expect(<span class="string">"Fail to create runtime"</span>);
<a href=#275 id=275 data-nosnippet>275</a> <span class="kw">let </span>tempdirpath = tempdir.path().to_path_buf();
<a href=#276 id=276 data-nosnippet>276</a> <span class="kw">let </span>handle = runtime.spawn(<span class="kw">async move </span>{
<a href=#277 id=277 data-nosnippet>277</a> <span class="kw">let </span><span class="kw-2">mut </span>file = File::create(tempdirpath.join(<span class="string">"test.txt"</span>)).<span class="kw">await</span>.unwrap();
<a href=#278 id=278 data-nosnippet>278</a> file.write_all(<span class="string">b"Hello, world!"</span>).<span class="kw">await</span>.unwrap();
<a href=#279 id=279 data-nosnippet>279</a> <span class="number">42
<a href=#280 id=280 data-nosnippet>280</a> </span>});
<a href=#281 id=281 data-nosnippet>281</a> <span class="kw">let </span>result = handle.<span class="kw">await</span>.expect(<span class="string">"Task panicked"</span>);
<a href=#282 id=282 data-nosnippet>282</a> <span class="macro">assert_eq!</span>(result, <span class="number">42</span>);
<a href=#283 id=283 data-nosnippet>283</a> }
<a href=#284 id=284 data-nosnippet>284</a> }
<a href=#285 id=285 data-nosnippet>285</a>}
</code></pre></div></section></main></body></html>