1// Copyright 2015, VIXL authors
2// All rights reserved.
3//
4// Redistribution and use in source and binary forms, with or without
5// modification, are permitted provided that the following conditions are met:
6//
7//   * Redistributions of source code must retain the above copyright notice,
8//     this list of conditions and the following disclaimer.
9//   * Redistributions in binary form must reproduce the above copyright notice,
10//     this list of conditions and the following disclaimer in the documentation
11//     and/or other materials provided with the distribution.
12//   * Neither the name of ARM Limited nor the names of its contributors may be
13//     used to endorse or promote products derived from this software without
14//     specific prior written permission.
15//
16// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS CONTRIBUTORS "AS IS" AND
17// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
20// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
23// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26
27#ifndef VIXL_EXAMPLE_EXAMPLES_H_
28#define VIXL_EXAMPLE_EXAMPLES_H_
29
30extern "C" {
31#include <stdint.h>
32#ifndef VIXL_INCLUDE_SIMULATOR_AARCH32
33#include <sys/mman.h>
34#endif
35}
36
37#include <cstdio>
38#include <string>
39
40#include "aarch32/constants-aarch32.h"
41#include "aarch32/instructions-aarch32.h"
42#include "aarch32/macro-assembler-aarch32.h"
43
44#ifndef VIXL_INCLUDE_SIMULATOR_AARCH32
45class ExecutableMemory {
46 public:
47  ExecutableMemory(const byte* code_start, size_t size)
48      : size_(size),
49        buffer_(reinterpret_cast<byte*>(mmap(NULL,
50                                             size,
51                                             PROT_READ | PROT_WRITE | PROT_EXEC,
52                                             MAP_SHARED | MAP_ANONYMOUS,
53                                             -1,
54                                             0))) {
55    VIXL_ASSERT(reinterpret_cast<intptr_t>(buffer_) != -1);
56    memcpy(buffer_, code_start, size_);
57    __builtin___clear_cache(buffer_, buffer_ + size_);
58  }
59  ~ExecutableMemory() { munmap(buffer_, size_); }
60
61  template <typename T>
62  T GetEntryPoint(const Label& entry_point, InstructionSet isa) const {
63    int32_t location = entry_point.GetLocation();
64    if (isa == T32) location += 1;
65    return GetOffsetAddress<T>(location);
66  }
67
68 protected:
69  template <typename T>
70  T GetOffsetAddress(int32_t offset) const {
71    VIXL_ASSERT((offset >= 0) && (static_cast<size_t>(offset) <= size_));
72    T function_address;
73    byte* buffer_address = buffer_ + offset;
74    memcpy(&function_address, &buffer_address, sizeof(T));
75    return function_address;
76  }
77
78 private:
79  size_t size_;
80  byte* buffer_;
81};
82#endif
83
84// Generate a function with the following prototype:
85//   int32_t abs(int32_t x)
86//
87// The generated function computes the absolute value of an integer.
88void GenerateAbs(vixl::aarch32::MacroAssembler* masm);
89
90// Generate a function with the following prototype:
91//   uint32_t demo_function(uint32_t x)
92//
93// This is the example used in doc/getting-started-aarch32.md
94void GenerateDemo(vixl::aarch32::MacroAssembler* masm);
95
96#endif  // VIXL_EXAMPLE_EXAMPLES_H_
97