process.h

Go to the documentation of this file.

/*
 * Copyright (c) 2005, Swedish Institute of Computer Science
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the Institute nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * This file is part of the Contiki operating system.
 *
 * @(#)$Id: process.h,v 1.17 2010/09/14 18:55:04 dak664 Exp $
 */
 
#ifndef __PROCESS_H__
#define __PROCESS_H__
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "sys/pt.h"
#include "sys/cc.h"
 
typedef unsigned char process_event_t;
typedef void *process_data_t;
typedef uint32_t process_num_events_t;
 
#define PROCESS_ERR_OK 0
#define PROCESS_ERR_FULL 1
#define PROCESS_NONE NULL
 
#ifndef PROCESS_CONF_NUMEVENTS
#define PROCESS_CONF_NUMEVENTS       255
#define PROCESS_CONF_NUMEVENTS_PRINT 64
#define PROCESS_CONF_NUMEVENTS_ERROR 230
#endif /* PROCESS_CONF_NUMEVENTS */
 
#define PROCESS_EVENT_NONE            0x80
#define PROCESS_EVENT_INIT            0x81
#define PROCESS_EVENT_POLL            0x82
#define PROCESS_EVENT_EXIT            0x83
#define PROCESS_EVENT_SERVICE_REMOVED 0x84
#define PROCESS_EVENT_CONTINUE        0x85
#define PROCESS_EVENT_MSG             0x86
#define PROCESS_EVENT_EXITED          0x87
#define PROCESS_EVENT_TIMER           0x88
#define PROCESS_EVENT_COM             0x89
#define PROCESS_EVENT_MAX             0x8a
 
#define PROCESS_BROADCAST NULL
#define PROCESS_ZOMBIE    ((struct process *)0x1)
 
#define PROCESS_BEGIN() PT_BEGIN(process_pt)
 
#define PROCESS_END() PT_END(process_pt)
 
#define PROCESS_WAIT_EVENT() PROCESS_YIELD()
 
#define PROCESS_WAIT_EVENT_UNTIL(c) PROCESS_YIELD_UNTIL(c)
 
#define PROCESS_YIELD() PT_YIELD(process_pt)
 
#define PROCESS_YIELD_UNTIL(c) PT_YIELD_UNTIL(process_pt, c)
 
#define PROCESS_WAIT_UNTIL(c) PT_WAIT_UNTIL(process_pt, c)
#define PROCESS_WAIT_WHILE(c) PT_WAIT_WHILE(process_pt, c)
 
#define PROCESS_EXIT() PT_EXIT(process_pt)
 
#define PROCESS_PT_SPAWN(pt, thread) PT_SPAWN(process_pt, pt, thread)
 
#define PROCESS_PAUSE()                                            \
  do {                                                             \
    process_post(PROCESS_CURRENT(), PROCESS_EVENT_CONTINUE, NULL); \
    PROCESS_WAIT_EVENT();                                          \
  } while (0)
 
#define PROCESS_POLLHANDLER(handler) \
  if (ev == PROCESS_EVENT_POLL) {    \
    handler;                         \
  }
 
#define PROCESS_EXITHANDLER(handler) \
  if (ev == PROCESS_EVENT_EXIT) {    \
    handler;                         \
  }
 
#define PROCESS_THREAD(name, ev, data)                          \
  static PT_THREAD(process_thread_##name(struct pt *process_pt, \
                                         process_event_t ev,    \
                                         process_data_t data))
 
#define PROCESS_NAME(name) extern struct process name
 
#if PROCESS_CONF_NO_PROCESS_NAMES
#define PROCESS(name, strname)    \
  PROCESS_THREAD(name, ev, data); \
  struct process name = {NULL, process_thread_##name}
#else
#define PROCESS(name, strname)    \
  PROCESS_THREAD(name, ev, data); \
  struct process name = {NULL, strname, process_thread_##name}
#endif
 
struct process {
  struct process *next;
#if PROCESS_CONF_NO_PROCESS_NAMES
#define PROCESS_NAME_STRING(process) ""
#else
  const char *name;
#define PROCESS_NAME_STRING(process) (process)->name
#endif
  PT_THREAD((*thread)(struct pt *, process_event_t, process_data_t));
  struct pt pt;
  unsigned char state, needspoll;
};
 
CCIF void process_start(struct process *p, const char *arg) CC_REENTRANT_ARG;
 
CCIF int process_post(struct process *p,
                      process_event_t ev,
                      void *procdata) CC_REENTRANT_ARG;
 
CCIF int process_count_events(const struct process *p,
                              process_event_t ev,
                              const process_data_t procdata) CC_REENTRANT_ARG;
 
CCIF void process_post_synch(struct process *p,
                             process_event_t ev,
                             void *procdata) CC_REENTRANT_ARG;
 
CCIF void process_exit(struct process *p) CC_REENTRANT_ARG;
 
#define PROCESS_CURRENT() process_current
CCIF extern struct process *process_current;
 
#define PROCESS_CONTEXT_BEGIN(p)                     \
  {                                                  \
    struct process *tmp_current = PROCESS_CURRENT(); \
    process_current             = p
 
#define PROCESS_CONTEXT_END(p)   \
  process_current = tmp_current; \
  }
 
CCIF process_event_t process_alloc_event(void);
 
CCIF void process_poll(struct process *p) CC_REENTRANT_ARG;
 
void process_init(void);
 
int process_run(void);
 
CCIF int process_is_running(struct process *p) CC_REENTRANT_ARG;
 
int process_nevents(void);
 
CCIF extern struct process *process_list;
 
#define PROCESS_LIST() process_list
 
#ifdef __cplusplus
}
#endif
 
#endif /* __PROCESS_H__ */