v13 support
[plantuner.git] / plantuner.c
index bf3c511..f87dcea 100644 (file)
@@ -6,13 +6,13 @@
  * modification, are permitted provided that the following conditions
  * are met:
  * 1. Redistributions of source code must retain the above copyright
- *        notice, this list of conditions and the following disclaimer.
+ *             notice, this list of conditions and the following disclaimer.
  * 2. Redistributions in binary form must reproduce the above copyright
- *        notice, this list of conditions and the following disclaimer in the
- *        documentation and/or other materials provided with the distribution.
+ *             notice, this list of conditions and the following disclaimer in the
+ *             documentation and/or other materials provided with the distribution.
  * 3. Neither the name of the author nor the names of any co-contributors
- *        may be used to endorse or promote products derived from this software
- *        without specific prior written permission.
+ *             may be used to endorse or promote products derived from this software
+ *             without specific prior written permission.
  *
  * THIS SOFTWARE IS PROVIDED BY CONTRIBUTORS ``AS IS'' AND ANY EXPRESS
  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 #include <postgres.h>
 
 #include <fmgr.h>
+#include <miscadmin.h>
+#include <access/heapam.h>
+#include <access/xact.h>
 #include <catalog/namespace.h>
 #include <catalog/pg_class.h>
 #include <nodes/pg_list.h>
 #include <optimizer/plancat.h>
+#include <storage/bufmgr.h>
 #include <utils/builtins.h>
 #include <utils/guc.h>
 #include <utils/lsyscache.h>
+#include <utils/rel.h>
+#if PG_VERSION_NUM >= 100000
+#include <utils/regproc.h>
+#include <utils/varlena.h>
+#endif
 
 PG_MODULE_MAGIC;
 
-static int     nIndexesOut = 0;
-static Oid     *indexesOut = NULL;
+#if PG_VERSION_NUM >= 130000
+#define heap_open(r, l)                                        table_open(r, l)
+#define heap_close(r, l)                               table_close(r, l)
+#endif
+
+static int     nDisabledIndexes = 0;
+static Oid     *disabledIndexes = NULL;
+static char *disableIndexesOutStr = "";
+
+static int     nEnabledIndexes = 0;
+static Oid     *enabledIndexes = NULL;
+static char *enableIndexesOutStr = "";
+
+static int     nOnlyIndexes = 0;
+static Oid     *onlyIndexes = NULL;
+static char *onlyIndexesOutStr = "";
+
 get_relation_info_hook_type    prevHook = NULL;
+static bool    fix_empty_table = false;
+
+static bool    plantuner_enable_inited = false;
+static bool    plantuner_only_inited = false;
+static bool    plantuner_disable_inited = false;
 
-static char *indexesOutStr = "";
+typedef enum IndexListKind {
+       EnabledKind,
+       DisabledKind,
+       OnlyKind
+} IndexListKind;
 
 static const char *
-indexesOutAssign(const char * newval, bool doit, GucSource source) 
+indexesAssign(const char * newval, bool doit, GucSource source,
+                         IndexListKind kind)
 {
-       char       *rawname;
-       List       *namelist;
-       ListCell   *l;
+       char            *rawname;
+       List            *namelist;
+       ListCell        *l;
        Oid                     *newOids = NULL;
        int                     nOids = 0,
                                i = 0;
@@ -61,27 +95,83 @@ indexesOutAssign(const char * newval, bool doit, GucSource source)
        if (!SplitIdentifierString(rawname, ',', &namelist))
                goto cleanup;
 
-       if (doit) 
+       /*
+        * follow work could be done only in normal processing because of
+        * accsess to system catalog
+        */
+       if (MyBackendId == InvalidBackendId || !IsUnderPostmaster ||
+               !IsTransactionState())
+       {
+               /* reset init state */
+               switch(kind)
+               {
+                       case EnabledKind:
+                               plantuner_enable_inited = false;
+                               break;
+                       case DisabledKind:
+                               plantuner_disable_inited = false;
+                               break;
+                       case OnlyKind:
+                               plantuner_only_inited = false;
+                               break;
+                       default:
+                               elog(ERROR, "wrong kind");
+               }
+
+               return newval;
+       }
+
+       if (doit)
        {
                nOids = list_length(namelist);
                newOids = malloc(sizeof(Oid) * (nOids+1));
                if (!newOids)
-                       elog(ERROR,"could not allocate %d bytes", sizeof(Oid) * (nOids+1));
+                       elog(ERROR,"could not allocate %d bytes",
+                                (int)(sizeof(Oid) * (nOids+1)));
+       }
+
+       switch(kind)
+       {
+               case EnabledKind:
+                       plantuner_enable_inited = true;
+                       break;
+               case DisabledKind:
+                       plantuner_disable_inited = true;
+                       break;
+               case OnlyKind:
+                       plantuner_only_inited = true;
+                       break;
+               default:
+                       elog(ERROR, "wrong kind");
        }
 
        foreach(l, namelist)
        {
-               char            *curname = (char *) lfirst(l);
-               Oid                     indexOid = RangeVarGetRelid(makeRangeVarFromNameList(stringToQualifiedNameList(curname)), true);
+               char    *curname = (char *) lfirst(l);
+#if PG_VERSION_NUM >= 90200
+               Oid             indexOid = RangeVarGetRelid(
+                               makeRangeVarFromNameList(stringToQualifiedNameList(curname)),
+                                                                                       NoLock, true);
+#else
+               Oid             indexOid = RangeVarGetRelid(
+                               makeRangeVarFromNameList(stringToQualifiedNameList(curname)),
+                                                                                       true);
+#endif
 
                if (indexOid == InvalidOid)
                {
-                       elog(WARNING,"'%s' does not exist", curname);
+#if PG_VERSION_NUM >= 90100
+                       if (doit == false)
+#endif
+                               elog(WARNING,"'%s' does not exist", curname);
                        continue;
                }
                else if ( get_rel_relkind(indexOid) != RELKIND_INDEX )
                {
-                       elog(WARNING,"'%s' is not an index", curname);
+#if PG_VERSION_NUM >= 90100
+                       if (doit == false)
+#endif
+                               elog(WARNING,"'%s' is not an index", curname);
                        continue;
                }
                else if (doit)
@@ -90,10 +180,31 @@ indexesOutAssign(const char * newval, bool doit, GucSource source)
                }
        }
 
-       if (doit) 
+       if (doit)
        {
-               nIndexesOut = nOids;
-               indexesOut = newOids;
+               switch(kind)
+               {
+                       case EnabledKind:
+                               nEnabledIndexes = i;
+                               if (enabledIndexes)
+                                       free(enabledIndexes);
+                               enabledIndexes = newOids;
+                               break;
+                       case DisabledKind:
+                               nDisabledIndexes = i;
+                               if (disabledIndexes)
+                                       free(disabledIndexes);
+                               disabledIndexes = newOids;
+                               break;
+                       case OnlyKind:
+                               nOnlyIndexes = i;
+                               if (onlyIndexes)
+                                       free(onlyIndexes);
+                               onlyIndexes = newOids;
+                               break;
+                       default:
+                               elog(ERROR, "wrong kind");
+               }
        }
 
        pfree(rawname);
@@ -109,50 +220,210 @@ cleanup:
        return NULL;
 }
 
+static const char *
+assignDisabledIndexes(const char * newval, bool doit, GucSource source)
+{
+       return indexesAssign(newval, doit, source, DisabledKind);
+}
+
+static const char *
+assignEnabledIndexes(const char * newval, bool doit, GucSource source)
+{
+       return indexesAssign(newval, doit, source, EnabledKind);
+}
+
+static const char *
+assignOnlyIndexes(const char * newval, bool doit, GucSource source)
+{
+       return indexesAssign(newval, doit, source, OnlyKind);
+}
+
+static void
+lateInit()
+{
+       if (!plantuner_only_inited)
+               indexesAssign(onlyIndexesOutStr, true, PGC_S_USER, OnlyKind);
+       if (!plantuner_enable_inited)
+               indexesAssign(enableIndexesOutStr, true, PGC_S_USER, EnabledKind);
+       if (!plantuner_disable_inited)
+               indexesAssign(disableIndexesOutStr, true, PGC_S_USER, DisabledKind);
+}
+
+#if PG_VERSION_NUM >= 90100
+
+static bool
+checkOnlyIndexes(char **newval, void **extra, GucSource source)
+{
+       char *val;
+
+       val = (char*)indexesAssign(*newval, false, source, OnlyKind);
+
+       if (val)
+       {
+               *newval = val;
+               return true;
+       }
+
+       return false;
+}
+
+static bool
+checkDisabledIndexes(char **newval, void **extra, GucSource source)
+{
+       char *val;
+
+       val = (char*)indexesAssign(*newval, false, source, DisabledKind);
+
+       if (val)
+       {
+               *newval = val;
+               return true;
+       }
+
+       return false;
+}
+
+static bool
+checkEnabledIndexes(char **newval, void **extra, GucSource source)
+{
+       char *val;
+
+       val = (char*)indexesAssign(*newval, false, source, EnabledKind);
+
+       if (val)
+       {
+               *newval = val;
+               return true;
+       }
+
+       return false;
+}
+
+static void
+assignDisabledIndexesNew(const char *newval, void *extra)
+{
+       assignDisabledIndexes(newval, true, PGC_S_USER /* doesn't matter */);
+}
+
+static void
+assignEnabledIndexesNew(const char *newval, void *extra)
+{
+       assignEnabledIndexes(newval, true, PGC_S_USER /* doesn't matter */);
+}
 
 static void
-indexFilter(PlannerInfo *root, Oid relationObjectId, bool inhparent, RelOptInfo *rel) {
+assignOnlyIndexesNew(const char *newval, void *extra)
+{
+       assignOnlyIndexes(newval, true, PGC_S_USER /* doesn't matter */);
+}
+
+#endif
+
+static void
+indexFilter(PlannerInfo *root, Oid relationObjectId, bool inhparent,
+                       RelOptInfo *rel)
+{
        int i;
 
-       for(i=0;i<nIndexesOut;i++)
+       lateInit();
+
+       if (nOnlyIndexes > 0)
        {
-               ListCell   *l;
+               ListCell        *l;
 
+restart1:
                foreach(l, rel->indexlist)
                {
                        IndexOptInfo    *info = (IndexOptInfo*)lfirst(l);
+                       bool                    remove = true;
+
+                       for(i=0; remove && i<nOnlyIndexes; i++)
+                               if (onlyIndexes[i] == info->indexoid)
+                                       remove = false;
 
-                       if (indexesOut[i] == info->indexoid)
+                       if (remove)
                        {
                                rel->indexlist = list_delete_ptr(rel->indexlist, info);
+                               goto restart1;
+                       }
+               }
+
+               return;
+       }
+
+       for(i=0; i<nDisabledIndexes; i++)
+       {
+               ListCell   *l;
+
+               foreach(l, rel->indexlist)
+               {
+                       IndexOptInfo    *info = (IndexOptInfo*)lfirst(l);
+
+                       if (disabledIndexes[i] == info->indexoid)
+                       {
+                               int j;
+
+                               for(j=0; j<nEnabledIndexes; j++)
+                                       if (enabledIndexes[j] == info->indexoid)
+                                               break;
+
+                               if (j >= nEnabledIndexes)
+                                       rel->indexlist = list_delete_ptr(rel->indexlist, info);
+
                                break;
                        }
                }
        }
+}
+
+static void
+execPlantuner(PlannerInfo *root, Oid relationObjectId, bool inhparent,
+                         RelOptInfo *rel)
+{
+       Relation        relation;
+
+       relation = heap_open(relationObjectId, NoLock);
+       if (relation->rd_rel->relkind == RELKIND_RELATION)
+       {
+               if (fix_empty_table && RelationGetNumberOfBlocks(relation) == 0)
+               {
+                       /*
+                        * estimate_rel_size() could be too pessimistic for particular
+                        * workload
+                        */
+                       rel->pages = 1.0;
+                       rel->tuples = 0.0;
+               }
+
+               indexFilter(root, relationObjectId, inhparent, rel);
+       }
+       heap_close(relation, NoLock);
 
        /*
-        * Call next hook if it exists 
+        * Call next hook if it exists
         */
        if (prevHook)
                prevHook(root, relationObjectId, inhparent, rel);
 }
 
 static const char*
-IndexFilterShow(void) 
+IndexFilterShow(Oid* indexes, int nIndexes)
 {
-       char    *val, *ptr;
-       int     i,
+       char    *val, *ptr;
+       int             i,
                        len;
 
-       len = 1 /* \0 */ + nIndexesOut * (2 * NAMEDATALEN + 2 /* ', ' */ + 1 /* . */);
+       lateInit();
+
+       len = 1 /* \0 */ + nIndexes * (2 * NAMEDATALEN + 2 /* ', ' */ + 1 /* . */);
        ptr = val = palloc(len);
 
-       *ptr ='\0';
-       for(i=0; i<nIndexesOut; i++)
+       *ptr =(char)'\0';
+       for(i=0; i<nIndexes; i++)
        {
-               char    *relname = get_rel_name(indexesOut[i]);
-               Oid     nspOid = get_rel_namespace(indexesOut[i]);
-               char    *nspname = get_namespace_name(nspOid); 
+               char    *relname = get_rel_name(indexes[i]);
+               Oid             nspOid = get_rel_namespace(indexes[i]);
+               char    *nspname = get_namespace_name(nspOid);
 
                if ( relname == NULL || nspOid == InvalidOid || nspname == NULL )
                        continue;
@@ -166,25 +437,118 @@ IndexFilterShow(void)
        return val;
 }
 
+static const char*
+disabledIndexFilterShow(void)
+{
+       return IndexFilterShow(disabledIndexes, nDisabledIndexes);
+}
+
+static const char*
+enabledIndexFilterShow(void)
+{
+       return IndexFilterShow(enabledIndexes, nEnabledIndexes);
+}
+
+static const char*
+onlyIndexFilterShow(void)
+{
+       return IndexFilterShow(onlyIndexes, nOnlyIndexes);
+}
+
 void _PG_init(void);
 void
-_PG_init(void) 
+_PG_init(void)
 {
-    DefineCustomStringVariable(
+       DefineCustomStringVariable(
                "plantuner.forbid_index",
-               "List of forbidden indexes",
+               "List of forbidden indexes (deprecated)",
+               "Listed indexes will not be used in queries (deprecated, use plantuner.disable_index)",
+               &disableIndexesOutStr,
+               "",
+               PGC_USERSET,
+               0,
+#if PG_VERSION_NUM >= 90100
+               checkDisabledIndexes,
+               assignDisabledIndexesNew,
+#else
+               assignDisabledIndexes,
+#endif
+               disabledIndexFilterShow
+       );
+
+       DefineCustomStringVariable(
+               "plantuner.disable_index",
+               "List of disabled indexes",
                "Listed indexes will not be used in queries",
-               &indexesOutStr,
+               &disableIndexesOutStr,
+               "",
+               PGC_USERSET,
+               0,
+#if PG_VERSION_NUM >= 90100
+               checkDisabledIndexes,
+               assignDisabledIndexesNew,
+#else
+               assignDisabledIndexes,
+#endif
+               disabledIndexFilterShow
+       );
+
+       DefineCustomStringVariable(
+               "plantuner.enable_index",
+               "List of enabled indexes (overload plantuner.disable_index)",
+               "Listed indexes which could be used in queries even they are listed in plantuner.disable_index",
+               &enableIndexesOutStr,
                "",
                PGC_USERSET,
                0,
-               indexesOutAssign,
-               IndexFilterShow
+#if PG_VERSION_NUM >= 90100
+               checkEnabledIndexes,
+               assignEnabledIndexesNew,
+#else
+               assignEnabledIndexes,
+#endif
+               enabledIndexFilterShow
+       );
+
+       DefineCustomStringVariable(
+               "plantuner.only_index",
+               "List of explicitly enabled indexes (overload plantuner.disable_index and plantuner.enable_index)",
+               "Only indexes in this list are allowed",
+               &onlyIndexesOutStr,
+               "",
+               PGC_USERSET,
+               0,
+#if PG_VERSION_NUM >= 90100
+               checkOnlyIndexes,
+               assignOnlyIndexesNew,
+#else
+               assignOnlyIndexes,
+#endif
+               onlyIndexFilterShow
+       );
+
+       DefineCustomBoolVariable(
+               "plantuner.fix_empty_table",
+               "Sets to zero estimations for empty tables",
+               "Sets to zero estimations for empty or newly created tables",
+               &fix_empty_table,
+#if PG_VERSION_NUM >= 80400
+               fix_empty_table,
+#endif
+               PGC_USERSET,
+#if PG_VERSION_NUM >= 80400
+               GUC_NOT_IN_SAMPLE,
+#if PG_VERSION_NUM >= 90100
+               NULL,
+#endif
+#endif
+               NULL,
+               NULL
        );
 
-       if (get_relation_info_hook != indexFilter )
+       if (get_relation_info_hook != execPlantuner )
        {
                prevHook = get_relation_info_hook;
-               get_relation_info_hook = indexFilter;
+               get_relation_info_hook = execPlantuner;
        }
 }