xref: /xnu-8020.101.4/bsd/netinet/mptcp_timer.c (revision e7776783b89a353188416a9a346c6cdb4928faad)

/*
 * Copyright (c) 2012-2017 Apple Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 *
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 *
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 *
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/kernel.h>
#include <sys/mcache.h>
#include <sys/socket.h>
#include <sys/socketvar.h>
#include <sys/syslog.h>
#include <sys/protosw.h>
#include <sys/sysctl.h>

#include <mach/sdt.h>

#include <netinet/mp_pcb.h>
#include <netinet/mptcp_var.h>
#include <netinet/mptcp_timer.h>
#include <netinet/mptcp_seq.h>

#include <kern/locks.h>

/*
 * MPTCP Retransmission Timer comes into play only when subflow level
 * data is acked, but Data ACK is not received. Time is in seconds.
 */
static u_int32_t mptcp_rto = 3;
SYSCTL_INT(_net_inet_mptcp, OID_AUTO, rto, CTLFLAG_RW | CTLFLAG_LOCKED,
    &mptcp_rto, 0, "MPTCP Retransmission Timeout");

static int mptcp_nrtos = 3;
SYSCTL_INT(_net_inet_mptcp, OID_AUTO, nrto, CTLFLAG_RW | CTLFLAG_LOCKED,
    &mptcp_rto, 0, "MPTCP Retransmissions");

/*
 * MPTCP connections timewait interval in seconds.
 */
static u_int32_t mptcp_tw = 60;
SYSCTL_INT(_net_inet_mptcp, OID_AUTO, tw, CTLFLAG_RW | CTLFLAG_LOCKED,
    &mptcp_tw, 0, "MPTCP Timewait Period");

#define TIMEVAL_TO_HZ(_tv_)     ((_tv_).tv_sec * hz + (_tv_).tv_usec / hz)

static int mptcp_cancel_urgency_timer(struct mptses *mpte);

static int
mptcp_timer_demux(struct mptses *mpte, uint64_t now_msecs)
{
	struct mptcb *mp_tp = NULL;
	mp_tp = mpte->mpte_mptcb;
	int resched_timer = 0;

	DTRACE_MPTCP2(timer, struct mptses *, mpte, struct mptcb *, mp_tp);

	switch (mp_tp->mpt_timer_vals) {
	case MPTT_REXMT:
		if (mp_tp->mpt_rxtstart == 0) {
			break;
		}
		if ((now_msecs - mp_tp->mpt_rxtstart) > (mptcp_rto * hz)) {
			if (MPTCP_SEQ_GT(mp_tp->mpt_snduna, mp_tp->mpt_rtseq)) {
				mp_tp->mpt_timer_vals = 0;
				mp_tp->mpt_rtseq = 0;
				break;
			}
			mp_tp->mpt_rxtshift++;
			if (mp_tp->mpt_rxtshift > mptcp_nrtos) {
				mp_tp->mpt_softerror = ETIMEDOUT;
				DTRACE_MPTCP1(error, struct mptcb *, mp_tp);
			} else {
				mp_tp->mpt_sndnxt = mp_tp->mpt_rtseq;
				os_log_info(mptcp_log_handle,
				    "%s: REXMT %d sndnxt %u\n",
				    __func__, mp_tp->mpt_rxtshift,
				    (uint32_t)mp_tp->mpt_sndnxt);
				mptcp_output(mpte);
			}
		} else {
			resched_timer = 1;
		}
		break;
	case MPTT_TW:
		/* Allows for break before make XXX */
		if (mp_tp->mpt_timewait == 0) {
			VERIFY(0);
		}
		if ((now_msecs - mp_tp->mpt_timewait) >
		    (mptcp_tw * hz)) {
			mp_tp->mpt_softerror = ETIMEDOUT;
			DTRACE_MPTCP1(error, struct mptcb *, mp_tp);
		} else {
			resched_timer = 1;
		}
		break;
	case MPTT_FASTCLOSE:
		/* TODO XXX */
		break;
	default:
		break;
	}

	return resched_timer;
}

uint32_t
mptcp_timer(struct mppcbinfo *mppi)
{
	struct mppcb *mpp, *tmpp;
	struct timeval now;
	uint32_t resched_timer = 0;
	uint64_t now_msecs;

	LCK_MTX_ASSERT(&mppi->mppi_lock, LCK_MTX_ASSERT_OWNED);

	microuptime(&now);
	now_msecs = TIMEVAL_TO_HZ(now);
	TAILQ_FOREACH_SAFE(mpp, &mppi->mppi_pcbs, mpp_entry, tmpp) {
		struct socket *mp_so;
		struct mptses *mpte;

		mp_so = mpp->mpp_socket;
		mpte = mptompte(mpp);
		socket_lock(mp_so, 1);

		VERIFY(mpp->mpp_flags & MPP_ATTACHED);

		if (mptcp_timer_demux(mpte, now_msecs)) {
			resched_timer = 1;
		}
		socket_unlock(mp_so, 1);
	}

	return resched_timer;
}

void
mptcp_start_timer(struct mptses *mpte, int timer_type)
{
	struct timeval now;
	struct mptcb *mp_tp = mpte->mpte_mptcb;

	microuptime(&now);

	DTRACE_MPTCP2(start__timer, struct mptcb *, mp_tp, int, timer_type);
	mptcplog((LOG_DEBUG, "MPTCP Socket: %s: %d\n", __func__, timer_type),
	    MPTCP_SOCKET_DBG, MPTCP_LOGLVL_VERBOSE);

	socket_lock_assert_owned(mptetoso(mpte));

	switch (timer_type) {
	case MPTT_REXMT:
		mp_tp->mpt_timer_vals |= MPTT_REXMT;
		mp_tp->mpt_rxtstart = TIMEVAL_TO_HZ(now);
		mp_tp->mpt_rxtshift = 0;
		mp_tp->mpt_rtseq = mp_tp->mpt_sndnxt;
		break;
	case MPTT_TW:
		/* XXX: Not implemented yet */
		mp_tp->mpt_timer_vals |= MPTT_TW;
		mp_tp->mpt_timewait = TIMEVAL_TO_HZ(now);
		break;
	case MPTT_FASTCLOSE:
		/* NO-OP */
		break;
	default:
		VERIFY(0);
		/* NOTREACHED */
	}
	mptcp_timer_sched();
}

void
mptcp_cancel_timer(struct mptcb *mp_tp, int timer_type)
{
	socket_lock_assert_owned(mptetoso(mp_tp->mpt_mpte));

	switch (timer_type) {
	case MPTT_REXMT:
		mp_tp->mpt_rxtstart = 0;
		mp_tp->mpt_rxtshift = 0;
		mp_tp->mpt_timer_vals = 0;
		break;
	case MPTT_TW:
		/* NO-OP */
		break;
	case MPTT_FASTCLOSE:
		/* NO-OP */
		break;
	default:
		break;
	}
}

void
mptcp_cancel_all_timers(struct mptcb *mp_tp)
{
	struct mptses *mpte = mp_tp->mpt_mpte;

	mptcp_cancel_urgency_timer(mpte);

	mptcp_cancel_timer(mp_tp, MPTT_REXMT);
	mptcp_cancel_timer(mp_tp, MPTT_TW);
	mptcp_cancel_timer(mp_tp, MPTT_FASTCLOSE);
}

static void
mptcp_urgency_timer(void *param0, __unused void *param1)
{
	struct mptses *mpte = (struct mptses *)param0;
	struct socket *mp_so = mptetoso(mpte);
	uint64_t time_now;

	socket_lock(mp_so, 1);

	time_now = mach_continuous_time();
	VERIFY(mp_so->so_usecount >= 0);

	os_log(mptcp_log_handle, "%s - %lx: timer at %llu now %llu usecount %u\n",
	    __func__, (unsigned long)VM_KERNEL_ADDRPERM(mpte), mpte->mpte_time_target, time_now, mp_so->so_usecount);

	mptcp_check_subflows_and_add(mpte);

	mp_so->so_usecount--;

	socket_unlock(mp_so, 1);
}

static void
mptcp_urgency_stop(void *param0, __unused void *param1)
{
	struct mptses *mpte = (struct mptses *)param0;
	struct socket *mp_so = mptetoso(mpte);

	socket_lock(mp_so, 1);

	VERIFY(mp_so->so_usecount >= 0);

	os_log(mptcp_log_handle, "%s - %lx: usecount %u\n",
	    __func__, (unsigned long)VM_KERNEL_ADDRPERM(mpte), mp_so->so_usecount);

	mptcp_check_subflows_and_remove(mpte);

	mp_so->so_usecount--;

	socket_unlock(mp_so, 1);
}

void
mptcp_init_urgency_timer(struct mptses *mpte)
{
	/* thread_call_allocate never fails */
	mpte->mpte_time_thread = thread_call_allocate(mptcp_urgency_timer, mpte);
	mpte->mpte_stop_urgency = thread_call_allocate(mptcp_urgency_stop, mpte);
}

void
mptcp_set_urgency_timer(struct mptses *mpte)
{
	struct socket *mp_so = mptetoso(mpte);
	uint64_t time_now = 0;
	boolean_t ret = FALSE;

	socket_lock_assert_owned(mp_so);

	VERIFY(mp_so->so_usecount >= 0);
	if (mp_so->so_usecount == 0) {
		goto exit_log;
	}

	if (mpte->mpte_time_target == 0) {
		/* Close subflows right now */

		ret = thread_call_enter(mpte->mpte_stop_urgency);

		if (!ret) {
			mp_so->so_usecount++;
		}

		goto exit_log;
	}

	time_now = mach_continuous_time();

	if ((int64_t)(mpte->mpte_time_target - time_now) > 0) {
		mptcp_check_subflows_and_remove(mpte);

		ret = thread_call_enter_delayed_with_leeway(mpte->mpte_time_thread, NULL,
		    mpte->mpte_time_target, 0, THREAD_CALL_CONTINUOUS);

		if (!ret) {
			mp_so->so_usecount++;
		}
	} else if ((int64_t)(mpte->mpte_time_target - time_now) <= 0) {
		/* Already passed the deadline, trigger subflows now */
		ret = thread_call_enter(mpte->mpte_time_thread);

		if (!ret) {
			mp_so->so_usecount++;
		}
	}

exit_log:
	os_log(mptcp_log_handle, "%s - %lx: timer at %llu now %llu usecount %u ret %u\n",
	    __func__, (unsigned long)VM_KERNEL_ADDRPERM(mpte), mpte->mpte_time_target, time_now,
	    mp_so->so_usecount, ret);
}

static int
mptcp_cancel_urgency_timer(struct mptses *mpte)
{
	struct socket *mp_so = mptetoso(mpte);
	boolean_t ret;

	ret = thread_call_cancel(mpte->mpte_time_thread);

	os_log(mptcp_log_handle, "%s - %lx: Canceled timer thread usecount %u ret %u\n",
	    __func__, (unsigned long)VM_KERNEL_ADDRPERM(mpte), mp_so->so_usecount, ret);

	mptcp_check_subflows_and_remove(mpte);

	if (ret) {
		mp_so->so_usecount--;
	}

	ret = thread_call_cancel(mpte->mpte_stop_urgency);
	if (ret) {
		mp_so->so_usecount--;
	}

	return 0;
}