mars/mars_check.c

// (c) 2010 Thomas Schoebel-Theuer / 1&1 Internet AG

/* Check brick
 * checks various semantic properties, uses watchdog to find lost callbacks.
 */

//#define BRICK_DEBUGGING
//#define MARS_DEBUGGING

#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/string.h>
#include <linux/kthread.h>

#include "mars.h"

///////////////////////// own type definitions ////////////////////////

#include "mars_check.h"

///////////////////////// own helper functions ////////////////////////

static int check_mars_endio(struct mars_io_object *mio, int error)
{
	struct check_output *output = mio->cb_private;
	struct check_mars_io_aspect *mio_a = NULL;
	int status;
	unsigned long flags;

	if (!output) {
		MARS_ERR("bad private on mio %p\n", mio);
		goto regenerate;
	}
	mio_a = check_mars_io_get_aspect(output, mio);

	traced_lock(&output->lock, flags);
	if (list_empty(&mio_a->mio_head)) {
		MARS_ERR("mio callback called twice on %p\n", mio);
	}
	list_del_init(&mio_a->mio_head);
	//mio->cb_private = mio_a->old_private;
	traced_unlock(&output->lock, flags);

	mio_a->last_jiffies = jiffies;
regenerate:
	status = mio_a->old_mars_endio(mio, error);
	mio->cb_private = output;
	return status;
}

static void check_buf_endio(struct mars_buf_object *mbuf)
{
	struct check_output *output = mbuf->cb_private;
	struct check_mars_buf_aspect *mbuf_a = check_mars_buf_get_aspect(output, mbuf);
	unsigned long flags;

	traced_lock(&output->lock, flags);
	if (list_empty(&mbuf_a->mbuf_head)) {
		MARS_ERR("mbuf callback called twice on %p\n", mbuf);
	}
	list_del_init(&mbuf_a->mbuf_head);
	traced_unlock(&output->lock, flags);

	mbuf->cb_private = mbuf_a->old_private;
	mbuf_a->last_jiffies = jiffies;
	mbuf_a->old_buf_endio(mbuf);
	mbuf->cb_private = output;
}

static int check_watchdog(void *data)
{
	struct check_output *output = data;
	MARS_INF("watchdog has started.\n");
	while (!kthread_should_stop()) {
		struct list_head *h;
		unsigned long flags;
		unsigned long now;

		msleep_interruptible(5000);

		traced_lock(&output->lock, flags);

		now = jiffies;
		for (h = output->mio_anchor.next; h != &output->mio_anchor; h = h->next) {
			struct check_mars_io_aspect *mio_a;
			struct mars_io_object *mio;
			unsigned long elapsed;

			mio_a = container_of(h, struct check_mars_io_aspect, mio_head);
			mio = mio_a->object;
			elapsed = now - mio_a->last_jiffies;
			if (elapsed > 10 * HZ) {
				mio_a->last_jiffies = now;
				MARS_ERR("instance %d: mio %p callback is missing for more than 10 seconds.\n", output->instance_nr, mio);
			}
		}
		for (h = output->mbuf_anchor.next; h != &output->mbuf_anchor; h = h->next) {
			struct check_mars_buf_aspect *mbuf_a;
			struct mars_buf_object *mbuf;
			unsigned long elapsed;

			mbuf_a = container_of(h, struct check_mars_buf_aspect, mbuf_head);
			mbuf = mbuf_a->object;
			elapsed = now - mbuf_a->last_jiffies;
			if (elapsed > 10 * HZ) {
				mbuf_a->last_jiffies = now;
				MARS_ERR("instance %d: mbuf %p callback is missing for more than 10 seconds.\n", output->instance_nr, mbuf);
			}
		}
		traced_unlock(&output->lock, flags);
	}
	return 0;
}

////////////////// own brick / input / output operations //////////////////

static int check_io(struct check_output *output, struct mars_io_object *mio)
{
	struct check_input *input = output->brick->inputs[0];
	int status;
#if 0
	struct check_mars_io_aspect *mio_a = check_mars_io_get_aspect(output, mio);
	unsigned long flags;

	traced_lock(&output->lock, flags);
	if (!list_empty(&mio_a->mio_head)) {
		MARS_ERR("multiple mars_endio() in parallel on %p\n", mio);
	}
	list_add_tail(&mio_a->mio_head, &output->mio_anchor);
	if (mio->mars_endio != check_mars_endio) {
		mio_a->old_mars_endio = mio->mars_endio;
		mio->mars_endio = check_mars_endio;
	}
	mio_a->old_private = mio->cb_private;
	mio->cb_private = output;
	mio_a->last_jiffies = jiffies;
	traced_unlock(&output->lock, flags);

#endif
	status = GENERIC_INPUT_CALL(input, mars_io, mio);
#if 0
	if (status < 0) { // revert. TODO: change semantics to callback _always_
		traced_lock(&output->lock, flags);
		list_del_init(&mio_a->mio_head);
		traced_unlock(&output->lock, flags);
	}
#endif
	//mio->cb_private = mio_a->old_private;
	return status;
}

static int check_get_info(struct check_output *output, struct mars_info *info)
{
	struct check_input *input = output->brick->inputs[0];
	return GENERIC_INPUT_CALL(input, mars_get_info, info);
}

static int check_buf_get(struct check_output *output, struct mars_buf_object *mbuf)
{
	struct check_input *input = output->brick->inputs[0];
	return GENERIC_INPUT_CALL(input, mars_buf_get, mbuf);
}

static void check_buf_put(struct check_output *output, struct mars_buf_object *mbuf)
{
	struct check_input *input = output->brick->inputs[0];
	GENERIC_INPUT_CALL(input, mars_buf_put, mbuf);
}

static void check_buf_io(struct check_output *output, struct mars_buf_object *mbuf, int rw)
{
	struct check_input *input = output->brick->inputs[0];
	struct check_mars_buf_aspect *mbuf_a = check_mars_buf_get_aspect(output, mbuf);
	unsigned long flags;
	traced_lock(&output->lock, flags);
	if (!list_empty(&mbuf_a->mbuf_head)) {
		MARS_ERR("instance %d: multiple buf_endio() in parallel on %p\n", output->instance_nr, mbuf);
	}
	list_add_tail(&mbuf_a->mbuf_head, &output->mbuf_anchor);
	if (mbuf->cb_buf_endio != check_buf_endio) {
		mbuf_a->old_buf_endio = mbuf->cb_buf_endio;
		mbuf->cb_buf_endio = check_buf_endio;
		mbuf_a->old_private = mbuf->cb_private;
		mbuf->cb_private = output;
	}
	mbuf_a->last_jiffies = jiffies;
	traced_unlock(&output->lock, flags);
	GENERIC_INPUT_CALL(input, mars_buf_io, mbuf, rw);
}

//////////////// object / aspect constructors / destructors ///////////////

static int check_mars_io_aspect_init_fn(struct generic_aspect *_ini, void *_init_data)
{
	struct check_mars_io_aspect *ini = (void*)_ini;
	INIT_LIST_HEAD(&ini->mio_head);
	return 0;
}

static int check_mars_buf_aspect_init_fn(struct generic_aspect *_ini, void *_init_data)
{
	struct check_mars_buf_aspect *ini = (void*)_ini;
	INIT_LIST_HEAD(&ini->mbuf_head);
	return 0;
}

MARS_MAKE_STATICS(check);

////////////////////// brick constructors / destructors ////////////////////

static int check_brick_construct(struct check_brick *brick)
{
	return 0;
}

static int check_output_construct(struct check_output *output)
{
	static int count = 0;
	struct task_struct *watchdog;
	spin_lock_init(&output->lock);
	INIT_LIST_HEAD(&output->mio_anchor);
	INIT_LIST_HEAD(&output->mbuf_anchor);
	output->instance_nr = ++count;
	watchdog = kthread_create(check_watchdog, output, "check_watchdog%d", output->instance_nr);
	if (!IS_ERR(watchdog)) {
		output->watchdog = watchdog;
		wake_up_process(watchdog);
	}
	return 0;
}

///////////////////////// static structs ////////////////////////

static struct check_brick_ops check_brick_ops = {
};

static struct check_output_ops check_output_ops = {
	.make_object_layout = check_make_object_layout,
	.mars_io = check_io,
	.mars_get_info = check_get_info,
	.mars_buf_get = check_buf_get,
	.mars_buf_put = check_buf_put,
	.mars_buf_io = check_buf_io,
};

static const struct check_input_type check_input_type = {
	.type_name = "check_input",
	.input_size = sizeof(struct check_input),
};

static const struct check_input_type *check_input_types[] = {
	&check_input_type,
};

static const struct check_output_type check_output_type = {
	.type_name = "check_output",
	.output_size = sizeof(struct check_output),
	.master_ops = &check_output_ops,
	.output_construct = &check_output_construct,
	.aspect_types = check_aspect_types,
	.layout_code = {
		[BRICK_OBJ_MARS_IO] = LAYOUT_ALL,
		[BRICK_OBJ_MARS_BUF] = LAYOUT_ALL,
	}
};

static const struct check_output_type *check_output_types[] = {
	&check_output_type,
};

const struct check_brick_type check_brick_type = {
	.type_name = "check_brick",
	.brick_size = sizeof(struct check_brick),
	.max_inputs = 1,
	.max_outputs = 1,
	.master_ops = &check_brick_ops,
	.default_input_types = check_input_types,
	.default_output_types = check_output_types,
	.brick_construct = &check_brick_construct,
};
EXPORT_SYMBOL_GPL(check_brick_type);

////////////////// module init stuff /////////////////////////

static int __init init_check(void)
{
	printk(MARS_INFO "init_check()\n");
	return check_register_brick_type();
}

static void __exit exit_check(void)
{
	printk(MARS_INFO "exit_check()\n");
	check_unregister_brick_type();
}

MODULE_DESCRIPTION("MARS check brick");
MODULE_AUTHOR("Thomas Schoebel-Theuer <tst@1und1.de>");
MODULE_LICENSE("GPL");

module_init(init_check);
module_exit(exit_check);