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
|
/*
* Copyright (C) 2013 Apple Inc. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#if ENABLE(REMOTE_INSPECTOR)
#ifndef RemoteInspector_h
#define RemoteInspector_h
#import "RemoteInspectorXPCConnection.h"
#import <wtf/Forward.h>
#import <wtf/HashMap.h>
#import <wtf/RetainPtr.h>
OBJC_CLASS NSDictionary;
OBJC_CLASS NSString;
namespace Inspector {
class RemoteInspectorClient;
class RemoteInspectorDebuggable;
class RemoteInspectorDebuggableConnection;
struct RemoteInspectorDebuggableInfo;
class JS_EXPORT_PRIVATE RemoteInspector final : public RemoteInspectorXPCConnection::Client {
public:
static void startDisabled();
static RemoteInspector& shared();
friend class NeverDestroyed<RemoteInspector>;
void registerDebuggable(RemoteInspectorDebuggable*);
void unregisterDebuggable(RemoteInspectorDebuggable*);
void updateDebuggable(RemoteInspectorDebuggable*);
void sendMessageToRemoteFrontend(unsigned identifier, const String& message);
void setupFailed(unsigned identifier);
bool enabled() const { return m_enabled; }
bool hasActiveDebugSession() const { return m_hasActiveDebugSession; }
void start();
void stop();
bool hasParentProcessInformation() const { return m_parentProcessIdentifier != 0; }
pid_t parentProcessIdentifier() const { return m_parentProcessIdentifier; }
RetainPtr<CFDataRef> parentProcessAuditData() const { return m_parentProcessAuditData; }
void setParentProcessInformation(pid_t, RetainPtr<CFDataRef> auditData);
void setParentProcessInfomationIsDelayed();
private:
RemoteInspector();
unsigned nextAvailableIdentifier();
enum class StopSource { API, XPCMessage };
void stopInternal(StopSource);
void setupXPCConnectionIfNeeded();
NSDictionary *listingForDebuggable(const RemoteInspectorDebuggableInfo&) const;
void pushListingNow();
void pushListingSoon();
void updateHasActiveDebugSession();
virtual void xpcConnectionReceivedMessage(RemoteInspectorXPCConnection*, NSString *messageName, NSDictionary *userInfo) override;
virtual void xpcConnectionFailed(RemoteInspectorXPCConnection*) override;
virtual void xpcConnectionUnhandledMessage(RemoteInspectorXPCConnection*, xpc_object_t) override;
void receivedSetupMessage(NSDictionary *userInfo);
void receivedDataMessage(NSDictionary *userInfo);
void receivedDidCloseMessage(NSDictionary *userInfo);
void receivedGetListingMessage(NSDictionary *userInfo);
void receivedIndicateMessage(NSDictionary *userInfo);
void receivedProxyApplicationSetupMessage(NSDictionary *userInfo);
void receivedConnectionDiedMessage(NSDictionary *userInfo);
static bool startEnabled;
// Debuggables can be registered from any thread at any time.
// Any debuggable can send messages over the XPC connection.
// So lock access to all maps and state as they can change
// from any thread.
std::mutex m_mutex;
HashMap<unsigned, std::pair<RemoteInspectorDebuggable*, RemoteInspectorDebuggableInfo>> m_debuggableMap;
HashMap<unsigned, RefPtr<RemoteInspectorDebuggableConnection>> m_connectionMap;
RefPtr<RemoteInspectorXPCConnection> m_xpcConnection;
dispatch_queue_t m_xpcQueue;
unsigned m_nextAvailableIdentifier;
int m_notifyToken;
bool m_enabled;
bool m_hasActiveDebugSession;
bool m_pushScheduled;
pid_t m_parentProcessIdentifier;
RetainPtr<CFDataRef> m_parentProcessAuditData;
bool m_shouldSendParentProcessInformation;
};
} // namespace Inspector
#endif // RemoteInspector_h
#endif // ENABLE(REMOTE_INSPECTOR)
|