mars/mars_server.c

753 lines
18 KiB
C

// (c) 2010 Thomas Schoebel-Theuer / 1&1 Internet AG
// Server brick (just for demonstration)
//#define BRICK_DEBUGGING
//#define MARS_DEBUGGING
//#define IO_DEBUGGING
#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/string.h>
#include <linux/kthread.h>
#define _STRATEGY
#include "mars.h"
///////////////////////// own type definitions ////////////////////////
#include "mars_server.h"
static struct mars_socket server_socket = {};
static struct task_struct *server_thread = NULL;
static LIST_HEAD(server_list);
static spinlock_t server_lock = SPIN_LOCK_UNLOCKED;
///////////////////////// own helper functions ////////////////////////
static
int cb_thread(void *data)
{
struct server_brick *brick = data;
struct mars_socket *sock = &brick->handler_socket;
bool aborted = false;
bool ok = mars_get_socket(sock);
int status = -EINVAL;
brick->cb_running = ok;
wake_up_interruptible(&brick->startup_event);
MARS_DBG("--------------- cb_thread starting on socket #%d, ok = %d\n", sock->s_debug_nr, ok);
if (!ok)
goto done;
while (!kthread_should_stop() || !list_empty(&brick->cb_read_list) || !list_empty(&brick->cb_write_list) || atomic_read(&brick->in_flight) > 0) {
struct server_mref_aspect *mref_a;
struct mref_object *mref;
struct list_head *tmp;
unsigned long flags;
wait_event_interruptible_timeout(
brick->cb_event,
!list_empty(&brick->cb_read_list) ||
!list_empty(&brick->cb_write_list),
1 * HZ);
traced_lock(&brick->cb_lock, flags);
tmp = brick->cb_write_list.next;
if (tmp == &brick->cb_write_list) {
tmp = brick->cb_read_list.next;
if (tmp == &brick->cb_read_list) {
traced_unlock(&brick->cb_lock, flags);
msleep(1000 / HZ);
continue;
}
}
list_del_init(tmp);
traced_unlock(&brick->cb_lock, flags);
mref_a = container_of(tmp, struct server_mref_aspect, cb_head);
mref = mref_a->object;
status = -EINVAL;
CHECK_PTR(mref, err);
down(&brick->socket_sem);
status = mars_send_cb(sock, mref);
up(&brick->socket_sem);
err:
if (unlikely(status < 0) && !aborted) {
aborted = true;
MARS_WRN("cannot send response, status = %d\n", status);
/* Just shutdown the socket and forget all pending
* requests.
* The _client_ is responsible for resending
* any lost operations.
*/
mars_shutdown_socket(sock);
}
GENERIC_INPUT_CALL(brick->inputs[0], mref_put, mref);
atomic_dec(&brick->in_flight);
}
done:
brick->cb_running = false;
MARS_DBG("---------- cb_thread terminating, status = %d\n", status);
if (ok)
mars_put_socket(sock);
wake_up_interruptible(&brick->startup_event);
return status;
}
static
void server_endio(struct generic_callback *cb)
{
struct server_mref_aspect *mref_a;
struct mref_object *mref;
struct server_brick *brick;
int rw;
unsigned long flags;
mref_a = cb->cb_private;
CHECK_PTR(mref_a, err);
mref = mref_a->object;
CHECK_PTR(mref, err);
brick = mref_a->brick;
if (!brick) {
MARS_WRN("late IO callback -- cannot do anything\n");
return;
}
rw = mref->ref_rw;
traced_lock(&brick->cb_lock, flags);
if (rw) {
list_add_tail(&mref_a->cb_head, &brick->cb_write_list);
} else {
list_add_tail(&mref_a->cb_head, &brick->cb_read_list);
}
traced_unlock(&brick->cb_lock, flags);
wake_up_interruptible(&brick->cb_event);
return;
err:
MARS_FAT("cannot handle callback - giving up\n");
}
int server_io(struct server_brick *brick, struct mars_socket *sock)
{
struct mref_object *mref;
struct server_mref_aspect *mref_a;
int status = -ENOTRECOVERABLE;
if (!brick->cb_running || !mars_socket_is_alive(sock))
goto done;
mref = server_alloc_mref(brick, &brick->mref_object_layout);
status = -ENOMEM;
if (!mref)
goto done;
mref_a = server_mref_get_aspect(brick, mref);
if (unlikely(!mref_a)) {
mars_free_mref(mref);
goto done;
}
status = mars_recv_mref(sock, mref);
if (status < 0) {
mars_free_mref(mref);
goto done;
}
mref_a->brick = brick;
SETUP_CALLBACK(mref, server_endio, mref_a);
status = GENERIC_INPUT_CALL(brick->inputs[0], mref_get, mref);
if (unlikely(status < 0)) {
MARS_WRN("mref_get execution error = %d\n", status);
SIMPLE_CALLBACK(mref, status);
status = 0; // continue serving requests
goto done;
}
atomic_inc(&brick->in_flight);
GENERIC_INPUT_CALL(brick->inputs[0], mref_io, mref);
done:
return status;
}
static
void _clean_list(struct server_brick *brick, struct list_head *start)
{
for (;;) {
struct server_mref_aspect *mref_a;
struct mref_object *mref;
struct list_head *tmp = start->next;
if (tmp == start)
break;
list_del_init(tmp);
mref_a = container_of(tmp, struct server_mref_aspect, cb_head);
mref_a->brick = NULL;
mref = mref_a->object;
if (!mref)
continue;
GENERIC_INPUT_CALL(brick->inputs[0], mref_put, mref);
}
}
static
struct task_struct *_grab_handler(struct server_brick *brick)
{
struct task_struct *res;
spin_lock(&server_lock);
list_del_init(&brick->server_link);
res = brick->handler_thread;
brick->handler_thread = NULL;
spin_unlock(&server_lock);
return res;
}
static
int handler_thread(void *data)
{
struct server_brick *brick = data;
struct mars_socket *sock = &brick->handler_socket;
struct task_struct *cb_thread = brick->cb_thread;
int status = 0;
brick->cb_thread = NULL;
brick->self_shutdown = true;
wake_up_interruptible(&brick->startup_event);
MARS_DBG("--------------- handler_thread starting on socket %p\n", sock);
while (brick->cb_running && !sock->s_dead && !kthread_should_stop()) {
struct mars_cmd cmd = {};
status = mars_recv_struct(sock, &cmd, mars_cmd_meta);
if (unlikely(status < 0 || sock->s_dead)) {
MARS_WRN("dead = %d recv cmd status = %d\n", sock->s_dead, status);
break;
}
MARS_IO("cmd = %d\n", cmd.cmd_code);
status = -EPROTO;
switch (cmd.cmd_code) {
case CMD_NOP:
MARS_DBG("got NOP operation\n");
status = 0;
break;
case CMD_NOTIFY:
mars_trigger();
break;
case CMD_GETINFO:
{
struct mars_info info = {};
status = GENERIC_INPUT_CALL(brick->inputs[0], mars_get_info, &info);
if (status < 0) {
break;
}
down(&brick->socket_sem);
status = mars_send_struct(sock, &cmd, mars_cmd_meta);
if (status < 0) {
break;
}
status = mars_send_struct(sock, &info, mars_info_meta);
up(&brick->socket_sem);
break;
}
case CMD_GETENTS:
{
status = -EINVAL;
if (unlikely(!cmd.cmd_str1 || !mars_global))
break;
down(&brick->socket_sem);
down_read(&mars_global->dent_mutex);
status = mars_send_dent_list(sock, &mars_global->dent_anchor);
up_read(&mars_global->dent_mutex);
up(&brick->socket_sem);
if (status < 0) {
MARS_WRN("could not send dentry information, status = %d\n", status);
}
break;
}
case CMD_CONNECT:
{
struct mars_brick *prev;
const char *path = cmd.cmd_str1;
status = -EINVAL;
CHECK_PTR(path, err);
CHECK_PTR_NULL(mars_global, err);
CHECK_PTR_NULL(_bio_brick_type, err);
if (!mars_global->global_power.button) {
MARS_WRN("system is not alive\n");
goto err;
}
prev = make_brick_all(
mars_global,
NULL,
true,
NULL,
NULL,
10 * HZ,
path,
(const struct generic_brick_type*)_bio_brick_type,
(const struct generic_brick_type*[]){},
NULL,
1, // start always
path,
(const char *[]){},
0);
if (likely(prev)) {
status = generic_connect((void*)brick->inputs[0], (void*)prev->outputs[0]);
} else {
MARS_ERR("cannot find brick '%s'\n", path);
}
err:
cmd.cmd_int1 = status;
down(&brick->socket_sem);
status = mars_send_struct(sock, &cmd, mars_cmd_meta);
up(&brick->socket_sem);
break;
}
case CMD_MREF:
status = server_io(brick, sock);
break;
case CMD_CB:
MARS_ERR("oops, as a server I should never get CMD_CB; something is wrong here - attack attempt??\n");
break;
default:
MARS_ERR("unknown command %d\n", cmd.cmd_code);
}
brick_string_free(cmd.cmd_str1);
if (status < 0)
break;
}
mars_shutdown_socket(sock);
MARS_DBG("handler_thread terminating, status = %d\n", status);
if (cb_thread) {
MARS_INF("stopping cb thread...\n");
kthread_stop(cb_thread);
wait_event_interruptible_timeout(
brick->startup_event,
!brick->cb_running,
10 * HZ);
put_task_struct(cb_thread);
}
_clean_list(brick, &brick->cb_read_list);
_clean_list(brick, &brick->cb_write_list);
/* Normally, the brick should be shut down from outside.
* In case the handler thread stops abnormally (e.g.
* shutdown of socket etc), it has to cleanup itself.
* This is an exception to the basic rule of instance orientation
* that execution logic should be cleanly separated from strategy
* logic.
* So be careful, avoid races by use of _grab_handler().
*/
if (brick->self_shutdown) {
struct task_struct *h_thread;
MARS_DBG("self-shutdown\n");
h_thread = _grab_handler(brick);
mars_put_socket(sock);
if (h_thread) {
int status;
MARS_DBG("self cleanup...\n");
status = mars_kill_brick((void*)brick);
if (status < 0) {
MARS_ERR("kill status = %d, giving up\n", status);
}
put_task_struct(h_thread);
}
}
MARS_DBG("done.\n");
return status;
}
////////////////// own brick / input / output operations //////////////////
static int server_get_info(struct server_output *output, struct mars_info *info)
{
struct server_input *input = output->brick->inputs[0];
return GENERIC_INPUT_CALL(input, mars_get_info, info);
}
static int server_ref_get(struct server_output *output, struct mref_object *mref)
{
struct server_input *input = output->brick->inputs[0];
return GENERIC_INPUT_CALL(input, mref_get, mref);
}
static void server_ref_put(struct server_output *output, struct mref_object *mref)
{
struct server_input *input = output->brick->inputs[0];
GENERIC_INPUT_CALL(input, mref_put, mref);
}
static void server_ref_io(struct server_output *output, struct mref_object *mref)
{
struct server_input *input = output->brick->inputs[0];
GENERIC_INPUT_CALL(input, mref_io, mref);
}
static int server_switch(struct server_brick *brick)
{
int status = 0;
if (brick->power.button) {
static int version = 0;
struct task_struct *thread;
mars_power_led_off((void*)brick, false);
MARS_INF("starting.....\n");
spin_lock(&server_lock);
list_add(&brick->server_link, &server_list);
spin_unlock(&server_lock);
thread = kthread_create(cb_thread, brick, "mars_cb%d", version);
if (IS_ERR(thread)) {
status = PTR_ERR(thread);
MARS_ERR("cannot create cb thread, status = %d\n", status);
goto err;
}
get_task_struct(thread);
brick->cb_thread = thread;
wake_up_process(thread);
thread = kthread_create(handler_thread, brick, "mars_handler%d", version++);
if (IS_ERR(thread)) {
status = PTR_ERR(thread);
MARS_ERR("cannot create handler thread, status = %d\n", status);
kthread_stop(brick->cb_thread);
goto err;
}
get_task_struct(thread);
brick->handler_thread = thread;
wake_up_process(thread);
wait_event_interruptible(brick->startup_event, brick->cb_thread == NULL);
err:
if (status >= 0) {
mars_power_led_on((void*)brick, true);
}
} else {
struct task_struct *thread;
struct mars_socket *sock = &brick->handler_socket;
mars_power_led_on((void*)brick, false);
mars_shutdown_socket(sock);
thread = _grab_handler(brick);
if (thread) {
brick->handler_thread = NULL;
MARS_INF("stopping handler thread....\n");
kthread_stop(thread);
if (sock->s_socket)
mars_put_socket(sock);
put_task_struct(thread);
} else {
MARS_WRN("handler thread does not exist\n");
}
mars_power_led_off((void*)brick, true);
}
return status;
}
//////////////// informational / statistics ///////////////
static
char *server_statistics(struct server_brick *brick, int verbose)
{
char *res = brick_string_alloc(1024);
if (!res)
return NULL;
snprintf(res, 1024,
"cb_running = %d self_shutdown = %d in_flight = %d\n",
brick->cb_running, brick->self_shutdown,
atomic_read(&brick->in_flight));
return res;
}
static
void server_reset_statistics(struct server_brick *brick)
{
}
//////////////// object / aspect constructors / destructors ///////////////
static int server_mref_aspect_init_fn(struct generic_aspect *_ini)
{
struct server_mref_aspect *ini = (void*)_ini;
INIT_LIST_HEAD(&ini->cb_head);
return 0;
}
static void server_mref_aspect_exit_fn(struct generic_aspect *_ini)
{
struct server_mref_aspect *ini = (void*)_ini;
CHECK_HEAD_EMPTY(&ini->cb_head);
}
MARS_MAKE_STATICS(server);
////////////////////// brick constructors / destructors ////////////////////
static int server_brick_construct(struct server_brick *brick)
{
INIT_LIST_HEAD(&brick->server_link);
init_waitqueue_head(&brick->startup_event);
init_waitqueue_head(&brick->cb_event);
sema_init(&brick->socket_sem, 1);
spin_lock_init(&brick->cb_lock);
INIT_LIST_HEAD(&brick->cb_read_list);
INIT_LIST_HEAD(&brick->cb_write_list);
return 0;
}
static int server_output_construct(struct server_output *output)
{
return 0;
}
///////////////////////// static structs ////////////////////////
static struct server_brick_ops server_brick_ops = {
.brick_switch = server_switch,
.brick_statistics = server_statistics,
.reset_statistics = server_reset_statistics,
};
static struct server_output_ops server_output_ops = {
.mars_get_info = server_get_info,
.mref_get = server_ref_get,
.mref_put = server_ref_put,
.mref_io = server_ref_io,
};
const struct server_input_type server_input_type = {
.type_name = "server_input",
.input_size = sizeof(struct server_input),
};
static const struct server_input_type *server_input_types[] = {
&server_input_type,
};
const struct server_output_type server_output_type = {
.type_name = "server_output",
.output_size = sizeof(struct server_output),
.master_ops = &server_output_ops,
.output_construct = &server_output_construct,
};
static const struct server_output_type *server_output_types[] = {
&server_output_type,
};
const struct server_brick_type server_brick_type = {
.type_name = "server_brick",
.brick_size = sizeof(struct server_brick),
.max_inputs = 1,
.max_outputs = 0,
.master_ops = &server_brick_ops,
.aspect_types = server_aspect_types,
.default_input_types = server_input_types,
.default_output_types = server_output_types,
.brick_construct = &server_brick_construct,
};
EXPORT_SYMBOL_GPL(server_brick_type);
///////////////////////////////////////////////////////////////////////
// strategy layer
static int _server_thread(void *data)
{
char *id = my_id();
struct server_brick *brick = NULL;
int status = 0;
MARS_INF("-------- server starting on host '%s' ----------\n", id);
while (!kthread_should_stop() &&
(!mars_global || !mars_global->global_power.button)) {
MARS_DBG("system did not start up\n");
msleep(5000);
}
MARS_INF("-------- server now working on host '%s' ----------\n", id);
while (!kthread_should_stop() && mars_global && mars_global->global_power.button) {
if (!brick) {
brick = (void*)mars_make_brick(mars_global, NULL, true, &server_brick_type, "server", "server");
if (!brick) {
MARS_ERR("cannot create server instance\n");
msleep(5000);
continue;
}
}
status = mars_accept_socket(&brick->handler_socket, &server_socket);
if (unlikely(status < 0)) {
msleep(500);
if (status == -EAGAIN)
continue; // without error message
MARS_WRN("accept status = %d\n", status);
msleep(2000);
continue;
}
brick->handler_socket.s_shutdown_on_err = true;
MARS_DBG("got new connection #%d\n", brick->handler_socket.s_debug_nr);
/* TODO: check authorization.
*/
if (!mars_global || !mars_global->global_power.button || kthread_should_stop()) {
MARS_WRN("system is not alive\n");
goto err;
}
brick->power.button = true;
status = server_switch(brick);
if (unlikely(status < 0)) {
MARS_ERR("cannot switch on server brick, status = %d\n", status);
goto err;
}
brick = NULL;
msleep(1000);
continue;
err:
if (brick) {
mars_put_socket(&brick->handler_socket);
status = mars_kill_brick((void*)brick);
if (status < 0) {
BRICK_ERR("kill status = %d, giving up\n", status);
}
brick = NULL;
}
msleep(3000);
}
MARS_INF("-------- cleaning up ----------\n");
if (brick) {
MARS_DBG("cleaning up unused brick\n");
#if 0 // FIXME
if (brick->handler_socket.s_socket) {
MARS_DBG("put socket\n");
mars_put_socket(&brick->handler_socket);
}
status = mars_kill_brick((void*)brick);
if (unlikely(status < 0)) {
BRICK_WRN("kill status = %d, giving up\n", status);
}
#endif
brick = NULL;
}
spin_lock(&server_lock);
while (!list_empty(&server_list)) {
struct list_head *tmp = server_list.next;
struct server_brick *brick = container_of(tmp, struct server_brick, server_link);
list_del_init(tmp);
brick->self_shutdown = false;
spin_unlock(&server_lock);
MARS_INF("cleanup ....\n");
status = mars_kill_brick((void*)brick);
if (status < 0) {
BRICK_ERR("kill status = %d, giving up\n", status);
}
spin_lock(&server_lock);
}
spin_unlock(&server_lock);
//cleanup_mm();
MARS_INF("-------- done status = %d ----------\n", status);
return status;
}
////////////////// module init stuff /////////////////////////
int __init init_mars_server(void)
{
struct sockaddr_storage sockaddr = {};
struct task_struct *thread;
int status;
MARS_INF("init_server()\n");
#if 1
status = mars_create_sockaddr(&sockaddr, "");
if (status < 0)
return status;
status = mars_create_socket(&server_socket, &sockaddr, true);
if (unlikely(status < 0)) {
MARS_ERR("could not create server socket, status = %d\n", status);
return status;
}
thread = kthread_create(_server_thread, NULL, "mars_server");
if (IS_ERR(thread)) {
status = PTR_ERR(thread);
mars_put_socket(&server_socket);
return status;
}
get_task_struct(thread);
server_thread = thread;
wake_up_process(thread);
#endif
return server_register_brick_type();
}
void __exit exit_mars_server(void)
{
MARS_INF("exit_server()\n");
server_unregister_brick_type();
if (server_thread) {
MARS_INF("stopping server thread...\n");
kthread_stop(server_thread);
put_task_struct(server_thread);
server_thread = NULL;
mars_put_socket(&server_socket);
}
}
#ifndef CONFIG_MARS_HAVE_BIGMODULE
MODULE_DESCRIPTION("MARS server brick");
MODULE_AUTHOR("Thomas Schoebel-Theuer <tst@1und1.de>");
MODULE_LICENSE("GPL");
module_init(init_mars_server);
module_exit(exit_mars_server);
#endif