1 // SPDX-License-Identifier: GPL-2.0-only
2 /******************************************************************************
3 *******************************************************************************
5 ** Copyright (C) Sistina Software, Inc. 1997-2003 All rights reserved.
6 ** Copyright (C) 2004-2021 Red Hat, Inc. All rights reserved.
9 *******************************************************************************
10 ******************************************************************************/
15 * This is the appallingly named "mid-level" comms layer. It takes care about
16 * deliver an on application layer "reliable" communication above the used
17 * lowcomms transport layer.
21 * Each nodes keeps track of all send DLM messages in send_queue with a sequence
22 * number. The receive will send an DLM_ACK message back for every DLM message
23 * received at the other side. If a reconnect happens in lowcomms we will send
24 * all unacknowledged dlm messages again. The receiving side might drop any already
25 * received message by comparing sequence numbers.
27 * How version detection works:
29 * Due the fact that dlm has pre-configured node addresses on every side
30 * it is in it's nature that every side connects at starts to transmit
31 * dlm messages which ends in a race. However DLM_RCOM_NAMES, DLM_RCOM_STATUS
32 * and their replies are the first messages which are exchanges. Due backwards
33 * compatibility these messages are not covered by the midcomms re-transmission
34 * layer. These messages have their own re-transmission handling in the dlm
35 * application layer. The version field of every node will be set on these RCOM
36 * messages as soon as they arrived and the node isn't yet part of the nodes
37 * hash. There exists also logic to detect version mismatched if something weird
38 * going on or the first messages isn't an expected one.
42 * The midcomms layer does a 4 way handshake for termination on DLM protocol
43 * like TCP supports it with half-closed socket support. SCTP doesn't support
44 * half-closed socket, so we do it on DLM layer. Also socket shutdown() can be
45 * interrupted by .e.g. tcp reset itself. Additional there exists the othercon
46 * paradigm in lowcomms which cannot be easily without breaking backwards
47 * compatibility. A node cannot send anything to another node when a DLM_FIN
48 * message was send. There exists additional logic to print a warning if
49 * DLM wants to do it. There exists a state handling like RFC 793 but reduced
50 * to termination only. The event "member removal event" describes the cluster
51 * manager removed the node from internal lists, at this point DLM does not
52 * send any message to the other node. There exists two cases:
54 * 1. The cluster member was removed and we received a FIN
56 * 2. We received a FIN but the member was not removed yet
58 * One of these cases will do the CLOSE_WAIT to LAST_ACK change.
64 * | add member/receive RCOM version
72 * +---------+ snd FIN / \ snd ACK +---------+
73 * | FIN |<----------------- ------------------>| CLOSE |
74 * | WAIT-1 |------------------ | WAIT |
75 * +---------+ rcv FIN \ +---------+
76 * | rcv ACK of FIN ------- | CLOSE | member
77 * | -------------- snd ACK | ------- | removal
78 * V x V snd FIN V event
79 * +---------+ +---------+ +---------+
80 * |FINWAIT-2| | CLOSING | | LAST-ACK|
81 * +---------+ +---------+ +---------+
82 * | rcv ACK of FIN | rcv ACK of FIN |
83 * | rcv FIN -------------- | -------------- |
85 * \ snd ACK +---------+ +---------+
86 * ------------------------>| CLOSED | | CLOSED |
87 * +---------+ +---------+
89 * NOTE: any state can interrupted by midcomms_close() and state will be
90 * switched to CLOSED in case of fencing. There exists also some timeout
91 * handling when we receive the version detection RCOM messages which is
92 * made by observation.
94 * Future improvements:
96 * There exists some known issues/improvements of the dlm handling. Some
97 * of them should be done in a next major dlm version bump which makes
98 * it incompatible with previous versions.
100 * Unaligned memory access:
102 * There exists cases when the dlm message buffer length is not aligned
103 * to 8 byte. However seems nobody detected any problem with it. This
104 * can be fixed in the next major version bump of dlm.
108 * The version detection and how it's done is related to backwards
109 * compatibility. There exists better ways to make a better handling.
110 * However this should be changed in the next major version bump of dlm.
112 * Tail Size checking:
114 * There exists a message tail payload in e.g. DLM_MSG however we don't
115 * check it against the message length yet regarding to the receive buffer
116 * length. That need to be validated.
120 * At timeout places or weird sequence number behaviours we should send
121 * a fencing request to the cluster manager.
124 /* Debug switch to enable a 5 seconds sleep waiting of a termination.
125 * This can be useful to test fencing while termination is running.
126 * This requires a setup with only gfs2 as dlm user, so that the
127 * last umount will terminate the connection.
129 * However it became useful to test, while the 5 seconds block in umount
130 * just press the reset button. In a lot of dropping the termination
131 * process can could take several seconds.
133 #define DLM_DEBUG_FENCE_TERMINATION 0
135 #include <trace/events/dlm.h>
138 #include "dlm_internal.h"
139 #include "lowcomms.h"
144 #include "midcomms.h"
146 /* init value for sequence numbers for testing purpose only e.g. overflows */
147 #define DLM_SEQ_INIT 0
148 /* 5 seconds wait to sync ending of dlm */
149 #define DLM_SHUTDOWN_TIMEOUT msecs_to_jiffies(5000)
150 #define DLM_VERSION_NOT_SET 0
151 #define DLM_SEND_ACK_BACK_MSG_THRESHOLD 32
152 #define DLM_RECV_ACK_BACK_MSG_THRESHOLD (DLM_SEND_ACK_BACK_MSG_THRESHOLD * 8)
154 struct midcomms_node {
159 /* These queues are unbound because we cannot drop any message in dlm.
160 * We could send a fence signal for a specific node to the cluster
161 * manager if queues hits some maximum value, however this handling
164 struct list_head send_queue;
165 spinlock_t send_queue_lock;
166 atomic_t send_queue_cnt;
167 #define DLM_NODE_FLAG_CLOSE 1
168 #define DLM_NODE_FLAG_STOP_TX 2
169 #define DLM_NODE_FLAG_STOP_RX 3
170 atomic_t ulp_delivered;
172 wait_queue_head_t shutdown_wait;
174 /* dlm tcp termination state */
176 #define DLM_ESTABLISHED 2
177 #define DLM_FIN_WAIT1 3
178 #define DLM_FIN_WAIT2 4
179 #define DLM_CLOSE_WAIT 5
180 #define DLM_LAST_ACK 6
181 #define DLM_CLOSING 7
183 spinlock_t state_lock;
185 /* counts how many lockspaces are using this node
186 * this refcount is necessary to determine if the
187 * node wants to disconnect.
191 /* not protected by srcu, node_hash lifetime */
194 struct hlist_node hlist;
199 const union dlm_packet *inner_p;
200 struct midcomms_node *node;
201 struct dlm_opts *opts;
206 void (*ack_rcv)(struct midcomms_node *node);
208 /* get_mhandle/commit srcu idx exchange */
211 struct list_head list;
215 static struct hlist_head node_hash[CONN_HASH_SIZE];
216 static DEFINE_SPINLOCK(nodes_lock);
217 DEFINE_STATIC_SRCU(nodes_srcu);
219 /* This mutex prevents that midcomms_close() is running while
220 * stop() or remove(). As I experienced invalid memory access
221 * behaviours when DLM_DEBUG_FENCE_TERMINATION is enabled and
222 * resetting machines. I will end in some double deletion in nodes
225 static DEFINE_MUTEX(close_lock);
227 struct kmem_cache *dlm_midcomms_cache_create(void)
229 return kmem_cache_create("dlm_mhandle", sizeof(struct dlm_mhandle),
233 static inline const char *dlm_state_str(int state)
238 case DLM_ESTABLISHED:
239 return "ESTABLISHED";
255 const char *dlm_midcomms_state(struct midcomms_node *node)
257 return dlm_state_str(node->state);
260 unsigned long dlm_midcomms_flags(struct midcomms_node *node)
265 int dlm_midcomms_send_queue_cnt(struct midcomms_node *node)
267 return atomic_read(&node->send_queue_cnt);
270 uint32_t dlm_midcomms_version(struct midcomms_node *node)
272 return node->version;
275 static struct midcomms_node *__find_node(int nodeid, int r)
277 struct midcomms_node *node;
279 hlist_for_each_entry_rcu(node, &node_hash[r], hlist) {
280 if (node->nodeid == nodeid)
287 static void dlm_mhandle_release(struct rcu_head *rcu)
289 struct dlm_mhandle *mh = container_of(rcu, struct dlm_mhandle, rcu);
291 dlm_lowcomms_put_msg(mh->msg);
292 dlm_free_mhandle(mh);
295 static void dlm_mhandle_delete(struct midcomms_node *node,
296 struct dlm_mhandle *mh)
298 list_del_rcu(&mh->list);
299 atomic_dec(&node->send_queue_cnt);
300 call_rcu(&mh->rcu, dlm_mhandle_release);
303 static void dlm_send_queue_flush(struct midcomms_node *node)
305 struct dlm_mhandle *mh;
307 pr_debug("flush midcomms send queue of node %d\n", node->nodeid);
310 spin_lock_bh(&node->send_queue_lock);
311 list_for_each_entry_rcu(mh, &node->send_queue, list) {
312 dlm_mhandle_delete(node, mh);
314 spin_unlock_bh(&node->send_queue_lock);
318 static void midcomms_node_reset(struct midcomms_node *node)
320 pr_debug("reset node %d\n", node->nodeid);
322 atomic_set(&node->seq_next, DLM_SEQ_INIT);
323 atomic_set(&node->seq_send, DLM_SEQ_INIT);
324 atomic_set(&node->ulp_delivered, 0);
325 node->version = DLM_VERSION_NOT_SET;
328 dlm_send_queue_flush(node);
329 node->state = DLM_CLOSED;
330 wake_up(&node->shutdown_wait);
333 static struct midcomms_node *nodeid2node(int nodeid, gfp_t alloc)
335 struct midcomms_node *node, *tmp;
336 int r = nodeid_hash(nodeid);
338 node = __find_node(nodeid, r);
342 node = kmalloc(sizeof(*node), alloc);
346 node->nodeid = nodeid;
347 spin_lock_init(&node->state_lock);
348 spin_lock_init(&node->send_queue_lock);
349 atomic_set(&node->send_queue_cnt, 0);
350 INIT_LIST_HEAD(&node->send_queue);
351 init_waitqueue_head(&node->shutdown_wait);
353 midcomms_node_reset(node);
355 spin_lock(&nodes_lock);
356 /* check again if there was somebody else
357 * earlier here to add the node
359 tmp = __find_node(nodeid, r);
361 spin_unlock(&nodes_lock);
366 hlist_add_head_rcu(&node->hlist, &node_hash[r]);
367 spin_unlock(&nodes_lock);
369 node->debugfs = dlm_create_debug_comms_file(nodeid, node);
373 static int dlm_send_ack(int nodeid, uint32_t seq)
375 int mb_len = sizeof(struct dlm_header);
376 struct dlm_header *m_header;
380 msg = dlm_lowcomms_new_msg(nodeid, mb_len, GFP_ATOMIC, &ppc,
385 m_header = (struct dlm_header *)ppc;
387 m_header->h_version = cpu_to_le32(DLM_HEADER_MAJOR | DLM_HEADER_MINOR);
388 m_header->h_nodeid = cpu_to_le32(dlm_our_nodeid());
389 m_header->h_length = cpu_to_le16(mb_len);
390 m_header->h_cmd = DLM_ACK;
391 m_header->u.h_seq = cpu_to_le32(seq);
393 dlm_lowcomms_commit_msg(msg);
394 dlm_lowcomms_put_msg(msg);
399 static void dlm_send_ack_threshold(struct midcomms_node *node,
405 /* let only send one user trigger threshold to send ack back */
407 oval = atomic_read(&node->ulp_delivered);
408 send_ack = (oval > threshold);
409 /* abort if threshold is not reached */
414 /* try to reset ulp_delivered counter */
415 } while (atomic_cmpxchg(&node->ulp_delivered, oval, nval) != oval);
418 dlm_send_ack(node->nodeid, atomic_read(&node->seq_next));
421 static int dlm_send_fin(struct midcomms_node *node,
422 void (*ack_rcv)(struct midcomms_node *node))
424 int mb_len = sizeof(struct dlm_header);
425 struct dlm_header *m_header;
426 struct dlm_mhandle *mh;
429 mh = dlm_midcomms_get_mhandle(node->nodeid, mb_len, GFP_ATOMIC, &ppc);
433 set_bit(DLM_NODE_FLAG_STOP_TX, &node->flags);
434 mh->ack_rcv = ack_rcv;
436 m_header = (struct dlm_header *)ppc;
438 m_header->h_version = cpu_to_le32(DLM_HEADER_MAJOR | DLM_HEADER_MINOR);
439 m_header->h_nodeid = cpu_to_le32(dlm_our_nodeid());
440 m_header->h_length = cpu_to_le16(mb_len);
441 m_header->h_cmd = DLM_FIN;
443 pr_debug("sending fin msg to node %d\n", node->nodeid);
444 dlm_midcomms_commit_mhandle(mh, NULL, 0);
449 static void dlm_receive_ack(struct midcomms_node *node, uint32_t seq)
451 struct dlm_mhandle *mh;
454 list_for_each_entry_rcu(mh, &node->send_queue, list) {
455 if (before(mh->seq, seq)) {
459 /* send queue should be ordered */
464 spin_lock_bh(&node->send_queue_lock);
465 list_for_each_entry_rcu(mh, &node->send_queue, list) {
466 if (before(mh->seq, seq)) {
467 dlm_mhandle_delete(node, mh);
469 /* send queue should be ordered */
473 spin_unlock_bh(&node->send_queue_lock);
477 static void dlm_pas_fin_ack_rcv(struct midcomms_node *node)
479 spin_lock(&node->state_lock);
480 pr_debug("receive passive fin ack from node %d with state %s\n",
481 node->nodeid, dlm_state_str(node->state));
483 switch (node->state) {
486 midcomms_node_reset(node);
489 /* not valid but somehow we got what we want */
490 wake_up(&node->shutdown_wait);
493 spin_unlock(&node->state_lock);
494 log_print("%s: unexpected state: %d",
495 __func__, node->state);
499 spin_unlock(&node->state_lock);
502 static void dlm_receive_buffer_3_2_trace(uint32_t seq, union dlm_packet *p)
504 switch (p->header.h_cmd) {
506 trace_dlm_recv_message(dlm_our_nodeid(), seq, &p->message);
509 trace_dlm_recv_rcom(dlm_our_nodeid(), seq, &p->rcom);
516 static void dlm_midcomms_receive_buffer(union dlm_packet *p,
517 struct midcomms_node *node,
520 bool is_expected_seq;
524 oval = atomic_read(&node->seq_next);
525 is_expected_seq = (oval == seq);
526 if (!is_expected_seq)
530 } while (atomic_cmpxchg(&node->seq_next, oval, nval) != oval);
532 if (is_expected_seq) {
533 switch (p->header.h_cmd) {
535 spin_lock(&node->state_lock);
536 pr_debug("receive fin msg from node %d with state %s\n",
537 node->nodeid, dlm_state_str(node->state));
539 switch (node->state) {
540 case DLM_ESTABLISHED:
541 dlm_send_ack(node->nodeid, nval);
543 /* passive shutdown DLM_LAST_ACK case 1
544 * additional we check if the node is used by
545 * cluster manager events at all.
547 if (node->users == 0) {
548 node->state = DLM_LAST_ACK;
549 pr_debug("switch node %d to state %s case 1\n",
550 node->nodeid, dlm_state_str(node->state));
551 set_bit(DLM_NODE_FLAG_STOP_RX, &node->flags);
552 dlm_send_fin(node, dlm_pas_fin_ack_rcv);
554 node->state = DLM_CLOSE_WAIT;
555 pr_debug("switch node %d to state %s\n",
556 node->nodeid, dlm_state_str(node->state));
560 dlm_send_ack(node->nodeid, nval);
561 node->state = DLM_CLOSING;
562 set_bit(DLM_NODE_FLAG_STOP_RX, &node->flags);
563 pr_debug("switch node %d to state %s\n",
564 node->nodeid, dlm_state_str(node->state));
567 dlm_send_ack(node->nodeid, nval);
568 midcomms_node_reset(node);
569 pr_debug("switch node %d to state %s\n",
570 node->nodeid, dlm_state_str(node->state));
573 /* probably remove_member caught it, do nothing */
576 spin_unlock(&node->state_lock);
577 log_print("%s: unexpected state: %d",
578 __func__, node->state);
582 spin_unlock(&node->state_lock);
585 WARN_ON_ONCE(test_bit(DLM_NODE_FLAG_STOP_RX, &node->flags));
586 dlm_receive_buffer_3_2_trace(seq, p);
587 dlm_receive_buffer(p, node->nodeid);
588 atomic_inc(&node->ulp_delivered);
589 /* unlikely case to send ack back when we don't transmit */
590 dlm_send_ack_threshold(node, DLM_RECV_ACK_BACK_MSG_THRESHOLD);
594 /* retry to ack message which we already have by sending back
595 * current node->seq_next number as ack.
598 dlm_send_ack(node->nodeid, oval);
600 log_print_ratelimited("ignore dlm msg because seq mismatch, seq: %u, expected: %u, nodeid: %d",
601 seq, oval, node->nodeid);
605 static struct midcomms_node *
606 dlm_midcomms_recv_node_lookup(int nodeid, const union dlm_packet *p,
607 uint16_t msglen, int (*cb)(struct midcomms_node *node))
609 struct midcomms_node *node = NULL;
610 gfp_t allocation = 0;
613 switch (p->header.h_cmd) {
615 if (msglen < sizeof(struct dlm_rcom)) {
616 log_print("rcom msg too small: %u, will skip this message from node %d",
621 switch (p->rcom.rc_type) {
622 case cpu_to_le32(DLM_RCOM_NAMES):
624 case cpu_to_le32(DLM_RCOM_NAMES_REPLY):
626 case cpu_to_le32(DLM_RCOM_STATUS):
628 case cpu_to_le32(DLM_RCOM_STATUS_REPLY):
629 node = nodeid2node(nodeid, 0);
631 spin_lock(&node->state_lock);
632 if (node->state != DLM_ESTABLISHED)
633 pr_debug("receive begin RCOM msg from node %d with state %s\n",
634 node->nodeid, dlm_state_str(node->state));
636 switch (node->state) {
638 node->state = DLM_ESTABLISHED;
639 pr_debug("switch node %d to state %s\n",
640 node->nodeid, dlm_state_str(node->state));
642 case DLM_ESTABLISHED:
645 spin_unlock(&node->state_lock);
648 spin_unlock(&node->state_lock);
651 allocation = GFP_NOFS;
662 node = nodeid2node(nodeid, allocation);
664 switch (p->header.h_cmd) {
666 if (msglen < sizeof(struct dlm_opts)) {
667 log_print("opts msg too small: %u, will skip this message from node %d",
672 log_print_ratelimited("received dlm opts message nextcmd %d from node %d in an invalid sequence",
673 p->opts.o_nextcmd, nodeid);
676 log_print_ratelimited("received dlm message cmd %d from node %d in an invalid sequence",
677 p->header.h_cmd, nodeid);
691 static int dlm_midcomms_version_check_3_2(struct midcomms_node *node)
693 switch (node->version) {
694 case DLM_VERSION_NOT_SET:
695 node->version = DLM_VERSION_3_2;
696 wake_up(&node->shutdown_wait);
697 log_print("version 0x%08x for node %d detected", DLM_VERSION_3_2,
700 case DLM_VERSION_3_2:
703 log_print_ratelimited("version mismatch detected, assumed 0x%08x but node %d has 0x%08x",
704 DLM_VERSION_3_2, node->nodeid, node->version);
711 static int dlm_opts_check_msglen(union dlm_packet *p, uint16_t msglen, int nodeid)
715 /* we only trust outer header msglen because
716 * it's checked against receive buffer length.
718 if (len < sizeof(struct dlm_opts))
720 len -= sizeof(struct dlm_opts);
722 if (len < le16_to_cpu(p->opts.o_optlen))
724 len -= le16_to_cpu(p->opts.o_optlen);
726 switch (p->opts.o_nextcmd) {
728 if (len < sizeof(struct dlm_header)) {
729 log_print("fin too small: %d, will skip this message from node %d",
736 if (len < sizeof(struct dlm_message)) {
737 log_print("msg too small: %d, will skip this message from node %d",
744 if (len < sizeof(struct dlm_rcom)) {
745 log_print("rcom msg too small: %d, will skip this message from node %d",
752 log_print("unsupported o_nextcmd received: %u, will skip this message from node %d",
753 p->opts.o_nextcmd, nodeid);
760 static void dlm_midcomms_receive_buffer_3_2(union dlm_packet *p, int nodeid)
762 uint16_t msglen = le16_to_cpu(p->header.h_length);
763 struct midcomms_node *node;
767 idx = srcu_read_lock(&nodes_srcu);
768 node = dlm_midcomms_recv_node_lookup(nodeid, p, msglen,
769 dlm_midcomms_version_check_3_2);
773 switch (p->header.h_cmd) {
775 /* these rcom message we use to determine version.
776 * they have their own retransmission handling and
777 * are the first messages of dlm.
779 * length already checked.
781 switch (p->rcom.rc_type) {
782 case cpu_to_le32(DLM_RCOM_NAMES):
784 case cpu_to_le32(DLM_RCOM_NAMES_REPLY):
786 case cpu_to_le32(DLM_RCOM_STATUS):
788 case cpu_to_le32(DLM_RCOM_STATUS_REPLY):
791 log_print("unsupported rcom type received: %u, will skip this message from node %d",
792 le32_to_cpu(p->rcom.rc_type), nodeid);
796 WARN_ON_ONCE(test_bit(DLM_NODE_FLAG_STOP_RX, &node->flags));
797 dlm_receive_buffer(p, nodeid);
800 seq = le32_to_cpu(p->header.u.h_seq);
802 ret = dlm_opts_check_msglen(p, msglen, nodeid);
804 log_print("opts msg too small: %u, will skip this message from node %d",
809 p = (union dlm_packet *)((unsigned char *)p->opts.o_opts +
810 le16_to_cpu(p->opts.o_optlen));
812 /* recheck inner msglen just if it's not garbage */
813 msglen = le16_to_cpu(p->header.h_length);
814 switch (p->header.h_cmd) {
816 if (msglen < sizeof(struct dlm_rcom)) {
817 log_print("inner rcom msg too small: %u, will skip this message from node %d",
824 if (msglen < sizeof(struct dlm_message)) {
825 log_print("inner msg too small: %u, will skip this message from node %d",
832 if (msglen < sizeof(struct dlm_header)) {
833 log_print("inner fin too small: %u, will skip this message from node %d",
840 log_print("unsupported inner h_cmd received: %u, will skip this message from node %d",
845 dlm_midcomms_receive_buffer(p, node, seq);
848 seq = le32_to_cpu(p->header.u.h_seq);
849 dlm_receive_ack(node, seq);
852 log_print("unsupported h_cmd received: %u, will skip this message from node %d",
853 p->header.h_cmd, nodeid);
858 srcu_read_unlock(&nodes_srcu, idx);
861 static int dlm_midcomms_version_check_3_1(struct midcomms_node *node)
863 switch (node->version) {
864 case DLM_VERSION_NOT_SET:
865 node->version = DLM_VERSION_3_1;
866 wake_up(&node->shutdown_wait);
867 log_print("version 0x%08x for node %d detected", DLM_VERSION_3_1,
870 case DLM_VERSION_3_1:
873 log_print_ratelimited("version mismatch detected, assumed 0x%08x but node %d has 0x%08x",
874 DLM_VERSION_3_1, node->nodeid, node->version);
881 static void dlm_midcomms_receive_buffer_3_1(union dlm_packet *p, int nodeid)
883 uint16_t msglen = le16_to_cpu(p->header.h_length);
884 struct midcomms_node *node;
887 idx = srcu_read_lock(&nodes_srcu);
888 node = dlm_midcomms_recv_node_lookup(nodeid, p, msglen,
889 dlm_midcomms_version_check_3_1);
891 srcu_read_unlock(&nodes_srcu, idx);
894 srcu_read_unlock(&nodes_srcu, idx);
896 switch (p->header.h_cmd) {
898 /* length already checked */
901 if (msglen < sizeof(struct dlm_message)) {
902 log_print("msg too small: %u, will skip this message from node %d",
909 log_print("unsupported h_cmd received: %u, will skip this message from node %d",
910 p->header.h_cmd, nodeid);
914 dlm_receive_buffer(p, nodeid);
917 int dlm_validate_incoming_buffer(int nodeid, unsigned char *buf, int len)
919 const unsigned char *ptr = buf;
920 const struct dlm_header *hd;
924 while (len >= sizeof(struct dlm_header)) {
925 hd = (struct dlm_header *)ptr;
927 /* no message should be more than DLM_MAX_SOCKET_BUFSIZE or
928 * less than dlm_header size.
930 * Some messages does not have a 8 byte length boundary yet
931 * which can occur in a unaligned memory access of some dlm
932 * messages. However this problem need to be fixed at the
933 * sending side, for now it seems nobody run into architecture
934 * related issues yet but it slows down some processing.
935 * Fixing this issue should be scheduled in future by doing
936 * the next major version bump.
938 msglen = le16_to_cpu(hd->h_length);
939 if (msglen > DLM_MAX_SOCKET_BUFSIZE ||
940 msglen < sizeof(struct dlm_header)) {
941 log_print("received invalid length header: %u from node %d, will abort message parsing",
946 /* caller will take care that leftover
947 * will be parsed next call with more data
961 * Called from the low-level comms layer to process a buffer of
964 int dlm_process_incoming_buffer(int nodeid, unsigned char *buf, int len)
966 const unsigned char *ptr = buf;
967 const struct dlm_header *hd;
971 while (len >= sizeof(struct dlm_header)) {
972 hd = (struct dlm_header *)ptr;
974 msglen = le16_to_cpu(hd->h_length);
978 switch (hd->h_version) {
979 case cpu_to_le32(DLM_VERSION_3_1):
980 dlm_midcomms_receive_buffer_3_1((union dlm_packet *)ptr, nodeid);
982 case cpu_to_le32(DLM_VERSION_3_2):
983 dlm_midcomms_receive_buffer_3_2((union dlm_packet *)ptr, nodeid);
986 log_print("received invalid version header: %u from node %d, will skip this message",
987 le32_to_cpu(hd->h_version), nodeid);
999 void dlm_midcomms_unack_msg_resend(int nodeid)
1001 struct midcomms_node *node;
1002 struct dlm_mhandle *mh;
1005 idx = srcu_read_lock(&nodes_srcu);
1006 node = nodeid2node(nodeid, 0);
1008 srcu_read_unlock(&nodes_srcu, idx);
1012 /* old protocol, we don't support to retransmit on failure */
1013 switch (node->version) {
1014 case DLM_VERSION_3_2:
1017 srcu_read_unlock(&nodes_srcu, idx);
1022 list_for_each_entry_rcu(mh, &node->send_queue, list) {
1026 ret = dlm_lowcomms_resend_msg(mh->msg);
1028 log_print_ratelimited("retransmit dlm msg, seq %u, nodeid %d",
1029 mh->seq, node->nodeid);
1032 srcu_read_unlock(&nodes_srcu, idx);
1035 static void dlm_fill_opts_header(struct dlm_opts *opts, uint16_t inner_len,
1038 opts->o_header.h_cmd = DLM_OPTS;
1039 opts->o_header.h_version = cpu_to_le32(DLM_HEADER_MAJOR | DLM_HEADER_MINOR);
1040 opts->o_header.h_nodeid = cpu_to_le32(dlm_our_nodeid());
1041 opts->o_header.h_length = cpu_to_le16(DLM_MIDCOMMS_OPT_LEN + inner_len);
1042 opts->o_header.u.h_seq = cpu_to_le32(seq);
1045 static void midcomms_new_msg_cb(void *data)
1047 struct dlm_mhandle *mh = data;
1049 atomic_inc(&mh->node->send_queue_cnt);
1051 spin_lock_bh(&mh->node->send_queue_lock);
1052 list_add_tail_rcu(&mh->list, &mh->node->send_queue);
1053 spin_unlock_bh(&mh->node->send_queue_lock);
1055 mh->seq = atomic_fetch_inc(&mh->node->seq_send);
1058 static struct dlm_msg *dlm_midcomms_get_msg_3_2(struct dlm_mhandle *mh, int nodeid,
1059 int len, gfp_t allocation, char **ppc)
1061 struct dlm_opts *opts;
1062 struct dlm_msg *msg;
1064 msg = dlm_lowcomms_new_msg(nodeid, len + DLM_MIDCOMMS_OPT_LEN,
1065 allocation, ppc, midcomms_new_msg_cb, mh);
1069 opts = (struct dlm_opts *)*ppc;
1072 /* add possible options here */
1073 dlm_fill_opts_header(opts, len, mh->seq);
1075 *ppc += sizeof(*opts);
1076 mh->inner_p = (const union dlm_packet *)*ppc;
1080 /* avoid false positive for nodes_srcu, unlock happens in
1081 * dlm_midcomms_commit_mhandle which is a must call if success
1084 struct dlm_mhandle *dlm_midcomms_get_mhandle(int nodeid, int len,
1085 gfp_t allocation, char **ppc)
1087 struct midcomms_node *node;
1088 struct dlm_mhandle *mh;
1089 struct dlm_msg *msg;
1092 idx = srcu_read_lock(&nodes_srcu);
1093 node = nodeid2node(nodeid, 0);
1099 /* this is a bug, however we going on and hope it will be resolved */
1100 WARN_ON_ONCE(test_bit(DLM_NODE_FLAG_STOP_TX, &node->flags));
1102 mh = dlm_allocate_mhandle(allocation);
1106 mh->committed = false;
1111 switch (node->version) {
1112 case DLM_VERSION_3_1:
1113 msg = dlm_lowcomms_new_msg(nodeid, len, allocation, ppc,
1116 dlm_free_mhandle(mh);
1121 case DLM_VERSION_3_2:
1122 msg = dlm_midcomms_get_msg_3_2(mh, nodeid, len, allocation,
1125 dlm_free_mhandle(mh);
1129 /* send ack back if necessary */
1130 dlm_send_ack_threshold(node, DLM_SEND_ACK_BACK_MSG_THRESHOLD);
1133 dlm_free_mhandle(mh);
1140 /* keep in mind that is a must to call
1141 * dlm_midcomms_commit_msg() which releases
1142 * nodes_srcu using mh->idx which is assumed
1143 * here that the application will call it.
1148 srcu_read_unlock(&nodes_srcu, idx);
1153 static void dlm_midcomms_commit_msg_3_2_trace(const struct dlm_mhandle *mh,
1154 const void *name, int namelen)
1156 switch (mh->inner_p->header.h_cmd) {
1158 trace_dlm_send_message(mh->node->nodeid, mh->seq,
1159 &mh->inner_p->message,
1163 trace_dlm_send_rcom(mh->node->nodeid, mh->seq,
1164 &mh->inner_p->rcom);
1167 /* nothing to trace */
1172 static void dlm_midcomms_commit_msg_3_2(struct dlm_mhandle *mh,
1173 const void *name, int namelen)
1175 /* nexthdr chain for fast lookup */
1176 mh->opts->o_nextcmd = mh->inner_p->header.h_cmd;
1177 mh->committed = true;
1178 dlm_midcomms_commit_msg_3_2_trace(mh, name, namelen);
1179 dlm_lowcomms_commit_msg(mh->msg);
1182 /* avoid false positive for nodes_srcu, lock was happen in
1183 * dlm_midcomms_get_mhandle
1186 void dlm_midcomms_commit_mhandle(struct dlm_mhandle *mh,
1187 const void *name, int namelen)
1190 switch (mh->node->version) {
1191 case DLM_VERSION_3_1:
1192 srcu_read_unlock(&nodes_srcu, mh->idx);
1194 dlm_lowcomms_commit_msg(mh->msg);
1195 dlm_lowcomms_put_msg(mh->msg);
1196 /* mh is not part of rcu list in this case */
1197 dlm_free_mhandle(mh);
1199 case DLM_VERSION_3_2:
1200 /* held rcu read lock here, because we sending the
1201 * dlm message out, when we do that we could receive
1202 * an ack back which releases the mhandle and we
1203 * get a use after free.
1206 dlm_midcomms_commit_msg_3_2(mh, name, namelen);
1207 srcu_read_unlock(&nodes_srcu, mh->idx);
1211 srcu_read_unlock(&nodes_srcu, mh->idx);
1218 int dlm_midcomms_start(void)
1220 return dlm_lowcomms_start();
1223 void dlm_midcomms_stop(void)
1225 dlm_lowcomms_stop();
1228 void dlm_midcomms_init(void)
1232 for (i = 0; i < CONN_HASH_SIZE; i++)
1233 INIT_HLIST_HEAD(&node_hash[i]);
1235 dlm_lowcomms_init();
1238 void dlm_midcomms_exit(void)
1240 dlm_lowcomms_exit();
1243 static void dlm_act_fin_ack_rcv(struct midcomms_node *node)
1245 spin_lock(&node->state_lock);
1246 pr_debug("receive active fin ack from node %d with state %s\n",
1247 node->nodeid, dlm_state_str(node->state));
1249 switch (node->state) {
1251 node->state = DLM_FIN_WAIT2;
1252 pr_debug("switch node %d to state %s\n",
1253 node->nodeid, dlm_state_str(node->state));
1256 midcomms_node_reset(node);
1257 pr_debug("switch node %d to state %s\n",
1258 node->nodeid, dlm_state_str(node->state));
1261 /* not valid but somehow we got what we want */
1262 wake_up(&node->shutdown_wait);
1265 spin_unlock(&node->state_lock);
1266 log_print("%s: unexpected state: %d",
1267 __func__, node->state);
1271 spin_unlock(&node->state_lock);
1274 void dlm_midcomms_add_member(int nodeid)
1276 struct midcomms_node *node;
1279 idx = srcu_read_lock(&nodes_srcu);
1280 node = nodeid2node(nodeid, GFP_NOFS);
1282 srcu_read_unlock(&nodes_srcu, idx);
1286 spin_lock(&node->state_lock);
1288 pr_debug("receive add member from node %d with state %s\n",
1289 node->nodeid, dlm_state_str(node->state));
1290 switch (node->state) {
1291 case DLM_ESTABLISHED:
1294 node->state = DLM_ESTABLISHED;
1295 pr_debug("switch node %d to state %s\n",
1296 node->nodeid, dlm_state_str(node->state));
1299 /* some invalid state passive shutdown
1300 * was failed, we try to reset and
1301 * hope it will go on.
1303 log_print("reset node %d because shutdown stuck",
1306 midcomms_node_reset(node);
1307 node->state = DLM_ESTABLISHED;
1313 pr_debug("node %d users inc count %d\n", nodeid, node->users);
1314 spin_unlock(&node->state_lock);
1316 srcu_read_unlock(&nodes_srcu, idx);
1319 void dlm_midcomms_remove_member(int nodeid)
1321 struct midcomms_node *node;
1324 idx = srcu_read_lock(&nodes_srcu);
1325 node = nodeid2node(nodeid, 0);
1327 srcu_read_unlock(&nodes_srcu, idx);
1331 spin_lock(&node->state_lock);
1333 pr_debug("node %d users dec count %d\n", nodeid, node->users);
1335 /* hitting users count to zero means the
1336 * other side is running dlm_midcomms_stop()
1337 * we meet us to have a clean disconnect.
1339 if (node->users == 0) {
1340 pr_debug("receive remove member from node %d with state %s\n",
1341 node->nodeid, dlm_state_str(node->state));
1342 switch (node->state) {
1343 case DLM_ESTABLISHED:
1345 case DLM_CLOSE_WAIT:
1346 /* passive shutdown DLM_LAST_ACK case 2 */
1347 node->state = DLM_LAST_ACK;
1348 pr_debug("switch node %d to state %s case 2\n",
1349 node->nodeid, dlm_state_str(node->state));
1350 set_bit(DLM_NODE_FLAG_STOP_RX, &node->flags);
1351 dlm_send_fin(node, dlm_pas_fin_ack_rcv);
1354 /* probably receive fin caught it, do nothing */
1357 /* already gone, do nothing */
1360 log_print("%s: unexpected state: %d",
1361 __func__, node->state);
1365 spin_unlock(&node->state_lock);
1367 srcu_read_unlock(&nodes_srcu, idx);
1370 static void midcomms_node_release(struct rcu_head *rcu)
1372 struct midcomms_node *node = container_of(rcu, struct midcomms_node, rcu);
1374 WARN_ON_ONCE(atomic_read(&node->send_queue_cnt));
1375 dlm_send_queue_flush(node);
1379 void dlm_midcomms_version_wait(void)
1381 struct midcomms_node *node;
1384 idx = srcu_read_lock(&nodes_srcu);
1385 for (i = 0; i < CONN_HASH_SIZE; i++) {
1386 hlist_for_each_entry_rcu(node, &node_hash[i], hlist) {
1387 ret = wait_event_timeout(node->shutdown_wait,
1388 node->version != DLM_VERSION_NOT_SET ||
1389 node->state == DLM_CLOSED ||
1390 test_bit(DLM_NODE_FLAG_CLOSE, &node->flags),
1391 DLM_SHUTDOWN_TIMEOUT);
1392 if (!ret || test_bit(DLM_NODE_FLAG_CLOSE, &node->flags))
1393 pr_debug("version wait timed out for node %d with state %s\n",
1394 node->nodeid, dlm_state_str(node->state));
1397 srcu_read_unlock(&nodes_srcu, idx);
1400 static void midcomms_shutdown(struct midcomms_node *node)
1404 /* old protocol, we don't wait for pending operations */
1405 switch (node->version) {
1406 case DLM_VERSION_3_2:
1412 spin_lock(&node->state_lock);
1413 pr_debug("receive active shutdown for node %d with state %s\n",
1414 node->nodeid, dlm_state_str(node->state));
1415 switch (node->state) {
1416 case DLM_ESTABLISHED:
1417 node->state = DLM_FIN_WAIT1;
1418 pr_debug("switch node %d to state %s case 2\n",
1419 node->nodeid, dlm_state_str(node->state));
1420 dlm_send_fin(node, dlm_act_fin_ack_rcv);
1423 /* we have what we want */
1426 /* busy to enter DLM_FIN_WAIT1, wait until passive
1427 * done in shutdown_wait to enter DLM_CLOSED.
1431 spin_unlock(&node->state_lock);
1433 if (DLM_DEBUG_FENCE_TERMINATION)
1436 /* wait for other side dlm + fin */
1437 ret = wait_event_timeout(node->shutdown_wait,
1438 node->state == DLM_CLOSED ||
1439 test_bit(DLM_NODE_FLAG_CLOSE, &node->flags),
1440 DLM_SHUTDOWN_TIMEOUT);
1441 if (!ret || test_bit(DLM_NODE_FLAG_CLOSE, &node->flags))
1442 pr_debug("active shutdown timed out for node %d with state %s\n",
1443 node->nodeid, dlm_state_str(node->state));
1445 pr_debug("active shutdown done for node %d with state %s\n",
1446 node->nodeid, dlm_state_str(node->state));
1449 void dlm_midcomms_shutdown(void)
1451 struct midcomms_node *node;
1454 mutex_lock(&close_lock);
1455 idx = srcu_read_lock(&nodes_srcu);
1456 for (i = 0; i < CONN_HASH_SIZE; i++) {
1457 hlist_for_each_entry_rcu(node, &node_hash[i], hlist) {
1458 midcomms_shutdown(node);
1460 dlm_delete_debug_comms_file(node->debugfs);
1462 spin_lock(&nodes_lock);
1463 hlist_del_rcu(&node->hlist);
1464 spin_unlock(&nodes_lock);
1466 call_srcu(&nodes_srcu, &node->rcu, midcomms_node_release);
1469 srcu_read_unlock(&nodes_srcu, idx);
1470 mutex_unlock(&close_lock);
1472 dlm_lowcomms_shutdown();
1475 int dlm_midcomms_close(int nodeid)
1477 struct midcomms_node *node;
1480 idx = srcu_read_lock(&nodes_srcu);
1481 /* Abort pending close/remove operation */
1482 node = nodeid2node(nodeid, 0);
1484 /* let shutdown waiters leave */
1485 set_bit(DLM_NODE_FLAG_CLOSE, &node->flags);
1486 wake_up(&node->shutdown_wait);
1488 srcu_read_unlock(&nodes_srcu, idx);
1490 synchronize_srcu(&nodes_srcu);
1492 idx = srcu_read_lock(&nodes_srcu);
1493 mutex_lock(&close_lock);
1494 node = nodeid2node(nodeid, 0);
1496 mutex_unlock(&close_lock);
1497 srcu_read_unlock(&nodes_srcu, idx);
1498 return dlm_lowcomms_close(nodeid);
1501 ret = dlm_lowcomms_close(nodeid);
1502 spin_lock(&node->state_lock);
1503 midcomms_node_reset(node);
1504 spin_unlock(&node->state_lock);
1505 srcu_read_unlock(&nodes_srcu, idx);
1506 mutex_unlock(&close_lock);
1511 /* debug functionality to send raw dlm msg from user space */
1512 struct dlm_rawmsg_data {
1513 struct midcomms_node *node;
1517 static void midcomms_new_rawmsg_cb(void *data)
1519 struct dlm_rawmsg_data *rd = data;
1520 struct dlm_header *h = rd->buf;
1522 switch (h->h_version) {
1523 case cpu_to_le32(DLM_VERSION_3_1):
1529 h->u.h_seq = cpu_to_le32(atomic_fetch_inc(&rd->node->seq_send));
1538 int dlm_midcomms_rawmsg_send(struct midcomms_node *node, void *buf,
1541 struct dlm_rawmsg_data rd;
1542 struct dlm_msg *msg;
1548 msg = dlm_lowcomms_new_msg(node->nodeid, buflen, GFP_NOFS,
1549 &msgbuf, midcomms_new_rawmsg_cb, &rd);
1553 memcpy(msgbuf, buf, buflen);
1554 dlm_lowcomms_commit_msg(msg);