]>
Commit | Line | Data |
---|---|---|
9a1955a7 JF |
1 | /* |
2 | * Copyright (c) 2015-2017 Red Hat, Inc. | |
3 | * | |
4 | * All rights reserved. | |
5 | * | |
6 | * Author: Jan Friesse (jfriesse@redhat.com) | |
7 | * | |
8 | * This software licensed under BSD license, the text of which follows: | |
9 | * | |
10 | * Redistribution and use in source and binary forms, with or without | |
11 | * modification, are permitted provided that the following conditions are met: | |
12 | * | |
13 | * - Redistributions of source code must retain the above copyright notice, | |
14 | * this list of conditions and the following disclaimer. | |
15 | * - Redistributions in binary form must reproduce the above copyright notice, | |
16 | * this list of conditions and the following disclaimer in the documentation | |
17 | * and/or other materials provided with the distribution. | |
18 | * - Neither the name of the Red Hat, Inc. nor the names of its | |
19 | * contributors may be used to endorse or promote products derived from this | |
20 | * software without specific prior written permission. | |
21 | * | |
22 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | |
23 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
24 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
25 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE | |
26 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | |
27 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | |
28 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | |
29 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | |
30 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | |
31 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF | |
32 | * THE POSSIBILITY OF SUCH DAMAGE. | |
33 | */ | |
34 | ||
35 | #include <sys/types.h> | |
36 | ||
37 | #include <string.h> | |
38 | ||
39 | #include "qnetd-algo-test.h" | |
40 | #include "qnetd-log.h" | |
41 | #include "qnetd-cluster-list.h" | |
42 | #include "qnetd-client-send.h" | |
43 | #include "qnetd-log-debug.h" | |
44 | #include "qnetd-client-algo-timer.h" | |
45 | #include "utils.h" | |
46 | ||
47 | /* | |
48 | * Called right after client sent init message. This happens after initial accept of client, | |
49 | * tls handshake and sending basic information about cluster/client. | |
50 | * Known information: | |
51 | * - client->cluster_name (client->cluster_name_len) | |
52 | * - client->node_id (client->node_id_set = 1) | |
53 | * - client->decision_algorithm | |
54 | * - client->cluster | |
55 | * - client->last_ring_id | |
56 | * | |
57 | * Callback is designed mainly for allocating client->algorithm_data. It's also already | |
58 | * part of the cluster, so can access (alloc) client->cluster->algorithm_data. | |
59 | * | |
60 | * client is initialized qnetd_client structure. | |
61 | * | |
62 | * Return TLV_REPLY_ERROR_CODE_NO_ERROR on success, different TLV_REPLY_ERROR_CODE_* | |
63 | * on failure (error is sent back to client) | |
64 | */ | |
65 | enum tlv_reply_error_code | |
66 | qnetd_algo_test_client_init(struct qnetd_client *client) | |
67 | { | |
68 | int *algo_data; | |
69 | ||
70 | qnetd_log(LOG_WARNING, "algo-test: Client %s (cluster = '%s', node_id = " | |
71 | UTILS_PRI_NODE_ID") initiated test algorithm. It's not recommended to use test " | |
72 | "algorithm because it can create multiple quorate partitions!", client->addr_str, | |
73 | client->cluster_name, client->node_id); | |
74 | ||
75 | qnetd_log(LOG_INFO, "algo-test: client_init"); | |
76 | ||
77 | client->algorithm_data = malloc(sizeof(int)); | |
78 | if (client->algorithm_data == NULL) { | |
79 | return (TLV_REPLY_ERROR_CODE_INTERNAL_ERROR); | |
80 | } | |
81 | ||
82 | algo_data = client->algorithm_data; | |
83 | *algo_data = 42; | |
84 | ||
85 | if (qnetd_cluster_size(client->cluster) == 1) { | |
86 | /* | |
87 | * First client in the cluster | |
88 | */ | |
89 | qnetd_log(LOG_INFO, "algo-test: Initializing cluster->algorithm data"); | |
90 | ||
91 | client->cluster->algorithm_data = malloc(sizeof(int)); | |
92 | if (client->cluster->algorithm_data == NULL) { | |
93 | return (TLV_REPLY_ERROR_CODE_INTERNAL_ERROR); | |
94 | } | |
95 | ||
96 | algo_data = client->cluster->algorithm_data; | |
97 | *algo_data = 42; | |
98 | } | |
99 | ||
100 | return (TLV_REPLY_ERROR_CODE_NO_ERROR); | |
101 | } | |
102 | ||
103 | ||
104 | /* | |
105 | * Called after client sent configuration node list | |
106 | * All client fields are already set. Nodes is actual node list, initial is used | |
107 | * for distrinquish between initial node list and changed node list. | |
108 | * msg_seq_num is 32-bit number set by client. If client sent config file version, | |
109 | * config_version_set is set to 1 and config_version contains valid config file version. | |
110 | * | |
111 | * Function has to return result_vote. This can be one of ack/nack, ask_later (client | |
112 | * should ask later for a vote) or wait_for_reply (client should wait for reply). | |
113 | * | |
114 | * Return TLV_REPLY_ERROR_CODE_NO_ERROR on success, different TLV_REPLY_ERROR_CODE_* | |
115 | * on failure (error is send back to client) | |
116 | */ | |
117 | enum tlv_reply_error_code | |
118 | qnetd_algo_test_config_node_list_received(struct qnetd_client *client, | |
119 | uint32_t msg_seq_num, int config_version_set, uint64_t config_version, | |
120 | const struct node_list *nodes, int initial, enum tlv_vote *result_vote) | |
121 | { | |
122 | ||
123 | qnetd_log(LOG_INFO, "algo-test: node_list_received"); | |
124 | ||
125 | *result_vote = TLV_VOTE_NO_CHANGE; | |
126 | ||
127 | return (TLV_REPLY_ERROR_CODE_NO_ERROR); | |
128 | } | |
129 | ||
130 | /* | |
131 | * Called after client sent membership node list. | |
132 | * All client fields are already set. Nodes is actual node list. | |
133 | * msg_seq_num is 32-bit number set by client. | |
134 | * ring_id is copied from client votequorum callback. | |
135 | * heuristics is result of client heuristics (or TLV_HEURISTICS_UNDEFINED if heuristics | |
136 | * are disabled or not supported by client) | |
137 | * | |
138 | * Function has to return result_vote. This can be one of ack/nack, ask_later (client | |
139 | * should ask later for a vote) or wait_for_reply (client should wait for reply). | |
140 | * | |
141 | * Return TLV_REPLY_ERROR_CODE_NO_ERROR on success, different TLV_REPLY_ERROR_CODE_* | |
142 | * on failure (error is sent back to client) | |
143 | */ | |
144 | ||
145 | enum tlv_reply_error_code | |
146 | qnetd_algo_test_membership_node_list_received(struct qnetd_client *client, | |
147 | uint32_t msg_seq_num, const struct tlv_ring_id *ring_id, | |
148 | const struct node_list *nodes, enum tlv_heuristics heuristics, enum tlv_vote *result_vote) | |
149 | { | |
150 | ||
151 | qnetd_log(LOG_INFO, "algo-test: membership_node_list_received"); | |
152 | ||
153 | *result_vote = TLV_VOTE_ACK; | |
154 | ||
155 | return (TLV_REPLY_ERROR_CODE_NO_ERROR); | |
156 | } | |
157 | ||
158 | /* | |
159 | * Called after client sent quorum node list. | |
160 | * All client fields are already set. Nodes is actual node list. | |
161 | * msg_seq_num is 32-bit number set by client. | |
162 | * quorate is copied from client votequorum callback. | |
163 | * Function is just informative. If client vote is required to change, it's possible | |
164 | * to use qnetd_client_send_vote_info. | |
165 | * | |
166 | * Return TLV_REPLY_ERROR_CODE_NO_ERROR on success, different TLV_REPLY_ERROR_CODE_* | |
167 | * on failure (error is sent back to client) | |
168 | */ | |
169 | enum tlv_reply_error_code | |
170 | qnetd_algo_test_quorum_node_list_received(struct qnetd_client *client, | |
171 | uint32_t msg_seq_num, enum tlv_quorate quorate, const struct node_list *nodes, | |
172 | enum tlv_vote *result_vote) | |
173 | { | |
174 | ||
175 | qnetd_log(LOG_INFO, "algo-test: quorum_node_list_received"); | |
176 | ||
177 | *result_vote = TLV_VOTE_NO_CHANGE; | |
178 | ||
179 | return (TLV_REPLY_ERROR_CODE_NO_ERROR); | |
180 | } | |
181 | ||
182 | /* | |
183 | * Called after client disconnect. Client structure is still existing (and it's part | |
184 | * of a client->cluster), but it is destroyed (and removed from cluster) right after | |
185 | * this callback finishes. Callback is used mainly for destroing client->algorithm_data. | |
186 | */ | |
187 | void | |
188 | qnetd_algo_test_client_disconnect(struct qnetd_client *client, int server_going_down) | |
189 | { | |
190 | ||
191 | qnetd_log(LOG_INFO, "algo-test: client_disconnect"); | |
192 | ||
193 | free(client->algorithm_data); | |
194 | ||
195 | if (qnetd_cluster_size(client->cluster) == 1) { | |
196 | /* | |
197 | * Last client in the cluster | |
198 | */ | |
199 | qnetd_log(LOG_INFO, "algo-test: Finalizing cluster->algorithm data"); | |
200 | ||
201 | free(client->cluster->algorithm_data); | |
202 | } | |
203 | } | |
204 | ||
205 | /* | |
206 | * Called after client sent ask for vote message. This is usually happening after server | |
207 | * replied TLV_VOTE_ASK_LATER. | |
208 | */ | |
209 | enum tlv_reply_error_code | |
210 | qnetd_algo_test_ask_for_vote_received(struct qnetd_client *client, uint32_t msg_seq_num, | |
211 | enum tlv_vote *result_vote) | |
212 | { | |
213 | ||
214 | qnetd_log(LOG_INFO, "algo-test: ask_for_vote_received"); | |
215 | ||
216 | *result_vote = TLV_VOTE_ACK; | |
217 | ||
218 | return (TLV_REPLY_ERROR_CODE_NO_ERROR); | |
219 | } | |
220 | ||
221 | enum tlv_reply_error_code | |
222 | qnetd_algo_test_vote_info_reply_received(struct qnetd_client *client, uint32_t msg_seq_num) | |
223 | { | |
224 | ||
225 | qnetd_log(LOG_INFO, "algo-test: vote_info_reply_received"); | |
226 | ||
227 | return (TLV_REPLY_ERROR_CODE_NO_ERROR); | |
228 | } | |
229 | ||
230 | /* | |
231 | * Called after client sent heuristics change message. | |
232 | * heuristics is result of client regular heuristics (cannot be TLV_HEURISTICS_UNDEFINED) | |
233 | * Variables client->last_regular_heuristics and client->last_heuristics are updated after | |
234 | * the call. | |
235 | */ | |
236 | enum tlv_reply_error_code | |
237 | qnetd_algo_test_heuristics_change_received(struct qnetd_client *client, uint32_t msg_seq_num, | |
238 | enum tlv_heuristics heuristics, enum tlv_vote *result_vote) | |
239 | { | |
240 | ||
241 | qnetd_log(LOG_INFO, "algo-test: heuristics_change_received"); | |
242 | ||
243 | *result_vote = TLV_VOTE_NO_CHANGE; | |
244 | ||
245 | return (TLV_REPLY_ERROR_CODE_NO_ERROR); | |
246 | } | |
247 | ||
248 | /* | |
249 | * Called as a result of qnetd_client_algo_timer_schedule function call after timeout expires. | |
250 | * | |
251 | * If send_vote is set by callback to non zero value, result_vote must also be set and such vote is | |
252 | * sent to client. Result_vote is ignored if send_vote = 0 (default). | |
253 | * | |
254 | * If reschedule timer (default value = 0) is set to non zero value, callback is called again later | |
255 | * with same timeout as originaly created. | |
256 | * | |
257 | * Return TLV_REPLY_ERROR_CODE_NO_ERROR on success, different TLV_REPLY_ERROR_CODE_* | |
258 | * on failure (error is sent back to client) | |
259 | */ | |
260 | enum tlv_reply_error_code | |
261 | qnetd_algo_test_timer_callback(struct qnetd_client *client, int *reschedule_timer, | |
262 | int *send_vote, enum tlv_vote *result_vote) | |
263 | { | |
264 | ||
265 | return (TLV_REPLY_ERROR_CODE_NO_ERROR); | |
266 | } | |
267 | ||
268 | static struct qnetd_algorithm qnetd_algo_test = { | |
269 | .init = qnetd_algo_test_client_init, | |
270 | .config_node_list_received = qnetd_algo_test_config_node_list_received, | |
271 | .membership_node_list_received = qnetd_algo_test_membership_node_list_received, | |
272 | .quorum_node_list_received = qnetd_algo_test_quorum_node_list_received, | |
273 | .client_disconnect = qnetd_algo_test_client_disconnect, | |
274 | .ask_for_vote_received = qnetd_algo_test_ask_for_vote_received, | |
275 | .vote_info_reply_received = qnetd_algo_test_vote_info_reply_received, | |
276 | .heuristics_change_received = qnetd_algo_test_heuristics_change_received, | |
277 | .timer_callback = qnetd_algo_test_timer_callback, | |
278 | }; | |
279 | ||
280 | enum tlv_reply_error_code qnetd_algo_test_register() | |
281 | { | |
282 | ||
283 | return (qnetd_algorithm_register(TLV_DECISION_ALGORITHM_TYPE_TEST, &qnetd_algo_test)); | |
284 | } |