48 lines
2.1 KiB
C++
48 lines
2.1 KiB
C++
/*
|
|
* MutationTracking.h
|
|
*
|
|
* This source file is part of the FoundationDB open source project
|
|
*
|
|
* Copyright 2013-2022 Apple Inc. and the FoundationDB project authors
|
|
*
|
|
* 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
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#ifndef _FDBSERVER_MUTATIONTRACKING_H_
|
|
#define _FDBSERVER_MUTATIONTRACKING_H_
|
|
#pragma once
|
|
|
|
#include "fdbclient/FDBTypes.h"
|
|
#include "fdbclient/CommitTransaction.h"
|
|
|
|
#define MUTATION_TRACKING_ENABLED 0
|
|
// The keys to track are defined in the .cpp file to limit recompilation.
|
|
|
|
#define DEBUG_MUTATION(...) MUTATION_TRACKING_ENABLED&& debugMutation(__VA_ARGS__)
|
|
TraceEvent debugMutation(const char* context, Version version, MutationRef const& mutation, UID id = UID());
|
|
|
|
// debugKeyRange and debugTagsAndMessage only log the *first* occurrence of a key in their range/commit.
|
|
// TODO: Create a TraceEventGroup that forwards all calls to each element of a std::vector<TraceEvent>,
|
|
// to allow "multiple" TraceEvents to be returned.
|
|
|
|
#define DEBUG_KEY_RANGE(...) MUTATION_TRACKING_ENABLED&& debugKeyRange(__VA_ARGS__)
|
|
TraceEvent debugKeyRange(const char* context, Version version, KeyRangeRef const& keys, UID id = UID());
|
|
|
|
#define DEBUG_TAGS_AND_MESSAGE(...) MUTATION_TRACKING_ENABLED&& debugTagsAndMessage(__VA_ARGS__)
|
|
TraceEvent debugTagsAndMessage(const char* context, Version version, StringRef commitBlob, UID id = UID());
|
|
|
|
// TODO: Version Tracking. If the bug is in handling a version rather than a key, then it'd be good to be able to log
|
|
// each time that version is handled within simulation. A similar set of functions should be implemented.
|
|
|
|
#endif
|