Solidity编译器源码解析

MAC下开发环境

安装最新版Xcode,安装后检查make,clang, cmake等工具是否已经安装到系统中。

安装porosity.
porosity是deassembly工具,可以将生成的字节码转成汇编码,这样可以检测字节码正确性。
安装方法可参看: https://github.com/comaeio/porosity

常用命令
solc 将sol文件编译成字节码,然后通过porosity反汇编验证结果。

//生成字节码
solc *.sol --asm
//根据字节码反汇编得到汇编码
porosity --code 60606040526000600160006101000a81548160ff021916908302179055506101bb8061002b6000396000f360606040526000357c010000000000000 --disassm

源码结构:

solc: 程序入口main.cpp ,solc命令参数解析,根据参数调用相应方法。

libsolidity:编译器的核心。

libsolidity/parsing:词法分析,把程序按字符串顺序依次把所有token解析出来,生成AST

libsolidity/ast:AST类包,包括定义各种node类型,node附加信息类,对node的访问,解析,类型等。对节点访问使用了vistor设计模式,因为需要在不同阶段访问不同类型的节点,阶段和节点类型都是动态绑定。

libsolidity/analysis:语义分析,静态分析,类型检查

libsolidity/codegen:根据AST节点生成指令集

libevmasm:根据汇编指令生成字节码

libdevcore:工具

docs :有几个有用的文档比如grammer.rst, assembly.rst


代码解析

solc:

main.cpp: 调用CommandLineInterface的几个函数解析参数和sol文件
setDefaultOrCLocale();
   dev::solidity::CommandLineInterface cli;
   //命令参数解析
   if (!cli.parseArguments(argc, argv))
       return 1;
   //对sol文件进行解析,生成字节码
   if (!cli.processInput())
       return 1;
   bool success = false;
   try
   {
       success = cli.actOnInput();
   }
   catch (boost::exception const& _exception)
   {
       cerr << "Exception during output generation: " << boost::diagnostic_information(_exception) << endl;
       success = false;
   }

   return success ? 0 : 1;
CommandLineInterface.h/cpp:

提供解析命令参数以及编译sol文件的方法。
使用boost::program_options解析参数
调用CompilerStack的对象编译sol文件

    /// Parse command line arguments and return false if we should not continue
    bool parseArguments(int _argc, char** _argv);
    /// Parse the files and create source code objects
    bool processInput();
    /// Perform actions on the input depending on provided compiler arguments
    /// @returns true on success.
    bool actOnInput();

    /// Compiler arguments variable map
    boost::program_options::variables_map m_args;
    /// Solidity compiler stack
    std::unique_ptr<dev::solidity::CompilerStack> m_compiler;

libsolidity:

libsolidity/interface:

CompilerStack.h/cpp

solc编译器, 将sol源码编译生成bytecode字节码
主要函数:parse,analyze,compile,分别执行了编译过程中的词法分析,语法分析,语义分析,代码生成。

    /// Parses all source units that were added
    /// @returns false on error.
    bool parse();

    /// Performs the analysis steps (imports, scopesetting, syntaxCheck, referenceResolving,
    ///  typechecking, staticAnalysis) on previously parsed sources.
    /// @returns false on error.
    bool analyze();

    /// Compiles the source units that were previously added and parsed.
    /// @returns false on error.
    bool compile();

parse()调用Parser类对象的parse方法,返回生成的ast。

Source& source = m_sources[path];
source.scanner->reset();
source.ast = Parser(m_errorReporter).parse(source.scanner);

analyze() 调用libsolidity/analysis下的类对象遍历ast做语法分析,变量名分析,类型检查等。

//语法分析
SyntaxChecker syntaxChecker(m_errorReporter);
for (Source const* source: m_sourceOrder)
    if (!syntaxChecker.checkSyntax(*source->ast))
        noErrors = false;
//解析contract名,方法名
DocStringAnalyser docStringAnalyser(m_errorReporter);
for (Source const* source: m_sourceOrder)
    if (!docStringAnalyser.analyseDocStrings(*source->ast))
        noErrors = false;
//解析变量名和变量类型
NameAndTypeResolver resolver(m_globalContext->declarations(), m_scopes, m_errorReporter);
for (Source const* source: m_sourceOrder)
    if (!resolver.registerDeclarations(*source->ast))
        return false;

compile()
调用libsolidity/codegen 下的Compiler对象生成EVM-assembly 。

compileContract(*contract, compiledContracts);

comiileContract

// Run optimiser and compile the contract.
compiler->compileContract(_contract, _compiledContracts, cborEncodedMetadata);

libsolidity/parsing

Token.h/cpp
定义了Solidity的token集合,包括关键字,操作符。如果要添加新的关键字,首先要在这里把新关键字加到token的enum里。

UnderMaros.h 防止已定义的Token跟一些操作系统环境冲突。

Scanner.h/cpp
将sol文件视为一个长字符串,从头扫到尾,识别和区分各个token,变量名,literal。parser会用scanner 对象去取token。

DocStringParser.h/cpp
解析sol文件的docstring,将每个tag(@)的tag名和内容,保存在m_docTags

/// Mapping tag name -> content.
std::multimap<std::string, DocTag> m_docTags;

Parser.h/cpp
解析每个token,根据token的不同类型调用不同的方法进行解析,并创建不同类型的ASTNode,举例说明:

ASTPointer<IfStatement> Parser::parseIfStatement(ASTPointer<ASTString> const& _docString)
{
    RecursionGuard recursionGuard(*this);
    ASTNodeFactory nodeFactory(*this);
    expectToken(Token::If);
    expectToken(Token::LParen);
    ASTPointer<Expression> condition = parseExpression();
    expectToken(Token::RParen);
    ASTPointer<Statement> trueBody = parseStatement();
    ASTPointer<Statement> falseBody;
    if (m_scanner->currentToken() == Token::Else)
    {
        m_scanner->next();
        falseBody = parseStatement();
        nodeFactory.setEndPositionFromNode(falseBody);
    }
    else
        nodeFactory.setEndPositionFromNode(trueBody);
    return nodeFactory.createNode<IfStatement>(_docString, condition, trueBody, falseBody);
}

未完待续

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,125评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,293评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,054评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,077评论 1 291
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,096评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,062评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,988评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,817评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,266评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,486评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,646评论 1 347
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,375评论 5 342
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,974评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,621评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,796评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,642评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,538评论 2 352

推荐阅读更多精彩内容

  • 标题: Rakudo and NQP Internals子标题: The guts tormented imple...
    焉知非鱼阅读 1,368评论 1 3
  • 引言 维基百科:编译语言(英语:Compiled language)是一种以编译器来实现的编程语言。它不像解释型语...
    Flame_Dream阅读 8,561评论 5 52
  • 前言 2000年,伊利诺伊大学厄巴纳-香槟分校(University of Illinois at Urbana-...
    星光社的戴铭阅读 15,888评论 8 180
  • 如果有来世,我愿意当一棵树,深深的站立大地上,高大而挺立,为我爱的人,遮风挡雨。 如果有来世,我愿意当一只小鸟,自...
    易足乐阅读 216评论 0 0
  • 1、下午的读书会进行的很顺利,对自己的表现也很满意 2、和旺儿的磨合更好了,上午带他出去玩儿,中午赶在读书会前到家...
    星空梦旅人Beverly阅读 81评论 0 0