<!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/ipc.rs`."><title>ipc.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-b0742ba02757f159.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="lsm" data-themes="" data-resource-suffix="" data-rustdoc-version="1.83.0 (90b35a623 2024-11-26) (Fedora 1.83.0-1.fc40)" data-channel="1.83.0" data-search-js="search-f0d225181b97f9a4.js" data-settings-js="settings-805db61a62df4bd2.js" ><script src="../../static.files/storage-1d39b6787ed640ff.js"></script><script defer src="../../static.files/src-script-e66d777a5a92e9b2.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-f070b9041d14864c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-0111fcff984fae8f.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc src"><!--[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"></div><main><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">lsm/</div>ipc.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap"><div data-nosnippet><pre class="src-line-numbers">
<a href="#1" id="1">1</a>
<a href="#2" id="2">2</a>
<a href="#3" id="3">3</a>
<a href="#4" id="4">4</a>
<a href="#5" id="5">5</a>
<a href="#6" id="6">6</a>
<a href="#7" id="7">7</a>
<a href="#8" id="8">8</a>
<a href="#9" id="9">9</a>
<a href="#10" id="10">10</a>
<a href="#11" id="11">11</a>
<a href="#12" id="12">12</a>
<a href="#13" id="13">13</a>
<a href="#14" id="14">14</a>
<a href="#15" id="15">15</a>
<a href="#16" id="16">16</a>
<a href="#17" id="17">17</a>
<a href="#18" id="18">18</a>
<a href="#19" id="19">19</a>
<a href="#20" id="20">20</a>
<a href="#21" id="21">21</a>
<a href="#22" id="22">22</a>
<a href="#23" id="23">23</a>
<a href="#24" id="24">24</a>
<a href="#25" id="25">25</a>
<a href="#26" id="26">26</a>
<a href="#27" id="27">27</a>
<a href="#28" id="28">28</a>
<a href="#29" id="29">29</a>
<a href="#30" id="30">30</a>
<a href="#31" id="31">31</a>
<a href="#32" id="32">32</a>
<a href="#33" id="33">33</a>
<a href="#34" id="34">34</a>
<a href="#35" id="35">35</a>
<a href="#36" id="36">36</a>
<a href="#37" id="37">37</a>
<a href="#38" id="38">38</a>
<a href="#39" id="39">39</a>
<a href="#40" id="40">40</a>
<a href="#41" id="41">41</a>
<a href="#42" id="42">42</a>
<a href="#43" id="43">43</a>
<a href="#44" id="44">44</a>
<a href="#45" id="45">45</a>
<a href="#46" id="46">46</a>
<a href="#47" id="47">47</a>
<a href="#48" id="48">48</a>
<a href="#49" id="49">49</a>
<a href="#50" id="50">50</a>
<a href="#51" id="51">51</a>
<a href="#52" id="52">52</a>
<a href="#53" id="53">53</a>
<a href="#54" id="54">54</a>
<a href="#55" id="55">55</a>
<a href="#56" id="56">56</a>
<a href="#57" id="57">57</a>
<a href="#58" id="58">58</a>
<a href="#59" id="59">59</a>
<a href="#60" id="60">60</a>
<a href="#61" id="61">61</a>
<a href="#62" id="62">62</a>
<a href="#63" id="63">63</a>
<a href="#64" id="64">64</a>
<a href="#65" id="65">65</a>
<a href="#66" id="66">66</a>
<a href="#67" id="67">67</a>
<a href="#68" id="68">68</a>
<a href="#69" id="69">69</a>
<a href="#70" id="70">70</a>
<a href="#71" id="71">71</a>
<a href="#72" id="72">72</a>
<a href="#73" id="73">73</a>
<a href="#74" id="74">74</a>
<a href="#75" id="75">75</a>
<a href="#76" id="76">76</a>
<a href="#77" id="77">77</a>
<a href="#78" id="78">78</a>
<a href="#79" id="79">79</a>
<a href="#80" id="80">80</a>
<a href="#81" id="81">81</a>
<a href="#82" id="82">82</a>
<a href="#83" id="83">83</a>
<a href="#84" id="84">84</a>
<a href="#85" id="85">85</a>
<a href="#86" id="86">86</a>
<a href="#87" id="87">87</a>
<a href="#88" id="88">88</a>
<a href="#89" id="89">89</a>
<a href="#90" id="90">90</a>
<a href="#91" id="91">91</a>
<a href="#92" id="92">92</a>
<a href="#93" id="93">93</a>
<a href="#94" id="94">94</a>
<a href="#95" id="95">95</a>
<a href="#96" id="96">96</a>
<a href="#97" id="97">97</a>
<a href="#98" id="98">98</a>
<a href="#99" id="99">99</a>
<a href="#100" id="100">100</a>
<a href="#101" id="101">101</a>
<a href="#102" id="102">102</a>
<a href="#103" id="103">103</a>
<a href="#104" id="104">104</a>
<a href="#105" id="105">105</a>
<a href="#106" id="106">106</a>
<a href="#107" id="107">107</a>
<a href="#108" id="108">108</a>
<a href="#109" id="109">109</a>
<a href="#110" id="110">110</a>
<a href="#111" id="111">111</a>
<a href="#112" id="112">112</a>
<a href="#113" id="113">113</a>
<a href="#114" id="114">114</a>
<a href="#115" id="115">115</a>
<a href="#116" id="116">116</a>
<a href="#117" id="117">117</a>
<a href="#118" id="118">118</a>
<a href="#119" id="119">119</a>
<a href="#120" id="120">120</a>
<a href="#121" id="121">121</a>
<a href="#122" id="122">122</a>
<a href="#123" id="123">123</a>
<a href="#124" id="124">124</a>
<a href="#125" id="125">125</a>
<a href="#126" id="126">126</a>
<a href="#127" id="127">127</a>
<a href="#128" id="128">128</a>
<a href="#129" id="129">129</a>
<a href="#130" id="130">130</a>
<a href="#131" id="131">131</a>
<a href="#132" id="132">132</a>
<a href="#133" id="133">133</a>
<a href="#134" id="134">134</a>
<a href="#135" id="135">135</a>
<a href="#136" id="136">136</a>
<a href="#137" id="137">137</a></pre></div><pre class="rust"><code><span class="comment">// Copyright (C) 2017-2018 Red Hat, Inc.
//
// Permission is hereby granted, free of charge, to any
// person obtaining a copy of this software and associated
// documentation files (the "Software"), to deal in the
// Software without restriction, including without
// limitation the rights to use, copy, modify, merge,
// publish, distribute, sublicense, and/or sell copies of
// the Software, and to permit persons to whom the Software
// is furnished to do so, subject to the following
// conditions:
//
// The above copyright notice and this permission notice
// shall be included in all copies or substantial portions
// of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
// ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
// TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
// PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
// SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
// CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
// IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//
// Author: Gris Ge <fge@redhat.com>
</span><span class="kw">use </span>serde_json;
<span class="kw">use </span>serde_json::{Map, Number, Value};
<span class="kw">use </span>std::env;
<span class="kw">use </span>std::io::prelude::{Read, Write};
<span class="kw">use </span>std::os::unix::net::UnixStream;
<span class="kw">use </span>std::str;
<span class="kw">use </span><span class="kw">super</span>::error::<span class="kw-2">*</span>;
<span class="kw">const </span>IPC_HDR_LEN: usize = <span class="number">10</span>; <span class="comment">// length of u32 max string.
</span><span class="kw">const </span>IPC_JSON_ID: u8 = <span class="number">100</span>;
<span class="kw">const </span>IPC_BUFF_SIZE: usize = <span class="number">8192</span>;
<span class="kw">static </span>UDS_PATH_DEFAULT: <span class="kw-2">&</span>str = <span class="string">"/var/run/lsm/ipc"</span>;
<span class="kw">static </span>UDS_PATH_VAR_NAME: <span class="kw-2">&</span>str = <span class="string">"LSM_UDS_PATH"</span>;
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>TransPort {
so: UnixStream,
}
<span class="kw">impl </span>TransPort {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new(plugin_uds_path: <span class="kw-2">&</span>str) -> <span class="prelude-ty">Result</span><TransPort> {
<span class="kw">let </span>so = <span class="kw">match </span>UnixStream::connect(plugin_uds_path) {
<span class="prelude-val">Ok</span>(s) => s,
<span class="prelude-val">Err</span>(<span class="kw">_</span>) => {
<span class="kw">return </span><span class="prelude-val">Err</span>(
<span class="comment">// TODO(Gris Ge): need to tell DaemonNotRunning or
// PluginNotExist
</span>LsmError::DaemonNotRunning(<span class="macro">format!</span>(
<span class="string">"LibStorageMgmt daemon is not running for \
socket folder: '{}'"</span>,
plugin_uds_path
)),
);
}
};
<span class="prelude-val">Ok</span>(TransPort { so })
}
<span class="kw">fn </span>send(<span class="kw-2">&mut </span><span class="self">self</span>, msg: <span class="kw-2">&</span>str) -> <span class="prelude-ty">Result</span><()> {
<span class="kw">let </span>msg = <span class="macro">format!</span>(<span class="string">"{:0padding$}{}"</span>, msg.len(), msg, padding = IPC_HDR_LEN);
<span class="self">self</span>.so.write_all(msg.as_bytes())<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(())
}
<span class="kw">fn </span>recv(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Result</span><String> {
<span class="kw">let </span><span class="kw-2">mut </span>msg_buff = [<span class="number">0u8</span>; IPC_HDR_LEN];
<span class="self">self</span>.so.read_exact(<span class="kw-2">&mut </span>msg_buff)<span class="question-mark">?</span>;
<span class="kw">let </span>msg_len = str::from_utf8(<span class="kw-2">&</span>msg_buff)<span class="question-mark">?</span>.parse::<usize>()<span class="question-mark">?</span>;
<span class="kw">let </span><span class="kw-2">mut </span>msg = Vec::with_capacity(msg_len);
<span class="kw">let </span><span class="kw-2">mut </span>got: usize = <span class="number">0</span>;
<span class="kw">let </span><span class="kw-2">mut </span>msg_buff = [<span class="number">0u8</span>; IPC_BUFF_SIZE];
<span class="kw">while </span>got < msg_len {
<span class="kw">let </span>cur_got = <span class="self">self</span>.so.read(<span class="kw-2">&mut </span>msg_buff)<span class="question-mark">?</span>;
msg.extend_from_slice(<span class="kw-2">&</span>msg_buff[<span class="number">0</span>..cur_got]);
got += cur_got;
}
<span class="kw">let </span>msg = String::from_utf8(msg)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(msg)
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>invoke(<span class="kw-2">&mut </span><span class="self">self</span>, cmd: <span class="kw-2">&</span>str, args: <span class="prelude-ty">Option</span><Map<String, Value>>) -> <span class="prelude-ty">Result</span><Value> {
<span class="kw">let </span><span class="kw-2">mut </span>msg = Map::new();
msg.insert(<span class="string">"method"</span>.to_string(), Value::String(cmd.to_string()));
msg.insert(<span class="string">"id"</span>.to_string(), Value::Number(Number::from(IPC_JSON_ID)));
<span class="kw">let </span><span class="kw-2">mut </span>args = args.unwrap_or_default();
args.insert(<span class="string">"flags"</span>.to_string(), Value::Number(Number::from(<span class="number">0u8</span>)));
msg.insert(<span class="string">"params"</span>.to_string(), Value::Object(args));
<span class="kw">let </span>msg = <span class="kw-2">&</span>serde_json::to_string(<span class="kw-2">&</span>msg)<span class="question-mark">?</span>;
<span class="self">self</span>.send(msg)<span class="question-mark">?</span>;
<span class="kw">let </span>val: Value = serde_json::from_str(<span class="kw-2">&</span><span class="self">self</span>.recv()<span class="question-mark">?</span>)<span class="question-mark">?</span>;
<span class="kw">let </span>obj = <span class="kw">match </span>val.as_object() {
<span class="prelude-val">Some</span>(o) => o,
<span class="prelude-val">None </span>=> {
<span class="kw">return </span><span class="prelude-val">Err</span>(LsmError::PluginBug(<span class="macro">format!</span>(
<span class="string">"Invalid reply from socket: {}"</span>,
msg
)))
}
};
<span class="kw">if let </span><span class="prelude-val">Some</span>(e) = obj.get(<span class="string">"error"</span>) {
<span class="kw">let </span>lsm_err_ipc: LsmErrorIpc = serde_json::from_value(e.clone())<span class="question-mark">?</span>;
<span class="kw">return </span><span class="prelude-val">Err</span>(From::from(lsm_err_ipc));
};
<span class="kw">let </span>result = <span class="kw">match </span>obj.get(<span class="string">"result"</span>) {
<span class="prelude-val">Some</span>(r) => r,
<span class="prelude-val">None </span>=> {
<span class="kw">return </span><span class="prelude-val">Err</span>(LsmError::PluginBug(<span class="macro">format!</span>(
<span class="string">"Got no result from socket: {}"</span>,
msg
)))
}
};
<span class="prelude-val">Ok</span>(result.clone())
}
}
<span class="kw">impl </span>Drop <span class="kw">for </span>TransPort {
<span class="kw">fn </span>drop(<span class="kw-2">&mut </span><span class="self">self</span>) {
<span class="kw">if </span><span class="self">self</span>.invoke(<span class="string">"plugin_unregister"</span>, <span class="prelude-val">None</span>).is_ok() {}
}
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>uds_path() -> String {
<span class="kw">match </span>env::var(UDS_PATH_VAR_NAME) {
<span class="prelude-val">Ok</span>(v) => v,
<span class="prelude-val">Err</span>(<span class="kw">_</span>) => UDS_PATH_DEFAULT.to_string(),
}
}
</code></pre></div></section></main></body></html>