/**
* Copyright (C) 2014 MongoDB Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see .
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the GNU Affero General Public License in all respects for
* all of the code used other than as permitted herein. If you modify file(s)
* with this exception, you may extend this exception to your version of the
* file(s), but you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version. If you delete this
* exception statement from all source files in the program, then also delete
* it in the license file.
*/
#pragma once
#include
#include
#include
#include
#include "mongo/base/status.h"
#include "mongo/base/string_data.h"
#include "mongo/platform/cstdint.h"
namespace mongo {
class BSONObjBuilder;
namespace repl {
/**
* Representation of a tag on a replica set node.
*
* Tags are only meaningful when used with a copy of the ReplicaSetTagConfig that
* created them.
*/
class ReplicaSetTag {
public:
/**
* Default constructor, produces an uninitialized tag.
*/
ReplicaSetTag() {}
/**
* Constructs a tag with the given key and value indexes.
* Do not call directly; used by ReplicaSetTagConfig.
*/
ReplicaSetTag(int32_t keyIndex, int32_t valueIndex) :
_keyIndex(keyIndex),
_valueIndex(valueIndex) {}
/**
* Returns true if the tag is not explicitly invalid.
*/
bool isValid() const { return _keyIndex >= 0; }
/**
* Gets the key index of the tag.
*/
int32_t getKeyIndex() const { return _keyIndex; }
/**
* Gets the value index of the tag.
*/
int32_t getValueIndex() const { return _valueIndex; }
/**
* Compares two tags from the *same* ReplicaSetTagConfig for equality.
*/
bool operator==(const ReplicaSetTag& other) const;
/**
* Compares two tags from the *same* ReplicaSetTagConfig for inequality.
*/
bool operator!=(const ReplicaSetTag& other) const;
private:
// The index of the key in the associated ReplicaSetTagConfig.
int32_t _keyIndex;
// The index of the value in the entry for the key in the associated ReplicaSetTagConfig.
int32_t _valueIndex;
};
/**
* Representation of a tag matching pattern, like { "dc": 2, "rack": 3 }, of the form
* used for tagged replica set writes.
*/
class ReplicaSetTagPattern {
public:
/**
* Representation of a single tag's minimum count constraint in a pattern.
*/
class TagCountConstraint {
public:
TagCountConstraint() {}
TagCountConstraint(int32_t keyIndex, int32_t minCount);
int32_t getKeyIndex() const { return _keyIndex; }
int32_t getMinCount() const { return _minCount; }
private:
int32_t _keyIndex;
int32_t _minCount;
};
typedef std::vector::const_iterator ConstraintIterator;
/**
* Adds a count constraint for the given key index with the given count.
*
* Do not call directly, but use the addTagCountConstraintToPattern method
* of ReplicaSetTagConfig.
*/
void addTagCountConstraint(int32_t keyIndex, int32_t minCount);
/**
* Gets the begin iterator over the constraints in this pattern.
*/
ConstraintIterator constraintsBegin() const { return _constraints.begin(); }
/**
* Gets the end iterator over the constraints in this pattern.
*/
ConstraintIterator constraintsEnd() const { return _constraints.end(); }
private:
std::vector _constraints;
};
/**
* State object for progressive detection of ReplicaSetTagPattern constraint satisfaction.
*
* This is an abstraction of the replica set write tag satisfaction problem.
*
* Replica set tag matching is an event-driven constraint satisfaction process. This type
* represents the state of that process. It is initialized from a pattern object, then
* progressively updated with tags. After processing a sequence of tags sufficient to satisfy
* the pattern, isSatisfied() becomes true.
*/
class ReplicaSetTagMatch {
friend class ReplicaSetTagConfig;
public:
/**
* Constructs an empty match object, equivalent to one that matches an
* empty pattern.
*/
ReplicaSetTagMatch() {}
/**
* Constructs a clean match object for the given pattern.
*/
explicit ReplicaSetTagMatch(const ReplicaSetTagPattern& pattern);
/**
* Updates the match state based on the data for the given tag.
*
* Returns true if, after this update, isSatisfied() is true.
*/
bool update(const ReplicaSetTag& tag);
/**
* Returns true if the match has received a sequence of tags sufficient to satisfy the
* pattern.
*/
bool isSatisfied() const;
private:
/**
* Representation of the state related to a single tag key in the match pattern.
* Consists of a constraint (key index and min count for satisfaction) and a list
* of already observed values.
*
* A BoundTagValue is satisfied when the size of boundValues is at least
* constraint.getMinCount().
*/
struct BoundTagValue {
BoundTagValue() {}
explicit BoundTagValue(const ReplicaSetTagPattern::TagCountConstraint& aConstraint) :
constraint(aConstraint) {}
int32_t getKeyIndex() const { return constraint.getKeyIndex(); }
bool isSatisfied() const;
ReplicaSetTagPattern::TagCountConstraint constraint;
std::vector boundValues;
};
std::vector _boundTagValues;
};
/**
* Representation of the tag configuration information for a replica set.
*
* This type, like all in this file, is copyable. Tags and patterns from one instance of this
* class are compatible with other instances of this class that are *copies* of the original
* instance.
*/
class ReplicaSetTagConfig {
public:
/**
* Finds or allocates a tag with the given "key" and "value" strings.
*/
ReplicaSetTag makeTag(const StringData& key, const StringData& value);
/**
* Finds a tag with the given key and value strings, or returns a tag whose isValid() method
* returns false if the configuration has never allocated such a tag via makeTag().
*/
ReplicaSetTag findTag(const StringData& key, const StringData& value) const;
/**
* Makes a new, empty pattern object.
*/
ReplicaSetTagPattern makePattern() const;
/**
* Adds a constraint clause to the given "pattern". This particular
* constraint requires that at least "minCount" distinct tags with the given "tagKey"
* be observed. Two tags "t1" and "t2" are distinct if "t1 != t2", so this constraint
* means that we must see at least "minCount" tags with the specified "tagKey".
*/
Status addTagCountConstraintToPattern(ReplicaSetTagPattern* pattern,
const StringData& tagKey,
int32_t minCount) const;
/**
* Gets the string key for the given "tag".
*
* Behavior is undefined if "tag" is not valid or was not from this
* config or one of its copies.
*/
std::string getTagKey(const ReplicaSetTag& tag) const;
/**
* Gets the string value for the given "tag".
*
* Like getTagKey, above, behavior is undefined if "tag" is not valid or was not from this
* config or one of its copies.
*/
std::string getTagValue(const ReplicaSetTag& tag) const;
/**
* Helper that writes a string debugging representation of "tag" to "os".
*/
void put(const ReplicaSetTag& tag, std::ostream& os) const;
/**
* Helper that writes a string debugging representation of "pattern" to "os".
*/
void put(const ReplicaSetTagPattern& pattern, std::ostream& os) const;
/**
* Helper that writes a string debugging representation of "matcher" to "os".
*/
void put(const ReplicaSetTagMatch& matcher, std::ostream& os) const;
private:
typedef std::vector ValueVector;
typedef std::vector > KeyValueVector;
/**
* Returns the index corresponding to "key", or _tagData.size() if there is no
* such index.
*/
int32_t _findKeyIndex(const StringData& key) const;
/**
* Helper that writes a "tagKey" field for the given "keyIndex" to "builder".
*/
void _appendTagKey(int32_t keyIndex, BSONObjBuilder* builder) const;
/**
* Helper that writes a "tagValue" field for the given "keyIndex" and "valueIndex"
* to "builder".
*/
void _appendTagValue(int32_t keyIndex, int32_t valueIndex, BSONObjBuilder* builder) const;
/**
* Helper that writes a constraint object to "builder".
*/
void _appendConstraint(const ReplicaSetTagPattern::TagCountConstraint& constraint,
BSONObjBuilder* builder) const;
// Data about known tags. Conceptually, it maps between keys and their indexes,
// keys and their associated values, and (key, value) pairs and the values' indexes.
KeyValueVector _tagData;
};
} // namespace repl
} // namespace mongo