/* * Copyright (c) 2004-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. * * Author: Adam Dunkels * * $Id: pt.h,v 1.7 2006/10/02 07:52:56 adam Exp $ */ /** * \addtogroup pt * @{ */ /** * \file * Protothreads implementation. * \author * Adam Dunkels * */ #ifndef __PT_H__ #define __PT_H__ #include "lc.h" struct pt { lc_t lc; }; #define PT_WAITING 0 #define PT_YIELDED 1 #define PT_EXITED 2 #define PT_ENDED 3 /** * \name 初始化 * @{ */ /** * 初始化protothread线程 * * 初始化protothread线程。初始化必须在开始执行原型线程之前完成。 * * \param pt 指向protothread线程控制结构的指针 * * \sa PT_SPAWN() * * \hideinitializer */ #define PT_INIT(pt) LC_INIT((pt)->lc) /** @} */ /** * \name 声明和定义 * @{ */ /** * 声明protothread线程。 * * 此宏用于声明protothread线程。必须使用此宏声明所有protothread线程 * * \param name_args 实现protothread线程的 C 函数的名称和参数。 * * \hideinitializer */ #define PT_THREAD(name_args) char name_args /** * 在实现protothread线程的 C 函数中声明protothread线程的开始 * * 此宏用于声明protothread线程的起点。它应该放在运行protothread线程的函数的开头。 * 每次调度 protothread 时，都将执行 PT_BEGIN（） 调用上方的所有 C 语句。 * * \param pt 指向原型线程控制结构的指针。 * * \hideinitializer */ #define PT_BEGIN(pt) { char PT_YIELD_FLAG = 1; LC_RESUME((pt)->lc) /** * 声明原型线程的结束。 * * 此宏用于声明原型线程结束。它必须始终与匹配的 PT_BEGIN（） 宏一起使用。 * * \param pt 指向原型线程控制结构的指针。 * * \hideinitializer */ #define PT_END(pt) LC_END((pt)->lc); PT_YIELD_FLAG = 0; \ PT_INIT(pt); return PT_ENDED; } /** @} */ /** * \name 阻止等待 * @{ */ /** * 阻止并等待条件为真 * * 此宏会阻塞原型线程，直到指定的条件为真 * * \param pt 指向原型线程控制结构的指针 * \param condition 条件。 * * \hideinitializer */ #define PT_WAIT_UNTIL(pt, condition) \ do { \ LC_SET((pt)->lc); \ if(!(condition)) { \ return PT_WAITING; \ } \ } while(0) /** * 阻止并等待条件为真。 * * 此功能在条件为真时阻止并等待. See * PT_WAIT_UNTIL(). * * \param pt 指向原型线程控制结构的指针 * \param cond 条件。 * * \hideinitializer */ #define PT_WAIT_WHILE(pt, cond) PT_WAIT_UNTIL((pt), !(cond)) /** @} */ /** * \name 分层原型线程 * @{ */ /** * 阻止并等待子原型线程完成。 * * This macro schedules a child protothread. The current protothread * will block until the child protothread completes. * * \note The child protothread must be manually initialized with the * PT_INIT() function before this function is used. * * \param pt A pointer to the protothread control structure. * \param thread The child protothread with arguments * * \sa PT_SPAWN() * * \hideinitializer */ #define PT_WAIT_THREAD(pt, thread) PT_WAIT_WHILE((pt), PT_SCHEDULE(thread)) /** * Spawn a child protothread and wait until it exits. * * This macro spawns a child protothread and waits until it exits. The * macro can only be used within a protothread. * * \param pt A pointer to the protothread control structure. * \param child A pointer to the child protothread's control structure. * \param thread The child protothread with arguments * * \hideinitializer */ #define PT_SPAWN(pt, child, thread) \ do { \ PT_INIT((child)); \ PT_WAIT_THREAD((pt), (thread)); \ } while(0) /** @} */ /** * \name Exiting and restarting * @{ */ /** * Restart the protothread. * * This macro will block and cause the running protothread to restart * its execution at the place of the PT_BEGIN() call. * * \param pt A pointer to the protothread control structure. * * \hideinitializer */ #define PT_RESTART(pt) \ do { \ PT_INIT(pt); \ return PT_WAITING; \ } while(0) /** * Exit the protothread. * * This macro causes the protothread to exit. If the protothread was * spawned by another protothread, the parent protothread will become * unblocked and can continue to run. * * \param pt A pointer to the protothread control structure. * * \hideinitializer */ #define PT_EXIT(pt) \ do { \ PT_INIT(pt); \ return PT_EXITED; \ } while(0) /** @} */ /** * \name Calling a protothread * @{ */ /** * Schedule a protothread. * * This function shedules a protothread. The return value of the * function is non-zero if the protothread is running or zero if the * protothread has exited. * * \param f The call to the C function implementing the protothread to * be scheduled * * \hideinitializer */ #define PT_SCHEDULE(f) ((f) < PT_EXITED) /** @} */ /** * \name Yielding from a protothread * @{ */ /** * Yield from the current protothread. * * This function will yield the protothread, thereby allowing other * processing to take place in the system. * * \param pt A pointer to the protothread control structure. * * \hideinitializer */ #define PT_YIELD(pt) \ do { \ PT_YIELD_FLAG = 0; \ LC_SET((pt)->lc); \ if(PT_YIELD_FLAG == 0) { \ return PT_YIELDED; \ } \ } while(0) /** * \brief Yield from the protothread until a condition occurs. * \param pt A pointer to the protothread control structure. * \param cond The condition. * * This function will yield the protothread, until the * specified condition evaluates to true. * * * \hideinitializer */ #define PT_YIELD_UNTIL(pt, cond) \ do { \ PT_YIELD_FLAG = 0; \ LC_SET((pt)->lc); \ if((PT_YIELD_FLAG == 0) || !(cond)) { \ return PT_YIELDED; \ } \ } while(0) /** @} */ #endif /* __PT_H__ */ /** @} */