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++;}\
182 * \brief VArg String Number Print Formatted
184 int vsnprintf(char *__s, size_t __maxlen, const char *__format, va_list args)
187 int minSize = 0, len;
188 char tmpBuf[34]; // For Integers
196 //Log("vsnprintf: (__s=%p, __maxlen=%i, __format='%s', ...)", __s, __maxlen, __format);
198 while((c = *__format++) != 0)
200 // Non control character
201 if(c != '%') { PUTCH(c); continue; }
204 //Log("pos = %i", pos);
207 if(c == '%') { PUTCH('%'); continue; }
209 // Pointer - Done first for debugging
211 Uint ptr = va_arg(args, Uint);
212 PUTCH('*'); PUTCH('0'); PUTCH('x');
214 itoa(p, ptr, 16, BITS/4, '0');
219 val = va_arg(args, unsigned int);
221 // - Padding Side Flag
236 if(c == '*') { // Dynamic length
238 val = 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
261 val |= (Uint64)va_arg(args, Uint) << 32;
268 // - Now get the format code
274 if( isLongLong && val >> 63 ) {
278 else if( !isLongLong && val >> 31 ) {
282 itoa(p, val, 10, minSize, pad);
285 itoa(p, val, 10, minSize, pad);
288 itoa(p, val, 16, minSize, pad);
291 itoa(p, val, 8, minSize, pad);
294 itoa(p, val, 2, minSize, pad);
302 // String - Null Terminated Array
304 p = (char*)(tVAddr)val;
308 if( !bPadLeft ) while(len++ < minSize) PUTCH(pad);
309 while(*p) PUTCH(*p++);
310 if( bPadLeft ) while(len++ < minSize) PUTCH(pad);
313 case 'C': // Non-Null Terminated Character Array
314 p = (char*)(tVAddr)val;
315 if(!p) goto printString;
316 while(minSize--) PUTCH(*p++);
327 if(__s && pos != __maxlen)
336 int sprintf(char *__s, const char *__format, ...)
341 va_start(args, __format);
342 ret = vsnprintf(__s, -1, __format, args);
349 * \fn int tolower(int c)
350 * \brief Converts a character to lower case
354 if('A' <= c && c <= 'Z')
355 return c - 'A' + 'a';
360 * \fn int strucmp(const char *Str1, const char *Str2)
361 * \brief Compare \a Str1 and \a Str2 case-insensitively
363 int strucmp(const char *Str1, const char *Str2)
365 while(*Str1 && tolower(*Str1) == tolower(*Str2))
367 return tolower(*Str1) - tolower(*Str2);
371 * \fn int strpos(const char *Str, char Ch)
372 * \brief Search a string for an ascii character
374 int strpos(const char *Str, char Ch)
377 for(pos=0;Str[pos];pos++)
379 if(Str[pos] == Ch) return pos;
385 * \fn Uint8 ByteSum(void *Ptr, int Size)
386 * \brief Adds the bytes in a memory region and returns the sum
388 Uint8 ByteSum(void *Ptr, int Size)
391 while(Size--) sum += *(Uint8*)Ptr++;
396 * \fn Uint strlen(const char *__str)
397 * \brief Get the length of string
399 Uint strlen(const char *__str)
402 while(*__str++) ret++;
407 * \fn char *strcpy(char *__str1, const char *__str2)
408 * \brief Copy a string to a new location
410 char *strcpy(char *__str1, const char *__str2)
413 *__str1++ = *__str2++;
414 *__str1 = '\0'; // Terminate String
419 * \fn char *strncpy(char *__str1, const char *__str2, size_t max)
420 * \brief Copy a string to a new location
422 char *strncpy(char *__str1, const char *__str2, size_t max)
424 while(*__str2 && max-- >= 1)
425 *__str1++ = *__str2++;
427 *__str1 = '\0'; // Terminate String
432 * \fn int strcmp(const char *str1, const char *str2)
433 * \brief Compare two strings return the difference between
434 * the first non-matching characters.
436 int strcmp(const char *str1, const char *str2)
438 while(*str1 && *str1 == *str2)
440 return *str1 - *str2;
444 * \fn int strncmp(const char *Str1, const char *Str2, size_t num)
445 * \brief Compare strings \a Str1 and \a Str2 to a maximum of \a num characters
447 int strncmp(const char *Str1, const char *Str2, size_t num)
449 if(num == 0) return 0; // TODO: Check what should officially happen here
450 while(--num && *Str1 && *Str1 == *Str2)
457 * \fn char *strdup(const char *Str)
458 * \brief Duplicates a string
460 char *strdup(const char *Str)
463 ret = malloc(strlen(Str)+1);
464 if( !ret ) return NULL;
471 * \fn char *_strdup(const char *File, int Line, const char *Str)
472 * \brief Duplicates a string
474 char *_strdup(const char *File, int Line, const char *Str)
477 ret = Heap_Allocate(File, Line, strlen(Str)+1);
478 if( !ret ) return NULL;
484 * \brief Split a string using the passed character
485 * \return NULL terminated array of strings on the heap
486 * \param __str String to split
487 * \param __ch Character to split by
489 char **str_split(const char *__str, char __ch)
496 for( i = 0; __str[i]; i++ )
502 ret = malloc( sizeof(char*)*(len+1) + (i + 1) );
503 if( !ret ) return NULL;
506 start = (char *)&ret[len+1];
508 for( i = 0; __str[i]; i++ )
510 if(__str[i] == __ch) {
525 * \fn int DivUp(int num, int dem)
526 * \brief Divide two numbers, rounding up
527 * \param num Numerator
528 * \param dem Denominator
530 int DivUp(int num, int dem)
532 return (num+dem-1)/dem;
536 * \fn int strpos8(const char *str, Uint32 search)
537 * \brief Search a string for a UTF-8 character
539 int strpos8(const char *str, Uint32 Search)
543 for(pos=0;str[pos];pos++)
547 if(str[pos] == Search) return pos;
550 if(*(Uint8*)(str+pos) < 128) continue;
552 pos += ReadUTF8( (Uint8*)&str[pos], &val );
553 if(val == Search) return pos;
559 * \fn int ReadUTF8(Uint8 *str, Uint32 *Val)
560 * \brief Read a UTF-8 character from a string
562 int ReadUTF8(Uint8 *str, Uint32 *Val)
564 *Val = 0xFFFD; // Assume invalid character
567 if( !(*str & 0x80) ) {
572 // Middle of a sequence
573 if( (*str & 0xC0) == 0x80 ) {
578 if( (*str & 0xE0) == 0xC0 ) {
579 *Val = (*str & 0x1F) << 6; // Upper 6 Bits
581 if( (*str & 0xC0) != 0x80) return -1; // Validity check
582 *Val |= (*str & 0x3F); // Lower 6 Bits
587 if( (*str & 0xF0) == 0xE0 ) {
588 *Val = (*str & 0x0F) << 12; // Upper 4 Bits
590 if( (*str & 0xC0) != 0x80) return -1; // Validity check
591 *Val |= (*str & 0x3F) << 6; // Middle 6 Bits
593 if( (*str & 0xC0) != 0x80) return -1; // Validity check
594 *Val |= (*str & 0x3F); // Lower 6 Bits
599 if( (*str & 0xF1) == 0xF0 ) {
600 *Val = (*str & 0x07) << 18; // Upper 3 Bits
602 if( (*str & 0xC0) != 0x80) return -1; // Validity check
603 *Val |= (*str & 0x3F) << 12; // Middle-upper 6 Bits
605 if( (*str & 0xC0) != 0x80) return -1; // Validity check
606 *Val |= (*str & 0x3F) << 6; // Middle-lower 6 Bits
608 if( (*str & 0xC0) != 0x80) return -1; // Validity check
609 *Val |= (*str & 0x3F); // Lower 6 Bits
613 // UTF-8 Doesn't support more than four bytes
618 * \fn int WriteUTF8(Uint8 *str, Uint32 Val)
619 * \brief Write a UTF-8 character sequence to a string
621 int WriteUTF8(Uint8 *str, Uint32 Val)
631 *str = 0xC0 | (Val >> 6);
633 *str = 0x80 | (Val & 0x3F);
638 if( Val < 0x10000 ) {
639 *str = 0xE0 | (Val >> 12);
641 *str = 0x80 | ((Val >> 6) & 0x3F);
643 *str = 0x80 | (Val & 0x3F);
648 if( Val < 0x110000 ) {
649 *str = 0xF0 | (Val >> 18);
651 *str = 0x80 | ((Val >> 12) & 0x3F);
653 *str = 0x80 | ((Val >> 6) & 0x3F);
655 *str = 0x80 | (Val & 0x3F);
659 // UTF-8 Doesn't support more than four bytes
664 * \fn Uint64 timestamp(int sec, int mins, int hrs, int day, int month, int year)
665 * \brief Converts a date into an Acess Timestamp
667 Sint64 timestamp(int sec, int mins, int hrs, int day, int month, int year)
674 stamp += day*3600*24;
675 stamp += month*DAYS_BEFORE[month]*3600*24;
677 ((year&3) == 0 || year%100 != 0)
678 || (year%100 == 0 && ((year/100)&3) == 0)
679 ) && month > 1) // Leap year and after feb
682 stamp += ((365*4+1) * ((year-2000)&~3)) * 3600*24; // Four Year Segments
683 stamp += ((year-2000)&3) * 365*3600*24; // Inside four year segment
691 * \brief Pseudo random number generator
692 * \note Unknown effectiveness (made up on the spot)
697 static Uint state = RANDOM_SEED;
699 // Get the next state value
700 giRandomState = (RANDOM_A*state + RANDOM_C);
701 // Check if it has changed, and if it hasn't, change it
702 if(state == old) state += RANDOM_SPRUCE;
705 // http://en.wikipedia.org/wiki/Xorshift
707 static Uint32 x = 123456789;
708 static Uint32 y = 362436069;
709 static Uint32 z = 521288629;
710 static Uint32 w = 88675123;
715 return w = w ^ (w >> 19) ^ t ^ (t >> 8);
720 * \name Memory Validation
724 * \brief Checks if a string resides fully in valid memory
726 int CheckString(char *String)
728 if( !MM_GetPhysAddr( (tVAddr)String ) )
732 if( MM_IsUser( (tVAddr)String ) )
737 if( !MM_IsUser( (tVAddr)String ) )
739 // Increment string pointer
744 else if( MM_GetPhysAddr( (tVAddr)String ) )
749 if( !MM_GetPhysAddr( (tVAddr)String ) )
751 // Increment string pointer
760 * \brief Check if a sized memory region is valid memory
762 int CheckMem(void *Mem, int NumBytes)
764 tVAddr addr = (tVAddr)Mem;
766 if( MM_IsUser( addr ) )
770 if( !MM_IsUser( addr ) )
776 else if( MM_GetPhysAddr( addr ) )
780 if( !MM_GetPhysAddr( addr ) )
793 * \brief Search a string array for \a Needle
794 * \note Helper function for eTplDrv_IOCtl::DRV_IOCTL_LOOKUP
796 int ModUtil_LookupString(char **Array, char *Needle)
799 if( !CheckString(Needle) ) return -1;
800 for( i = 0; Array[i]; i++ )
802 if(strcmp(Array[i], Needle) == 0) return i;
807 int ModUtil_SetIdent(char *Dest, char *Value)
809 if( !CheckMem(Dest, 32) ) return -1;
810 strncpy(Dest, Value, 32);