service_runtime/nacl_sync.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 mutex and condition variable abstraction layer.
  34  * This is the host-OS-independent interface.
  35  */
  36 #ifndef NATIVE_CLIENT_SERVICE_RUNTIME_NACL_SYNC_H_
  37 #define NATIVE_CLIENT_SERVICE_RUNTIME_NACL_SYNC_H_
  38
  39 #include "native_client/include/nacl_base.h"
  40 #include "native_client/service_runtime/include/sys/time.h"
  41
  42 EXTERN_C_BEGIN
  43
  44 struct NaClMutex {
  45   void* lock;
  46 };
  47
  48 struct NaClCondVar {
  49   void* cv;
  50 };
  51
  52 typedef enum NaClSyncStatus {
  53   NACL_SYNC_OK,
  54   NACL_SYNC_INTERNAL_ERROR,
  55   NACL_SYNC_BUSY,
  56   NACL_SYNC_MUTEX_INVALID,
  57   NACL_SYNC_MUTEX_DEADLOCK,
  58   NACL_SYNC_MUTEX_PERMISSION,
  59   NACL_SYNC_MUTEX_INTERRUPTED,
  60   NACL_SYNC_CONDVAR_TIMEDOUT,
  61   NACL_SYNC_CONDVAR_INTR,
  62   NACL_SYNC_SEM_INTERRUPTED,
  63   NACL_SYNC_SEM_RANGE_ERROR,
  64 } NaClSyncStatus;
  65
  66 int NaClMutexCtor(struct NaClMutex *mp);  /* bool success/fail */
  67
  68 void NaClMutexDtor(struct NaClMutex *mp);
  69
  70 NaClSyncStatus NaClMutexLock(struct NaClMutex *mp);
  71
  72 NaClSyncStatus NaClMutexTryLock(struct NaClMutex *mp);
  73
  74 NaClSyncStatus NaClMutexUnlock(struct NaClMutex *mp);
  75
  76
  77 int NaClCondVarCtor(struct NaClCondVar *cvp);
  78
  79 void NaClCondVarDtor(struct NaClCondVar *cvp);
  80
  81 NaClSyncStatus NaClCondVarSignal(struct NaClCondVar *cvp);
  82
  83 NaClSyncStatus NaClCondVarBroadcast(struct NaClCondVar *cvp);
  84
  85 NaClSyncStatus NaClCondVarWait(struct NaClCondVar *cvp,
  86                                struct NaClMutex   *mp);
  87
  88 NaClSyncStatus NaClCondVarTimedWaitRelative(
  89     struct NaClCondVar              *cvp,
  90     struct NaClMutex                *mp,
  91     struct nacl_abi_timespec const  *reltime);
  92
  93 NaClSyncStatus NaClCondVarTimedWaitAbsolute(
  94     struct NaClCondVar              *cvp,
  95     struct NaClMutex                *mp,
  96     struct nacl_abi_timespec const  *abstime);
  97
  98
  99
 100 EXTERN_C_END
 101
 102
 103 #endif  /* NATIVE_CLIENT_SERVICE_RUNTIME_NACL_SYNC_H_ */