Ghidra-Decompiler-Analysis-Engine-Document/sleigh__arch_8hh_source.html

/* ###

 * IP: GHIDRA

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */


#ifndef __SLEIGH_ARCH__

#define __SLEIGH_ARCH__


#include "filemanage.hh"

#include "architecture.hh"

#include "sleigh.hh"


class CompilerTag {

  string name;

  string spec;

  string id;

public:

  CompilerTag(void) {}

  void restoreXml(const Element *el);

  const string &getName(void) const { return name; }

  const string &getSpec(void) const { return spec; }

  const string &getId(void) const { return id; }

};


class LanguageDescription {

  string processor;

  bool isbigendian;

  int4 size;

  string variant;

  string version;

  string slafile;

  string processorspec;

  string id;

  string description;

  bool deprecated;

  vector<CompilerTag> compilers;

  vector<TruncationTag> truncations;

public:

  LanguageDescription(void) {}

  void restoreXml(const Element *el);

  const string &getProcessor(void) const { return processor; }

  bool isBigEndian(void) const { return isbigendian; }

  int4 getSize(void) const { return size; }

  const string &getVariant(void) const { return variant; }

  const string &getVersion(void) const { return version; }

  const string &getSlaFile(void) const { return slafile; }

  const string &getProcessorSpec(void) const { return processorspec; }

  const string &getId(void) const { return id; }

  const string &getDescription(void) const { return description; }

  bool isDeprecated(void) const { return deprecated; }

  const CompilerTag &getCompiler(const string &nm) const;

  int4 numTruncations(void) const { return truncations.size(); }

  const TruncationTag &getTruncation(int4 i) const { return truncations[i]; }

};


class SleighArchitecture : public Architecture {

  static Sleigh *last_sleigh;

  static int4 last_languageindex;

  static vector<LanguageDescription> description;

  int4 languageindex;

  string filename;

  string target;

  static void loadLanguageDescription(const string &specfile,ostream &errs);

  bool isTranslateReused(void);

protected:

  ostream *errorstream;

  // buildLoader must be filled in by derived class

  static void collectSpecFiles(ostream &errs);

  virtual Translate *buildTranslator(DocumentStorage &store);

  virtual PcodeInjectLibrary *buildPcodeInjectLibrary(void);

  virtual void buildSpecFile(DocumentStorage &store);

  virtual void modifySpaces(Translate *trans);

  virtual void resolveArchitecture(void);

public:

  SleighArchitecture(const string &fname,const string &targ,ostream *estream);

  const string &getFilename(void) const { return filename; }

  const string &getTarget(void) const { return target; }

  void saveXmlHeader(ostream &s) const;

  void restoreXmlHeader(const Element *el);

  virtual void printMessage(const string &message) const { *errorstream << message << endl; }

  virtual ~SleighArchitecture(void);

  virtual string getDescription(void) const;


  static string normalizeProcessor(const string &nm);

  static string normalizeEndian(const string &nm);

  static string normalizeSize(const string &nm);

  static string normalizeArchitecture(const string &nm);

  static void scanForSleighDirectories(const string &rootpath);

  static void shutdown(void);

  static FileManage specpaths;

};


#endif