Plugins-loading.html 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103
  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 loading</title>
  20. <meta name="description" content="GNU Compiler Collection (GCC) Internals: Plugins loading">
  21. <meta name="keywords" content="GNU Compiler Collection (GCC) Internals: Plugins loading">
  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="Plugin-API.html#Plugin-API" rel="next" title="Plugin API">
  31. <link href="Plugins.html#Plugins" rel="prev" title="Plugins">
  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-loading"></a>
  63. <div class="header">
  64. <p>
  65. Next: <a href="Plugin-API.html#Plugin-API" accesskey="n" rel="next">Plugin API</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="Loading-Plugins"></a>
  69. <h3 class="section">23.1 Loading Plugins</h3>
  70. <p>Plugins are supported on platforms that support <samp>-ldl
  71. -rdynamic</samp>. They are loaded by the compiler using <code>dlopen</code>
  72. and invoked at pre-determined locations in the compilation
  73. process.
  74. </p>
  75. <p>Plugins are loaded with
  76. </p>
  77. <p><samp>-fplugin=/path/to/<var>name</var>.so</samp> <samp>-fplugin-arg-<var>name</var>-<var>key1</var>[=<var>value1</var>]</samp>
  78. </p>
  79. <p>The plugin arguments are parsed by GCC and passed to respective
  80. plugins as key-value pairs. Multiple plugins can be invoked by
  81. specifying multiple <samp>-fplugin</samp> arguments.
  82. </p>
  83. <p>A plugin can be simply given by its short name (no dots or
  84. slashes). When simply passing <samp>-fplugin=<var>name</var></samp>, the plugin is
  85. loaded from the <samp>plugin</samp> directory, so <samp>-fplugin=<var>name</var></samp> is
  86. the same as <samp>-fplugin=`gcc -print-file-name=plugin`/<var>name</var>.so</samp>,
  87. using backquote shell syntax to query the <samp>plugin</samp> directory.
  88. </p>
  89. </body>
  90. </html>