Commit ec571793 authored by Ben Walker's avatar Ben Walker
Browse files

thread: Add debug logging 



This makes it easier to debug failures.

Change-Id: Ic1099ec08308d5e50dd9fe03798dc0873579f2cc
Signed-off-by: default avatarBen Walker <benjamin.walker@intel.com>
Reviewed-on: https://review.gerrithub.io/423961


Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Chandler-Test-Pool: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: default avatarChangpeng Liu <changpeng.liu@intel.com>
Reviewed-by: default avatarShuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
parent 603a6de8

lib/thread/thread.c

+45 −1
Original line number Diff line number Diff line
@@ -33,8 +33,10 @@ 


#include "spdk/stdinc.h"



#include "spdk/string.h"

#include "spdk/thread.h"

#include "spdk/log.h"



#include "spdk_internal/log.h"



#ifdef __linux__

#include <sys/prctl.h>
@@ -153,8 +155,12 @@ spdk_allocate_thread(spdk_thread_pass_msg msg_fn, 
	if (name) {

		_set_thread_name(name);

		thread->name = strdup(name);

	} else {

		thread->name = spdk_sprintf_alloc("%p", thread);

	}



	SPDK_DEBUGLOG(SPDK_LOG_THREAD, "Allocating new thread %s\n", thread->name);



	pthread_mutex_unlock(&g_devlist_mutex);



	return thread;
@@ -174,6 +180,8 @@ spdk_free_thread(void) 
		return;

	}



	SPDK_DEBUGLOG(SPDK_LOG_THREAD, "Freeing thread %s\n", thread->name);



	assert(g_thread_count > 0);

	g_thread_count--;

	TAILQ_REMOVE(&g_threads, thread, tailq);
@@ -295,9 +303,14 @@ spdk_on_thread(void *ctx) 
	pthread_mutex_unlock(&g_devlist_mutex);



	if (!ct->cur_thread) {

		SPDK_DEBUGLOG(SPDK_LOG_THREAD, "Completed thread iteration");



		spdk_thread_send_msg(ct->orig_thread, ct->cpl, ct->ctx);

		free(ctx);

	} else {

		SPDK_DEBUGLOG(SPDK_LOG_THREAD, "Continuing thread iteration to %s\n",

			      ct->cur_thread->name);



		spdk_thread_send_msg(ct->cur_thread, spdk_on_thread, ctx);

	}

}
@@ -323,6 +336,9 @@ spdk_for_each_thread(spdk_thread_fn fn, void *ctx, spdk_thread_fn cpl) 
	ct->cur_thread = TAILQ_FIRST(&g_threads);

	pthread_mutex_unlock(&g_devlist_mutex);



	SPDK_DEBUGLOG(SPDK_LOG_THREAD, "Starting thread iteration from %s\n",

		      ct->orig_thread->name);



	spdk_thread_send_msg(ct->cur_thread, spdk_on_thread, ct);

}
@@ -351,6 +367,9 @@ spdk_io_device_register(void *io_device, spdk_io_channel_create_cb create_cb, 
	dev->unregistered = false;

	dev->refcnt = 0;



	SPDK_DEBUGLOG(SPDK_LOG_THREAD, "Registering io_device %p on thread %s\n",

		      dev, spdk_get_thread()->name);



	pthread_mutex_lock(&g_devlist_mutex);

	TAILQ_FOREACH(tmp, &g_io_devices, tailq) {

		if (tmp->io_device == io_device) {
@@ -369,6 +388,9 @@ _finish_unregister(void *arg) 
{

	struct io_device *dev = arg;



	SPDK_DEBUGLOG(SPDK_LOG_THREAD, "Finishing unregistration of io_device %p on thread %s\n",

		      dev, dev->unregister_thread->name);



	dev->unregister_cb(dev->io_device);

	free(dev);

}
@@ -380,6 +402,8 @@ _spdk_io_device_free(struct io_device *dev) 
		free(dev);

	} else {

		assert(dev->unregister_thread != NULL);

		SPDK_DEBUGLOG(SPDK_LOG_THREAD, "io_device %p needs to unregister from thread %s\n",

			      dev, dev->unregister_thread->name);

		spdk_thread_send_msg(dev->unregister_thread, _finish_unregister, dev);

	}

}
@@ -420,6 +444,9 @@ spdk_io_device_unregister(void *io_device, spdk_io_device_unregister_cb unregist 
	dev->unregister_thread = thread;

	pthread_mutex_unlock(&g_devlist_mutex);



	SPDK_DEBUGLOG(SPDK_LOG_THREAD, "Unregistering io_device %p from thread %s\n",

		      dev, thread->name);



	if (refcnt > 0) {

		/* defer deletion */

		return;
@@ -458,6 +485,10 @@ spdk_get_io_channel(void *io_device) 
	TAILQ_FOREACH(ch, &thread->io_channels, tailq) {

		if (ch->dev == dev) {

			ch->ref++;



			SPDK_DEBUGLOG(SPDK_LOG_THREAD, "Get io_channel %p for io_device %p on thread %s refcnt %u\n",

				      ch, dev, thread->name, ch->ref);



			/*

			 * An I/O channel already exists for this device on this

			 *  thread, so return it.
@@ -480,6 +511,9 @@ spdk_get_io_channel(void *io_device) 
	ch->ref = 1;

	TAILQ_INSERT_TAIL(&thread->io_channels, ch, tailq);



	SPDK_DEBUGLOG(SPDK_LOG_THREAD, "Get io_channel %p for io_device %p on thread %s refcnt %u\n",

		      ch, dev, thread->name, ch->ref);



	dev->refcnt++;



	pthread_mutex_unlock(&g_devlist_mutex);
@@ -503,6 +537,10 @@ _spdk_put_io_channel(void *arg) 
	struct spdk_io_channel *ch = arg;

	bool do_remove_dev = true;



	SPDK_DEBUGLOG(SPDK_LOG_THREAD,

		      "Releasing io_channel %p for io_device %p. Channel thread %p. Current thread %s\n",

		      ch, ch->dev, ch->thread, spdk_get_thread()->name);



	assert(ch->thread == spdk_get_thread());



	if (ch->ref > 0) {
@@ -543,6 +581,9 @@ _spdk_put_io_channel(void *arg) 
void

spdk_put_io_channel(struct spdk_io_channel *ch)

{

	SPDK_DEBUGLOG(SPDK_LOG_THREAD, "Putting io_channel %p for io_device %p on thread %s refcnt %u\n",

		      ch, ch->dev, ch->thread->name, ch->ref);



	ch->ref--;



	if (ch->ref == 0) {
@@ -707,3 +748,6 @@ end: 


	spdk_thread_send_msg(i->orig_thread, _call_completion, i);

}





SPDK_LOG_REGISTER_COMPONENT("thread", SPDK_LOG_THREAD)

test/unit/lib/thread/thread.c/thread_ut.c

+2 −2
Original line number Diff line number Diff line
@@ -349,12 +349,12 @@ thread_name(void) 
	struct spdk_thread *thread;

	const char *name;



	/* Create thread with no name */

	/* Create thread with no name, which automatically generates one */

	spdk_allocate_thread(_send_msg, NULL, NULL, NULL, NULL);

	thread = spdk_get_thread();

	SPDK_CU_ASSERT_FATAL(thread != NULL);

	name = spdk_thread_get_name(thread);

	CU_ASSERT(name == NULL);

	CU_ASSERT(name != NULL);

	spdk_free_thread();



	/* Create thread named "test_thread" */