service_runtime/nacl_threads.h

   1 /*
   2  * Copyright 2008, Google Inc.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met:
   8  *
   9  *     * Redistributions of source code must retain the above copyright
  10  * notice, this list of conditions and the following disclaimer.
  11  *     * Redistributions in binary form must reproduce the above
  12  * copyright notice, this list of conditions and the following disclaimer
  13  * in the documentation and/or other materials provided with the
  14  * distribution.
  15  *     * Neither the name of Google Inc. nor the names of its
  16  * contributors may be used to endorse or promote products derived from
  17  * this software without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 /*
  33  * NaCl Server Runtime threads abstraction layer.
  34  */
  35
  36 #ifndef SERVICE_RUNTIME_NACL_THREADS_H__
  37 #define SERVICE_RUNTIME_NACL_THREADS_H__ 1
  38
  39 #include "native_client/include/nacl_base.h"
  40 #include "native_client/include/portability.h"
  41
  42 EXTERN_C_BEGIN
  43
  44 #if NACL_LINUX || NACL_OSX
  45 # include "native_client/service_runtime/linux/nacl_threads_types.h"
  46 #elif NACL_WINDOWS
  47 # include "native_client/service_runtime/win/nacl_threads_types.h"
  48 #else
  49 # error "thread abstraction not defined for target OS"
  50 #endif
  51
  52 typedef enum NaClThreadStatus {
  53   NACL_THREAD_OK,
  54   NACL_THREAD_RESOURCE_LIMIT,
  55 } NaClThreadStatus;
  56
  57 /*
  58  * Abstract low-level thread creation.  No thread attribute is
  59  * available, so no scheduling hint interface, no ability to set the
  60  * detach state, etc.  All threads are detached, and the main service
  61  * runtime thread must consult the NaClApp or NaClAppThread state to
  62  * figure out which thread(s) are still running.
  63  */
  64 int NaClThreadCtor(struct NaClThread  *ntp,
  65                    void               (WINAPI *start_fn)(void *),
  66                    void               *state,
  67                    size_t             stack_size);
  68
  69 /*
  70  * NaClThreadDtor is used to clean up the NaClThread object, and
  71  * cannot be invoked while the thread is still alive.
  72  */
  73 void NaClThreadDtor(struct NaClThread *ntp);
  74
  75 /*
  76  * NaClThreadExit is invoked by the thread itself.
  77  */
  78 void NaClThreadExit(void);
  79
  80 /*
  81  * NaClThreadKill will be used to attempt to clean up after a badly
  82  * behaving NaClApp.
  83  */
  84 void NaClThreadKill(struct NaClThread *target);
  85
  86 /*
  87  * Thread Specific Data.  Both Linux and Windows support Thread Local
  88  * Storage, but OSX does not.  Thus, we use the older, more primitive
  89  * TSD interface to get thread-specific information.
  90  */
  91
  92 int NaClTsdKeyCreate(struct NaClTsdKey  *tsdp);
  93
  94 int NaClTsdSetSpecific(struct NaClTsdKey  *tsdp,
  95                        void const         *ptr);
  96
  97 void *NaClTsdGetSpecific(struct NaClTsdKey  *tsdp);
  98
  99 uint32_t NaClThreadId(void);
 100
 101 EXTERN_C_END
 102
 103 #endif