foundationdb/fdbserver/RestoreUtil.h

/*
 * RestoreUtil.h
 *
 * This source file is part of the FoundationDB open source project
 *
 * Copyright 2013-2018 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.
 */

// This file defines the commonly used data structure and functions
// that are used by both RestoreWorker and RestoreRoles(Master, Loader, and Applier)

#ifndef FDBSERVER_RESTOREUTIL_H
#define FDBSERVER_RESTOREUTIL_H
#pragma once

#include "fdbclient/Tuple.h"
#include "flow/flow.h"
#include "flow/Stats.h"
#include "fdbrpc/fdbrpc.h"
#include "fdbrpc/IAsyncFile.h"
#include <cstdint>
#include <cstdarg>

enum class RestoreRole {Invalid = 0, Master = 1, Loader, Applier};
BINARY_SERIALIZABLE( RestoreRole );
std::string getRoleStr(RestoreRole role);
extern const std::vector<std::string> RestoreRoleStr;
extern int numRoles;

// Fast restore operation configuration
// The initRestoreWorkerConfig function will reset the configuration params in simulation
struct FastRestoreOpConfig {
	int num_loaders = 120;
	int num_appliers = 40;
	// transactionBatchSizeThreshold is used when applier applies multiple mutations in a transaction to DB 
	double transactionBatchSizeThreshold = 512; //512 in Bytes
};
extern FastRestoreOpConfig opConfig;

struct RestoreCommonReply {
	constexpr static FileIdentifier file_identifier = 56140435;
	UID id; // unique ID of the server who sends the reply
	
	RestoreCommonReply() = default;
	explicit RestoreCommonReply(UID id) : id(id) {}
	
	std::string toString() const {
		std::stringstream ss;
		ss << "ServerNodeID:" << id.toString();
		return ss.str();
	}

	template <class Ar>
	void serialize(Ar& ar) {
		serializer(ar, id);
	}
};

struct RestoreSimpleRequest : TimedRequest {
	constexpr static FileIdentifier file_identifier = 83557801;

	ReplyPromise<RestoreCommonReply> reply;

	RestoreSimpleRequest() = default;

	template <class Ar> 
	void serialize( Ar& ar ) {
		serializer(ar, reply);
	}

	std::string toString() const {
		std::stringstream ss;
		ss << "RestoreSimpleRequest";
		return ss.str();
	}
};

#endif //FDBSERVER_RESTOREUTIL_ACTOR_H