util.c

   1 /*
   2  * Copyright (C) 2012, 2013
   3  *     Dale Weiler
   4  *     Wolfgang Bumiller
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy of
   7  * this software and associated documentation files (the "Software"), to deal in
   8  * the Software without restriction, including without limitation the rights to
   9  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
  10  * of the Software, and to permit persons to whom the Software is furnished to do
  11  * so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in all
  14  * copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  22  * SOFTWARE.
  23  */
  24 #include <string.h>
  25 #include <stdlib.h>
  26
  27 #include "gmqcc.h"
  28
  29 /*
  30  * Initially this was handled with a table in the gmqcc.h header, but
  31  * much to my surprise the contents of the table was duplicated for
  32  * each translation unit, causing all these strings to be duplicated
  33  * for every .c file it was included into. This method culls back on
  34  * it. This is a 'utility' function because the executor also depends
  35  * on this for disassembled byte-code.
  36  */
  37 const char *util_instr_str[VINSTR_END] = {
  38     "DONE",       "MUL_F",      "MUL_V",      "MUL_FV",
  39     "MUL_VF",     "DIV_F",      "ADD_F",      "ADD_V",
  40     "SUB_F",      "SUB_V",      "EQ_F",       "EQ_V",
  41     "EQ_S",       "EQ_E",       "EQ_FNC",     "NE_F",
  42     "NE_V",       "NE_S",       "NE_E",       "NE_FNC",
  43     "LE",         "GE",         "LT",         "GT",
  44     "LOAD_F",     "LOAD_V",     "LOAD_S",     "LOAD_ENT",
  45     "LOAD_FLD",   "LOAD_FNC",   "ADDRESS",    "STORE_F",
  46     "STORE_V",    "STORE_S",    "STORE_ENT",  "STORE_FLD",
  47     "STORE_FNC",  "STOREP_F",   "STOREP_V",   "STOREP_S",
  48     "STOREP_ENT", "STOREP_FLD", "STOREP_FNC", "RETURN",
  49     "NOT_F",      "NOT_V",      "NOT_S",      "NOT_ENT",
  50     "NOT_FNC",    "IF",         "IFNOT",      "CALL0",
  51     "CALL1",      "CALL2",      "CALL3",      "CALL4",
  52     "CALL5",      "CALL6",      "CALL7",      "CALL8",
  53     "STATE",      "GOTO",       "AND",        "OR",
  54     "BITAND",     "BITOR"
  55 };
  56
  57 /*
  58  * only required if big endian .. otherwise no need to swap
  59  * data.
  60  */
  61 #if PLATFORM_BYTE_ORDER == GMQCC_BYTE_ORDER_BIG
  62     static GMQCC_INLINE void util_swap16(uint16_t *d, size_t l) {
  63         while (l--) {
  64             d[l] = (d[l] << 8) | (d[l] >> 8);
  65         }
  66     }
  67
  68     static GMQCC_INLINE void util_swap32(uint32_t *d, size_t l) {
  69         while (l--) {
  70             uint32_t v;
  71             v = ((d[l] << 8) & 0xFF00FF00) | ((d[l] >> 8) & 0x00FF00FF);
  72             d[l] = (v << 16) | (v >> 16);
  73         }
  74     }
  75
  76     /* Some strange system doesn't like constants that big, AND doesn't recognize an ULL suffix
  77      * so let's go the safe way
  78      */
  79     static GMQCC_INLINE void util_swap64(uint32_t *d, size_t l) {
  80         /*
  81         while (l--) {
  82             uint64_t v;
  83             v = ((d[l] << 8) & 0xFF00FF00FF00FF00) | ((d[l] >> 8) & 0x00FF00FF00FF00FF);
  84             v = ((v << 16) & 0xFFFF0000FFFF0000) | ((v >> 16) & 0x0000FFFF0000FFFF);
  85             d[l] = (v << 32) | (v >> 32);
  86         }
  87         */
  88         size_t i;
  89         for (i = 0; i < l; i += 2) {
  90             uint32_t v1 = d[i];
  91             d[i] = d[i+1];
  92             d[i+1] = v1;
  93             util_swap32(d+i, 2);
  94         }
  95     }
  96 #endif
  97
  98 void util_endianswap(void *_data, size_t length, unsigned int typesize) {
  99 #   if PLATFORM_BYTE_ORDER == -1 /* runtime check */
 100     if (*((char*)&typesize))
 101         return;
 102 #else
 103     /* prevent unused warnings */
 104     (void) _data;
 105     (void) length;
 106     (void) typesize;
 107
 108 #   if PLATFORM_BYTE_ORDER == GMQCC_BYTE_ORDER_LITTLE
 109         return;
 110 #   else
 111         switch (typesize) {
 112             case 1: return;
 113             case 2:
 114                 util_swap16((uint16_t*)_data, length>>1);
 115                 return;
 116             case 4:
 117                 util_swap32((uint32_t*)_data, length>>2);
 118                 return;
 119             case 8:
 120                 util_swap64((uint32_t*)_data, length>>3);
 121                 return;
 122
 123             default: exit(EXIT_FAILURE); /* please blow the fuck up! */
 124         }
 125 #   endif
 126 #endif
 127 }
 128
 129 /*
 130  * CRC algorithms vary in the width of the polynomial, the value of said polynomial,
 131  * the initial value used for the register, weather the bits of each byte are reflected
 132  * before being processed, weather the algorithm itself feeds input bytes through the
 133  * register or XORs them with a byte from one end and then straight into the table, as
 134  * well as (but not limited to the idea of reflected versions) where the final register
 135  * value becomes reversed, and finally weather the value itself is used to XOR the final
 136  * register value.  AS such you can already imagine how painfully annoying CRCs are,
 137  * of course we stand to target Quake, which expects it's certain set of rules for proper
 138  * calculation of a CRC.
 139  *
 140  * In most traditional CRC algorithms on uses a reflected table driven method where a value
 141  * or register is reflected if it's bits are swapped around it's center.  For example:
 142  * take the bits 0101 is the 4-bit reflection of 1010, and respectfully 0011 would be the
 143  * reflection of 1100. Quake however expects a NON-Reflected CRC on the output, but still
 144  * requires a final XOR on the values (0xFFFF and 0x0000) this is a standard CCITT CRC-16
 145  * which I respectfully as a programmer don't agree with.
 146  *
 147  * So now you know what we target, and why we target it, despite how unsettling it may seem
 148  * but those are what Quake seems to request.
 149  */
 150
 151 static const uint16_t util_crc16_table[] = {
 152     0x0000, 0x1021, 0x2042, 0x3063, 0x4084, 0x50A5, 0x60C6, 0x70E7, 0x8108,
 153     0x9129, 0xA14A, 0xB16B, 0xC18C, 0xD1AD, 0xE1CE, 0xF1EF, 0x1231, 0x0210,
 154     0x3273, 0x2252, 0x52B5, 0x4294, 0x72F7, 0x62D6, 0x9339, 0x8318, 0xB37B,
 155     0xA35A, 0xD3BD, 0xC39C, 0xF3FF, 0xE3DE, 0x2462, 0x3443, 0x0420, 0x1401,
 156     0x64E6, 0x74C7, 0x44A4, 0x5485, 0xA56A, 0xB54B, 0x8528, 0x9509, 0xE5EE,
 157     0xF5CF, 0xC5AC, 0xD58D, 0x3653, 0x2672, 0x1611, 0x0630, 0x76D7, 0x66F6,
 158     0x5695, 0x46B4, 0xB75B, 0xA77A, 0x9719, 0x8738, 0xF7DF, 0xE7FE, 0xD79D,
 159     0xC7BC, 0x48C4, 0x58E5, 0x6886, 0x78A7, 0x0840, 0x1861, 0x2802, 0x3823,
 160     0xC9CC, 0xD9ED, 0xE98E, 0xF9AF, 0x8948, 0x9969, 0xA90A, 0xB92B, 0x5AF5,
 161     0x4AD4, 0x7AB7, 0x6A96, 0x1A71, 0x0A50, 0x3A33, 0x2A12, 0xDBFD, 0xCBDC,
 162     0xFBBF, 0xEB9E, 0x9B79, 0x8B58, 0xBB3B, 0xAB1A, 0x6CA6, 0x7C87, 0x4CE4,
 163     0x5CC5, 0x2C22, 0x3C03, 0x0C60, 0x1C41, 0xEDAE, 0xFD8F, 0xCDEC, 0xDDCD,
 164     0xAD2A, 0xBD0B, 0x8D68, 0x9D49, 0x7E97, 0x6EB6, 0x5ED5, 0x4EF4, 0x3E13,
 165     0x2E32, 0x1E51, 0x0E70, 0xFF9F, 0xEFBE, 0xDFDD, 0xCFFC, 0xBF1B, 0xAF3A,
 166     0x9F59, 0x8F78, 0x9188, 0x81A9, 0xB1CA, 0xA1EB, 0xD10C, 0xC12D, 0xF14E,
 167     0xE16F, 0x1080, 0x00A1, 0x30C2, 0x20E3, 0x5004, 0x4025, 0x7046, 0x6067,
 168     0x83B9, 0x9398, 0xA3FB, 0xB3DA, 0xC33D, 0xD31C, 0xE37F, 0xF35E, 0x02B1,
 169     0x1290, 0x22F3, 0x32D2, 0x4235, 0x5214, 0x6277, 0x7256, 0xB5EA, 0xA5CB,
 170     0x95A8, 0x8589, 0xF56E, 0xE54F, 0xD52C, 0xC50D, 0x34E2, 0x24C3, 0x14A0,
 171     0x0481, 0x7466, 0x6447, 0x5424, 0x4405, 0xA7DB, 0xB7FA, 0x8799, 0x97B8,
 172     0xE75F, 0xF77E, 0xC71D, 0xD73C, 0x26D3, 0x36F2, 0x0691, 0x16B0, 0x6657,
 173     0x7676, 0x4615, 0x5634, 0xD94C, 0xC96D, 0xF90E, 0xE92F, 0x99C8, 0x89E9,
 174     0xB98A, 0xA9AB, 0x5844, 0x4865, 0x7806, 0x6827, 0x18C0, 0x08E1, 0x3882,
 175     0x28A3, 0xCB7D, 0xDB5C, 0xEB3F, 0xFB1E, 0x8BF9, 0x9BD8, 0xABBB, 0xBB9A,
 176     0x4A75, 0x5A54, 0x6A37, 0x7A16, 0x0AF1, 0x1AD0, 0x2AB3, 0x3A92, 0xFD2E,
 177     0xED0F, 0xDD6C, 0xCD4D, 0xBDAA, 0xAD8B, 0x9DE8, 0x8DC9, 0x7C26, 0x6C07,
 178     0x5C64, 0x4C45, 0x3CA2, 0x2C83, 0x1CE0, 0x0CC1, 0xEF1F, 0xFF3E, 0xCF5D,
 179     0xDF7C, 0xAF9B, 0xBFBA, 0x8FD9, 0x9FF8, 0x6E17, 0x7E36, 0x4E55, 0x5E74,
 180     0x2E93, 0x3EB2, 0x0ED1, 0x1EF0
 181 };
 182
 183 /* Non - Reflected */
 184 uint16_t util_crc16(uint16_t current, const char *k, size_t len) {
 185     register uint16_t h = current;
 186     for (; len; --len, ++k)
 187         h = util_crc16_table[(h>>8)^((unsigned char)*k)]^(h<<8);
 188     return h;
 189 }
 190 /* Reflective Variation (for reference) */
 191 #if 0
 192 uint16_t util_crc16(const char *k, int len, const short clamp) {
 193     register uint16_t h= (uint16_t)0xFFFFFFFF;
 194     for (; len; --len, ++k)
 195         h = util_crc16_table[(h^((unsigned char)*k))&0xFF]^(h>>8);
 196     return (~h)%clamp;
 197 }
 198 #endif
 199
 200 /*
 201  * modifier is the match to make and the transposition from it, while add is the upper-value that determines the
 202  * transposition from uppercase to lower case.
 203  */
 204 static GMQCC_INLINE size_t util_strtransform(const char *in, char *out, size_t outsz, const char *mod, int add) {
 205     size_t sz = 1;
 206     for (; *in && sz < outsz; ++in, ++out, ++sz) {
 207         *out = (*in == mod[0])
 208                     ? mod[1]
 209                     : (util_isalpha(*in) && ((add > 0) ? util_isupper(*in) : !util_isupper(*in)))
 210                         ? *in + add
 211                         : *in;
 212     }
 213     *out = 0;
 214     return sz-1;
 215 }
 216
 217 size_t util_strtocmd(const char *in, char *out, size_t outsz) {
 218     return util_strtransform(in, out, outsz, "-_", 'A'-'a');
 219 }
 220 size_t util_strtononcmd(const char *in, char *out, size_t outsz) {
 221     return util_strtransform(in, out, outsz, "_-", 'a'-'A');
 222 }
 223 size_t util_optimizationtostr(const char *in, char *out, size_t outsz) {
 224     return util_strtransform(in, out, outsz, "_ ", 'a'-'A');
 225 }
 226
 227 /*
 228  * Portable implementation of vasprintf/asprintf. Assumes vsnprintf
 229  * exists, otherwise compiler error.
 230  *
 231  * TODO: fix for MSVC ....
 232  */
 233 int util_vasprintf(char **dat, const char *fmt, va_list args) {
 234     int   ret;
 235     int   len;
 236     char *tmp = NULL;
 237
 238     /*
 239      * For visual studio _vsnprintf doesn't tell you the length of a
 240      * formatted string if it overflows. However there is a MSVC
 241      * intrinsic (which is documented wrong) called _vcsprintf which
 242      * will return the required amount to allocate.
 243      */
 244     #ifdef _MSC_VER
 245         if ((len = _vscprintf(fmt, args)) < 0) {
 246             *dat = NULL;
 247             return -1;
 248         }
 249
 250         tmp = (char*)mem_a(len + 1);
 251         if ((ret = _vsnprintf_s(tmp, len+1, len+1, fmt, args)) != len) {
 252             mem_d(tmp);
 253             *dat = NULL;
 254             return -1;
 255         }
 256         *dat = tmp;
 257         return len;
 258     #else
 259         /*
 260          * For everything else we have a decent conforming vsnprintf that
 261          * returns the number of bytes needed.  We give it a try though on
 262          * a short buffer, since efficiently speaking, it could be nice to
 263          * above a second vsnprintf call.
 264          */
 265         char    buf[128];
 266         va_list cpy;
 267         va_copy(cpy, args);
 268         len = vsnprintf(buf, sizeof(buf), fmt, cpy);
 269         va_end (cpy);
 270
 271         if (len < (int)sizeof(buf)) {
 272             *dat = util_strdup(buf);
 273             return len;
 274         }
 275
 276         /* not large enough ... */
 277         tmp = (char*)mem_a(len + 1);
 278         if ((ret = vsnprintf(tmp, len + 1, fmt, args)) != len) {
 279             mem_d(tmp);
 280             *dat = NULL;
 281             return -1;
 282         }
 283
 284         *dat = tmp;
 285         return len;
 286     #endif
 287 }
 288 int util_asprintf(char **ret, const char *fmt, ...) {
 289     va_list  args;
 290     int      read;
 291     va_start(args, fmt);
 292     read = util_vasprintf(ret, fmt, args);
 293     va_end  (args);
 294
 295     return read;
 296 }
 297
 298 /*
 299  * These are various re-implementations (wrapping the real ones) of
 300  * string functions that MSVC considers unsafe. We wrap these up and
 301  * use the safe variations on MSVC.
 302  */
 303 #ifdef _MSC_VER
 304     static char **util_strerror_allocated() {
 305         static char **data = NULL;
 306         return data;
 307     }
 308
 309     static void util_strerror_cleanup(void) {
 310         size_t i;
 311         char  **data = util_strerror_allocated();
 312         for (i = 0; i < vec_size(data); i++)
 313             mem_d(data[i]);
 314         vec_free(data);
 315     }
 316
 317     const char *util_strerror(int num) {
 318         char         *allocated = NULL;
 319         static bool   install   = false;
 320         static size_t tries     = 0;
 321         char        **vector    = util_strerror_allocated();
 322
 323         /* try installing cleanup handler */
 324         while (!install) {
 325             if (tries == 32)
 326                 return "(unknown)";
 327
 328             install = !atexit(&util_strerror_cleanup);
 329             tries ++;
 330         }
 331
 332         allocated = (char*)mem_a(4096); /* A page must be enough */
 333         strerror_s(allocated, 4096, num);
 334
 335         vec_push(vector, allocated);
 336         return (const char *)allocated;
 337     }
 338
 339     int util_snprintf(char *src, size_t bytes, const char *format, ...) {
 340         int      rt;
 341         va_list  va;
 342         va_start(va, format);
 343
 344         rt = vsprintf_s(src, bytes, format, va);
 345         va_end  (va);
 346
 347         return rt;
 348     }
 349
 350     char *util_strcat(char *dest, const char *src) {
 351         strcat_s(dest, strlen(src), src);
 352         return dest;
 353     }
 354
 355     char *util_strncpy(char *dest, const char *src, size_t num) {
 356         strncpy_s(dest, num, src, num);
 357         return dest;
 358     }
 359 #else
 360     const char *util_strerror(int num) {
 361         return strerror(num);
 362     }
 363
 364     int util_snprintf(char *src, size_t bytes, const char *format, ...) {
 365         int      rt;
 366         va_list  va;
 367         va_start(va, format);
 368         rt = vsnprintf(src, bytes, format, va);
 369         va_end  (va);
 370
 371         return rt;
 372     }
 373
 374     char *util_strcat(char *dest, const char *src) {
 375         return strcat(dest, src);
 376     }
 377
 378     char *util_strncpy(char *dest, const char *src, size_t num) {
 379         return strncpy(dest, src, num);
 380     }
 381
 382 #endif /*! _MSC_VER */
 383
 384
 385 void util_seed(uint32_t value) {
 386     srand((int)value);
 387 }
 388 uint32_t util_rand() {
 389     return rand();
 390 }