/* -------------------------------------------------------------------------
 *
 * execJunk.cpp
 *	  Junk attribute support stuff....
 *
 * Portions Copyright (c) 2020 Huawei Technologies Co.,Ltd.
 * Portions Copyright (c) 1996-2012, PostgreSQL Global Development Group
 * Portions Copyright (c) 1994, Regents of the University of California
 *
 *
 * IDENTIFICATION
 *	  src/gausskernel/runtime/executor/execJunk.cpp
 *
 * -------------------------------------------------------------------------
 */
#include "postgres.h"
#include "knl/knl_variable.h"

#include "access/tableam.h"
#include "executor/executor.h"
#include "pgxc/pgxc.h"

/* -------------------------------------------------------------------------
 *		XXX this stuff should be rewritten to take advantage
 *			of ExecProject() and the ProjectionInfo node.
 *			-cim 6/3/91
 *
 * An attribute of a tuple living inside the executor, can be
 * either a normal attribute or a "junk" attribute. "junk" attributes
 * never make it out of the executor, i.e. they are never printed,
 * returned or stored on disk. Their only purpose in life is to
 * store some information useful only to the executor, mainly the values
 * of system attributes like "ctid", or sort key columns that are not to
 * be output.
 *
 * The general idea is the following: A target list consists of a list of
 * TargetEntry nodes containing expressions. Each TargetEntry has a field
 * called 'resjunk'. If the value of this field is true then the
 * corresponding attribute is a "junk" attribute.
 *
 * When we initialize a plan we call ExecInitJunkFilter to create a filter.
 *
 * We then execute the plan, treating the resjunk attributes like any others.
 *
 * Finally, when at the top level we get back a tuple, we can call
 * ExecFindJunkAttribute/ExecGetJunkAttribute to retrieve the values of the
 * junk attributes we are interested in, and ExecFilterJunk to remove all the
 * junk attributes from a tuple.  This new "clean" tuple is then printed,
 * inserted, or updated.
 *
 * -------------------------------------------------------------------------
 */
/*
 * ExecInitJunkFilter
 *
 * Initialize the Junk filter.
 *
 * The source targetlist is passed in.	The output tuple descriptor is
 * built from the non-junk tlist entries, plus the passed specification
 * of whether to include room for an OID or not.
 * An optional resultSlot can be passed as well.
 */
JunkFilter* ExecInitJunkFilter(List* targetList, bool hasoid, TupleTableSlot* slot, TableAmType tam)
{
    JunkFilter* junkfilter = NULL;
    TupleDesc cleanTupType;
    int cleanLength;
    AttrNumber* cleanMap = NULL;
    ListCell* t = NULL;
    AttrNumber cleanResno;

    /*
     * Compute the tuple descriptor for the cleaned tuple.
     */
    cleanTupType = ExecCleanTypeFromTL(targetList, hasoid, tam);

    /*
     * Use the given slot, or make a new slot if we weren't given one.
     */
    if (slot != NULL)
        ExecSetSlotDescriptor(slot, cleanTupType);
    else
        slot = MakeSingleTupleTableSlot(cleanTupType);

    /*
     * Now calculate the mapping between the original tuple's attributes and
     * the "clean" tuple's attributes.
     *
     * The "map" is an array of "cleanLength" attribute numbers, i.e. one
     * entry for every attribute of the "clean" tuple. The value of this entry
     * is the attribute number of the corresponding attribute of the
     * "original" tuple.  (Zero indicates a NULL output attribute, but we do
     * not use that feature in this routine.)
     */
    cleanLength = cleanTupType->natts;
    if (cleanLength > 0) {
        cleanMap = (AttrNumber*)palloc(cleanLength * sizeof(AttrNumber));
        cleanResno = 1;
        foreach (t, targetList) {
            TargetEntry* tle = (TargetEntry*)lfirst(t);

            if (!tle->resjunk) {
                cleanMap[cleanResno - 1] = tle->resno;
                cleanResno++;
            }
        }
    } else {
        cleanMap = NULL;
    }

    /*
     * Finally create and initialize the JunkFilter struct.
     */
    junkfilter = makeNode(JunkFilter);

    junkfilter->jf_targetList = targetList;
    junkfilter->jf_cleanTupType = cleanTupType;
    junkfilter->jf_cleanMap = cleanMap;
    junkfilter->jf_resultSlot = slot;

    return junkfilter;
}

/*
 * ExecInitJunkFilterConversion
 *
 * Initialize a JunkFilter for rowtype conversions.
 *
 * Here, we are given the target "clean" tuple descriptor rather than
 * inferring it from the targetlist.  The target descriptor can contain
 * deleted columns.  It is assumed that the caller has checked that the
 * non-deleted columns match up with the non-junk columns of the targetlist.
 */
JunkFilter* ExecInitJunkFilterConversion(List* targetList, TupleDesc cleanTupType, TupleTableSlot* slot)
{
    JunkFilter* junkfilter = NULL;
    int cleanLength;
    AttrNumber* cleanMap = NULL;
    ListCell* t = NULL;
    int i;

    /*
     * Use the given slot, or make a new slot if we weren't given one.
     */
    if (slot != NULL)
        ExecSetSlotDescriptor(slot, cleanTupType);
    else
        slot = MakeSingleTupleTableSlot(cleanTupType);

    /*
     * Calculate the mapping between the original tuple's attributes and the
     * "clean" tuple's attributes.
     *
     * The "map" is an array of "cleanLength" attribute numbers, i.e. one
     * entry for every attribute of the "clean" tuple. The value of this entry
     * is the attribute number of the corresponding attribute of the
     * "original" tuple.  We store zero for any deleted attributes, marking
     * that a NULL is needed in the output tuple.
     */
    cleanLength = cleanTupType->natts;
    if (cleanLength > 0) {
        cleanMap = (AttrNumber*)palloc0(cleanLength * sizeof(AttrNumber));
        t = list_head(targetList);
        for (i = 0; i < cleanLength; i++) {
            if (cleanTupType->attrs[i]->attisdropped)
                continue; /* map entry is already zero */
            for (;;) {
                TargetEntry* tle = (TargetEntry*)lfirst(t);

                t = lnext(t);
                if (!tle->resjunk) {
                    cleanMap[i] = tle->resno;
                    break;
                }
            }
        }
    } else {
        cleanMap = NULL;
    }

    /*
     * Finally create and initialize the JunkFilter struct.
     */
    junkfilter = makeNode(JunkFilter);

    junkfilter->jf_targetList = targetList;
    junkfilter->jf_cleanTupType = cleanTupType;
    junkfilter->jf_cleanMap = cleanMap;
    junkfilter->jf_resultSlot = slot;

    return junkfilter;
}

/*
 * ExecFindJunkAttribute
 *
 * Locate the specified junk attribute in the junk filter's targetlist,
 * and return its resno.  Returns InvalidAttrNumber if not found.
 */
AttrNumber ExecFindJunkAttribute(JunkFilter* junkfilter, const char* attrName)
{
    return ExecFindJunkAttributeInTlist(junkfilter->jf_targetList, attrName);
}

void ExecInitJunkAttr(EState* estate, CmdType operation, List* targetlist, ResultRelInfo* result_rel_info)
{
    JunkFilter* j = NULL;

    j = ExecInitJunkFilter(targetlist,
        result_rel_info->ri_RelationDesc->rd_att->tdhasoid,
        ExecInitExtraTupleSlot(estate, result_rel_info->ri_RelationDesc->rd_tam_type));

    if (operation == CMD_UPDATE || operation == CMD_DELETE || operation == CMD_MERGE) {
        /* For UPDATE/DELETE, find the appropriate junk attr now */
        char relkind;

        relkind = result_rel_info->ri_RelationDesc->rd_rel->relkind;
        if (relkind == RELKIND_RELATION) {
            j->jf_junkAttNo = ExecFindJunkAttribute(j, "ctid");
            if (!AttributeNumberIsValid(j->jf_junkAttNo)) {
                ereport(ERROR,
                    (errmodule(MOD_EXECUTOR),
                        (errcode(ERRCODE_INVALID_ATTRIBUTE), errmsg("could not find junk ctid column"))));
            }

            /* if the table is partitioned table ,give a paritionOidJunkOid junk */
            if (RELATION_IS_PARTITIONED(result_rel_info->ri_RelationDesc) ||
                RelationIsCUFormat(result_rel_info->ri_RelationDesc)) {
                AttrNumber tableOidAttNum = ExecFindJunkAttribute(j, "tableoid");
                if (!AttributeNumberIsValid(tableOidAttNum)) {
                    ereport(ERROR,
                        (errmodule(MOD_EXECUTOR),
                            (errcode(ERRCODE_INVALID_ATTRIBUTE),
                                errmsg("could not find junk tableoid column for partition table."))));
                }

                result_rel_info->ri_partOidAttNum = tableOidAttNum;
                j->jf_xc_part_id = result_rel_info->ri_partOidAttNum;
            }

            if (RELATION_HAS_BUCKET(result_rel_info->ri_RelationDesc)) {
                AttrNumber bucketIdAttNum = ExecFindJunkAttribute(j, "tablebucketid");
                if (!AttributeNumberIsValid(bucketIdAttNum)) {
                    ereport(ERROR,
                        (errmodule(MOD_EXECUTOR),
                            (errcode(ERRCODE_INVALID_ATTRIBUTE),
                                errmsg("could not find junk bucketid column for bucketed table."))));
                }

                result_rel_info->ri_bucketIdAttNum = bucketIdAttNum;
                j->jf_xc_bucket_id = result_rel_info->ri_bucketIdAttNum;
            }
#ifdef PGXC
            if (IS_PGXC_COORDINATOR && RelationGetLocInfo(result_rel_info->ri_RelationDesc)) {
                /*
                    * We may or may not need these attributes depending upon
                    * the exact kind of trigger. We defer the check; instead throw
                    * error only at the point when we need but don't find one.
                    */
                j->jf_xc_node_id = ExecFindJunkAttribute(j, "xc_node_id");
                j->jf_xc_wholerow = ExecFindJunkAttribute(j, "wholerow");
                j->jf_primary_keys = ExecFindJunkPrimaryKeys(targetlist);
            } else if (IS_PGXC_DATANODE && !IS_SINGLE_NODE) {
                j->jf_xc_node_id = ExecFindJunkAttribute(j, "xc_node_id");
            }
#endif
        } else if (relkind == RELKIND_FOREIGN_TABLE || relkind == RELKIND_STREAM) {
            /* FDW must fetch any junk attrs it wants */
        } else {
            j->jf_junkAttNo = ExecFindJunkAttribute(j, "wholerow");
            if (!AttributeNumberIsValid(j->jf_junkAttNo)) {
                ereport(ERROR,
                    (errmodule(MOD_EXECUTOR),
                        (errcode(ERRCODE_INVALID_ATTRIBUTE),
                            errmsg("could not find junk wholerow column"))));
            }
        }
    }

    result_rel_info->ri_junkFilter = j;
}

/*
 * ExecFindJunkPrimaryKeys
 *
 * Locate the specified junk attribute in the junk filter's targetlist.
 * Returns NIL if not found.
 */
List* ExecFindJunkPrimaryKeys(List* targetlist)
{
    List* jk_primary_keys = NIL;
    ListCell* cell = NULL;

    foreach (cell, targetlist) {
        TargetEntry* tle = (TargetEntry*)lfirst(cell);

        if (tle->resjunk && tle->resname && (strcmp(tle->resname, "xc_primary_key") == 0)) {
            /* We found it ! */
            jk_primary_keys = lappend(jk_primary_keys, tle->expr);
        }
    }

    return jk_primary_keys;
}

/*
 * ExecFindJunkAttributeInTlist
 *
 * Find a junk attribute given a subplan's targetlist (not necessarily
 * part of a JunkFilter).
 */
AttrNumber ExecFindJunkAttributeInTlist(List* targetlist, const char* attrName)
{
    ListCell* t = NULL;

    foreach (t, targetlist) {
        TargetEntry* tle = (TargetEntry*)lfirst(t);

        if (tle->resjunk && tle->resname && (strcmp(tle->resname, attrName) == 0)) {
            /* We found it ! */
            return tle->resno;
        }
    }

    return InvalidAttrNumber;
}

/*
 * ExecGetJunkAttribute
 *
 * Given a junk filter's input tuple (slot) and a junk attribute's number
 * previously found by ExecFindJunkAttribute, extract & return the value and
 * isNull flag of the attribute.
 */
Datum ExecGetJunkAttribute(TupleTableSlot* slot, AttrNumber attno, bool* isNull)
{
    Assert(attno > 0);
    Assert(slot != NULL);

    return tableam_tslot_getattr(slot, attno, isNull);
}

/*
 * ExecFilterJunk
 *
 * Construct and return a slot with all the junk attributes removed.
 */
TupleTableSlot* ExecFilterJunk(JunkFilter* junkfilter, TupleTableSlot* slot)
{
    TupleTableSlot* resultSlot = NULL;
    AttrNumber* cleanMap = NULL;
    TupleDesc cleanTupType;
    int cleanLength;
    int i;
    Datum* values = NULL;
    bool* isnull = NULL;
    Datum* old_values = NULL;
    bool* old_isnull = NULL;

    /*
     * Extract all the values of the old tuple.
     */

    /* Get the Table Accessor Method*/
    Assert(slot != NULL && slot->tts_tupleDescriptor != NULL);
    tableam_tslot_getallattrs(slot);
    old_values = slot->tts_values;
    old_isnull = slot->tts_isnull;

    /*
     * get info from the junk filter
     */
    cleanTupType = junkfilter->jf_cleanTupType;
    cleanLength = cleanTupType->natts;
    cleanMap = junkfilter->jf_cleanMap;
    resultSlot = junkfilter->jf_resultSlot;

    /*
     * Prepare to build a virtual result tuple.
     */
    (void)ExecClearTuple(resultSlot);
    values = resultSlot->tts_values;
    isnull = resultSlot->tts_isnull;

    /*
     * Transpose data into proper fields of the new tuple.
     */
    for (i = 0; i < cleanLength; i++) {
        int j = cleanMap[i];

        if (j == 0) {
            values[i] = (Datum)0;
            isnull[i] = true;
        } else {
            values[i] = old_values[j - 1];
            isnull[i] = old_isnull[j - 1];
        }
    }

    /*
     * And return the virtual tuple.
     */
    return ExecStoreVirtualTuple(resultSlot);
}

/*
 * BatchExecFilterJunk
 *
 * Construct and return a vector batch with all the junk attributes removed.
 */
VectorBatch* BatchExecFilterJunk(_in_ JunkFilter* junkfilter, __inout VectorBatch* batch)
{
    AttrNumber* cleanMap = NULL;
    TupleDesc cleanTupType;
    int cleanLength;
    int i;
    ScalarVector* columns = NULL;

    // Get info from the junk filter
    //
    cleanTupType = junkfilter->jf_cleanTupType;
    cleanLength = cleanTupType->natts;
    cleanMap = junkfilter->jf_cleanMap;
    columns = batch->m_arr;

    // Transpose data into proper fields of the new tuple.
    //
    for (i = 0; i < cleanLength; i++) {
        int j = cleanMap[i];

        if (j == 0) {
            for (int k = 0; k < columns[i].m_rows; k++) {
                columns[i].SetNull(k);
            }
        } else {
            columns[i] = columns[j - 1];
        }
    }

    // Return the modified batch without changing the column count
    // as the column count is early decided at compile time.
    //
    return batch;
}

void ExecSetjunkFilteDescriptor(JunkFilter* junkfilter, TupleDesc tupdesc)
{
    TupleDesc resultslotTupType;
    AttrNumber* cleanMap = NULL;
    int cleanLength;
    int i;

    cleanLength = junkfilter->jf_cleanTupType->natts;
    cleanMap = junkfilter->jf_cleanMap;

    resultslotTupType = junkfilter->jf_resultSlot->tts_tupleDescriptor;

    /*
     * Transpose tupdesc into proper fields of the new tupdesc.
     */
    for (i = 0; i < cleanLength; i++) {
        int j = cleanMap[i];
        if (j > 0)
            resultslotTupType->attrs[i]->atttypid = tupdesc->attrs[j - 1]->atttypid;
    }
}

/*
 * @Description: Check if junk attribute xc_node_id is the same as current node identifier
 *
 * @param[IN] junkfilter: junk attributes
 * @param[IN] batch: vector batch
 * @return: void
 */
void BatchCheckNodeIdentifier(JunkFilter* junkfilter, VectorBatch* batch)
{
    ScalarVector* xc_node_id_col = NULL;
    uint32 xc_node_id = 0;
    int counter = 0;

    if (InvalidAttrNumber == junkfilter->jf_xc_node_id) {
        return;
    }

    xc_node_id_col = &(batch->m_arr[junkfilter->jf_xc_node_id - 1]);

    for (counter = 0; counter < xc_node_id_col->m_rows; counter++) {
        xc_node_id = DatumGetUInt32(xc_node_id_col->m_vals[counter]);
        if (u_sess->pgxc_cxt.PGXCNodeIdentifier != xc_node_id) {
            ereport(ERROR,
                (errcode(ERRCODE_UNDEFINED_OBJECT),
                    errmsg("invalid node identifier for update/delete"),
                    errdetail("xc_node_id in batch is %u, while current node identifier is %u",
                        xc_node_id,
                        u_sess->pgxc_cxt.PGXCNodeIdentifier)));
        }
    }
}