FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
codeql/swift/extractor/main.cpp at codeql-cli/v2.15.2 · github/codeql · GitHub
Uh oh!
There was an error while loading.
Please reload this page
.
github
/
codeql
Public
Notifications
You must be signed in to change notification settings
Fork
2.1k
Star
10k
Code
Issues
997
Pull requests
463
Discussions
Actions
Projects
Security and quality
0
Insights
Additional navigation options
Code
Issues
Pull requests
Discussions
Actions
Projects
Security and quality
Insights
Expand file tree
Breadcrumbs
codeql
/
swift
/
extractor
/
main.cpp
Copy path
More file actions
More file actions
Latest commit
History
History
History
248 lines (217 loc) · 8.99 KB
Breadcrumbs
codeql
/
swift
/
extractor
/
main.cpp
Copy path
File metadata and controls
248 lines (217 loc) · 8.99 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
#
include
<
stdlib.h
>
#
include
<
vector
>
#
include
<
iostream
>
#
include
<
regex
>
#
include
<
unistd.h
>
#
include
<
chrono
>
#
include
<
swift/Basic/LLVMInitialize.h
>
#
include
<
swift/FrontendTool/FrontendTool.h
>
#
include
<
swift/Basic/InitializeSwiftModules.h
>
#
include
"
absl/strings/str_join.h
"
#
include
"
absl/strings/str_cat.h
"
#
include
"
swift/extractor/SwiftExtractor.h
"
#
include
"
swift/extractor/infra/TargetDomains.h
"
#
include
"
swift/extractor/remapping/SwiftFileInterception.h
"
#
include
"
swift/extractor/invocation/SwiftDiagnosticsConsumer.h
"
#
include
"
swift/extractor/invocation/SwiftInvocationExtractor.h
"
#
include
"
swift/extractor/trap/TrapDomain.h
"
#
include
"
swift/extractor/infra/file/Path.h
"
#
include
"
swift/logging/SwiftAssert.h
"
using
namespace
std
::string_literals
;
using
namespace
codeql
::main_logger
;
const
std::string_view codeql::programName =
"
extractor
"
;
//
must be called before processFrontendOptions modifies output paths
static
void
lockOutputSwiftModuleTraps
(codeql::SwiftExtractorState& state,
const
swift::FrontendOptions& options) {
for
(
const
auto
& input : options.
InputsAndOutputs
.
getAllInputs
()) {
if
(
const
auto
&
module
= input.
getPrimarySpecificPaths
().
SupplementaryOutputs
.
ModuleOutputPath
;
!
module
.
empty
()) {
if
(
auto
target =
codeql::createTargetTrapDomain
(state,
codeql::resolvePath
(
module
),
codeql::TrapType::
module
)) {
target->
emitComment
(
"
trap file deliberately empty
\n
"
"
* this swiftmodule was created during the build, so its entities must have
\n
"
"
* been extracted directly from source files
\n
"
);
}
}
}
}
static
void
processFrontendOptions
(codeql::SwiftExtractorState& state,
swift::FrontendOptions& options) {
auto
& inOuts = options.
InputsAndOutputs
;
std::vector<swift::InputFile> inputs;
inOuts.
forEachInput
([&](
const
swift::InputFile& input) {
swift::PrimarySpecificPaths psp{};
if
(std::filesystem::path output = input.
getPrimarySpecificPaths
().
OutputFilename
;
!output.
empty
()) {
if
(output.
extension
() ==
"
.swiftmodule
"
) {
psp.
OutputFilename
=
codeql::redirect
(output);
}
else
{
psp.
OutputFilename
=
"
/dev/null
"
;
}
}
if
(std::filesystem::path
module
=
input.
getPrimarySpecificPaths
().
SupplementaryOutputs
.
ModuleOutputPath
;
!
module
.
empty
()) {
psp.
SupplementaryOutputs
.
ModuleOutputPath
=
codeql::redirect
(
module
);
state.
originalOutputModules
.
push_back
(
module
);
}
auto
inputCopy = input;
inputCopy.
setPrimarySpecificPaths
(
std::move
(psp));
inputs.
push_back
(
std::move
(inputCopy));
return
false
;
});
inOuts.
clearInputs
();
for
(
const
auto
& i : inputs) {
inOuts.
addInput
(i);
}
}
codeql::TrapDomain
invocationTrapDomain
(codeql::SwiftExtractorState& state);
//
This is part of the swiftFrontendTool interface, we hook into the
//
compilation pipeline and extract files after the Swift frontend performed
//
semantic analysis
class
Observer
:
public
swift
::FrontendObserver {
public:
explicit
Observer
(
const
codeql::SwiftExtractorConfiguration& config) : state{config} {}
void
parsedArgs
(swift::CompilerInvocation& invocation)
override
{
auto
& options = invocation.
getFrontendOptions
();
options.
KeepASTContext
=
true
;
lockOutputSwiftModuleTraps
(state, options);
processFrontendOptions
(state, options);
}
void
configuredCompiler
(swift::CompilerInstance& instance)
override
{
//
remove default consumers to avoid double messaging
instance.
getDiags
().
takeConsumers
();
instance.
addDiagnosticConsumer
(&diagConsumer);
}
void
performedCompilation
(swift::CompilerInstance& compiler)
override
{
codeql::extractSwiftFiles
(state, compiler);
codeql::extractSwiftInvocation
(state, compiler, invocationTrap);
codeql::extractExtractLazyDeclarations
(state, compiler);
}
void
markSuccessfullyExtractedFiles
() {
codeql::SwiftLocationExtractor locExtractor{invocationTrap};
for
(
const
auto
& src : state.
sourceFiles
) {
auto
fileLabel = locExtractor.
emitFile
(src);
invocationTrap.
emit
(codeql::FileIsSuccessfullyExtractedTrap{fileLabel});
}
}
private:
codeql::SwiftExtractorState state;
codeql::TrapDomain invocationTrap{
invocationTrapDomain
(state)};
codeql::SwiftDiagnosticsConsumer diagConsumer{invocationTrap};
};
static
std::string
getenv_or
(
const
char
* envvar,
const
std::string& def) {
if
(
const
char
* var =
getenv
(envvar)) {
return
var;
}
return
def;
}
static
bool
checkRunUnderFilter
(
int
argc,
char
*
const
* argv) {
auto
runUnderFilter =
getenv
(
"
CODEQL_EXTRACTOR_SWIFT_RUN_UNDER_FILTER
"
);
if
(runUnderFilter ==
nullptr
) {
return
true
;
}
std::string call = argv[
0
];
for
(
auto
i =
1
; i < argc; ++i) {
call +=
'
'
;
call += argv[i];
}
std::regex filter{runUnderFilter, std::regex_constants::basic | std::regex_constants::nosubs};
return
std::regex_search
(call, filter);
}
//
if `CODEQL_EXTRACTOR_SWIFT_RUN_UNDER` env variable is set, and either
//
* `CODEQL_EXTRACTOR_SWIFT_RUN_UNDER_FILTER` is not set, or
//
* it is set to a regexp matching any substring of the extractor call
//
then the running process is substituted with the command (and possibly
//
options) stated in `CODEQL_EXTRACTOR_SWIFT_RUN_UNDER`, followed by `argv`.
//
Before calling `exec`, `CODEQL_EXTRACTOR_SWIFT_RUN_UNDER` is unset to avoid
//
unpleasant loops.
//
An example usage is to run the extractor under `gdbserver :1234` when the
//
arguments match a given source file.
static
void
checkWhetherToRunUnderTool
(
int
argc,
char
*
const
* argv) {
if
(argc ==
0
)
return
;
auto
runUnder =
getenv
(
"
CODEQL_EXTRACTOR_SWIFT_RUN_UNDER
"
);
if
(runUnder ==
nullptr
|| !
checkRunUnderFilter
(argc, argv)) {
return
;
}
std::vector<
char
*> args;
//
split RUN_UNDER value by spaces to get args vector
for
(
auto
word =
std::strtok
(runUnder,
"
"
); word !=
nullptr
; word =
std::strtok
(
nullptr
,
"
"
)) {
args.
push_back
(word);
}
//
append process args, including extractor executable path
args.
insert
(args.
end
(), argv, argv + argc);
args.
push_back
(
nullptr
);
//
avoid looping on this function
unsetenv
(
"
CODEQL_EXTRACTOR_SWIFT_RUN_UNDER
"
);
execvp
(args[
0
], args.
data
());
}
//
Creates a target file that should store per-invocation info, e.g. compilation args,
//
compilations, diagnostics, etc.
codeql::TrapDomain
invocationTrapDomain
(codeql::SwiftExtractorState& state) {
auto
timestamp =
std::chrono::system_clock::now
().
time_since_epoch
().
count
();
auto
filename =
absl::StrCat
(timestamp,
"
-
"
,
getpid
());
auto
target =
std::filesystem::path
(
"
invocations
"
) /
std::filesystem::path
(filename);
auto
maybeDomain =
codeql::createTargetTrapDomain
(state, target, codeql::TrapType::invocation);
CODEQL_ASSERT
(maybeDomain,
"
Cannot create invocation trap file for {}
"
, target);
return
std::move
(maybeDomain.
value
());
}
codeql::SwiftExtractorConfiguration
configure
(
int
argc,
char
** argv,
const
std::string& resourceDir) {
codeql::SwiftExtractorConfiguration configuration{};
configuration.
trapDir
=
getenv_or
(
"
CODEQL_EXTRACTOR_SWIFT_TRAP_DIR
"
,
"
extractor-out/trap/swift
"
);
configuration.
sourceArchiveDir
=
getenv_or
(
"
CODEQL_EXTRACTOR_SWIFT_SOURCE_ARCHIVE_DIR
"
,
"
extractor-out/src
"
);
configuration.
scratchDir
=
getenv_or
(
"
CODEQL_EXTRACTOR_SWIFT_SCRATCH_DIR
"
,
"
extractor-out/working
"
);
configuration.
frontendOptions
.
assign
(argv +
1
, argv + argc);
//
TODO: Should be moved to the tracer config
for
(
int
i =
0
; i < argc -
1
; i++) {
if
(
std::string
(
"
-resource-dir
"
) == configuration.
frontendOptions
[i]) {
configuration.
frontendOptions
[i +
1
] = resourceDir.
c_str
();
break
;
}
}
return
configuration;
}
static
auto
argDump
(
int
argc,
char
** argv) {
if
(argc <
2
) {
return
"
"
s;
}
return
absl::StrJoin
(argv +
1
, argv + argc,
"
"
);
}
static
auto
envDump
(
char
** envp) {
std::string ret;
for
(
auto
env = envp; *env; ++env) {
ret += *env;
ret +=
'
\n
'
;
}
return
ret;
}
int
main
(
int
argc,
char
** argv,
char
** envp) {
checkWhetherToRunUnderTool
(argc, argv);
if
(argc ==
1
) {
//
TODO: print usage
return
1
;
}
//
Required by Swift/LLVM
PROGRAM_START
(argc, argv);
INITIALIZE_LLVM
();
initializeSwiftModules
();
std::string resourceDir =
getenv_or
(
"
CODEQL_EXTRACTOR_SWIFT_ROOT
"
,
"
.
"
) +
"
/resource-dir/
"
+
getenv_or
(
"
CODEQL_PLATFORM
"
,
"
.
"
);
const
auto
configuration =
configure
(argc, argv, resourceDir);
LOG_INFO
(
"
calling extractor with arguments
\"
{}
\"
"
,
argDump
(argc, argv));
LOG_DEBUG
(
"
environment:
\n
{}
\n
"
,
envDump
(envp));
auto
openInterception =
codeql::setupFileInterception
(configuration);
Observer
observer
(configuration);
int
frontend_rc =
swift::performFrontend
(configuration.
frontendOptions
,
"
swift-extractor
"
,
(
void
*)main, &observer);
if
(frontend_rc ==
0
) {
observer.
markSuccessfullyExtractedFiles
();
}
codeql::Log::flush
();
return
frontend_rc;
}
Back
|
FazBrowse Home
|
New Git URL