service_runtime/nacl_sync_checked.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  * The NaClX* interfaces just invoke the no-X versions of the
  35  * synchronization routines, and aborts if there are any error
  36  * returns.
  37  */
  38
  39 #ifndef NATIVE_CLIENT_SERVICE_RUNTIME_NACL_SYNC_CHECKED_H_
  40 #define NATIVE_CLIENT_SERVICE_RUNTIME_NACL_SYNC_CHECKED_H_
  41
  42 #include "native_client/include/nacl_base.h"
  43
  44 #include "native_client/service_runtime/nacl_sync.h"
  45
  46 EXTERN_C_BEGIN
  47
  48 /*
  49  * These are simple checked versions of the nacl_sync API which will
  50  * abort on any unexpected return value.
  51  */
  52
  53 void NaClXMutexLock(struct NaClMutex *mp);
  54 NaClSyncStatus NaClXMutexTryLock(struct NaClMutex *mp);
  55 void NaClXMutexUnlock(struct NaClMutex *mp);
  56 void NaClXCondVarSignal(struct NaClCondVar *cvp);
  57 void NaClXCondVarBroadcast(struct NaClCondVar *cvp);
  58 void NaClXCondVarWait(struct NaClCondVar *cvp,
  59                       struct NaClMutex   *mp);
  60 NaClSyncStatus NaClXCondVarTimedWaitAbsolute(
  61     struct NaClCondVar              *cvp,
  62     struct NaClMutex                *mp,
  63     struct nacl_abi_timespec const  *abstime);
  64
  65 NaClSyncStatus NaClXCondVarTimedWaitRelative(
  66     struct NaClCondVar              *cvp,
  67     struct NaClMutex                *mp,
  68     struct nacl_abi_timespec const  *reltime);
  69
  70 EXTERN_C_END
  71
  72 #endif