core: fix warnings/eliminate unused variables
[sip-router] / ut.h
1 /*
2  *$Id$
3  *
4  * - various general purpose functions
5  *
6  * Copyright (C) 2001-2003 FhG Fokus
7  *
8  * Permission to use, copy, modify, and distribute this software for any
9  * purpose with or without fee is hereby granted, provided that the above
10  * copyright notice and this permission notice appear in all copies.
11  *
12  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
13  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
14  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
15  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
16  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
17  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
18  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19  *
20  * History
21  * ------
22  * 2003-01-18 un_escape function introduced for convenience of code needing
23  *            the complex&slow feature of unescaping
24  * 2003-01-28 scratchpad removed (jiri)
25  * 2003-01-29 pathmax added (jiri)
26  * 2003-02-13 strlower added (janakj)
27  * 2003-02-28 scratchpad compatibility abandoned (jiri)
28  * 2003-03-30 str2int and str2float added (janakj)
29  * 2003-04-26 ZSW (jiri)
30  * 2004-03-08 updated int2str (64 bits, INT2STR_MAX_LEN used) (andrei)
31  * 2005-11-29 reverse_hex2int/int2reverse_hex switched to unsigned int (andrei)
32  * 2005-12-09 added msgid_var (andrei)
33  * 2007-05-14 added get_sys_ver() (andrei)
34  * 2007-06-05 added MAX_UVAR_VALUE(), MAX_int(a,b) MIN_int(a,b) (andrei)
35  * 2008-05-21 added ushort2sbuf(), ushort2str() (andrei)
36  * 2009-03-16 added sint2strbuf() and incremented INST2STR_MAX_LEN to account
37  *             for sign (andrei)
38  */
39 /** various general purpose/helper functions.
40  * @file
41  */
42
43
44 #ifndef ut_h
45 #define ut_h
46
47 #include "comp_defs.h"
48
49 #include <sys/types.h>
50 #include <sys/select.h>
51 #include <sys/time.h>
52 #include <limits.h>
53 #include <time.h>
54 #include <unistd.h>
55 #include <ctype.h>
56 #include <string.h>
57 #include <strings.h>
58
59 #include "compiler_opt.h"
60 #include "config.h"
61 #include "dprint.h"
62 #include "str.h"
63 #include "mem/mem.h"
64 #include "mem/shm_mem.h"
65
66
67
68 /* zero-string wrapper */
69 #define ZSW(_c) ((_c)?(_c):"")
70
71 /* returns string beginning and length without insignificant chars */
72 #define trim_len( _len, _begin, _mystr ) \
73         do{     static char _c; \
74                 (_len)=(_mystr).len; \
75                 while ((_len) && ((_c=(_mystr).s[(_len)-1])==0 || _c=='\r' || \
76                                         _c=='\n' || _c==' ' || _c=='\t' )) \
77                         (_len)--; \
78                 (_begin)=(_mystr).s; \
79                 while ((_len) && ((_c=*(_begin))==' ' || _c=='\t')) { \
80                         (_len)--;\
81                         (_begin)++; \
82                 } \
83         }while(0)
84
85 #define trim_r( _mystr ) \
86         do{     static char _c; \
87                 while( ((_mystr).len) && ( ((_c=(_mystr).s[(_mystr).len-1]))==0 ||\
88                                                                         _c=='\r' || _c=='\n' ) \
89                                 ) \
90                         (_mystr).len--; \
91         }while(0)
92
93
94 #define  translate_pointer( _new_buf , _org_buf , _p) \
95         ( (_p)?(_new_buf + (_p-_org_buf)):(0) )
96
97 #define via_len(_via) \
98         ((_via)->bsize-((_via)->name.s-\
99                 ((_via)->hdr.s+(_via)->hdr.len)))
100
101
102
103 /* rounds to sizeof(type), but type must have a 2^k size (e.g. short, int,
104  * long, void*) */
105 #define ROUND2TYPE(s, type) \
106         (((s)+(sizeof(type)-1))&(~(sizeof(type)-1)))
107
108
109 /* rounds to sizeof(char*) - the first 4 byte multiple on 32 bit archs
110  * and the first 8 byte multiple on 64 bit archs */
111 #define ROUND_POINTER(s) ROUND2TYPE(s, char*)
112
113 /* rounds to sizeof(long) - the first 4 byte multiple on 32 bit archs
114  * and the first 8 byte multiple on 64 bit archs  (equiv. to ROUND_POINTER)*/
115 #define ROUND_LONG(s)  ROUND2TYPE(s, long)
116
117 /* rounds to sizeof(int) - the first t byte multiple on 32 and 64  bit archs */
118 #define ROUND_INT(s) ROUND2TYPE(s, int)
119
120 /* rounds to sizeof(short) - the first 2 byte multiple */
121 #define ROUND_SHORT(s) ROUND2TYPE(s, short)
122
123
124 /* params: v - either a variable name, structure member or a type
125  * returns an unsigned long containing the maximum possible value that will
126  * fit in v, if v is unsigned or converted to an unsigned version
127  * example: MAX_UVAR_VALUE(unsigned short); MAX_UVAR_VALUE(i);
128  *  MAX_UVAR_VALUE(((struct foo*)0)->bar) */
129 #define MAX_UVAR_VALUE(v) \
130         (((unsigned long)(-1))>>((sizeof(unsigned long)-sizeof(v))*8UL))
131
132
133 #define MIN_int(a, b) (((a)<(b))?(a):(b))
134 #define MAX_int(a, b) (((a)>(b))?(a):(b))
135
136 #define MIN_unsigned(a, b) (unsigned)(((unsigned)(a)<(unsigned)(b))?(a):(b))
137 #define MAX_unsigned(a, b) (unsigned)(((unsigned)(a)>(unsigned)(b))?(a):(b))
138
139 #if 0
140 #define MIN_int(a, b) ((b)+(((a)-(b))& -((a)<(b))))
141 #define MAX_int(a, b) ((a)-(((a)-(b))& -((b)>(a))))
142
143 /* depend on signed right shift result which depends on the compiler */
144 #define MIN_int(a, b) ((b)+(((a)-(b))&(((a)-(b))>>(sizeof(int)*8-1))))
145 #define MAX_int(a, b) ((a)-(((a)-(b))&(((a)-(b))>>(sizeof(int)*8-1))))
146 #endif
147
148
149 #define append_str(_dest,_src,_len)                             \
150         do{                                                                                     \
151                 memcpy( (_dest) , (_src) , (_len) );    \
152                 (_dest) += (_len) ;                                             \
153         }while(0);                                                                      \
154
155         
156 /*! append _c char to _dest string */
157 #define append_chr(_dest,_c) \
158         *((_dest)++) = _c;
159
160
161 /* links a value to a msgid */
162 struct msgid_var{
163         union{
164                 char char_val;
165                 int int_val;
166                 long long_val;
167         }u;
168         unsigned int msgid;
169 };
170
171 /* return the value or 0 if the msg_id doesn't match */
172 #define get_msgid_val(var, id, type)\
173         ((type)((type)((var).msgid!=(id))-1)&((var).u.type##_val))
174
175 #define set_msgid_val(var, id, type, value)\
176         do{\
177                 (var).msgid=(id); \
178                 (var).u.type##_val=(value); \
179         }while(0)
180
181 /* char to hex conversion table */
182 static char fourbits2char[16] = { '0', '1', '2', '3', '4', '5',
183         '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' };
184
185
186 /* converts a str to an u. short, returns the u. short and sets *err on
187  * error and if err!=null
188   */
189 static inline unsigned short str2s(const char* s, unsigned int len,
190                                                                         int *err)
191 {
192         unsigned short ret;
193         int i;
194         unsigned char *limit;
195         unsigned char* str;
196
197         /*init*/
198         str=(unsigned char*)s;
199         ret=i=0;
200         limit=str+len;
201
202         for(;str<limit ;str++){
203                 if ( (*str <= '9' ) && (*str >= '0') ){
204                                 ret=ret*10+*str-'0';
205                                 i++;
206                                 if (i>5) goto error_digits;
207                 }else{
208                                 /* error unknown char */
209                                 goto error_char;
210                 }
211         }
212         if (err) *err=0;
213         return ret;
214
215 error_digits:
216         if (err) *err=1;
217         return 0;
218 error_char:
219         if (err) *err=1;
220         return 0;
221 }
222
223
224
225 static inline int btostr( char *p,  unsigned char val)
226 {
227         unsigned int a,b,i =0;
228
229         if ( (a=val/100)!=0 )
230                 *(p+(i++)) = a+'0';         /*first digit*/
231         if ( (b=val%100/10)!=0 || a)
232                 *(p+(i++)) = b+'0';        /*second digit*/
233         *(p+(i++)) = '0'+val%10;              /*third digit*/
234
235         return i;
236 }
237
238
239 #define INT2STR_MAX_LEN  (19+1+1+1) /* 2^64~= 16*10^18 =>
240                                                                            19+1 digits + sign + \0 */
241
242 /* 
243  * returns a pointer to a static buffer containing l in asciiz (with base "base") & sets len 
244  * left padded with 0 to "size"
245  */
246 static inline char* int2str_base_0pad(unsigned int l, int* len, int base, 
247                                                                                         int size)
248 {
249         static char r[INT2STR_MAX_LEN];
250         int i, j;
251
252         if (base < 2) {
253                 BUG("base underflow\n");
254                 return NULL;
255         }
256         if (base > 36) {
257                 BUG("base overflow\n");
258                 return NULL;
259         }
260         i=INT2STR_MAX_LEN-2;
261         j=i-size;
262         r[INT2STR_MAX_LEN-1]=0; /* null terminate */
263         do{
264                 r[i]=l%base;
265                 if (r[i]<10)
266                         r[i]+='0';
267                 else
268                         r[i]+='a'-10;
269                 i--;
270                 l/=base;
271         }while((l || i>j) && (i>=0));
272         if (l && (i<0)){
273                 BUG("result buffer overflow\n");
274         }
275         if (len) *len=(INT2STR_MAX_LEN-2)-i;
276         return &r[i+1];
277 }
278
279 /* returns a pointer to a static buffer containing l in asciiz (with base "base") & sets len */
280 static inline char* int2str_base(unsigned int l, int* len, int base)
281 {
282         return int2str_base_0pad(l, len, base, 0);
283 }
284
285
286
287 /** unsigned long to str conversion using a provided buffer.
288  * Converts/prints an unsigned long to a string. The result buffer must be
289  * provided  and its length must be at least INT2STR_MAX_LEN.
290  * @param l - unsigned long to be converted
291  * @param r - pointer to result buffer
292  * @param r_size - result buffer size, must be at least INT2STR_MAX_LEN.
293  * @param *len - length of the written string, _without_ the terminating 0.
294  * @return  pointer _inside_ r, to the converted string (note: the string
295  *  is written from the end of the buffer and not from the start and hence
296  *  the returned pointer will most likely not be equal to r). In case of error
297  *  it returns 0 (the only error being insufficient provided buffer size).
298  */
299 static inline char* int2strbuf(unsigned long l, char *r, int r_size, int* len)
300 {
301         int i;
302
303         if(unlikely(r_size<INT2STR_MAX_LEN)) {
304                 if (len)
305                         *len = 0;
306                 return 0; /* => if someone misuses it => crash (feature no. 1) */
307         }
308         i=INT2STR_MAX_LEN-2;
309         r[INT2STR_MAX_LEN-1]=0; /* null terminate */
310         do{
311                 r[i]=l%10+'0';
312                 i--;
313                 l/=10;
314         }while(l && (i>=0));
315         if (l && (i<0)){
316                 LOG(L_CRIT, "BUG: int2str: overflow\n");
317         }
318         if (len) *len=(INT2STR_MAX_LEN-2)-i;
319         return &r[i+1];
320 }
321
322 extern char ut_buf_int2str[INT2STR_MAX_LEN];
323 /** interger(long) to string conversion.
324  * This version uses a static buffer (shared with sint2str()).
325  * WARNING: other function calls might overwrite the static buffer, so
326  * either always save the result immediately or use int2strbuf(...).
327  * @param l - unsigned long to be converted/printed.
328  * @param *len - will be filled with the final length (without the terminating
329  *   0).
330  * @return a pointer to a static buffer containing l in asciiz & sets len.
331  */
332 static inline char* int2str(unsigned long l, int* len)
333 {
334         return int2strbuf(l, ut_buf_int2str, INT2STR_MAX_LEN, len);
335 }
336
337
338
339 /** signed long to str conversion using a provided buffer.
340  * Converts a long to a signed string. The result buffer must be provided
341  * and its length must be at least INT2STR_MAX_LEN.
342  * @param l - long to be converted
343  * @param r - pointer to result buffer
344  * @param r_size - result buffer size, must be at least INT2STR_MAX_LEN.
345  * @param *len - length of the written string, _without_ the terminating 0.
346  * @return  pointer _inside_ r, to the converted string (note: the string
347  *  is written from the end of the buffer and not from the start and hence
348  *  the returned pointer will most likely not be equal to r). In case of error
349  *  it returns 0 (the only error being insufficient provided buffer size).
350  */
351 static inline char* sint2strbuf(long l, char* r, int r_size, int* len)
352 {
353         int sign;
354         char *p;
355         int p_len;
356
357         sign = 0;
358         if(l<0) {
359                 sign = 1;
360                 l = -l;
361         }
362         p = int2strbuf((unsigned long)l, r, r_size, &p_len);
363         if(sign && p_len<(r_size-1)) {
364                 *(--p) = '-';
365                 p_len++;;
366         }
367         if (likely(len))
368                 *len = p_len;
369         return p;
370 }
371
372
373 /** Signed INTeger-TO-STRing: converts a long to a string.
374  * This version uses a static buffer, shared with int2str().
375  * WARNING: other function calls might overwrite the static buffer, so
376  * either always save the result immediately or use sint2strbuf(...).
377  * @param l - long to be converted/printed.
378  * @param *len - will be filled with the final length (without the terminating
379  *   0).
380  * @return a pointer to a static buffer containing l in asciiz & sets len.
381  */
382 static inline char* sint2str(long l, int* len)
383 {
384         return sint2strbuf(l, ut_buf_int2str, INT2STR_MAX_LEN, len);
385 }
386
387
388
389 #define USHORT2SBUF_MAX_LEN  5 /* 65535*/
390 /* converts an unsigned short (16 bits) to asciiz
391  * returns bytes written or 0 on error
392  * the passed len must be at least USHORT2SBUF_MAX chars or error
393  * would be returned.
394  * (optimized for port conversion (4 or 5 digits most of the time)*/
395 static inline int ushort2sbuf(unsigned short u, char* buf, int len)
396 {
397         int offs;
398         unsigned char a, b, c, d;
399         
400         if (unlikely(len<USHORT2SBUF_MAX_LEN))
401                 return 0;
402         offs=0;
403         a=u/10000; u%=10000;
404         buf[offs]=a+'0'; offs+=(a!=0);
405         b=u/1000;  u%=1000;
406         buf[offs]=b+'0'; offs+=((offs|b)!=0);
407         c=u/100;   u%=100;
408         buf[offs]=c+'0'; offs+=((offs|c)!=0);
409         d=u/10;    u%=10;
410         buf[offs]=d+'0'; offs+=((offs|d)!=0);
411         buf[offs]=(unsigned char)u+'0';
412         return offs+1;
413 }
414
415
416
417 #define USHORT2STR_MAX_LEN  (USHORT2SBUF_MAX_LEN+1) /* 65535\0*/
418 /* converts an unsigned short (16 bits) to asciiz
419  * (optimized for port conversiob (4 or 5 digits most of the time)*/
420 static inline char* ushort2str(unsigned short u)
421 {
422         static char buf[USHORT2STR_MAX_LEN];
423         int len;
424
425         len=ushort2sbuf(u, buf, sizeof(buf)-1);
426         buf[len]=0;
427         return buf;
428 }
429
430
431
432 /* faster memchr version */
433 static inline char* q_memchr(char* p, int c, unsigned int size)
434 {
435         char* end;
436
437         end=p+size;
438         for(;p<end;p++){
439                 if (*p==(unsigned char)c) return p;
440         }
441         return 0;
442 }
443         
444
445 /* returns -1 on error, 1! on success (consistent with int2reverse_hex) */
446 inline static int reverse_hex2int( char *c, int len, unsigned int* res)
447 {
448         char *pc;
449         char mychar;
450
451         *res=0;
452         for (pc=c+len-1; len>0; pc--, len--) {
453                 *res <<= 4 ;
454                 mychar=*pc;
455                 if ( mychar >='0' && mychar <='9') *res+=mychar -'0';
456                 else if (mychar >='a' && mychar <='f') *res+=mychar -'a'+10;
457                 else if (mychar  >='A' && mychar <='F') *res+=mychar -'A'+10;
458                 else return -1;
459         }
460         return 1;
461 }
462
463 inline static int int2reverse_hex( char **c, int *size, unsigned int nr )
464 {
465         unsigned short digit;
466
467         if (*size && nr==0) {
468                 **c = '0';
469                 (*c)++;
470                 (*size)--;
471                 return 1;
472         }
473
474         while (*size && nr ) {
475                 digit = nr & 0xf ;
476                 **c= digit >= 10 ? digit + 'a' - 10 : digit + '0';
477                 nr >>= 4;
478                 (*c)++;
479                 (*size)--;
480         }
481         return nr ? -1 /* number not processed; too little space */ : 1;
482 }
483
484 /* double output length assumed ; does NOT zero-terminate */
485 inline static int string2hex( 
486         /* input */ unsigned char *str, int len,
487         /* output */ char *hex )
488 {
489         int orig_len;
490
491         if (len==0) {
492                 *hex='0';
493                 return 1;
494         }
495
496         orig_len=len;
497         while ( len ) {
498
499                 *hex=fourbits2char[(*str) >> 4];
500                 hex++;
501                 *hex=fourbits2char[(*str) & 0xf];
502                 hex++;
503                 len--;
504                 str++;
505
506         }
507         return orig_len-len;
508 }
509
510 /* portable sleep in microseconds (no interrupt handling now) */
511
512 inline static void sleep_us( unsigned int nusecs )
513 {
514         struct timeval tval;
515         tval.tv_sec =nusecs/1000000;
516         tval.tv_usec=nusecs%1000000;
517         select(0, NULL, NULL, NULL, &tval );
518 }
519
520
521 /* portable determination of max_path */
522 inline static int pathmax()
523 {
524 #ifdef PATH_MAX
525         static int pathmax=PATH_MAX;
526 #else
527         static int pathmax=0;
528 #endif
529         if (pathmax==0) { /* init */
530                 pathmax=pathconf("/", _PC_PATH_MAX);
531                 pathmax=(pathmax<=0)?PATH_MAX_GUESS:pathmax+1;
532         }
533         return pathmax;
534 }
535
536 inline static int hex2int(char hex_digit)
537 {
538         if (hex_digit>='0' && hex_digit<='9')
539                 return hex_digit-'0';
540         if (hex_digit>='a' && hex_digit<='f')
541                 return hex_digit-'a'+10;
542         if (hex_digit>='A' && hex_digit<='F')
543                 return hex_digit-'A'+10;
544         /* no valid hex digit ... */
545         LOG(L_ERR, "ERROR: hex2int: '%c' is no hex char\n", hex_digit );
546         return -1;
547 }
548
549 /* Un-escape URI user  -- it takes a pointer to original user
550    str, as well as the new, unescaped one, which MUST have
551    an allocated buffer linked to the 'str' structure ;
552    (the buffer can be allocated with the same length as
553    the original string -- the output string is always
554    shorter (if escaped characters occur) or same-long
555    as the original one).
556
557    only printable characters are permitted
558
559         <0 is returned on an unescaping error, length of the
560         unescaped string otherwise
561 */
562 inline static int un_escape(str *user, str *new_user ) 
563 {
564         int i, j, value;
565         int hi, lo;
566
567         if( new_user==0 || new_user->s==0) {
568                 LOG(L_CRIT, "BUG: un_escape: called with invalid param\n");
569                 return -1;
570         }
571
572         new_user->len = 0;
573         j = 0;
574
575         for (i = 0; i < user->len; i++) {
576                 if (user->s[i] == '%') {
577                         if (i + 2 >= user->len) {
578                                 LOG(L_ERR, "ERROR: un_escape: escape sequence too short in"
579                                         " '%.*s' @ %d\n",
580                                         user->len, user->s, i );
581                                 goto error;
582                         }
583                         hi=hex2int(user->s[i + 1]);
584                         if (hi<0) {
585                                 LOG(L_ERR, "ERROR: un_escape: non-hex high digit in an escape sequence in"
586                                         " '%.*s' @ %d\n",
587                                         user->len, user->s, i+1 );
588                                 goto error;
589                         }
590                         lo=hex2int(user->s[i + 2]);
591                         if (lo<0) {
592                                 LOG(L_ERR, "ERROR: non-hex low digit in an escape sequence in "
593                                         "'%.*s' @ %d\n",
594                                         user->len, user->s, i+2 );
595                                 goto error;
596                         }
597                         value=(hi<<4)+lo;
598                         if (value < 32 || value > 126) {
599                                 LOG(L_ERR, "ERROR: non-ASCII escaped character in '%.*s' @ %d\n",
600                                         user->len, user->s, i );
601                                 goto error;
602                         }
603                         new_user->s[j] = value;
604                         i+=2; /* consume the two hex digits, for cycle will move to the next char */
605                 } else {
606                         new_user->s[j] = user->s[i];
607                 }
608         j++; /* good -- we translated another character */
609         }
610         new_user->len = j;
611         return j;
612
613 error:
614         new_user->len = j;
615         return -1;
616
617
618
619 /*
620  * Convert a string to lower case
621  */
622 static inline void strlower(str* _s)
623 {
624         int i;
625
626         for(i = 0; i < _s->len; i++) {
627                 _s->s[i] = tolower(_s->s[i]);
628         }
629 }
630
631
632 /*
633  * Convert a str into integer
634  */
635 static inline int str2int(str* _s, unsigned int* _r)
636 {
637         int i;
638         
639         *_r = 0;
640         for(i = 0; i < _s->len; i++) {
641                 if ((_s->s[i] >= '0') && (_s->s[i] <= '9')) {
642                         *_r *= 10;
643                         *_r += _s->s[i] - '0';
644                 } else {
645                         return -1;
646                 }
647         }
648         
649         return 0;
650 }
651
652 /*
653  * Convert an str to signed integer
654  */
655 static inline int str2sint(str* _s, int* _r)
656 {
657         int i;
658         int sign;
659
660         if (_s->len == 0) return -1;
661
662         *_r = 0;
663         sign = 1;
664         i = 0;
665         if (_s->s[0] == '+') {
666                 i++;
667         } else if (_s->s[0] == '-') {
668                 sign = -1;
669                 i++;
670         }
671         for(; i < _s->len; i++) {
672                 if ((_s->s[i] >= '0') && (_s->s[i] <= '9')) {
673                         *_r *= 10;
674                         *_r += _s->s[i] - '0';
675                 } else {
676                         return -1;
677                 }
678         }
679         *_r *= sign;
680
681         return 0;
682 }
683
684
685
686 #ifdef SHM_MEM
687 /**
688  * \brief Make a copy of a str structure using shm_malloc
689  * \param dst destination
690  * \param src source
691  * \return 0 on success, -1 on failure
692  */
693 static inline int shm_str_dup(str* dst, const str* src)
694 {
695         dst->s = shm_malloc(src->len);
696         if (!dst->s) {
697                 SHM_MEM_ERROR;
698                 return -1;
699         }
700
701         memcpy(dst->s, src->s, src->len);
702         dst->len = src->len;
703         return 0;
704 }
705 #endif /* SHM_MEM */
706
707
708
709 /**
710  * \brief Make a copy of a str structure using pkg_malloc
711  * \param dst destination
712  * \param src source
713  * \return 0 on success, -1 on failure
714  */
715 static inline int pkg_str_dup(str* dst, const str* src)
716 {
717         dst->s = pkg_malloc(src->len);
718         if (dst->s==NULL)
719         {
720                 PKG_MEM_ERROR;
721                 return -1;
722         }
723
724         memcpy(dst->s, src->s, src->len);
725         dst->len = src->len;
726         return 0;
727 }
728
729 /**
730  * \brief Compare two str's case sensitive
731  * \param str1 first str
732  * \param str2 second str
733  * \return 0 if both are equal, positive if str1 is greater, negative if str2 is greater, -2 on errors
734  */
735 static inline int str_strcmp(const str *str1, const str *str2)
736 {
737         if(str1==NULL || str2==NULL || str1->s ==NULL || str2->s==NULL || str1->len<0 || str2->len<0)
738         {
739                 LM_ERR("bad parameters\n");
740                 return -2;
741         }
742
743         if (str1->len < str2->len)
744                 return -1;
745         else if (str1->len > str2->len)
746                 return 1;
747         else
748                 return strncmp(str1->s, str2->s, str1->len);
749 }
750
751 /**
752  * \brief Compare two str's case insensitive
753  * \param str1 first str
754  * \param str2 second str
755  * \return 0 if both are equal, positive if str1 is greater, negative if str2 is greater, -2 on errors
756  */
757 static inline int str_strcasecmp(const str *str1, const str *str2)
758 {
759         if(str1==NULL || str2==NULL || str1->s ==NULL || str2->s==NULL || str1->len<0 || str2->len<0)
760         {
761                 LM_ERR("bad parameters\n");
762                 return -2;
763         }
764         if (str1->len < str2->len)
765                 return -1;
766         else if (str1->len > str2->len)
767                 return 1;
768         else
769                 return strncasecmp(str1->s, str2->s, str1->len);
770 }
771
772 /* converts a username into uid:gid,
773  * returns -1 on error & 0 on success */
774 int user2uid(int* uid, int* gid, char* user);
775
776 /* converts a group name into a gid
777  * returns -1 on error, 0 on success */
778 int group2gid(int* gid, char* group);
779
780 /*
781  * Replacement of timegm (does not exists on all platforms
782  * Taken from 
783  * http://lists.samba.org/archive/samba-technical/2002-November/025737.html
784  */
785 time_t _timegm(struct tm* t);
786
787 /* Convert time_t value that is relative to local timezone to UTC */
788 time_t local2utc(time_t in);
789
790 /* Convert time_t value in UTC to to value relative to local time zone */
791 time_t utc2local(time_t in);
792
793 /*
794  * Return str as zero terminated string allocated
795  * using pkg_malloc
796  */
797 char* as_asciiz(str* s);
798
799
800 /* return system version (major.minor.minor2) as
801  *  (major<<16)|(minor)<<8|(minor2)
802  * (if some of them are missing, they are set to 0)
803  * if the parameters are not null they are set to the coresp. part */
804 unsigned int get_sys_version(int* major, int* minor, int* minor2);
805
806 /** Converts relative pathnames to absolute pathnames. This function returns
807  * the full pathname of a file in parameter. If the file pathname does not
808  * start with / then it will be converted into an absolute pathname. The
809  * function gets the absolute directory pathname from \c base and appends \c
810  * file to it. The first parameter can be NULL, in this case the function will
811  * use the location of the main SER configuration file as reference.
812  * @param base filename to be used as reference when \c file is relative. It
813  *             must be absolute. The location of the SER configuration file
814  *             will be used as reference if you set the value of this
815  *             parameter to NULL.
816  * @param file A pathname to be converted to absolute.
817  * @return A string containing absolute pathname, the string must be freed
818  * with free. NULL on error.
819  */
820 char* get_abs_pathname(str* base, str* file);
821
822 /**
823  * search for needle in text
824  */
825 char *str_search(str *text, str *needle);
826 #endif