hphp/runtime/vm/jit/align.h

   1 /*
   2    +----------------------------------------------------------------------+
   3    | HipHop for PHP                                                       |
   4    +----------------------------------------------------------------------+
   5    | Copyright (c) 2010-present Facebook, Inc. (http://www.facebook.com)  |
   6    +----------------------------------------------------------------------+
   7    | This source file is subject to version 3.01 of the PHP license,      |
   8    | that is bundled with this package in the file LICENSE, and is        |
   9    | available through the world-wide-web at the following url:           |
  10    | http://www.php.net/license/3_01.txt                                  |
  11    | If you did not receive a copy of the PHP license and are unable to   |
  12    | obtain it through the world-wide-web, please send a note to          |
  13    | license@php.net so we can mail you a copy immediately.               |
  14    +----------------------------------------------------------------------+
  15 */
  16
  17 #ifndef incl_HPHP_JIT_ALIGN_H_
  18 #define incl_HPHP_JIT_ALIGN_H_
  19
  20 #include "hphp/runtime/vm/jit/types.h"
  21 #include "hphp/runtime/vm/jit/alignment.h"
  22
  23 #include "hphp/util/data-block.h"
  24
  25 namespace HPHP { namespace jit {
  26
  27 struct CGMeta;
  28
  29 ///////////////////////////////////////////////////////////////////////////////
  30
  31 /*
  32  * Whether `frontier' is aligned to `alignment'.
  33  */
  34 bool is_aligned(TCA frontier, Alignment alignment);
  35
  36 /*
  37  * Align `cb' to `alignment' in `context'.
  38  *
  39  * By default, calling align() registers alignment metadata for relocation.  If
  40  * this behavior is not desired (e.g., in the relocator itself), it can be
  41  * disabled by passing nullptr for `meta'.
  42  */
  43 void align(CodeBlock& cb, CGMeta* meta,
  44            Alignment alignment, AlignContext context);
  45
  46 /*
  47  * Size of a cache line, in bytes.
  48  */
  49 size_t cache_line_size();
  50
  51 ///////////////////////////////////////////////////////////////////////////////
  52
  53 }}
  54
  55 #endif