service_runtime/nacl_desc_base.c

   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.  I/O Descriptor / Handle abstraction.  Memory
  34  * mapping using descriptors.
  35  */
  36
  37 #include <stdlib.h>
  38
  39 #include "native_client/include/portability.h"
  40
  41 #include "native_client/service_runtime/nacl_config.h"
  42 #include "native_client/service_runtime/nacl_log.h"
  43 #include "native_client/service_runtime/nacl_desc_base.h"
  44 #include "native_client/service_runtime/nacl_sync_checked.h"
  45 #include "native_client/service_runtime/sel_util.h"
  46
  47 /*
  48  * This file contains base class code for NaClDesc.
  49  *
  50  * The implementation for following subclasses are elsewhere, but here
  51  * is an enumeration of them with a brief description:
  52  *
  53  * NaClDescIoDesc is the subclass that wraps host-OS descriptors
  54  * provided by NaClHostDesc (which gives an OS-independent abstraction
  55  * for host-OS descriptors).
  56  *
  57  * NaClDescImcDesc is the subclass that wraps IMC descriptors.
  58  *
  59  * NaClDescMutex and NaClDescCondVar are the subclasses that
  60  * wrap the non-transferrable synchronization objects.
  61  *
  62  * These NaClDesc objects are impure in that they know about the
  63  * virtual memory subsystem restriction of requiring mappings to occur
  64  * in NACL_MAP_PAGESIZE (64KB) chunks, so the Map and Unmap virtual
  65  * functions, at least, will enforce this restriction.
  66  */
  67
  68 int NaClDescCtor(struct NaClDesc *ndp)
  69 {
  70   /* this should be a compile-time test */
  71   if (0 != (sizeof(struct NaClInternalHeader) & 0xf)) {
  72     NaClLog(LOG_FATAL,
  73             "Internal error.  NaClInternalHeader size not a"
  74             " multiple of 16\n");
  75   }
  76   ndp->ref_count = 1;
  77   return NaClMutexCtor(&ndp->mu);
  78 }
  79
  80 void NaClDescDtor(struct NaClDesc *ndp)
  81 {
  82   if (0 != ndp->ref_count) {
  83     NaClLog(LOG_FATAL, ("NaClDescDtor invoked on a generic descriptor"
  84                         " at 0x%08"PRIxPTR" with non-zero"
  85                         " reference count (%d)\n"),
  86             (uintptr_t) ndp,
  87             ndp->ref_count);
  88   }
  89   NaClLog(4, "NaClDescDtor(0x%08"PRIxPTR"), refcount 0, destroying.\n",
  90           (uintptr_t) ndp);
  91   NaClMutexDtor(&ndp->mu);
  92 }
  93
  94 struct NaClDesc *NaClDescRef(struct NaClDesc *ndp)
  95 {
  96   NaClLog(4, "NaClDescRef(0x%08"PRIxPTR").\n",
  97           (uintptr_t) ndp);
  98   NaClXMutexLock(&ndp->mu);
  99   if (0 == ++ndp->ref_count) {
 100     NaClLog(LOG_FATAL, "NaClDescRef integer overflow\n");
 101   }
 102   NaClXMutexUnlock(&ndp->mu);
 103   return ndp;
 104 }
 105
 106 void NaClDescUnref(struct NaClDesc *ndp)
 107 {
 108   int destroy;
 109
 110   NaClLog(4, "NaClDescUnref(0x%08"PRIxPTR").\n",
 111           (uintptr_t) ndp);
 112   NaClXMutexLock(&ndp->mu);
 113   if (0 == ndp->ref_count) {
 114     NaClLog(LOG_FATAL,
 115             "NaClDescUnref on 0x%08"PRIxPTR", refcount already zero!\n",
 116             (uintptr_t) ndp);
 117   }
 118   destroy = (0 == --ndp->ref_count);
 119   NaClXMutexUnlock(&ndp->mu);
 120   if (destroy) {
 121     (*ndp->vtbl->Dtor)(ndp);
 122     free(ndp);
 123   }
 124 }
 125
 126 int (*NaClDescInternalize[NACL_DESC_TYPE_MAX])(struct NaClDesc **,
 127                                                struct NaClDescXferState *) = {
 128   NaClDescDirInternalize,
 129   NaClDescIoInternalize,
 130   NaClDescConnCapInternalize,
 131   NaClDescImcBoundDescInternalize,
 132   NaClDescImcDescInternalize,
 133   NaClDescImcShmInternalize,
 134   NaClDescMutexInternalize,
 135   NaClDescCondVarInternalize,
 136 };
 137
 138 char const *NaClDescTypeString(enum NaClDescTypeTag type_tag)
 139 {
 140   /* default functions for the vtable - return NOT_IMPLEMENTED */
 141   switch (type_tag) {
 142 #define MAP(E) case E: do { return #E; } while (0)
 143     MAP(NACL_DESC_DIR);
 144     MAP(NACL_DESC_HOST_IO);
 145     MAP(NACL_DESC_CONN_CAP);
 146     MAP(NACL_DESC_BOUND_SOCKET);
 147     MAP(NACL_DESC_CONNECTED_SOCKET);
 148     MAP(NACL_DESC_SHM);
 149     MAP(NACL_DESC_MUTEX);
 150     MAP(NACL_DESC_CONDVAR);
 151     MAP(NACL_DESC_SEMAPHORE);
 152   }
 153   return "BAD TYPE TAG";
 154 }
 155 void NaClDescDtorNotImplemented(struct NaClDesc  *vself)
 156 {
 157   NaClLog(LOG_FATAL, "Must implement a destructor!\n");
 158 }
 159
 160 int NaClDescMapNotImplemented(struct NaClDesc         *vself,
 161                               struct NaClDescEffector *effp,
 162                               void                    *start_addr,
 163                               size_t                  len,
 164                               int                     prot,
 165                               int                     flags,
 166                               off_t                   offset)
 167 {
 168   NaClLog(LOG_ERROR,
 169           "Map method is not implemented for object of type %s\n",
 170           NaClDescTypeString(vself->vtbl->typeTag));
 171   return -NACL_ABI_EINVAL;
 172 }
 173
 174 int NaClDescUnmapUnsafeNotImplemented(struct NaClDesc         *vself,
 175                                       struct NaClDescEffector *effp,
 176                                       void                    *start_addr,
 177                                       size_t                  len)
 178 {
 179   NaClLog(LOG_ERROR,
 180     "Map method is not implemented for object of type %s\n",
 181     NaClDescTypeString(vself->vtbl->typeTag));
 182   return -NACL_ABI_EINVAL;
 183 }
 184
 185 int NaClDescUnmapNotImplemented(struct NaClDesc         *vself,
 186                                 struct NaClDescEffector *effp,
 187                                 void                    *start_addr,
 188                                 size_t                  len)
 189 {
 190   NaClLog(LOG_ERROR,
 191           "Unmap method is not implemented for object of type %s\n",
 192           NaClDescTypeString(vself->vtbl->typeTag));
 193   return -NACL_ABI_EINVAL;
 194 }
 195
 196 ssize_t NaClDescReadNotImplemented(struct NaClDesc          *vself,
 197                                    struct NaClDescEffector  *effp,
 198                                    void                     *buf,
 199                                    size_t                   len)
 200 {
 201   NaClLog(LOG_ERROR,
 202           "Read method is not implemented for object of type %s\n",
 203           NaClDescTypeString(vself->vtbl->typeTag));
 204   return -NACL_ABI_EINVAL;
 205 }
 206
 207 ssize_t NaClDescWriteNotImplemented(struct NaClDesc         *vself,
 208                                     struct NaClDescEffector *effp,
 209                                     void const              *buf,
 210                                     size_t                  len)
 211 {
 212   NaClLog(LOG_ERROR,
 213           "Write method is not implemented for object of type %s\n",
 214           NaClDescTypeString(vself->vtbl->typeTag));
 215   return -NACL_ABI_EINVAL;
 216 }
 217
 218 int NaClDescSeekNotImplemented(struct NaClDesc          *vself,
 219                                struct NaClDescEffector  *effp,
 220                                off_t                    offset,
 221                                int                      whence)
 222 {
 223   NaClLog(LOG_ERROR,
 224           "Seek method is not implemented for object of type %s\n",
 225           NaClDescTypeString(vself->vtbl->typeTag));
 226   return -NACL_ABI_EINVAL;
 227 }
 228
 229 int NaClDescIoctlNotImplemented(struct NaClDesc         *vself,
 230                                 struct NaClDescEffector *effp,
 231                                 int                     request,
 232                                 void                    *arg)
 233 {
 234   NaClLog(LOG_ERROR,
 235           "Ioctl method is not implemented for object of type %s\n",
 236           NaClDescTypeString(vself->vtbl->typeTag));
 237   return -NACL_ABI_EINVAL;
 238 }
 239
 240 int NaClDescFstatNotImplemented(struct NaClDesc         *vself,
 241                                 struct NaClDescEffector *effp,
 242                                 struct nacl_abi_stat    *statbuf)
 243 {
 244   NaClLog(LOG_ERROR,
 245           "Fstat method is not implemented for object of type %s\n",
 246           NaClDescTypeString(vself->vtbl->typeTag));
 247   return -NACL_ABI_EINVAL;
 248 }
 249
 250 int NaClDescCloseNotImplemented(struct NaClDesc         *vself,
 251                                 struct NaClDescEffector *effp)
 252 {
 253   NaClLog(LOG_ERROR,
 254           "Close method is not implemented for object of type %s\n",
 255           NaClDescTypeString(vself->vtbl->typeTag));
 256   return -NACL_ABI_EINVAL;
 257 }
 258
 259 ssize_t NaClDescGetdentsNotImplemented(struct NaClDesc          *vself,
 260                                        struct NaClDescEffector  *effp,
 261                                        void                     *dirp,
 262                                        size_t                   count)
 263 {
 264   NaClLog(LOG_ERROR,
 265           "Getdents method is not implemented for object of type %s\n",
 266           NaClDescTypeString(vself->vtbl->typeTag));
 267   return -NACL_ABI_EINVAL;
 268 }
 269
 270 int NaClDescExternalizeSizeNotImplemented(struct NaClDesc      *vself,
 271                                           size_t               *nbytes,
 272                                           size_t               *nhandles)
 273 {
 274   NaClLog(LOG_ERROR,
 275           "ExternalizeSize method is not implemented for object of type %s\n",
 276           NaClDescTypeString(vself->vtbl->typeTag));
 277   return -NACL_ABI_EINVAL;
 278 }
 279
 280 int NaClDescExternalizeNotImplemented(struct NaClDesc          *vself,
 281                                       struct NaClDescXferState *xfer)
 282 {
 283   NaClLog(LOG_ERROR,
 284           "Externalize method is not implemented for object of type %s\n",
 285           NaClDescTypeString(vself->vtbl->typeTag));
 286   return -NACL_ABI_EINVAL;
 287 }
 288
 289 int NaClDescLockNotImplemented(struct NaClDesc          *vself,
 290                                struct NaClDescEffector  *effp)
 291 {
 292   NaClLog(LOG_ERROR,
 293           "Lock method is not implemented for object of type %s\n",
 294           NaClDescTypeString(vself->vtbl->typeTag));
 295   return -NACL_ABI_EINVAL;
 296 }
 297
 298 int NaClDescTryLockNotImplemented(struct NaClDesc         *vself,
 299                                   struct NaClDescEffector *effp)
 300 {
 301   NaClLog(LOG_ERROR,
 302           "TryLock method is not implemented for object of type %s\n",
 303           NaClDescTypeString(vself->vtbl->typeTag));
 304   return -NACL_ABI_EINVAL;
 305 }
 306
 307 int NaClDescUnlockNotImplemented(struct NaClDesc          *vself,
 308                                  struct NaClDescEffector  *effp)
 309 {
 310   NaClLog(LOG_ERROR,
 311           "Unlock method is not implemented for object of type %s\n",
 312           NaClDescTypeString(vself->vtbl->typeTag));
 313   return -NACL_ABI_EINVAL;
 314 }
 315
 316 int NaClDescWaitNotImplemented(struct NaClDesc          *vself,
 317                                struct NaClDescEffector  *effp,
 318                                struct NaClDesc          *mutex)
 319 {
 320   NaClLog(LOG_ERROR,
 321           "Wait method is not implemented for object of type %s\n",
 322           NaClDescTypeString(vself->vtbl->typeTag));
 323   return -NACL_ABI_EINVAL;
 324 }
 325
 326 int NaClDescTimedWaitAbsNotImplemented(struct NaClDesc          *vself,
 327                                        struct NaClDescEffector  *effp,
 328                                        struct NaClDesc          *mutex,
 329                                        struct nacl_abi_timespec *ts)
 330 {
 331   NaClLog(LOG_ERROR,
 332           "TimedWaitAbs method is not implemented for object of type %s\n",
 333           NaClDescTypeString(vself->vtbl->typeTag));
 334   return -NACL_ABI_EINVAL;
 335 }
 336
 337 int NaClDescSignalNotImplemented(struct NaClDesc          *vself,
 338                                  struct NaClDescEffector  *effp)
 339 {
 340   NaClLog(LOG_ERROR,
 341           "Signal method is not implemented for object of type %s\n",
 342           NaClDescTypeString(vself->vtbl->typeTag));
 343   return -NACL_ABI_EINVAL;
 344 }
 345
 346 int NaClDescBroadcastNotImplemented(struct NaClDesc         *vself,
 347                                     struct NaClDescEffector *effp)
 348 {
 349   NaClLog(LOG_ERROR,
 350           "Broadcast method is not implemented for object of type %s\n",
 351           NaClDescTypeString(vself->vtbl->typeTag));
 352   return -NACL_ABI_EINVAL;
 353 }
 354
 355 int NaClDescSendMsgNotImplemented(struct NaClDesc           *vself,
 356                                   struct NaClDescEffector   *effp,
 357                                   struct NaClMessageHeader  *dgram,
 358                                   int                       flags)
 359 {
 360   NaClLog(LOG_ERROR,
 361           "SendMsg method is not implemented for object of type %s\n",
 362           NaClDescTypeString(vself->vtbl->typeTag));
 363   return -NACL_ABI_EINVAL;
 364 }
 365
 366 int NaClDescRecvMsgNotImplemented(struct NaClDesc           *vself,
 367                                   struct NaClDescEffector   *effp,
 368                                   struct NaClMessageHeader  *dgram,
 369                                   int                       flags)
 370 {
 371   NaClLog(LOG_ERROR,
 372           "RecvMsg method is not implemented for object of type %s\n",
 373           NaClDescTypeString(vself->vtbl->typeTag));
 374   return -NACL_ABI_EINVAL;
 375 }
 376
 377 int NaClDescConnectAddrNotImplemented(struct NaClDesc         *vself,
 378                                       struct NaClDescEffector *effp)
 379 {
 380   NaClLog(LOG_ERROR,
 381           "ConnectAddr method is not implemented for object of type %s\n",
 382           NaClDescTypeString(vself->vtbl->typeTag));
 383   return -NACL_ABI_EINVAL;
 384 }
 385
 386 int NaClDescAcceptConnNotImplemented(struct NaClDesc          *vself,
 387                                      struct NaClDescEffector  *effp)
 388 {
 389   NaClLog(LOG_ERROR,
 390           "AcceptConn method is not implemented for object of type %s\n",
 391           NaClDescTypeString(vself->vtbl->typeTag));
 392   return -NACL_ABI_EINVAL;
 393 }
 394
 395 int NaClDescPostNotImplemented(struct NaClDesc          *vself,
 396                                struct NaClDescEffector  *effp)
 397 {
 398   NaClLog(LOG_ERROR,
 399           "Post method is not implemented for object of type %s\n",
 400           NaClDescTypeString(vself->vtbl->typeTag));
 401   return -NACL_ABI_EINVAL;
 402 }
 403
 404 int NaClDescSemWaitNotImplemented(struct NaClDesc         *vself,
 405                                   struct NaClDescEffector *effp)
 406 {
 407   NaClLog(LOG_ERROR,
 408           "SemWait method is not implemented for object of type %s\n",
 409           NaClDescTypeString(vself->vtbl->typeTag));
 410   return -NACL_ABI_EINVAL;
 411 }
 412
 413 int NaClDescGetValueNotImplemented(struct NaClDesc          *vself,
 414                                    struct NaClDescEffector  *effp)
 415 {
 416   NaClLog(LOG_ERROR,
 417           "GetValue method is not implemented for object of type %s\n",
 418           NaClDescTypeString(vself->vtbl->typeTag));
 419   return -NACL_ABI_EINVAL;
 420 }