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
|
/*
* Copyright (c) 2014, 2016 Nicira, Inc.
*
* 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 RAFT_H
#define RAFT_H 1
#include <stddef.h>
/* Implementation of the Raft consensus algorithm.
*
*
* References
* ==========
*
* Based on Diego Ongaro's Ph.D. thesis, "Consensus: Bridging Theory and
* Practice", available at https://ramcloud.stanford.edu/~ongaro/thesis.pdf.
* References to sections, pages, and figures are from this thesis. Quotations
* in comments also come from this work, in accordance with its license notice,
* reproduced below:
*
* Copyright 2014 by Diego Andres Ongaro. All Rights Reserved.
*
* This work is licensed under a Creative Commons Attribution-3.0 United
* States License. http://creativecommons.org/licenses/by/3.0/us/
*
*
*/
#include <stdbool.h>
#include <stdint.h>
#include "compiler.h"
struct raft;
struct uuid;
/* Default TCP port number for OVSDB RAFT. */
#define RAFT_PORT 6641
struct ovsdb_error *raft_create(const char *file_name,
const char *local_address,
const char *data)
OVS_WARN_UNUSED_RESULT;
struct ovsdb_error *raft_open(const char *file_name, struct raft **)
OVS_WARN_UNUSED_RESULT;
struct ovsdb_error *raft_join(const char *file_name, const char *local_address,
char *remote_addresses[], size_t n_remotes,
const struct uuid *cid, struct raft **)
OVS_WARN_UNUSED_RESULT;
void raft_take_leadership(struct raft *);
void raft_close(struct raft *);
void raft_run(struct raft *);
void raft_wait(struct raft *);
enum raft_command_status {
RAFT_CMD_INCOMPLETE, /* In progress, please wait. */
RAFT_CMD_SUCCESS, /* Committed. */
RAFT_CMD_NOT_LEADER, /* Failed because we are not the leader. */
RAFT_CMD_LOST_LEADERSHIP, /* Leadership lost after command initiation. */
RAFT_CMD_SHUTDOWN, /* Raft server shut down. */
};
const char *raft_command_status_to_string(enum raft_command_status);
struct raft_command *raft_command_execute(struct raft *, const char *data)
OVS_WARN_UNUSED_RESULT;
enum raft_command_status raft_command_get_status(const struct raft_command *);
void raft_command_unref(struct raft_command *);
void raft_command_wait(const struct raft_command *);
#endif /* lib/raft.h */
|
