1// Copyright 2016, 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_MACRO_ASSEMBLER_INTERFACE_H
28#define VIXL_MACRO_ASSEMBLER_INTERFACE_H
29
30#include "assembler-base-vixl.h"
31
32namespace vixl {
33
34class MacroAssemblerInterface {
35 public:
36  virtual internal::AssemblerBase* AsAssemblerBase() = 0;
37
38  virtual ~MacroAssemblerInterface() {}
39
40  virtual bool AllowMacroInstructions() const = 0;
41  virtual bool ArePoolsBlocked() const = 0;
42
43 protected:
44  virtual void SetAllowMacroInstructions(bool allow) = 0;
45
46  virtual void BlockPools() = 0;
47  virtual void ReleasePools() = 0;
48  virtual void EnsureEmitPoolsFor(size_t size) = 0;
49
50  // Emit the branch over a literal/veneer pool, and any necessary padding
51  // before it.
52  virtual void EmitPoolHeader() = 0;
53  // When this is called, the label used for branching over the pool is bound.
54  // This can also generate additional padding, which must correspond to the
55  // alignment_ value passed to the PoolManager (which needs to keep track of
56  // the exact size of the generated pool).
57  virtual void EmitPoolFooter() = 0;
58
59  // Emit n bytes of padding that does not have to be executable.
60  virtual void EmitPaddingBytes(int n) = 0;
61  // Emit n bytes of padding that has to be executable. Implementations must
62  // make sure this is a multiple of the instruction size.
63  virtual void EmitNopBytes(int n) = 0;
64
65  // The following scopes need access to the above method in order to implement
66  // pool blocking and temporarily disable the macro-assembler.
67  friend class ExactAssemblyScope;
68  friend class EmissionCheckScope;
69  template <typename T>
70  friend class PoolManager;
71};
72
73}  // namespace vixl
74
75#endif  // VIXL_MACRO_ASSEMBLER_INTERFACE_H
76