ASoC: SOF: sof-client-dma-trace: Add protection against file/module removal

Based on debugging the following issues were identified:

if the snd_sof_dma_trace module is removed while the sof-logger keeps the
trace file open:
The module's remove will block on the debugfs_remove() until the sof-logger
is stopped (w/ C-c).
The sof_dfsentry_trace_read() will return and the debugfs file is removed,
the module remove completes.
Then the debugfs file's release callback got called but the file itself was
already removed!

The second issue is that while the client driver is loaded and sof-logger
keeps the trace file open, the user can rmmod the parent driver for the
DSP itself which will removes the SOF client devices and the same chain of
events will happen.

With this patch we protect the debugfs file from removal with the
debugfs_file_get/put and we protect the parent device against removal while
the module is in active use (the debugfs file is open).

Signed-off-by: Peter Ujfalusi <peter.ujfalusi@linux.intel.com>

Author: ujfalusi

sound/soc/sof/sof-client-dma-trace.c

@@ -291,6 +291,32 @@ static size_t sof_wait_trace_avail(struct sof_client_dev *cdev,
 	return sof_trace_avail(cdev, pos, buffer_size);
 }
 
+static int sof_dfsentry_trace_open(struct inode *inode, struct file *file)
+{
+	struct sof_client_dev *cdev;
+	int ret;
+
+	ret = debugfs_file_get(file->f_path.dentry);
+	if (unlikely(ret))
+		return ret;
+
+	cdev = inode->i_private;
+
+	ret = sof_client_core_module_get(cdev);
+	if (ret) {
+		debugfs_file_put(file->f_path.dentry);
+		return ret;
+	}
+
+	ret = simple_open(inode, file);
+	if (ret) {
+		debugfs_file_put(file->f_path.dentry);
+		sof_client_core_module_put(cdev);
+	}
+
+	return ret;
+}
+
 static ssize_t sof_dfsentry_trace_read(struct file *file, char __user *buffer,
 				       size_t count, loff_t *ppos)
 {
@@ -348,11 +374,13 @@ static int sof_dfsentry_trace_release(struct inode *inode, struct file *file)
 	if (!priv->dtrace_is_enabled)
 		priv->host_offset = 0;
 
+	debugfs_file_put(file->f_path.dentry);
+	sof_client_core_module_put(cdev);
 	return 0;
 }
 
 static const struct file_operations sof_dtrace_trace_fops = {
-	.open = simple_open,
+	.open = sof_dfsentry_trace_open,
 	.read = sof_dfsentry_trace_read,
 	.llseek = default_llseek,
 	.release = sof_dfsentry_trace_release,