hammer2 - wire up msg transaction state machine

[dragonfly.git] / sys / vfs / hammer2 / hammer2_msg.c

/*-
 * Copyright (c) 2012 The DragonFly Project.  All rights reserved.
 *
 * This code is derived from software contributed to The DragonFly Project
 * by Matthew Dillon <dillon@backplane.com>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 3. Neither the name of The DragonFly Project nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific, prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#include "hammer2.h"

/*
 * Process state tracking for a message after reception, prior to
 * execution.
 *
 * Called with msglk held and the msg dequeued.
 *
 * All messages are called with dummy state and return actual state.
 * (One-off messages often just return the same dummy state).
 *
 * May request that caller discard the message by setting *discardp to 1.
 * The returned state is not used in this case and is allowed to be NULL.
 *
 * --
 *
 * These routines handle persistent and command/reply message state via the
 * CREATE and DELETE flags.  The first message in a command or reply sequence
 * sets CREATE, the last message in a command or reply sequence sets DELETE.
 *
 * There can be any number of intermediate messages belonging to the same
 * sequence sent inbetween the CREATE message and the DELETE message,
 * which set neither flag.  This represents a streaming command or reply.
 *
 * Any command message received with CREATE set expects a reply sequence to
 * be returned.  Reply sequences work the same as command sequences except the
 * REPLY bit is also sent.  Both the command side and reply side can
 * degenerate into a single message with both CREATE and DELETE set.  Note
 * that one side can be streaming and the other side not, or neither, or both.
 *
 * The msgid is unique for the initiator.  That is, two sides sending a new
 * message can use the same msgid without colliding.
 *
 * --
 *
 * ABORT sequences work by setting the ABORT flag along with normal message
 * state.  However, ABORTs can also be sent on half-closed messages, that is
 * even if the command or reply side has already sent a DELETE, as long as
 * the message has not been fully closed it can still send an ABORT+DELETE
 * to terminate the half-closed message state.
 *
 * Since ABORT+DELETEs can race we silently discard ABORT's for message
 * state which has already been fully closed.  REPLY+ABORT+DELETEs can
 * also race, and in this situation the other side might have already
 * initiated a new unrelated command with the same message id.  Since
 * the abort has not set the CREATE flag the situation can be detected
 * and the message will also be discarded.
 *
 * Non-blocking requests can be initiated with ABORT+CREATE[+DELETE].
 * The ABORT request is essentially integrated into the command instead
 * of being sent later on.  In this situation the command implementation
 * detects that CREATE and ABORT are both set (vs ABORT alone) and can
 * special-case non-blocking operation for the command.
 *
 * NOTE!  Messages with ABORT set without CREATE or DELETE are considered
 *	  to be mid-stream aborts for command/reply sequences.  ABORTs on
 *	  one-way messages are not supported.
 *
 * NOTE!  If a command sequence does not support aborts the ABORT flag is
 *	  simply ignored.
 *
 * --
 *
 * One-off messages (no reply expected) are sent with neither CREATE or DELETE
 * set.  One-off messages cannot be aborted and typically aren't processed
 * by these routines.  The REPLY bit can be used to distinguish whether a
 * one-off message is a command or reply.  For example, one-off replies
 * will typically just contain status updates.
 */
int
hammer2_state_msgrx(hammer2_pfsmount_t *pmp, hammer2_msg_t *msg)
{
	hammer2_state_t *state;
	int error;

	/*
	 * Make sure a state structure is ready to go in case we need a new
	 * one.  This is the only routine which uses freerd_state so no
	 * races are possible.
	 */
	if ((state = pmp->freerd_state) == NULL) {
		state = kmalloc(sizeof(*state), pmp->mmsg, M_WAITOK | M_ZERO);
		state->pmp = pmp;
		state->flags = HAMMER2_STATE_DYNAMIC;
		pmp->freerd_state = state;
	}

	/*
	 * Lock RB tree and locate existing persistent state, if any.
	 *
	 * If received msg is a command state is on staterd_tree.
	 * If received msg is a reply state is on statewr_tree.
	 */
	lockmgr(&pmp->msglk, LK_EXCLUSIVE);

	state->msgid = msg->any.head.msgid;
	if (msg->any.head.cmd & HAMMER2_MSGF_REPLY)
		state = RB_FIND(hammer2_state_tree, &pmp->statewr_tree, state);
	else
		state = RB_FIND(hammer2_state_tree, &pmp->staterd_tree, state);
	msg->state = state;

	/*
	 * Short-cut one-off or mid-stream messages (state may be NULL).
	 */
	if ((msg->any.head.cmd & (HAMMER2_MSGF_CREATE | HAMMER2_MSGF_DELETE |
				  HAMMER2_MSGF_ABORT)) == 0) {
		lockmgr(&pmp->msglk, LK_RELEASE);
		return(0);
	}

	/*
	 * Switch on CREATE, DELETE, REPLY, and also handle ABORT from
	 * inside the case statements.
	 */
	switch(msg->any.head.cmd & (HAMMER2_MSGF_CREATE | HAMMER2_MSGF_DELETE |
				    HAMMER2_MSGF_REPLY)) {
	case HAMMER2_MSGF_CREATE:
	case HAMMER2_MSGF_CREATE | HAMMER2_MSGF_DELETE:
		/*
		 * New persistant command received.
		 */
		if (state) {
			kprintf("hammer2_state_msgrx: duplicate transaction\n");
			error = EINVAL;
			break;
		}
		state = pmp->freerd_state;
		pmp->freerd_state = NULL;
		msg->state = state;
		state->msg = msg;
		state->rxcmd = msg->any.head.cmd & ~HAMMER2_MSGF_DELETE;
		RB_INSERT(hammer2_state_tree, &pmp->staterd_tree, state);
		state->flags |= HAMMER2_STATE_INSERTED;
		error = 0;
		break;
	case HAMMER2_MSGF_DELETE:
		/*
		 * Persistent state is expected but might not exist if an
		 * ABORT+DELETE races the close.
		 */
		if (state == NULL) {
			if (msg->any.head.cmd & HAMMER2_MSGF_ABORT) {
				error = EALREADY;
			} else {
				kprintf("hammer2_state_msgrx: no state "
					"for DELETE\n");
				error = EINVAL;
			}
			break;
		}

		/*
		 * Handle another ABORT+DELETE case if the msgid has already
		 * been reused.
		 */
		if ((state->rxcmd & HAMMER2_MSGF_CREATE) == 0) {
			if (msg->any.head.cmd & HAMMER2_MSGF_ABORT) {
				error = EALREADY;
			} else {
				kprintf("hammer2_state_msgrx: state reused "
					"for DELETE\n");
				error = EINVAL;
			}
			break;
		}
		error = 0;
		break;
	default:
		/*
		 * Check for mid-stream ABORT command received, otherwise
		 * allow.
		 */
		if (msg->any.head.cmd & HAMMER2_MSGF_ABORT) {
			if (state == NULL ||
			    (state->rxcmd & HAMMER2_MSGF_CREATE) == 0) {
				error = EALREADY;
				break;
			}
		}
		error = 0;
		break;
	case HAMMER2_MSGF_REPLY | HAMMER2_MSGF_CREATE:
	case HAMMER2_MSGF_REPLY | HAMMER2_MSGF_CREATE | HAMMER2_MSGF_DELETE:
		/*
		 * When receiving a reply with CREATE set the original
		 * persistent state message should already exist.
		 */
		if (state == NULL) {
			kprintf("hammer2_state_msgrx: no state match for "
				"REPLY\n");
			error = EINVAL;
			break;
		}
		state->rxcmd = msg->any.head.cmd & ~HAMMER2_MSGF_DELETE;
		error = 0;
		break;
	case HAMMER2_MSGF_REPLY | HAMMER2_MSGF_DELETE:
		/*
		 * Received REPLY+ABORT+DELETE in case where msgid has
		 * already been fully closed, ignore the message.
		 */
		if (state == NULL) {
			if (msg->any.head.cmd & HAMMER2_MSGF_ABORT) {
				error = EALREADY;
			} else {
				kprintf("hammer2_state_msgrx: no state match "
					"for REPLY|DELETE\n");
				error = EINVAL;
			}
			break;
		}

		/*
		 * Received REPLY+ABORT+DELETE in case where msgid has
		 * already been reused for an unrelated message,
		 * ignore the message.
		 */
		if ((state->rxcmd & HAMMER2_MSGF_CREATE) == 0) {
			if (msg->any.head.cmd & HAMMER2_MSGF_ABORT) {
				error = EALREADY;
			} else {
				kprintf("hammer2_state_msgrx: state reused "
					"for REPLY|DELETE\n");
				error = EINVAL;
			}
			break;
		}
		error = 0;
		break;
	case HAMMER2_MSGF_REPLY:
		/*
		 * Check for mid-stream ABORT reply received to sent command.
		 */
		if (msg->any.head.cmd & HAMMER2_MSGF_ABORT) {
			if (state == NULL ||
			    (state->rxcmd & HAMMER2_MSGF_CREATE) == 0) {
				error = EALREADY;
				break;
			}
		}
		error = 0;
		break;
	}
	lockmgr(&pmp->msglk, LK_RELEASE);
	return (error);
}

void
hammer2_state_cleanuprx(hammer2_pfsmount_t *pmp, hammer2_msg_t *msg)
{
	hammer2_state_t *state;

	if ((state = msg->state) == NULL) {
		hammer2_msg_free(pmp, msg);
	} else if (msg->any.head.cmd & HAMMER2_MSGF_DELETE) {
		lockmgr(&pmp->msglk, LK_EXCLUSIVE);
		state->rxcmd |= HAMMER2_MSGF_DELETE;
		if (state->txcmd & HAMMER2_MSGF_DELETE) {
			if (state->msg == msg)
				state->msg = NULL;
			KKASSERT(state->flags & HAMMER2_STATE_INSERTED);
			if (msg->any.head.cmd & HAMMER2_MSGF_REPLY) {
				RB_REMOVE(hammer2_state_tree,
					  &pmp->statewr_tree, state);
			} else {
				RB_REMOVE(hammer2_state_tree,
					  &pmp->staterd_tree, state);
			}
			state->flags &= ~HAMMER2_STATE_INSERTED;
			lockmgr(&pmp->msglk, LK_RELEASE);
			hammer2_state_free(state);
		} else {
			lockmgr(&pmp->msglk, LK_RELEASE);
		}
		hammer2_msg_free(pmp, msg);
	} else if (state->msg != msg) {
		hammer2_msg_free(pmp, msg);
	}
}

/*
 * Process state tracking for a message prior to transmission.
 *
 * Called with msglk held and the msg dequeued.
 *
 * One-off messages are usually with dummy state and msg->state may be NULL
 * in this situation.
 *
 * New transactions (when CREATE is set) will insert the state.
 *
 * May request that caller discard the message by setting *discardp to 1.
 * A NULL state may be returned in this case.
 */
int
hammer2_state_msgtx(hammer2_pfsmount_t *pmp, hammer2_msg_t *msg)
{
	hammer2_state_t *state;
	int error;

	/*
	 * Make sure a state structure is ready to go in case we need a new
	 * one.  This is the only routine which uses freewr_state so no
	 * races are possible.
	 */
	if ((state = pmp->freewr_state) == NULL) {
		state = kmalloc(sizeof(*state), pmp->mmsg, M_WAITOK | M_ZERO);
		state->pmp = pmp;
		state->flags = HAMMER2_STATE_DYNAMIC;
		pmp->freewr_state = state;
	}

	/*
	 * Lock RB tree.  If persistent state is present it will have already
	 * been assigned to msg.
	 */
	lockmgr(&pmp->msglk, LK_EXCLUSIVE);
	state = msg->state;

	/*
	 * Short-cut one-off or mid-stream messages (state may be NULL).
	 */
	if ((msg->any.head.cmd & (HAMMER2_MSGF_CREATE | HAMMER2_MSGF_DELETE |
				  HAMMER2_MSGF_ABORT)) == 0) {
		lockmgr(&pmp->msglk, LK_RELEASE);
		return(0);
	}


	/*
	 * Switch on CREATE, DELETE, REPLY, and also handle ABORT from
	 * inside the case statements.
	 */
	switch(msg->any.head.cmd & (HAMMER2_MSGF_CREATE | HAMMER2_MSGF_DELETE |
				    HAMMER2_MSGF_REPLY)) {
	case HAMMER2_MSGF_CREATE:
	case HAMMER2_MSGF_CREATE | HAMMER2_MSGF_DELETE:
		/*
		 * Insert the new persistent message state and mark
		 * half-closed if DELETE is set.  Since this is a new
		 * message it isn't possible to transition into the fully
		 * closed state here.
		 */
		if (state == NULL) {
			state = pmp->freerd_state;
			pmp->freerd_state = NULL;
			msg->state = state;
			state->msg = msg;
		}
		KKASSERT((state->flags & HAMMER2_STATE_INSERTED) == 0);
		if (RB_INSERT(hammer2_state_tree, &pmp->staterd_tree, state)) {
			kprintf("hammer2_state_msgtx: duplicate transaction\n");
			error = EINVAL;
			break;
		}
		state->flags |= HAMMER2_STATE_INSERTED;
		state->txcmd = msg->any.head.cmd & ~HAMMER2_MSGF_DELETE;
		error = 0;
		break;
	case HAMMER2_MSGF_DELETE:
		/*
		 * Sent ABORT+DELETE in case where msgid has already
		 * been fully closed, ignore the message.
		 */
		if (state == NULL) {
			if (msg->any.head.cmd & HAMMER2_MSGF_ABORT) {
				error = EALREADY;
			} else {
				kprintf("hammer2_state_msgtx: no state match "
					"for DELETE\n");
				error = EINVAL;
			}
			break;
		}

		/*
		 * Sent ABORT+DELETE in case where msgid has
		 * already been reused for an unrelated message,
		 * ignore the message.
		 */
		if ((state->txcmd & HAMMER2_MSGF_CREATE) == 0) {
			if (msg->any.head.cmd & HAMMER2_MSGF_ABORT) {
				error = EALREADY;
			} else {
				kprintf("hammer2_state_msgtx: state reused "
					"for DELETE\n");
				error = EINVAL;
			}
			break;
		}
		error = 0;
		break;
	default:
		/*
		 * Check for mid-stream ABORT command sent
		 */
		if (msg->any.head.cmd & HAMMER2_MSGF_ABORT) {
			if (state == NULL ||
			    (state->txcmd & HAMMER2_MSGF_CREATE) == 0) {
				error = EALREADY;
				break;
			}
		}
		error = 0;
		break;
	case HAMMER2_MSGF_REPLY | HAMMER2_MSGF_CREATE:
	case HAMMER2_MSGF_REPLY | HAMMER2_MSGF_CREATE | HAMMER2_MSGF_DELETE:
		/*
		 * When transmitting a reply with CREATE set the original
		 * persistent state message should already exist.
		 */
		if (state == NULL) {
			kprintf("hammer2_state_msgtx: no state match "
				"for REPLY | CREATE\n");
			error = EINVAL;
			break;
		}
		state->txcmd = msg->any.head.cmd & ~HAMMER2_MSGF_DELETE;
		error = 0;
		break;
	case HAMMER2_MSGF_REPLY | HAMMER2_MSGF_DELETE:
		/*
		 * When transmitting a reply with DELETE set the original
		 * persistent state message should already exist.
		 *
		 * This is very similar to the REPLY|CREATE|* case except
		 * txcmd is already stored, so we just add the DELETE flag.
		 *
		 * Sent REPLY+ABORT+DELETE in case where msgid has
		 * already been fully closed, ignore the message.
		 */
		if (state == NULL) {
			if (msg->any.head.cmd & HAMMER2_MSGF_ABORT) {
				error = EALREADY;
			} else {
				kprintf("hammer2_state_msgtx: no state match "
					"for REPLY | DELETE\n");
				error = EINVAL;
			}
			break;
		}

		/*
		 * Sent REPLY+ABORT+DELETE in case where msgid has already
		 * been reused for an unrelated message, ignore the message.
		 */
		if ((state->txcmd & HAMMER2_MSGF_CREATE) == 0) {
			if (msg->any.head.cmd & HAMMER2_MSGF_ABORT) {
				error = EALREADY;
			} else {
				kprintf("hammer2_state_msgtx: state reused "
					"for REPLY | DELETE\n");
				error = EINVAL;
			}
			break;
		}
		error = 0;
		break;
	case HAMMER2_MSGF_REPLY:
		/*
		 * Check for mid-stream ABORT reply sent.
		 *
		 * One-off REPLY messages are allowed for e.g. status updates.
		 */
		if (msg->any.head.cmd & HAMMER2_MSGF_ABORT) {
			if (state == NULL ||
			    (state->txcmd & HAMMER2_MSGF_CREATE) == 0) {
				error = EALREADY;
				break;
			}
		}
		error = 0;
		break;
	}
	lockmgr(&pmp->msglk, LK_RELEASE);
	return (error);
}

void
hammer2_state_cleanuptx(hammer2_pfsmount_t *pmp, hammer2_msg_t *msg)
{
	hammer2_state_t *state;

	if ((state = msg->state) == NULL) {
		hammer2_msg_free(pmp, msg);
	} else if (msg->any.head.cmd & HAMMER2_MSGF_DELETE) {
		lockmgr(&pmp->msglk, LK_EXCLUSIVE);
		state->txcmd |= HAMMER2_MSGF_DELETE;
		if (state->rxcmd & HAMMER2_MSGF_DELETE) {
			if (state->msg == msg)
				state->msg = NULL;
			KKASSERT(state->flags & HAMMER2_STATE_INSERTED);
			if (msg->any.head.cmd & HAMMER2_MSGF_REPLY) {
				RB_REMOVE(hammer2_state_tree,
					  &pmp->staterd_tree, state);
			} else {
				RB_REMOVE(hammer2_state_tree,
					  &pmp->statewr_tree, state);
			}
			state->flags &= ~HAMMER2_STATE_INSERTED;
			lockmgr(&pmp->msglk, LK_RELEASE);
			hammer2_state_free(state);
		} else {
			lockmgr(&pmp->msglk, LK_RELEASE);
		}
		hammer2_msg_free(pmp, msg);
	} else if (state->msg != msg) {
		hammer2_msg_free(pmp, msg);
	}
}

void
hammer2_state_free(hammer2_state_t *state)
{
	hammer2_pfsmount_t *pmp = state->pmp;
	hammer2_msg_t *msg;

	msg = state->msg;
	state->msg = NULL;
	kfree(state, pmp->mmsg);
	if (msg)
		hammer2_msg_free(pmp, msg);
}

void
hammer2_msg_free(hammer2_pfsmount_t *pmp, hammer2_msg_t *msg)
{
	if (msg->aux_data && msg->aux_size) {
		kfree(msg->aux_data, pmp->mmsg);
		msg->aux_data = NULL;
		msg->aux_size = 0;
	}
	kfree(msg, pmp->mmsg);
}

/*
 * Indexed messages are stored in a red-black tree indexed by their
 * msgid.  Only persistent messages are indexed.
 */
int
hammer2_state_cmp(hammer2_state_t *state1, hammer2_state_t *state2)
{
	if (state1->msgid < state2->msgid)
		return(-1);
	if (state1->msgid > state2->msgid)
		return(1);
	return(0);
}

/*
 * Execute a received message.
 *
 * If msg is part of a transaction msg->state will be non-NULL.  In this
 * situation state->msg saves the original command and can be replaced
 * by ongoing activity if desired.  Any msg which does not match state->msg
 * will be destroyed after we return.
 *
 * Single-element transactions set both CREATE and DELETE.
 *
 * Non-blocking transactions also set ABORT with CREATE.
 *
 * Specific transactional ABORTs can also be received and must be handled,
 * and can be received even when the other end has closed (after DELETE
 * received) if we have not yet closed our end of the transaction.
 */
int
hammer2_msg_execute(hammer2_pfsmount_t *pmp __unused, hammer2_msg_t *msg __unused)
{
	return(0);
}