Plugins-building.html 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html>
  3. <!-- Copyright (C) 1988-2017 Free Software Foundation, Inc.
  4. Permission is granted to copy, distribute and/or modify this document
  5. under the terms of the GNU Free Documentation License, Version 1.3 or
  6. any later version published by the Free Software Foundation; with the
  7. Invariant Sections being "Funding Free Software", the Front-Cover
  8. Texts being (a) (see below), and with the Back-Cover Texts being (b)
  9. (see below). A copy of the license is included in the section entitled
  10. "GNU Free Documentation License".
  11. (a) The FSF's Front-Cover Text is:
  12. A GNU Manual
  13. (b) The FSF's Back-Cover Text is:
  14. You have freedom to copy and modify this GNU Manual, like GNU
  15. software. Copies published by the Free Software Foundation raise
  16. funds for GNU development. -->
  17. <!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
  18. <head>
  19. <title>GNU Compiler Collection (GCC) Internals: Plugins building</title>
  20. <meta name="description" content="GNU Compiler Collection (GCC) Internals: Plugins building">
  21. <meta name="keywords" content="GNU Compiler Collection (GCC) Internals: Plugins building">
  22. <meta name="resource-type" content="document">
  23. <meta name="distribution" content="global">
  24. <meta name="Generator" content="makeinfo">
  25. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  26. <link href="index.html#Top" rel="start" title="Top">
  27. <link href="Option-Index.html#Option-Index" rel="index" title="Option Index">
  28. <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
  29. <link href="Plugins.html#Plugins" rel="up" title="Plugins">
  30. <link href="LTO.html#LTO" rel="next" title="LTO">
  31. <link href="Plugins-tracking.html#Plugins-tracking" rel="prev" title="Plugins tracking">
  32. <style type="text/css">
  33. <!--
  34. a.summary-letter {text-decoration: none}
  35. blockquote.smallquotation {font-size: smaller}
  36. div.display {margin-left: 3.2em}
  37. div.example {margin-left: 3.2em}
  38. div.indentedblock {margin-left: 3.2em}
  39. div.lisp {margin-left: 3.2em}
  40. div.smalldisplay {margin-left: 3.2em}
  41. div.smallexample {margin-left: 3.2em}
  42. div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
  43. div.smalllisp {margin-left: 3.2em}
  44. kbd {font-style:oblique}
  45. pre.display {font-family: inherit}
  46. pre.format {font-family: inherit}
  47. pre.menu-comment {font-family: serif}
  48. pre.menu-preformatted {font-family: serif}
  49. pre.smalldisplay {font-family: inherit; font-size: smaller}
  50. pre.smallexample {font-size: smaller}
  51. pre.smallformat {font-family: inherit; font-size: smaller}
  52. pre.smalllisp {font-size: smaller}
  53. span.nocodebreak {white-space:nowrap}
  54. span.nolinebreak {white-space:nowrap}
  55. span.roman {font-family:serif; font-weight:normal}
  56. span.sansserif {font-family:sans-serif; font-weight:normal}
  57. ul.no-bullet {list-style: none}
  58. -->
  59. </style>
  60. </head>
  61. <body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
  62. <a name="Plugins-building"></a>
  63. <div class="header">
  64. <p>
  65. Previous: <a href="Plugins-tracking.html#Plugins-tracking" accesskey="p" rel="prev">Plugins tracking</a>, Up: <a href="Plugins.html#Plugins" accesskey="u" rel="up">Plugins</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Option-Index.html#Option-Index" title="Index" rel="index">Index</a>]</p>
  66. </div>
  67. <hr>
  68. <a name="Building-GCC-plugins"></a>
  69. <h3 class="section">23.10 Building GCC plugins</h3>
  70. <p>If plugins are enabled, GCC installs the headers needed to build a
  71. plugin (somewhere in the installation tree, e.g. under
  72. <samp>/usr/local</samp>). In particular a <samp>plugin/include</samp> directory
  73. is installed, containing all the header files needed to build plugins.
  74. </p>
  75. <p>On most systems, you can query this <code>plugin</code> directory by
  76. invoking <code>gcc -print-file-name=plugin</code> (replace if needed
  77. <code>gcc</code> with the appropriate program path).
  78. </p>
  79. <p>Inside plugins, this <code>plugin</code> directory name can be queried by
  80. calling <code>default_plugin_dir_name ()</code>.
  81. </p>
  82. <p>Plugins may know, when they are compiled, the GCC version for which
  83. <samp>plugin-version.h</samp> is provided. The constant macros
  84. <code>GCCPLUGIN_VERSION_MAJOR</code>, <code>GCCPLUGIN_VERSION_MINOR</code>,
  85. <code>GCCPLUGIN_VERSION_PATCHLEVEL</code>, <code>GCCPLUGIN_VERSION</code> are
  86. integer numbers, so a plugin could ensure it is built for GCC 4.7 with
  87. </p><div class="smallexample">
  88. <pre class="smallexample">#if GCCPLUGIN_VERSION != 4007
  89. #error this GCC plugin is for GCC 4.7
  90. #endif
  91. </pre></div>
  92. <p>The following GNU Makefile excerpt shows how to build a simple plugin:
  93. </p>
  94. <div class="smallexample">
  95. <pre class="smallexample">HOST_GCC=g++
  96. TARGET_GCC=gcc
  97. PLUGIN_SOURCE_FILES= plugin1.c plugin2.cc
  98. GCCPLUGINS_DIR:= $(shell $(TARGET_GCC) -print-file-name=plugin)
  99. CXXFLAGS+= -I$(GCCPLUGINS_DIR)/include -fPIC -fno-rtti -O2
  100. plugin.so: $(PLUGIN_SOURCE_FILES)
  101. $(HOST_GCC) -shared $(CXXFLAGS) $^ -o $@
  102. </pre></div>
  103. <p>A single source file plugin may be built with <code>g++ -I`gcc
  104. -print-file-name=plugin`/include -fPIC -shared -fno-rtti -O2 plugin.c -o
  105. plugin.so</code>, using backquote shell syntax to query the <samp>plugin</samp>
  106. directory.
  107. </p>
  108. <p>When a plugin needs to use <code>gengtype</code>, be sure that both
  109. <samp>gengtype</samp> and <samp>gtype.state</samp> have the same version as the
  110. GCC for which the plugin is built.
  111. </p>
  112. </body>
  113. </html>