3 * Common Library Functions
8 #define RANDOM_SEED 0xACE55052
9 #define RANDOM_A 0x00731ADE
10 #define RANDOM_C 12345
11 #define RANDOM_SPRUCE 0xf12b039
12 // Jan Feb Mar Apr May Jun Jul Aug Sept Oct Nov Dec
13 const short DAYS_BEFORE[] = {0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334};
14 #define UNIX_TO_2K ((30*365*3600*24) + (7*3600*24)) //Normal years + leap years
17 int atoi(const char *string);
18 void itoa(char *buf, Uint num, int base, int minLength, char pad);
19 int vsnprintf(char *__s, size_t __maxlen, const char *__format, va_list args);
20 int sprintf(char *__s, const char *__format, ...);
22 int strucmp(const char *Str1, const char *Str2);
23 int strpos(const char *Str, char Ch);
24 Uint8 ByteSum(void *Ptr, int Size);
25 size_t strlen(const char *__s);
26 char *strcpy(char *__str1, const char *__str2);
27 char *strncpy(char *__str1, const char *__str2, size_t max);
28 int strcmp(const char *str1, const char *str2);
29 int strncmp(const char *str1, const char *str2, size_t num);
30 char *_strdup(const char *File, int Line, const char *Str);
31 char **str_split(const char *__str, char __ch);
32 int strpos8(const char *str, Uint32 Search);
33 int ReadUTF8(Uint8 *str, Uint32 *Val);
34 int WriteUTF8(Uint8 *str, Uint32 Val);
35 int DivUp(int num, int dem);
36 Sint64 timestamp(int sec, int mins, int hrs, int day, int month, int year);
38 int CheckString(char *String);
39 int CheckMem(void *Mem, int NumBytes);
40 int ModUtil_LookupString(char **Array, char *Needle);
41 int ModUtil_SetIdent(char *Dest, char *Value);
58 EXPORT(_strdup); // Takes File/Line too
67 EXPORT(ModUtil_LookupString);
68 EXPORT(ModUtil_SetIdent);
72 * \brief Convert a string into an integer
74 int atoi(const char *string)
79 //Log("atoi: (string='%s')", string);
81 // Clear non-numeric characters
82 while( !('0' <= *string && *string <= '9') && *string != '-' ) string++;
83 if( *string == '-' ) {
85 while( !('0' <= *string && *string <= '9') ) string++;
97 if('0' <= *string && *string <= '9') {
101 else if('A' <= *string && *string <= 'F') {
103 ret += *string - 'A' + 10;
105 else if('a' <= *string && *string <= 'f') {
107 ret += *string - 'a' + 10;
115 for( ; '0' <= *string && *string <= '7'; string ++ )
118 ret += *string - '0';
124 for( ; '0' <= *string && *string <= '9'; string++)
127 ret += *string - '0';
133 //Log("atoi: RETURN %i", ret);
138 static const char cUCDIGITS[] = "0123456789ABCDEF";
140 * \fn void itoa(char *buf, Uint num, int base, int minLength, char pad)
141 * \brief Convert an integer into a character string
143 void itoa(char *buf, Uint num, int base, int minLength, char pad)
152 if(base > 16 || base < 2) {
158 while(num > base-1) {
159 tmpBuf[pos] = cUCDIGITS[ num % base ];
160 num /= (Uint)base; // Shift `num` right 1 digit
163 tmpBuf[pos++] = cUCDIGITS[ num % base ]; // Last digit of `num`
168 while(minLength-- > 0) buf[i++] = pad;
169 while(pos-- > 0) buf[i++] = tmpBuf[pos]; // Reverse the order of characters
174 * \brief Append a character the the vsnprintf output
176 #define PUTCH(c) do{\
178 if(pos==__maxlen){return pos;}\
179 if(__s){__s[pos++]=ch;}else{pos++;}\
181 #define GETVAL() do {\
182 if(isLongLong) val = va_arg(args, Uint64);\
183 else val = va_arg(args, unsigned int);\
186 * \brief VArg String Number Print Formatted
188 int vsnprintf(char *__s, size_t __maxlen, const char *__format, va_list args)
191 int minSize = 0, len;
192 char tmpBuf[34]; // For Integers
200 //Log("vsnprintf: (__s=%p, __maxlen=%i, __format='%s', ...)", __s, __maxlen, __format);
202 while((c = *__format++) != 0)
204 // Non control character
205 if(c != '%') { PUTCH(c); continue; }
208 //Log("pos = %i", pos);
211 if(c == '%') { PUTCH('%'); continue; }
213 // Pointer - Done first for debugging
215 Uint ptr = va_arg(args, Uint);
216 PUTCH('*'); PUTCH('0'); PUTCH('x');
218 itoa(p, ptr, 16, BITS/4, '0');
222 // - Padding Side Flag
237 if(c == '*') { // Dynamic length
238 minSize = va_arg(args, unsigned int);
241 else if('1' <= c && c <= '9')
244 while('0' <= c && c <= '9')
254 // - Default, Long or LongLong?
256 if(c == 'l') // Long is actually the default on x86
265 // - Now get the format code
272 if( isLongLong && val >> 63 ) {
276 else if( !isLongLong && val >> 31 ) {
280 itoa(p, val, 10, minSize, pad);
284 itoa(p, val, 10, minSize, pad);
288 itoa(p, val, 16, minSize, pad);
292 itoa(p, val, 8, minSize, pad);
296 itoa(p, val, 2, minSize, pad);
300 val = va_arg(args, unsigned int);
305 // String - Null Terminated Array
307 p = va_arg(args, char*); // Get Argument
311 if( !bPadLeft ) while(len++ < minSize) PUTCH(pad);
312 while(*p) PUTCH(*p++);
313 if( bPadLeft ) while(len++ < minSize) PUTCH(pad);
316 case 'C': // Non-Null Terminated Character Array
317 p = va_arg(args, char*);
318 if(!p) goto printString;
319 while(minSize--) PUTCH(*p++);
331 if(__s && pos != __maxlen)
340 int sprintf(char *__s, const char *__format, ...)
345 va_start(args, __format);
346 ret = vsnprintf(__s, -1, __format, args);
353 * \fn int tolower(int c)
354 * \brief Converts a character to lower case
358 if('A' <= c && c <= 'Z')
359 return c - 'A' + 'a';
364 * \fn int strucmp(const char *Str1, const char *Str2)
365 * \brief Compare \a Str1 and \a Str2 case-insensitively
367 int strucmp(const char *Str1, const char *Str2)
369 while(*Str1 && tolower(*Str1) == tolower(*Str2))
371 return tolower(*Str1) - tolower(*Str2);
375 * \fn int strpos(const char *Str, char Ch)
376 * \brief Search a string for an ascii character
378 int strpos(const char *Str, char Ch)
381 for(pos=0;Str[pos];pos++)
383 if(Str[pos] == Ch) return pos;
389 * \fn Uint8 ByteSum(void *Ptr, int Size)
390 * \brief Adds the bytes in a memory region and returns the sum
392 Uint8 ByteSum(void *Ptr, int Size)
395 while(Size--) sum += *(Uint8*)Ptr++;
400 * \fn Uint strlen(const char *__str)
401 * \brief Get the length of string
403 Uint strlen(const char *__str)
406 while(*__str++) ret++;
411 * \fn char *strcpy(char *__str1, const char *__str2)
412 * \brief Copy a string to a new location
414 char *strcpy(char *__str1, const char *__str2)
417 *__str1++ = *__str2++;
418 *__str1 = '\0'; // Terminate String
423 * \fn char *strncpy(char *__str1, const char *__str2, size_t max)
424 * \brief Copy a string to a new location
426 char *strncpy(char *__str1, const char *__str2, size_t max)
428 while(*__str2 && max-- >= 1)
429 *__str1++ = *__str2++;
431 *__str1 = '\0'; // Terminate String
436 * \fn int strcmp(const char *str1, const char *str2)
437 * \brief Compare two strings return the difference between
438 * the first non-matching characters.
440 int strcmp(const char *str1, const char *str2)
442 while(*str1 && *str1 == *str2)
444 return *str1 - *str2;
448 * \fn int strncmp(const char *Str1, const char *Str2, size_t num)
449 * \brief Compare strings \a Str1 and \a Str2 to a maximum of \a num characters
451 int strncmp(const char *Str1, const char *Str2, size_t num)
453 if(num == 0) return 0; // TODO: Check what should officially happen here
454 while(--num && *Str1 && *Str1 == *Str2)
461 * \fn char *strdup(const char *Str)
462 * \brief Duplicates a string
464 char *strdup(const char *Str)
467 ret = malloc(strlen(Str)+1);
468 if( !ret ) return NULL;
475 * \fn char *_strdup(const char *File, int Line, const char *Str)
476 * \brief Duplicates a string
478 char *_strdup(const char *File, int Line, const char *Str)
481 ret = Heap_Allocate(File, Line, strlen(Str)+1);
482 if( !ret ) return NULL;
488 * \brief Split a string using the passed character
489 * \return NULL terminated array of strings on the heap
490 * \param __str String to split
491 * \param __ch Character to split by
493 char **str_split(const char *__str, char __ch)
500 for( i = 0; __str[i]; i++ )
506 ret = malloc( sizeof(char*)*(len+1) + (i + 1) );
507 if( !ret ) return NULL;
510 start = (char *)&ret[len+1];
512 for( i = 0; __str[i]; i++ )
514 if(__str[i] == __ch) {
529 * \fn int DivUp(int num, int dem)
530 * \brief Divide two numbers, rounding up
531 * \param num Numerator
532 * \param dem Denominator
534 int DivUp(int num, int dem)
536 return (num+dem-1)/dem;
540 * \fn int strpos8(const char *str, Uint32 search)
541 * \brief Search a string for a UTF-8 character
543 int strpos8(const char *str, Uint32 Search)
547 for(pos=0;str[pos];pos++)
551 if(str[pos] == Search) return pos;
554 if(*(Uint8*)(str+pos) < 128) continue;
556 pos += ReadUTF8( (Uint8*)&str[pos], &val );
557 if(val == Search) return pos;
563 * \fn int ReadUTF8(Uint8 *str, Uint32 *Val)
564 * \brief Read a UTF-8 character from a string
566 int ReadUTF8(Uint8 *str, Uint32 *Val)
568 *Val = 0xFFFD; // Assume invalid character
571 if( !(*str & 0x80) ) {
576 // Middle of a sequence
577 if( (*str & 0xC0) == 0x80 ) {
582 if( (*str & 0xE0) == 0xC0 ) {
583 *Val = (*str & 0x1F) << 6; // Upper 6 Bits
585 if( (*str & 0xC0) != 0x80) return -1; // Validity check
586 *Val |= (*str & 0x3F); // Lower 6 Bits
591 if( (*str & 0xF0) == 0xE0 ) {
592 *Val = (*str & 0x0F) << 12; // Upper 4 Bits
594 if( (*str & 0xC0) != 0x80) return -1; // Validity check
595 *Val |= (*str & 0x3F) << 6; // Middle 6 Bits
597 if( (*str & 0xC0) != 0x80) return -1; // Validity check
598 *Val |= (*str & 0x3F); // Lower 6 Bits
603 if( (*str & 0xF1) == 0xF0 ) {
604 *Val = (*str & 0x07) << 18; // Upper 3 Bits
606 if( (*str & 0xC0) != 0x80) return -1; // Validity check
607 *Val |= (*str & 0x3F) << 12; // Middle-upper 6 Bits
609 if( (*str & 0xC0) != 0x80) return -1; // Validity check
610 *Val |= (*str & 0x3F) << 6; // Middle-lower 6 Bits
612 if( (*str & 0xC0) != 0x80) return -1; // Validity check
613 *Val |= (*str & 0x3F); // Lower 6 Bits
617 // UTF-8 Doesn't support more than four bytes
622 * \fn int WriteUTF8(Uint8 *str, Uint32 Val)
623 * \brief Write a UTF-8 character sequence to a string
625 int WriteUTF8(Uint8 *str, Uint32 Val)
635 *str = 0xC0 | (Val >> 6);
637 *str = 0x80 | (Val & 0x3F);
642 if( Val < 0x10000 ) {
643 *str = 0xE0 | (Val >> 12);
645 *str = 0x80 | ((Val >> 6) & 0x3F);
647 *str = 0x80 | (Val & 0x3F);
652 if( Val < 0x110000 ) {
653 *str = 0xF0 | (Val >> 18);
655 *str = 0x80 | ((Val >> 12) & 0x3F);
657 *str = 0x80 | ((Val >> 6) & 0x3F);
659 *str = 0x80 | (Val & 0x3F);
663 // UTF-8 Doesn't support more than four bytes
668 * \fn Uint64 timestamp(int sec, int mins, int hrs, int day, int month, int year)
669 * \brief Converts a date into an Acess Timestamp
671 Sint64 timestamp(int sec, int mins, int hrs, int day, int month, int year)
678 stamp += day*3600*24;
679 stamp += month*DAYS_BEFORE[month]*3600*24;
681 ((year&3) == 0 || year%100 != 0)
682 || (year%100 == 0 && ((year/100)&3) == 0)
683 ) && month > 1) // Leap year and after feb
686 stamp += ((365*4+1) * ((year-2000)&~3)) * 3600*24; // Four Year Segments
687 stamp += ((year-2000)&3) * 365*3600*24; // Inside four year segment
695 * \brief Pseudo random number generator
696 * \note Unknown effectiveness (made up on the spot)
701 static Uint state = RANDOM_SEED;
703 // Get the next state value
704 giRandomState = (RANDOM_A*state + RANDOM_C);
705 // Check if it has changed, and if it hasn't, change it
706 if(state == old) state += RANDOM_SPRUCE;
709 // http://en.wikipedia.org/wiki/Xorshift
711 static Uint32 x = 123456789;
712 static Uint32 y = 362436069;
713 static Uint32 z = 521288629;
714 static Uint32 w = 88675123;
719 return w = w ^ (w >> 19) ^ t ^ (t >> 8);
724 * \name Memory Validation
728 * \brief Checks if a string resides fully in valid memory
730 int CheckString(char *String)
732 if( !MM_GetPhysAddr( (tVAddr)String ) )
736 if( MM_IsUser( (tVAddr)String ) )
741 if( !MM_IsUser( (tVAddr)String ) )
743 // Increment string pointer
748 else if( MM_GetPhysAddr( (tVAddr)String ) )
753 if( !MM_GetPhysAddr( (tVAddr)String ) )
755 // Increment string pointer
764 * \brief Check if a sized memory region is valid memory
766 int CheckMem(void *Mem, int NumBytes)
768 tVAddr addr = (tVAddr)Mem;
770 if( MM_IsUser( addr ) )
774 if( !MM_IsUser( addr ) )
780 else if( MM_GetPhysAddr( addr ) )
784 if( !MM_GetPhysAddr( addr ) )
797 * \brief Search a string array for \a Needle
798 * \note Helper function for eTplDrv_IOCtl::DRV_IOCTL_LOOKUP
800 int ModUtil_LookupString(char **Array, char *Needle)
803 if( !CheckString(Needle) ) return -1;
804 for( i = 0; Array[i]; i++ )
806 if(strcmp(Array[i], Needle) == 0) return i;
811 int ModUtil_SetIdent(char *Dest, char *Value)
813 if( !CheckMem(Dest, 32) ) return -1;
814 strncpy(Dest, Value, 32);