5 Author: Pekka Riikonen <priikone@silcnet.org>
7 Copyright (C) 2001 - 2007 Pekka Riikonen
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; version 2 of the License.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
21 #include "serverincludes.h"
22 #include "server_internal.h"
24 SILC_TASK_CALLBACK(silc_server_protocol_backup_done);
25 SILC_TASK_CALLBACK(silc_server_backup_announce_watches);
27 static void silc_server_backup_connect_primary(SilcServer server,
28 SilcServerEntry server_entry,
32 /************************** Types and Definitions ***************************/
36 SilcServerEntry server;
40 } SilcServerBackupEntry;
42 /* Holds IP address and port of the primary router that was replaced
47 SilcServerEntry server; /* Backup router that replaced the primary */
48 } SilcServerBackupReplaced;
51 struct SilcServerBackupStruct {
52 SilcServerBackupEntry *servers;
53 SilcUInt32 servers_count;
54 SilcServerBackupReplaced **replaced;
55 SilcUInt32 replaced_count;
61 SilcServerEntry server_entry;
62 } SilcServerBackupProtocolSession;
64 /* Backup resuming protocol context */
67 SilcPacketStream sock;
70 SilcServerBackupProtocolSession *sessions;
71 SilcUInt32 sessions_count;
72 SilcUInt32 initiator_restart;
75 unsigned int responder : 1;
76 unsigned int received_failure : 1;
77 unsigned int timeout : 1;
78 unsigned int error : 1;
79 } *SilcServerBackupProtocolContext;
82 /********************* Backup Configuration Routines ************************/
84 /* Adds the `backup_server' to be one of our backup router. This can be
85 called multiple times to set multiple backup routers. The `ip' and `port'
86 is the IP and port that the `backup_router' will replace if the `ip'
87 will become unresponsive. If `local' is TRUE then the `backup_server' is
88 in the local cell, if FALSE it is in some other cell. */
90 void silc_server_backup_add(SilcServer server, SilcServerEntry backup_server,
91 const char *ip, int port, SilcBool local)
98 if (!server->backup) {
99 server->backup = silc_calloc(1, sizeof(*server->backup));
104 /* See if already added */
105 for (i = 0; i < server->backup->servers_count; i++) {
106 if (server->backup->servers[i].server == backup_server)
110 SILC_LOG_DEBUG(("Backup router %s will replace %s",
111 backup_server->data.sconn->remote_host, ip, port));
113 for (i = 0; i < server->backup->servers_count; i++) {
114 if (!server->backup->servers[i].server) {
115 server->backup->servers[i].server = backup_server;
116 server->backup->servers[i].local = local;
117 server->backup->servers[i].port = SILC_SWAB_16(port);
118 memset(server->backup->servers[i].ip.data, 0,
119 sizeof(server->backup->servers[i].ip.data));
120 silc_net_addr2bin(ip, server->backup->servers[i].ip.data,
121 sizeof(server->backup->servers[i].ip.data));
126 i = server->backup->servers_count;
127 server->backup->servers = silc_realloc(server->backup->servers,
128 sizeof(*server->backup->servers) *
130 server->backup->servers[i].server = backup_server;
131 server->backup->servers[i].local = local;
132 server->backup->servers[i].port = SILC_SWAB_16(port);
133 memset(server->backup->servers[i].ip.data, 0,
134 sizeof(server->backup->servers[i].ip.data));
135 silc_net_addr2bin(ip, server->backup->servers[i].ip.data,
136 sizeof(server->backup->servers[i].ip.data));
137 server->backup->servers_count++;
140 /* Returns backup router for IP and port in `server_id' or NULL if there
141 does not exist backup router. */
143 SilcServerEntry silc_server_backup_get(SilcServer server,
144 SilcServerID *server_id)
151 for (i = 0; i < server->backup->servers_count; i++) {
152 if (server->backup->servers[i].server &&
153 server->backup->servers[i].port == server_id->port &&
154 !memcmp(server->backup->servers[i].ip.data, server_id->ip.data,
155 sizeof(server_id->ip.data))) {
156 SILC_LOG_DEBUG(("Found backup router %s for %s",
157 server->backup->servers[i].server->server_name,
158 silc_id_render(server_id, SILC_ID_SERVER)));
159 return server->backup->servers[i].server;
166 /* Deletes the backup server `server_entry'. */
168 void silc_server_backup_del(SilcServer server, SilcServerEntry server_entry)
175 for (i = 0; i < server->backup->servers_count; i++) {
176 if (server->backup->servers[i].server == server_entry) {
177 SILC_LOG_DEBUG(("Removing %s as backup router",
178 silc_id_render(server->backup->servers[i].server->id,
180 server->backup->servers[i].server = NULL;
181 memset(server->backup->servers[i].ip.data, 0,
182 sizeof(server->backup->servers[i].ip.data));
187 /* Frees all data allocated for backup routers. Call this after deleting
188 all backup routers and when new routers are added no more, for example
189 when shutting down the server. */
191 void silc_server_backup_free(SilcServer server)
198 /* Delete existing servers if caller didn't do it */
199 for (i = 0; i < server->backup->servers_count; i++) {
200 if (server->backup->servers[i].server)
201 silc_server_backup_del(server, server->backup->servers[i].server);
204 silc_free(server->backup->servers);
205 silc_free(server->backup);
206 server->backup = NULL;
209 /* Marks the IP address and port from the `server_id' as being replaced
210 by backup router indicated by the `server'. If the router connects at
211 a later time we can check whether it has been replaced by an backup
214 void silc_server_backup_replaced_add(SilcServer server,
215 SilcServerID *server_id,
216 SilcServerEntry server_entry)
219 SilcServerBackupReplaced *r = silc_calloc(1, sizeof(*r));;
222 server->backup = silc_calloc(1, sizeof(*server->backup));
223 if (!server->backup->replaced) {
224 server->backup->replaced =
225 silc_calloc(1, sizeof(*server->backup->replaced));
226 server->backup->replaced_count = 1;
229 SILC_LOG_DEBUG(("Replacing router %s with %s",
230 silc_id_render(server_id, SILC_ID_SERVER),
231 server_entry->server_name));
233 memcpy(&r->ip, &server_id->ip, sizeof(server_id->ip));
234 r->server = server_entry;
236 for (i = 0; i < server->backup->replaced_count; i++) {
237 if (!server->backup->replaced[i]) {
238 server->backup->replaced[i] = r;
243 i = server->backup->replaced_count;
244 server->backup->replaced = silc_realloc(server->backup->replaced,
245 sizeof(*server->backup->replaced) *
247 server->backup->replaced[i] = r;
248 server->backup->replaced_count++;
251 /* Checks whether the IP address and port from the `server_id' has been
252 replaced by an backup router. If it has been then this returns TRUE
253 and the bacup router entry to the `server' pointer if non-NULL. Returns
254 FALSE if the router is not replaced by backup router. */
256 SilcBool silc_server_backup_replaced_get(SilcServer server,
257 SilcServerID *server_id,
258 SilcServerEntry *server_entry)
262 if (!server->backup || !server->backup->replaced)
265 for (i = 0; i < server->backup->replaced_count; i++) {
266 if (!server->backup->replaced[i])
268 if (!memcmp(server->backup->replaced[i]->ip.data, server_id->ip.data,
269 sizeof(server_id->ip.data))) {
271 *server_entry = server->backup->replaced[i]->server;
272 SILC_LOG_DEBUG(("Router %s is replaced by %s",
273 silc_id_render(server_id, SILC_ID_SERVER),
274 server->backup->replaced[i]->server->server_name));
279 SILC_LOG_DEBUG(("Router %s is not replaced by backup router",
280 silc_id_render(server_id, SILC_ID_SERVER)));
284 /* Deletes a replaced host by the set `server_entry. */
286 void silc_server_backup_replaced_del(SilcServer server,
287 SilcServerEntry server_entry)
291 if (!server->backup || !server->backup->replaced)
294 for (i = 0; i < server->backup->replaced_count; i++) {
295 if (!server->backup->replaced[i])
297 if (server->backup->replaced[i]->server == server_entry) {
298 silc_free(server->backup->replaced[i]);
299 server->backup->replaced[i] = NULL;
304 /* Broadcast the received packet indicated by `packet' to all of our backup
305 routers. All router wide information is passed using broadcast packets.
306 That is why all backup routers need to get this data too. It is expected
307 that the caller already knows that the `packet' is broadcast packet. */
309 void silc_server_backup_broadcast(SilcServer server,
310 SilcPacketStream sender,
313 SilcServerEntry backup;
314 SilcPacketStream sock;
317 if (!server->backup || server->server_type != SILC_ROUTER)
320 SILC_LOG_DEBUG(("Broadcasting received packet to backup routers"));
322 for (i = 0; i < server->backup->servers_count; i++) {
323 backup = server->backup->servers[i].server;
325 if (!backup || backup->connection == sender ||
326 server->backup->servers[i].local == FALSE)
328 if (server->backup->servers[i].server == server->id_entry)
331 sock = backup->connection;
332 silc_server_packet_route(server, sock, packet);
336 /* A generic routine to send data to all backup routers. If the `sender'
337 is provided it will indicate the original sender of the packet and the
338 packet won't be resent to that entity. The `data' is the data that will
339 be assembled to packet context before sending. The packet will be
340 encrypted this function. If the `force_send' is TRUE the data is sent
341 immediately and not put to queue. If `local' is TRUE then the packet
342 will be sent only to local backup routers inside the cell. If false the
343 packet can go from one cell to the other. This function has no effect
344 if there are no any backup routers. */
346 void silc_server_backup_send(SilcServer server,
347 SilcServerEntry sender,
349 SilcPacketFlags flags,
355 SilcServerEntry backup;
356 SilcPacketStream sock;
359 if (!server->backup || server->server_type != SILC_ROUTER)
362 for (i = 0; i < server->backup->servers_count; i++) {
363 backup = server->backup->servers[i].server;
364 if (!backup || sender == backup)
366 if (local && server->backup->servers[i].local == FALSE)
368 if (server->backup->servers[i].server == server->id_entry)
371 sock = backup->connection;
373 silc_server_packet_send(server, backup->connection, type, flags,
378 /* Same as silc_server_backup_send but sets a specific Destination ID to
379 the packet. The Destination ID is indicated by the `dst_id' and the
380 ID type `dst_id_type'. For example, packets destined to channels must
381 be sent using this function. */
383 void silc_server_backup_send_dest(SilcServer server,
384 SilcServerEntry sender,
386 SilcPacketFlags flags,
388 SilcIdType dst_id_type,
394 SilcServerEntry backup;
395 SilcPacketStream sock;
398 if (!server->backup || server->server_type != SILC_ROUTER)
401 for (i = 0; i < server->backup->servers_count; i++) {
402 backup = server->backup->servers[i].server;
403 if (!backup || sender == backup)
405 if (local && server->backup->servers[i].local == FALSE)
407 if (server->backup->servers[i].server == server->id_entry)
410 sock = backup->connection;
412 silc_server_packet_send_dest(server, backup->connection, type, flags,
413 dst_id, dst_id_type, data, data_len);
417 /* Send the START_USE indication to remote connection. If `failure' is
418 TRUE then this sends SILC_PACKET_FAILURE. Otherwise it sends
419 SILC_PACKET_RESUME_ROUTER. */
421 void silc_server_backup_send_start_use(SilcServer server,
422 SilcPacketStream sock,
425 unsigned char data[4];
427 SILC_LOG_DEBUG(("Sending START_USE (%s)",
428 failure ? "failure" : "success"));
431 SILC_PUT32_MSB(SILC_SERVER_BACKUP_START_USE, data);
432 silc_server_packet_send(server, sock, SILC_PACKET_FAILURE, 0,
435 data[0] = SILC_SERVER_BACKUP_START_USE;
437 silc_server_packet_send(server, sock,
438 SILC_PACKET_RESUME_ROUTER, 0,
443 /* Send the REPLACED indication to remote router. This is send by the
444 primary router (remote router) of the primary router that came back
445 online. This is not sent by backup router or any other server. */
447 void silc_server_backup_send_replaced(SilcServer server,
448 SilcPacketStream sock)
450 unsigned char data[4];
452 SILC_LOG_DEBUG(("Sending REPLACED"));
454 data[0] = SILC_SERVER_BACKUP_REPLACED;
456 silc_server_packet_send(server, sock,
457 SILC_PACKET_RESUME_ROUTER, 0,
462 /************************ Backup Resuming Protocol **************************/
464 /* Timeout callback for protocol */
466 SILC_TASK_CALLBACK(silc_server_backup_timeout)
468 SilcServerBackupProtocolContext ctx = context;
469 SilcServer server = app_context;
471 SILC_LOG_INFO(("Timeout occurred during backup resuming protocol"));
474 silc_schedule_task_add_timeout(server->schedule,
475 silc_server_protocol_backup_done, context,
479 /* Callback to start the protocol as responder */
481 SILC_TASK_CALLBACK(silc_server_backup_responder_start)
483 SilcServerBackupProtocolContext proto_ctx = context;
484 SilcPacketStream sock = proto_ctx->sock;
485 SilcIDListData idata = silc_packet_get_context(sock);
486 SilcServer server = app_context;
488 /* If other protocol is executing at the same time, start with timeout. */
489 if (idata->sconn->op) {
490 SILC_LOG_DEBUG(("Other protocol is executing, wait for it to finish"));
491 silc_schedule_task_add_timeout(server->schedule,
492 silc_server_backup_responder_start,
497 /* Register protocol timeout */
498 silc_schedule_task_add_timeout(server->schedule,
499 silc_server_backup_timeout,
502 /* Run the backup resuming protocol */
503 silc_schedule_task_add_timeout(server->schedule,
504 silc_server_protocol_backup,
508 /* Callback to send START_USE to backup to check whether using backup
511 SILC_TASK_CALLBACK(silc_server_backup_check_status)
513 SilcPacketStream sock = context;
514 SilcServer server = app_context;
516 /* Check whether we are still using backup */
517 if (!server->backup_primary)
520 silc_server_backup_send_start_use(server, sock, FALSE);
521 silc_packet_stream_unref(sock);
526 SilcPacketStream sock;
528 } *SilcServerBackupPing;
530 /* PING command reply callback */
532 void silc_server_backup_ping_reply(void *context, void *reply)
534 SilcServerBackupPing pc = context;
535 SilcServerCommandReplyContext cmdr = reply;
537 if (cmdr && !silc_command_get_status(cmdr->payload, NULL, NULL)) {
538 /* Timeout error occurred, the primary is really down. */
539 SilcPacketStream primary = SILC_PRIMARY_ROUTE(pc->server);
541 SILC_LOG_DEBUG(("PING timeout, primary is down"));
544 silc_server_free_sock_user_data(pc->server, primary, NULL);
545 silc_server_close_connection(pc->server, primary);
548 /* Reprocess the RESUME_ROUTER packet */
549 silc_server_backup_resume_router(pc->server, pc->sock, pc->packet);
551 /* The primary is not down, refuse to serve the server as primary */
552 SILC_LOG_DEBUG(("PING received, primary is up"));
553 silc_server_backup_send_start_use(pc->server, pc->sock, TRUE);
556 silc_packet_stream_unref(pc->sock);
557 silc_packet_free(pc->packet);
561 /* Processes incoming RESUME_ROUTER packet. This can give the packet
562 for processing to the protocol handler or allocate new protocol if
563 start command is received. */
565 void silc_server_backup_resume_router(SilcServer server,
566 SilcPacketStream sock,
569 SilcIDListData idata = silc_packet_get_context(sock);
570 SilcServerEntry router = (SilcServerEntry)idata;
571 SilcUInt8 type, session;
572 SilcServerBackupProtocolContext ctx;
575 SILC_LOG_DEBUG(("Received RESUME_ROUTER packet"));
577 if (idata->conn_type == SILC_CONN_CLIENT ||
578 idata->conn_type == SILC_CONN_UNKNOWN) {
579 SILC_LOG_DEBUG(("Bad packet received"));
580 silc_packet_free(packet);
584 ret = silc_buffer_unformat(&packet->buffer,
585 SILC_STR_UI_CHAR(&type),
586 SILC_STR_UI_CHAR(&session),
589 SILC_LOG_ERROR(("Malformed resume router packet received"));
590 silc_packet_free(packet);
594 /* Check whether this packet is used to tell us that server will start
595 using us as primary router. */
596 if (type == SILC_SERVER_BACKUP_START_USE) {
598 SilcServerBackupPing pc;
600 /* If we are normal server then backup router has sent us back
601 this reply and we use the backup as primary router now. */
602 if (server->server_type == SILC_SERVER) {
603 /* Nothing to do here actually, since we have switched already. */
604 SILC_LOG_DEBUG(("Received successful START_USE from backup router"));
605 silc_packet_free(packet);
609 /* Backup router following. */
611 /* If we are marked as router then the primary is down and we send
612 success START_USE back to the server. */
613 if (server->server_type == SILC_ROUTER) {
614 SILC_LOG_DEBUG(("Sending success START_USE back"));
615 silc_server_backup_send_start_use(server, sock, FALSE);
616 silc_packet_free(packet);
620 /* We have just lost primary, send success START_USE back */
621 if (server->standalone) {
622 SILC_LOG_DEBUG(("We are stanalone, sending success START_USE back"));
623 silc_server_backup_send_start_use(server, sock, FALSE);
624 silc_packet_free(packet);
628 /* We are backup router. This server claims that our primary is down.
629 We will check this ourselves by sending PING command to the primary. */
630 SILC_LOG_DEBUG(("Sending PING to detect status of primary router"));
631 idp = silc_id_payload_encode(server->router->id, SILC_ID_SERVER);
632 silc_server_send_command(server, SILC_PRIMARY_ROUTE(server),
633 SILC_COMMAND_PING, ++server->cmd_ident, 1,
634 1, idp->data, silc_buffer_len(idp));
635 silc_buffer_free(idp);
637 /* Reprocess this packet after received reply from router */
638 pc = silc_calloc(1, sizeof(*pc));
642 silc_packet_stream_ref(sock);
643 silc_server_command_pending_timed(server, SILC_COMMAND_PING,
645 silc_server_backup_ping_reply, pc, 15);
649 /* Start the resuming protocol if requested. */
650 if (type == SILC_SERVER_BACKUP_START) {
651 /* We have received a start for resuming protocol. We are either
652 primary router that came back online or normal server. */
653 SilcServerBackupProtocolContext proto_ctx;
655 /* If backup had closed the connection earlier we won't allow resuming
656 since we (primary router) have never gone away. */
657 if (server->server_type == SILC_ROUTER && !server->backup_router &&
658 server->backup_closed) {
659 unsigned char data[4];
660 SILC_LOG_DEBUG(("Backup resuming not allowed since we are still "
662 SILC_LOG_INFO(("Backup resuming not allowed since we are still "
664 SILC_PUT32_MSB(SILC_SERVER_BACKUP_START, data);
665 silc_server_packet_send(server, sock, SILC_PACKET_FAILURE, 0,
667 server->backup_closed = FALSE;
668 silc_packet_free(packet);
672 proto_ctx = silc_calloc(1, sizeof(*proto_ctx));
673 proto_ctx->server = server;
674 proto_ctx->sock = sock;
675 proto_ctx->responder = TRUE;
676 proto_ctx->type = type;
677 proto_ctx->session = session;
678 proto_ctx->start = time(0);
679 silc_packet_stream_ref(sock);
680 router->backup = TRUE;
681 router->backup_proto = proto_ctx;
683 SILC_LOG_DEBUG(("Starting backup resuming protocol as responder"));
684 SILC_LOG_INFO(("Starting backup resuming protocol"));
686 /* Start protocol immediately */
687 silc_schedule_task_add_timeout(server->schedule,
688 silc_server_backup_responder_start,
693 /* If we are router and the packet is coming from our primary router
694 then it means we have been replaced by an backup router in our cell. */
695 if (type == SILC_SERVER_BACKUP_REPLACED &&
696 server->server_type == SILC_ROUTER &&
697 idata->conn_type == SILC_CONN_ROUTER &&
698 SILC_PRIMARY_ROUTE(server) == sock) {
699 /* We have been replaced by an backup router in our cell. We must
700 mark our primary router connection disabled since we are not allowed
701 to use it at this moment. */
702 SILC_LOG_INFO(("We are replaced by an backup router in this cell, will "
703 "wait until backup resuming protocol is executed"));
704 idata->status |= SILC_IDLIST_STATUS_DISABLED;
705 silc_packet_free(packet);
709 /* Activate the shared protocol context for this socket connection
711 if (type == SILC_SERVER_BACKUP_RESUMED &&
712 idata->conn_type == SILC_CONN_ROUTER && !router->backup &&
713 idata->status & SILC_IDLIST_STATUS_DISABLED) {
714 SilcServerEntry backup_router;
716 if (silc_server_backup_replaced_get(server, router->id, &backup_router)) {
717 ctx = backup_router->backup_proto;
719 silc_packet_stream_unref(ctx->sock);
720 router->backup = TRUE;
721 router->backup_proto = ctx;
723 silc_packet_stream_ref(sock);
727 /* Call the resuming protocol if the protocol is active. */
728 if (router->backup) {
729 ctx = router->backup_proto;
732 for (i = 0; i < ctx->sessions_count; i++) {
733 if (session == ctx->sessions[i].session) {
734 ctx->session = session;
735 silc_schedule_task_add_timeout(server->schedule,
736 silc_server_protocol_backup,
738 silc_packet_free(packet);
743 /* If RESUMED received the session ID is zero, execute the protocol. */
744 if (type == SILC_SERVER_BACKUP_RESUMED) {
745 silc_schedule_task_add_timeout(server->schedule,
746 silc_server_protocol_backup,
748 silc_packet_free(packet);
752 SILC_LOG_ERROR(("Unknown backup resuming session %d", session));
753 silc_packet_free(packet);
757 silc_packet_free(packet);
760 /* Task that is called after backup router has connected back to
761 primary router and we are starting the resuming protocol */
763 SILC_TASK_CALLBACK(silc_server_backup_connected_later)
765 SilcServerBackupProtocolContext proto_ctx =
766 (SilcServerBackupProtocolContext)context;
767 SilcServer server = proto_ctx->server;
769 SILC_LOG_DEBUG(("Starting backup resuming protocol as initiator"));
770 SILC_LOG_INFO(("Starting backup resuming protocol"));
772 /* Register protocol timeout */
773 silc_schedule_task_add_timeout(server->schedule,
774 silc_server_backup_timeout,
777 /* Run the backup resuming protocol */
778 silc_schedule_task_add_timeout(server->schedule,
779 silc_server_protocol_backup,
783 SILC_TASK_CALLBACK(silc_server_backup_connected_again)
785 SilcServer server = app_context;
786 SilcServerConfigRouter *primary;
788 primary = silc_server_config_get_primary_router(server);
790 if (!silc_server_find_socket_by_host(server, SILC_CONN_ROUTER,
791 primary->host, primary->port))
792 silc_server_create_connection(server, FALSE, FALSE,
793 primary->host, primary->port,
794 silc_server_backup_connected,
799 /* Called when we've established connection back to our primary router
800 when we've acting as backup router and have replaced the primary router
801 in the cell. This function will start the backup resuming protocol. */
803 void silc_server_backup_connected(SilcServer server,
804 SilcServerEntry server_entry,
807 SilcServerBackupProtocolContext proto_ctx;
808 SilcPacketStream sock;
812 silc_schedule_task_add_timeout(server->schedule,
813 silc_server_backup_connected_again,
818 sock = server_entry->connection;
819 proto_ctx = silc_calloc(1, sizeof(*proto_ctx));
820 proto_ctx->server = server;
821 proto_ctx->sock = sock;
822 proto_ctx->responder = FALSE;
823 proto_ctx->type = SILC_SERVER_BACKUP_START;
824 proto_ctx->start = time(0);
825 silc_packet_stream_ref(sock);
827 /* Start through scheduler */
828 silc_schedule_task_add_timeout(server->schedule,
829 silc_server_backup_connected_later,
833 SILC_TASK_CALLBACK(silc_server_backup_connect_primary_again)
835 SilcServer server = app_context;
836 SilcServerConfigRouter *primary;
838 primary = silc_server_config_get_primary_router(server);
840 if (!silc_server_find_socket_by_host(server, SILC_CONN_ROUTER,
841 primary->host, primary->port))
842 silc_server_create_connection(server, FALSE, FALSE,
843 primary->host, primary->port,
844 silc_server_backup_connect_primary,
849 /* Called when normal server has connected to its primary router after
850 backup router has sent the START packet in reusming protocol. We will
851 move the protocol context from the backup router connection to the
854 static void silc_server_backup_connect_primary(SilcServer server,
855 SilcServerEntry server_entry,
858 SilcPacketStream backup_router = context;
859 SilcIDListData idata = silc_packet_get_context(backup_router);
860 SilcServerEntry router = (SilcServerEntry)idata;
861 SilcServerBackupProtocolContext ctx;
862 SilcPacketStream sock;
863 unsigned char data[2];
867 silc_schedule_task_add_timeout(server->schedule,
868 silc_server_backup_connect_primary_again,
873 if (!router->backup || !server_entry->connection) {
874 silc_packet_stream_unref(backup_router);
878 ctx = router->backup_proto;
879 sock = server_entry->connection;
880 idata = (SilcIDListData)server_entry;
882 SILC_LOG_DEBUG(("Sending CONNECTED packet (session %d)", ctx->session));
883 SILC_LOG_INFO(("Sending CONNECTED (session %d) to backup router",
886 /* Send the CONNECTED packet back to the backup router. */
887 data[0] = SILC_SERVER_BACKUP_CONNECTED;
888 data[1] = ctx->session;
889 silc_server_packet_send(server, backup_router,
890 SILC_PACKET_RESUME_ROUTER, 0, data, 2);
892 /* The primary connection is disabled until it sends the RESUMED packet
894 idata->status |= SILC_IDLIST_STATUS_DISABLED;
896 /* Move this protocol context from this backup router connection to
897 the primary router connection since it will send the subsequent
898 packets in this protocol. We don't talk with backup router
901 silc_packet_stream_unref(ctx->sock);
903 silc_packet_stream_ref(sock);
904 server_entry->backup = TRUE;
905 server_entry->backup_proto = ctx;
906 router->backup = FALSE;
907 router->backup_proto = NULL;
910 silc_packet_stream_unref(backup_router);
913 /* Timeout callback used by the backup router to send the ENDING packet
914 to primary router to indicate that it can now resume as being primary
915 router. All CONNECTED packets has been received when we reach this. */
917 SILC_TASK_CALLBACK(silc_server_backup_send_resumed)
919 SilcServerBackupProtocolContext ctx = context;
920 SilcServer server = ctx->server;
921 unsigned char data[2];
924 SILC_LOG_DEBUG(("Start"));
926 for (i = 0; i < ctx->sessions_count; i++)
927 if (ctx->sessions[i].server_entry == silc_packet_get_context(ctx->sock))
928 ctx->session = ctx->sessions[i].session;
930 /* We've received all the CONNECTED packets and now we'll send the
931 ENDING packet to the new primary router. */
932 data[0] = SILC_SERVER_BACKUP_ENDING;
933 data[1] = ctx->session;
934 silc_server_packet_send(server, ctx->sock, SILC_PACKET_RESUME_ROUTER, 0,
937 /* The protocol will go to END state. */
941 /* Backup resuming protocol. This protocol is executed when the primary
942 router wants to resume its position as being primary router. */
944 SILC_TASK_CALLBACK(silc_server_protocol_backup)
946 SilcServerBackupProtocolContext ctx = context;
947 SilcServer server = ctx->server;
948 SilcServerEntry server_entry = NULL;
949 SilcPacketStream sock = NULL;
950 unsigned char data[2];
959 if (ctx->responder == FALSE) {
961 * Initiator (backup router)
964 /* Send the START packet to primary router and normal servers. The
965 packet will indicate to the primary router that it has been replaced
966 by us. For normal servers it means that we will be resigning as
967 being primary router shortly. */
968 list = silc_packet_engine_get_streams(server->packet_engine);
972 silc_dlist_start(list);
973 while ((sock = silc_dlist_get(list))) {
974 server_entry = silc_packet_get_context(sock);
976 if (!server_entry || server_entry == server->id_entry ||
977 (server_entry->data.conn_type != SILC_CONN_ROUTER &&
978 server_entry->data.conn_type != SILC_CONN_SERVER))
981 if (server_entry->data.status & SILC_IDLIST_STATUS_DISABLED)
984 ctx->sessions = silc_realloc(ctx->sessions,
985 sizeof(*ctx->sessions) *
986 (ctx->sessions_count + 1));
987 ctx->sessions[ctx->sessions_count].session = ctx->sessions_count;
988 ctx->sessions[ctx->sessions_count].connected = FALSE;
989 ctx->sessions[ctx->sessions_count].server_entry = server_entry;
991 SILC_LOG_DEBUG(("Sending START to %s (session %d)",
992 server_entry->server_name, ctx->sessions_count));
993 SILC_LOG_INFO(("Expecting CONNECTED from %s (session %d)",
994 server_entry->server_name, ctx->sessions_count));
996 /* This connection is performing this protocol too now */
997 server_entry->backup = TRUE;
998 server_entry->backup_proto = ctx;
1000 data[0] = SILC_SERVER_BACKUP_START;
1001 data[1] = ctx->sessions_count;
1002 silc_server_packet_send(server, sock, SILC_PACKET_RESUME_ROUTER, 0,
1003 data, sizeof(data));
1004 ctx->sessions_count++;
1006 silc_packet_engine_free_streams_list(list);
1008 /* Announce data to the new primary to be. */
1009 silc_server_announce_servers(server, TRUE, 0, ctx->sock);
1010 silc_server_announce_clients(server, 0, ctx->sock);
1011 silc_server_announce_channels(server, 0, ctx->sock);
1017 * Responder (all servers and routers)
1019 SilcServerConfigRouter *primary;
1021 /* We should have received START packet */
1022 if (ctx->type != SILC_SERVER_BACKUP_START) {
1023 SILC_LOG_ERROR(("Bad resume router packet START %d", ctx->type));
1027 /* Connect to the primary router that was down that is now supposed
1028 to be back online. We send the CONNECTED packet after we've
1029 established the connection to the primary router. */
1030 primary = silc_server_config_get_primary_router(server);
1031 if (primary && server->backup_primary &&
1032 !silc_server_num_sockets_by_remote(server,
1033 silc_net_is_ip(primary->host) ?
1034 primary->host : NULL,
1035 silc_net_is_ip(primary->host) ?
1036 NULL : primary->host,
1038 SILC_CONN_ROUTER)) {
1039 SILC_LOG_DEBUG(("Received START (session %d), reconnect to router",
1041 silc_packet_stream_ref(ctx->sock);
1042 silc_server_create_connection(server, FALSE, FALSE,
1043 primary->host, primary->port,
1044 silc_server_backup_connect_primary,
1047 /* Nowhere to connect just return the CONNECTED packet */
1048 SILC_LOG_DEBUG(("Received START (session %d), send CONNECTED back",
1050 SILC_LOG_INFO(("Sending CONNECTED (session %d) to backup router",
1053 /* Send the CONNECTED packet back to the backup router. */
1054 data[0] = SILC_SERVER_BACKUP_CONNECTED;
1055 data[1] = ctx->session;
1056 silc_server_packet_send(server, ctx->sock,
1057 SILC_PACKET_RESUME_ROUTER, 0,
1058 data, sizeof(data));
1061 /* Add this resuming session */
1062 ctx->sessions = silc_realloc(ctx->sessions,
1063 sizeof(*ctx->sessions) *
1064 (ctx->sessions_count + 1));
1065 ctx->sessions[ctx->sessions_count].session = ctx->session;
1066 ctx->sessions_count++;
1068 /* Normal server goes directly to the END state. */
1069 if (server->server_type == SILC_ROUTER &&
1071 server->router->data.status & SILC_IDLIST_STATUS_DISABLED))
1079 if (ctx->responder == FALSE) {
1081 * Initiator (backup router)
1084 /* We should have received CONNECTED packet */
1085 if (ctx->type != SILC_SERVER_BACKUP_CONNECTED) {
1086 SILC_LOG_ERROR(("Bad resume router packet CONNECTED %d", ctx->type));
1090 for (i = 0; i < ctx->sessions_count; i++) {
1091 if (ctx->sessions[i].session == ctx->session) {
1092 ctx->sessions[i].connected = TRUE;
1093 SILC_LOG_INFO(("Received CONNECTED from %s (session %d)",
1094 ctx->sessions[i].server_entry->server_name,
1096 SILC_LOG_DEBUG(("Received CONNECTED (session %d)", ctx->session));
1101 /* See if all returned CONNECTED, if not, then continue waiting. */
1102 for (i = 0; i < ctx->sessions_count; i++) {
1103 if (!ctx->sessions[i].connected)
1107 SILC_LOG_INFO(("All sessions have returned CONNECTED packets, "
1109 SILC_LOG_DEBUG(("Sending ENDING packet to primary router"));
1111 /* The ENDING is sent with timeout, and then we continue to the
1112 END state in the protocol. */
1113 silc_schedule_task_add_timeout(server->schedule,
1114 silc_server_backup_send_resumed,
1120 * Responder (primary router)
1123 /* We should have been received ENDING packet */
1124 if (ctx->type != SILC_SERVER_BACKUP_ENDING) {
1125 SILC_LOG_ERROR(("Bad resume router packet ENDING %d", ctx->type));
1129 SILC_LOG_DEBUG(("Received ENDING packet, we are going to resume now"));
1131 /* Switch announced informations to our primary router of using the
1133 silc_server_local_servers_toggle_enabled(server, TRUE);
1134 silc_server_update_servers_by_server(server,
1135 silc_packet_get_context(ctx->sock),
1137 silc_server_update_clients_by_server(server,
1138 silc_packet_get_context(ctx->sock),
1139 server->router, TRUE);
1141 /* We as primary router now must send RESUMED packets to all servers
1142 and routers so that they know we are back. For backup router we
1143 send the packet last so that we give the backup as much time as
1144 possible to deal with message routing at this critical moment. */
1145 list = silc_packet_engine_get_streams(server->packet_engine);
1149 silc_dlist_start(list);
1150 while ((sock = silc_dlist_get(list))) {
1151 server_entry = silc_packet_get_context(sock);
1153 if (!server_entry || server_entry == server->id_entry ||
1154 (server_entry->data.conn_type != SILC_CONN_ROUTER &&
1155 server_entry->data.conn_type != SILC_CONN_SERVER))
1158 /* Send to backup last */
1159 if (sock == ctx->sock)
1163 server_entry->data.status &= ~SILC_IDLIST_STATUS_DISABLED;
1165 SILC_LOG_DEBUG(("Sending RESUMED to %s", server_entry->server_name));
1166 SILC_LOG_INFO(("Sending RESUMED to %s", server_entry->server_name));
1168 /* This connection is performing this protocol too now */
1169 server_entry->backup = TRUE;
1170 server_entry->backup_proto = ctx;
1172 data[0] = SILC_SERVER_BACKUP_RESUMED;
1174 silc_server_packet_send(server, sock, SILC_PACKET_RESUME_ROUTER, 0,
1175 data, sizeof(data));
1177 silc_packet_engine_free_streams_list(list);
1179 /* Now send the same packet to backup */
1180 if (sock != ctx->sock) {
1183 goto send_to_backup;
1186 /* We are now resumed and are back as primary router in the cell. */
1187 SILC_LOG_INFO(("We are now the primary router of our cell again"));
1188 server->wait_backup = FALSE;
1190 /* Announce WATCH list a little later */
1191 silc_packet_stream_ref(ctx->sock);
1192 silc_schedule_task_add_timeout(server->schedule,
1193 silc_server_backup_announce_watches,
1196 /* For us this is the end of this protocol. */
1197 silc_schedule_task_add_timeout(server->schedule,
1198 silc_server_protocol_backup_done,
1206 * Responder (backup router, servers, and remote router)
1208 SilcServerEntry router, backup_router;
1210 /* We should have been received RESUMED from our primary router. */
1211 if (ctx->type != SILC_SERVER_BACKUP_RESUMED) {
1212 SILC_LOG_ERROR(("Bad resume router packet RESUMED %d", ctx->type));
1216 SILC_LOG_INFO(("Received RESUMED from new primary router"));
1218 /* If we are the backup router, mark that we are no longer primary
1219 but are back to backup router status. */
1220 if (server->backup_router)
1221 server->server_type = SILC_BACKUP_ROUTER;
1223 /* We have now new primary router. All traffic goes there from now on. */
1224 router = silc_packet_get_context(ctx->sock);
1225 if (silc_server_backup_replaced_get(server, router->id,
1228 if (backup_router == server->router) {
1229 /* We have new primary router now */
1230 server->id_entry->router = router;
1231 server->router = router;
1232 SILC_LOG_INFO(("Switching back to primary router %s",
1233 server->router->server_name));
1235 /* We are connected to new primary and now continue using it */
1236 SILC_LOG_INFO(("Resuming the use of primary router %s",
1237 router->server_name));
1239 server->backup_primary = FALSE;
1240 sock = router->connection;
1242 /* Update the client entries of the backup router to the new
1244 silc_server_local_servers_toggle_enabled(server, FALSE);
1245 router->data.status &= ~SILC_IDLIST_STATUS_DISABLED;
1246 silc_server_update_servers_by_server(server, backup_router, router);
1247 silc_server_update_clients_by_server(
1248 server, NULL, router,
1249 server->server_type == SILC_BACKUP_ROUTER);
1250 if (server->server_type == SILC_SERVER)
1251 silc_server_update_channels_by_server(server, backup_router, router);
1252 silc_server_backup_replaced_del(server, backup_router);
1255 /* Send notify about primary router going down to local operators */
1256 SILC_SERVER_SEND_OPERS(server, FALSE, TRUE,
1257 SILC_NOTIFY_TYPE_NONE,
1258 ("%s resumed the use of primary router %s",
1259 server->server_name,
1260 server->router->server_name));
1262 /* Protocol has ended, call the final callback */
1263 silc_schedule_task_add_timeout(server->schedule,
1264 silc_server_protocol_backup_done,
1270 /* Protocol has ended, call the final callback */
1271 silc_schedule_task_add_timeout(server->schedule,
1272 silc_server_protocol_backup_done,
1277 /* Protocol has ended, call the final callback */
1278 SILC_LOG_ERROR(("Error during backup resume: received Failure"));
1279 ctx->received_failure = TRUE;
1280 silc_schedule_task_add_timeout(server->schedule,
1281 silc_server_protocol_backup_done,
1290 /* Final resuming protocol completion callback */
1292 SILC_TASK_CALLBACK(silc_server_protocol_backup_done)
1294 SilcServerBackupProtocolContext ctx = context;
1295 SilcServer server = ctx->server;
1297 SilcServerEntry server_entry;
1298 SilcPacketStream sock;
1301 silc_schedule_task_del_by_context(server->schedule, ctx);
1306 SILC_LOG_ERROR(("Error occurred during backup router resuming protcool"));
1308 if (server->server_shutdown)
1311 /* Remove this protocol from all server entries that has it */
1312 list = silc_packet_engine_get_streams(server->packet_engine);
1316 silc_dlist_start(list);
1317 while ((sock = silc_dlist_get(list))) {
1318 server_entry = silc_packet_get_context(sock);
1322 if (server_entry->data.conn_type != SILC_CONN_ROUTER &&
1323 server_entry->data.conn_type != SILC_CONN_SERVER)
1326 if (server_entry->backup_proto == ctx) {
1329 if (server->server_type == SILC_SERVER &&
1330 server_entry->server_type == SILC_ROUTER)
1334 if (SILC_PRIMARY_ROUTE(server) == sock && server->backup_router) {
1335 if (ctx->sock == sock) {
1336 silc_packet_stream_unref(sock);
1340 /* If failed after 10 attempts, it won't work, give up */
1341 if (ctx->initiator_restart > 10)
1342 ctx->received_failure = TRUE;
1344 if (!ctx->received_failure) {
1345 /* Protocol error, probably timeout. Just restart the protocol. */
1346 SilcServerBackupProtocolContext proto_ctx;
1348 /* Restart the protocol. */
1349 proto_ctx = silc_calloc(1, sizeof(*proto_ctx));
1350 proto_ctx->server = server;
1351 proto_ctx->sock = sock;
1352 proto_ctx->responder = FALSE;
1353 proto_ctx->type = SILC_SERVER_BACKUP_START;
1354 proto_ctx->start = time(0);
1355 proto_ctx->initiator_restart = ctx->initiator_restart + 1;
1356 silc_packet_stream_ref(sock);
1358 /* Start through scheduler */
1359 silc_schedule_task_add_timeout(server->schedule,
1360 silc_server_backup_connected_later,
1363 /* If failure was received, switch back to normal backup router.
1364 For some reason primary wouldn't accept that we were supposed
1365 to perfom resuming protocol. */
1366 server->server_type = SILC_BACKUP_ROUTER;
1367 silc_server_local_servers_toggle_enabled(server, FALSE);
1368 server_entry->data.status &= ~SILC_IDLIST_STATUS_DISABLED;
1369 silc_server_update_servers_by_server(server, server->id_entry,
1370 silc_packet_get_context(sock));
1371 silc_server_update_clients_by_server(server, NULL,
1372 silc_packet_get_context(sock),
1375 /* Announce our clients and channels to the router */
1376 silc_server_announce_clients(server, 0, sock);
1377 silc_server_announce_channels(server, 0, sock);
1379 /* Announce WATCH list a little later */
1380 silc_packet_stream_ref(sock);
1381 silc_schedule_task_add_timeout(server->schedule,
1382 silc_server_backup_announce_watches,
1390 server_entry->data.status &= ~SILC_IDLIST_STATUS_DISABLED;
1393 silc_packet_engine_free_streams_list(list);
1396 SILC_LOG_INFO(("Backup resuming protocol ended successfully"));
1398 if (ctx->type == SILC_SERVER_BACKUP_RESUMED && server->router) {
1399 /* Announce all of our information to the router. */
1400 if (server->server_type == SILC_ROUTER)
1401 silc_server_announce_servers(server, FALSE, 0,
1402 server->router->connection);
1404 /* Announce our clients and channels to the router */
1405 silc_server_announce_clients(server, 0, server->router->connection);
1406 silc_server_announce_channels(server, 0, server->router->connection);
1408 /* Announce WATCH list a little later */
1409 silc_packet_stream_ref(server->router->connection);
1410 silc_schedule_task_add_timeout(server->schedule,
1411 silc_server_backup_announce_watches,
1412 server->router->connection, 4, 0);
1417 if (server->server_type == SILC_SERVER) {
1418 /* If we are still using backup router Send confirmation to backup
1419 that using it is still ok and continue sending traffic there.
1420 The backup will reply with error if it's not ok. */
1421 if (server->router && server->backup_primary) {
1422 /* Send START_USE just in case using backup wouldn't be ok. */
1423 silc_server_backup_send_start_use(server, server->router->connection,
1426 /* Check couple of times same START_USE just in case. */
1427 silc_packet_stream_ref(server->router->connection);
1428 silc_schedule_task_add_timeout(server->schedule,
1429 silc_server_backup_check_status,
1430 server->router->connection,
1432 silc_packet_stream_ref(server->router->connection);
1433 silc_schedule_task_add_timeout(server->schedule,
1434 silc_server_backup_check_status,
1435 server->router->connection,
1437 silc_packet_stream_ref(server->router->connection);
1438 silc_schedule_task_add_timeout(server->schedule,
1439 silc_server_backup_check_status,
1440 server->router->connection,
1447 SilcServerEntry r = silc_packet_get_context(ctx->sock);
1449 r->backup_proto = NULL;
1450 silc_packet_stream_unref(ctx->sock);
1452 silc_free(ctx->sessions);
1456 SILC_TASK_CALLBACK(silc_server_backup_announce_watches)
1458 SilcPacketStream sock = context;
1459 SilcServer server = app_context;
1460 if (silc_packet_stream_is_valid(sock))
1461 silc_server_announce_watches(server, sock);
1462 silc_packet_stream_unref(sock);