llvm-rs-cc.cpp revision 8f4d972ef6c6796ffdde603e456979a7004d1e20 
1/*
2 * Copyright 2010, The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *     http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#include <cstdlib>
18#include <list>
19#include <set>
20#include <string>
21#include <utility>
22#include <vector>
23
24#include "clang/Driver/Arg.h"
25#include "clang/Driver/ArgList.h"
26#include "clang/Driver/DriverDiagnostic.h"
27#include "clang/Driver/Option.h"
28#include "clang/Driver/OptTable.h"
29
30#include "clang/Frontend/DiagnosticOptions.h"
31#include "clang/Frontend/TextDiagnosticPrinter.h"
32#include "clang/Frontend/Utils.h"
33
34#include "llvm/ADT/SmallVector.h"
35#include "llvm/ADT/IntrusiveRefCntPtr.h"
36#include "llvm/ADT/OwningPtr.h"
37
38#include "llvm/Support/CommandLine.h"
39#include "llvm/Support/ManagedStatic.h"
40#include "llvm/Support/MemoryBuffer.h"
41#include "llvm/Support/Path.h"
42#include "llvm/Support/raw_ostream.h"
43#include "llvm/Support/system_error.h"
44
45#include "slang.h"
46#include "slang_assert.h"
47#include "slang_diagnostic_buffer.h"
48#include "slang_rs.h"
49#include "slang_rs_reflect_utils.h"
50
51// Class under clang::driver used are enumerated here.
52using clang::driver::arg_iterator;
53using clang::driver::options::DriverOption;
54using clang::driver::Arg;
55using clang::driver::ArgList;
56using clang::driver::InputArgList;
57using clang::driver::Option;
58using clang::driver::OptTable;
59
60// SaveStringInSet, ExpandArgsFromBuf and ExpandArgv are all copied from
61// $(CLANG_ROOT)/tools/driver/driver.cpp for processing argc/argv passed in
62// main().
63static inline const char *SaveStringInSet(std::set<std::string> &SavedStrings,
64                                          llvm::StringRef S) {
65  return SavedStrings.insert(S).first->c_str();
66}
67static void ExpandArgsFromBuf(const char *Arg,
68                              llvm::SmallVectorImpl<const char*> &ArgVector,
69                              std::set<std::string> &SavedStrings);
70static void ExpandArgv(int argc, const char **argv,
71                       llvm::SmallVectorImpl<const char*> &ArgVector,
72                       std::set<std::string> &SavedStrings);
73
74enum {
75  OPT_INVALID = 0,  // This is not an option ID.
76#define OPTION(NAME, ID, KIND, GROUP, ALIAS, FLAGS, PARAM, \
77               HELPTEXT, METAVAR) OPT_##ID,
78#include "RSCCOptions.inc"
79  LastOption
80#undef OPTION
81};
82
83static const OptTable::Info RSCCInfoTable[] = {
84#define OPTION(NAME, ID, KIND, GROUP, ALIAS, FLAGS, PARAM, \
85               HELPTEXT, METAVAR)   \
86  { NAME, HELPTEXT, METAVAR, Option::KIND##Class, FLAGS, PARAM, \
87    OPT_##GROUP, OPT_##ALIAS },
88#include "RSCCOptions.inc"
89};
90
91class RSCCOptTable : public OptTable {
92 public:
93  RSCCOptTable()
94      : OptTable(RSCCInfoTable,
95                 sizeof(RSCCInfoTable) / sizeof(RSCCInfoTable[0])) {
96  }
97};
98
99OptTable *createRSCCOptTable() {
100  return new RSCCOptTable();
101}
102
103///////////////////////////////////////////////////////////////////////////////
104
105class RSCCOptions {
106 public:
107  // The include search paths
108  std::vector<std::string> mIncludePaths;
109
110  // The output directory, if any.
111  std::string mOutputDir;
112
113  // The output type
114  slang::Slang::OutputType mOutputType;
115
116  unsigned mAllowRSPrefix : 1;
117
118  // The name of the target triple to compile for.
119  std::string mTriple;
120
121  // The name of the target CPU to generate code for.
122  std::string mCPU;
123
124  // The list of target specific features to enable or disable -- this should
125  // be a list of strings starting with by '+' or '-'.
126  std::vector<std::string> mFeatures;
127
128  std::string mJavaReflectionPathBase;
129
130  std::string mJavaReflectionPackageName;
131
132  slang::BitCodeStorageType mBitcodeStorage;
133
134  unsigned mOutputDep : 1;
135
136  std::string mOutputDepDir;
137
138  std::vector<std::string> mAdditionalDepTargets;
139
140  unsigned mShowHelp : 1;  // Show the -help text.
141  unsigned mShowVersion : 1;  // Show the -version text.
142
143  unsigned int mTargetAPI;
144
145  RSCCOptions() {
146    mOutputType = slang::Slang::OT_Bitcode;
147    // Triple/CPU/Features must be hard-coded to our chosen portable ABI.
148    mTriple = "armv7-none-linux-gnueabi";
149    mCPU = "";
150    slangAssert(mFeatures.empty());
151    mFeatures.push_back("+long64");
152    mBitcodeStorage = slang::BCST_APK_RESOURCE;
153    mOutputDep = 0;
154    mShowHelp = 0;
155    mShowVersion = 0;
156    mTargetAPI = RS_VERSION;
157  }
158};
159
160// ParseArguments -
161static void ParseArguments(llvm::SmallVectorImpl<const char*> &ArgVector,
162                           llvm::SmallVectorImpl<const char*> &Inputs,
163                           RSCCOptions &Opts,
164                           clang::DiagnosticsEngine &DiagEngine) {
165  if (ArgVector.size() > 1) {
166    const char **ArgBegin = ArgVector.data() + 1;
167    const char **ArgEnd = ArgVector.data() + ArgVector.size();
168    unsigned MissingArgIndex, MissingArgCount;
169    llvm::OwningPtr<OptTable> OptParser(createRSCCOptTable());
170    llvm::OwningPtr<InputArgList> Args(
171      OptParser->ParseArgs(ArgBegin, ArgEnd, MissingArgIndex, MissingArgCount));
172
173    // Check for missing argument error.
174    if (MissingArgCount)
175      DiagEngine.Report(clang::diag::err_drv_missing_argument)
176        << Args->getArgString(MissingArgIndex) << MissingArgCount;
177
178    clang::DiagnosticOptions DiagOpts;
179    DiagOpts.IgnoreWarnings = Args->hasArg(OPT_w);
180    DiagOpts.Warnings = Args->getAllArgValues(OPT_W);
181    clang::ProcessWarningOptions(DiagEngine, DiagOpts);
182
183    // Issue errors on unknown arguments.
184    for (arg_iterator it = Args->filtered_begin(OPT_UNKNOWN),
185        ie = Args->filtered_end(); it != ie; ++it)
186      DiagEngine.Report(clang::diag::err_drv_unknown_argument)
187        << (*it)->getAsString(*Args);
188
189    for (ArgList::const_iterator it = Args->begin(), ie = Args->end();
190        it != ie; ++it) {
191      const Arg *A = *it;
192      if (A->getOption().getKind() == Option::InputClass)
193        Inputs.push_back(A->getValue(*Args));
194    }
195
196    Opts.mIncludePaths = Args->getAllArgValues(OPT_I);
197
198    Opts.mOutputDir = Args->getLastArgValue(OPT_o);
199
200    if (const Arg *A = Args->getLastArg(OPT_M_Group)) {
201      switch (A->getOption().getID()) {
202        case OPT_M: {
203          Opts.mOutputDep = 1;
204          Opts.mOutputType = slang::Slang::OT_Dependency;
205          break;
206        }
207        case OPT_MD: {
208          Opts.mOutputDep = 1;
209          Opts.mOutputType = slang::Slang::OT_Bitcode;
210          break;
211        }
212        default: {
213          slangAssert(false && "Invalid option in M group!");
214        }
215      }
216    }
217
218    if (const Arg *A = Args->getLastArg(OPT_Output_Type_Group)) {
219      switch (A->getOption().getID()) {
220        case OPT_emit_asm: {
221          Opts.mOutputType = slang::Slang::OT_Assembly;
222          break;
223        }
224        case OPT_emit_llvm: {
225          Opts.mOutputType = slang::Slang::OT_LLVMAssembly;
226          break;
227        }
228        case OPT_emit_bc: {
229          Opts.mOutputType = slang::Slang::OT_Bitcode;
230          break;
231        }
232        case OPT_emit_nothing: {
233          Opts.mOutputType = slang::Slang::OT_Nothing;
234          break;
235        }
236        default: {
237          slangAssert(false && "Invalid option in output type group!");
238        }
239      }
240    }
241
242    if (Opts.mOutputDep &&
243        ((Opts.mOutputType != slang::Slang::OT_Bitcode) &&
244         (Opts.mOutputType != slang::Slang::OT_Dependency)))
245      DiagEngine.Report(clang::diag::err_drv_argument_not_allowed_with)
246          << Args->getLastArg(OPT_M_Group)->getAsString(*Args)
247          << Args->getLastArg(OPT_Output_Type_Group)->getAsString(*Args);
248
249    Opts.mAllowRSPrefix = Args->hasArg(OPT_allow_rs_prefix);
250
251    Opts.mJavaReflectionPathBase =
252        Args->getLastArgValue(OPT_java_reflection_path_base);
253    Opts.mJavaReflectionPackageName =
254        Args->getLastArgValue(OPT_java_reflection_package_name);
255
256    llvm::StringRef BitcodeStorageValue =
257        Args->getLastArgValue(OPT_bitcode_storage);
258    if (BitcodeStorageValue == "ar")
259      Opts.mBitcodeStorage = slang::BCST_APK_RESOURCE;
260    else if (BitcodeStorageValue == "jc")
261      Opts.mBitcodeStorage = slang::BCST_JAVA_CODE;
262    else if (!BitcodeStorageValue.empty())
263      DiagEngine.Report(clang::diag::err_drv_invalid_value)
264          << OptParser->getOptionName(OPT_bitcode_storage)
265          << BitcodeStorageValue;
266
267    Opts.mOutputDepDir =
268        Args->getLastArgValue(OPT_output_dep_dir, Opts.mOutputDir);
269    Opts.mAdditionalDepTargets =
270        Args->getAllArgValues(OPT_additional_dep_target);
271
272    Opts.mShowHelp = Args->hasArg(OPT_help);
273    Opts.mShowVersion = Args->hasArg(OPT_version);
274
275    Opts.mTargetAPI = Args->getLastArgIntValue(OPT_target_api,
276                                               RS_VERSION,
277                                               DiagEngine);
278  }
279
280  return;
281}
282
283static const char *DetermineOutputFile(const std::string &OutputDir,
284                                       const char *InputFile,
285                                       slang::Slang::OutputType OutputType,
286                                       std::set<std::string> &SavedStrings) {
287  if (OutputType == slang::Slang::OT_Nothing)
288    return "/dev/null";
289
290  std::string OutputFile(OutputDir);
291
292  // Append '/' to Opts.mOutputDir if not presents
293  if (!OutputFile.empty() &&
294      (OutputFile[OutputFile.size() - 1]) != OS_PATH_SEPARATOR)
295    OutputFile.append(1, OS_PATH_SEPARATOR);
296
297  if (OutputType == slang::Slang::OT_Dependency) {
298    // The build system wants the .d file name stem to be exactly the same as
299    // the source .rs file, instead of the .bc file.
300    OutputFile.append(slang::RSSlangReflectUtils::GetFileNameStem(InputFile));
301  } else {
302    OutputFile.append(
303        slang::RSSlangReflectUtils::BCFileNameFromRSFileName(InputFile));
304  }
305
306  switch (OutputType) {
307    case slang::Slang::OT_Dependency: {
308      OutputFile.append(".d");
309      break;
310    }
311    case slang::Slang::OT_Assembly: {
312      OutputFile.append(".S");
313      break;
314    }
315    case slang::Slang::OT_LLVMAssembly: {
316      OutputFile.append(".ll");
317      break;
318    }
319    case slang::Slang::OT_Object: {
320      OutputFile.append(".o");
321      break;
322    }
323    case slang::Slang::OT_Bitcode: {
324      OutputFile.append(".bc");
325      break;
326    }
327    case slang::Slang::OT_Nothing:
328    default: {
329      slangAssert(false && "Invalid output type!");
330    }
331  }
332
333  return SaveStringInSet(SavedStrings, OutputFile);
334}
335
336#define str(s) #s
337#define wrap_str(s) str(s)
338static void llvm_rs_cc_VersionPrinter() {
339  llvm::raw_ostream &OS = llvm::outs();
340  OS << "llvm-rs-cc: Renderscript compiler\n"
341     << "  (http://developer.android.com/guide/topics/renderscript)\n"
342     << "  based on LLVM (http://llvm.org):\n";
343  OS << "  Built " << __DATE__ << " (" << __TIME__ ").\n";
344  OS << "  Target APIs: " << SLANG_MINIMUM_TARGET_API << " - "
345     << SLANG_MAXIMUM_TARGET_API;
346  OS << "\n  Build type: " << wrap_str(TARGET_BUILD_VARIANT);
347#ifndef __DISABLE_ASSERTS
348  OS << " with assertions";
349#endif
350  OS << ".\n";
351  return;
352}
353#undef wrap_str
354#undef str
355
356int main(int argc, const char **argv) {
357  std::set<std::string> SavedStrings;
358  llvm::SmallVector<const char*, 256> ArgVector;
359  RSCCOptions Opts;
360  llvm::SmallVector<const char*, 16> Inputs;
361  std::string Argv0;
362
363  atexit(llvm::llvm_shutdown);
364
365  ExpandArgv(argc, argv, ArgVector, SavedStrings);
366
367  // Argv0
368  Argv0 = llvm::sys::path::stem(ArgVector[0]);
369
370  // Setup diagnostic engine
371  slang::DiagnosticBuffer *DiagClient = new slang::DiagnosticBuffer();
372
373  llvm::IntrusiveRefCntPtr<clang::DiagnosticIDs> DiagIDs(
374    new clang::DiagnosticIDs());
375
376  clang::DiagnosticsEngine DiagEngine(DiagIDs, DiagClient, true);
377
378  slang::Slang::GlobalInitialization();
379
380  ParseArguments(ArgVector, Inputs, Opts, DiagEngine);
381
382  // Exits when there's any error occurred during parsing the arguments
383  if (DiagEngine.hasErrorOccurred()) {
384    llvm::errs() << DiagClient->str();
385    return 1;
386  }
387
388  if (Opts.mShowHelp) {
389    llvm::OwningPtr<OptTable> OptTbl(createRSCCOptTable());
390    OptTbl->PrintHelp(llvm::outs(), Argv0.c_str(),
391                      "Renderscript source compiler");
392    return 0;
393  }
394
395  if (Opts.mShowVersion) {
396    llvm_rs_cc_VersionPrinter();
397    return 0;
398  }
399
400  // No input file
401  if (Inputs.empty()) {
402    DiagEngine.Report(clang::diag::err_drv_no_input_files);
403    llvm::errs() << DiagClient->str();
404    return 1;
405  }
406
407  // Prepare input data for RS compiler.
408  std::list<std::pair<const char*, const char*> > IOFiles;
409  std::list<std::pair<const char*, const char*> > DepFiles;
410
411  llvm::OwningPtr<slang::SlangRS> Compiler(new slang::SlangRS());
412
413  Compiler->init(Opts.mTriple, Opts.mCPU, Opts.mFeatures, &DiagEngine,
414                 DiagClient);
415
416  for (int i = 0, e = Inputs.size(); i != e; i++) {
417    const char *InputFile = Inputs[i];
418    const char *OutputFile =
419        DetermineOutputFile(Opts.mOutputDir, InputFile,
420                            Opts.mOutputType, SavedStrings);
421
422    if (Opts.mOutputDep) {
423      const char *BCOutputFile, *DepOutputFile;
424
425      if (Opts.mOutputType == slang::Slang::OT_Bitcode)
426        BCOutputFile = OutputFile;
427      else
428        BCOutputFile = DetermineOutputFile(Opts.mOutputDepDir,
429                                           InputFile,
430                                           slang::Slang::OT_Bitcode,
431                                           SavedStrings);
432
433      if (Opts.mOutputType == slang::Slang::OT_Dependency)
434        DepOutputFile = OutputFile;
435      else
436        DepOutputFile = DetermineOutputFile(Opts.mOutputDepDir,
437                                            InputFile,
438                                            slang::Slang::OT_Dependency,
439                                            SavedStrings);
440
441      DepFiles.push_back(std::make_pair(BCOutputFile, DepOutputFile));
442    }
443
444    IOFiles.push_back(std::make_pair(InputFile, OutputFile));
445  }
446
447  // Let's rock!
448  int CompileFailed = !Compiler->compile(IOFiles,
449                                         DepFiles,
450                                         Opts.mIncludePaths,
451                                         Opts.mAdditionalDepTargets,
452                                         Opts.mOutputType,
453                                         Opts.mBitcodeStorage,
454                                         Opts.mAllowRSPrefix,
455                                         Opts.mOutputDep,
456                                         Opts.mTargetAPI,
457                                         Opts.mJavaReflectionPathBase,
458                                         Opts.mJavaReflectionPackageName);
459  Compiler->reset();
460
461  return CompileFailed;
462}
463
464///////////////////////////////////////////////////////////////////////////////
465
466// ExpandArgsFromBuf -
467static void ExpandArgsFromBuf(const char *Arg,
468                              llvm::SmallVectorImpl<const char*> &ArgVector,
469                              std::set<std::string> &SavedStrings) {
470  const char *FName = Arg + 1;
471  llvm::OwningPtr<llvm::MemoryBuffer> MemBuf;
472  if (llvm::MemoryBuffer::getFile(FName, MemBuf)) {
473    // Unable to open the file
474    ArgVector.push_back(SaveStringInSet(SavedStrings, Arg));
475    return;
476  }
477
478  const char *Buf = MemBuf->getBufferStart();
479  char InQuote = ' ';
480  std::string CurArg;
481
482  for (const char *P = Buf; ; ++P) {
483    if (*P == '\0' || (isspace(*P) && InQuote == ' ')) {
484      if (!CurArg.empty()) {
485        if (CurArg[0] != '@') {
486          ArgVector.push_back(SaveStringInSet(SavedStrings, CurArg));
487        } else {
488          ExpandArgsFromBuf(CurArg.c_str(), ArgVector, SavedStrings);
489        }
490
491        CurArg = "";
492      }
493      if (*P == '\0')
494        break;
495      else
496        continue;
497    }
498
499    if (isspace(*P)) {
500      if (InQuote != ' ')
501        CurArg.push_back(*P);
502      continue;
503    }
504
505    if (*P == '"' || *P == '\'') {
506      if (InQuote == *P)
507        InQuote = ' ';
508      else if (InQuote == ' ')
509        InQuote = *P;
510      else
511        CurArg.push_back(*P);
512      continue;
513    }
514
515    if (*P == '\\') {
516      ++P;
517      if (*P != '\0')
518        CurArg.push_back(*P);
519      continue;
520    }
521    CurArg.push_back(*P);
522  }
523}
524
525// ExpandArgsFromBuf -
526static void ExpandArgv(int argc, const char **argv,
527                       llvm::SmallVectorImpl<const char*> &ArgVector,
528                       std::set<std::string> &SavedStrings) {
529  for (int i = 0; i < argc; ++i) {
530    const char *Arg = argv[i];
531    if (Arg[0] != '@') {
532      ArgVector.push_back(SaveStringInSet(SavedStrings, std::string(Arg)));
533      continue;
534    }
535
536    ExpandArgsFromBuf(Arg, ArgVector, SavedStrings);
537  }
538}
539