3 * Common Library Functions
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
19 int atoi(const char *string);
20 int ParseInt(const char *string, int *Val);
21 void itoa(char *buf, Uint64 num, int base, int minLength, char pad);
22 int vsnprintf(char *__s, size_t __maxlen, const char *__format, va_list args);
23 size_t snprintf(char *__s, size_t __n, const char *__format, ...);
24 int sprintf(char *__s, const char *__format, ...);
28 int strucmp(const char *Str1, const char *Str2);
29 char *strchr(const char *__s, int __c);
30 int strpos(const char *Str, char Ch);
31 Uint8 ByteSum(void *Ptr, int Size);
32 size_t strlen(const char *__s);
33 char *strcpy(char *__str1, const char *__str2);
34 char *strncpy(char *__str1, const char *__str2, size_t max);
35 int strcmp(const char *str1, const char *str2);
36 int strncmp(const char *str1, const char *str2, size_t num);
37 char *_strdup(const char *File, int Line, const char *Str);
38 char **str_split(const char *__str, char __ch);
39 int strpos8(const char *str, Uint32 Search);
40 int ReadUTF8(Uint8 *str, Uint32 *Val);
41 int WriteUTF8(Uint8 *str, Uint32 Val);
42 int DivUp(int num, int dem);
43 Sint64 timestamp(int sec, int mins, int hrs, int day, int month, int year);
44 void format_date(tTime TS, int *year, int *month, int *day, int *hrs, int *mins, int *sec, int *ms);
47 int CheckString(char *String);
48 int CheckMem(void *Mem, int NumBytes);
50 int ModUtil_LookupString(char **Array, char *Needle);
51 int ModUtil_SetIdent(char *Dest, char *Value);
53 int Hex(char *Dest, size_t Size, const Uint8 *SourceData);
54 int UnHex(Uint8 *Dest, size_t DestSize, const char *SourceString);
75 EXPORT(_strdup); // Takes File/Line too
84 EXPORT(ModUtil_LookupString);
85 EXPORT(ModUtil_SetIdent);
93 * \brief Convert a string into an integer
95 int atoi(const char *string)
98 ParseInt(string, &ret);
101 int ParseInt(const char *string, int *Val)
105 const char *orig_string = string;
107 //Log("atoi: (string='%s')", string);
109 // Clear non-numeric characters
110 while( !('0' <= *string && *string <= '9') && *string != '-' ) string++;
111 if( *string == '-' ) {
113 while( !('0' <= *string && *string <= '9') ) string++;
125 if('0' <= *string && *string <= '9') {
127 ret += *string - '0';
129 else if('A' <= *string && *string <= 'F') {
131 ret += *string - 'A' + 10;
133 else if('a' <= *string && *string <= 'f') {
135 ret += *string - 'a' + 10;
143 for( ; '0' <= *string && *string <= '7'; string ++ )
146 ret += *string - '0';
152 for( ; '0' <= *string && *string <= '9'; string++)
155 ret += *string - '0';
158 if( ret == 0 ) return 0;
163 //Log("atoi: RETURN %i", ret);
167 return string - orig_string;
170 static const char cUCDIGITS[] = "0123456789ABCDEF";
172 * \fn void itoa(char *buf, Uint64 num, int base, int minLength, char pad)
173 * \brief Convert an integer into a character string
175 void itoa(char *buf, Uint64 num, int base, int minLength, char pad)
185 if(base > 16 || base < 2) {
191 while(num > base-1) {
192 num = DivMod64U(num, base, &rem); // Shift `num` and get remainder
193 tmpBuf[pos] = cUCDIGITS[ rem ];
196 tmpBuf[pos++] = cUCDIGITS[ num ]; // Last digit of `num`
201 while(minLength-- > 0) buf[i++] = pad;
202 while(pos-- > 0) buf[i++] = tmpBuf[pos]; // Reverse the order of characters
207 * \brief Append a character the the vsnprintf output
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);\
215 * \brief VArg String Number Print Formatted
217 int vsnprintf(char *__s, size_t __maxlen, const char *__format, va_list args)
220 int minSize = 0, precision = -1, len;
221 char tmpBuf[34]; // For Integers
222 const char *p = NULL;
229 auto void _putch(char ch);
235 if(__s) __s[pos] = ch;
240 while((c = *__format++) != 0)
242 // Non control character
243 if(c != '%') { PUTCH(c); continue; }
249 if(c == '%') { PUTCH('%'); continue; }
251 // Pointer - Done first for debugging
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 ] );
260 // - Padding Side Flag
275 if(c == '*') { // Dynamic length
276 minSize = va_arg(args, unsigned int);
279 else if('1' <= c && c <= '9')
282 while('0' <= c && c <= '9')
297 if(c == '*') { // Dynamic length
298 precision = va_arg(args, unsigned int);
301 else if('1' <= c && c <= '9')
304 while('0' <= c && c <= '9')
307 precision += c - '0';
313 // - Default, Long or LongLong?
315 if(c == 'l') // Long is actually the default on x86
324 // - Now get the format code
331 if( isLongLong && val >> 63 ) {
335 else if( !isLongLong && val >> 31 ) {
339 itoa(tmpBuf, val, 10, minSize, pad);
341 case 'u': // Unsigned
343 itoa(tmpBuf, val, 10, minSize, pad);
345 case 'P': // Physical Address
348 if(sizeof(tPAddr) > 4) isLongLong = 1;
350 itoa(tmpBuf, val, 16, minSize, pad);
354 isLongLong = 1; // TODO: Handle non-x86 64-bit archs
356 itoa(tmpBuf, val, 16, minSize, pad);
359 case 'x': // Lower case hex
361 itoa(tmpBuf, val, 16, minSize, pad);
365 itoa(tmpBuf, val, 8, minSize, pad);
369 itoa(tmpBuf, val, 2, minSize, pad);
373 val = va_arg(args, unsigned int);
378 // String - Null Terminated Array
380 p = va_arg(args, char*); // Get Argument
381 if( !p || !CheckString(p) ) p = "(inval)"; // Avoid #PFs
385 if( !bPadLeft ) while(len++ < minSize) PUTCH(pad);
386 while(*p && precision--) PUTCH(*p++);
387 if( bPadLeft ) while(len++ < minSize) PUTCH(pad);
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++);
406 if(__s && pos != __maxlen)
415 size_t snprintf(char *__s, size_t __n, const char *__format, ...)
420 va_start(args, __format);
421 ret = vsnprintf(__s, __n, __format, args);
429 int sprintf(char *__s, const char *__format, ...)
434 va_start(args, __format);
435 ret = vsnprintf(__s, -1, __format, args);
442 * \fn int tolower(int c)
443 * \brief Converts a character to lower case
447 if('A' <= c && c <= 'Z')
448 return c - 'A' + 'a';
453 * \fn int strucmp(const char *Str1, const char *Str2)
454 * \brief Compare \a Str1 and \a Str2 case-insensitively
456 int strucmp(const char *Str1, const char *Str2)
458 while(*Str1 && tolower(*Str1) == tolower(*Str2))
460 return tolower(*Str1) - tolower(*Str2);
464 * \brief Locate a byte in a string
466 char *strchr(const char *__s, int __c)
468 for( ; *__s; __s ++ )
470 if( *__s == __c ) return (char*)__s;
476 * \fn int strpos(const char *Str, char Ch)
477 * \brief Search a string for an ascii character
479 int strpos(const char *Str, char Ch)
482 for(pos=0;Str[pos];pos++)
484 if(Str[pos] == Ch) return pos;
490 * \fn Uint8 ByteSum(void *Ptr, int Size)
491 * \brief Adds the bytes in a memory region and returns the sum
493 Uint8 ByteSum(const void *Ptr, int Size)
496 const Uint8 *data = Ptr;
497 while(Size--) sum += *(data++);
502 * \fn size_t strlen(const char *__str)
503 * \brief Get the length of string
505 size_t strlen(const char *__str)
508 while(*__str++) ret++;
513 * \brief Copy a string to a new location
515 char *strcpy(char *__str1, const char *__str2)
518 *__str1++ = *__str2++;
519 *__str1 = '\0'; // Terminate String
524 * \brief Copy a string to a new location
525 * \note Copies at most `max` chars
527 char *strncpy(char *__str1, const char *__str2, size_t __max)
529 while(*__str2 && __max-- >= 1)
530 *__str1++ = *__str2++;
532 *__str1 = '\0'; // Terminate String
537 * \brief Append a string to another
539 char *strcat(char *__dest, const char *__src)
544 *__dest++ = *__src++;
550 * \brief Append at most \a n chars to a string from another
551 * \note At most n+1 chars are written (the dest is always zero terminated)
553 char *strncat(char *__dest, const char *__src, size_t n)
556 while(*__src && n-- >= 1)
557 *__dest++ = *__src++;
563 * \fn int strcmp(const char *str1, const char *str2)
564 * \brief Compare two strings return the difference between
565 * the first non-matching characters.
567 int strcmp(const char *str1, const char *str2)
569 while(*str1 && *str1 == *str2)
571 return *str1 - *str2;
575 * \fn int strncmp(const char *Str1, const char *Str2, size_t num)
576 * \brief Compare strings \a Str1 and \a Str2 to a maximum of \a num characters
578 int strncmp(const char *Str1, const char *Str2, size_t num)
580 if(num == 0) return 0; // TODO: Check what should officially happen here
581 while(--num && *Str1 && *Str1 == *Str2)
588 * \fn char *strdup(const char *Str)
589 * \brief Duplicates a string
591 char *strdup(const char *Str)
594 ret = malloc(strlen(Str)+1);
595 if( !ret ) return NULL;
602 * \fn char *_strdup(const char *File, int Line, const char *Str)
603 * \brief Duplicates a string
605 char *_strdup(const char *File, int Line, const char *Str)
608 ret = Heap_Allocate(File, Line, strlen(Str)+1);
609 if( !ret ) return NULL;
616 * \brief Split a string using the passed character
617 * \return NULL terminated array of strings on the heap
618 * \param __str String to split
619 * \param __ch Character to split by
621 char **str_split(const char *__str, char __ch)
628 for( i = 0; __str[i]; i++ )
634 ret = malloc( sizeof(char*)*(len+1) + (i + 1) );
635 if( !ret ) return NULL;
638 start = (char *)&ret[len+1];
640 for( i = 0; __str[i]; i++ )
642 if(__str[i] == __ch) {
657 * \fn int DivUp(int num, int dem)
658 * \brief Divide two numbers, rounding up
659 * \param num Numerator
660 * \param dem Denominator
662 int DivUp(int num, int dem)
664 return (num+dem-1)/dem;
668 * \fn int strpos8(const char *str, Uint32 search)
669 * \brief Search a string for a UTF-8 character
671 int strpos8(const char *str, Uint32 Search)
675 for(pos=0;str[pos];pos++)
679 if(str[pos] == Search) return pos;
682 if(*(Uint8*)(str+pos) < 128) continue;
684 pos += ReadUTF8( (Uint8*)&str[pos], &val );
685 if(val == Search) return pos;
691 * \fn int ReadUTF8(Uint8 *str, Uint32 *Val)
692 * \brief Read a UTF-8 character from a string
694 int ReadUTF8(const Uint8 *str, Uint32 *Val)
696 *Val = 0xFFFD; // Assume invalid character
699 if( !(*str & 0x80) ) {
704 // Middle of a sequence
705 if( (*str & 0xC0) == 0x80 ) {
710 if( (*str & 0xE0) == 0xC0 ) {
711 *Val = (*str & 0x1F) << 6; // Upper 6 Bits
713 if( (*str & 0xC0) != 0x80) return -1; // Validity check
714 *Val |= (*str & 0x3F); // Lower 6 Bits
719 if( (*str & 0xF0) == 0xE0 ) {
720 *Val = (*str & 0x0F) << 12; // Upper 4 Bits
722 if( (*str & 0xC0) != 0x80) return -1; // Validity check
723 *Val |= (*str & 0x3F) << 6; // Middle 6 Bits
725 if( (*str & 0xC0) != 0x80) return -1; // Validity check
726 *Val |= (*str & 0x3F); // Lower 6 Bits
731 if( (*str & 0xF1) == 0xF0 ) {
732 *Val = (*str & 0x07) << 18; // Upper 3 Bits
734 if( (*str & 0xC0) != 0x80) return -1; // Validity check
735 *Val |= (*str & 0x3F) << 12; // Middle-upper 6 Bits
737 if( (*str & 0xC0) != 0x80) return -1; // Validity check
738 *Val |= (*str & 0x3F) << 6; // Middle-lower 6 Bits
740 if( (*str & 0xC0) != 0x80) return -1; // Validity check
741 *Val |= (*str & 0x3F); // Lower 6 Bits
745 // UTF-8 Doesn't support more than four bytes
750 * \fn int WriteUTF8(Uint8 *str, Uint32 Val)
751 * \brief Write a UTF-8 character sequence to a string
753 int WriteUTF8(Uint8 *str, Uint32 Val)
766 *str++ = 0xC0 | (Val >> 6);
767 *str++ = 0x80 | (Val & 0x3F);
773 if( Val < 0x10000 ) {
775 *str++ = 0xE0 | (Val >> 12);
776 *str++ = 0x80 | ((Val >> 6) & 0x3F);
777 *str++ = 0x80 | (Val & 0x3F);
783 if( Val < 0x110000 ) {
785 *str++ = 0xF0 | (Val >> 18);
786 *str++ = 0x80 | ((Val >> 12) & 0x3F);
787 *str++ = 0x80 | ((Val >> 6) & 0x3F);
788 *str++ = 0x80 | (Val & 0x3F);
793 // UTF-8 Doesn't support more than four bytes
798 * \fn Uint64 timestamp(int sec, int mins, int hrs, int day, int month, int year)
799 * \brief Converts a date into an Acess Timestamp
801 Sint64 timestamp(int sec, int min, int hrs, int day, int month, int year)
806 if( !(0 <= sec && sec < 60) ) return 0;
807 if( !(0 <= min && min < 60) ) return 0;
808 if( !(0 <= hrs && hrs < 24) ) return 0;
809 if( !(0 <= day && day < 31) ) return 0;
810 if( !(0 <= month && month < 12) ) return 0;
812 stamp = DAYS_BEFORE[month] + day;
817 is_leap = (year % 4 == 0) - (year % 100 == 0) + (year % 400 == 0);
818 ASSERT(is_leap == 0 || is_leap == 1);
820 if( is_leap && month > 1 ) // Leap year and after feb
823 // Get seconds before the first of specified year
824 year -= 2000; // Base off Y2K
825 // base year days + total leap year days
826 stamp += year*365 + (year/400) - (year/100) + (year/4);
837 void format_date(tTime TS, int *year, int *month, int *day, int *hrs, int *mins, int *sec, int *ms)
841 auto Sint64 DivMod64(Sint64 N, Sint64 D, Sint64 *R);
843 Sint64 DivMod64(Sint64 N, Sint64 D, Sint64 *R)
845 int sign = (N < 0) != (D < 0);
849 return -DivMod64U(N, D, (Uint64*)R);
851 return DivMod64U(N, D, (Uint64*)R);
855 // TODO: Leap-seconds?
858 TS = DivMod64( TS, 1000, &rem );
860 TS = DivMod64( TS, 60, &rem );
862 TS = DivMod64( TS, 60, &rem );
864 TS = DivMod64( TS, 24, &rem );
869 TS -= UNIX_TO_2K/(3600*24);
871 // Year (400 yr blocks) - (400/4-3) leap years
872 *year = 400 * DivMod64( TS, 365*400 + (400/4-3), &TS );
873 if( TS < 366 ) // First year in 400 is a leap
877 // 100 yr blocks - 100/4-1 leap years
878 *year += 100 * DivMod64( TS, 365*100 + (100/4-1), &TS );
879 if( TS < 366 ) // First year in 100 isn't a leap
883 *year += 4 * DivMod64( TS, 365*4 + 1, &TS );
884 if( TS < 366 ) // First year in 4 is a leap
888 *year += DivMod64( TS, 356, &TS );
897 // Month (if after the first of march, which is 29 Feb in a leap year)
898 if( is_leap && TS > DAYS_BEFORE[2] ) {
899 TS -= 1; // Shifts 29 Feb to 28 Feb
902 // Get what month it is
903 for( i = 0; i < 12; i ++ ) {
904 if( TS < DAYS_BEFORE[i] )
909 TS -= DAYS_BEFORE[i-1];
910 *day += TS; // Plus offset from leap handling above
915 * \brief Pseudo random number generator
920 static Uint state = RANDOM_SEED;
922 // Get the next state value
923 giRandomState = (RANDOM_A*state + RANDOM_C);
924 // Check if it has changed, and if it hasn't, change it
925 if(state == old) state += RANDOM_SPRUCE;
928 // http://en.wikipedia.org/wiki/Xorshift
930 static Uint32 x = 123456789;
931 static Uint32 y = 362436069;
932 static Uint32 z = 521288629;
933 static Uint32 w = 88675123;
938 return w = w ^ (w >> 19) ^ t ^ (t >> 8);
943 * \name Memory Validation
947 * \brief Checks if a string resides fully in valid memory
949 int CheckString(const char *String)
954 addr = (tVAddr)String;
956 if( !MM_GetPhysAddr( addr ) )
960 bUser = MM_IsUser( addr );
962 while( *(char*)addr )
964 if( (addr & (PAGE_SIZE-1)) == 0 )
966 if(bUser && !MM_IsUser(addr) )
968 if(!bUser && !MM_GetPhysAddr(addr) )
977 * \brief Check if a sized memory region is valid memory
978 * \return Boolean success
980 int CheckMem(const void *Mem, int NumBytes)
982 return MM_IsValidBuffer( (tVAddr)Mem, NumBytes );
989 * \brief Search a string array for \a Needle
990 * \note Helper function for eTplDrv_IOCtl::DRV_IOCTL_LOOKUP
992 int ModUtil_LookupString(const char **Array, const char *Needle)
995 if( !CheckString(Needle) ) return -1;
996 for( i = 0; Array[i]; i++ )
998 if(strcmp(Array[i], Needle) == 0) return i;
1003 int ModUtil_SetIdent(char *Dest, const char *Value)
1005 if( !CheckMem(Dest, 32) ) return -1;
1006 strncpy(Dest, Value, 32);
1010 int Hex(char *Dest, size_t Size, const Uint8 *SourceData)
1013 for( i = 0; i < Size; i ++ )
1015 sprintf(Dest + i*2, "%02x", SourceData[i]);
1021 * \brief Convert a string of hexadecimal digits into a byte stream
1023 int UnHex(Uint8 *Dest, size_t DestSize, const char *SourceString)
1027 for( i = 0; i < DestSize*2; i += 2 )
1031 if(SourceString[i] == '\0') break;
1033 if('0' <= SourceString[i] && SourceString[i] <= '9')
1034 val |= (SourceString[i]-'0') << 4;
1035 else if('A' <= SourceString[i] && SourceString[i] <= 'F')
1036 val |= (SourceString[i]-'A'+10) << 4;
1037 else if('a' <= SourceString[i] && SourceString[i] <= 'f')
1038 val |= (SourceString[i]-'a'+10) << 4;
1040 if(SourceString[i+1] == '\0') break;
1042 if('0' <= SourceString[i+1] && SourceString[i+1] <= '9')
1043 val |= (SourceString[i+1] - '0');
1044 else if('A' <= SourceString[i+1] && SourceString[i+1] <= 'F')
1045 val |= (SourceString[i+1] - 'A' + 10);
1046 else if('a' <= SourceString[i+1] && SourceString[i+1] <= 'f')
1047 val |= (SourceString[i+1] - 'a' + 10);
1054 Uint16 SwapEndian16(Uint16 Val)
1056 return ((Val&0xFF)<<8) | ((Val>>8)&0xFF);
1058 Uint32 SwapEndian32(Uint32 Val)
1060 return ((Val&0xFF)<<24) | ((Val&0xFF00)<<8) | ((Val>>8)&0xFF00) | ((Val>>24)&0xFF);
1063 void *memmove(void *__dest, const void *__src, size_t len)
1066 char *dest = __dest;
1067 const char *src = __src;
1070 if( len == 0 || dest == src )
1073 if( (tVAddr)dest > (tVAddr)src + len )
1074 return memcpy(dest, src, len);
1075 if( (tVAddr)dest + len < (tVAddr)src )
1076 return memcpy(dest, src, len);
1078 // NOTE: Assumes memcpy works forward
1079 if( (tVAddr)dest < (tVAddr)src )
1080 return memcpy(dest, src, len);
1082 if( (tVAddr)dest < (tVAddr)src )
1083 block_size = (tVAddr)src - (tVAddr)dest;
1085 block_size = (tVAddr)dest - (tVAddr)src;
1089 while(len >= block_size)
1091 memcpy(dest, src, block_size);
1096 memcpy(dest, src, len);