// increment invocation count & check for overflow
//
// Note: checking for negative value instead of overflow
//       so we have a 'sticky' overflow test
//
// Lmethod: method
// ??: invocation counter
//

void InterpreterGenerator::generate_counter_incr(Label* overflow, Label* profile_method, Label* profile_method_continue) {

  {- -------------------------------------------
  (1) (この関数には, TieredCompilation オプションの値に応じて 2つの処理パスがある)
      ---------------------------------------- -}

  {- -------------------------------------------
  (1) (以下が, TieredCompilation オプションが指定されている場合の処理)
      ---------------------------------------- -}

      // Note: In tiered we increment either counters in methodOop or in MDO depending if we're profiling or not.
      if (TieredCompilation) {

    {- -------------------------------------------
  (1.1) (変数宣言など)
        ---------------------------------------- -}

        const int increment = InvocationCounter::count_increment;
        const int mask = ((1 << Tier0InvokeNotifyFreqLog) - 1) << InvocationCounter::count_shift;
        Label no_mdo, done;

    {- -------------------------------------------
  (1.1) コード生成: (ただし, ProfileInterpreter オプションが指定されていない場合には生成しない)
        「もし methodDataOopDesc(mdo) が付いていれば, 
          InterpreterMacroAssembler::increment_mask_and_jump() が生成するコードによって
          mdo の _invocation_counter フィールドのカウンタ値をインクリメントし, 閾値チェックを行う.
          閾値に達していた場合は, 引数で指定された overflow ラベルにジャンプする.
          そうでなければ, done ラベルまでジャンプする (= 今回のカウンタ値の処理は終了).

          もし methodDataOopDesc が付いていなければ, 
          no_mdo ラベルまでジャンプする」
        ---------------------------------------- -}

        if (ProfileInterpreter) {
          // If no method data exists, go to profile_continue.
          __ ld_ptr(Lmethod, methodOopDesc::method_data_offset(), G4_scratch);
          __ br_null(G4_scratch, false, Assembler::pn, no_mdo);
          __ delayed()->nop();
          // Increment counter
          Address mdo_invocation_counter(G4_scratch,
                                         in_bytes(methodDataOopDesc::invocation_counter_offset()) +
                                         in_bytes(InvocationCounter::counter_offset()));
          __ increment_mask_and_jump(mdo_invocation_counter, increment, mask,
                                     G3_scratch, Lscratch,
                                     Assembler::zero, overflow);
          __ ba(false, done);
          __ delayed()->nop();
        }

    {- -------------------------------------------
  (1.1) コード生成:
        「(ここが no_mdo ラベルの位置)」
        ---------------------------------------- -}

        // Increment counter in methodOop
        __ bind(no_mdo);

    {- -------------------------------------------
  (1.1) (変数宣言など)
        ---------------------------------------- -}

        Address invocation_counter(Lmethod,
                                   in_bytes(methodOopDesc::invocation_counter_offset()) +
                                   in_bytes(InvocationCounter::counter_offset()));

    {- -------------------------------------------
  (1.1) コード生成:
        「InterpreterMacroAssembler::increment_mask_and_jump() が生成するコードによって
          実行中のメソッドに対応する methodOopDesc の 
          _invocation_counter フィールドのカウンタ値をインクリメントし, 閾値チェックを行う.
          閾値に達していた場合は, 引数で指定された overflow ラベルにジャンプする.
          そうでなければ, このままフォールスルーして, 今回のカウンタ値の処理は終了」
        ---------------------------------------- -}

        __ increment_mask_and_jump(invocation_counter, increment, mask,
                                   G3_scratch, Lscratch,
                                   Assembler::zero, overflow);

    {- -------------------------------------------
  (1.1) コード生成:
        「(ここが done ラベルの位置)」
        ---------------------------------------- -}

        __ bind(done);

  {- -------------------------------------------
  (1) (以下が, TieredCompilation オプションが指定されていない場合の処理)
      ---------------------------------------- -}

      } else {

    {- -------------------------------------------
  (1.1) コード生成:
        「InterpreterMacroAssembler::increment_invocation_counter() が生成するコードによって, 
          実行中のメソッドに対応する methodOopDesc の 
          _invocation_counter フィールドのカウンタ値をインクリメントする.」

         (なおついでに, この生成コードは O3 レジスタに 
         _backedge_counter と _invocation_counter を足した値をセットする)
        ---------------------------------------- -}

        // Update standard invocation counters
        __ increment_invocation_counter(O0, G3_scratch);

    {- -------------------------------------------
  (1.1) コード生成: (ただし, ProfileInterpreter オプションが指定されていない場合には生成しない)
        「(プロファイル情報を取得する場合には)
          実行中のメソッドに対応する methodOopDesc の 
          _interpreter_invocation_count フィールドの値をインクリメントしておく」
        ---------------------------------------- -}

        if (ProfileInterpreter) {  // %%% Merge this into methodDataOop
          Address interpreter_invocation_counter(Lmethod,in_bytes(methodOopDesc::interpreter_invocation_counter_offset()));
          __ ld(interpreter_invocation_counter, G3_scratch);
          __ inc(G3_scratch);
          __ st(G3_scratch, interpreter_invocation_counter);
        }

    {- -------------------------------------------
  (1.1) コード生成: (ただし, ProfileInterpreter オプションが指定されていない場合や, 引数の profile_method が NULL の場合には生成しない)
        「(プロファイル情報を取得する場合, ある程度実行回数が多いコードには methodDataOopDesc(mdo) を付ける.
          ここでカウンタ値をチェックし, カウンタ値が大きいのに mdo がまだ付いてなければ, 付けるコードにジャンプする)

         カウンタの値を閾値(InvocationCounter::InterpreterProfileLimitの値)と比較する.
         もしカウンタ値が閾値未満であれば, 引数で指定された profile_method_continue ラベルにジャンプする.

         そうでなければ, InterpreterMacroAssembler::test_method_data_pointer() が生成するコードによって
         ImethodDataPtr レジスタの値を調べる.
         まだ mdo が生成されてなければ, 引数で指定された profile_method ラベルにジャンプする」


         (なお, 引数の profile_method が NULL 以外の値を取るのは
          インタープリタで実行されているメソッドの場合のみ.
          つまり, "profile_method != NULL" という条件は「ネイティブメソッドではない」という意味)
        ---------------------------------------- -}

        if (ProfileInterpreter && profile_method != NULL) {
          // Test to see if we should create a method data oop
          AddressLiteral profile_limit((address)&InvocationCounter::InterpreterProfileLimit);
          __ load_contents(profile_limit, G3_scratch);
          __ cmp(O0, G3_scratch);
          __ br(Assembler::lessUnsigned, false, Assembler::pn, *profile_method_continue);
          __ delayed()->nop();

          // if no method data exists, go to profile_method
          __ test_method_data_pointer(*profile_method);
        }

    {- -------------------------------------------
  (1.1) コード生成:
        「カウンタの値を閾値(InvocationCounter::InterpreterInvocationLimitの値)と比較する.
         もしカウンタ値が閾値以上であれば, 引数で指定された overflow ラベルにジャンプする.」
        ---------------------------------------- -}

        AddressLiteral invocation_limit((address)&InvocationCounter::InterpreterInvocationLimit);
        __ load_contents(invocation_limit, G3_scratch);
        __ cmp(O0, G3_scratch);
        __ br(Assembler::greaterEqualUnsigned, false, Assembler::pn, *overflow);
        __ delayed()->nop();
      }

    }