hphp/runtime/vm/jit/service-request-handlers.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 #pragma once
  18
  19 #include "hphp/runtime/vm/jit/service-requests.h"
  20 #include "hphp/runtime/vm/jit/types.h"
  21
  22 namespace HPHP {
  23
  24 struct ActRec;
  25 struct SrcKey;
  26
  27 namespace jit {
  28
  29 struct ReqInfo;
  30
  31 namespace svcreq {
  32
  33 /*
  34  * Handle a service request.
  35  *
  36  * This often involves looking up or creating a translation, smashing a jmp
  37  * target or other address in the code, and returning the smashed-in value.
  38  * This address indicates where the caller should resume execution.
  39  */
  40 TCA handleServiceRequest(ReqInfo& info) noexcept;
  41
  42 /*
  43  * Handle a request to retranslate the current function, leveraging profiling
  44  * data to produce a set of larger, more optimized translations. Only used when
  45  * PGO is enabled. Execution will resume at `bcOff' whether or not retranslation
  46  * is successful.
  47  */
  48 TCA handleRetranslateOpt(Offset bcOff, SBInvOffset spOff) noexcept;
  49
  50 /*
  51  * Handle a situation where the translated code in the TC executes a return
  52  * for a frame that was pushed by the interpreter, i.e. there is no TCA to
  53  * return to.
  54  */
  55 TCA handlePostInterpRet(uint32_t callOffAndFlags) noexcept;
  56
  57 /*
  58  * Handle a bindcall request---i.e., look up (or create) the appropriate func
  59  * prologue for `func' and `numArgs', then smash the call instruction
  60  * at `toSmash'.
  61  *
  62  * If we can't find or make a translation, may return fcallHelperThunk instead,
  63  * which uses C++ helpers to act like a prologue.
  64  */
  65 TCA handleBindCall(TCA toSmash, Func* func, int32_t numArgs);
  66
  67 /*
  68  * Look up (or create) and return the address of a translation for the current
  69  * VM location.
  70  *
  71  * If no translation can be found or created, execute code in the interpreter
  72  * until we find one, possibly throwing exceptions or reentering the VM.
  73  *
  74  * If `interpFirst' is true, at least one basic block will be interpreted
  75  * before attempting to look up a translation.  This is necessary to ensure
  76  * forward progress in certain situations, such as hitting the translation
  77  * limit for a SrcKey.
  78  */
  79 TCA handleResume(bool interpFirst);
  80 TCA handleResumeNoTranslate(bool interpFirst);
  81
  82 /*
  83  * Look up (or create) the translation for the body of func.
  84  */
  85 TCA getFuncBody(const Func* func);
  86
  87 }}}