Skip to content
This repository
tree: 7a57ad0177
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

executable file 1564 lines (1222 sloc) 41.429 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563
#import "DDLog.h"

#import <pthread.h>
#import <objc/runtime.h>
#import <mach/mach_host.h>
#import <mach/host_info.h>
#import <libkern/OSAtomic.h>


/**
* Welcome to Cocoa Lumberjack!
*
* The Google Code page has a wealth of documentation if you have any questions.
* http://code.google.com/p/cocoalumberjack/
*
* If you're new to the project you may wish to read the "Getting Started" page.
* http://code.google.com/p/cocoalumberjack/wiki/GettingStarted
*
**/

// We probably shouldn't be using DDLog() statements within the DDLog implementation.
// But we still want to leave our log statements for any future debugging,
// and to allow other developers to trace the implementation (which is a great learning tool).
//
// So we use a primitive logging macro around NSLog.
// We maintain the NS prefix on the macros to be explicit about the fact that we're using NSLog.

#define DD_DEBUG NO

#define NSLogDebug(frmt, ...) do{ if(DD_DEBUG) NSLog((frmt), ##__VA_ARGS__); } while(0)

// Specifies the maximum queue size of the logging thread.
//
// Since most logging is asynchronous, its possible for rogue threads to flood the logging queue.
// That is, to issue an abundance of log statements faster than the logging thread can keepup.
// Typically such a scenario occurs when log statements are added haphazardly within large loops,
// but may also be possible if relatively slow loggers are being used.
//
// This property caps the queue size at a given number of outstanding log statements.
// If a thread attempts to issue a log statement when the queue is already maxed out,
// the issuing thread will block until the queue size drops below the max again.

#define LOG_MAX_QUEUE_SIZE 1000 // Should not exceed INT32_MAX


#if GCD_MAYBE_AVAILABLE
@interface DDLoggerNode : NSObject {
@public
id <DDLogger> logger;
dispatch_queue_t loggerQueue;
}

+ (DDLoggerNode *)nodeWithLogger:(id <DDLogger>)logger loggerQueue:(dispatch_queue_t)loggerQueue;

@end
#endif


@interface DDLog (PrivateAPI)

+ (void)lt_addLogger:(id <DDLogger>)logger;
+ (void)lt_removeLogger:(id <DDLogger>)logger;
+ (void)lt_removeAllLoggers;
+ (void)lt_log:(DDLogMessage *)logMessage;
+ (void)lt_flush;

@end

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
#pragma mark -
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

@implementation DDLog

  // An array used to manage all the individual loggers.
  // The array is only modified on the loggingQueue/loggingThread.
  static NSMutableArray *loggers;

#if GCD_MAYBE_AVAILABLE

  // All logging statements are added to the same queue to ensure FIFO operation.
  static dispatch_queue_t loggingQueue;

  // Individual loggers are executed concurrently per log statement.
  // Each logger has it's own associated queue, and a dispatch group is used for synchrnoization.
  static dispatch_group_t loggingGroup;

  // In order to prevent to queue from growing infinitely large,
  // a maximum size is enforced (LOG_MAX_QUEUE_SIZE).
  static dispatch_semaphore_t queueSemaphore;

  // Minor optimization for uniprocessor machines
  static unsigned int numProcessors;

#endif

#if GCD_MAYBE_UNAVAILABLE

  // All logging statements are queued onto the same thread to ensure FIFO operation.
  static NSThread *loggingThread;

  // In order to prevent to queue from growing infinitely large,
  // a maximum size is enforced (LOG_MAX_QUEUE_SIZE).
  static int32_t queueSize; // Incremented and decremented locklessly using OSAtomic operations
  static NSCondition *condition; // Not used unless the queueSize exceeds its max
  static NSMutableArray *blockedThreads; // Not used unless the queueSize exceeds its max

#endif

/**
* The runtime sends initialize to each class in a program exactly one time just before the class,
* or any class that inherits from it, is sent its first message from within the program. (Thus the
* method may never be invoked if the class is not used.) The runtime sends the initialize message to
* classes in a thread-safe manner. Superclasses receive this message before their subclasses.
*
* This method may also be called directly (assumably by accident), hence the safety mechanism.
**/
+ (void)initialize
{
static BOOL initialized = NO;
if (!initialized)
{
initialized = YES;

loggers = [[NSMutableArray alloc] initWithCapacity:4];

if (IS_GCD_AVAILABLE)
{
#if GCD_MAYBE_AVAILABLE

NSLogDebug(@"DDLog: Using grand central dispatch");

loggingQueue = dispatch_queue_create("cocoa.lumberjack", NULL);
loggingGroup = dispatch_group_create();

queueSemaphore = dispatch_semaphore_create(LOG_MAX_QUEUE_SIZE);

// Figure out how many processors are available.
// This may be used later for an optimization on uniprocessor machines.

host_basic_info_data_t hostInfo;
mach_msg_type_number_t infoCount;

infoCount = HOST_BASIC_INFO_COUNT;
host_info(mach_host_self(), HOST_BASIC_INFO, (host_info_t)&hostInfo, &infoCount);

unsigned int result = (unsigned int)(hostInfo.max_cpus);
unsigned int one = (unsigned int)(1);

numProcessors = MAX(result, one);

NSLogDebug(@"DDLog: numProcessors = %u", numProcessors);
#endif
}
else
{
#if GCD_MAYBE_UNAVAILABLE

NSLogDebug(@"DDLog: GCD not available");

loggingThread = [[NSThread alloc] initWithTarget:self selector:@selector(lt_main:) object:nil];
[loggingThread start];

queueSize = 0;

condition = [[NSCondition alloc] init];
blockedThreads = [[NSMutableArray alloc] init];
#endif
}
#if TARGET_OS_IPHONE
NSString *notificationName = @"UIApplicationWillTerminateNotification";
#else
NSString *notificationName = @"NSApplicationWillTerminateNotification";
#endif

[[NSNotificationCenter defaultCenter] addObserver:self
selector:@selector(applicationWillTerminate:)
name:notificationName
object:nil];
}
}

#if GCD_MAYBE_AVAILABLE

/**
* Provides access to the logging queue.
**/
+ (dispatch_queue_t)loggingQueue
{
return loggingQueue;
}

#endif

#if GCD_MAYBE_UNAVAILABLE

/**
* Provides access to the logging thread.
**/
+ (NSThread *)loggingThread
{
return loggingThread;
}

#endif

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
#pragma mark Notifications
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

+ (void)applicationWillTerminate:(NSNotification *)notification
{
[self flushLog];
}

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
#pragma mark Logger Management
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

+ (void)addLogger:(id <DDLogger>)logger
{
if (logger == nil) return;

if (IS_GCD_AVAILABLE)
{
#if GCD_MAYBE_AVAILABLE

dispatch_block_t addLoggerBlock = ^{
NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];

[self lt_addLogger:logger];

[pool drain];
};

dispatch_async(loggingQueue, addLoggerBlock);
#endif
}
else
{
#if GCD_MAYBE_UNAVAILABLE

[self performSelector:@selector(lt_addLogger:) onThread:loggingThread withObject:logger waitUntilDone:NO];
#endif
}
}

+ (void)removeLogger:(id <DDLogger>)logger
{
if (logger == nil) return;

if (IS_GCD_AVAILABLE)
{
#if GCD_MAYBE_AVAILABLE

dispatch_block_t removeLoggerBlock = ^{
NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];

[self lt_removeLogger:logger];

[pool drain];
};

dispatch_async(loggingQueue, removeLoggerBlock);
#endif
}
else
{
#if GCD_MAYBE_UNAVAILABLE

[self performSelector:@selector(lt_removeLogger:) onThread:loggingThread withObject:logger waitUntilDone:NO];
#endif
}
}

+ (void)removeAllLoggers
{
if (IS_GCD_AVAILABLE)
{
#if GCD_MAYBE_AVAILABLE

dispatch_block_t removeAllLoggersBlock = ^{
NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];

[self lt_removeAllLoggers];

[pool drain];
};

dispatch_async(loggingQueue, removeAllLoggersBlock);
#endif
}
else
{
#if GCD_MAYBE_UNAVAILABLE

[self performSelector:@selector(lt_removeAllLoggers) onThread:loggingThread withObject:nil waitUntilDone:NO];
#endif
}
}

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
#pragma mark Master Logging
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

+ (void)queueLogMessage:(DDLogMessage *)logMessage asynchronously:(BOOL)asyncFlag
{
// We have a tricky situation here...
//
// In the common case, when the queueSize is below the maximumQueueSize,
// we want to simply enqueue the logMessage. And we want to do this as fast as possible,
// which means we don't want to block and we don't want to use any locks.
//
// However, if the queueSize gets too big, we want to block.
// But we have very strict requirements as to when we block, and how long we block.
//
// The following example should help illustrate our requirements:
//
// Imagine that the maximum queue size is configured to be 5,
// and that there are already 5 log messages queued.
// Let us call these 5 queued log messages A, B, C, D, and E. (A is next to be executed)
//
// Now if our thread issues a log statement (let us call the log message F),
// it should block before the message is added to the queue.
// Furthermore, it should be unblocked immediately after A has been unqueued.
//
// The requirements are strict in this manner so that we block only as long as necessary,
// and so that blocked threads are unblocked in the order in which they were blocked.
//
// Returning to our previous example, let us assume that log messages A through E are still queued.
// Our aforementioned thread is blocked attempting to queue log message F.
// Now assume we have another separate thread that attempts to issue log message G.
// It should block until log messages A and B have been unqueued.

if (IS_GCD_AVAILABLE)
{
#if GCD_MAYBE_AVAILABLE

// We are using a counting semaphore provided by GCD.
// The semaphore is initialized with our LOG_MAX_QUEUE_SIZE value.
// Everytime we want to queue a log message we decrement this value.
// If the resulting value is less than zero,
// the semaphore function waits in FIFO order for a signal to occur before returning.
//
// A dispatch semaphore is an efficient implementation of a traditional counting semaphore.
// Dispatch semaphores call down to the kernel only when the calling thread needs to be blocked.
// If the calling semaphore does not need to block, no kernel call is made.

dispatch_semaphore_wait(queueSemaphore, DISPATCH_TIME_FOREVER);
#endif
}
else
{
#if GCD_MAYBE_UNAVAILABLE

// We're going increment our queue size (in an atomic fashion).
// If the queue size would exceed our LOG_MAX_QUEUE_SIZE value,
// then we're going to take a lock, and add ourself to the blocked threads array.
// Then we wait for the logging thread to signal us.
// When it does, we automatically reaquire the lock,
// and check to see if we have been removed from the blocked threads array.
// When this occurs we are unblocked, and we can go ahead and queue our log message.

int32_t newQueueSize = OSAtomicIncrement32(&queueSize);
if (newQueueSize > LOG_MAX_QUEUE_SIZE)
{
NSLogDebug(@"DDLog: Blocking thread %@ (newQueueSize=%i)", [logMessage threadID], newQueueSize);

[condition lock];

NSString *currentThreadID = [logMessage threadID];
[blockedThreads addObject:currentThreadID];

NSUInteger lastKnownIndex = [blockedThreads count] - 1;

if (lastKnownIndex == 0)
{
NSLogDebug(@"DDLog: Potential edge case: First blocked thread -> Signaling condition...");

// Edge case:
// The loggingThread/loggingQueue acquired the lock before we did,
// but it immediately discovered the blockedThreads array was empty.

[condition signal];
}

BOOL done = NO;
while (!done)
{
BOOL found = NO;
NSUInteger i;
NSUInteger count = [blockedThreads count];

for (i = 0; i <= lastKnownIndex && i < count && !found; i++)
{
NSString *blockedThreadID = [blockedThreads objectAtIndex:i];

// Instead of doing a string comparison,
// we can save CPU cycles by doing an pointer comparison,
// since we still have access to the string that we added the array.

if (blockedThreadID == currentThreadID)
{
found = YES;
lastKnownIndex = i;
}
}

// If our currentThreadID is still in the blockedThreads array,
// then we are still blocked, and we're not done.

done = !found;

if (!done)
{
[condition wait];
}
}


[condition unlock];

NSLogDebug(@"DDLog: Unblocking thread %@", [logMessage threadID]);
}
#endif
}

// We've now sure we won't overflow the queue.
// It is time to queue our log message.

if (IS_GCD_AVAILABLE)
{
#if GCD_MAYBE_AVAILABLE

dispatch_block_t logBlock = ^{
NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];

[self lt_log:logMessage];

[pool drain];
};

if (asyncFlag)
dispatch_async(loggingQueue, logBlock);
else
dispatch_sync(loggingQueue, logBlock);
#endif
}
else
{
#if GCD_MAYBE_UNAVAILABLE

[self performSelector:@selector(lt_log:) onThread:loggingThread withObject:logMessage waitUntilDone:!asyncFlag];
#endif
}
}

+ (void)log:(BOOL)asynchronous
      level:(int)level
       flag:(int)flag
    context:(int)context
       file:(const char *)file
   function:(const char *)function
       line:(int)line
     format:(NSString *)format, ...
{
va_list args;
if (format)
{
va_start(args, format);

NSString *logMsg = [[NSString alloc] initWithFormat:format arguments:args];
DDLogMessage *logMessage = [[DDLogMessage alloc] initWithLogMsg:logMsg
level:level
flag:flag
context:context
file:file
function:function
line:line];

[self queueLogMessage:logMessage asynchronously:asynchronous];

[logMessage release];
[logMsg release];

va_end(args);
}
}

+ (void)flushLog
{
if (IS_GCD_AVAILABLE)
{
#if GCD_MAYBE_AVAILABLE

dispatch_block_t flushBlock = ^{
NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];

[self lt_flush];

[pool drain];
};

dispatch_sync(loggingQueue, flushBlock);
#endif
}
else
{
#if GCD_MAYBE_UNAVAILABLE

[self performSelector:@selector(lt_flush) onThread:loggingThread withObject:nil waitUntilDone:YES];
#endif
}
}

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
#pragma mark Registered Dynamic Logging
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

+ (BOOL)isRegisteredClass:(Class)class
{
SEL getterSel = @selector(ddLogLevel);
SEL setterSel = @selector(ddSetLogLevel:);
#if TARGET_OS_IPHONE

// Issue #6 - Crashes on iOS 4.2.1 and iPhone 4
//
// Crash caused by class_getClassMethod(2).
//
// "It's a bug with UIAccessibilitySafeCategory__NSObject so it didn't pop up until
// users had VoiceOver enabled [...]. I was able to work around it by searching the
// result of class_copyMethodList() instead of calling class_getClassMethod()"

unsigned int methodCount, i;
Method *methodList = class_copyMethodList(object_getClass(class), &methodCount);

if (methodList != NULL)
{
BOOL getterFound = NO;
BOOL setterFound = NO;

for (i = 0; i < methodCount; ++i)
{
SEL currentSel = method_getName(methodList[i]);

if (currentSel == getterSel)
{
getterFound = YES;
}
else if (currentSel == setterSel)
{
setterFound = YES;
}

if (getterFound && setterFound)
{
return YES;
}
}

free(methodList);
}

return NO;
#else

Method getter = class_getClassMethod(class, getterSel);
Method setter = class_getClassMethod(class, setterSel);

if ((getter != NULL) && (setter != NULL))
{
return YES;
}

return NO;
#endif
}

+ (NSArray *)registeredClasses
{
int numClasses, i;

// We're going to get the list of all registered classes.
// The Objective-C runtime library automatically registers all the classes defined in your source code.
//
// To do this we use the following method (documented in the Objective-C Runtime Reference):
//
// int objc_getClassList(Class *buffer, int bufferLen)
//
// We can pass (NULL, 0) to obtain the total number of
// registered class definitions without actually retrieving any class definitions.
// This allows us to allocate the minimum amount of memory needed for the application.

numClasses = objc_getClassList(NULL, 0);

// The numClasses method now tells us how many classes we have.
// So we can allocate our buffer, and get pointers to all the class definitions.

Class *classes = malloc(sizeof(Class) * numClasses);

numClasses = objc_getClassList(classes, numClasses);

// We can now loop through the classes, and test each one to see if it is a DDLogging class.

NSMutableArray *result = [NSMutableArray arrayWithCapacity:numClasses];

for (i = 0; i < numClasses; i++)
{
Class class = classes[i];

if ([self isRegisteredClass:class])
{
[result addObject:class];
}
}

free(classes);

return result;
}

+ (NSArray *)registeredClassNames
{
NSArray *registeredClasses = [self registeredClasses];
NSMutableArray *result = [NSMutableArray arrayWithCapacity:[registeredClasses count]];

for (Class class in registeredClasses)
{
[result addObject:NSStringFromClass(class)];
}

return result;
}

+ (int)logLevelForClass:(Class)aClass
{
if ([self isRegisteredClass:aClass])
{
return [aClass ddLogLevel];
}

return -1;
}

+ (int)logLevelForClassWithName:(NSString *)aClassName
{
Class aClass = NSClassFromString(aClassName);

return [self logLevelForClass:aClass];
}

+ (void)setLogLevel:(int)logLevel forClass:(Class)aClass
{
if ([self isRegisteredClass:aClass])
{
[aClass ddSetLogLevel:logLevel];
}
}

+ (void)setLogLevel:(int)logLevel forClassWithName:(NSString *)aClassName
{
Class aClass = NSClassFromString(aClassName);

[self setLogLevel:logLevel forClass:aClass];
}

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
#pragma mark Logging Thread
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

#if GCD_MAYBE_UNAVAILABLE

/**
* Entry point for logging thread.
**/
+ (void)lt_main:(id)ignore
{
NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];

// We can't run the run loop unless it has an associated input source or a timer.
// So we'll just create a timer that will never fire - unless the server runs for 10,000 years.
[NSTimer scheduledTimerWithTimeInterval:DBL_MAX target:self selector:@selector(ignore:) userInfo:nil repeats:NO];

[[NSRunLoop currentRunLoop] run];

[pool drain];
}

#endif

/**
* This method should only be run on the logging thread/queue.
**/
+ (void)lt_addLogger:(id <DDLogger>)logger
{
if (IS_GCD_AVAILABLE)
{
#if GCD_MAYBE_AVAILABLE

// Add to loggers array.
// Need to create loggerQueue if loggerNode doesn't provide one.

dispatch_queue_t loggerQueue = NULL;

if ([logger respondsToSelector:@selector(loggerQueue)])
{
// Logger may be providing its own queue

loggerQueue = [logger loggerQueue];
}

if (loggerQueue == nil)
{
// Automatically create queue for the logger.
// Use the logger name as the queue name if possible.

const char *loggerQueueName = NULL;
if ([logger respondsToSelector:@selector(loggerName)])
{
loggerQueueName = [[logger loggerName] UTF8String];
}

loggerQueue = dispatch_queue_create(loggerQueueName, NULL);
}

DDLoggerNode *loggerNode = [DDLoggerNode nodeWithLogger:logger loggerQueue:loggerQueue];
[loggers addObject:loggerNode];

if ([logger respondsToSelector:@selector(didAddLogger)])
{
dispatch_async(loggerNode->loggerQueue, ^{
NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];

[logger didAddLogger];

[pool drain];
});
}
#endif
}
else
{
#if GCD_MAYBE_UNAVAILABLE

// Add to loggers array

[loggers addObject:logger];

if ([logger respondsToSelector:@selector(didAddLogger)])
{
[logger didAddLogger];
}
#endif
}
}

/**
* This method should only be run on the logging thread/queue.
**/
+ (void)lt_removeLogger:(id <DDLogger>)logger
{
if (IS_GCD_AVAILABLE)
{
#if GCD_MAYBE_AVAILABLE

// Find associated loggerNode in list of added loggers

DDLoggerNode *loggerNode = nil;

for (DDLoggerNode *node in loggers)
{
if (node->logger == logger)
{
loggerNode = node;
break;
}
}

if (loggerNode == nil)
{
NSLogDebug(@"DDLog: Request to remove logger which wasn't added");
return;
}

// Notify logger

if ([logger respondsToSelector:@selector(willRemoveLogger)])
{
dispatch_async(loggerNode->loggerQueue, ^{
NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];

[logger willRemoveLogger];

[pool drain];
});
}

// Remove from loggers array

[loggers removeObject:loggerNode];
#endif
}
else
{
#if GCD_MAYBE_UNAVAILABLE

// Notify logger

if ([logger respondsToSelector:@selector(willRemoveLogger)])
{
[logger willRemoveLogger];
}

// Remove from loggers array

[loggers removeObject:logger];
#endif
}
}

/**
* This method should only be run on the logging thread/queue.
**/
+ (void)lt_removeAllLoggers
{
// Notify all loggers

if (IS_GCD_AVAILABLE)
{
#if GCD_MAYBE_AVAILABLE

for (DDLoggerNode *loggerNode in loggers)
{
if ([loggerNode->logger respondsToSelector:@selector(willRemoveLogger)])
{
dispatch_async(loggerNode->loggerQueue, ^{
NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];

[loggerNode->logger willRemoveLogger];

[pool drain];
});
}
}
#endif
}
else
{
#if GCD_MAYBE_UNAVAILABLE

for (id <DDLogger> logger in loggers)
{
if ([logger respondsToSelector:@selector(willRemoveLogger)])
{
[logger willRemoveLogger];
}
}
#endif
}

// Remove all loggers from array

[loggers removeAllObjects];
}

/**
* This method should only be run on the logging thread/queue.
**/
+ (void)lt_log:(DDLogMessage *)logMessage
{
// Execute the given log message on each of our loggers.

if (IS_GCD_AVAILABLE)
{
#if GCD_MAYBE_AVAILABLE

if (numProcessors > 1)
{
// Execute each logger concurrently, each within its own queue.
// All blocks are added to same group.
// After each block has been queued, wait on group.
//
// The waiting ensures that a slow logger doesn't end up with a large queue of pending log messages.
// This would defeat the purpose of the efforts we made earlier to restrict the max queue size.

for (DDLoggerNode *loggerNode in loggers)
{
dispatch_group_async(loggingGroup, loggerNode->loggerQueue, ^{

NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];

[loggerNode->logger logMessage:logMessage];

[pool drain];
});
}

dispatch_group_wait(loggingGroup, DISPATCH_TIME_FOREVER);
}
else
{
// Execute each logger serialy, each within its own queue.

for (DDLoggerNode *loggerNode in loggers)
{
dispatch_sync(loggerNode->loggerQueue, ^{
NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];

[loggerNode->logger logMessage:logMessage];

[pool drain];
});
}
}
#endif
}
else
{
#if GCD_MAYBE_UNAVAILABLE

for (id <DDLogger> logger in loggers)
{
[logger logMessage:logMessage];
}
#endif
}

// If our queue got too big, there may be blocked threads waiting to add log messages to the queue.
// Since we've now dequeued an item from the log, we may need to unblock the next thread.

if (IS_GCD_AVAILABLE)
{
#if GCD_MAYBE_AVAILABLE

// We are using a counting semaphore provided by GCD.
// The semaphore is initialized with our LOG_MAX_QUEUE_SIZE value.
// When a log message is queued this value is decremented.
// When a log message is dequeued this value is incremented.
// If the value ever drops below zero,
// the queueing thread blocks and waits in FIFO order for us to signal it.
//
// A dispatch semaphore is an efficient implementation of a traditional counting semaphore.
// Dispatch semaphores call down to the kernel only when the calling thread needs to be blocked.
// If the calling semaphore does not need to block, no kernel call is made.

dispatch_semaphore_signal(queueSemaphore);
#endif
}
else
{
#if GCD_MAYBE_UNAVAILABLE

int32_t newQueueSize = OSAtomicDecrement32(&queueSize);
if (newQueueSize >= LOG_MAX_QUEUE_SIZE)
{
// There is an existing blocked thread waiting for us.
// When the thread went to queue a log message, it first incremented the queueSize.
// At this point it realized that was going to exceed the maxQueueSize.
// It then added itself to the blockedThreads list, and is now waiting for us to signal it.

[condition lock];

while ([blockedThreads count] == 0)
{
NSLogDebug(@"DDLog: Edge case: Empty blocked threads array -> Waiting for condition...");

// Edge case.
// We acquired the lock before the blockedThread did.
// That is why the array is empty.
// Allow it to acquire the lock and signal us.

[condition wait];
}

// The blockedThreads variable is acting as a queue. (FIFO)
// Whatever was the first thread to block can now be unblocked.
// This means that thread will block only until the count of
// prevoiusly queued plus previously reserved log messages before it have dropped below the maxQueueSize.

NSLogDebug(@"DDLog: Signaling thread %@ (newQueueSize=%i)", [blockedThreads objectAtIndex:0], newQueueSize);

[blockedThreads removeObjectAtIndex:0];
[condition broadcast];

[condition unlock];
}
#endif
}
}

/**
* This method should only be run on the background logging thread.
**/
+ (void)lt_flush
{
// All log statements issued before the flush method was invoked have now been executed.
//
// Now we need to propogate the flush request to any loggers that implement the flush method.
// This is designed for loggers that buffer IO.

if (IS_GCD_AVAILABLE)
{
#if GCD_MAYBE_AVAILABLE

for (DDLoggerNode *loggerNode in loggers)
{
if ([loggerNode->logger respondsToSelector:@selector(flush)])
{
dispatch_group_async(loggingGroup, loggerNode->loggerQueue, ^{

NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];

[loggerNode->logger flush];

[pool drain];
});
}
}

dispatch_group_wait(loggingGroup, DISPATCH_TIME_FOREVER);
#endif
}
else
{
#if GCD_MAYBE_UNAVAILABLE

for (id <DDLogger> logger in loggers)
{
if ([logger respondsToSelector:@selector(flush)])
{
[logger flush];
}
}
#endif
}
}

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
#pragma mark Utilities
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

NSString *ExtractFileNameWithoutExtension(const char *filePath, BOOL copy)
{
if (filePath == NULL) return nil;

char *lastSlash = NULL;
char *lastDot = NULL;

char *p = (char *)filePath;

while (*p != '\0')
{
if (*p == '/')
lastSlash = p;
else if (*p == '.')
lastDot = p;

p++;
}

char *subStr;
NSUInteger subLen;

if (lastSlash)
{
if (lastDot)
{
// lastSlash -> lastDot
subStr = lastSlash + 1;
subLen = lastDot - subStr;
}
else
{
// lastSlash -> endOfString
subStr = lastSlash + 1;
subLen = p - subStr;
}
}
else
{
if (lastDot)
{
// startOfString -> lastDot
subStr = (char *)filePath;
subLen = lastDot - subStr;
}
else
{
// startOfString -> endOfString
subStr = (char *)filePath;
subLen = p - subStr;
}
}

if (copy)
{
return [[[NSString alloc] initWithBytes:subStr
length:subLen
encoding:NSUTF8StringEncoding] autorelease];
}
else
{
// We can take advantage of the fact that __FILE__ is a string literal.
// Specifically, we don't need to waste time copying the string.
// We can just tell NSString to point to a range within the string literal.

return [[[NSString alloc] initWithBytesNoCopy:subStr
length:subLen
encoding:NSUTF8StringEncoding
freeWhenDone:NO] autorelease];
}
}

@end

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
#pragma mark -
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

#if GCD_MAYBE_AVAILABLE

@implementation DDLoggerNode

- (id)initWithLogger:(id <DDLogger>)aLogger loggerQueue:(dispatch_queue_t)aLoggerQueue
{
if ((self = [super init]))
{
logger = [aLogger retain];

if (aLoggerQueue) {
loggerQueue = aLoggerQueue;
dispatch_retain(loggerQueue);
}
}
return self;
}

+ (DDLoggerNode *)nodeWithLogger:(id <DDLogger>)logger loggerQueue:(dispatch_queue_t)loggerQueue
{
return [[[DDLoggerNode alloc] initWithLogger:logger loggerQueue:loggerQueue] autorelease];
}

- (void)dealloc
{
[logger release];
if (loggerQueue) {
dispatch_release(loggerQueue);
}
[super dealloc];
}

@end

#endif

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
#pragma mark -
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

@implementation DDLogMessage

- (id)initWithLogMsg:(NSString *)msg
               level:(int)level
                flag:(int)flag
             context:(int)context
                file:(const char *)aFile
            function:(const char *)aFunction
                line:(int)line
{
if((self = [super init]))
{
logMsg = [msg retain];
logLevel = level;
logFlag = flag;
logContext = context;
file = aFile;
function = aFunction;
lineNumber = line;

timestamp = [[NSDate alloc] init];

machThreadID = pthread_mach_thread_np(pthread_self());
        
        if (IS_GCD_AVAILABLE)
        {
#if GCD_MAYBE_AVAILABLE
            const char *label = dispatch_queue_get_label(dispatch_get_current_queue());
            if (label) {
                size_t labelLength = strlen(label);
                queueLabel = malloc(labelLength+1);
                strncpy(queueLabel, label, labelLength);
                queueLabel[labelLength] = 0;
            }
#endif
        }
}
return self;
}

- (NSString *)threadID
{
if (threadID == nil)
{
threadID = [[NSString alloc] initWithFormat:@"%x", machThreadID];
}

return threadID;
}

- (NSString *)fileName
{
if (fileName == nil)
{
fileName = [ExtractFileNameWithoutExtension(file, NO) retain];
}

return fileName;
}

- (NSString *)methodName
{
if (methodName == nil && function != NULL)
{
methodName = [[NSString alloc] initWithUTF8String:function];
}

return methodName;
}

- (void)dealloc
{
[logMsg release];
[timestamp release];

[threadID release];
[fileName release];
[methodName release];
    
    if (IS_GCD_AVAILABLE) {
#if GCD_MAYBE_AVAILABLE
        if (queueLabel != NULL) {
            free(queueLabel);
        }
#endif
    }

[super dealloc];
}

@end

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
#pragma mark -
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

@implementation DDAbstractLogger

- (id)init
{
if ((self = [super init]))
{
if (IS_GCD_AVAILABLE)
{
#if GCD_MAYBE_AVAILABLE

const char *loggerQueueName = NULL;
if ([self respondsToSelector:@selector(loggerName)])
{
loggerQueueName = [[self loggerName] UTF8String];
}

loggerQueue = dispatch_queue_create(loggerQueueName, NULL);
#endif
}
}
return self;
}

- (void)dealloc
{
if (IS_GCD_AVAILABLE)
{
#if GCD_MAYBE_AVAILABLE
if (loggerQueue) dispatch_release(loggerQueue);
#endif
}

[super dealloc];
}

- (void)logMessage:(DDLogMessage *)logMessage
{
// Override me
}

#if GCD_MAYBE_UNAVAILABLE

- (void)lt_getLogFormatter:(NSMutableArray *)resultHolder
{
// This method is executed on the logging thread.

[resultHolder addObject:formatter];
OSMemoryBarrier();
}

- (void)lt_setLogFormatter:(id <DDLogFormatter>)logFormatter
{
// This method is executed on the logging thread.

if (formatter != logFormatter)
{
[formatter release];
formatter = [logFormatter retain];
}
}

#endif

- (id <DDLogFormatter>)logFormatter
{
// This method must be thread safe and intuitive.
// Therefore if somebody executes the following code:
//
// [logger setLogFormatter:myFormatter];
// formatter = [logger logFormatter];
//
// They would expect formatter to equal myFormatter.
// This functionality must be ensured by the getter and setter method.
//
// The thread safety must not come at a cost to the performance of the logMessage method.
// This method is likely called sporadically, while the logMessage method is called repeatedly.
// This means, the implementation of this method:
// - Must NOT require the logMessage method to acquire a lock.
// - Must NOT require the logMessage method to access an atomic property (also a lock of sorts).
//
// Thread safety is ensured by executing access to the formatter variable on the logging thread/queue.
// This is the same thread/queue that the logMessage method operates on.
//
// Note: The last time I benchmarked the performance of direct access vs atomic property access,
// direct access was over twice as fast on the desktop and over 6 times as fast on the iPhone.

if (IS_GCD_AVAILABLE)
{
#if GCD_MAYBE_AVAILABLE

// loggerQueue : Our own private internal queue that the logMessage method runs on.
// Operations are added to this queue from the global loggingQueue.
//
// loggingQueue : The queue that all log messages go through before they arrive in our loggerQueue.
//
// It is important to note that, while the loggerQueue is used to create thread-safety for our formatter,
// changes to the formatter variable are queued on the loggingQueue.
//
// Since this will obviously confuse the hell out of me later, here is a better description.
// Imagine the following code:
//
// DDLogVerbose(@"log msg 1");
// DDLogVerbose(@"log msg 2");
// [logger setFormatter:myFormatter];
// DDLogVerbose(@"log msg 3");
//
// Our intuitive requirement means that the new formatter will only apply to the 3rd log message.
// But notice what happens if we have asynchronous logging enabled for verbose mode.
//
// Log msg 1 starts executing asynchronously on the loggingQueue.
// The loggingQueue executes the log statement on each logger concurrently.
// That means it executes log msg 1 on our loggerQueue.
// While log msg 1 is executing, log msg 2 gets added to the loggingQueue.
// Then the user requests that we change our formatter.
// So at this exact moment, our queues look like this:
//
// loggerQueue : executing log msg 1, nil
// loggingQueue : executing log msg 1, log msg 2, nil
//
// So direct access to the formatter is only available if requested from the loggerQueue.
// In all other circumstances we need to go through the loggingQueue to get the proper value.

if (dispatch_get_current_queue() == loggerQueue)
{
return formatter;
}

__block id <DDLogFormatter> result;

dispatch_sync([DDLog loggingQueue], ^{
result = [formatter retain];
});

return [result autorelease];
#endif
}
else
{
#if GCD_MAYBE_UNAVAILABLE

NSThread *loggingThread = [DDLog loggingThread];

if ([NSThread currentThread] == loggingThread)
{
return formatter;
}

NSMutableArray *resultHolder = [[NSMutableArray alloc] init];

[self performSelector:@selector(lt_getLogFormatter:)
onThread:loggingThread
withObject:resultHolder
waitUntilDone:YES];

OSMemoryBarrier();

id <DDLogFormatter> result = [[resultHolder objectAtIndex:0] retain];
[resultHolder release];

return [result autorelease];
#endif
}
}

- (void)setLogFormatter:(id <DDLogFormatter>)logFormatter
{
// This method must be thread safe and intuitive.
// Therefore if somebody executes the following code:
//
// [logger setLogFormatter:myFormatter];
// formatter = [logger logFormatter];
//
// They would expect formatter to equal myFormatter.
// This functionality must be ensured by the getter and setter method.
//
// The thread safety must not come at a cost to the performance of the logMessage method.
// This method is likely called sporadically, while the logMessage method is called repeatedly.
// This means, the implementation of this method:
// - Must NOT require the logMessage method to acquire a lock.
// - Must NOT require the logMessage method to access an atomic property (also a lock of sorts).
//
// Thread safety is ensured by executing access to the formatter variable on the logging thread/queue.
// This is the same thread/queue that the logMessage method operates on.
//
// Note: The last time I benchmarked the performance of direct access vs atomic property access,
// direct access was over twice as fast on the desktop and over 6 times as fast on the iPhone.

if (IS_GCD_AVAILABLE)
{
#if GCD_MAYBE_AVAILABLE

// loggerQueue : Our own private internal queue that the logMessage method runs on.
// Operations are added to this queue from the global loggingQueue.
//
// loggingQueue : The queue that all log messages go through before they arrive in our loggerQueue.
//
// It is important to note that, while the loggerQueue is used to create thread-safety for our formatter,
// changes to the formatter variable are queued on the loggingQueue.
//
// Since this will obviously confuse the hell out of me later, here is a better description.
// Imagine the following code:
//
// DDLogVerbose(@"log msg 1");
// DDLogVerbose(@"log msg 2");
// [logger setFormatter:myFormatter];
// DDLogVerbose(@"log msg 3");
//
// Our intuitive requirement means that the new formatter will only apply to the 3rd log message.
// But notice what happens if we have asynchronous logging enabled for verbose mode.
//
// Log msg 1 starts executing asynchronously on the loggingQueue.
// The loggingQueue executes the log statement on each logger concurrently.
// That means it executes log msg 1 on our loggerQueue.
// While log msg 1 is executing, log msg 2 gets added to the loggingQueue.
// Then the user requests that we change our formatter.
// So at this exact moment, our queues look like this:
//
// loggerQueue : executing log msg 1, nil
// loggingQueue : executing log msg 1, log msg 2, nil
//
// So direct access to the formatter is only available if requested from the loggerQueue.
// In all other circumstances we need to go through the loggingQueue to get the proper value.

dispatch_block_t block = ^{
if (formatter != logFormatter)
{
[formatter release];
formatter = [logFormatter retain];
}
};

if (dispatch_get_current_queue() == loggerQueue)
block();
else
dispatch_async([DDLog loggingQueue], block);
#endif
}
else
{
#if GCD_MAYBE_UNAVAILABLE

NSThread *loggingThread = [DDLog loggingThread];

if ([NSThread currentThread] == loggingThread)
{
[self lt_setLogFormatter:logFormatter];
}
else
{
[self performSelector:@selector(lt_setLogFormatter:)
onThread:loggingThread
withObject:logFormatter
waitUntilDone:NO];
}
#endif
}
}

#if GCD_MAYBE_AVAILABLE

- (dispatch_queue_t)loggerQueue
{
return loggerQueue;
}

- (NSString *)loggerName
{
return NSStringFromClass([self class]);
}

#endif

@end
Something went wrong with that request. Please try again.