define.c 21.5 KB
Newer Older
1 2 3
/*-------------------------------------------------------------------------
 *
 * define.c--
4 5 6
 *
 *    These routines execute some of the CREATE statements.  In an earlier
 *    version of Postgres, these were "define" statements.
7 8 9 10 11
 *
 * Copyright (c) 1994, Regents of the University of California
 *
 *
 * IDENTIFICATION
Bruce Momjian's avatar
Bruce Momjian committed
12
 *    $Header: /cvsroot/pgsql/src/backend/commands/define.c,v 1.7 1996/11/08 05:55:49 momjian Exp $
13 14 15 16 17
 *
 * DESCRIPTION
 *    The "DefineFoo" routines take the parse tree and pick out the
 *    appropriate arguments/flags, passing the results to the
 *    corresponding "FooDefine" routines (in src/catalog) that do
18 19
 *    the actual catalog-munging.  These routines also verify permission
 *    of the user to execute the command.
20 21 22
 *
 * NOTES
 *    These things must be defined and committed in the following order:
23 24 25 26 27 28
 *      "create function":
 *              input/output, recv/send procedures
 *      "create type":
 *              type
 *      "create operator":
 *              operators
29
 *
30 31
 *      Most of the parse-tree manipulation routines are defined in
 *      commands/manip.c.
32 33 34
 *
 *-------------------------------------------------------------------------
 */
35
#include <stdio.h>
36
#include <ctype.h>
37 38
#include <string.h>
#include <math.h>
39

40 41 42 43 44 45 46 47 48 49 50 51 52 53
#include <postgres.h>

#include <access/heapam.h>
#include <catalog/catname.h>
#include <catalog/pg_aggregate.h>
#include <catalog/pg_operator.h>
#include <catalog/pg_proc.h>
#include <catalog/pg_type.h>
#include <utils/syscache.h>
#include <fmgr.h>               /* for fmgr */
#include <utils/builtins.h>     /* prototype for textin() */
#include <commands/defrem.h>
#include <optimizer/xfunc.h>
#include <tcop/dest.h>
54
#include <catalog/pg_user.h>
55

56 57 58
static char *defGetString(DefElem *def);
static int  defGetTypeLength(DefElem *def);

59 60 61
#define DEFAULT_TYPDELIM        ','


62
void
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
case_translate_language_name(const char *input, char *output) {
/*-------------------------------------------------------------------------
  Translate the input language name to lower case, except if it's C,
  translate to upper case.  
--------------------------------------------------------------------------*/
    int i;

    for (i = 0; i < NAMEDATALEN && input[i] != '\0'; ++i) 
        output[i] = tolower(input[i]);

    output[i] = '\0';

    if (strcmp(output, "c") == 0) output[0] = 'C';
}    



void
compute_return_type(const Node *returnType, 
                    char **prorettype_p, bool *returnsSet_p) {
/*---------------------------------------------------------------------------
   Examine the "returns" clause returnType of the CREATE FUNCTION statement 
   and return information about it as **prorettype_p and **returnsSet.
----------------------------------------------------------------------------*/
    if (nodeTag(returnType) == T_TypeName) {
        /* a set of values */
        TypeName *setType = (TypeName *)returnType;
        *prorettype_p = setType->name,
        *returnsSet_p = true;
92
    }else {
93 94 95
        /* singleton */
        *prorettype_p = strVal(returnType);
        *returnsSet_p = false;
96
    }
97 98
}

99
    
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138

void 
compute_full_attributes(const List *parameters, int32 *byte_pct_p, 
                        int32 *perbyte_cpu_p, int32 *percall_cpu_p, 
                        int32 *outin_ratio_p, bool *canCache_p) {
/*--------------------------------------------------------------------------
  Interpret the parameters *parameters and return their contents as
  *byte_pct_p, etc.

  These are the full parameters of a C or internal function.
---------------------------------------------------------------------------*/
    List *pl;

    /* the defaults */
    *byte_pct_p = BYTE_PCT;
    *perbyte_cpu_p = PERBYTE_CPU;
    *percall_cpu_p = PERCALL_CPU;
    *outin_ratio_p = OUTIN_RATIO;

    foreach(pl, (List *)parameters) {
        int count;
        char *ptr;
        ParamString *param = (ParamString*)lfirst(pl);

        if (strcasecmp(param->name, "iscachable") == 0) {
            *canCache_p = true;
        } else if (strcasecmp(param->name, "trusted") == 0) {
        /*
         * we don't have untrusted functions any more. The 4.2
         * implementation is lousy anyway so I took it out.
         *                                         -ay 10/94
         */
        elog(WARN, "untrusted function has been decommissioned.");
        } else if (strcasecmp(param->name, "byte_pct") == 0) {
            /*
            ** handle expensive function parameters
            */
            *byte_pct_p = atoi(param->val);
        } else if (strcasecmp(param->name, "perbyte_cpu") == 0) {
Bruce Momjian's avatar
Bruce Momjian committed
139
			count = 0;
140
            if (sscanf(param->val, "%d", perbyte_cpu_p) == 0) {
Bruce Momjian's avatar
Bruce Momjian committed
141
                for (ptr = param->val; *ptr != '\0'; ptr++) 
142 143 144 145 146 147 148 149 150 151 152 153
                    if (*ptr == '!') count++;
            }
            *perbyte_cpu_p = (int) pow(10.0, (double) count);
        } else if (strcasecmp(param->name, "percall_cpu") == 0) {
            if (sscanf(param->val, "%d", percall_cpu_p) == 0) {
                for (count = 0, ptr = param->val; *ptr != '\0'; ptr++) 
                    if (*ptr == '!') count++;
                *percall_cpu_p = (int) pow(10.0, (double) count);
            }
        } else if (strcasecmp(param->name, "outin_ratio") == 0) {
            *outin_ratio_p = atoi(param->val);
        }
154
    }
155 156 157 158 159 160 161 162 163 164 165 166
}



void
interpret_AS_clause(const char languageName[], const char as[],
                    char **prosrc_str_p, char **probin_str_p) {

    if ( strcmp(languageName, "C") == 0 ||
         strcmp(languageName, "internal") == 0 ) {
        *prosrc_str_p = "-";
        *probin_str_p = (char *)as;
167
    } else {
168 169
        *prosrc_str_p = (char *)as;
        *probin_str_p = "-";
170
    }
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
}



/*
 * CreateFunction --
 *   Execute a CREATE FUNCTION utility statement.
 *
 */
void
CreateFunction(ProcedureStmt *stmt, CommandDest dest)
{
    char   *probin_str;   
      /* pathname of executable file that executes this function, if any */
    char   *prosrc_str;
      /* SQL that executes this function, if any */
    char   *prorettype;
      /* Type of return value (or member of set of values) from function */
    char   languageName[NAMEDATALEN+1];
      /* name of language of function, with case adjusted:
         "C", "internal", or "SQL" 
      */
    /* The following are attributes of the function, as expressed in the 
       CREATE FUNCTION statement, where applicable.
    */
    int32  byte_pct, perbyte_cpu, percall_cpu, outin_ratio;
    bool   canCache;
    bool   returnsSet;
      /* The function returns a set of values, as opposed to a singleton. */


    case_translate_language_name(stmt->language, languageName);

    compute_return_type(stmt->returnType, &prorettype, &returnsSet);

    if ( strcmp(languageName, "C") == 0 ||
         strcmp(languageName, "internal") == 0 )  {
        compute_full_attributes(stmt->withClause, 
                                &byte_pct, &perbyte_cpu, &percall_cpu,
                                &outin_ratio, &canCache);
    } else if (strcmp(languageName, "sql") == 0) {
        /* query optimizer groks sql, these are meaningless */
        perbyte_cpu = percall_cpu = 0;
        byte_pct = outin_ratio = 100;
        canCache = false;
    } else {
        elog(WARN, 
             "Unrecognized language specified in a CREATE FUNCTION: "
             "'%s'.  Recognized languages are sql, C, and internal.",
             languageName);
221
    }
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
   
    interpret_AS_clause(languageName, stmt->as, &prosrc_str, &probin_str);

    if (strcmp(languageName, "sql") != 0 && !superuser())
        elog(WARN, 
             "Only users with Postgres superuser privilege are permitted "
             "to create a function "
             "in the '%s' language.  Others may use the 'sql' language.", 
             languageName);
        /* Above does not return. */
    else {
        /* And now that we have all the parameters, and know we're permitted
           to do so, go ahead and create the function.
        */
        ProcedureCreate(stmt->funcname,
                        returnsSet,
                        prorettype,
                        languageName,
                        prosrc_str,         /* converted to text later */
                        probin_str,         /* converted to text later */
                        canCache,
                        true,               /* (obsolete "trusted") */
                        byte_pct,
                        perbyte_cpu,
                        percall_cpu, 
                        outin_ratio,
                        stmt->defArgs,
                        dest);
    }        
251 252
}

253 254


255 256 257
/* --------------------------------
 * DefineOperator--
 *
258 259 260
 *      this function extracts all the information from the
 *      parameter list generated by the parser and then has
 *      OperatorCreate() do all the actual work.
261 262 263 264 265
 *
 * 'parameters' is a list of DefElem
 * --------------------------------
 */
void
266 267
DefineOperator(char *oprName,   
               List *parameters)
268
{
269 270 271 272 273 274 275 276 277 278 279 280 281
    uint16      precedence=0;           /* operator precedence */
    bool        canHash=false;          /* operator hashes */
    bool        isLeftAssociative=true; /* operator is left associative */
    char *functionName=NULL;    /* function for operator */
    char *typeName1=NULL;               /* first type name */
    char *typeName2=NULL;               /* second type name */
    char *commutatorName=NULL;  /* optional commutator operator name */
    char *negatorName=NULL;     /* optional negator operator name */
    char *restrictionName=NULL; /* optional restrict. sel. procedure */
    char *joinName=NULL;                /* optional join sel. procedure name */
    char *sortName1=NULL;               /* optional first sort operator */
    char *sortName2=NULL;               /* optional second sort operator */
    List        *pl;
282 283 284 285 286

    /*
     * loop over the definition list and extract the information we need.
     */
    foreach (pl, parameters) {
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
        DefElem *defel = (DefElem *)lfirst(pl);

        if (!strcasecmp(defel->defname, "leftarg")) {
            /* see gram.y, must be setof */
            if (nodeTag(defel->arg)==T_TypeName) 
                elog(WARN, "setof type not implemented for leftarg");

            if (nodeTag(defel->arg)==T_String) {
                typeName1 = defGetString(defel);
            }else {
                elog(WARN, "type for leftarg is malformed.");
            }
        } else if (!strcasecmp(defel->defname, "rightarg")) {
            /* see gram.y, must be setof */
            if (nodeTag(defel->arg)==T_TypeName) 
                elog(WARN, "setof type not implemented for rightarg");

            if (nodeTag(defel->arg)==T_String) {
                typeName2 = defGetString(defel);
            }else {
                elog(WARN, "type for rightarg is malformed.");
            }
        } else if (!strcasecmp(defel->defname, "procedure")) {
            functionName = defGetString(defel);
        } else if (!strcasecmp(defel->defname, "precedence")) {
            /* NOT IMPLEMENTED (never worked in v4.2) */
            elog(NOTICE, "CREATE OPERATOR: precedence not implemented");
        } else if (!strcasecmp(defel->defname, "associativity")) {
            /* NOT IMPLEMENTED (never worked in v4.2) */
            elog(NOTICE, "CREATE OPERATOR: associativity not implemented");
        } else if (!strcasecmp(defel->defname, "commutator")) {
            commutatorName = defGetString(defel);
        } else if (!strcasecmp(defel->defname, "negator")) {
            negatorName = defGetString(defel);
        } else if (!strcasecmp(defel->defname, "restrict")) {
            restrictionName = defGetString(defel);
        } else if (!strcasecmp(defel->defname, "join")) {
            joinName = defGetString(defel);
        } else if (!strcasecmp(defel->defname, "hashes")) {
            canHash = TRUE;
        } else if (!strcasecmp(defel->defname, "sort1")) {
            /* ----------------
             * XXX ( ... [ , sort1 = oprname ] [ , sort2 = oprname ] ... )
             * XXX is undocumented in the reference manual source as of
             * 89/8/22.
             * ----------------
             */
            sortName1 = defGetString(defel);
        } else if (!strcasecmp(defel->defname, "sort2")) {
            sortName2 = defGetString(defel);
        } else {
            elog(NOTICE, "DefineOperator: attribute \"%s\" not recognized",
                 defel->defname);
        }
341 342 343 344 345 346
    }

    /*
     * make sure we have our required definitions
     */
    if (functionName==NULL) {
347
        elog(WARN, "Define: \"procedure\" unspecified");
348 349 350
    }
    
    /* ----------------
351
     *  now have OperatorCreate do all the work..
352 353
     * ----------------
     */
354 355 356 357 358 359 360 361 362 363 364 365 366
    OperatorCreate(oprName,     /* operator name */
                   typeName1,           /* first type name */
                   typeName2,           /* second type name */
                   functionName,        /* function for operator */
                   precedence,          /* operator precedence */
                   isLeftAssociative,   /* operator is left associative */
                   commutatorName,      /* optional commutator operator name */
                   negatorName,         /* optional negator operator name */
                   restrictionName,     /* optional restrict. sel. procedure */
                   joinName,            /* optional join sel. procedure name */
                   canHash,             /* operator hashes */
                   sortName1,           /* optional first sort operator */
                   sortName2);          /* optional second sort operator */
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
    
}

/* -------------------
 *  DefineAggregate
 * ------------------
 */
void
DefineAggregate(char *aggName, List *parameters)

{
    char *stepfunc1Name = NULL;
    char *stepfunc2Name = NULL;
    char *finalfuncName = NULL;
    char *baseType = NULL;
    char *stepfunc1Type = NULL;
    char *stepfunc2Type = NULL;
    char *init1 = NULL;
    char *init2 = NULL;
    List *pl;
    
    foreach (pl, parameters) {
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
        DefElem *defel = (DefElem *)lfirst(pl);

        /*
         * sfunc1
         */
        if (!strcasecmp(defel->defname, "sfunc1")) {
            stepfunc1Name = defGetString(defel);
        } else if (!strcasecmp(defel->defname, "basetype")) {
            baseType = defGetString(defel);
        } else if (!strcasecmp(defel->defname, "stype1")) {
            stepfunc1Type = defGetString(defel);

        /*
         * sfunc2
         */
        } else if (!strcasecmp(defel->defname, "sfunc2")) {
            stepfunc2Name = defGetString(defel);
        } else if (!strcasecmp(defel->defname, "stype2")) {
            stepfunc2Type = defGetString(defel);
        /*
         * final
         */
        } else if (!strcasecmp(defel->defname, "finalfunc")) {
            finalfuncName = defGetString(defel);
        /*
         * initial conditions
         */
        } else if (!strcasecmp(defel->defname, "initcond1")) {
            init1 = defGetString(defel);
        } else if (!strcasecmp(defel->defname, "initcond2")) {
            init2 = defGetString(defel);
        } else {
            elog(NOTICE, "DefineAggregate: attribute \"%s\" not recognized",
                 defel->defname);
        }
424 425 426 427 428 429
    }

    /*
     * make sure we have our required definitions
     */
    if (baseType==NULL) 
430
        elog(WARN, "Define: \"basetype\" unspecified");
431
    if (stepfunc1Name!=NULL) {
432 433
        if (stepfunc1Type==NULL) 
            elog(WARN, "Define: \"stype1\" unspecified");
434 435
    }
    if (stepfunc2Name!=NULL) {
436 437
        if (stepfunc2Type==NULL)
            elog(WARN, "Define: \"stype2\" unspecified");
438 439 440 441 442
    }

    /*
     * Most of the argument-checking is done inside of AggregateCreate
     */
443 444 445 446 447 448 449 450 451
    AggregateCreate(aggName,            /* aggregate name */
                    stepfunc1Name,      /* first step function name */
                    stepfunc2Name,      /* second step function name */
                    finalfuncName,      /* final function name */
                    baseType,           /* type of object being aggregated */
                    stepfunc1Type,      /* return type of first function */
                    stepfunc2Type,      /* return type of second function */
                    init1,      /* first initial condition */
                    init2);     /* second initial condition */
452 453 454 455 456 457
    
    /* XXX free palloc'd memory */
}

/*
 * DefineType --
458
 *      Registers a new type.
459 460 461 462 463
 *
 */
void
DefineType(char *typeName, List *parameters)
{
464 465
    int16               internalLength= 0;      /* int2 */
    int16               externalLength= 0;      /* int2 */
466 467 468 469 470
    char *elemName = NULL;
    char *inputName = NULL;
    char *outputName = NULL;
    char *sendName = NULL;
    char *receiveName = NULL;
471 472 473
    char                *defaultValue = NULL;   /* Datum */
    bool                byValue = false;
    char                delimiter = DEFAULT_TYPDELIM;
474
    char *shadow_type;
475 476
    List                *pl;
    char                alignment = 'i';        /* default alignment */
477 478 479 480 481 482

    /*
     * Type names can only be 15 characters long, so that the shadow type
     * can be created using the 16th character as necessary.
     */
    if (strlen(typeName) >= (NAMEDATALEN - 1)) {
483 484
        elog(WARN, "DefineType: type names must be %d characters or less",
             NAMEDATALEN - 1);
485 486 487
    }

    foreach(pl, parameters) {
488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524
        DefElem *defel = (DefElem*)lfirst(pl);

        if (!strcasecmp(defel->defname, "internallength")) {
            internalLength = defGetTypeLength(defel);
        }else if (!strcasecmp(defel->defname, "externallength")) {
            externalLength = defGetTypeLength(defel);
        }else if (!strcasecmp(defel->defname, "input")) {
            inputName = defGetString(defel);
        }else if (!strcasecmp(defel->defname, "output")) {
            outputName = defGetString(defel);
        }else if (!strcasecmp(defel->defname, "send")) {
            sendName = defGetString(defel);
        }else if (!strcasecmp(defel->defname, "delimiter")) {
            char *p = defGetString(defel);
            delimiter = p[0];
        }else if (!strcasecmp(defel->defname, "receive")) {
            receiveName = defGetString(defel);
        }else if (!strcasecmp(defel->defname, "element")) {
            elemName = defGetString(defel);
        }else if (!strcasecmp(defel->defname, "default")) {
            defaultValue = defGetString(defel);
        }else if (!strcasecmp(defel->defname, "passedbyvalue")) {
            byValue = true;
        }else if (!strcasecmp(defel->defname, "alignment")) {
            char *a = defGetString(defel);
            if (!strcasecmp(a, "double")) {
                alignment = 'd';
            } else if (!strcasecmp(a, "int")) {
                alignment = 'i';
            } else {
                elog(WARN, "DefineType: \"%s\" alignment  not recognized",
                     a);
            }
        }else {
            elog(NOTICE, "DefineType: attribute \"%s\" not recognized",
                 defel->defname);
        }
525 526 527 528 529 530
    }

    /*
     * make sure we have our required definitions
     */
    if (inputName==NULL)
531
        elog(WARN, "Define: \"input\" unspecified");
532
    if (outputName==NULL)
533
        elog(WARN, "Define: \"output\" unspecified");
534 535
    
    /* ----------------
536
     *  now have TypeCreate do all the real work.
537 538
     * ----------------
     */
539 540 541 542 543 544 545 546 547 548 549 550 551 552
    (void) TypeCreate(typeName, /* type name */
                      InvalidOid,  /* relation oid (n/a here) */
                      internalLength,   /* internal size */
                      externalLength,   /* external size */
                      'b',              /* type-type (base type) */
                      delimiter,        /* array element delimiter */
                      inputName,        /* input procedure */
                      outputName,       /* output procedure */
                      sendName,         /* send procedure */
                      receiveName,      /* receive procedure */
                      elemName,         /* element type name */
                      defaultValue,     /* default type value */
                      byValue,          /* passed by value */
                      alignment);
553 554 555 556 557 558 559 560
    
    /* ----------------
     *  When we create a true type (as opposed to a complex type)
     *  we need to have an shadow array entry for it in pg_type as well.
     * ----------------
     */
    shadow_type = makeArrayTypeName(typeName);

561 562 563 564 565 566 567 568 569 570 571 572 573 574
    (void) TypeCreate(shadow_type,      /* type name */
                      InvalidOid,  /* relation oid (n/a here) */
                      -1,               /* internal size */
                      -1,               /* external size */
                      'b',              /* type-type (base type) */
                      DEFAULT_TYPDELIM, /* array element delimiter */
                      "array_in",               /* input procedure */
                      "array_out",              /* output procedure */
                      "array_out",              /* send procedure */
                      "array_in",               /* receive procedure */
                      typeName, /* element type name */
                      defaultValue,     /* default type value */
                      false,            /* never passed by value */
                      alignment);
575 576 577 578 579 580 581 582
    
    pfree(shadow_type);
}

static char *
defGetString(DefElem *def)
{
    if (nodeTag(def->arg)!=T_String)
583
        elog(WARN, "Define: \"%s\" = what?", def->defname);
584 585 586 587 588 589 590
    return (strVal(def->arg));
}

static int 
defGetTypeLength(DefElem *def)
{
    if (nodeTag(def->arg)==T_Integer)
591
        return (intVal(def->arg));
592
    else if (nodeTag(def->arg)==T_String &&
593 594
             !strcasecmp(strVal(def->arg),"variable"))
        return -1;      /* variable length */
595 596 597 598

    elog(WARN, "Define: \"%s\" = what?", def->defname);
    return -1;
}