129 lines
3.7 KiB
Objective-C
129 lines
3.7 KiB
Objective-C
/**
|
|
* Copyright (c) 2015-present, Facebook, Inc.
|
|
* All rights reserved.
|
|
*
|
|
* This source code is licensed under the BSD-style license found in the
|
|
* LICENSE file in the root directory of this source tree. An additional grant
|
|
* of patent rights can be found in the PATENTS file in the same directory.
|
|
*/
|
|
|
|
#import <Foundation/Foundation.h>
|
|
|
|
#import "RCTDefines.h"
|
|
|
|
/**
|
|
* RCTProfile
|
|
*
|
|
* This file provides a set of functions and macros for performance profiling
|
|
*
|
|
* NOTE: This API is a work in a work in progress, please consider carefully
|
|
* before before using it.
|
|
*/
|
|
|
|
NSString *const RCTProfileDidStartProfiling;
|
|
NSString *const RCTProfileDidEndProfiling;
|
|
|
|
#if RCT_DEV
|
|
|
|
@class RCTBridge;
|
|
|
|
#define RCTProfileBeginFlowEvent() \
|
|
_Pragma("clang diagnostic push") \
|
|
_Pragma("clang diagnostic ignored \"-Wshadow\"") \
|
|
NSNumber *__rct_profile_flow_id = _RCTProfileBeginFlowEvent(); \
|
|
_Pragma("clang diagnostic pop")
|
|
|
|
#define RCTProfileEndFlowEvent() \
|
|
_RCTProfileEndFlowEvent(__rct_profile_flow_id)
|
|
|
|
RCT_EXTERN NSNumber *_RCTProfileBeginFlowEvent(void);
|
|
RCT_EXTERN void _RCTProfileEndFlowEvent(NSNumber *);
|
|
|
|
/**
|
|
* Returns YES if the profiling information is currently being collected
|
|
*/
|
|
RCT_EXTERN BOOL RCTProfileIsProfiling(void);
|
|
|
|
/**
|
|
* Start collecting profiling information
|
|
*/
|
|
RCT_EXTERN void RCTProfileInit(RCTBridge *);
|
|
|
|
/**
|
|
* Stop profiling and return a JSON string of the collected data - The data
|
|
* returned is compliant with google's trace event format - the format used
|
|
* as input to trace-viewer
|
|
*/
|
|
RCT_EXTERN NSString *RCTProfileEnd(RCTBridge *);
|
|
|
|
/**
|
|
* Collects the initial event information for the event and returns a reference ID
|
|
*/
|
|
RCT_EXTERN NSNumber *_RCTProfileBeginEvent(void);
|
|
|
|
/**
|
|
* The ID returned by BeginEvent should then be passed into EndEvent, with the
|
|
* rest of the event information. Just at this point the event will actually be
|
|
* registered
|
|
*/
|
|
RCT_EXTERN void _RCTProfileEndEvent(NSNumber *, NSString *, NSString *, id);
|
|
|
|
/**
|
|
* This pair of macros implicitly handle the event ID when beginning and ending
|
|
* an event, for both simplicity and performance reasons, this method is preferred
|
|
*
|
|
* NOTE: The EndEvent call has to be either, in the same scope of BeginEvent,
|
|
* or in a sub-scope, otherwise the ID stored by BeginEvent won't be accessible
|
|
* for EndEvent, in this case you may want to use the actual C functions.
|
|
*/
|
|
#define RCTProfileBeginEvent() \
|
|
_Pragma("clang diagnostic push") \
|
|
_Pragma("clang diagnostic ignored \"-Wshadow\"") \
|
|
NSNumber *__rct_profile_id = _RCTProfileBeginEvent(); \
|
|
_Pragma("clang diagnostic pop")
|
|
|
|
#define RCTProfileEndEvent(name, category, args...) \
|
|
_RCTProfileEndEvent(__rct_profile_id, name, category, args)
|
|
|
|
/**
|
|
* An event that doesn't have a duration (i.e. Notification, VSync, etc)
|
|
*/
|
|
RCT_EXTERN void RCTProfileImmediateEvent(NSString *, NSTimeInterval , NSString *);
|
|
|
|
/**
|
|
* Helper to profile the duration of the execution of a block. This method uses
|
|
* self and _cmd to name this event for simplicity sake.
|
|
*
|
|
* NOTE: The block can't expect any argument
|
|
*/
|
|
#define RCTProfileBlock(block, category, arguments) \
|
|
^{ \
|
|
RCTProfileBeginEvent(); \
|
|
block(); \
|
|
RCTProfileEndEvent([NSString stringWithFormat:@"[%@ %@]", NSStringFromClass([self class]), NSStringFromSelector(_cmd)], category, arguments); \
|
|
}
|
|
|
|
#else
|
|
|
|
#define RCTProfileBeginFlowEvent()
|
|
#define _RCTProfileBeginFlowEvent() @0
|
|
|
|
#define RCTProfileEndFlowEvent()
|
|
#define _RCTProfileEndFlowEvent()
|
|
|
|
#define RCTProfileIsProfiling(...) NO
|
|
#define RCTProfileInit(...)
|
|
#define RCTProfileEnd(...) @""
|
|
|
|
#define _RCTProfileBeginEvent(...) @0
|
|
#define RCTProfileBeginEvent(...)
|
|
|
|
#define _RCTProfileEndEvent(...)
|
|
#define RCTProfileEndEvent(...)
|
|
|
|
#define RCTProfileImmediateEvent(...)
|
|
|
|
#define RCTProfileBlock(block, ...) block
|
|
|
|
#endif
|