/*
 * PM2: Parallel Multithreaded Machine
 * Copyright (C) 2001 the PM2 team (see AUTHORS file)
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or (at
 * your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 */


#ifndef __SYS_MARCEL_WORK_H__
#define __SYS_MARCEL_WORK_H__


#include "marcel_config.h"
#include "sys/linux_spinlock.h"


/** Public functions **/
#ifdef MARCEL_DEVIATION_ENABLED
void marcel_enable_deviation(void);
void marcel_disable_deviation(void);
void marcel_deviate(marcel_t pid, marcel_handler_func_t h, any_t arg);
void marcel_do_deviate(marcel_t pid, marcel_handler_func_t h, any_t arg);
#endif				/* MARCEL_DEVIATION_ENABLED */


/** Public data types **/
typedef struct marcel_work marcel_work_t;
#ifdef MARCEL_DEVIATION_ENABLED
typedef struct deviate_record_struct_t deviate_record_t;
#endif				/* MARCEL_DEVIATION_ENABLED */


/** Public data structures **/
#ifdef MARCEL_DEVIATION_ENABLED
struct marcel_work {
	volatile unsigned has_work;
	deviate_record_t *deviate_work;
	ma_spinlock_t deviate_lock;
};
#else				/* MARCEL_DEVIATION_ENABLED */
struct marcel_work {
};
#endif				/* MARCEL_DEVIATION_ENABLED */



#ifdef __MARCEL_KERNEL__
TBX_VISIBILITY_PUSH_INTERNAL


/** Internal macros **/
#ifdef MARCEL_DEVIATION_ENABLED
#define MARCEL_WORK_INIT ((marcel_work_t) {	\
	.has_work = 0,	                        \
        .deviate_work = NULL,			\
	.deviate_lock = MA_SPIN_LOCK_UNLOCKED	\
})

/* flags indiquant le type de travail à faire */
enum {
	MARCEL_WORK_DEVIATE = 0x1
};
#define HAS_DEVIATE_WORK(pid)  ((pid)->work.has_work & MARCEL_WORK_DEVIATE)
#define SET_DEVIATE_WORK(pid)  do { (pid)->work.has_work |= MARCEL_WORK_DEVIATE; } while(0)
#define CLR_DEVIATE_WORK(pid)  do { (pid)->work.has_work &= ~MARCEL_WORK_DEVIATE; } while(0)
void ma_do_work(marcel_t self);

#else				/* MARCEL_DEVIATION_ENABLED */

#define MARCEL_WORK_INIT ((marcel_work_t) {})
#define HAS_DEVIATE_WORK(pid) 0
#define SET_DEVIATE_WORK(pid) MA_BUG()
#define CLR_DEVIATE_WORK(pid) MA_BUG()
#define ma_do_work(pid) ((void)0)
#endif				/* MARCEL_DEVIATION_ENABLED */


/** Internal data structures **/
#ifdef MARCEL_DEVIATION_ENABLED
struct deviate_record_struct_t {
	marcel_handler_func_t func;
	any_t arg;
	struct deviate_record_struct_t *next;
};
#endif				/* MARCEL_DEVIATION_ENABLED */


/** Internal functions **/
#ifdef MARCEL_DEVIATION_ENABLED
void ma_deviate_init(void);
void marcel_execute_deviate_work(void);
#endif				/* MARCEL_DEVIATION_ENABLED */


TBX_VISIBILITY_POP
#endif /** __MARCEL_KERNEL__ **/
#endif /** __SYS_MARCEL_WORK_H__ **/