From: Hans Verkuil <hansverk@cisco.com>
Date: Fri, 9 Dec 2016 14:00:49 +0000 (-0200)
Subject: [media] cec: fix race between configuring and unconfiguring
X-Git-Tag: v4.14-rc1~332^2~978
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=f60f35609f89ef4fee73776bc1ef697923251995;p=platform%2Fkernel%2Flinux-rpi.git

[media] cec: fix race between configuring and unconfiguring

This race was discovered by running cec-compliance -A with the cec module debug
parameter set to 2: suddenly the test would fail.

It turns out that this happens when the test configures the adapter in
non-blocking mode, then it waits for the CEC_EVENT_STATE_CHANGE event and once
the event is received it unconfigures the adapter.

What happened was that the unconfigure was executed while the configure was
still transmitting the Report Features and Report Physical Address messages.
This messed up the internal state of the cec_adapter.

The fix is to transmit those messages with the adap->lock mutex held (this will
just queue them up in the internal transmit queue, and not actually transmit
anything yet). Only unlock the mutex once everything is done. The main thread
will dequeue the messages from the internal transmit queue and transmit them
one by one, unless an unconfigure was done, and in that case any messages are
just dropped.

Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---

diff --git a/drivers/media/cec/cec-adap.c b/drivers/media/cec/cec-adap.c
index f3d4956..ebb5e391 100644
--- a/drivers/media/cec/cec-adap.c
+++ b/drivers/media/cec/cec-adap.c
@@ -1256,8 +1256,17 @@ configured:
 	adap->is_configured = true;
 	adap->is_configuring = false;
 	cec_post_state_event(adap);
-	mutex_unlock(&adap->lock);
 
+	/*
+	 * Now post the Report Features and Report Physical Address broadcast
+	 * messages. Note that these are non-blocking transmits, meaning that
+	 * they are just queued up and once adap->lock is unlocked the main
+	 * thread will kick in and start transmitting these.
+	 *
+	 * If after this function is done (but before one or more of these
+	 * messages are actually transmitted) the CEC adapter is unconfigured,
+	 * then any remaining messages will be dropped by the main thread.
+	 */
 	for (i = 0; i < las->num_log_addrs; i++) {
 		struct cec_msg msg = {};
 
@@ -1271,7 +1280,7 @@ configured:
 		if (las->log_addr[i] != CEC_LOG_ADDR_UNREGISTERED &&
 		    adap->log_addrs.cec_version >= CEC_OP_CEC_VERSION_2_0) {
 			cec_fill_msg_report_features(adap, &msg, i);
-			cec_transmit_msg(adap, &msg, false);
+			cec_transmit_msg_fh(adap, &msg, NULL, false);
 		}
 
 		/* Report Physical Address */
@@ -1280,12 +1289,11 @@ configured:
 		dprintk(2, "config: la %d pa %x.%x.%x.%x\n",
 			las->log_addr[i],
 			cec_phys_addr_exp(adap->phys_addr));
-		cec_transmit_msg(adap, &msg, false);
+		cec_transmit_msg_fh(adap, &msg, NULL, false);
 	}
-	mutex_lock(&adap->lock);
 	adap->kthread_config = NULL;
-	mutex_unlock(&adap->lock);
 	complete(&adap->config_completion);
+	mutex_unlock(&adap->lock);
 	return 0;
 
 unconfigure: