src/include/cwrapper/dbcommon/utils/instrument.h

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

#ifndef DBCOMMON_SRC_DBCOMMON_UTILS_INSTRUMENT_H_
#define DBCOMMON_SRC_DBCOMMON_UTILS_INSTRUMENT_H_

#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef struct MyInstrumentation {
  struct MyInstrumentation *leftTree;
  struct MyInstrumentation *rightTree;
  struct MyInstrumentation *subTree;
  struct MyInstrumentation *subplan;
  struct MyInstrumentation *subplanSibling;

  bool running;              // TRUE if we've completed first tupleBatch
  uint64_t startTime;        // Start time of current iteration of node
  uint64_t counter;          // Accumulated runtime for this node
  uint64_t firstTupleBatch;  // Time for first tupleBatch of this cycle
  uint64_t firstStart;       // Start time of first iteration of node
  uint64_t tupleCount;       // Tuples emitted so far this cycle
  double nloops;             // Number of run cycles for this node

  double execmemused;    // CDB: executor memory used (bytes)
  double workmemused;    // CDB: work_mem actually used (bytes)
  double workmemwanted;  // CDB: work_mem to avoid scratch i/o (bytes)

  bool workfileReused;   // TRUE if cached workfiles reused in this node
  bool workfileCreated;  // TRUE if workfiles are created in this node

  uint32_t numPartScanned;  // Number of part tables scanned

  const char *notebuf;  // extra message text
  int32_t notebufLen;   // size of extra message text

  // for new scheduler only
  const char *queryId;
  int32_t stageNo;
  int32_t execId;
} MyInstrumentation;

__attribute__((weak)) void MyInstrInitNode(MyInstrumentation *instr) {}

__attribute__((weak)) void MyInstrStartNode(MyInstrumentation *instr) {}

__attribute__((weak)) void MyInstrStopNode(MyInstrumentation *instr, uint64_t nTuples) {}

__attribute__((weak)) void MyInstrEndLoop(MyInstrumentation *instr) {}

#ifdef __cplusplus
}
#endif

#endif  // DBCOMMON_SRC_DBCOMMON_UTILS_INSTRUMENT_H_