ncv/ncfileutil.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  * ncfileutil.h - open an executable file. FOR TESTING ONLY.
  34  */
  35 #ifndef NATICE_CLIENT_NCV_NCFILEUTIL_H__
  36 #define NATICE_CLIENT_NCV_NCFILEUTIL_H__
  37
  38 #include "native_client/include/portability.h"
  39 #include "native_client/include/nacl_elf.h"
  40
  41 EXTERN_C_BEGIN
  42
  43 /* memory access permissions have a granularity of 4KB pages. */
  44 static const int kNCFileUtilPageShift =      12;
  45 static const int kNCFileUtilPageSize = (1 << 12);
  46 /* this needs to be a #define because it's used as an array size */
  47 #define kMaxPhnum 32
  48
  49 struct ncfile {
  50   const char *fname; /* name of loaded file */
  51   uint32_t vbase;    /* base address in virtual memory */
  52   size_t size;       /* size of program memory         */
  53   uint8_t *data;     /* the actual loaded bytes        */
  54   Elf32_Half phnum;  /* number of Elf program headers */
  55   Elf32_Phdr *pheaders;  /* copy of the Elf program headers */
  56   Elf32_Half shnum;  /* number of Elf section headers */
  57   Elf32_Shdr *sheaders;  /* copy of the Elf section headers */
  58   int ncalign;
  59 };
  60 typedef struct ncfile ncfile;
  61
  62 ncfile *nc_loadfile(const char *filename);
  63
  64 void nc_freefile(ncfile *ncf);
  65
  66 void GetVBaseAndLimit(ncfile *ncf, uint32_t *vbase, uint32_t *vlimit);
  67
  68 EXTERN_C_END
  69
  70 #endif  /* NATICE_CLIENT_NCV_NCFILEUTIL_H__ */