interface/extract_interface.cc

   1 /*
   2  * Copyright 2011 Sven Verdoolaege. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  *
   8  *    1. Redistributions of source code must retain the above copyright
   9  *       notice, this list of conditions and the following disclaimer.
  10  *
  11  *    2. Redistributions in binary form must reproduce the above
  12  *       copyright notice, this list of conditions and the following
  13  *       disclaimer in the documentation and/or other materials provided
  14  *       with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY SVEN VERDOOLAEGE ''AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  19  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SVEN VERDOOLAEGE OR
  20  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  21  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  22  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
  23  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  * The views and conclusions contained in the software and documentation
  29  * are those of the authors and should not be interpreted as
  30  * representing official policies, either expressed or implied, of
  31  * Sven Verdoolaege.
  32  */
  33
  34 #include "isl_config.h"
  35
  36 #include <assert.h>
  37 #include <iostream>
  38 #include <llvm/Support/raw_ostream.h>
  39 #include <llvm/Support/CommandLine.h>
  40 #include <llvm/Support/Host.h>
  41 #include <llvm/Support/ManagedStatic.h>
  42 #include <clang/AST/ASTContext.h>
  43 #include <clang/AST/ASTConsumer.h>
  44 #include <clang/Basic/FileSystemOptions.h>
  45 #include <clang/Basic/FileManager.h>
  46 #include <clang/Basic/TargetOptions.h>
  47 #include <clang/Basic/TargetInfo.h>
  48 #include <clang/Basic/Version.h>
  49 #include <clang/Driver/Compilation.h>
  50 #include <clang/Driver/Driver.h>
  51 #include <clang/Driver/Tool.h>
  52 #include <clang/Frontend/CompilerInstance.h>
  53 #include <clang/Frontend/CompilerInvocation.h>
  54 #ifdef HAVE_BASIC_DIAGNOSTICOPTIONS_H
  55 #include <clang/Basic/DiagnosticOptions.h>
  56 #else
  57 #include <clang/Frontend/DiagnosticOptions.h>
  58 #endif
  59 #include <clang/Frontend/TextDiagnosticPrinter.h>
  60 #include <clang/Frontend/Utils.h>
  61 #include <clang/Lex/HeaderSearch.h>
  62 #include <clang/Lex/Preprocessor.h>
  63 #include <clang/Parse/ParseAST.h>
  64 #include <clang/Sema/Sema.h>
  65
  66 #include "extract_interface.h"
  67 #include "python.h"
  68
  69 using namespace std;
  70 using namespace clang;
  71 using namespace clang::driver;
  72
  73 static llvm::cl::opt<string> InputFilename(llvm::cl::Positional,
  74                         llvm::cl::Required, llvm::cl::desc("<input file>"));
  75 static llvm::cl::list<string> Includes("I",
  76                         llvm::cl::desc("Header search path"),
  77                         llvm::cl::value_desc("path"), llvm::cl::Prefix);
  78
  79 static const char *ResourceDir = CLANG_PREFIX"/lib/clang/"CLANG_VERSION_STRING;
  80
  81 /* Does decl have an attribute of the following form?
  82  *
  83  *      __attribute__((annotate("name")))
  84  */
  85 bool has_annotation(Decl *decl, const char *name)
  86 {
  87         if (!decl->hasAttrs())
  88                 return false;
  89
  90         AttrVec attrs = decl->getAttrs();
  91         for (AttrVec::const_iterator i = attrs.begin() ; i != attrs.end(); ++i) {
  92                 const AnnotateAttr *ann = dyn_cast<AnnotateAttr>(*i);
  93                 if (!ann)
  94                         continue;
  95                 if (ann->getAnnotation().str() == name)
  96                         return true;
  97         }
  98
  99         return false;
 100 }
 101
 102 /* Is decl marked as exported?
 103  */
 104 static bool is_exported(Decl *decl)
 105 {
 106         return has_annotation(decl, "isl_export");
 107 }
 108
 109 /* Collect all types and functions that are annotated "isl_export"
 110  * in "types" and "function".
 111  *
 112  * We currently only consider single declarations.
 113  */
 114 struct MyASTConsumer : public ASTConsumer {
 115         set<RecordDecl *> types;
 116         set<FunctionDecl *> functions;
 117
 118         virtual HandleTopLevelDeclReturn HandleTopLevelDecl(DeclGroupRef D) {
 119                 Decl *decl;
 120
 121                 if (!D.isSingleDecl())
 122                         return HandleTopLevelDeclContinue;
 123                 decl = D.getSingleDecl();
 124                 if (!is_exported(decl))
 125                         return HandleTopLevelDeclContinue;
 126                 switch (decl->getKind()) {
 127                 case Decl::Record:
 128                         types.insert(cast<RecordDecl>(decl));
 129                         break;
 130                 case Decl::Function:
 131                         functions.insert(cast<FunctionDecl>(decl));
 132                         break;
 133                 default:
 134                         break;
 135                 }
 136                 return HandleTopLevelDeclContinue;
 137         }
 138 };
 139
 140 #ifdef USE_ARRAYREF
 141
 142 #ifdef HAVE_CXXISPRODUCTION
 143 static Driver *construct_driver(const char *binary, DiagnosticsEngine &Diags)
 144 {
 145         return new Driver(binary, llvm::sys::getDefaultTargetTriple(),
 146                             "", false, false, Diags);
 147 }
 148 #else
 149 static Driver *construct_driver(const char *binary, DiagnosticsEngine &Diags)
 150 {
 151         return new Driver(binary, llvm::sys::getDefaultTargetTriple(),
 152                             "", false, Diags);
 153 }
 154 #endif
 155
 156 /* Create a CompilerInvocation object that stores the command line
 157  * arguments constructed by the driver.
 158  * The arguments are mainly useful for setting up the system include
 159  * paths on newer clangs and on some platforms.
 160  */
 161 static CompilerInvocation *construct_invocation(const char *filename,
 162         DiagnosticsEngine &Diags)
 163 {
 164         const char *binary = CLANG_PREFIX"/bin/clang";
 165         const llvm::OwningPtr<Driver> driver(construct_driver(binary, Diags));
 166         std::vector<const char *> Argv;
 167         Argv.push_back(binary);
 168         Argv.push_back(filename);
 169         const llvm::OwningPtr<Compilation> compilation(
 170                 driver->BuildCompilation(llvm::ArrayRef<const char *>(Argv)));
 171         JobList &Jobs = compilation->getJobs();
 172
 173         Command *cmd = cast<Command>(*Jobs.begin());
 174         if (strcmp(cmd->getCreator().getName(), "clang"))
 175                 return NULL;
 176
 177         const ArgStringList *args = &cmd->getArguments();
 178
 179         CompilerInvocation *invocation = new CompilerInvocation;
 180         CompilerInvocation::CreateFromArgs(*invocation, args->data() + 1,
 181                                                 args->data() + args->size(),
 182                                                 Diags);
 183         return invocation;
 184 }
 185
 186 #else
 187
 188 static CompilerInvocation *construct_invocation(const char *filename,
 189         DiagnosticsEngine &Diags)
 190 {
 191         return NULL;
 192 }
 193
 194 #endif
 195
 196 #ifdef HAVE_BASIC_DIAGNOSTICOPTIONS_H
 197
 198 static TextDiagnosticPrinter *construct_printer(void)
 199 {
 200         return new TextDiagnosticPrinter(llvm::errs(), new DiagnosticOptions());
 201 }
 202
 203 #else
 204
 205 static TextDiagnosticPrinter *construct_printer(void)
 206 {
 207         DiagnosticOptions DO;
 208         return new TextDiagnosticPrinter(llvm::errs(), DO);
 209 }
 210
 211 #endif
 212
 213 int main(int argc, char *argv[])
 214 {
 215         llvm::cl::ParseCommandLineOptions(argc, argv);
 216
 217         CompilerInstance *Clang = new CompilerInstance();
 218         Clang->createDiagnostics(0, NULL, construct_printer());
 219         DiagnosticsEngine &Diags = Clang->getDiagnostics();
 220         Diags.setSuppressSystemWarnings(true);
 221         CompilerInvocation *invocation =
 222                 construct_invocation(InputFilename.c_str(), Diags);
 223         if (invocation)
 224                 Clang->setInvocation(invocation);
 225         Clang->createFileManager();
 226         Clang->createSourceManager(Clang->getFileManager());
 227         TargetOptions TO;
 228         TO.Triple = llvm::sys::getDefaultTargetTriple();
 229         TargetInfo *target = TargetInfo::CreateTargetInfo(Diags, TO);
 230         Clang->setTarget(target);
 231         CompilerInvocation::setLangDefaults(Clang->getLangOpts(), IK_C,
 232                                             LangStandard::lang_unspecified);
 233         HeaderSearchOptions &HSO = Clang->getHeaderSearchOpts();
 234         LangOptions &LO = Clang->getLangOpts();
 235         PreprocessorOptions &PO = Clang->getPreprocessorOpts();
 236         HSO.ResourceDir = ResourceDir;
 237
 238         for (int i = 0; i < Includes.size(); ++i)
 239                 HSO.AddPath(Includes[i], frontend::Angled, true, false, false);
 240
 241         PO.addMacroDef("__isl_give=__attribute__((annotate(\"isl_give\")))");
 242         PO.addMacroDef("__isl_keep=__attribute__((annotate(\"isl_keep\")))");
 243         PO.addMacroDef("__isl_take=__attribute__((annotate(\"isl_take\")))");
 244         PO.addMacroDef("__isl_export=__attribute__((annotate(\"isl_export\")))");
 245         PO.addMacroDef("__isl_constructor=__attribute__((annotate(\"isl_constructor\"))) __attribute__((annotate(\"isl_export\")))");
 246         PO.addMacroDef("__isl_subclass(super)=__attribute__((annotate(\"isl_subclass(\" #super \")\"))) __attribute__((annotate(\"isl_export\")))");
 247
 248         Clang->createPreprocessor();
 249         Preprocessor &PP = Clang->getPreprocessor();
 250
 251         PP.getBuiltinInfo().InitializeBuiltins(PP.getIdentifierTable(), LO);
 252
 253         const FileEntry *file = Clang->getFileManager().getFile(InputFilename);
 254         assert(file);
 255         Clang->getSourceManager().createMainFileID(file);
 256
 257         Clang->createASTContext();
 258         MyASTConsumer consumer;
 259         Sema *sema = new Sema(PP, Clang->getASTContext(), consumer);
 260
 261         Diags.getClient()->BeginSourceFile(LO, &PP);
 262         ParseAST(*sema);
 263         Diags.getClient()->EndSourceFile();
 264
 265         generate_python(consumer.types, consumer.functions);
 266
 267         delete sema;
 268         delete Clang;
 269         llvm::llvm_shutdown();
 270
 271         return 0;
 272 }