blob: 7b0bd4729daeb6a02d5d84c4fa9e0f0df6a7cb9e [file] [log] [blame]
* Copyright (C) 2017 The Android Open Source Project
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* See the License for the specific language governing permissions and
* limitations under the License.
#include <cassert>
#include <limits>
#include <ostream>
#include <android-base/result.h>
namespace android {
namespace netdutils {
// Simple status implementation suitable for use on the stack in low
// or moderate performance code. This can definitely be improved but
// for now short string optimization is expected to keep the common
// success case fast.
// Status is implicitly movable via the default noexcept move constructor
// and noexcept move-assignment operator.
class [[nodiscard]] Status {
Status() = default;
explicit Status(int code) : mCode(code) {}
// Constructs an error Status, |code| must be non-zero.
Status(int code, std::string msg) : mCode(code), mMsg(std::move(msg)) { assert(!ok()); }
Status(android::base::Result<void> result)
: mCode(result.ok() ? 0 : static_cast<int>(result.error().code())),
mMsg(result.ok() ? "" : result.error().message()) {}
int code() const { return mCode; }
bool ok() const { return code() == 0; }
const std::string& msg() const { return mMsg; }
// Explicitly ignores the Status without triggering [[nodiscard]] errors.
void ignoreError() const {}
bool operator==(const Status& other) const { return code() == other.code(); }
bool operator!=(const Status& other) const { return !(*this == other); }
int mCode = 0;
std::string mMsg;
namespace status {
const Status ok{0};
// EOF is not part of errno space, we'll place it far above the
// highest existing value.
const Status eof{0x10001, "end of file"};
const Status undefined{std::numeric_limits<int>::max(), "undefined"};
} // namespace status
// Return true if status is "OK". This is sometimes preferable to
// status.ok() when we want to check the state of Status-like objects
// that implicitly cast to Status.
inline bool isOk(const Status& status) {
return status.ok();
// For use only in tests. Used for both Status and Status-like objects. See also isOk().
#define EXPECT_OK(status) EXPECT_TRUE(isOk(status))
#define ASSERT_OK(status) ASSERT_TRUE(isOk(status))
// Documents that status is expected to be ok. This function may log
// (or assert when running in debug mode) if status has an unexpected value.
inline void expectOk(const Status& /*status*/) {
// TODO: put something here, for now this function serves solely as documentation.
// Convert POSIX errno to a Status object.
// If Status is extended to have more features, this mapping may
// become more complex.
Status statusFromErrno(int err, const std::string& msg);
// Helper that checks Status-like object (notably StatusOr) against a
// value in the errno space.
bool equalToErrno(const Status& status, int err);
// Helper that converts Status-like object (notably StatusOr) to a
// message.
std::string toString(const Status& status);
std::ostream& operator<<(std::ostream& os, const Status& s);
// Evaluate 'stmt' to a Status object and if it results in an error, return that
// error. Use 'tmp' as a variable name to avoid shadowing any variables named
// tmp.
#define RETURN_IF_NOT_OK_IMPL(tmp, stmt) \
do { \
::android::netdutils::Status tmp = (stmt); \
if (!isOk(tmp)) { \
return tmp; \
} \
} while (false)
// Create a unique variable name to avoid shadowing local variables.
#define RETURN_IF_NOT_OK_CONCAT(line, stmt) RETURN_IF_NOT_OK_IMPL(__CONCAT(_status_, line), stmt)
// Macro to allow exception-like handling of error return values.
// If the evaluation of stmt results in an error, return that error
// from current function.
// Example usage:
// Status bar() { ... }
// RETURN_IF_NOT_OK(status);
// RETURN_IF_NOT_OK(bar());
} // namespace netdutils
} // namespace android
#endif /* NETUTILS_STATUS_H */