2
* Copyright (c) 1997, 2024, Oracle and/or its affiliates. All rights reserved.
3
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5
* This code is free software; you can redistribute it and/or modify it
6
* under the terms of the GNU General Public License version 2 only, as
7
* published by the Free Software Foundation.
9
* This code is distributed in the hope that it will be useful, but WITHOUT
10
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12
* version 2 for more details (a copy is included in the LICENSE file that
13
* accompanied this code).
15
* You should have received a copy of the GNU General Public License version
16
* 2 along with this work; if not, write to the Free Software Foundation,
17
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
19
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20
* or visit www.oracle.com if you need additional information or have any
25
// MAIN.CPP - Entry point for the Architecture Description Language Compiler
28
//------------------------------Prototypes-------------------------------------
29
static void usage(ArchDesc& AD); // Print usage message and exit
30
static char *strip_ext(char *fname); // Strip off name extension
31
static char *base_plus_suffix(const char* base, const char *suffix);// New concatenated string
32
static int get_legal_text(FileBuff &fbuf, char **legal_text); // Get pointer to legal text
34
ArchDesc* globalAD = nullptr; // global reference to Architecture Description object
36
const char* get_basename(const char* filename) {37
const char *basename = filename;
39
for (cp = basename; *cp; cp++) {40
if (*cp == '/' || *cp == '\\') {47
//------------------------------main-------------------------------------------
48
int main(int argc, char *argv[])
50
ArchDesc AD; // Architecture Description object
54
ADLParser *ADL_Parse; // ADL Parser object to parse AD file
56
// Check for proper arguments
57
if( argc == 1 ) usage(AD); // No arguments? Then print usage
59
// Read command line arguments and file names
60
for( int i = 1; i < argc; i++ ) { // For all arguments61
char *s = argv[i]; // Get option/filename
63
if( *s++ == '-' ) { // It's a flag? (not a filename)64
if( !*s ) { // Stand-alone `-' means stdin65
//********** INSERT CODE HERE **********
66
} else while (*s != '\0') { // While have flags on option67
switch (*s++) { // Handle flag68
case 'd': // Debug flag
69
AD._dfa_debug += 1; // Set Debug Flag
71
case 'g': // Debug ad location flag
72
AD._adlocation_debug += 1; // Set Debug ad location Flag
74
case 'o': // No Output Flag
75
AD._no_output ^= 1; // Toggle no_output flag
77
case 'q': // Quiet Mode Flag
78
AD._quiet_mode ^= 1; // Toggle quiet_mode flag
80
case 'w': // Disable Warnings Flag
81
AD._disable_warnings ^= 1; // Toggle disable_warnings flag
83
case 'T': // Option to make DFA as many subroutine calls.
84
AD._dfa_small += 1; // Set Mode Flag
86
case 'c': { // Set C++ Output file name87
AD._CPP_file._name = s;
88
const char *base = strip_ext(strdup(s));
89
AD._CPP_CLONE_file._name = base_plus_suffix(base,"_clone.cpp");
90
AD._CPP_EXPAND_file._name = base_plus_suffix(base,"_expand.cpp");
91
AD._CPP_FORMAT_file._name = base_plus_suffix(base,"_format.cpp");
92
AD._CPP_GEN_file._name = base_plus_suffix(base,"_gen.cpp");
93
AD._CPP_MISC_file._name = base_plus_suffix(base,"_misc.cpp");
94
AD._CPP_PEEPHOLE_file._name = base_plus_suffix(base,"_peephole.cpp");
95
AD._CPP_PIPELINE_file._name = base_plus_suffix(base,"_pipeline.cpp");
99
case 'h': // Set C++ Output file name
100
AD._HPP_file._name = s; s += strlen(s);
102
case 'v': // Set C++ Output file name
103
AD._VM_file._name = s; s += strlen(s);
105
case 'a': // Set C++ Output file name
106
AD._DFA_file._name = s;
107
AD._bug_file._name = s;
110
case '#': // Special internal debug flag
111
AD._adl_debug++; // Increment internal debug level
113
case 's': // Output which instructions are cisc-spillable
114
AD._cisc_spill_debug = true;
116
case 'D': // Flag Definition
120
char* def = strchr(flag, '=');
121
if (def == nullptr) def = (char*)"1";
123
AD.set_preproc_def(flag, def);
126
case 'U': // Flag Un-Definition
130
AD.set_preproc_def(flag, nullptr);
133
default: // Unknown option
134
usage(AD); // So print usage and exit
135
} // End of switch on options...
136
} // End of while have options...
138
} else { // Not an option; must be a filename139
AD._ADL_file._name = argv[i]; // Set the input filename
141
// // Files for storage, based on input file name
142
const char *base = strip_ext(strdup(argv[i]));
143
char *temp = base_plus_suffix("dfa_",base);144
AD._DFA_file._name = base_plus_suffix(temp,".cpp");
146
temp = base_plus_suffix("ad_",base);147
AD._CPP_file._name = base_plus_suffix(temp,".cpp");
148
AD._CPP_CLONE_file._name = base_plus_suffix(temp,"_clone.cpp");
149
AD._CPP_EXPAND_file._name = base_plus_suffix(temp,"_expand.cpp");
150
AD._CPP_FORMAT_file._name = base_plus_suffix(temp,"_format.cpp");
151
AD._CPP_GEN_file._name = base_plus_suffix(temp,"_gen.cpp");
152
AD._CPP_MISC_file._name = base_plus_suffix(temp,"_misc.cpp");
153
AD._CPP_PEEPHOLE_file._name = base_plus_suffix(temp,"_peephole.cpp");
154
AD._CPP_PIPELINE_file._name = base_plus_suffix(temp,"_pipeline.cpp");
155
AD._HPP_file._name = base_plus_suffix(temp,".hpp");
157
temp = base_plus_suffix("adGlobals_",base);158
AD._VM_file._name = base_plus_suffix(temp,".hpp");
160
temp = base_plus_suffix("bugs_",base);161
AD._bug_file._name = base_plus_suffix(temp,".out");
163
} // End of files vs options...
164
} // End of while have command line arguments
166
// Open files used to store the matcher and its components
167
if (AD.open_files() == 0) return 1; // Open all input/output files
169
// Build the File Buffer, Parse the input, & Generate Code
170
FileBuff ADL_Buf(&AD._ADL_file, AD); // Create a file buffer for input file
172
// Get pointer to legal text at the beginning of AD file.
173
// It will be used in generated ad files.
175
int legal_sz = get_legal_text(ADL_Buf, &legal_text);
177
ADL_Parse = new ADLParser(ADL_Buf, AD); // Create a parser to parse the buffer
178
ADL_Parse->parse(); // Parse buffer & build description lists
180
if( AD._dfa_debug >= 1 ) { // For higher debug settings, print dump184
delete ADL_Parse; // Delete parser
186
// Verify that the results of the parse are consistent
189
// Check defined operands are used
192
// Prepare to generate the result files:
193
AD.generateMatchLists();
194
AD.identify_unique_operands();
195
AD.identify_cisc_spill_instructions();
196
AD.identify_short_branches();
197
// Make sure every file starts with a copyright:
198
AD.addSunCopyright(legal_text, legal_sz, AD._HPP_file._fp); // .hpp
199
AD.addSunCopyright(legal_text, legal_sz, AD._CPP_file._fp); // .cpp
200
AD.addSunCopyright(legal_text, legal_sz, AD._CPP_CLONE_file._fp); // .cpp
201
AD.addSunCopyright(legal_text, legal_sz, AD._CPP_EXPAND_file._fp); // .cpp
202
AD.addSunCopyright(legal_text, legal_sz, AD._CPP_FORMAT_file._fp); // .cpp
203
AD.addSunCopyright(legal_text, legal_sz, AD._CPP_GEN_file._fp); // .cpp
204
AD.addSunCopyright(legal_text, legal_sz, AD._CPP_MISC_file._fp); // .cpp
205
AD.addSunCopyright(legal_text, legal_sz, AD._CPP_PEEPHOLE_file._fp); // .cpp
206
AD.addSunCopyright(legal_text, legal_sz, AD._CPP_PIPELINE_file._fp); // .cpp
207
AD.addSunCopyright(legal_text, legal_sz, AD._VM_file._fp); // .hpp
208
AD.addSunCopyright(legal_text, legal_sz, AD._DFA_file._fp); // .cpp
209
// Add include guards for all .hpp files
210
AD.addIncludeGuardStart(AD._HPP_file, "GENERATED_ADFILES_AD_HPP"); // .hpp
211
AD.addIncludeGuardStart(AD._VM_file, "GENERATED_ADFILES_ADGLOBALS_HPP"); // .hpp
213
AD.addInclude(AD._CPP_file, "precompiled.hpp");
214
AD.addInclude(AD._CPP_file, "adfiles", get_basename(AD._VM_file._name));
215
AD.addInclude(AD._CPP_file, "adfiles", get_basename(AD._HPP_file._name));
216
AD.addInclude(AD._CPP_file, "memory/allocation.inline.hpp");
217
AD.addInclude(AD._CPP_file, "code/codeCache.hpp");
218
AD.addInclude(AD._CPP_file, "code/compiledIC.hpp");
219
AD.addInclude(AD._CPP_file, "code/nativeInst.hpp");
220
AD.addInclude(AD._CPP_file, "code/vmreg.inline.hpp");
221
AD.addInclude(AD._CPP_file, "gc/shared/collectedHeap.inline.hpp");
222
AD.addInclude(AD._CPP_file, "oops/compressedOops.hpp");
223
AD.addInclude(AD._CPP_file, "oops/markWord.hpp");
224
AD.addInclude(AD._CPP_file, "oops/method.hpp");
225
AD.addInclude(AD._CPP_file, "oops/oop.inline.hpp");
226
AD.addInclude(AD._CPP_file, "opto/c2_MacroAssembler.hpp");
227
AD.addInclude(AD._CPP_file, "opto/cfgnode.hpp");
228
AD.addInclude(AD._CPP_file, "opto/intrinsicnode.hpp");
229
AD.addInclude(AD._CPP_file, "opto/locknode.hpp");
230
AD.addInclude(AD._CPP_file, "opto/opcodes.hpp");
231
AD.addInclude(AD._CPP_file, "opto/regalloc.hpp");
232
AD.addInclude(AD._CPP_file, "opto/regmask.hpp");
233
AD.addInclude(AD._CPP_file, "opto/runtime.hpp");
234
AD.addInclude(AD._CPP_file, "runtime/safepointMechanism.hpp");
235
AD.addInclude(AD._CPP_file, "runtime/sharedRuntime.hpp");
236
AD.addInclude(AD._CPP_file, "runtime/stubRoutines.hpp");
237
AD.addInclude(AD._CPP_file, "utilities/growableArray.hpp");
238
AD.addInclude(AD._CPP_file, "utilities/powerOfTwo.hpp");
239
AD.addInclude(AD._HPP_file, "memory/allocation.hpp");
240
AD.addInclude(AD._HPP_file, "oops/compressedOops.hpp");
241
AD.addInclude(AD._HPP_file, "code/nativeInst.hpp");
242
AD.addInclude(AD._HPP_file, "opto/output.hpp");
243
AD.addInclude(AD._HPP_file, "opto/machnode.hpp");
244
AD.addInclude(AD._HPP_file, "opto/node.hpp");
245
AD.addInclude(AD._HPP_file, "opto/regalloc.hpp");
246
AD.addInclude(AD._HPP_file, "opto/subnode.hpp");
247
AD.addInclude(AD._HPP_file, "opto/vectornode.hpp");
248
AD.addInclude(AD._CPP_CLONE_file, "precompiled.hpp");
249
AD.addInclude(AD._CPP_CLONE_file, "adfiles", get_basename(AD._HPP_file._name));
250
AD.addInclude(AD._CPP_EXPAND_file, "precompiled.hpp");
251
AD.addInclude(AD._CPP_EXPAND_file, "adfiles", get_basename(AD._HPP_file._name));
252
AD.addInclude(AD._CPP_EXPAND_file, "oops/compressedOops.hpp");
253
AD.addInclude(AD._CPP_FORMAT_file, "precompiled.hpp");
254
AD.addInclude(AD._CPP_FORMAT_file, "adfiles", get_basename(AD._HPP_file._name));
255
AD.addInclude(AD._CPP_FORMAT_file, "compiler/oopMap.hpp");
256
AD.addInclude(AD._CPP_GEN_file, "precompiled.hpp");
257
AD.addInclude(AD._CPP_GEN_file, "adfiles", get_basename(AD._HPP_file._name));
258
AD.addInclude(AD._CPP_GEN_file, "opto/cfgnode.hpp");
259
AD.addInclude(AD._CPP_GEN_file, "opto/locknode.hpp");
260
AD.addInclude(AD._CPP_GEN_file, "opto/rootnode.hpp");
261
AD.addInclude(AD._CPP_MISC_file, "precompiled.hpp");
262
AD.addInclude(AD._CPP_MISC_file, "adfiles", get_basename(AD._HPP_file._name));
263
AD.addInclude(AD._CPP_PEEPHOLE_file, "precompiled.hpp");
264
AD.addInclude(AD._CPP_PEEPHOLE_file, "adfiles", get_basename(AD._HPP_file._name));
265
AD.addInclude(AD._CPP_PIPELINE_file, "precompiled.hpp");
266
AD.addInclude(AD._CPP_PIPELINE_file, "adfiles", get_basename(AD._HPP_file._name));
267
AD.addInclude(AD._DFA_file, "precompiled.hpp");
268
AD.addInclude(AD._DFA_file, "adfiles", get_basename(AD._HPP_file._name));
269
AD.addInclude(AD._DFA_file, "oops/compressedOops.hpp");
270
AD.addInclude(AD._DFA_file, "opto/cfgnode.hpp"); // Use PROB_MAX in predicate.
271
AD.addInclude(AD._DFA_file, "opto/intrinsicnode.hpp");
272
AD.addInclude(AD._DFA_file, "opto/matcher.hpp");
273
AD.addInclude(AD._DFA_file, "opto/narrowptrnode.hpp");
274
AD.addInclude(AD._DFA_file, "opto/opcodes.hpp");
275
AD.addInclude(AD._DFA_file, "opto/convertnode.hpp");
276
AD.addInclude(AD._DFA_file, "opto/superword.hpp");
277
AD.addInclude(AD._DFA_file, "utilities/powerOfTwo.hpp");
279
// Make sure each .cpp file starts with include lines:
280
// files declaring and defining generators for Mach* Objects (hpp,cpp)
281
// Generate the result files:
282
// enumerations, class definitions, object generators, and the DFA
283
// file containing enumeration of machine operands & instructions (hpp)
284
AD.addPreHeaderBlocks(AD._HPP_file._fp); // .hpp
285
AD.buildMachOperEnum(AD._HPP_file._fp); // .hpp
286
AD.buildMachOpcodesEnum(AD._HPP_file._fp); // .hpp
287
AD.buildMachRegisterNumbers(AD._VM_file._fp); // VM file
288
AD.buildMachRegisterEncodes(AD._HPP_file._fp); // .hpp file
289
AD.declareRegSizes(AD._HPP_file._fp); // .hpp
290
AD.build_pipeline_enums(AD._HPP_file._fp); // .hpp
291
// output definition of class "State"
292
AD.defineStateClass(AD._HPP_file._fp); // .hpp
293
// file declaring the Mach* classes derived from MachOper and MachNode
294
AD.declareClasses(AD._HPP_file._fp);
295
// declare and define maps: in the .hpp and .cpp files respectively
296
AD.addSourceBlocks(AD._CPP_file._fp); // .cpp
297
AD.addHeaderBlocks(AD._HPP_file._fp); // .hpp
298
AD.buildReduceMaps(AD._HPP_file._fp, AD._CPP_file._fp);
299
AD.buildMustCloneMap(AD._HPP_file._fp, AD._CPP_file._fp);
300
// build CISC_spilling oracle and MachNode::cisc_spill() methods
301
AD.build_cisc_spill_instructions(AD._HPP_file._fp, AD._CPP_file._fp);
302
// define methods for machine dependent State, MachOper, and MachNode classes
303
AD.defineClasses(AD._CPP_file._fp);
304
AD.buildMachOperGenerator(AD._CPP_GEN_file._fp);// .cpp
305
AD.buildMachNodeGenerator(AD._CPP_GEN_file._fp);// .cpp
306
// define methods for machine dependent instruction matching
307
AD.buildInstructMatchCheck(AD._CPP_file._fp); // .cpp
308
// define methods for machine dependent frame management
309
AD.buildFrameMethods(AD._CPP_file._fp); // .cpp
310
AD.generate_needs_deep_clone_jvms(AD._CPP_file._fp);
313
AD.addPreprocessorChecks(AD._CPP_file._fp); // .cpp
314
AD.addPreprocessorChecks(AD._CPP_CLONE_file._fp); // .cpp
315
AD.addPreprocessorChecks(AD._CPP_EXPAND_file._fp); // .cpp
316
AD.addPreprocessorChecks(AD._CPP_FORMAT_file._fp); // .cpp
317
AD.addPreprocessorChecks(AD._CPP_GEN_file._fp); // .cpp
318
AD.addPreprocessorChecks(AD._CPP_MISC_file._fp); // .cpp
319
AD.addPreprocessorChecks(AD._CPP_PEEPHOLE_file._fp); // .cpp
320
AD.addPreprocessorChecks(AD._CPP_PIPELINE_file._fp); // .cpp
322
// define the finite automata that selects lowest cost production
323
AD.buildDFA(AD._DFA_file._fp);
324
// Add include guards for all .hpp files
325
AD.addIncludeGuardEnd(AD._HPP_file, "GENERATED_ADFILES_AD_HPP"); // .hpp
326
AD.addIncludeGuardEnd(AD._VM_file, "GENERATED_ADFILES_ADGLOBALS_HPP"); // .hpp
328
AD.close_files(0); // Close all input/output files
330
// Final printout and statistics
333
if( AD._dfa_debug & 2 ) { // For higher debug settings, print timing info335
// Timer t_total = t_stop - t_start; // Total running time
336
// cerr << "\n---Architecture Description Totals---\n";
337
// cerr << ", Total lines: " << TotalLines;
338
// float l = TotalLines;
339
// cerr << "\nTotal Compilation Time: " << t_total << "\n";
340
// float ft = (float)t_total;
341
// if( ft > 0.0 ) fprintf(stderr,"Lines/sec: %#5.2f\n", l/ft);
343
return (AD._syntax_errs + AD._semantic_errs + AD._internal_errs); // Bye Bye!!
346
//------------------------------usage------------------------------------------
347
static void usage(ArchDesc& AD)
349
printf("Architecture Description Language Compiler\n\n");350
printf("Usage: adlc [-doqwTs] [-#]* [-D<FLAG>[=<DEF>]] [-U<FLAG>] [-c<CPP_FILE_NAME>] [-h<HPP_FILE_NAME>] [-a<DFA_FILE_NAME>] [-v<GLOBALS_FILE_NAME>] <ADL_FILE_NAME>\n");351
printf(" d produce DFA debugging info\n");352
printf(" o no output produced, syntax and semantic checking only\n");353
printf(" q quiet mode, suppresses all non-essential messages\n");354
printf(" w suppress warning messages\n");355
printf(" T make DFA as many subroutine calls\n");356
printf(" s output which instructions are cisc-spillable\n");357
printf(" D define preprocessor symbol\n");358
printf(" U undefine preprocessor symbol\n");359
printf(" c specify CPP file name (default: %s)\n", AD._CPP_file._name);360
printf(" h specify HPP file name (default: %s)\n", AD._HPP_file._name);361
printf(" a specify DFA output file name\n");362
printf(" v specify adGlobals output file name\n");363
printf(" # increment ADL debug level\n");367
//------------------------------open_file------------------------------------
368
int ArchDesc::open_file(bool required, ADLFILE & ADF, const char *action)
371
(ADF._fp = fopen(ADF._name, action)) == nullptr) {372
printf("ERROR: Cannot open file for %s: %s\n", action, ADF._name);379
//------------------------------open_files-------------------------------------
380
int ArchDesc::open_files(void)
382
if (_ADL_file._name == nullptr)
383
{ printf("ERROR: No ADL input file specified\n"); return 0; }385
if (!open_file(true , _ADL_file, "r")) { return 0; }386
if (!open_file(!_no_output, _DFA_file, "w")) { return 0; }387
if (!open_file(!_no_output, _HPP_file, "w")) { return 0; }388
if (!open_file(!_no_output, _CPP_file, "w")) { return 0; }389
if (!open_file(!_no_output, _CPP_CLONE_file, "w")) { return 0; }390
if (!open_file(!_no_output, _CPP_EXPAND_file, "w")) { return 0; }391
if (!open_file(!_no_output, _CPP_FORMAT_file, "w")) { return 0; }392
if (!open_file(!_no_output, _CPP_GEN_file, "w")) { return 0; }393
if (!open_file(!_no_output, _CPP_MISC_file, "w")) { return 0; }394
if (!open_file(!_no_output, _CPP_PEEPHOLE_file, "w")) { return 0; }395
if (!open_file(!_no_output, _CPP_PIPELINE_file, "w")) { return 0; }396
if (!open_file(!_no_output, _VM_file , "w")) { return 0; }397
if (!open_file(_dfa_debug != 0, _bug_file, "w")) { return 0; }402
//------------------------------close_file------------------------------------
403
void ArchDesc::close_file(int delete_out, ADLFILE& ADF)
407
if (delete_out) remove(ADF._name);
411
//------------------------------close_files------------------------------------
412
void ArchDesc::close_files(int delete_out)
414
if (_ADL_file._fp) fclose(_ADL_file._fp);
416
close_file(delete_out, _CPP_file);
417
close_file(delete_out, _CPP_CLONE_file);
418
close_file(delete_out, _CPP_EXPAND_file);
419
close_file(delete_out, _CPP_FORMAT_file);
420
close_file(delete_out, _CPP_GEN_file);
421
close_file(delete_out, _CPP_MISC_file);
422
close_file(delete_out, _CPP_PEEPHOLE_file);
423
close_file(delete_out, _CPP_PIPELINE_file);
424
close_file(delete_out, _HPP_file);
425
close_file(delete_out, _DFA_file);
426
close_file(delete_out, _bug_file);
430
if (_no_output || delete_out) {431
if (_ADL_file._name) printf("%s: ", _ADL_file._name);432
printf("No output produced");435
if (_ADL_file._name) printf("%s --> ", _ADL_file._name);436
printf("%s, %s, %s, %s, %s, %s, %s, %s, %s, %s",438
_CPP_CLONE_file._name,
439
_CPP_EXPAND_file._name,
440
_CPP_FORMAT_file._name,
442
_CPP_MISC_file._name,
443
_CPP_PEEPHOLE_file._name,
444
_CPP_PIPELINE_file._name,
452
//------------------------------strip_ext--------------------------------------
453
static char *strip_ext(char *fname)
458
ep = fname + strlen(fname) - 1; // start at last character and look for '.'
459
while (ep >= fname && *ep != '.') --ep;
460
if (*ep == '.') *ep = '\0'; // truncate string at '.'
465
//------------------------------base_plus_suffix-------------------------------
466
// New concatenated string
467
static char *base_plus_suffix(const char* base, const char *suffix)
469
int len = (int)strlen(base) + (int)strlen(suffix) + 1;
471
char* fname = new char[len];
472
snprintf_checked(fname,len,"%s%s",base,suffix);
476
//------------------------------get_legal_text---------------------------------
477
// Get pointer to legal text at the beginning of AD file.
478
// This code assumes that a legal text starts at the beginning of .ad files,
479
// is commented by "//" at each line and ends with empty line.
481
int get_legal_text(FileBuff &fbuf, char **legal_text)
483
char* legal_start = fbuf.get_line();
484
assert(legal_start[0] == '/' && legal_start[1] == '/', "Incorrect header of AD file");
485
char* legal_end = fbuf.get_line();
486
assert(strncmp(legal_end, "// Copyright", 12) == 0, "Incorrect header of AD file");
487
while(legal_end[0] == '/' && legal_end[1] == '/') {488
legal_end = fbuf.get_line();
490
*legal_text = legal_start;
491
return (int) (legal_end - legal_start);
494
#if !defined(_WIN32) || defined(_WIN64)
495
void *operator new( size_t size, int, const char *, int ) throw() {496
return ::operator new( size );