native_client_sdk/src/libraries/nacl_io/kernel_wrap_glibc.cc

// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include <sys/types.h>  // Include something that will define __GLIBC__.
#include "nacl_io/kernel_wrap.h" // IRT_EXT is turned on in this header.

#if !defined(NACL_IO_IRT_EXT) && defined(__native_client__) && \
    defined(__GLIBC__)

#include <alloca.h>
#include <assert.h>
#include <dirent.h>
#include <errno.h>
#include <irt.h>
#include <irt_syscalls.h>
#include <nacl_stat.h>
#include <string.h>
#include <sys/stat.h>
#include <sys/time.h>

#include "nacl_io/kernel_intercept.h"
#include "nacl_io/kernel_wrap_real.h"
#include "nacl_io/log.h"
#include "nacl_io/nacl_abi_types.h"
#include "nacl_io/osmman.h"
#include "nacl_io/ostime.h"

namespace {

void stat_to_nacl_stat(const struct stat* buf, nacl_abi_stat* nacl_buf) {
  memset(nacl_buf, 0, sizeof(struct nacl_abi_stat));
  nacl_buf->nacl_abi_st_dev = buf->st_dev;
  nacl_buf->nacl_abi_st_ino = buf->st_ino;
  nacl_buf->nacl_abi_st_mode = buf->st_mode;
  nacl_buf->nacl_abi_st_nlink = buf->st_nlink;
  nacl_buf->nacl_abi_st_uid = buf->st_uid;
  nacl_buf->nacl_abi_st_gid = buf->st_gid;
  nacl_buf->nacl_abi_st_rdev = buf->st_rdev;
  nacl_buf->nacl_abi_st_size = buf->st_size;
  nacl_buf->nacl_abi_st_blksize = buf->st_blksize;
  nacl_buf->nacl_abi_st_blocks = buf->st_blocks;
  nacl_buf->nacl_abi_st_atime = buf->st_atime;
  nacl_buf->nacl_abi_st_atimensec = buf->st_atimensec;
  nacl_buf->nacl_abi_st_mtime = buf->st_mtime;
  nacl_buf->nacl_abi_st_mtimensec = buf->st_mtimensec;
  nacl_buf->nacl_abi_st_ctime = buf->st_ctime;
  nacl_buf->nacl_abi_st_ctimensec = buf->st_ctimensec;
}

void nacl_stat_to_stat(const nacl_abi_stat* nacl_buf, struct stat* buf) {
  memset(buf, 0, sizeof(struct stat));
  buf->st_dev = nacl_buf->nacl_abi_st_dev;
  buf->st_ino = nacl_buf->nacl_abi_st_ino;
  buf->st_mode = nacl_buf->nacl_abi_st_mode;
  buf->st_nlink = nacl_buf->nacl_abi_st_nlink;
  buf->st_uid = nacl_buf->nacl_abi_st_uid;
  buf->st_gid = nacl_buf->nacl_abi_st_gid;
  buf->st_rdev = nacl_buf->nacl_abi_st_rdev;
  buf->st_size = nacl_buf->nacl_abi_st_size;
  buf->st_blksize = nacl_buf->nacl_abi_st_blksize;
  buf->st_blocks = nacl_buf->nacl_abi_st_blocks;
  buf->st_atime = nacl_buf->nacl_abi_st_atime;
  buf->st_atimensec = nacl_buf->nacl_abi_st_atimensec;
  buf->st_mtime = nacl_buf->nacl_abi_st_mtime;
  buf->st_mtimensec = nacl_buf->nacl_abi_st_mtimensec;
  buf->st_ctime = nacl_buf->nacl_abi_st_ctime;
  buf->st_ctimensec = nacl_buf->nacl_abi_st_ctimensec;
}

}  // namespace

static const int d_name_shift = offsetof (dirent, d_name) -
  offsetof (struct nacl_abi_dirent, nacl_abi_d_name);

EXTERN_C_BEGIN

// Macro to get the REAL function pointer
#define REAL(name) __nacl_irt_##name##_real

// Macro to get the WRAP function
#define WRAP(name) __nacl_irt_##name##_wrap

// Declare REAL function pointer.
#define DECLARE_REAL_PTR(name) __typeof__(__nacl_irt_##name) REAL(name);

// Assign the REAL function pointer.
#define ASSIGN_REAL_PTR(name)        \
  assert(__nacl_irt_##name != NULL); \
  REAL(name) = __nacl_irt_##name;

// Switch IRT's pointer to the REAL pointer
#define USE_REAL(name) \
  __nacl_irt_##name = (__typeof__(__nacl_irt_##name))REAL(name)

// Switch IRT's pointer to the WRAP function
#define USE_WRAP(name) \
  __nacl_irt_##name = (__typeof__(__nacl_irt_##name))WRAP(name)

#define EXPAND_SYMBOL_LIST_OPERATION(OP) \
  OP(chdir);                             \
  OP(close);                             \
  OP(dup);                               \
  OP(dup2);                              \
  OP(exit);                              \
  OP(fstat);                             \
  OP(getcwd);                            \
  OP(getdents);                          \
  OP(mkdir);                             \
  OP(open);                              \
  OP(poll);                              \
  OP(read);                              \
  OP(rmdir);                             \
  OP(seek);                              \
  OP(stat);                              \
  OP(select);                            \
  OP(write);                             \
  OP(mmap);                              \
  OP(munmap);                            \
  OP(open_resource);                     \
                                         \
  OP(socket);                            \
  OP(accept);                            \
  OP(bind);                              \
  OP(listen);                            \
  OP(connect);                           \
  OP(send);                              \
  OP(sendmsg);                           \
  OP(sendto);                            \
  OP(recv);                              \
  OP(recvmsg);                           \
  OP(recvfrom);                          \
  OP(getpeername);                       \
  OP(getsockname);                       \
  OP(getsockopt);                        \
  OP(setsockopt);                        \
  OP(socketpair);                        \
  OP(shutdown);                          \
                                         \
  OP(chmod);                             \
  OP(access);                            \
  OP(unlink);                            \
  OP(fchdir);                            \
  OP(fchmod);                            \
  OP(fsync);                             \
  OP(fdatasync);                         \
  OP(lstat);                             \
  OP(link);                              \
  OP(rename);                            \
  OP(readlink);                          \
  OP(utimes);

// TODO(bradnelson): Add these as well.
// OP(epoll_create);
// OP(epoll_create1);
// OP(epoll_ctl);
// OP(epoll_pwait);
// OP(ppoll);
// OP(pselect);

EXPAND_SYMBOL_LIST_OPERATION(DECLARE_REAL_PTR);

int WRAP(chdir)(const char* pathname) {
  ERRNO_RTN(ki_chdir(pathname));
}

int WRAP(close)(int fd) {
  ERRNO_RTN(ki_close(fd));
}

int WRAP(dup)(int fd, int* newfd) NOTHROW {
  *newfd = ki_dup(fd);
  RTN_ERRNO_IF(*newfd < 0);
  return 0;
}

int WRAP(dup2)(int fd, int newfd) NOTHROW {
  ERRNO_RTN(ki_dup2(fd, newfd));
}

void WRAP(exit)(int status) {
  ki_exit(status);
}

int WRAP(fstat)(int fd, struct nacl_abi_stat* nacl_buf) {
  struct stat buf;
  memset(&buf, 0, sizeof(struct stat));
  int res = ki_fstat(fd, &buf);
  RTN_ERRNO_IF(res < 0);
  stat_to_nacl_stat(&buf, nacl_buf);
  return 0;
}

int WRAP(getcwd)(char* buf, size_t size) {
  RTN_ERRNO_IF(ki_getcwd(buf, size) == NULL);
  return 0;
}

int WRAP(getdents)(int fd, nacl_abi_dirent* nacl_buf, size_t nacl_count,
                   size_t* nread) {
  int nacl_offset = 0;
  // "buf" contains dirent(s); "nacl_buf" contains nacl_abi_dirent(s).
  // nacl_abi_dirent(s) are smaller than dirent(s), so nacl_count bytes buffer
  // is enough
  char* buf = (char*)alloca(nacl_count);
  int offset = 0;
  int count;

  count = ki_getdents(fd, (dirent*)buf, nacl_count);
  RTN_ERRNO_IF(count < 0);

  while (offset < count) {
    dirent* d = (dirent*)(buf + offset);
    nacl_abi_dirent* nacl_d = (nacl_abi_dirent*)((char*)nacl_buf + nacl_offset);
    nacl_d->nacl_abi_d_ino = d->d_ino;
    nacl_d->nacl_abi_d_off = d->d_off;
    nacl_d->nacl_abi_d_reclen = d->d_reclen - d_name_shift;
    size_t d_name_len = d->d_reclen - offsetof(dirent, d_name);
    memcpy(nacl_d->nacl_abi_d_name, d->d_name, d_name_len);

    offset += d->d_reclen;
    nacl_offset += nacl_d->nacl_abi_d_reclen;
  }

  *nread = nacl_offset;
  return 0;
}

int WRAP(mkdir)(const char* pathname, mode_t mode) {
  RTN_ERRNO_IF(ki_mkdir(pathname, mode) < 0);
  return 0;
}

int WRAP(mmap)(void** addr,
               size_t length,
               int prot,
               int flags,
               int fd,
               off_t offset) {
  if (flags & MAP_ANONYMOUS)
    return REAL(mmap)(addr, length, prot, flags, fd, offset);

  *addr = ki_mmap(*addr, length, prot, flags, fd, offset);
  RTN_ERRNO_IF(*addr == (void*)-1);
  return 0;
}

int WRAP(munmap)(void* addr, size_t length) {
  // Always let the real munmap run on the address range. It is not an error if
  // there are no mapped pages in that range.
  ki_munmap(addr, length);
  return REAL(munmap)(addr, length);
}

int WRAP(open)(const char* pathname, int oflag, mode_t mode, int* newfd) {
  *newfd = ki_open(pathname, oflag, mode);
  RTN_ERRNO_IF(*newfd < 0);
  return 0;
}

int WRAP(open_resource)(const char* file, int* fd) {
  *fd = ki_open_resource(file);
  RTN_ERRNO_IF(*fd < 0);
  return 0;
}

int WRAP(poll)(struct pollfd* fds, nfds_t nfds, int timeout, int* count) {
  *count = ki_poll(fds, nfds, timeout);
  RTN_ERRNO_IF(*count < 0);
  return 0;
}

int WRAP(read)(int fd, void* buf, size_t count, size_t* nread) {
  ssize_t signed_nread = ki_read(fd, buf, count);
  *nread = static_cast<size_t>(signed_nread);
  RTN_ERRNO_IF(signed_nread < 0);
  return 0;
}

int WRAP(rmdir)(const char* pathname) {
  RTN_ERRNO_IF(ki_rmdir(pathname) < 0);
  return 0;
}

int WRAP(seek)(int fd, off_t offset, int whence, off_t* new_offset) {
  *new_offset = ki_lseek(fd, offset, whence);
  RTN_ERRNO_IF(*new_offset < 0);
  return 0;
}

int WRAP(select)(int nfds,
                 fd_set* readfds,
                 fd_set* writefds,
                 fd_set* exceptfds,
                 struct timeval* timeout,
                 int* count) {
  *count = ki_select(nfds, readfds, writefds, exceptfds, timeout);
  RTN_ERRNO_IF(*count < 0);
  return 0;
}

int WRAP(stat)(const char* pathname, struct nacl_abi_stat* nacl_buf) {
  struct stat buf;
  memset(&buf, 0, sizeof(struct stat));
  int res = ki_stat(pathname, &buf);
  RTN_ERRNO_IF(res < 0);
  stat_to_nacl_stat(&buf, nacl_buf);
  return 0;
}

int WRAP(lstat)(const char* pathname, struct nacl_abi_stat* nacl_buf) {
  struct stat buf;
  memset(&buf, 0, sizeof(struct stat));
  int res = ki_lstat(pathname, &buf);
  RTN_ERRNO_IF(res < 0);
  stat_to_nacl_stat(&buf, nacl_buf);
  return 0;
}

int WRAP(link)(const char* pathname, const char* newpath) {
  ERRNO_RTN(ki_link(pathname, newpath));
}

int WRAP(rename)(const char* pathname, const char* newpath) {
  ERRNO_RTN(ki_rename(pathname, newpath));
}

int WRAP(readlink)(const char* pathname,
                   char* buf,
                   size_t count,
                   size_t* nread) {
  int rtn = ki_readlink(pathname, buf, count);
  RTN_ERRNO_IF(rtn < 0);
  *nread = rtn;
  return 0;
}

int WRAP(utimes)(const char *filename, const struct timeval *times) {
  ERRNO_RTN(ki_utimes(filename, times));
}

int WRAP(chmod)(const char* pathname, mode_t mode) {
  ERRNO_RTN(ki_chmod(pathname, mode));
}

int WRAP(access)(const char* pathname, int amode) {
  ERRNO_RTN(ki_access(pathname, amode));
}

int WRAP(unlink)(const char* pathname) {
  ERRNO_RTN(ki_unlink(pathname));
}

int WRAP(fchdir)(int fd) {
  ERRNO_RTN(ki_fchdir(fd));
}

int WRAP(fchmod)(int fd, mode_t mode) {
  ERRNO_RTN(ki_fchmod(fd, mode));
}

int WRAP(fsync)(int fd) {
  ERRNO_RTN(ki_fsync(fd));
}

int WRAP(fdatasync)(int fd) {
  ERRNO_RTN(ki_fdatasync(fd));
}

int WRAP(write)(int fd, const void* buf, size_t count, size_t* nwrote) {
  ssize_t signed_nwrote = ki_write(fd, buf, count);
  *nwrote = static_cast<size_t>(signed_nwrote);
  RTN_ERRNO_IF(signed_nwrote < 0);
  return 0;
}

int WRAP(accept)(int sockfd,
                 struct sockaddr* addr,
                 socklen_t* addrlen,
                 int* sd) {
  *sd = ki_accept(sockfd, addr, addrlen);
  RTN_ERRNO_IF(*sd < 0);
  return 0;
}

int WRAP(bind)(int sockfd, const struct sockaddr* addr, socklen_t addrlen) {
  ERRNO_RTN(ki_bind(sockfd, addr, addrlen));
}

int WRAP(connect)(int sockfd, const struct sockaddr* addr, socklen_t addrlen) {
  ERRNO_RTN(ki_connect(sockfd, addr, addrlen));
}

int WRAP(getpeername)(int sockfd, struct sockaddr* addr, socklen_t* addrlen) {
  ERRNO_RTN(ki_getpeername(sockfd, addr, addrlen));
}

int WRAP(getsockname)(int sockfd, struct sockaddr* addr, socklen_t* addrlen) {
  ERRNO_RTN(ki_getsockname(sockfd, addr, addrlen));
}

int WRAP(getsockopt)(int sockfd,
                     int level,
                     int optname,
                     void* optval,
                     socklen_t* optlen) {
  ERRNO_RTN(ki_getsockopt(sockfd, level, optname, optval, optlen));
}

int WRAP(setsockopt)(int sockfd,
                     int level,
                     int optname,
                     const void* optval,
                     socklen_t optlen) {
  ERRNO_RTN(ki_setsockopt(sockfd, level, optname, optval, optlen));
}

int WRAP(listen)(int sockfd, int backlog) {
  ERRNO_RTN(ki_listen(sockfd, backlog));
}

int WRAP(recv)(int sockfd, void* buf, size_t len, int flags, int* count) {
  ssize_t signed_nread = ki_recv(sockfd, buf, len, flags);
  *count = static_cast<int>(signed_nread);
  RTN_ERRNO_IF(signed_nread < 0);
  return 0;
}

int WRAP(recvfrom)(int sockfd,
                   void* buf,
                   size_t len,
                   int flags,
                   struct sockaddr* addr,
                   socklen_t* addrlen,
                   int* count) {
  ssize_t signed_nread = ki_recvfrom(sockfd, buf, len, flags, addr, addrlen);
  *count = static_cast<int>(signed_nread);
  RTN_ERRNO_IF(signed_nread < 0);
  return 0;
}

int WRAP(recvmsg)(int sockfd, struct msghdr* msg, int flags, int* count) {
  ssize_t signed_nread = ki_recvmsg(sockfd, msg, flags);
  *count = static_cast<int>(signed_nread);
  RTN_ERRNO_IF(signed_nread < 0);
  return 0;
}

ssize_t WRAP(send)(int sockfd, const void* buf, size_t len, int flags,
                   int* count) {
  ssize_t signed_nread = ki_send(sockfd, buf, len, flags);
  *count = static_cast<int>(signed_nread);
  RTN_ERRNO_IF(signed_nread < 0);
  return 0;
}

ssize_t WRAP(sendto)(int sockfd,
                     const void* buf,
                     size_t len,
                     int flags,
                     const struct sockaddr* addr,
                     socklen_t addrlen,
                     int* count) {
  ssize_t signed_nread = ki_sendto(sockfd, buf, len, flags, addr, addrlen);
  *count = static_cast<int>(signed_nread);
  RTN_ERRNO_IF(signed_nread < 0);
  return 0;
}

ssize_t WRAP(sendmsg)(int sockfd,
                      const struct msghdr* msg,
                      int flags,
                      int* count) {
  ssize_t signed_nread = ki_sendmsg(sockfd, msg, flags);
  *count = static_cast<int>(signed_nread);
  RTN_ERRNO_IF(signed_nread < 0);
  return 0;
}

int WRAP(shutdown)(int sockfd, int how) {
  RTN_ERRNO_IF(ki_shutdown(sockfd, how) < 0);
  return 0;
}

int WRAP(socket)(int domain, int type, int protocol, int* sd) {
  *sd = ki_socket(domain, type, protocol);
  RTN_ERRNO_IF(*sd < 0);
  return 0;
}

int WRAP(socketpair)(int domain, int type, int protocol, int* sv) {
  RTN_ERRNO_IF(ki_socketpair(domain, type, protocol, sv) < 0);
  return 0;
}

static void assign_real_pointers() {
  static bool assigned = false;
  if (!assigned) {
    EXPAND_SYMBOL_LIST_OPERATION(ASSIGN_REAL_PTR)
    assigned = true;
  }
}

#define CHECK_REAL(func)    \
  if (!REAL(func)) {        \
    assign_real_pointers(); \
    if (!REAL(func))        \
      return ENOSYS;        \
  }

// "real" functions, i.e. the unwrapped original functions.

int _real_close(int fd) {
  CHECK_REAL(close);
  return REAL(close)(fd);
}

void _real_exit(int status) {
  if (!REAL(exit))
    assign_real_pointers();
  REAL(exit)(status);
}

int _real_fstat(int fd, struct stat* buf) {
  struct nacl_abi_stat st;
  CHECK_REAL(fstat);
  int err = REAL(fstat)(fd, &st);
  if (err) {
    errno = err;
    return -1;
  }

  nacl_stat_to_stat(&st, buf);
  return 0;
}

int _real_getdents(int fd, void* buf, size_t count, size_t* nread) {
  // "buf" contains dirent(s); "nacl_buf" contains nacl_abi_dirent(s).
  // See WRAP(getdents) above.
  char* nacl_buf = (char*)alloca(count);
  size_t offset = 0;
  size_t nacl_offset = 0;
  size_t nacl_nread;
  CHECK_REAL(getdents);
  int err = REAL(getdents)(fd, (dirent*)nacl_buf, count, &nacl_nread);
  if (err)
    return err;

  while (nacl_offset < nacl_nread) {
    dirent* d = (dirent*)((char*)buf + offset);
    nacl_abi_dirent* nacl_d = (nacl_abi_dirent*)(nacl_buf + nacl_offset);
    d->d_ino = nacl_d->nacl_abi_d_ino;
    d->d_off = nacl_d->nacl_abi_d_off;
    d->d_reclen = nacl_d->nacl_abi_d_reclen + d_name_shift;
    size_t d_name_len =
        nacl_d->nacl_abi_d_reclen - offsetof(nacl_abi_dirent, nacl_abi_d_name);
    memcpy(d->d_name, nacl_d->nacl_abi_d_name, d_name_len);

    offset += d->d_reclen;
    offset += nacl_d->nacl_abi_d_reclen;
  }

  *nread = offset;
  return 0;
}

int _real_lseek(int fd, off_t offset, int whence, off_t* new_offset) {
  CHECK_REAL(seek);
  return REAL(seek)(fd, offset, whence, new_offset);
}

int _real_mkdir(const char* pathname, mode_t mode) {
  CHECK_REAL(mkdir);
  return REAL(mkdir)(pathname, mode);
}

int _real_mmap(void** addr,
               size_t length,
               int prot,
               int flags,
               int fd,
               off_t offset) {
  CHECK_REAL(mmap);
  return REAL(mmap)(addr, length, prot, flags, fd, offset);
}

int _real_munmap(void* addr, size_t length) {
  CHECK_REAL(munmap);
  return REAL(munmap)(addr, length);
}

int _real_open(const char* pathname, int oflag, mode_t mode, int* newfd) {
  CHECK_REAL(open);
  return REAL(open)(pathname, oflag, mode, newfd);
}

int _real_open_resource(const char* file, int* fd) {
  CHECK_REAL(open_resource);
  return REAL(open_resource)(file, fd);
}

int _real_read(int fd, void* buf, size_t count, size_t* nread) {
  CHECK_REAL(read);
  return REAL(read)(fd, buf, count, nread);
}

int _real_rmdir(const char* pathname) {
  CHECK_REAL(rmdir);
  return REAL(rmdir)(pathname);
}

int _real_write(int fd, const void* buf, size_t count, size_t* nwrote) {
  CHECK_REAL(write);
  return REAL(write)(fd, buf, count, nwrote);
}

int _real_getcwd(char* pathname, size_t len) {
  CHECK_REAL(getcwd);
  return REAL(getcwd)(pathname, len);
}

static bool s_wrapped = false;
void kernel_wrap_init() {
  if (!s_wrapped) {
    LOG_TRACE("kernel_wrap_init");
    assign_real_pointers();
    EXPAND_SYMBOL_LIST_OPERATION(USE_WRAP)
    s_wrapped = true;
  }
}

void kernel_wrap_uninit() {
  if (s_wrapped) {
    LOG_TRACE("kernel_wrap_uninit");
    EXPAND_SYMBOL_LIST_OPERATION(USE_REAL)
    s_wrapped = false;
  }
}

EXTERN_C_END

#endif  // defined(__native_client__) && defined(__GLIBC__)