foundationdb-simulation 0.2.3

Embed Rust code within FoundationDB's simulation
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109

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

#pragma once
#ifndef CPP_WORKLOAD_H
#define CPP_WORKLOAD_H
#include <string>
#include <vector>
#include <functional>
#include <memory>

#ifndef DLLEXPORT
#if defined(_MSC_VER)
#define DLLEXPORT __declspec(dllexport)
#elif defined(__GNUG__)
#define DLLEXPORT __attribute__((visibility("default")))
#else
#error Missing symbol export
#endif
#endif

typedef struct FDB_future FDBFuture;
typedef struct FDB_result FDBResult;
typedef struct FDB_database FDBDatabase;
typedef struct FDB_transaction FDBTransaction;

enum class FDBSeverity { Debug, Info, Warn, WarnAlways, Error };

class FDBLogger {
public:
	virtual void trace(FDBSeverity sev,
	                   const std::string& name,
	                   const std::vector<std::pair<std::string, std::string>>& details) = 0;
};

class FDBWorkloadContext : public FDBLogger {
public:
	virtual uint64_t getProcessID() const = 0;
	virtual void setProcessID(uint64_t processID) = 0;
	virtual double now() const = 0;
	virtual uint32_t rnd() const = 0;
	virtual bool getOption(const std::string& name, bool defaultValue) = 0;
	virtual long getOption(const std::string& name, long defaultValue) = 0;
	virtual unsigned long getOption(const std::string& name, unsigned long defaultValue) = 0;
	virtual double getOption(const std::string& name, double defaultValue) = 0;
	virtual std::string getOption(const std::string& name, std::string defaultValue) = 0;
	virtual int clientId() const = 0;
	virtual int clientCount() const = 0;
	virtual int64_t sharedRandomNumber() const = 0;
};

struct FDBPromise {
	virtual ~FDBPromise() = default;
	virtual void send(void*) = 0;
};

template <class T>
class GenericPromise {
	std::shared_ptr<FDBPromise> impl;

public:
	template <class Ptr>
	explicit GenericPromise(Ptr&& impl) : impl(std::forward<Ptr>(impl)) {}
	void send(T val) { impl->send(&val); }
};

struct FDBPerfMetric {
	std::string name;
	double value;
	bool averaged;
	std::string format_code = "%.3g";
};

class DLLEXPORT FDBWorkload {
public:
#if FDB_API_VERSION <= 730
	virtual std::string description() const = 0;
#endif
	virtual bool init(FDBWorkloadContext* context) = 0;
	virtual void setup(FDBDatabase* db, GenericPromise<bool> done) = 0;
	virtual void start(FDBDatabase* db, GenericPromise<bool> done) = 0;
	virtual void check(FDBDatabase* db, GenericPromise<bool> done) = 0;
	virtual void getMetrics(std::vector<FDBPerfMetric>& out) const = 0;
	virtual double getCheckTimeout() { return 3000; }
};

class DLLEXPORT FDBWorkloadFactory {
public:
	virtual std::shared_ptr<FDBWorkload> create(const std::string& name) = 0;
};

#endif