dss.h

/*
 * Sccsid:     @(#)dss.h	2.1.8.5
 *
 * general definitions and control information for the DSS code 
 * generator; if it controls the data set, it's here
 */
#ifndef DSS_H
#define DSS_H

#ifdef SSBM
#define NAME "SSBM (Star Schema Benchmark)"
#define VERSION 1
#define RELEASE 0
#define MODIFICATION 0
#define PATCH ""

/*global variables*/
/*SSBM added DATE table*/
#define DATE 4

/*SSBM use the lineorder without partsupp and order table*/
#define L_SKEY_MIN 1
#define L_SKEY_MAX (tdefs[SUPP].base * scale)

#endif

#ifdef TPCH
#define NAME "TPC-H"
#define VERSION 1
#define RELEASE 3
#define MODIFICATION 0
#define PATCH ""
#endif
#ifdef TPCR
#define NAME "TPC-R"
#define VERSION 1
#define RELEASE 3
#define MODIFICATION 0
#define PATCH ""
#endif
#ifndef NAME
#error Benchmark version must be defined in config.h
#endif
#define TPC "Transaction Processing Performance Council"
#define C_DATES "1994 - 2000"

#include "config.h"
#include "shared.h"

#include <stdio.h>
#include <stdlib.h>
#ifdef SSBM
#include <math.h>
#endif

#define NONE -1
#define PART 0
#define PSUPP 1
#define SUPP 2
#define CUST 3
#define ORDER 4
#define LINE 5
#define ORDER_LINE 6
#define PART_PSUPP 7
#define NATION 8
#define REGION 9
#define UPDATE 10
#define MAX_TABLE 11
#define ONE_STREAM 1
#define ADD_AT_END 2

#ifdef MAX
#undef MAX
#endif
#ifdef MIN
#undef MIN
#endif
#define MAX(a, b) ((a > b) ? a : b)
#define MIN(A, B) ((A) < (B) ? (A) : (B))

#define INTERNAL_ERROR(p)       \
   {                            \
      fprintf(stderr, "%s", p); \
      abort();                  \
   }
#define LN_CNT 4
static char lnoise[4] = {'|', '/', '-', '\\'};
#define LIFENOISE(n, var) \
   if (verbose > 0)       \
   fprintf(stderr, "%c\b", lnoise[(var % LN_CNT)])

#define MALLOC_CHECK(var)                         \
   if ((var) == NULL)                             \
   {                                              \
      fprintf(stderr, "Malloc failed at %s:%d\n", \
              __FILE__, __LINE__);                \
      exit(1);                                    \
   }
#define OPEN_CHECK(var, path)                          \
   if ((var) == NULL)                                  \
   {                                                   \
      fprintf(stderr, "Open failed for %s at %s:%d\n", \
              path, __FILE__, __LINE__);               \
      exit(1);                                         \
   }
#ifndef MAX_CHILDREN
#define MAX_CHILDREN 1000
#endif

/*
 * macros that control sparse keys
 *
 * refer to Porting.Notes for a complete explanation
 */
#ifndef BITS_PER_LONG
#define BITS_PER_LONG 32
#define MAX_LONG 0x7FFFFFFF
#endif /* BITS_PER_LONG */
#define SPARSE_BITS 2
#define SPARSE_KEEP 3
#define MK_SPARSE(key, seq) \
   (((((key >> 3) << 2) | (seq & 0x0003)) << 3) | (key & 0x0007))

#define RANDOM(tgt, lower, upper, stream) dss_random(&tgt, lower, upper, stream)
#ifdef SSBM
typedef struct
{
   char *name;
   int start_day;
   int start_month;
   int end_day;
   int end_month;
} season;
typedef struct
{
   char *name;
   int month;
   int day;
} holiday;

#endif

typedef struct
{
   long weight;
   char *text;
} set_member;

typedef struct
{
   int count;
   int max;
   set_member *list;
   long *permute;
} distribution;

/*
 * some handy access functions 
 */
#define DIST_SIZE(d) d->count
#define DIST_MEMBER(d, i) ((set_member *)((d)->list + i))->text

typedef struct
{
   char *name;
   char *comment;
   long base;
   int (*header)();
   int (*loader[2])();
   long (*gen_seed)();
   int (*verify)();
   int child;
   unsigned long vtotal;
} tdef;

typedef struct SEED_T
{
   long table;
   long value;
   long usage;
   long boundary;
} seed_t;

#if defined(__STDC__)
#define PROTO(s) s
#else
#define PROTO(s) ()
#endif

/* bm_utils.c */
char *env_config PROTO((char *var, char *dflt));
long yes_no PROTO((char *prompt));
int a_rnd PROTO((int min, int max, int column, char *dest));
int tx_rnd PROTO((long min, long max, long column, char *tgt));
long julian PROTO((long date));
long unjulian PROTO((long date));
FILE *tbl_open PROTO((int tbl, char *mode));
long dssncasecmp PROTO((char *s1, char *s2, int n));
long dsscasecmp PROTO((char *s1, char *s2));
int pick_str PROTO((distribution * s, int c, char *target));
void agg_str PROTO((distribution * set, long count, long col, char *dest));
void read_dist PROTO((char *path, char *name, distribution *target));
void embed_str PROTO((distribution * d, int min, int max, int stream, char *dest));
#ifndef STDLIB_HAS_GETOPT
int getopt PROTO((int arg_cnt, char **arg_vect, char *oprions));
#endif /* STDLIB_HAS_GETOPT */
long set_state PROTO((int t, long scale, long procs, long step, long *e));

/* rnd.c */
long NextRand PROTO((long nSeed));
long UnifInt PROTO((long nLow, long nHigh, long nStream));
double UnifReal PROTO((double dLow, double dHigh, long nStream));
double Exponential PROTO((double dMean, long nStream));
void dss_random(long *tgt, long min, long max, long seed);
void row_start(int t);
void row_stop(int t);
void dump_seeds(int t);

/* text.c */
#define MAX_GRAMMAR_LEN 12 /* max length of grammar component */
#define MAX_SENT_LEN 256   /* max length of populated sentence */
#define RNG_PER_SENT 27    /* max number of RNG calls per sentence */

int dbg_text PROTO((char *t, int min, int max, int s));

#ifdef DECLARER
#define EXTERN
#else
#define EXTERN extern
#endif /* DECLARER */

EXTERN distribution nations;
EXTERN distribution nations2;
EXTERN distribution regions;
EXTERN distribution o_priority_set;
EXTERN distribution l_instruct_set;
EXTERN distribution l_smode_set;
EXTERN distribution l_category_set;
EXTERN distribution l_rflag_set;
EXTERN distribution c_mseg_set;
EXTERN distribution colors;
EXTERN distribution p_types_set;
EXTERN distribution p_cntr_set;

/* distributions that control text generation */
EXTERN distribution articles;
EXTERN distribution nouns;
EXTERN distribution adjectives;
EXTERN distribution adverbs;
EXTERN distribution prepositions;
EXTERN distribution verbs;
EXTERN distribution terminators;
EXTERN distribution auxillaries;
EXTERN distribution np;
EXTERN distribution vp;
EXTERN distribution grammar;

EXTERN long scale;
EXTERN int refresh;
EXTERN int resume;
EXTERN long verbose;
EXTERN long force;
EXTERN long header;
EXTERN long columnar;
EXTERN long direct;
EXTERN long updates;
EXTERN long table;
EXTERN long children;
EXTERN long fnames;
EXTERN int gen_sql;
EXTERN int gen_rng;
EXTERN char *db_name;
EXTERN int step;
EXTERN int set_seeds;
EXTERN int validate;
EXTERN char *d_path;

/* added for segmented updates */
EXTERN int insert_segments;
EXTERN int delete_segments;
EXTERN int insert_orders_segment;
EXTERN int insert_lineitem_segment;
EXTERN int delete_segment;

#ifndef DECLARER
extern tdef tdefs[];

#endif /* DECLARER */

/*****************************************************************
 ** table level defines use the following naming convention: t_ccc_xxx
 ** with: t, a table identifier
 **       ccc, a column identifier
 **       xxx, a limit type
 ****************************************************************
 */

/*
 * defines which control the parts table
 */
#define P_SIZE 126
#ifdef SSBM
#define P_NAME_SCL 3 /*5 change to 3 according to the new schema*/
#else
#define P_NAME_SCL 5
#endif
#define P_MFG_TAG "Manufacturer#"
#define P_MFG_FMT "%s%01d"
#define P_MFG_MIN 1
#define P_MFG_MAX 5
#define P_BRND_TAG "Brand#"
#define P_BRND_FMT "%s%02d"
#define P_BRND_MIN 1

/*#ifdef SSBM
#define  P_BRND_MAX     5
#else*/
#define P_BRND_MAX 40
/*#endif*/

#define P_SIZE_MIN 1
#define P_SIZE_MAX 50
#define P_MCST_MIN 100
#define P_MCST_MAX 99900
#define P_MCST_SCL 100.0
#define P_RCST_MIN 90000
#define P_RCST_MAX 200000
#define P_RCST_SCL 100.0
/*
 * defines which control the suppliers table
 */
#define S_SIZE 145
#define S_NAME_TAG "Supplier#"
#define S_NAME_FMT "%s%09ld"
#define S_ABAL_MIN -99999
#define S_ABAL_MAX 999999
#define S_CMNT_MAX 101
#define S_CMNT_BBB 10    /* number of BBB comments/SF */
#define BBB_DEADBEATS 50 /* % that are complaints */
#define BBB_BASE "Customer "
#define BBB_COMPLAIN "Complaints"
#define BBB_COMMEND "Recommends"
#define BBB_CMNT_LEN 19
#define BBB_BASE_LEN 9
#define BBB_TYPE_LEN 10

/*
 * defines which control the partsupp table
 */
#define PS_SIZE 145
#define PS_SKEY_MIN 0
#define PS_SKEY_MAX ((tdefs[SUPP].base - 1) * scale)
#define PS_SCST_MIN 100
#define PS_SCST_MAX 100000
#define PS_QTY_MIN 1
#define PS_QTY_MAX 9999
/*
 * defines which control the customers table
 */
#define C_SIZE 165
#define C_NAME_TAG "Customer#"
#define C_NAME_FMT "%s%09d"
#define C_MSEG_MAX 5
#define C_ABAL_MIN -99999
#define C_ABAL_MAX 999999
/*
 * defines which control the order table
 */
#define O_SIZE 109
#define O_CKEY_MIN 1
#define O_CKEY_MAX (long)(tdefs[CUST].base * scale)
#define O_ODATE_MIN STARTDATE
#define O_ODATE_MAX (STARTDATE + TOTDATE - \
                     (L_SDTE_MAX + L_RDTE_MAX) - 1)
#define O_CLRK_TAG "Clerk#"
#define O_CLRK_FMT "%s%09d"
#define O_CLRK_SCL 1000
#define O_LCNT_MIN 1
#define O_LCNT_MAX 7

/*
 * defines which control the lineitem table
 */
#define L_SIZE 144L
#define L_QTY_MIN 1
#define L_QTY_MAX 50
#define L_TAX_MIN 0
#define L_TAX_MAX 8
#define L_DCNT_MIN 0
#define L_DCNT_MAX 10
#define L_PKEY_MIN 1

#ifdef SSBM
/*part table log based*/
#define L_PKEY_MAX (tdefs[PART].base * (floor(log((double)scale)) + 1))
#else
#define L_PKEY_MAX (tdefs[PART].base * scale)
#endif

#define L_SDTE_MIN 1
#define L_SDTE_MAX 121
#define L_CDTE_MIN 30
#define L_CDTE_MAX 90
#define L_RDTE_MIN 1
#define L_RDTE_MAX 30
/*
 * defines which control the time table
 */
#define T_SIZE 30
#define T_START_DAY 3 /* wednesday ? */
#define LEAP(y) ((!(y % 4) && (y % 100)) ? 1 : 0)

/*******************************************************************
 *******************************************************************
 ***
 *** general or inter table defines
 ***
 *******************************************************************
 *******************************************************************/
#define SUPP_PER_PART 4
#define ORDERS_PER_CUST 10 /* sync this with CUST_MORTALITY */
#define CUST_MORTALITY 3   /* portion with have no orders */
#define NATIONS_MAX 90     /* limited by country codes in phone numbers */
#define PHONE_FMT "%02d-%03d-%03d-%04d"
#define STARTDATE 92001
#define CURRENTDATE 95168
#define ENDDATE 98365
#define TOTDATE 2557
#define UPD_PCT 10
#define MAX_STREAM 47
#define V_STR_LOW 0.4
#define PENNIES 100 /* for scaled int money arithmetic */
#define Q11_FRACTION (double)0.0001
/*
 * max and min SF in GB; Larger SF will require changes to the build routines
 */
#define MIN_SCALE 1.0
#define MAX_SCALE 1000.0
/*
 * beyond this point we need to allow for BCD calculations
 */
#define MAX_32B_SCALE 1000.0
#define INIT_HUGE(v)                                         \
   {                                                         \
      v = (DSS_HUGE *)malloc(sizeof(DSS_HUGE) * HUGE_COUNT); \
      MALLOC_CHECK(v);                                       \
   }
#define FREE_HUGE(v) free(v)
#ifdef SUPPORT_64BITS
#define LONG2HUGE(src, dst) *dst = (DSS_HUGE)src
#define HUGE2LONG(src, dst) *dst = (long)src
#define HUGE_SET(src, dst) *dst = *src
#define HUGE_MUL(op1, op2) *op1 *= op2
#define HUGE_DIV(op1, op2) *op1 /= op2
#define HUGE_ADD(op1, op2, dst) *dst = *op1 + op2
#define HUGE_SUB(op1, op2, dst) *dst = *op1 - op2
#define HUGE_MOD(op1, op2) *op1 % op2
#define HUGE_CMP(op1, op2) (*op1 == *op2) ? 0 : (*op1 < *op2) - 1 : 1
#else
#define LONG2HUGE(src, dst) \
   {                        \
      *dst = src;           \
      *(dst + 1) = 0;       \
   }
#define HUGE2LONG(src, dst)     \
   {                            \
      dst = 0;                  \
      bcd2_bin(dst, (src + 1)); \
      bcd2_bin(dst, src);       \
   }
#define HUGE_SET(src, dst)     \
   {                           \
      *dst = *src;             \
      *(dst + 1) = *(src + 1); \
   }
#define HUGE_MUL(op1, op2) bcd2_mul(op1, (op1 + 1), op2)
#define HUGE_DIV(op1, op2) bcd2_div(op1, (op1 + 1), op2)
#define HUGE_ADD(op1, op2, d)    \
   {                             \
      HUGE_SET(op1, d);          \
      bcd2_add(d, (d + 1), op2); \
   }
#define HUGE_SUB(op1, op2, d)    \
   {                             \
      HUGE_SET(op1, d);          \
      bcd2_sub(d, (d + 1), op2); \
   }
#define HUGE_MOD(op1, op2) bcd2_mod(op1, (op1 + 1), op2)
#define HUGE_CMP(op1, op2) (bcd2_cmp(op1, (op1 + 1), op2) == 0) ? 0 : ((bcd2_cmp(op1, (op1 + 1), op2) < 0) ? -1 : 1)
#endif /* SUPPORT_64BITS */

/******** environmental variables and defaults ***************/
#define DIST_TAG "DSS_DIST"     /* environment var to override ... */
#define DIST_DFLT "dists.dss"   /* default file to hold distributions */
#define PATH_TAG "DSS_PATH"     /* environment var to override ... */
#define PATH_DFLT "."           /* default directory to hold tables */
#define CONFIG_TAG "DSS_CONFIG" /* environment var to override ... */
#define CONFIG_DFLT "."         /* default directory to config files */
#define ADHOC_TAG "DSS_ADHOC"   /* environment var to override ... */
#define ADHOC_DFLT "adhoc.dss"  /* default file name for adhoc vars */

/******* output macros ********/
#ifndef SEPARATOR
#define SEPARATOR ',' /* field spearator for generated flat files */
#endif
/* Data type flags for a single print routine */
#define DT_STR 0
#ifndef MVS
#define DT_VSTR DT_STR
#else
#define DT_VSTR 1
#endif /* MVS */
#define DT_INT 2
#define DT_HUGE 3
#define DT_KEY 4
#define DT_MONEY 5
#define DT_CHR 6

int dbg_print(int dt, FILE *tgt, void *data, int len, int eol);
#define PR_STR(f, str, len) dbg_print(DT_STR, f, (void *)str, len, 1)
#define PR_VSTR(f, str, len) dbg_print(DT_VSTR, f, (void *)str, len, 1)
#define PR_VSTR_LAST(f, str, len) dbg_print(DT_VSTR, f, (void *)str, len, 0)
#define PR_INT(f, str) dbg_print(DT_INT, f, (void *)str, 0, 1)
#define PR_HUGE(f, str) dbg_print(DT_HUGE, f, (void *)str, 0, 1)
#define PR_KEY(f, str) dbg_print(DT_KEY, f, (void *)str, 0, -1)
#define PR_MONEY(f, str) dbg_print(DT_MONEY, f, (void *)str, 0, 1)
#define PR_CHR(f, str) dbg_print(DT_CHR, f, (void *)str, 0, 1)
#define PR_STRT(fp)                  /* any line prep for a record goes here */
#define PR_END(fp) fprintf(fp, "\n") /* finish the record here */

#ifdef SSBM
#define PR_DATE(tgt, yr, mn, dy) \
   sprintf(tgt, "19%02d-%02d-%02d", yr, mn, dy)
#else
#ifdef MDY_DATE
#define PR_DATE(tgt, yr, mn, dy) \
   sprintf(tgt, "%02d-%02d-19%02d", mn, dy, yr)
#else
#define PR_DATE(tgt, yr, mn, dy) \
   sprintf(tgt, "19%02d-%02d-%02d", yr, mn, dy)
#endif /* DATE_FORMAT */
#endif
/*
 * verification macros
 */
#define VRF_STR(t, d)              \
   {                               \
      char *xx = d;                \
      while (*xx)                  \
         tdefs[t].vtotal += *xx++; \
   }
#define VRF_INT(t, d) tdefs[t].vtotal += d
#ifdef SUPPORT_64BITS
#define VRF_HUGE(t, d) tdefs[t].vtotal = *((long *)&d) + *((long *)(&d + 1))
#else
#define VRF_HUGE(t, d) tdefs[t].vtotal += d[0] + d[1]
#endif /* SUPPORT_64BITS */
/* assume float is a 64 bit quantity */
#define VRF_MONEY(t, d) tdefs[t].vtotal = *((long *)&d) + *((long *)(&d + 1))
#define VRF_CHR(t, d) tdefs[t].vtotal += d
#define VRF_STRT(t)
#define VRF_END(t)

/*********** distribuitons currently defined *************/
#define UNIFORM 0

/*
 * seed indexes; used to separate the generation of individual columns
 */
#define P_MFG_SD 0
#define P_BRND_SD 1
#define P_TYPE_SD 2
#define P_SIZE_SD 3
#define P_CNTR_SD 4
#define P_RCST_SD 5
#define PS_QTY_SD 7
#define PS_SCST_SD 8
#define O_SUPP_SD 10
#define O_CLRK_SD 11
#define O_ODATE_SD 13
#define L_QTY_SD 14
#define L_DCNT_SD 15
#define L_TAX_SD 16
#define L_SHIP_SD 17
#define L_SMODE_SD 18
#define L_PKEY_SD 19
#define L_SKEY_SD 20
#define L_SDTE_SD 21
#define L_CDTE_SD 22
#define L_RDTE_SD 23
#define L_RFLG_SD 24
#define C_NTRG_SD 27
#define C_PHNE_SD 28
#define C_ABAL_SD 29
#define C_MSEG_SD 30
#define S_NTRG_SD 33
#define S_PHNE_SD 34
#define S_ABAL_SD 35
#define P_NAME_SD 37
#define O_PRIO_SD 38
#define HVAR_SD 39
#define O_CKEY_SD 40
#define N_CMNT_SD 41
#define R_CMNT_SD 42
#define O_LCNT_SD 43
#define BBB_JNK_SD 44
#define BBB_TYPE_SD 45
#define BBB_CMNT_SD 46
#define BBB_OFFSET_SD 47

#endif /* DSS_H */