common_memory_manager/
error.rs

1// Copyright 2023 Greptime Team
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15use std::any::Any;
16use std::time::Duration;
17
18use common_error::ext::ErrorExt;
19use common_error::status_code::StatusCode;
20use common_macro::stack_trace_debug;
21use snafu::Snafu;
22
23pub type Result<T> = std::result::Result<T, Error>;
24
25#[derive(Snafu)]
26#[snafu(visibility(pub))]
27#[stack_trace_debug]
28pub enum Error {
29    #[snafu(display(
30        "Memory limit exceeded: requested {requested_bytes} bytes, limit {limit_bytes} bytes"
31    ))]
32    MemoryLimitExceeded {
33        requested_bytes: u64,
34        limit_bytes: u64,
35    },
36
37    #[snafu(display("Memory semaphore unexpectedly closed"))]
38    MemorySemaphoreClosed,
39
40    #[snafu(display(
41        "Timeout waiting for memory quota: requested {requested_bytes} bytes, waited {waited:?}"
42    ))]
43    MemoryAcquireTimeout {
44        requested_bytes: u64,
45        waited: Duration,
46    },
47}
48
49impl ErrorExt for Error {
50    fn status_code(&self) -> StatusCode {
51        use Error::*;
52
53        match self {
54            MemoryLimitExceeded { .. } => StatusCode::RuntimeResourcesExhausted,
55            MemorySemaphoreClosed => StatusCode::Unexpected,
56            MemoryAcquireTimeout { .. } => StatusCode::RuntimeResourcesExhausted,
57        }
58    }
59
60    fn as_any(&self) -> &dyn Any {
61        self
62    }
63}
common_memory_manager/error.rs

common_memory_manager/
error.rs
