service_runtime/nacl_desc_imc_shm.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 service runtime.  Transferrable shared memory objects.
  34  */
  35 #ifndef NATIVE_CLIENT_SERVICE_RUNTIME_NACL_DESC_IMC_SHM_H_
  36 #define NATIVE_CLIENT_SERVICE_RUNTIME_NACL_DESC_IMC_SHM_H_
  37
  38 #include "native_client/include/portability.h"
  39
  40 #include "native_client/include/nacl_base.h"
  41
  42 /*
  43  * get NaClHandle, which is a typedef and not a struct pointer, so
  44  * impossible to just forward declare.
  45  */
  46 #include "native_client/intermodule_comm/nacl_imc_c.h"
  47
  48 EXTERN_C_BEGIN
  49
  50 struct NaClDesc;
  51 struct NaClDescEffector;
  52 struct NaClDescImcShm;
  53 struct NaClDescXferState;
  54 struct NaClHostDesc;
  55 struct NaClMessageHeader;
  56 struct nacl_abi_timespec;
  57 struct nacl_abi_stat;
  58
  59 int NaClDescImcShmCtor(struct NaClDescImcShm  *self,
  60                        NaClHandle             h,
  61                        off_t                  size);
  62
  63 void NaClDescImcShmDtor(struct NaClDesc *vself);
  64
  65 struct NaClDescImcShm *NaClDescImcShmMake(struct NaClHostDesc *nhdp);
  66
  67 int NaClDescImcShmMap(struct NaClDesc         *vself,
  68                       struct NaClDescEffector *effp,
  69                       void                    *start_addr,
  70                       size_t                  len,
  71                       int                     prot,
  72                       int                     flags,
  73                       off_t                   offset);
  74
  75 int NaClDescImcShmUnmapUnsafe(struct NaClDesc         *vself,
  76                               struct NaClDescEffector *effp,
  77                               void                    *start_addr,
  78                               size_t                  len);
  79
  80 int NaClDescImcShmUnmap(struct NaClDesc         *vself,
  81                         struct NaClDescEffector *effp,
  82                         void                    *start_addr,
  83                         size_t                  len);
  84
  85 int NaClDescImcShmFstat(struct NaClDesc         *vself,
  86                         struct NaClDescEffector *effp,
  87                         struct nacl_abi_stat    *stbp);
  88
  89 int NaClDescImcShmClose(struct NaClDesc         *vself,
  90                         struct NaClDescEffector *effp);
  91
  92 int NaClDescImcShmExternalizeSize(struct NaClDesc *vself,
  93                                   size_t          *nbytes,
  94                                   size_t          *nhandles);
  95
  96 int NaClDescImcShmExternalize(struct NaClDesc           *vself,
  97                               struct NaClDescXferState  *xfer);
  98
  99 EXTERN_C_END
 100
 101 #endif