Remove deprecated ObjectLibrary::Register() (and Regex public API) (#9439)
Summary: Regexes are considered potentially problematic for use in registering RocksDB extensions, so we are removing ObjectLibrary::Register() and the Regex public API it depended on (now unused). In reference to https://github.com/facebook/rocksdb/issues/9389 Why? * The power of Regexes can make it hard to reason about which extension will match what. (The replacement API isn't perfect, but we are at least "holding the line" on patterns we have seen in practice.) * It is easy to make regexes that don't quite mean what you think they mean, such as forgetting that the `.` in `foo.bar` can match any character or that matching is nondeterministic, as in `a🅱️42` matching `.*:[0-9]+`. * Some regexes and implementations can have disastrously bad performance. This might not be much practical concern for ObjectLibray here, but we don't want to encourage potentially dangerous further use in production code. (Testing code is fine. See TestRegex.) Pull Request resolved: https://github.com/facebook/rocksdb/pull/9439 Test Plan: CI Reviewed By: mrambacher Differential Revision: D33792342 Pulled By: pdillinger fbshipit-source-id: 4f64dcb04764e639162c8977a5fa196f67754cecmain
Peter Dillinger
2 years ago
committed by
Facebook GitHub Bot
parent
c27ca23644
commit
449029f865
@ -1,48 +0,0 @@ |
||||
// Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
|
||||
// This source code is licensed under both the GPLv2 (found in the
|
||||
// COPYING file in the root directory) and Apache 2.0 License
|
||||
// (found in the LICENSE.Apache file in the root directory).
|
||||
|
||||
#pragma once |
||||
|
||||
#ifndef ROCKSDB_LITE |
||||
|
||||
#include <memory> |
||||
#include <string> |
||||
|
||||
#include "rocksdb/status.h" |
||||
|
||||
namespace ROCKSDB_NAMESPACE { |
||||
|
||||
// A wrapper for parsed regular expressions. The regex syntax and matching is
|
||||
// compatible with std::regex.
|
||||
//
|
||||
// !!!!!! WARNING !!!!!!: The implementation currently uses std::regex, which
|
||||
// has terrible performance in some cases, including possible crash due to
|
||||
// stack overflow. See https://gcc.gnu.org/bugzilla/show_bug.cgi?id=61582
|
||||
// for example. Avoid use in production as much as possible.
|
||||
//
|
||||
// Internal note: see also TestRegex
|
||||
class Regex { |
||||
public: |
||||
// Note: Cannot be constructed with a pattern, so that syntax errors can
|
||||
// be handled without using exceptions.
|
||||
|
||||
// Parse returns OK and saves to `out` when the pattern is valid regex
|
||||
// syntax (modified ECMAScript), or else returns InvalidArgument.
|
||||
// See https://en.cppreference.com/w/cpp/regex/ecmascript
|
||||
static Status Parse(const char *pattern, Regex *out); |
||||
static Status Parse(const std::string &pattern, Regex *out); |
||||
|
||||
// Checks that the whole of str is matched by this regex. If called on a
|
||||
// default-constructed Regex, will trigger assertion failure in DEBUG build
|
||||
// or return false in release build.
|
||||
bool Matches(const std::string &str) const; |
||||
|
||||
private: |
||||
class Impl; |
||||
std::shared_ptr<Impl> impl_; // shared_ptr for simple implementation
|
||||
}; |
||||
} // namespace ROCKSDB_NAMESPACE
|
||||
|
||||
#endif // ROCKSDB_LITE
|
||||
@ -1,50 +0,0 @@ |
||||
// Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
|
||||
// This source code is licensed under both the GPLv2 (found in the
|
||||
// COPYING file in the root directory) and Apache 2.0 License
|
||||
// (found in the LICENSE.Apache file in the root directory).
|
||||
|
||||
// LITE not supported here in part because of exception handling
|
||||
#ifndef ROCKSDB_LITE |
||||
|
||||
#include "rocksdb/utilities/regex.h" |
||||
|
||||
#include <cassert> |
||||
#include <regex> |
||||
|
||||
namespace ROCKSDB_NAMESPACE { |
||||
|
||||
// This section would change for alternate underlying implementations other
|
||||
// than std::regex.
|
||||
#if 1 |
||||
class Regex::Impl : public std::regex { |
||||
public: |
||||
using std::regex::basic_regex; |
||||
}; |
||||
|
||||
bool Regex::Matches(const std::string &str) const { |
||||
if (impl_) { |
||||
return std::regex_match(str, *impl_); |
||||
} else { |
||||
// Should not call Matches on unset Regex
|
||||
assert(false); |
||||
return false; |
||||
} |
||||
} |
||||
|
||||
Status Regex::Parse(const std::string &pattern, Regex *out) { |
||||
try { |
||||
out->impl_.reset(new Impl(pattern)); |
||||
return Status::OK(); |
||||
} catch (const std::regex_error &e) { |
||||
return Status::InvalidArgument(e.what()); |
||||
} |
||||
} |
||||
#endif |
||||
|
||||
Status Regex::Parse(const char *pattern, Regex *out) { |
||||
return Parse(std::string(pattern), out); |
||||
} |
||||
|
||||
} // namespace ROCKSDB_NAMESPACE
|
||||
|
||||
#endif // ROCKSDB_LITE
|
||||
Loading…
Reference in new issue