-
Notifications
You must be signed in to change notification settings - Fork 34
[DO NOT ReVIEW] in-progress: Add code for detecting iOS thread starvation and fallbac… #1603
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
kaisong1990
wants to merge
1
commit into
dev
Choose a base branch
from
kasong/3403740-threading-ios
base: dev
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| // | ||
| // Copyright (c) Microsoft Corporation. | ||
| // All rights reserved. | ||
| // | ||
| // This code is licensed under the MIT License. | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| // of this software and associated documentation files(the "Software"), to deal | ||
| // in the Software without restriction, including without limitation the rights | ||
| // to use, copy, modify, merge, publish, distribute, sublicense, and / or sell | ||
| // copies of the Software, and to permit persons to whom the Software is | ||
| // furnished to do so, subject to the following conditions : | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in | ||
| // all copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| // THE SOFTWARE. | ||
|
|
||
|
|
||
| #import <Foundation/Foundation.h> | ||
|
|
||
| NS_ASSUME_NONNULL_BEGIN | ||
|
|
||
| @interface MSIDGCDStarvationDetector : NSObject | ||
|
|
||
| @property (nonatomic, readonly) BOOL running; | ||
|
|
||
| // Start monitoring on a dedicated thread | ||
| - (void)startMonitoringWithInterval:(NSTimeInterval)interval | ||
| timeout:(NSTimeInterval)timeout | ||
| onStarved:(void (^)(void))callback; | ||
|
|
||
| // Stop monitoring | ||
| - (void)stopMonitoring; | ||
|
|
||
| @end | ||
|
|
||
| NS_ASSUME_NONNULL_END |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| // | ||
| // Copyright (c) Microsoft Corporation. | ||
| // All rights reserved. | ||
| // | ||
| // This code is licensed under the MIT License. | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| // of this software and associated documentation files(the "Software"), to deal | ||
| // in the Software without restriction, including without limitation the rights | ||
| // to use, copy, modify, merge, publish, distribute, sublicense, and / or sell | ||
| // copies of the Software, and to permit persons to whom the Software is | ||
| // furnished to do so, subject to the following conditions : | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in | ||
| // all copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| // THE SOFTWARE. | ||
|
|
||
|
|
||
| #import "MSIDGCDStarvationDetector.h" | ||
| #import "MSIDLogger+Internal.h" | ||
|
|
||
| @implementation MSIDGCDStarvationDetector { | ||
| NSThread *_monitorThread; | ||
| BOOL _shouldStop; | ||
| NSTimeInterval _interval; | ||
| NSTimeInterval _timeout; | ||
| void (^_callback)(void); | ||
| } | ||
|
|
||
| #pragma mark - Public API | ||
|
|
||
| // We need to start the monitoring in a customized thread to avoid the current thread been blocked | ||
| - (void)startMonitoringWithInterval:(NSTimeInterval)interval | ||
| timeout:(NSTimeInterval)timeout | ||
| onStarved:(void (^)(void))callback | ||
| { | ||
| if (self.running) return; | ||
|
|
||
| _interval = interval; | ||
| _timeout = timeout; | ||
| _callback = [callback copy]; | ||
| _shouldStop = NO; | ||
|
|
||
| _monitorThread = [[NSThread alloc] initWithTarget:self | ||
| selector:@selector(monitorLoop) | ||
| object:nil]; | ||
| _monitorThread.name = [NSString stringWithFormat:@"%@-%@", @"com.microsoft.msid.gcdStarvationMonitor.thread", [NSUUID UUID].UUIDString]; | ||
| [_monitorThread start]; | ||
| _running = YES; | ||
| } | ||
|
|
||
| - (void)stopMonitoring { | ||
| @synchronized(self) { | ||
| _shouldStop = YES; | ||
| } | ||
|
|
||
| // Wait for monitor thread to finish | ||
| if (_monitorThread && !_monitorThread.isFinished) { | ||
| [_monitorThread cancel]; | ||
| // Give it time to clean up | ||
| dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(0.1 * NSEC_PER_SEC)), dispatch_get_main_queue(), ^{ | ||
| self->_monitorThread = nil; | ||
| self->_callback = nil; | ||
| }); | ||
| }} | ||
|
|
||
| - (void)monitorLoop { | ||
| @autoreleasepool { | ||
| MSID_LOG_WITH_CTX(MSIDLogLevelInfo, nil, @"GCD starvation monitor started on thread: %@", [NSThread currentThread]); | ||
|
|
||
| while (YES) { | ||
| @synchronized(self) { | ||
| if (_shouldStop || [NSThread currentThread].isCancelled) { | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| BOOL starved = [self isThreadStarvedWithTimeout:_timeout]; | ||
| if (starved && _callback) { | ||
| _callback(); | ||
| } | ||
|
|
||
| [NSThread sleepForTimeInterval:_interval]; | ||
| } | ||
|
|
||
| MSID_LOG_WITH_CTX(MSIDLogLevelInfo, nil, @"GCD starvation monitor stopped"); | ||
|
|
||
| @synchronized(self) { | ||
| _running = NO; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| - (BOOL)isThreadStarvedWithTimeout:(NSTimeInterval)timeout { | ||
| dispatch_semaphore_t sema = dispatch_semaphore_create(0); | ||
|
|
||
| // The "ping" — will only execute if GCD has an available worker | ||
| dispatch_async(dispatch_get_global_queue(QOS_CLASS_DEFAULT, 0), ^{ | ||
| // No need for starved variable - semaphore result is sufficient | ||
| dispatch_semaphore_signal(sema); | ||
| }); | ||
|
|
||
| long result = dispatch_semaphore_wait(sema, dispatch_time(DISPATCH_TIME_NOW, (int64_t)(timeout * NSEC_PER_SEC))); | ||
|
|
||
| // result == 0 means semaphore was signaled (GCD thread available) | ||
| // result != 0 means timeout occurred (GCD thread starvation) | ||
| return (result != 0); | ||
| } | ||
|
|
||
|
|
||
| @end |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| // | ||
| // Copyright (c) Microsoft Corporation. | ||
| // All rights reserved. | ||
| // | ||
| // This code is licensed under the MIT License. | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| // of this software and associated documentation files(the "Software"), to deal | ||
| // in the Software without restriction, including without limitation the rights | ||
| // to use, copy, modify, merge, publish, distribute, sublicense, and / or sell | ||
| // copies of the Software, and to permit persons to whom the Software is | ||
| // furnished to do so, subject to the following conditions : | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in | ||
| // all copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| // THE SOFTWARE. | ||
|
|
||
|
|
||
| #import <Foundation/Foundation.h> | ||
|
|
||
| NS_ASSUME_NONNULL_BEGIN | ||
|
|
||
| @interface MSIDGCDStarvationHandler : NSObject | ||
|
|
||
| + (instancetype)sharedHandler; | ||
|
|
||
| /// Detects if GCD thread pool is starved | ||
| /// @param timeout How long to wait for a simple GCD task (e.g., 10ms) | ||
| /// @return YES if thread starvation detected | ||
| - (BOOL)isGCDThreadPoolStarvedWithTimeout:(NSTimeInterval)timeout; | ||
|
|
||
| /// Execute block on GCD if available, otherwise fallback to custom thread | ||
| /// @param block Block to execute | ||
| /// @param fallbackToCustomThread Whether to use custom thread if GCD is starved | ||
| - (void)executeBlock:(dispatch_block_t)block fallbackToCustomThread:(BOOL)fallbackToCustomThread; | ||
|
|
||
| @end | ||
|
|
||
| NS_ASSUME_NONNULL_END |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This pull request does not update changelog.txt.
Please consider if this change would be noticeable to a partner or user and either update changelog.txt or resolve this conversation.