release/src/router/transmission/libtransmission/utils.h

   1 /*
   2  * This file Copyright (C) Mnemosyne LLC
   3  *
   4  * This file is licensed by the GPL version 2. Works owned by the
   5  * Transmission project are granted a special exemption to clause 2(b)
   6  * so that the bulk of its code can remain under the MIT license.
   7  * This exemption does not extend to derived works not owned by
   8  * the Transmission project.
   9  *
  10  * $Id: utils.h 13084 2011-11-12 00:16:04Z jordan $
  11  */
  12
  13 #ifndef TR_UTILS_H
  14 #define TR_UTILS_H 1
  15
  16 #include <inttypes.h>
  17 #include <stddef.h> /* size_t */
  18 #include <time.h> /* time_t */
  19
  20 #ifdef __cplusplus
  21 extern "C" {
  22 #endif
  23
  24 /***
  25 ****
  26 ***/
  27
  28 /**
  29  * @addtogroup utils Utilities
  30  * @{
  31  */
  32
  33 #ifndef UNUSED
  34  #ifdef __GNUC__
  35   #define UNUSED __attribute__ ( ( unused ) )
  36  #else
  37   #define UNUSED
  38  #endif
  39 #endif
  40
  41 #ifndef TR_GNUC_PRINTF
  42  #ifdef __GNUC__
  43   #define TR_GNUC_PRINTF( fmt, args ) __attribute__ ( ( format ( printf, fmt, args ) ) )
  44  #else
  45   #define TR_GNUC_PRINTF( fmt, args )
  46  #endif
  47 #endif
  48
  49 #ifndef TR_GNUC_NONNULL
  50  #ifdef __GNUC__
  51   #define TR_GNUC_NONNULL( ... ) __attribute__((nonnull (__VA_ARGS__)))
  52  #else
  53   #define TR_GNUC_NONNULL( ... )
  54  #endif
  55 #endif
  56
  57 #ifndef TR_GNUC_NULL_TERMINATED
  58  #if __GNUC__ > 4 || ( __GNUC__ == 4 && __GNUC_MINOR__ >= 3 )
  59   #define TR_GNUC_NULL_TERMINATED __attribute__ ( ( __sentinel__ ) )
  60   #define TR_GNUC_HOT __attribute ( ( hot ) )
  61  #else
  62   #define TR_GNUC_NULL_TERMINATED
  63   #define TR_GNUC_HOT
  64  #endif
  65 #endif
  66
  67 #if __GNUC__ > 2 || ( __GNUC__ == 2 && __GNUC_MINOR__ >= 96 )
  68  #define TR_GNUC_MALLOC __attribute__ ( ( __malloc__ ) )
  69 #else
  70  #define TR_GNUC_MALLOC
  71 #endif
  72
  73
  74 /***
  75 ****
  76 ***/
  77
  78 const char * tr_strip_positional_args( const char * fmt );
  79
  80 #if !defined( _ )
  81  #if defined( HAVE_LIBINTL_H ) && !defined( SYS_DARWIN )
  82   #include <libintl.h>
  83   #define _( a ) gettext ( a )
  84  #else
  85   #define _( a ) ( a )
  86  #endif
  87 #endif
  88
  89 /* #define DISABLE_GETTEXT */
  90 #ifndef DISABLE_GETTEXT
  91  #if defined(WIN32) || defined(TR_LIGHTWEIGHT)
  92    #define DISABLE_GETTEXT
  93  #endif
  94 #endif
  95 #ifdef DISABLE_GETTEXT
  96  #undef _
  97  #define _( a ) tr_strip_positional_args( a )
  98 #endif
  99
 100 /****
 101 *****
 102 ****/
 103
 104 #define TR_MAX_MSG_LOG 10000
 105
 106 extern tr_msg_level __tr_message_level;
 107
 108 static inline tr_msg_level tr_getMessageLevel( void )
 109 {
 110     return __tr_message_level;
 111 }
 112
 113 static inline bool tr_msgLoggingIsActive( tr_msg_level level )
 114 {
 115     return tr_getMessageLevel() >= level;
 116 }
 117
 118 void tr_msg( const char * file, int line,
 119              tr_msg_level level,
 120              const char * torrent,
 121              const char * fmt, ... ) TR_GNUC_PRINTF( 5, 6 );
 122
 123 #define tr_nerr( n, ... ) \
 124     do { \
 125         if( tr_msgLoggingIsActive( TR_MSG_ERR ) ) \
 126             tr_msg( __FILE__, __LINE__, TR_MSG_ERR, n, __VA_ARGS__ ); \
 127     } while( 0 )
 128
 129 #define tr_ninf( n, ... ) \
 130     do { \
 131         if( tr_msgLoggingIsActive( TR_MSG_INF) ) \
 132             tr_msg( __FILE__, __LINE__, TR_MSG_INF, n, __VA_ARGS__ ); \
 133     } while( 0 )
 134
 135 #define tr_ndbg( n, ... ) \
 136     do { \
 137         if( tr_msgLoggingIsActive( TR_MSG_DBG) ) \
 138             tr_msg( __FILE__, __LINE__, TR_MSG_DBG, n, __VA_ARGS__ ); \
 139     } while( 0 )
 140
 141 #define tr_torerr( tor, ... ) \
 142     do { \
 143         if( tr_msgLoggingIsActive( TR_MSG_ERR ) ) \
 144             tr_msg( __FILE__, __LINE__, TR_MSG_ERR, tor->info.name, __VA_ARGS__ ); \
 145     } while( 0 )
 146
 147 #define tr_torinf( tor, ... ) \
 148     do { \
 149         if( tr_msgLoggingIsActive( TR_MSG_INF ) ) \
 150             tr_msg( __FILE__, __LINE__, TR_MSG_INF, tor->info.name, __VA_ARGS__ ); \
 151     } while( 0 )
 152
 153 #define tr_tordbg( tor, ... ) \
 154     do { \
 155         if( tr_msgLoggingIsActive( TR_MSG_DBG ) ) \
 156             tr_msg( __FILE__, __LINE__, TR_MSG_DBG, tor->info.name, __VA_ARGS__ ); \
 157     } while( 0 )
 158
 159 #define tr_err( ... ) \
 160     do { \
 161         if( tr_msgLoggingIsActive( TR_MSG_ERR ) ) \
 162             tr_msg( __FILE__, __LINE__, TR_MSG_ERR, NULL, __VA_ARGS__ ); \
 163     } while( 0 )
 164
 165 #define tr_inf( ... ) \
 166     do { \
 167         if( tr_msgLoggingIsActive( TR_MSG_INF ) ) \
 168             tr_msg( __FILE__, __LINE__, TR_MSG_INF, NULL, __VA_ARGS__ ); \
 169     } while( 0 )
 170
 171 #define tr_dbg( ... ) \
 172     do { \
 173         if( tr_msgLoggingIsActive( TR_MSG_DBG ) ) \
 174             tr_msg( __FILE__, __LINE__, TR_MSG_DBG, NULL, __VA_ARGS__ ); \
 175     } while( 0 )
 176
 177
 178
 179 void* tr_getLog( void );
 180
 181 /** @brief return true if deep logging has been enabled by the user; false otherwise */
 182 bool tr_deepLoggingIsActive( void );
 183
 184 void           tr_deepLog( const char * file,
 185                            int          line,
 186                            const char * name,
 187                            const char * fmt,
 188                            ... ) TR_GNUC_PRINTF( 4, 5 ) TR_GNUC_NONNULL(1,4);
 189
 190 /** @brief set the buffer with the current time formatted for deep logging. */
 191 char* tr_getLogTimeStr( char * buf, int buflen ) TR_GNUC_NONNULL(1);
 192
 193
 194 /**
 195  * @brief Rich Salz's classic implementation of shell-style pattern matching for ?, \, [], and * characters.
 196  * @return 1 if the pattern matches, 0 if it doesn't, or -1 if an error occured
 197  */
 198 bool tr_wildmat( const char * text, const char * pattern ) TR_GNUC_NONNULL(1,2);
 199
 200 /** @brief Portability wrapper for basename() that uses the system implementation if available */
 201 char* tr_basename( const char * path ) TR_GNUC_MALLOC;
 202
 203 /** @brief Portability wrapper for dirname() that uses the system implementation if available */
 204 char* tr_dirname( const char * path ) TR_GNUC_MALLOC;
 205
 206 /**
 207  * @brief Portability wrapper for mkdir()
 208  *
 209  * A portability wrapper around mkdir().
 210  * On WIN32, the `permissions' argument is unused.
 211  *
 212  * @return zero on success, or -1 if an error occurred
 213  * (in which case errno is set appropriately).
 214  */
 215 int tr_mkdir( const char * path, int permissions ) TR_GNUC_NONNULL(1);
 216
 217 /**
 218  * Like mkdir, but makes parent directories as needed.
 219  *
 220  * @return zero on success, or -1 if an error occurred
 221  * (in which case errno is set appropriately).
 222  */
 223 int tr_mkdirp( const char * path, int permissions ) TR_GNUC_NONNULL(1);
 224
 225 /** @brief Portability wrapper for mkdtemp() that uses the system implementation if available */
 226 char* tr_mkdtemp( char * _template );
 227
 228
 229 /**
 230  * @brief Loads a file and returns its contents.
 231  * On failure, NULL is returned and errno is set.
 232  */
 233 uint8_t* tr_loadFile( const char * filename, size_t * size ) TR_GNUC_MALLOC
 234                                                              TR_GNUC_NONNULL(1);
 235
 236
 237 /** @brief build a filename from a series of elements using the
 238            platform's correct directory separator. */
 239 char* tr_buildPath( const char * first_element, ... ) TR_GNUC_NULL_TERMINATED
 240                                                       TR_GNUC_MALLOC;
 241
 242 struct event;
 243
 244 /**
 245  * @brief Convenience wrapper around timer_add() to have a timer wake up in a number of seconds and microseconds
 246  * @param timer
 247  * @param seconds
 248  * @param microseconds
 249  */
 250 void tr_timerAdd( struct event * timer, int seconds, int microseconds ) TR_GNUC_NONNULL(1);
 251
 252 /**
 253  * @brief Convenience wrapper around timer_add() to have a timer wake up in a number of milliseconds
 254  * @param timer
 255  * @param milliseconds
 256  */
 257 void tr_timerAddMsec( struct event * timer, int milliseconds ) TR_GNUC_NONNULL(1);
 258
 259
 260 /** @brief return the current date in milliseconds */
 261 uint64_t tr_time_msec( void );
 262
 263 /** @brief sleep the specified number of milliseconds */
 264 void tr_wait_msec( long int delay_milliseconds );
 265
 266 /**
 267  * @brief make a copy of 'str' whose non-utf8 content has been corrected or stripped
 268  * @return a newly-allocated string that must be freed with tr_free()
 269  * @param str the string to make a clean copy of
 270  * @param len the length of the string to copy. If -1, the entire string is used.
 271  */
 272 char* tr_utf8clean( const char * str, int len ) TR_GNUC_MALLOC;
 273
 274
 275 /***
 276 ****
 277 ***/
 278
 279 /* Sometimes the system defines MAX/MIN, sometimes not.
 280    In the latter case, define those here since we will use them */
 281 #ifndef MAX
 282  #define MAX( a, b ) ( ( a ) > ( b ) ? ( a ) : ( b ) )
 283 #endif
 284 #ifndef MIN
 285  #define MIN( a, b ) ( ( a ) > ( b ) ? ( b ) : ( a ) )
 286 #endif
 287
 288 /***
 289 ****
 290 ***/
 291
 292 /** @brief Portability wrapper around malloc() in which `0' is a safe argument */
 293 void* tr_malloc( size_t size );
 294
 295 /** @brief Portability wrapper around calloc() in which `0' is a safe argument */
 296 void* tr_malloc0( size_t size );
 297
 298 /** @brief Portability wrapper around free() in which `NULL' is a safe argument */
 299 void tr_free( void * p );
 300
 301 /**
 302  * @brief make a newly-allocated copy of a chunk of memory
 303  * @param src the memory to copy
 304  * @param byteCount the number of bytes to copy
 305  * @return a newly-allocated copy of `src' that can be freed with tr_free()
 306  */
 307 void* tr_memdup( const void * src, size_t byteCount );
 308
 309 #define tr_new( struct_type, n_structs )           \
 310     ( (struct_type *) tr_malloc ( sizeof ( struct_type ) * ( ( size_t) ( n_structs ) ) ) )
 311
 312 #define tr_new0( struct_type, n_structs )          \
 313     ( (struct_type *) tr_malloc0 ( sizeof ( struct_type ) * ( ( size_t) ( n_structs ) ) ) )
 314
 315 #define tr_renew( struct_type, mem, n_structs )    \
 316     ( (struct_type *) realloc ( ( mem ), sizeof ( struct_type ) * ( ( size_t) ( n_structs ) ) ) )
 317
 318 void* tr_valloc( size_t bufLen );
 319
 320 /**
 321  * @brief make a newly-allocated copy of a substring
 322  * @param in is a void* so that callers can pass in both signed & unsigned without a cast
 323  * @param len length of the substring to copy. if a length less than zero is passed in, strlen( len ) is used
 324  * @return a newly-allocated copy of `in' that can be freed with tr_free()
 325  */
 326 char* tr_strndup( const void * in, int len ) TR_GNUC_MALLOC;
 327
 328 /**
 329  * @brief make a newly-allocated copy of a string
 330  * @param in is a void* so that callers can pass in both signed & unsigned without a cast
 331  * @return a newly-allocated copy of `in' that can be freed with tr_free()
 332  */
 333 char* tr_strdup( const void * in );
 334
 335 /**
 336  * @brief like strcmp() but gracefully handles NULL strings
 337  */
 338 int tr_strcmp0( const char * str1, const char * str2 );
 339
 340
 341
 342 struct evbuffer;
 343
 344 char* evbuffer_free_to_str( struct evbuffer * buf );
 345
 346 /** @brief similar to bsearch() but returns the index of the lower bound */
 347 int tr_lowerBound( const void * key,
 348                    const void * base,
 349                    size_t       nmemb,
 350                    size_t       size,
 351                    int       (* compar)(const void* key, const void* arrayMember),
 352                    bool       * exact_match ) TR_GNUC_HOT TR_GNUC_NONNULL(1,5,6);
 353
 354
 355 /**
 356  * @brief sprintf() a string into a newly-allocated buffer large enough to hold it
 357  * @return a newly-allocated string that can be freed with tr_free()
 358  */
 359 char* tr_strdup_printf( const char * fmt, ... ) TR_GNUC_PRINTF( 1, 2 )
 360                                                 TR_GNUC_MALLOC;
 361
 362 /**
 363  * @brief Translate a block of bytes into base64
 364  * @return a newly-allocated string that can be freed with tr_free()
 365  */
 366 char* tr_base64_encode( const void * input,
 367                         int          inlen,
 368                         int        * outlen ) TR_GNUC_MALLOC;
 369
 370 /**
 371  * @brief Translate a block of bytes from base64 into raw form
 372  * @return a newly-allocated string that can be freed with tr_free()
 373  */
 374 char* tr_base64_decode( const void * input,
 375                         int          inlen,
 376                         int        * outlen ) TR_GNUC_MALLOC;
 377
 378 /** @brief Portability wrapper for strlcpy() that uses the system implementation if available */
 379 size_t tr_strlcpy( char * dst, const void * src, size_t siz );
 380
 381 /** @brief Portability wrapper for snprintf() that uses the system implementation if available */
 382 int tr_snprintf( char * buf, size_t buflen,
 383                  const char * fmt, ... ) TR_GNUC_PRINTF( 3, 4 ) TR_GNUC_NONNULL(1,3);
 384
 385 /** @brief Convenience wrapper around strerorr() guaranteed to not return NULL
 386     @param errno */
 387 const char* tr_strerror( int );
 388
 389 /** @brief strips leading and trailing whitspace from a string
 390     @return the stripped string */
 391 char* tr_strstrip( char * str );
 392
 393 /** @brief Returns true if the string ends with the specified case-insensitive suffix */
 394 bool tr_str_has_suffix( const char *str, const char *suffix );
 395
 396
 397 /** @brief Portability wrapper for memmem() that uses the system implementation if available */
 398 const char* tr_memmem( const char * haystack, size_t haystack_len,
 399                        const char * needle, size_t needle_len );
 400
 401 /** @brief Portability wrapper for strsep() that uses the system implementation if available */
 402 char* tr_strsep( char ** str, const char * delim );
 403
 404 /***
 405 ****
 406 ***/
 407
 408 int compareInt( const void * va, const void * vb );
 409
 410 void tr_sha1_to_hex( char * out, const uint8_t * sha1 ) TR_GNUC_NONNULL(1,2);
 411
 412 void tr_hex_to_sha1( uint8_t * out, const char * hex ) TR_GNUC_NONNULL(1,2);
 413
 414 /** @brief convenience function to determine if an address is an IP address (IPv4 or IPv6) */
 415 bool tr_addressIsIP( const char * address );
 416
 417 /** @brief return true if the url is a http or https url that Transmission understands */
 418 bool tr_urlIsValidTracker( const char * url ) TR_GNUC_NONNULL(1);
 419
 420 /** @brief return true if the url is a [ http, https, ftp, ftps ] url that Transmission understands */
 421 bool tr_urlIsValid( const char * url, int url_len ) TR_GNUC_NONNULL(1);
 422
 423 /** @brief parse a URL into its component parts
 424     @return zero on success or an error number if an error occurred */
 425 int  tr_urlParse( const char * url,
 426                   int          url_len,
 427                   char      ** setme_scheme,
 428                   char      ** setme_host,
 429                   int        * setme_port,
 430                   char      ** setme_path ) TR_GNUC_NONNULL(1);
 431
 432
 433 /** @brief return TR_RATIO_NA, TR_RATIO_INF, or a number in [0..1]
 434     @return TR_RATIO_NA, TR_RATIO_INF, or a number in [0..1] */
 435 double tr_getRatio( uint64_t numerator, uint64_t denominator );
 436
 437 /**
 438  * @brief Given a string like "1-4" or "1-4,6,9,14-51", this returns a
 439  *        newly-allocated array of all the integers in the set.
 440  * @return a newly-allocated array of integers that must be freed with tr_free(),
 441  *         or NULL if a fragment of the string can't be parsed.
 442  *
 443  * For example, "5-8" will return [ 5, 6, 7, 8 ] and setmeCount will be 4.
 444  */
 445 int* tr_parseNumberRange( const char * str,
 446                           int str_len,
 447                           int * setmeCount ) TR_GNUC_MALLOC TR_GNUC_NONNULL(1);
 448
 449
 450 /**
 451  * @brief truncate a double value at a given number of decimal places.
 452  *
 453  * this can be used to prevent a printf() call from rounding up:
 454  * call with the decimal_places argument equal to the number of
 455  * decimal places in the printf()'s precision:
 456  *
 457  * - printf("%.2f%%",           99.999    ) ==> "100.00%"
 458  *
 459  * - printf("%.2f%%", tr_truncd(99.999, 2)) ==>  "99.99%"
 460  *             ^                        ^
 461  *             |   These should match   |
 462  *             +------------------------+
 463  */
 464 double tr_truncd( double x, int decimal_places );
 465
 466 /* return a percent formatted string of either x.xx, xx.x or xxx */
 467 char* tr_strpercent( char * buf, double x, size_t buflen );
 468
 469 /**
 470  * @param buf the buffer to write the string to
 471  * @param buflef buf's size
 472  * @param ratio the ratio to convert to a string
 473  * @param the string represntation of "infinity"
 474  */
 475 char* tr_strratio( char * buf, size_t buflen, double ratio, const char * infinity ) TR_GNUC_NONNULL(1,4);
 476
 477 /** @brief Portability wrapper for localtime_r() that uses the system implementation if available */
 478 struct tm * tr_localtime_r( const time_t *_clock, struct tm *_result );
 479
 480
 481 /**
 482  * @brief move a file
 483  * @return 0 on success; otherwise, return -1 and set errno
 484  */
 485 int tr_moveFile( const char * oldpath, const char * newpath,
 486                  bool * renamed ) TR_GNUC_NONNULL(1,2);
 487
 488 /** @brief Test to see if the two filenames point to the same file. */
 489 bool tr_is_same_file( const char * filename1, const char * filename2 );
 490
 491 /** @brief convenience function to remove an item from an array */
 492 void tr_removeElementFromArray( void         * array,
 493                                 unsigned int   index_to_remove,
 494                                 size_t         sizeof_element,
 495                                 size_t         nmemb );
 496
 497 /***
 498 ****
 499 ***/
 500
 501 /** @brief Private libtransmission variable that's visible only for inlining in tr_time() */
 502 extern time_t __tr_current_time;
 503
 504 /**
 505  * @brief very inexpensive form of time(NULL)
 506  * @return the current epoch time in seconds
 507  *
 508  * This function returns a second counter that is updated once per second.
 509  * If something blocks the libtransmission thread for more than a second,
 510  * that counter may be thrown off, so this function is not guaranteed
 511  * to always be accurate. However, it is *much* faster when 100% accuracy
 512  * isn't needed
 513  */
 514 static inline time_t tr_time( void ) { return __tr_current_time; }
 515
 516 /** @brief Private libtransmission function to update tr_time()'s counter */
 517 static inline void tr_timeUpdate( time_t now ) { __tr_current_time = now; }
 518
 519 #ifdef WIN32
 520  #include <windef.h> /* MAX_PATH */
 521  #define TR_PATH_MAX (MAX_PATH + 1)
 522 #else
 523  #include <limits.h> /* PATH_MAX */
 524  #ifdef PATH_MAX
 525   #define TR_PATH_MAX PATH_MAX
 526  #else
 527   #define TR_PATH_MAX 4096
 528  #endif
 529 #endif
 530
 531 /** @brief Portability wrapper for realpath() that uses the system implementation if available.
 532     @param resolved_path should be TR_PATH_MAX or larger */
 533 char* tr_realpath( const char *path, char * resolved_path );
 534
 535 /** @brief Portability wrapper for htonll() that uses the system implementation if available */
 536 uint64_t tr_htonll( uint64_t );
 537
 538 /** @brief Portability wrapper for htonll() that uses the system implementation if available */
 539 uint64_t tr_ntohll( uint64_t );
 540
 541 /***
 542 ****
 543 ***/
 544
 545 /* example: tr_formatter_size_init( 1024, _("KiB"), _("MiB"), _("GiB"), _("TiB") ); */
 546
 547 void tr_formatter_size_init( unsigned int kilo, const char * kb, const char * mb,
 548                                                 const char * gb, const char * tb );
 549
 550 void tr_formatter_speed_init( unsigned int kilo, const char * kb, const char * mb,
 551                                                  const char * gb, const char * tb );
 552
 553 void tr_formatter_mem_init( unsigned int kilo, const char * kb, const char * mb,
 554                                                const char * gb, const char * tb );
 555
 556 extern unsigned int tr_speed_K;
 557 extern unsigned int tr_mem_K;
 558 extern unsigned int tr_size_K;
 559
 560 /* format a speed from KBps into a user-readable string. */
 561 char* tr_formatter_speed_KBps( char * buf, double KBps, size_t buflen );
 562
 563 /* format a memory size from bytes into a user-readable string. */
 564 char* tr_formatter_mem_B( char * buf, int64_t bytes, size_t buflen );
 565
 566 /* format a memory size from MB into a user-readable string. */
 567 static inline char* tr_formatter_mem_MB( char * buf, double MBps, size_t buflen ) { return tr_formatter_mem_B( buf, MBps * tr_mem_K * tr_mem_K, buflen ); }
 568
 569 /* format a file size from bytes into a user-readable string. */
 570 char* tr_formatter_size_B( char * buf, int64_t bytes, size_t buflen );
 571
 572 void tr_formatter_get_units( struct tr_benc * dict );
 573
 574 /***
 575 ****
 576 ***/
 577
 578 #ifdef __cplusplus
 579 }
 580 #endif
 581
 582 /** @} */
 583
 584 #endif