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
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef mozilla_nsDumpUtils_h
#define mozilla_nsDumpUtils_h
#include "nsIObserver.h"
#include "base/message_loop.h"
#include "nsXULAppAPI.h"
#include "nsThreadUtils.h"
#include "mozilla/Mutex.h"
#include "mozilla/StaticPtr.h"
#include "nsTArray.h"
#ifdef LOG
# undef LOG
#endif
#ifdef ANDROID
# include "android/log.h"
# define LOG(...) \
__android_log_print(ANDROID_LOG_INFO, "Gecko:DumpUtils", ##__VA_ARGS__)
#else
# define LOG(...)
#endif
#ifdef XP_UNIX // {
/**
* Abstract base class for something which watches an fd and takes action when
* we can read from it without blocking.
*/
class FdWatcher : public MessageLoopForIO::Watcher, public nsIObserver {
protected:
MessageLoopForIO::FileDescriptorWatcher mReadWatcher;
int mFd;
virtual ~FdWatcher() {
// StopWatching should have run.
MOZ_ASSERT(mFd == -1);
}
public:
FdWatcher() : mFd(-1) { MOZ_ASSERT(NS_IsMainThread()); }
/**
* Open the fd to watch. If we encounter an error, return -1.
*/
virtual int OpenFd() = 0;
/**
* Called when you can read() from the fd without blocking. Note that this
* function is also called when you're at eof (read() returns 0 in this case).
*/
virtual void OnFileCanReadWithoutBlocking(int aFd) override = 0;
virtual void OnFileCanWriteWithoutBlocking(int aFd) override{};
NS_DECL_THREADSAFE_ISUPPORTS
/**
* Initialize this object. This should be called right after the object is
* constructed. (This would go in the constructor, except we interact with
* XPCOM, which we can't do from a constructor because our refcount is 0 at
* that point.)
*/
void Init();
// Implementations may call this function multiple times if they ensure that
virtual void StartWatching();
// Since implementations can call StartWatching() multiple times, they can of
// course call StopWatching() multiple times.
virtual void StopWatching();
NS_IMETHOD Observe(nsISupports* aSubject, const char* aTopic,
const char16_t* aData) override {
MOZ_ASSERT(NS_IsMainThread());
MOZ_ASSERT(!strcmp(aTopic, "xpcom-shutdown"));
XRE_GetIOMessageLoop()->PostTask(mozilla::NewRunnableMethod(
"FdWatcher::StopWatching", this, &FdWatcher::StopWatching));
return NS_OK;
}
};
typedef void (*FifoCallback)(const nsCString& aInputStr);
struct FifoInfo {
nsCString mCommand;
FifoCallback mCallback;
};
typedef nsTArray<FifoInfo> FifoInfoArray;
class FifoWatcher : public FdWatcher {
public:
/**
* The name of the preference used to enable/disable the FifoWatcher.
*/
// The length of this array must match the size of the string constant in
// the definition in nsDumpUtils.cpp. A mismatch will result in a compile-time
// error.
static const char kPrefName[38];
static FifoWatcher* GetSingleton();
static bool MaybeCreate();
void RegisterCallback(const nsCString& aCommand, FifoCallback aCallback);
virtual ~FifoWatcher();
virtual int OpenFd() override;
virtual void OnFileCanReadWithoutBlocking(int aFd) override;
private:
nsAutoCString mDirPath;
static mozilla::StaticRefPtr<FifoWatcher> sSingleton;
explicit FifoWatcher(nsCString aPath)
: mDirPath(aPath), mFifoInfoLock("FifoWatcher.mFifoInfoLock") {}
mozilla::Mutex mFifoInfoLock; // protects mFifoInfo
FifoInfoArray mFifoInfo MOZ_GUARDED_BY(mFifoInfoLock);
};
typedef void (*PipeCallback)(const uint8_t aRecvSig);
struct SignalInfo {
uint8_t mSignal;
PipeCallback mCallback;
};
typedef nsTArray<SignalInfo> SignalInfoArray;
class SignalPipeWatcher : public FdWatcher {
public:
static SignalPipeWatcher* GetSingleton();
void RegisterCallback(uint8_t aSignal, PipeCallback aCallback);
void RegisterSignalHandler(uint8_t aSignal = 0);
virtual ~SignalPipeWatcher();
virtual int OpenFd() override;
virtual void StopWatching() override;
virtual void OnFileCanReadWithoutBlocking(int aFd) override;
private:
static mozilla::StaticRefPtr<SignalPipeWatcher> sSingleton;
SignalPipeWatcher() : mSignalInfoLock("SignalPipeWatcher.mSignalInfoLock") {
MOZ_ASSERT(NS_IsMainThread());
}
mozilla::Mutex mSignalInfoLock; // protects mSignalInfo
SignalInfoArray mSignalInfo MOZ_GUARDED_BY(mSignalInfoLock);
};
#endif // XP_UNIX }
class nsDumpUtils {
public:
enum Mode { CREATE, CREATE_UNIQUE };
/**
* This function creates a new unique file based on |aFilename| in a
* world-readable temp directory. This is the system temp directory
* or, in the case of Android, the downloads directory. If |aFile| is
* non-null, it is assumed to point to a folder, and that folder is used
* instead.
*/
static nsresult OpenTempFile(const nsACString& aFilename, nsIFile** aFile,
const nsACString& aFoldername = ""_ns,
Mode aMode = CREATE_UNIQUE);
};
#endif
|
