Line data    Source code

       1             : /*
       2             :  * SPDX-License-Identifier: MPL-2.0
       3             :  *
       4             :  * This Source Code Form is subject to the terms of the Mozilla Public
       5             :  * License, v. 2.0.  If a copy of the MPL was not distributed with this
       6             :  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
       7             :  *
       8             :  * Copyright 2024 MonetDB Foundation;
       9             :  * Copyright August 2008 - 2023 MonetDB B.V.;
      10             :  * Copyright 1997 - July 2008 CWI.
      11             :  */
      12             : 
      13             : /*
      14             :  * Constant Duplicate Removal
      15             :  * The compilers may generate an abundance of constants on
      16             :  * the stack. This simple optimizer merges them into a single reference.
      17             :  * This makes it easier to search for statement duplicates
      18             :  * and alias their variables.
      19             :  */
      20             : /* We should not look at constants in simple, side-effect functions, because
      21             :  * they can not be removed later on.
      22             : */
      23             : /*
      24             :  * We have to keep an alias table to reorganize the program
      25             :  * after the variable stack has changed.
      26             :  * The plan may contain many constants and to check them all would be quadratic
      27             :  * in the size of the constant list.
      28             :  * The heuristic is to look back into the list only partially.
      29             :  * A hash structure could help out with further reduction.
      30             :  */
      31             : #include "monetdb_config.h"
      32             : #include "mal_instruction.h"
      33             : #include "opt_constants.h"
      34             : 
      35             : str
      36      483984 : OPTconstantsImplementation(Client cntxt, MalBlkPtr mb, MalStkPtr stk,
      37             :                                                    InstrPtr pci)
      38             : {
      39      483984 :         int i, j, k = 1, n = 0, fnd = 0, actions = 0, limit = 0;
      40      483984 :         int *alias = NULL, *index = NULL, *cand = NULL;
      41      483984 :         VarPtr x, y, *cst = NULL;
      42      483984 :         str msg = MAL_SUCCEED;
      43      483984 :         InstrPtr p, q;
      44             : 
      45      483984 :         if (isSimpleSQL(mb)) {
      46      283892 :                 goto wrapup;
      47             :         }
      48      200093 :         alias = (int *) GDKzalloc(sizeof(int) * mb->vtop);
      49      200092 :         cand = (int *) GDKzalloc(sizeof(int) * mb->vtop);
      50      200092 :         cst = (VarPtr *) GDKzalloc(sizeof(VarPtr) * mb->vtop);
      51      200092 :         index = (int *) GDKzalloc(sizeof(int) * mb->vtop);
      52             : 
      53      200091 :         if (alias == NULL || cst == NULL || index == NULL || cand == NULL) {
      54           0 :                 msg = createException(MAL, "optimizer.constants",
      55             :                                                           SQLSTATE(HY013) MAL_MALLOC_FAIL);
      56           0 :                 goto wrapup;
      57             :         }
      58             : 
      59             :         (void) stk;
      60             :         (void) cntxt;
      61             : 
      62    15713812 :         for (i = 0; i < mb->stop; i++) {
      63    15513776 :                 q = getInstrPtr(mb, i);
      64    15513776 :                 if (!q) {
      65           0 :                         continue;
      66             :                 }
      67    15513776 :                 if (getModuleId(q) == sqlRef && getFunctionId(q) != tidRef) {
      68     2848715 :                         continue;
      69             :                 }
      70    12665061 :                 if (hasSideEffects(mb, q, 1))
      71     5821747 :                         continue;
      72    25170364 :                 for (k = q->retc; k < q->argc; k++) {
      73    18327105 :                         j = getArg(q, k);
      74    18327105 :                         if (cand[j] == 0) {
      75    14702564 :                                 cand[j] = isVarConstant(mb, j) && isVarFixed(mb, j)
      76    14702564 :                                                 && getVarType(mb, j) != TYPE_ptr;
      77             :                         }
      78             :                 }
      79             :         }
      80             : 
      81    31806362 :         for (i = 0; i < mb->vtop; i++)
      82    31606326 :                 alias[i] = i;
      83    31807348 :         for (i = 0; i < mb->vtop; i++)
      84    31607256 :                 if (cand[i]) {
      85     2730836 :                         x = getVar(mb, i);
      86     2730836 :                         fnd = 0;
      87     2730836 :                         limit = n - 128;        // don't look to far back
      88     2730836 :                         if (x->type && x->value.vtype)
      89    71194168 :                                 for (k = n - 1; k >= 0 && k > limit; k--) {
      90    69473967 :                                         y = cst[k];
      91    69473967 :                                         if (x->type == y->type && x->rowcnt == y->rowcnt
      92    35979245 :                                                 && x->value.vtype == y->value.vtype
      93    35978631 :                                                 && (x->value.vtype == TYPE_any
      94    35978545 :                                                 || ATOMcmp(x->value.vtype, VALptr(&x->value),
      95             :                                                                    VALptr(&y->value)) == 0)) {
      96             : 
      97             :                                                 /* reuse a constant */
      98      601696 :                                                 alias[i] = index[k];
      99      601696 :                                                 fnd = 1;
     100      601696 :                                                 actions++;
     101      601696 :                                                 break;
     102             :                                         }
     103             :                                 }
     104      601696 :                         if (fnd == 0) {
     105     2129196 :                                 cst[n] = x;
     106     2129196 :                                 index[n] = i;
     107     2129196 :                                 n++;
     108             :                         }
     109             :                 }
     110             : 
     111      200092 :         if (actions)
     112    10394394 :                 for (i = 0; i < mb->stop; i++) {
     113    10334270 :                         p = getInstrPtr(mb, i);
     114    52686389 :                         for (k = 0; k < p->argc; k++)
     115    42352119 :                                 getArg(p, k) = alias[getArg(p, k)];
     116             :                 }
     117             : 
     118             :         /* Defense line against incorrect plans */
     119             :         /* Plan remains unaffected */
     120             :         // msg = chkTypes(cntxt->usermodule, mb, FALSE);
     121             :         // if (!msg)
     122             :         //      msg = chkFlow(mb);
     123             :         // if(!msg)
     124             :         //      msg = chkDeclarations(mb);
     125             :         /* keep all actions taken as a post block comment */
     126      200092 :   wrapup:
     127             :         /* keep actions taken as a fake argument */
     128      483984 :         (void) pushInt(mb, pci, actions);
     129             : 
     130      483976 :         if (cand)
     131      200084 :                 GDKfree(cand);
     132      483985 :         if (alias)
     133      200093 :                 GDKfree(alias);
     134      483985 :         if (cst)
     135      200093 :                 GDKfree(cst);
     136      483985 :         if (index)
     137      200093 :                 GDKfree(index);
     138      483985 :         return msg;
     139             : }