web/c-sharp

   1 * MCS: The Ximian C# compiler
   2
   3         MCS is currently able to compile itself and many more C#
   4         programs (there is a test suite included that you can use).
   5         It is routinely used to compile Mono, roughly half a million
   6         lines of C# code.
   7
   8         We are in feature completion mode right now.  There are still
   9         a couple of areas that are not covered by the Mono compiler, but
  10         they are very very few at this point (security attributes),
  11         you can also browse the MCS <a href="http://bugzilla.ximian.com/buglist.cgi?product=Mono%2FMCS&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&changedin=&chfieldfrom=&chfieldto=Now&chfieldvalue=&short_desc=&short_desc_type=substring&long_desc=&long_desc_type=substring&bug_file_loc=&bug_file_loc_type=substring&keywords=&keywords_type=anywords&op_sys_details=&op_sys_details_type=substring&version_details=&version_details_type=substring&cmdtype=doit&newqueryname=&order=Reuse+same+sort+as+last+time&form_name=query">bugs</a> from Bugzilla.
  12
  13         A test suite is maintained to track the progress of
  14         the compiler and various programs are routinely compiled and
  15         ran.
  16
  17 ** Obtaining MCS
  18
  19         The Mono C# compiler is part of the `mcs' module in the Mono CVS
  20         you can get it from our <a href="anoncvs.html">Anonymous CVS</a> server,
  21         or you can get nightly <a href="download.html">download page</a>.
  22
  23 ** Running MCS
  24
  25         MCS is written in C# and uses heavily the .NET APIs.  MCS runs
  26         on Linux with the Mono runtime and on Windows with both the
  27         .NET runtime and the Mono runtime.
  28
  29 ** Reporting Bugs in MCS
  30
  31         When you report a bug, try to provide a small test case that would
  32         show the error so we can include this as part of the Mono C# regression
  33         test suite.
  34
  35         If the bug is an error or a warning that we do not flag, write
  36         a sample program called `csXXXX.cs' where XXXX is the code number
  37         that is used by the Microsoft C# compiler that illustrates the
  38         problem.  That way we can also do regression tests on the invalid
  39         input.
  40
  41 ** Phases of the compiler
  42
  43         The compiler has a number of phases:
  44
  45         <ul>
  46                 * Lexical analyzer: hand-coded lexical analyzer that
  47                   provides tokens to the parser.
  48
  49                 * The Parser: the parser is implemented using Jay (A
  50                   Berkeley Yacc port to Java, that I ported to C#).
  51                   The parser does minimal work and syntax checking,
  52                   and only constructs a parsed tree.
  53
  54                   Each language element gets its own class.  The code
  55                   convention is to use an uppercase name for the
  56                   language element.  So a C# class and its associated
  57                   information is kept in a "Class" class, a "struct"
  58                   in a "Struct" class and so on.  Statements derive
  59                   from the "Statement" class, and Expressions from the
  60                   Expr class.
  61
  62                 * Parent class resolution: before the actual code
  63                   generation, we need to resolve the parents and
  64                   interfaces for interface, classe and struct
  65                   definitions.
  66
  67                 * Semantic analysis: since C# can not resolve in a
  68                   top-down pass what identifiers actually mean, we
  69                   have to postpone this decision until the above steps
  70                   are finished.
  71
  72                 * Code generation: The code generation is done through
  73                   the System.Reflection.Emit API.
  74         </ul>
  75
  76 ** CIL Optimizations.
  77
  78         The compiler performs a number of simple optimizations on its input:
  79         constant folding (this is required by the C# language spec) and
  80         can perform dead code elimination.
  81
  82         Other more interesting optimizations like hoisting are not possible
  83         at this point since the compiler output at this point does not
  84         generate an intermediate representation that is suitable to
  85         perform basic block computation.
  86
  87         Adding an intermediate layer to enable the basic block
  88         computation to the compiler should be a simple task, but we
  89         are considering having a generic CIL optimizer.  Since all the
  90         information that is required to perform basic block-based
  91         optimizations is available at the CIL level, we might just skip
  92         this step altogether and have just a generic IL optimizer that
  93         would perform hoisting on arbitrary CIL programs, not only
  94         those produced by MCS.
  95
  96         If this tool is further expanded to perform constant folding
  97         (not needed for our C# compiler, as it is already in there)
  98         and dead code elimination, other compiler authors might be
  99         able to use this generic CIL optimizer in their projects
 100         reducing their time to develop a production compiler.
 101
 102 ** History
 103
 104         MCS was able to parse itself on April 2001, MCS compiled itself
 105         for the first time on December 28 2001.  MCS became self hosting
 106         on January 3rd, 2002.
 107
 108         The Mono Runtime and the Mono execution engine were able to make
 109         our compiler self hosting on March 12, 2002.
 110
 111 ** Questions and Answers
 112
 113 Q: Why not write a C# front-end for GCC?
 114
 115 A: I wanted to learn about C#, and this was an exercise in this
 116    task.  The resulting compiler is highly object-oriented, which has
 117    lead to a very nice, easy to follow and simple implementation of
 118    the compiler.
 119
 120    I found that the design of this compiler is very similar to
 121    Guavac's implementation.
 122
 123    Targeting the CIL/MSIL byte codes would require to re-architecting
 124    GCC, as GCC is mostly designed to be used for register machines.
 125
 126    The GCC Java engine that generates Java byte codes cheats: it does
 127    not use the GCC backend; it has a special backend just for Java, so
 128    you can not really generate Java bytecodes from the other languages
 129    supported by GCC.
 130
 131 Q: If your C# compiler is written in C#, how do you plan on getting
 132    this working on a non-Microsoft environment.
 133
 134    We will do this through an implementation of the CLI Virtual
 135    Execution System for Unix (our JIT engine).
 136
 137    Our JIT engine is working for the purposes of using the compiler.
 138    The supporting class libraries are being worked on to fully support
 139    the compiler.
 140
 141 Q: Do you use Bison?
 142
 143 A: No, currently I am using Jay which is a port of Berkeley Yacc to
 144    Java that I later ported to C#.  This means that error recovery is
 145    not as nice as I would like to, and for some reason error
 146    productions are not being caught.
 147
 148    In the future I want to port one of the Bison/Java ports to C# for
 149    the parser.
 150
 151 Q: Should someone work on a GCC front-end to C#?
 152
 153 A: I would love if someone does, and we would love to help anyone that
 154    takes on that task, but we do not have the time or expertise to
 155    build a C# compiler with the GCC engine.  I find it a lot more fun
 156    personally to work on C# on a C# compiler, which has an intrinsic
 157    beauty.
 158
 159    We can provide help and assistance to anyone who would like to work
 160    on this task.
 161
 162 Q: Should someone make a GCC backend that will generate CIL images?
 163
 164 A: I would love to see a backend to GCC that generates CIL images.  It
 165    would provide a ton of free compilers that would generate CIL
 166    code.  This is something that people would want to look into
 167    anyways for Windows interoperation in the future.
 168
 169    Again, we would love to provide help and assistance to anyone
 170    interested in working in such a project.
 171
 172 Q: What about making a front-end to GCC that takes CIL images and
 173    generates native code?
 174
 175 A: I would love to see this, specially since GCC supports this same
 176    feature for Java Byte Codes.  You could use the metadata library
 177    from Mono to read the byte codes (ie, this would be your
 178    "front-end") and generate the trees that get passed to the
 179    optimizer.
 180
 181    Ideally our implementation of the CLI will be available as a shared
 182    library that could be linked with your application as its runtime
 183    support.
 184
 185    Again, we would love to provide help and assistance to anyone
 186    interested in working in such a project.
 187
 188 Q: But would this work around the GPL in the GCC compiler and allow
 189    people to work on non-free front-ends?
 190
 191 A: People can already do this by targeting the JVM byte codes (there
 192    are about 130 compilers for various languages that target the JVM).
 193
 194 Q: Why are you writing a JIT engine instead of a front-end to GCC?
 195
 196 A: The JIT engine and runtime engine will be able to execute CIL
 197    executables generated on Windows.
 198
 199 You might also want to look at the <a href="faq.html#gcc">GCC</a>
 200 section on the main FAQ