Kernel/lib.c

   1 /*
   2  * Acess2
   3  * Common Library Functions
   4  */
   5 #include <acess.h>
   6 #include <hal_proc.h>
   7
   8 // === CONSTANTS ===
   9 #define RANDOM_SEED     0xACE55052
  10 #define RANDOM_A        0x00731ADE
  11 #define RANDOM_C        12345
  12 #define RANDOM_SPRUCE   0xf12b039
  13 //                          Jan Feb Mar Apr May  Jun  Jul  Aug  Sept Oct  Nov  Dec
  14 const short DAYS_BEFORE[] = {0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334};
  15 #define UNIX_TO_2K      ((30*365*3600*24) + (7*3600*24))        //Normal years + leap years
  16
  17 // === PROTOTYPES ===
  18 #if 0
  19  int    atoi(const char *string);
  20 void    itoa(char *buf, Uint64 num, int base, int minLength, char pad);
  21  int    vsnprintf(char *__s, size_t __maxlen, const char *__format, va_list args);
  22  int    sprintf(char *__s, const char *__format, ...);
  23 #endif
  24  int    tolower(int c);
  25 #if 0
  26  int    strucmp(const char *Str1, const char *Str2);
  27 char    *strchr(const char *__s, int __c);
  28  int    strpos(const char *Str, char Ch);
  29  Uint8  ByteSum(void *Ptr, int Size);
  30 size_t  strlen(const char *__s);
  31 char    *strcpy(char *__str1, const char *__str2);
  32 char    *strncpy(char *__str1, const char *__str2, size_t max);
  33  int    strcmp(const char *str1, const char *str2);
  34  int    strncmp(const char *str1, const char *str2, size_t num);
  35 char    *_strdup(const char *File, int Line, const char *Str);
  36 char    **str_split(const char *__str, char __ch);
  37  int    strpos8(const char *str, Uint32 Search);
  38  int    ReadUTF8(Uint8 *str, Uint32 *Val);
  39  int    WriteUTF8(Uint8 *str, Uint32 Val);
  40  int    DivUp(int num, int dem);
  41 Sint64  timestamp(int sec, int mins, int hrs, int day, int month, int year);
  42 #endif
  43 void    format_date(tTime TS, int *year, int *month, int *day, int *hrs, int *mins, int *sec, int *ms);
  44 #if 0
  45  int    rand(void);
  46
  47  int    CheckString(char *String);
  48  int    CheckMem(void *Mem, int NumBytes);
  49
  50  int    ModUtil_LookupString(char **Array, char *Needle);
  51  int    ModUtil_SetIdent(char *Dest, char *Value);
  52
  53  int    Hex(char *Dest, size_t Size, const Uint8 *SourceData);
  54  int    UnHex(Uint8 *Dest, size_t DestSize, const char *SourceString);
  55 #endif
  56
  57 // === EXPORTS ===
  58 EXPORT(atoi);
  59 EXPORT(itoa);
  60 EXPORT(vsnprintf);
  61 EXPORT(sprintf);
  62 EXPORT(tolower);
  63 EXPORT(strucmp);
  64 EXPORT(strchr);
  65 EXPORT(strpos);
  66 EXPORT(ByteSum);
  67 EXPORT(strlen);
  68 EXPORT(strcpy);
  69 EXPORT(strncpy);
  70 EXPORT(strcat);
  71 EXPORT(strncat);
  72 EXPORT(strcmp);
  73 EXPORT(strncmp);
  74 //EXPORT(strdup);
  75 EXPORT(_strdup);        // Takes File/Line too
  76 EXPORT(str_split);
  77 EXPORT(strpos8);
  78 EXPORT(DivUp);
  79 EXPORT(ReadUTF8);
  80 EXPORT(WriteUTF8);
  81 EXPORT(timestamp);
  82 EXPORT(CheckString);
  83 EXPORT(CheckMem);
  84 EXPORT(ModUtil_LookupString);
  85 EXPORT(ModUtil_SetIdent);
  86 EXPORT(UnHex);
  87 EXPORT(SwapEndian16);
  88 EXPORT(SwapEndian32);
  89 EXPORT(memmove);
  90
  91 // === CODE ===
  92 /**
  93  * \brief Convert a string into an integer
  94  */
  95 int atoi(const char *string)
  96 {
  97         int ret = 0;
  98         ParseInt(string, &ret);
  99         return ret;
 100 }
 101 int ParseInt(const char *string, int *Val)
 102 {
 103          int    ret = 0;
 104          int    bNeg = 0;
 105         const char *orig_string = string;
 106
 107         //Log("atoi: (string='%s')", string);
 108
 109         // Clear non-numeric characters
 110         while( !('0' <= *string && *string <= '9') && *string != '-' )  string++;
 111         if( *string == '-' ) {
 112                 bNeg = 1;
 113                 while( !('0' <= *string && *string <= '9') )    string++;
 114         }
 115
 116         if(*string == '0')
 117         {
 118                 string ++;
 119                 if(*string == 'x')
 120                 {
 121                         // Hex
 122                         string ++;
 123                         for( ;; string ++ )
 124                         {
 125                                 if('0' <= *string && *string <= '9') {
 126                                         ret *= 16;
 127                                         ret += *string - '0';
 128                                 }
 129                                 else if('A' <= *string && *string <= 'F') {
 130                                         ret *= 16;
 131                                         ret += *string - 'A' + 10;
 132                                 }
 133                                 else if('a' <= *string && *string <= 'f') {
 134                                         ret *= 16;
 135                                         ret += *string - 'a' + 10;
 136                                 }
 137                                 else
 138                                         break;
 139                         }
 140                 }
 141                 else    // Octal
 142                 {
 143                         for( ; '0' <= *string && *string <= '7'; string ++ )
 144                         {
 145                                 ret *= 8;
 146                                 ret += *string - '0';
 147                         }
 148                 }
 149         }
 150         else    // Decimal
 151         {
 152                 for( ; '0' <= *string && *string <= '9'; string++)
 153                 {
 154                         ret *= 10;
 155                         ret += *string - '0';
 156                 }
 157                 // Error check
 158                 if( ret == 0 )  return 0;
 159         }
 160
 161         if(bNeg)        ret = -ret;
 162
 163         //Log("atoi: RETURN %i", ret);
 164
 165         if(Val) *Val = ret;
 166
 167         return string - orig_string;
 168 }
 169
 170 static const char cUCDIGITS[] = "0123456789ABCDEF";
 171 /**
 172  * \fn void itoa(char *buf, Uint64 num, int base, int minLength, char pad)
 173  * \brief Convert an integer into a character string
 174  */
 175 void itoa(char *buf, Uint64 num, int base, int minLength, char pad)
 176 {
 177         char    tmpBuf[64+1];
 178          int    pos=0, i;
 179         Uint64  rem;
 180
 181         // Sanity check
 182         if(!buf)        return;
 183
 184         // Sanity Check
 185         if(base > 16 || base < 2) {
 186                 buf[0] = 0;
 187                 return;
 188         }
 189
 190         // Convert
 191         while(num > base-1) {
 192                 num = DivMod64U(num, base, &rem);       // Shift `num` and get remainder
 193                 tmpBuf[pos] = cUCDIGITS[ rem ];
 194                 pos++;
 195         }
 196         tmpBuf[pos++] = cUCDIGITS[ num ];               // Last digit of `num`
 197
 198         // Put in reverse
 199         i = 0;
 200         minLength -= pos;
 201         while(minLength-- > 0)  buf[i++] = pad;
 202         while(pos-- > 0)                buf[i++] = tmpBuf[pos]; // Reverse the order of characters
 203         buf[i] = 0;
 204 }
 205
 206 /**
 207  * \brief Append a character the the vsnprintf output
 208  */
 209 #define PUTCH(c)        _putch(c)
 210 #define GETVAL()        do {\
 211         if(isLongLong)  val = va_arg(args, Uint64);\
 212         else    val = va_arg(args, unsigned int);\
 213         }while(0)
 214 /**
 215  * \brief VArg String Number Print Formatted
 216  */
 217 int vsnprintf(char *__s, size_t __maxlen, const char *__format, va_list args)
 218 {
 219         char    c, pad = ' ';
 220          int    minSize = 0, precision = -1, len;
 221         char    tmpBuf[34];     // For Integers
 222         const char      *p = NULL;
 223          int    isLongLong = 0;
 224         Uint64  val;
 225         size_t  pos = 0;
 226         // Flags
 227          int    bPadLeft = 0;
 228
 229         auto void _putch(char ch);
 230
 231         void _putch(char ch)
 232         {
 233                 if(pos < __maxlen)
 234                 {
 235                         if(__s) __s[pos] = ch;
 236                         pos ++;
 237                 }
 238         }
 239
 240         while((c = *__format++) != 0)
 241         {
 242                 // Non control character
 243                 if(c != '%') { PUTCH(c); continue; }
 244
 245                 c = *__format++;
 246                 if(c == '\0')   break;
 247
 248                 // Literal %
 249                 if(c == '%') { PUTCH('%'); continue; }
 250
 251                 // Pointer - Done first for debugging
 252                 if(c == 'p') {
 253                         Uint    ptr = va_arg(args, Uint);
 254                         PUTCH('*');     PUTCH('0');     PUTCH('x');
 255                         for( len = BITS/4; len --; )
 256                                 PUTCH( cUCDIGITS[ (ptr>>(len*4))&15 ] );
 257                         continue ;
 258                 }
 259
 260                 // - Padding Side Flag
 261                 if(c == '-') {
 262                         bPadLeft = 1;
 263                         c = *__format++;
 264                 }
 265
 266                 // - Padding
 267                 if(c == '0') {
 268                         pad = '0';
 269                         c = *__format++;
 270                 }
 271                 else
 272                         pad = ' ';
 273
 274                 // - Minimum length
 275                 if(c == '*') {  // Dynamic length
 276                         minSize = va_arg(args, unsigned int);
 277                         c = *__format++;
 278                 }
 279                 else if('1' <= c && c <= '9')
 280                 {
 281                         minSize = 0;
 282                         while('0' <= c && c <= '9')
 283                         {
 284                                 minSize *= 10;
 285                                 minSize += c - '0';
 286                                 c = *__format++;
 287                         }
 288                 }
 289                 else
 290                         minSize = 0;
 291
 292                 // - Precision
 293                 precision = -1;
 294                 if( c == '.' ) {
 295                         c = *__format++;
 296
 297                         if(c == '*') {  // Dynamic length
 298                                 precision = va_arg(args, unsigned int);
 299                                 c = *__format++;
 300                         }
 301                         else if('1' <= c && c <= '9')
 302                         {
 303                                 precision = 0;
 304                                 while('0' <= c && c <= '9')
 305                                 {
 306                                         precision *= 10;
 307                                         precision += c - '0';
 308                                         c = *__format++;
 309                                 }
 310                         }
 311                 }
 312
 313                 // - Default, Long or LongLong?
 314                 isLongLong = 0;
 315                 if(c == 'l')    // Long is actually the default on x86
 316                 {
 317                         c = *__format++;
 318                         if(c == 'l') {
 319                                 c = *__format++;
 320                                 isLongLong = 1;
 321                         }
 322                 }
 323
 324                 // - Now get the format code
 325                 p = tmpBuf;
 326                 switch(c)
 327                 {
 328                 case 'd':
 329                 case 'i':
 330                         GETVAL();
 331                         if( isLongLong && val >> 63 ) {
 332                                 PUTCH('-');
 333                                 val = -val;
 334                         }
 335                         else if( !isLongLong && val >> 31 ) {
 336                                 PUTCH('-');
 337                                 val = -(Sint32)val;
 338                         }
 339                         itoa(tmpBuf, val, 10, minSize, pad);
 340                         goto printString;
 341                 case 'u':       // Unsigned
 342                         GETVAL();
 343                         itoa(tmpBuf, val, 10, minSize, pad);
 344                         goto printString;
 345                 case 'P':       // Physical Address
 346                         PUTCH('0');
 347                         PUTCH('x');
 348                         if(sizeof(tPAddr) > 4)  isLongLong = 1;
 349                         GETVAL();
 350                         itoa(tmpBuf, val, 16, minSize, pad);
 351                         goto printString;
 352                 case 'X':       // Hex
 353                         if(BITS == 64)
 354                                 isLongLong = 1; // TODO: Handle non-x86 64-bit archs
 355                         GETVAL();
 356                         itoa(tmpBuf, val, 16, minSize, pad);
 357                         goto printString;
 358
 359                 case 'x':       // Lower case hex
 360                         GETVAL();
 361                         itoa(tmpBuf, val, 16, minSize, pad);
 362                         goto printString;
 363                 case 'o':       // Octal
 364                         GETVAL();
 365                         itoa(tmpBuf, val, 8, minSize, pad);
 366                         goto printString;
 367                 case 'b':
 368                         GETVAL();
 369                         itoa(tmpBuf, val, 2, minSize, pad);
 370                         goto printString;
 371
 372                 case 'B':       //Boolean
 373                         val = va_arg(args, unsigned int);
 374                         if(val) p = "True";
 375                         else    p = "False";
 376                         goto printString;
 377
 378                 // String - Null Terminated Array
 379                 case 's':
 380                         p = va_arg(args, char*);        // Get Argument
 381                         if( !p || !CheckString(p) )     p = "(inval)";  // Avoid #PFs
 382                 printString:
 383                         if(!p)          p = "(null)";
 384                         len = strlen(p);
 385                         if( !bPadLeft ) while(len++ < minSize)  PUTCH(pad);
 386                         while(*p && precision--)        PUTCH(*p++);
 387                         if( bPadLeft )  while(len++ < minSize)  PUTCH(pad);
 388                         break;
 389
 390                 case 'C':       // Non-Null Terminated Character Array
 391                         p = va_arg(args, char*);
 392                         if( !CheckMem(p, minSize) )     continue;       // No #PFs please
 393                         if(!p)  goto printString;
 394                         while(minSize--)        PUTCH(*p++);
 395                         break;
 396
 397                 // Single Character
 398                 case 'c':
 399                 default:
 400                         GETVAL();
 401                         PUTCH( (Uint8)val );
 402                         break;
 403                 }
 404         }
 405
 406         if(__s && pos != __maxlen)
 407                 __s[pos] = '\0';
 408
 409         return pos;
 410 }
 411 #undef PUTCH
 412
 413 /**
 414  */
 415 int sprintf(char *__s, const char *__format, ...)
 416 {
 417         va_list args;
 418          int    ret;
 419
 420         va_start(args, __format);
 421         ret = vsnprintf(__s, -1, __format, args);
 422         va_end(args);
 423
 424         return ret;
 425 }
 426
 427 /**
 428  * \fn int tolower(int c)
 429  * \brief Converts a character to lower case
 430  */
 431 int tolower(int c)
 432 {
 433         if('A' <= c && c <= 'Z')
 434                 return c - 'A' + 'a';
 435         return c;
 436 }
 437
 438 /**
 439  * \fn int strucmp(const char *Str1, const char *Str2)
 440  * \brief Compare \a Str1 and \a Str2 case-insensitively
 441  */
 442 int strucmp(const char *Str1, const char *Str2)
 443 {
 444         while(*Str1 && tolower(*Str1) == tolower(*Str2))
 445                 Str1++, Str2++;
 446         return tolower(*Str1) - tolower(*Str2);
 447 }
 448
 449 /**
 450  * \brief Locate a byte in a string
 451  */
 452 char *strchr(const char *__s, int __c)
 453 {
 454         for( ; *__s; __s ++ )
 455         {
 456                 if( *__s == __c )       return (char*)__s;
 457         }
 458         return NULL;
 459 }
 460
 461 /**
 462  * \fn int strpos(const char *Str, char Ch)
 463  * \brief Search a string for an ascii character
 464  */
 465 int strpos(const char *Str, char Ch)
 466 {
 467          int    pos;
 468         for(pos=0;Str[pos];pos++)
 469         {
 470                 if(Str[pos] == Ch)      return pos;
 471         }
 472         return -1;
 473 }
 474
 475 /**
 476  * \fn Uint8 ByteSum(void *Ptr, int Size)
 477  * \brief Adds the bytes in a memory region and returns the sum
 478  */
 479 Uint8 ByteSum(const void *Ptr, int Size)
 480 {
 481         Uint8   sum = 0;
 482         const Uint8     *data = Ptr;
 483         while(Size--)   sum += *(data++);
 484         return sum;
 485 }
 486
 487 /**
 488  * \fn size_t strlen(const char *__str)
 489  * \brief Get the length of string
 490  */
 491 size_t strlen(const char *__str)
 492 {
 493         size_t  ret = 0;
 494         while(*__str++) ret++;
 495         return ret;
 496 }
 497
 498 /**
 499  * \brief Copy a string to a new location
 500  */
 501 char *strcpy(char *__str1, const char *__str2)
 502 {
 503         while(*__str2)
 504                 *__str1++ = *__str2++;
 505         *__str1 = '\0'; // Terminate String
 506         return __str1;
 507 }
 508
 509 /**
 510  * \brief Copy a string to a new location
 511  * \note Copies at most `max` chars
 512  */
 513 char *strncpy(char *__str1, const char *__str2, size_t __max)
 514 {
 515         while(*__str2 && __max-- >= 1)
 516                 *__str1++ = *__str2++;
 517         if(__max)
 518                 *__str1 = '\0'; // Terminate String
 519         return __str1;
 520 }
 521
 522 /**
 523  * \brief Append a string to another
 524  */
 525 char *strcat(char *__dest, const char *__src)
 526 {
 527         while(*__dest++);
 528         __dest--;
 529         while(*__src)
 530                 *__dest++ = *__src++;
 531         *__dest = '\0';
 532         return __dest;
 533 }
 534
 535 /**
 536  * \brief Append at most \a n chars to a string from another
 537  * \note At most n+1 chars are written (the dest is always zero terminated)
 538  */
 539 char *strncat(char *__dest, const char *__src, size_t n)
 540 {
 541         while(*__dest++);
 542         while(*__src && n-- >= 1)
 543                 *__dest++ = *__src++;
 544         *__dest = '\0';
 545         return __dest;
 546 }
 547
 548 /**
 549  * \fn int strcmp(const char *str1, const char *str2)
 550  * \brief Compare two strings return the difference between
 551  *        the first non-matching characters.
 552  */
 553 int strcmp(const char *str1, const char *str2)
 554 {
 555         while(*str1 && *str1 == *str2)
 556                 str1++, str2++;
 557         return *str1 - *str2;
 558 }
 559
 560 /**
 561  * \fn int strncmp(const char *Str1, const char *Str2, size_t num)
 562  * \brief Compare strings \a Str1 and \a Str2 to a maximum of \a num characters
 563  */
 564 int strncmp(const char *Str1, const char *Str2, size_t num)
 565 {
 566         if(num == 0)    return 0;       // TODO: Check what should officially happen here
 567         while(--num && *Str1 && *Str1 == *Str2)
 568                 Str1++, Str2++;
 569         return *Str1-*Str2;
 570 }
 571
 572 #if 0
 573 /**
 574  * \fn char *strdup(const char *Str)
 575  * \brief Duplicates a string
 576  */
 577 char *strdup(const char *Str)
 578 {
 579         char    *ret;
 580         ret = malloc(strlen(Str)+1);
 581         if( !ret )      return NULL;
 582         strcpy(ret, Str);
 583         return ret;
 584 }
 585 #else
 586
 587 /**
 588  * \fn char *_strdup(const char *File, int Line, const char *Str)
 589  * \brief Duplicates a string
 590  */
 591 char *_strdup(const char *File, int Line, const char *Str)
 592 {
 593         char    *ret;
 594         ret = Heap_Allocate(File, Line, strlen(Str)+1);
 595         if( !ret )      return NULL;
 596         strcpy(ret, Str);
 597         return ret;
 598 }
 599 #endif
 600
 601 /**
 602  * \brief Split a string using the passed character
 603  * \return NULL terminated array of strings on the heap
 604  * \param __str String to split
 605  * \param __ch  Character to split by
 606  */
 607 char **str_split(const char *__str, char __ch)
 608 {
 609          int    i, j;
 610          int    len = 1;
 611         char    **ret;
 612         char    *start;
 613
 614         for( i = 0; __str[i]; i++ )
 615         {
 616                 if(__str[i] == __ch)
 617                         len ++;
 618         }
 619
 620         ret = malloc( sizeof(char*)*(len+1) + (i + 1) );
 621         if( !ret )      return NULL;
 622
 623         j = 1;
 624         start = (char *)&ret[len+1];
 625         ret[0] = start;
 626         for( i = 0; __str[i]; i++ )
 627         {
 628                 if(__str[i] == __ch) {
 629                         *start++ = '\0';
 630                         ret[j++] = start;
 631                 }
 632                 else {
 633                         *start++ = __str[i];
 634                 }
 635         }
 636         *start = '\0';
 637         ret[j] = NULL;
 638
 639         return ret;
 640 }
 641
 642 /**
 643  * \fn int DivUp(int num, int dem)
 644  * \brief Divide two numbers, rounding up
 645  * \param num   Numerator
 646  * \param dem   Denominator
 647  */
 648 int DivUp(int num, int dem)
 649 {
 650         return (num+dem-1)/dem;
 651 }
 652
 653 /**
 654  * \fn int strpos8(const char *str, Uint32 search)
 655  * \brief Search a string for a UTF-8 character
 656  */
 657 int strpos8(const char *str, Uint32 Search)
 658 {
 659          int    pos;
 660         Uint32  val = 0;
 661         for(pos=0;str[pos];pos++)
 662         {
 663                 // ASCII Range
 664                 if(Search < 128) {
 665                         if(str[pos] == Search)  return pos;
 666                         continue;
 667                 }
 668                 if(*(Uint8*)(str+pos) < 128)    continue;
 669
 670                 pos += ReadUTF8( (Uint8*)&str[pos], &val );
 671                 if(val == Search)       return pos;
 672         }
 673         return -1;
 674 }
 675
 676 /**
 677  * \fn int ReadUTF8(Uint8 *str, Uint32 *Val)
 678  * \brief Read a UTF-8 character from a string
 679  */
 680 int ReadUTF8(const Uint8 *str, Uint32 *Val)
 681 {
 682         *Val = 0xFFFD;  // Assume invalid character
 683
 684         // ASCII
 685         if( !(*str & 0x80) ) {
 686                 *Val = *str;
 687                 return 1;
 688         }
 689
 690         // Middle of a sequence
 691         if( (*str & 0xC0) == 0x80 ) {
 692                 return 1;
 693         }
 694
 695         // Two Byte
 696         if( (*str & 0xE0) == 0xC0 ) {
 697                 *Val = (*str & 0x1F) << 6;      // Upper 6 Bits
 698                 str ++;
 699                 if( (*str & 0xC0) != 0x80)      return -1;      // Validity check
 700                 *Val |= (*str & 0x3F);  // Lower 6 Bits
 701                 return 2;
 702         }
 703
 704         // Three Byte
 705         if( (*str & 0xF0) == 0xE0 ) {
 706                 *Val = (*str & 0x0F) << 12;     // Upper 4 Bits
 707                 str ++;
 708                 if( (*str & 0xC0) != 0x80)      return -1;      // Validity check
 709                 *Val |= (*str & 0x3F) << 6;     // Middle 6 Bits
 710                 str ++;
 711                 if( (*str & 0xC0) != 0x80)      return -1;      // Validity check
 712                 *Val |= (*str & 0x3F);  // Lower 6 Bits
 713                 return 3;
 714         }
 715
 716         // Four Byte
 717         if( (*str & 0xF1) == 0xF0 ) {
 718                 *Val = (*str & 0x07) << 18;     // Upper 3 Bits
 719                 str ++;
 720                 if( (*str & 0xC0) != 0x80)      return -1;      // Validity check
 721                 *Val |= (*str & 0x3F) << 12;    // Middle-upper 6 Bits
 722                 str ++;
 723                 if( (*str & 0xC0) != 0x80)      return -1;      // Validity check
 724                 *Val |= (*str & 0x3F) << 6;     // Middle-lower 6 Bits
 725                 str ++;
 726                 if( (*str & 0xC0) != 0x80)      return -1;      // Validity check
 727                 *Val |= (*str & 0x3F);  // Lower 6 Bits
 728                 return 4;
 729         }
 730
 731         // UTF-8 Doesn't support more than four bytes
 732         return 4;
 733 }
 734
 735 /**
 736  * \fn int WriteUTF8(Uint8 *str, Uint32 Val)
 737  * \brief Write a UTF-8 character sequence to a string
 738  */
 739 int WriteUTF8(Uint8 *str, Uint32 Val)
 740 {
 741         // ASCII
 742         if( Val < 128 ) {
 743                 if( str ) {
 744                         *str = Val;
 745                 }
 746                 return 1;
 747         }
 748
 749         // Two Byte
 750         if( Val < 0x8000 ) {
 751                 if( str ) {
 752                         *str++ = 0xC0 | (Val >> 6);
 753                         *str++ = 0x80 | (Val & 0x3F);
 754                 }
 755                 return 2;
 756         }
 757
 758         // Three Byte
 759         if( Val < 0x10000 ) {
 760                 if( str ) {
 761                         *str++ = 0xE0 | (Val >> 12);
 762                         *str++ = 0x80 | ((Val >> 6) & 0x3F);
 763                         *str++ = 0x80 | (Val & 0x3F);
 764                 }
 765                 return 3;
 766         }
 767
 768         // Four Byte
 769         if( Val < 0x110000 ) {
 770                 if( str ) {
 771                         *str++ = 0xF0 | (Val >> 18);
 772                         *str++ = 0x80 | ((Val >> 12) & 0x3F);
 773                         *str++ = 0x80 | ((Val >> 6) & 0x3F);
 774                         *str++ = 0x80 | (Val & 0x3F);
 775                 }
 776                 return 4;
 777         }
 778
 779         // UTF-8 Doesn't support more than four bytes
 780         return 0;
 781 }
 782
 783 /**
 784  * \fn Uint64 timestamp(int sec, int mins, int hrs, int day, int month, int year)
 785  * \brief Converts a date into an Acess Timestamp
 786  */
 787 Sint64 timestamp(int sec, int min, int hrs, int day, int month, int year)
 788 {
 789          int    is_leap;
 790         Sint64  stamp;
 791
 792         if( !(0 <= sec && sec < 60) )   return 0;
 793         if( !(0 <= min && min < 60) )   return 0;
 794         if( !(0 <= hrs && hrs < 24) )   return 0;
 795         if( !(0 <= day && day < 31) )   return 0;
 796         if( !(0 <= month && month < 12) )       return 0;
 797
 798         stamp = DAYS_BEFORE[month] + day;
 799
 800         // Every 4 years
 801         // - every 100 years
 802         // + every 400 years
 803         is_leap = (year % 4 == 0) - (year % 100 == 0) + (year % 400 == 0);
 804         ASSERT(is_leap == 0 || is_leap == 1);
 805
 806         if( is_leap && month > 1 )      // Leap year and after feb
 807                 stamp += 1;
 808
 809         // Get seconds before the first of specified year
 810         year -= 2000;   // Base off Y2K
 811         // base year days + total leap year days
 812         stamp += year*365 + (year/400) - (year/100) + (year/4);
 813
 814         stamp *= 3600*24;
 815         stamp += UNIX_TO_2K;
 816         stamp += sec;
 817         stamp += min*60;
 818         stamp += hrs*3600;
 819
 820         return stamp * 1000;
 821 }
 822
 823 void format_date(tTime TS, int *year, int *month, int *day, int *hrs, int *mins, int *sec, int *ms)
 824 {
 825          int    is_leap = 0, i;
 826
 827         auto Sint64 DivMod64(Sint64 N, Sint64 D, Sint64 *R);
 828
 829         Sint64 DivMod64(Sint64 N, Sint64 D, Sint64 *R)
 830         {
 831                 int sign = (N < 0) != (D < 0);
 832                 if(N < 0)       N = -N;
 833                 if(D < 0)       D = -D;
 834                 if(sign)
 835                         return -DivMod64U(N, D, (Uint64*)R);
 836                 else
 837                         return DivMod64U(N, D, (Uint64*)R);
 838         }
 839
 840         // Get time
 841         // TODO: Leap-seconds?
 842         {
 843                 Sint64  rem;
 844                 TS = DivMod64( TS, 1000, &rem );
 845                 *ms = rem;
 846                 TS = DivMod64( TS, 60, &rem );
 847                 *sec = rem;
 848                 TS = DivMod64( TS, 60, &rem );
 849                 *mins = rem;
 850                 TS = DivMod64( TS, 24, &rem );
 851                 *hrs = rem;
 852         }
 853
 854         // Adjust to Y2K
 855         TS -= UNIX_TO_2K/(3600*24);
 856
 857         // Year (400 yr blocks) - (400/4-3) leap years
 858         *year = 400 * DivMod64( TS, 365*400 + (400/4-3), &TS );
 859         if( TS < 366 )  // First year in 400 is a leap
 860                 is_leap = 1;
 861         else
 862         {
 863                 // 100 yr blocks - 100/4-1 leap years
 864                 *year += 100 * DivMod64( TS, 365*100 + (100/4-1), &TS );
 865                 if( TS < 366 )  // First year in 100 isn't a leap
 866                         is_leap = 0;
 867                 else
 868                 {
 869                         *year += 4 * DivMod64( TS, 365*4 + 1, &TS );
 870                         if( TS < 366 )  // First year in 4 is a leap
 871                                 is_leap = 1;
 872                         else
 873                         {
 874                                 *year += DivMod64( TS, 356, &TS );
 875                         }
 876                 }
 877         }
 878         *year += 2000;
 879
 880         ASSERT(TS >= 0);
 881
 882         *day = 0;
 883         // Month (if after the first of march, which is 29 Feb in a leap year)
 884         if( is_leap && TS > DAYS_BEFORE[2] ) {
 885                 TS -= 1;        // Shifts 29 Feb to 28 Feb
 886                 *day = 1;
 887         }
 888         // Get what month it is
 889         for( i = 0; i < 12; i ++ ) {
 890                 if( TS < DAYS_BEFORE[i] )
 891                         break;
 892         }
 893         *month = i - 1;
 894         // Get day
 895         TS -= DAYS_BEFORE[i-1];
 896         *day += TS;     // Plus offset from leap handling above
 897 }
 898
 899 /**
 900  * \fn int rand()
 901  * \brief Pseudo random number generator
 902  */
 903 int rand(void)
 904 {
 905         #if 0
 906         static Uint     state = RANDOM_SEED;
 907         Uint    old = state;
 908         // Get the next state value
 909         giRandomState = (RANDOM_A*state + RANDOM_C);
 910         // Check if it has changed, and if it hasn't, change it
 911         if(state == old)        state += RANDOM_SPRUCE;
 912         return state;
 913         #else
 914         // http://en.wikipedia.org/wiki/Xorshift
 915         // 2010-10-03
 916         static Uint32   x = 123456789;
 917         static Uint32   y = 362436069;
 918         static Uint32   z = 521288629;
 919         static Uint32   w = 88675123;
 920         Uint32  t;
 921
 922         t = x ^ (x << 11);
 923         x = y; y = z; z = w;
 924         return w = w ^ (w >> 19) ^ t ^ (t >> 8);
 925         #endif
 926 }
 927
 928 /* *
 929  * \name Memory Validation
 930  * \{
 931  */
 932 /**
 933  * \brief Checks if a string resides fully in valid memory
 934  */
 935 int CheckString(const char *String)
 936 {
 937         tVAddr  addr;
 938          int    bUser;
 939
 940         addr = (tVAddr)String;
 941
 942         if( !MM_GetPhysAddr( addr ) )
 943                 return 0;
 944
 945         // Check 1st page
 946         bUser = MM_IsUser( addr );
 947
 948         while( *(char*)addr )
 949         {
 950                 if( (addr & (PAGE_SIZE-1)) == 0 )
 951                 {
 952                         if(bUser && !MM_IsUser(addr) )
 953                                 return 0;
 954                         if(!bUser && !MM_GetPhysAddr(addr) )
 955                                 return 0;
 956                 }
 957                 addr ++;
 958         }
 959         return 1;
 960 }
 961
 962 /**
 963  * \brief Check if a sized memory region is valid memory
 964  * \return Boolean success
 965  */
 966 int CheckMem(const void *Mem, int NumBytes)
 967 {
 968         return MM_IsValidBuffer( (tVAddr)Mem, NumBytes );
 969 }
 970 /* *
 971  * \}
 972  */
 973
 974 /**
 975  * \brief Search a string array for \a Needle
 976  * \note Helper function for eTplDrv_IOCtl::DRV_IOCTL_LOOKUP
 977  */
 978 int ModUtil_LookupString(const char **Array, const char *Needle)
 979 {
 980          int    i;
 981         if( !CheckString(Needle) )      return -1;
 982         for( i = 0; Array[i]; i++ )
 983         {
 984                 if(strcmp(Array[i], Needle) == 0)       return i;
 985         }
 986         return -1;
 987 }
 988
 989 int ModUtil_SetIdent(char *Dest, const char *Value)
 990 {
 991         if( !CheckMem(Dest, 32) )       return -1;
 992         strncpy(Dest, Value, 32);
 993         return 1;
 994 }
 995
 996 int Hex(char *Dest, size_t Size, const Uint8 *SourceData)
 997 {
 998          int    i;
 999         for( i = 0; i < Size; i ++ )
1000         {
1001                 sprintf(Dest + i*2, "%02x", SourceData[i]);
1002         }
1003         return i*2;
1004 }
1005
1006 /**
1007  * \brief Convert a string of hexadecimal digits into a byte stream
1008  */
1009 int UnHex(Uint8 *Dest, size_t DestSize, const char *SourceString)
1010 {
1011          int    i;
1012
1013         for( i = 0; i < DestSize*2; i += 2 )
1014         {
1015                 Uint8   val = 0;
1016
1017                 if(SourceString[i] == '\0')     break;
1018
1019                 if('0' <= SourceString[i] && SourceString[i] <= '9')
1020                         val |= (SourceString[i]-'0') << 4;
1021                 else if('A' <= SourceString[i] && SourceString[i] <= 'F')
1022                         val |= (SourceString[i]-'A'+10) << 4;
1023                 else if('a' <= SourceString[i] && SourceString[i] <= 'f')
1024                         val |= (SourceString[i]-'a'+10) << 4;
1025
1026                 if(SourceString[i+1] == '\0')   break;
1027
1028                 if('0' <= SourceString[i+1] && SourceString[i+1] <= '9')
1029                         val |= (SourceString[i+1] - '0');
1030                 else if('A' <= SourceString[i+1] && SourceString[i+1] <= 'F')
1031                         val |= (SourceString[i+1] - 'A' + 10);
1032                 else if('a' <= SourceString[i+1] && SourceString[i+1] <= 'f')
1033                         val |= (SourceString[i+1] - 'a' + 10);
1034
1035                 Dest[i/2] = val;
1036         }
1037         return i/2;
1038 }
1039
1040 Uint16 SwapEndian16(Uint16 Val)
1041 {
1042         return ((Val&0xFF)<<8) | ((Val>>8)&0xFF);
1043 }
1044 Uint32 SwapEndian32(Uint32 Val)
1045 {
1046         return ((Val&0xFF)<<24) | ((Val&0xFF00)<<8) | ((Val>>8)&0xFF00) | ((Val>>24)&0xFF);
1047 }
1048
1049 void *memmove(void *__dest, const void *__src, size_t len)
1050 {
1051         size_t  block_size;
1052         char    *dest = __dest;
1053         const char      *src = __src;
1054         void    *ret = __dest;
1055
1056         if( len == 0 || dest == src )
1057                 return dest;
1058
1059         if( (tVAddr)dest > (tVAddr)src + len )
1060                 return memcpy(dest, src, len);
1061         if( (tVAddr)dest + len < (tVAddr)src )
1062                 return memcpy(dest, src, len);
1063
1064         // NOTE: Assumes memcpy works forward
1065         if( (tVAddr)dest < (tVAddr)src )
1066                 return memcpy(dest, src, len);
1067
1068         if( (tVAddr)dest < (tVAddr)src )
1069                 block_size = (tVAddr)src - (tVAddr)dest;
1070         else
1071                 block_size = (tVAddr)dest - (tVAddr)src;
1072
1073         block_size &= ~0xF;
1074
1075         while(len >= block_size)
1076         {
1077                 memcpy(dest, src, block_size);
1078                 len -= block_size;
1079                 dest += block_size;
1080                 src += block_size;
1081         }
1082         memcpy(dest, src, len);
1083         return ret;
1084
1085 }
1086