2 * COarse-grain LOck-stepping Virtual Machines for Non-stop Service (COLO)
3 * (a.k.a. Fault Tolerance or Continuous Replication)
5 * Copyright (c) 2016 HUAWEI TECHNOLOGIES CO., LTD.
6 * Copyright (c) 2016 FUJITSU LIMITED
7 * Copyright (c) 2016 Intel Corporation
9 * Author: Zhang Chen <zhangchen.fnst@cn.fujitsu.com>
11 * This work is licensed under the terms of the GNU GPL, version 2 or
12 * later. See the COPYING file in the top-level directory.
15 #include "qemu/osdep.h"
16 #include "qemu/error-report.h"
18 #include "qemu-common.h"
19 #include "qapi/qmp/qerror.h"
20 #include "qapi/error.h"
23 #include "qom/object_interfaces.h"
25 #include "qom/object.h"
26 #include "qemu/typedefs.h"
27 #include "net/queue.h"
28 #include "sysemu/char.h"
29 #include "qemu/sockets.h"
30 #include "qapi-visit.h"
33 #define TYPE_COLO_COMPARE "colo-compare"
34 #define COLO_COMPARE(obj) \
35 OBJECT_CHECK(CompareState, (obj), TYPE_COLO_COMPARE)
37 #define COMPARE_READ_LEN_MAX NET_BUFSIZE
38 #define MAX_QUEUE_SIZE 1024
40 /* TODO: Should be configurable */
41 #define REGULAR_PACKET_CHECK_MS 3000
46 +---------------+ +---------------+ +---------------+
47 |conn list +--->conn +--------->conn |
48 +---------------+ +---------------+ +---------------+
50 +---------------+ +---v----+ +---v----+ +---v----+ +---v----+
51 |primary | |secondary |primary | |secondary
52 |packet | |packet + |packet | |packet +
53 +--------+ +--------+ +--------+ +--------+
55 +---v----+ +---v----+ +---v----+ +---v----+
56 |primary | |secondary |primary | |secondary
57 |packet | |packet + |packet | |packet +
58 +--------+ +--------+ +--------+ +--------+
60 +---v----+ +---v----+ +---v----+ +---v----+
61 |primary | |secondary |primary | |secondary
62 |packet | |packet + |packet | |packet +
63 +--------+ +--------+ +--------+ +--------+
65 typedef struct CompareState
{
71 CharBackend chr_pri_in
;
72 CharBackend chr_sec_in
;
74 SocketReadState pri_rs
;
75 SocketReadState sec_rs
;
77 /* connection list: the connections belonged to this NIC could be found
79 * element type: Connection
82 /* hashtable to save connection */
83 GHashTable
*connection_track_table
;
84 /* compare thread, a thread for each NIC */
87 GMainContext
*worker_context
;
88 GMainLoop
*compare_loop
;
91 typedef struct CompareClass
{
92 ObjectClass parent_class
;
100 static int compare_chr_send(CharBackend
*out
,
104 static gint
seq_sorter(Packet
*a
, Packet
*b
, gpointer data
)
106 struct tcphdr
*atcp
, *btcp
;
108 atcp
= (struct tcphdr
*)(a
->transport_header
);
109 btcp
= (struct tcphdr
*)(b
->transport_header
);
110 return ntohl(atcp
->th_seq
) - ntohl(btcp
->th_seq
);
114 * Return 0 on success, if return -1 means the pkt
115 * is unsupported(arp and ipv6) and will be sent later
117 static int packet_enqueue(CompareState
*s
, int mode
)
123 if (mode
== PRIMARY_IN
) {
124 pkt
= packet_new(s
->pri_rs
.buf
, s
->pri_rs
.packet_len
);
126 pkt
= packet_new(s
->sec_rs
.buf
, s
->sec_rs
.packet_len
);
129 if (parse_packet_early(pkt
)) {
130 packet_destroy(pkt
, NULL
);
134 fill_connection_key(pkt
, &key
);
136 conn
= connection_get(s
->connection_track_table
,
140 if (!conn
->processing
) {
141 g_queue_push_tail(&s
->conn_list
, conn
);
142 conn
->processing
= true;
145 if (mode
== PRIMARY_IN
) {
146 if (g_queue_get_length(&conn
->primary_list
) <=
148 g_queue_push_tail(&conn
->primary_list
, pkt
);
149 if (conn
->ip_proto
== IPPROTO_TCP
) {
150 g_queue_sort(&conn
->primary_list
,
151 (GCompareDataFunc
)seq_sorter
,
155 error_report("colo compare primary queue size too big,"
159 if (g_queue_get_length(&conn
->secondary_list
) <=
161 g_queue_push_tail(&conn
->secondary_list
, pkt
);
162 if (conn
->ip_proto
== IPPROTO_TCP
) {
163 g_queue_sort(&conn
->secondary_list
,
164 (GCompareDataFunc
)seq_sorter
,
168 error_report("colo compare secondary queue size too big,"
177 * The IP packets sent by primary and secondary
178 * will be compared in here
179 * TODO support ip fragment, Out-Of-Order
180 * return: 0 means packet same
181 * > 0 || < 0 means packet different
183 static int colo_packet_compare_common(Packet
*ppkt
, Packet
*spkt
, int offset
)
185 trace_colo_compare_ip_info(ppkt
->size
, inet_ntoa(ppkt
->ip
->ip_src
),
186 inet_ntoa(ppkt
->ip
->ip_dst
), spkt
->size
,
187 inet_ntoa(spkt
->ip
->ip_src
),
188 inet_ntoa(spkt
->ip
->ip_dst
));
190 if (ppkt
->size
== spkt
->size
) {
191 return memcmp(ppkt
->data
+ offset
, spkt
->data
+ offset
,
192 spkt
->size
- offset
);
194 trace_colo_compare_main("Net packet size are not the same");
200 * Called from the compare thread on the primary
201 * for compare tcp packet
202 * compare_tcp copied from Dr. David Alan Gilbert's branch
204 static int colo_packet_compare_tcp(Packet
*spkt
, Packet
*ppkt
)
206 struct tcphdr
*ptcp
, *stcp
;
209 trace_colo_compare_main("compare tcp");
211 ptcp
= (struct tcphdr
*)ppkt
->transport_header
;
212 stcp
= (struct tcphdr
*)spkt
->transport_header
;
215 * The 'identification' field in the IP header is *very* random
216 * it almost never matches. Fudge this by ignoring differences in
217 * unfragmented packets; they'll normally sort themselves out if different
218 * anyway, and it should recover at the TCP level.
219 * An alternative would be to get both the primary and secondary to rewrite
220 * somehow; but that would need some sync traffic to sync the state
222 if (ntohs(ppkt
->ip
->ip_off
) & IP_DF
) {
223 spkt
->ip
->ip_id
= ppkt
->ip
->ip_id
;
224 /* and the sum will be different if the IDs were different */
225 spkt
->ip
->ip_sum
= ppkt
->ip
->ip_sum
;
228 if (ptcp
->th_sum
== stcp
->th_sum
) {
229 res
= colo_packet_compare_common(ppkt
, spkt
, ETH_HLEN
);
234 if (res
!= 0 && trace_event_get_state(TRACE_COLO_COMPARE_MISCOMPARE
)) {
235 trace_colo_compare_pkt_info_src(inet_ntoa(ppkt
->ip
->ip_src
),
241 trace_colo_compare_pkt_info_dst(inet_ntoa(ppkt
->ip
->ip_dst
),
247 qemu_hexdump((char *)ppkt
->data
, stderr
,
248 "colo-compare ppkt", ppkt
->size
);
249 qemu_hexdump((char *)spkt
->data
, stderr
,
250 "colo-compare spkt", spkt
->size
);
257 * Called from the compare thread on the primary
258 * for compare udp packet
260 static int colo_packet_compare_udp(Packet
*spkt
, Packet
*ppkt
)
263 int network_header_length
= ppkt
->ip
->ip_hl
* 4;
265 trace_colo_compare_main("compare udp");
268 * Because of ppkt and spkt are both in the same connection,
269 * The ppkt's src ip, dst ip, src port, dst port, ip_proto all are
270 * same with spkt. In addition, IP header's Identification is a random
271 * field, we can handle it in IP fragmentation function later.
272 * COLO just concern the response net packet payload from primary guest
273 * and secondary guest are same or not, So we ignored all IP header include
274 * other field like TOS,TTL,IP Checksum. we only need to compare
275 * the ip payload here.
277 ret
= colo_packet_compare_common(ppkt
, spkt
,
278 network_header_length
+ ETH_HLEN
);
281 trace_colo_compare_udp_miscompare("primary pkt size", ppkt
->size
);
282 qemu_hexdump((char *)ppkt
->data
, stderr
, "colo-compare", ppkt
->size
);
283 trace_colo_compare_udp_miscompare("Secondary pkt size", spkt
->size
);
284 qemu_hexdump((char *)spkt
->data
, stderr
, "colo-compare", spkt
->size
);
291 * Called from the compare thread on the primary
292 * for compare icmp packet
294 static int colo_packet_compare_icmp(Packet
*spkt
, Packet
*ppkt
)
296 int network_header_length
= ppkt
->ip
->ip_hl
* 4;
298 trace_colo_compare_main("compare icmp");
301 * Because of ppkt and spkt are both in the same connection,
302 * The ppkt's src ip, dst ip, src port, dst port, ip_proto all are
303 * same with spkt. In addition, IP header's Identification is a random
304 * field, we can handle it in IP fragmentation function later.
305 * COLO just concern the response net packet payload from primary guest
306 * and secondary guest are same or not, So we ignored all IP header include
307 * other field like TOS,TTL,IP Checksum. we only need to compare
308 * the ip payload here.
310 if (colo_packet_compare_common(ppkt
, spkt
,
311 network_header_length
+ ETH_HLEN
)) {
312 trace_colo_compare_icmp_miscompare("primary pkt size",
314 qemu_hexdump((char *)ppkt
->data
, stderr
, "colo-compare",
316 trace_colo_compare_icmp_miscompare("Secondary pkt size",
318 qemu_hexdump((char *)spkt
->data
, stderr
, "colo-compare",
327 * Called from the compare thread on the primary
328 * for compare other packet
330 static int colo_packet_compare_other(Packet
*spkt
, Packet
*ppkt
)
332 trace_colo_compare_main("compare other");
333 trace_colo_compare_ip_info(ppkt
->size
, inet_ntoa(ppkt
->ip
->ip_src
),
334 inet_ntoa(ppkt
->ip
->ip_dst
), spkt
->size
,
335 inet_ntoa(spkt
->ip
->ip_src
),
336 inet_ntoa(spkt
->ip
->ip_dst
));
337 return colo_packet_compare_common(ppkt
, spkt
, 0);
340 static int colo_old_packet_check_one(Packet
*pkt
, int64_t *check_time
)
342 int64_t now
= qemu_clock_get_ms(QEMU_CLOCK_HOST
);
344 if ((now
- pkt
->creation_ms
) > (*check_time
)) {
345 trace_colo_old_packet_check_found(pkt
->creation_ms
);
352 static void colo_old_packet_check_one_conn(void *opaque
,
355 Connection
*conn
= opaque
;
356 GList
*result
= NULL
;
357 int64_t check_time
= REGULAR_PACKET_CHECK_MS
;
359 result
= g_queue_find_custom(&conn
->primary_list
,
361 (GCompareFunc
)colo_old_packet_check_one
);
364 /* do checkpoint will flush old packet */
365 /* TODO: colo_notify_checkpoint();*/
370 * Look for old packets that the secondary hasn't matched,
371 * if we have some then we have to checkpoint to wake
374 static void colo_old_packet_check(void *opaque
)
376 CompareState
*s
= opaque
;
378 g_queue_foreach(&s
->conn_list
, colo_old_packet_check_one_conn
, NULL
);
382 * Called from the compare thread on the primary
383 * for compare connection
385 static void colo_compare_connection(void *opaque
, void *user_data
)
387 CompareState
*s
= user_data
;
388 Connection
*conn
= opaque
;
390 GList
*result
= NULL
;
393 while (!g_queue_is_empty(&conn
->primary_list
) &&
394 !g_queue_is_empty(&conn
->secondary_list
)) {
395 pkt
= g_queue_pop_tail(&conn
->primary_list
);
396 switch (conn
->ip_proto
) {
398 result
= g_queue_find_custom(&conn
->secondary_list
,
399 pkt
, (GCompareFunc
)colo_packet_compare_tcp
);
402 result
= g_queue_find_custom(&conn
->secondary_list
,
403 pkt
, (GCompareFunc
)colo_packet_compare_udp
);
406 result
= g_queue_find_custom(&conn
->secondary_list
,
407 pkt
, (GCompareFunc
)colo_packet_compare_icmp
);
410 result
= g_queue_find_custom(&conn
->secondary_list
,
411 pkt
, (GCompareFunc
)colo_packet_compare_other
);
416 ret
= compare_chr_send(&s
->chr_out
, pkt
->data
, pkt
->size
);
418 error_report("colo_send_primary_packet failed");
420 trace_colo_compare_main("packet same and release packet");
421 g_queue_remove(&conn
->secondary_list
, result
->data
);
422 packet_destroy(pkt
, NULL
);
425 * If one packet arrive late, the secondary_list or
426 * primary_list will be empty, so we can't compare it
427 * until next comparison.
429 trace_colo_compare_main("packet different");
430 g_queue_push_tail(&conn
->primary_list
, pkt
);
431 /* TODO: colo_notify_checkpoint();*/
437 static int compare_chr_send(CharBackend
*out
,
442 uint32_t len
= htonl(size
);
448 ret
= qemu_chr_fe_write_all(out
, (uint8_t *)&len
, sizeof(len
));
449 if (ret
!= sizeof(len
)) {
453 ret
= qemu_chr_fe_write_all(out
, (uint8_t *)buf
, size
);
461 return ret
< 0 ? ret
: -EIO
;
464 static int compare_chr_can_read(void *opaque
)
466 return COMPARE_READ_LEN_MAX
;
470 * Called from the main thread on the primary for packets
471 * arriving over the socket from the primary.
473 static void compare_pri_chr_in(void *opaque
, const uint8_t *buf
, int size
)
475 CompareState
*s
= COLO_COMPARE(opaque
);
478 ret
= net_fill_rstate(&s
->pri_rs
, buf
, size
);
480 qemu_chr_fe_set_handlers(&s
->chr_pri_in
, NULL
, NULL
, NULL
,
482 error_report("colo-compare primary_in error");
487 * Called from the main thread on the primary for packets
488 * arriving over the socket from the secondary.
490 static void compare_sec_chr_in(void *opaque
, const uint8_t *buf
, int size
)
492 CompareState
*s
= COLO_COMPARE(opaque
);
495 ret
= net_fill_rstate(&s
->sec_rs
, buf
, size
);
497 qemu_chr_fe_set_handlers(&s
->chr_sec_in
, NULL
, NULL
, NULL
,
499 error_report("colo-compare secondary_in error");
504 * Check old packet regularly so it can watch for any packets
505 * that the secondary hasn't produced equivalents of.
507 static gboolean
check_old_packet_regular(void *opaque
)
509 CompareState
*s
= opaque
;
511 /* if have old packet we will notify checkpoint */
512 colo_old_packet_check(s
);
517 static void *colo_compare_thread(void *opaque
)
519 CompareState
*s
= opaque
;
520 GSource
*timeout_source
;
522 s
->worker_context
= g_main_context_new();
524 qemu_chr_fe_set_handlers(&s
->chr_pri_in
, compare_chr_can_read
,
525 compare_pri_chr_in
, NULL
, s
, s
->worker_context
, true);
526 qemu_chr_fe_set_handlers(&s
->chr_sec_in
, compare_chr_can_read
,
527 compare_sec_chr_in
, NULL
, s
, s
->worker_context
, true);
529 s
->compare_loop
= g_main_loop_new(s
->worker_context
, FALSE
);
531 /* To kick any packets that the secondary doesn't match */
532 timeout_source
= g_timeout_source_new(REGULAR_PACKET_CHECK_MS
);
533 g_source_set_callback(timeout_source
,
534 (GSourceFunc
)check_old_packet_regular
, s
, NULL
);
535 g_source_attach(timeout_source
, s
->worker_context
);
537 g_main_loop_run(s
->compare_loop
);
539 g_source_unref(timeout_source
);
540 g_main_loop_unref(s
->compare_loop
);
541 g_main_context_unref(s
->worker_context
);
545 static char *compare_get_pri_indev(Object
*obj
, Error
**errp
)
547 CompareState
*s
= COLO_COMPARE(obj
);
549 return g_strdup(s
->pri_indev
);
552 static void compare_set_pri_indev(Object
*obj
, const char *value
, Error
**errp
)
554 CompareState
*s
= COLO_COMPARE(obj
);
556 g_free(s
->pri_indev
);
557 s
->pri_indev
= g_strdup(value
);
560 static char *compare_get_sec_indev(Object
*obj
, Error
**errp
)
562 CompareState
*s
= COLO_COMPARE(obj
);
564 return g_strdup(s
->sec_indev
);
567 static void compare_set_sec_indev(Object
*obj
, const char *value
, Error
**errp
)
569 CompareState
*s
= COLO_COMPARE(obj
);
571 g_free(s
->sec_indev
);
572 s
->sec_indev
= g_strdup(value
);
575 static char *compare_get_outdev(Object
*obj
, Error
**errp
)
577 CompareState
*s
= COLO_COMPARE(obj
);
579 return g_strdup(s
->outdev
);
582 static void compare_set_outdev(Object
*obj
, const char *value
, Error
**errp
)
584 CompareState
*s
= COLO_COMPARE(obj
);
587 s
->outdev
= g_strdup(value
);
590 static void compare_pri_rs_finalize(SocketReadState
*pri_rs
)
592 CompareState
*s
= container_of(pri_rs
, CompareState
, pri_rs
);
594 if (packet_enqueue(s
, PRIMARY_IN
)) {
595 trace_colo_compare_main("primary: unsupported packet in");
596 compare_chr_send(&s
->chr_out
, pri_rs
->buf
, pri_rs
->packet_len
);
598 /* compare connection */
599 g_queue_foreach(&s
->conn_list
, colo_compare_connection
, s
);
603 static void compare_sec_rs_finalize(SocketReadState
*sec_rs
)
605 CompareState
*s
= container_of(sec_rs
, CompareState
, sec_rs
);
607 if (packet_enqueue(s
, SECONDARY_IN
)) {
608 trace_colo_compare_main("secondary: unsupported packet in");
610 /* compare connection */
611 g_queue_foreach(&s
->conn_list
, colo_compare_connection
, s
);
617 * Return 0 is success.
618 * Return 1 is failed.
620 static int find_and_check_chardev(Chardev
**chr
,
624 *chr
= qemu_chr_find(chr_name
);
626 error_setg(errp
, "Device '%s' not found",
631 if (!qemu_chr_has_feature(*chr
, QEMU_CHAR_FEATURE_RECONNECTABLE
)) {
632 error_setg(errp
, "chardev \"%s\" is not reconnectable",
641 * Called from the main thread on the primary
642 * to setup colo-compare.
644 static void colo_compare_complete(UserCreatable
*uc
, Error
**errp
)
646 CompareState
*s
= COLO_COMPARE(uc
);
648 char thread_name
[64];
649 static int compare_id
;
651 if (!s
->pri_indev
|| !s
->sec_indev
|| !s
->outdev
) {
652 error_setg(errp
, "colo compare needs 'primary_in' ,"
653 "'secondary_in','outdev' property set");
655 } else if (!strcmp(s
->pri_indev
, s
->outdev
) ||
656 !strcmp(s
->sec_indev
, s
->outdev
) ||
657 !strcmp(s
->pri_indev
, s
->sec_indev
)) {
658 error_setg(errp
, "'indev' and 'outdev' could not be same "
659 "for compare module");
663 if (find_and_check_chardev(&chr
, s
->pri_indev
, errp
) ||
664 !qemu_chr_fe_init(&s
->chr_pri_in
, chr
, errp
)) {
668 if (find_and_check_chardev(&chr
, s
->sec_indev
, errp
) ||
669 !qemu_chr_fe_init(&s
->chr_sec_in
, chr
, errp
)) {
673 if (find_and_check_chardev(&chr
, s
->outdev
, errp
) ||
674 !qemu_chr_fe_init(&s
->chr_out
, chr
, errp
)) {
678 net_socket_rs_init(&s
->pri_rs
, compare_pri_rs_finalize
);
679 net_socket_rs_init(&s
->sec_rs
, compare_sec_rs_finalize
);
681 g_queue_init(&s
->conn_list
);
683 s
->connection_track_table
= g_hash_table_new_full(connection_key_hash
,
684 connection_key_equal
,
688 sprintf(thread_name
, "colo-compare %d", compare_id
);
689 qemu_thread_create(&s
->thread
, thread_name
,
690 colo_compare_thread
, s
,
691 QEMU_THREAD_JOINABLE
);
697 static void colo_flush_packets(void *opaque
, void *user_data
)
699 CompareState
*s
= user_data
;
700 Connection
*conn
= opaque
;
703 while (!g_queue_is_empty(&conn
->primary_list
)) {
704 pkt
= g_queue_pop_head(&conn
->primary_list
);
705 compare_chr_send(&s
->chr_out
, pkt
->data
, pkt
->size
);
706 packet_destroy(pkt
, NULL
);
708 while (!g_queue_is_empty(&conn
->secondary_list
)) {
709 pkt
= g_queue_pop_head(&conn
->secondary_list
);
710 packet_destroy(pkt
, NULL
);
714 static void colo_compare_class_init(ObjectClass
*oc
, void *data
)
716 UserCreatableClass
*ucc
= USER_CREATABLE_CLASS(oc
);
718 ucc
->complete
= colo_compare_complete
;
721 static void colo_compare_init(Object
*obj
)
723 object_property_add_str(obj
, "primary_in",
724 compare_get_pri_indev
, compare_set_pri_indev
,
726 object_property_add_str(obj
, "secondary_in",
727 compare_get_sec_indev
, compare_set_sec_indev
,
729 object_property_add_str(obj
, "outdev",
730 compare_get_outdev
, compare_set_outdev
,
734 static void colo_compare_finalize(Object
*obj
)
736 CompareState
*s
= COLO_COMPARE(obj
);
738 qemu_chr_fe_set_handlers(&s
->chr_pri_in
, NULL
, NULL
, NULL
, NULL
,
739 s
->worker_context
, true);
740 qemu_chr_fe_set_handlers(&s
->chr_sec_in
, NULL
, NULL
, NULL
, NULL
,
741 s
->worker_context
, true);
742 qemu_chr_fe_deinit(&s
->chr_out
);
744 g_main_loop_quit(s
->compare_loop
);
745 qemu_thread_join(&s
->thread
);
747 /* Release all unhandled packets after compare thead exited */
748 g_queue_foreach(&s
->conn_list
, colo_flush_packets
, s
);
750 g_queue_clear(&s
->conn_list
);
752 g_hash_table_destroy(s
->connection_track_table
);
753 g_free(s
->pri_indev
);
754 g_free(s
->sec_indev
);
758 static const TypeInfo colo_compare_info
= {
759 .name
= TYPE_COLO_COMPARE
,
760 .parent
= TYPE_OBJECT
,
761 .instance_size
= sizeof(CompareState
),
762 .instance_init
= colo_compare_init
,
763 .instance_finalize
= colo_compare_finalize
,
764 .class_size
= sizeof(CompareClass
),
765 .class_init
= colo_compare_class_init
,
766 .interfaces
= (InterfaceInfo
[]) {
767 { TYPE_USER_CREATABLE
},
772 static void register_types(void)
774 type_register_static(&colo_compare_info
);
777 type_init(register_types
);