diff options
author | Ben Cheng <bccheng@google.com> | 2014-03-25 22:37:19 -0700 |
---|---|---|
committer | Ben Cheng <bccheng@google.com> | 2014-03-25 22:37:19 -0700 |
commit | 1bc5aee63eb72b341f506ad058502cd0361f0d10 (patch) | |
tree | c607e8252f3405424ff15bc2d00aa38dadbb2518 /gcc-4.9/libcilkrts/runtime/signal_node.h | |
parent | 283a0bf58fcf333c58a2a92c3ebbc41fb9eb1fdb (diff) | |
download | toolchain_gcc-1bc5aee63eb72b341f506ad058502cd0361f0d10.tar.gz toolchain_gcc-1bc5aee63eb72b341f506ad058502cd0361f0d10.tar.bz2 toolchain_gcc-1bc5aee63eb72b341f506ad058502cd0361f0d10.zip |
Initial checkin of GCC 4.9.0 from trunk (r208799).
Change-Id: I48a3c08bb98542aa215912a75f03c0890e497dba
Diffstat (limited to 'gcc-4.9/libcilkrts/runtime/signal_node.h')
-rw-r--r-- | gcc-4.9/libcilkrts/runtime/signal_node.h | 109 |
1 files changed, 109 insertions, 0 deletions
diff --git a/gcc-4.9/libcilkrts/runtime/signal_node.h b/gcc-4.9/libcilkrts/runtime/signal_node.h new file mode 100644 index 000000000..0a1fe2002 --- /dev/null +++ b/gcc-4.9/libcilkrts/runtime/signal_node.h @@ -0,0 +1,109 @@ +/* signal_node.h -*-C++-*- + * + ************************************************************************* + * + * @copyright + * Copyright (C) 2009-2013, Intel Corporation + * All rights reserved. + * + * @copyright + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * 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. + * * Neither the name of Intel Corporation nor the names of its + * contributors may be used to endorse or promote products derived + * from this software without specific prior written permission. + * + * @copyright + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT + * HOLDER 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. + **************************************************************************/ + +/** + * @file signal_node.h + * + * @brief Signal nodes allow coordinated waking and sleeping of the runtime + * without hammering on a single location in memory. + * + * The workers are logically arranged in a binary tree and propagate messages + * leaf-ward. User workers notify the root about waking and sleeping, so only + * that one node need share a cache line with a user worker. + */ + +#ifndef INCLUDED_SIGNAL_NODE_DOT_H +#define INCLUDED_SIGNAL_NODE_DOT_H + +#include "rts-common.h" +#include <cilk/common.h> + +__CILKRTS_BEGIN_EXTERN_C + +/** Opaque type. */ +typedef struct signal_node_t signal_node_t; + +/** + * Allocate and initialize a signal_node_t + * + * @return The initialized signal_node_t + */ +COMMON_SYSDEP +signal_node_t *signal_node_create(void); + +/** + * Free any resources and deallocate a signal_node_t + * + * @param node The node to be deallocated. + */ +COMMON_SYSDEP void signal_node_destroy(signal_node_t *node); + +/** + * Test whether the node thinks the worker should go to sleep + * + * @param node The node to be tested. + * + * @return 1 If the worker should go to sleep + * @return 0 If the worker should not go to sleep + */ +COMMON_SYSDEP +unsigned int signal_node_should_wait(signal_node_t *node); + +/** + * Specify whether the worker should go to sleep + * + * @param node The node to be set. + * @param msg The value to be set. Valid values are: + * - 0 - the worker should go to sleep + * - 1 - the worker should stay active + */ +COMMON_SYSDEP +void signal_node_msg(signal_node_t *node, unsigned int msg); + + +/** + * Wait for the node to be set + * + * @param node The node to wait on + */ +COMMON_SYSDEP +void signal_node_wait(signal_node_t *node); + +__CILKRTS_END_EXTERN_C + +#endif // ! defined(INCLUDED_SIGNAL_NODE_DOT_H) |