OSchip
/
OpenBLAS
Not watched
1
0
Fork 0
Code
Releases 66 Wiki evaluate Activity
Issues 0 Pull Requests 0 Datasets Model Cloudbrain HPC
You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.
Tree: 4dd2b5b046
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '4dd2b5b046'
${ noResults }
OpenBLAS/docs/build_system/index.html

608 lines
31 kB
Raw Blame History 

  1. 

  2. <!DOCTYPE html>

  3. 

  4. <html class="no-js" lang="en">

  5. <head>

  6. <meta charset="utf-8"/>

  7. <meta content="width=device-width,initial-scale=1" name="viewport"/>

  8. <link href="https://openblas.net/docs/build_system/" rel="canonical"/>

  9. <link href="../developers/" rel="prev"/>

  10. <link href="../runtime_variables/" rel="next"/>

  11. <link href="../logo.svg" rel="icon"/>

  12. <meta content="mkdocs-1.6.1, mkdocs-material-9.5.50" name="generator"/>

  13. <title>Build system - OpenBLAS</title>

  14. <link href="../assets/stylesheets/main.a40c8224.min.css" rel="stylesheet"/>

  15. <link href="../assets/stylesheets/palette.06af60db.min.css" rel="stylesheet"/>

  16. <link crossorigin="" href="https://fonts.gstatic.com" rel="preconnect"/>

  17. <link href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&amp;display=fallback" rel="stylesheet"/>

  18. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>

  19. <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>

  20. </head>

  21. <body data-md-color-accent="indigo" data-md-color-primary="blue-grey" data-md-color-scheme="slate" dir="ltr">

  22. <input autocomplete="off" class="md-toggle" data-md-toggle="drawer" id="__drawer" type="checkbox"/>

  23. <input autocomplete="off" class="md-toggle" data-md-toggle="search" id="__search" type="checkbox"/>

  24. <label class="md-overlay" for="__drawer"></label>

  25. <div data-md-component="skip">

  26. <a class="md-skip" href="#makefile-dependency-graph">

  27.           Skip to content

  28.         </a>

  29. </div>

  30. <div data-md-component="announce">

  31. </div>

  32. <header class="md-header md-header--shadow" data-md-component="header">

  33. <nav aria-label="Header" class="md-header__inner md-grid">

  34. <a aria-label="OpenBLAS" class="md-header__button md-logo" data-md-component="logo" href=".." title="OpenBLAS">

  35. <img alt="logo" src="../logo.svg"/>

  36. </a>

  37. <label class="md-header__button md-icon" for="__drawer">

  38. <svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"></path></svg>

  39. </label>

  40. <div class="md-header__title" data-md-component="header-title">

  41. <div class="md-header__ellipsis">

  42. <div class="md-header__topic">

  43. <span class="md-ellipsis">

  44.             OpenBLAS

  45.           </span>

  46. </div>

  47. <div class="md-header__topic" data-md-component="header-topic">

  48. <span class="md-ellipsis">

  49.             

  50.               Build system

  51.             

  52.           </span>

  53. </div>

  54. </div>

  55. </div>

  56. <form class="md-header__option" data-md-component="palette">

  57. <input aria-label="Switch to light mode" class="md-option" data-md-color-accent="indigo" data-md-color-media="" data-md-color-primary="blue-grey" data-md-color-scheme="slate" id="__palette_0" name="__palette" type="radio"/>

  58. <label class="md-header__button md-icon" for="__palette_1" hidden="" title="Switch to light mode">

  59. <svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"></path></svg>

  60. </label>

  61. <input aria-label="Switch to dark mode" class="md-option" data-md-color-accent="indigo" data-md-color-media="" data-md-color-primary="blue-grey" data-md-color-scheme="default" id="__palette_1" name="__palette" type="radio"/>

  62. <label class="md-header__button md-icon" for="__palette_0" hidden="" title="Switch to dark mode">

  63. <svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"></path></svg>

  64. </label>

  65. </form>

  66. <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>

  67. <label class="md-header__button md-icon" for="__search">

  68. <svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"></path></svg>

  69. </label>

  70. <div class="md-search" data-md-component="search" role="dialog">

  71. <label class="md-search__overlay" for="__search"></label>

  72. <div class="md-search__inner" role="search">

  73. <form class="md-search__form" name="search">

  74. <input aria-label="Search" autocapitalize="off" autocomplete="off" autocorrect="off" class="md-search__input" data-md-component="search-query" name="query" placeholder="Search" required="" spellcheck="false" type="text"/>

  75. <label class="md-search__icon md-icon" for="__search">

  76. <svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"></path></svg>

  77. <svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"></path></svg>

  78. </label>

  79. <nav aria-label="Search" class="md-search__options">

  80. <button aria-label="Clear" class="md-search__icon md-icon" tabindex="-1" title="Clear" type="reset">

  81. <svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"></path></svg>

  82. </button>

  83. </nav>

  84. </form>

  85. <div class="md-search__output">

  86. <div class="md-search__scrollwrap" data-md-scrollfix="" tabindex="0">

  87. <div class="md-search-result" data-md-component="search-result">

  88. <div class="md-search-result__meta">

  89.             Initializing search

  90.           </div>

  91. <ol class="md-search-result__list" role="presentation"></ol>

  92. </div>

  93. </div>

  94. </div>

  95. </div>

  96. </div>

  97. <div class="md-header__source">

  98. <a class="md-source" data-md-component="source" href="https://github.com/OpenMathLib/OpenBLAS" title="Go to repository">

  99. <div class="md-source__icon md-icon">

  100. <svg viewbox="0 0 448 512" xmlns="http://www.w3.org/2000/svg"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"></path></svg>

  101. </div>

  102. <div class="md-source__repository">

  103.     GitHub

  104.   </div>

  105. </a>

  106. </div>

  107. </nav>

  108. </header>

  109. <div class="md-container" data-md-component="container">

  110. <main class="md-main" data-md-component="main">

  111. <div class="md-main__inner md-grid">

  112. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation">

  113. <div class="md-sidebar__scrollwrap">

  114. <div class="md-sidebar__inner">

  115. <nav aria-label="Navigation" class="md-nav md-nav--primary" data-md-level="0">

  116. <label class="md-nav__title" for="__drawer">

  117. <a aria-label="OpenBLAS" class="md-nav__button md-logo" data-md-component="logo" href=".." title="OpenBLAS">

  118. <img alt="logo" src="../logo.svg"/>

  119. </a>

  120.     OpenBLAS

  121.   </label>

  122. <div class="md-nav__source">

  123. <a class="md-source" data-md-component="source" href="https://github.com/OpenMathLib/OpenBLAS" title="Go to repository">

  124. <div class="md-source__icon md-icon">

  125. <svg viewbox="0 0 448 512" xmlns="http://www.w3.org/2000/svg"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"></path></svg>

  126. </div>

  127. <div class="md-source__repository">

  128.     GitHub

  129.   </div>

  130. </a>

  131. </div>

  132. <ul class="md-nav__list" data-md-scrollfix="">

  133. <li class="md-nav__item">

  134. <a class="md-nav__link" href="..">

  135. <span class="md-ellipsis">

  136.     Home

  137.   </span>

  138. </a>

  139. </li>

  140. <li class="md-nav__item">

  141. <a class="md-nav__link" href="../install/">

  142. <span class="md-ellipsis">

  143.     Install OpenBLAS

  144.   </span>

  145. </a>

  146. </li>

  147. <li class="md-nav__item">

  148. <a class="md-nav__link" href="../user_manual/">

  149. <span class="md-ellipsis">

  150.     User manual

  151.   </span>

  152. </a>

  153. </li>

  154. <li class="md-nav__item">

  155. <a class="md-nav__link" href="../extensions/">

  156. <span class="md-ellipsis">

  157.     Extensions

  158.   </span>

  159. </a>

  160. </li>

  161. <li class="md-nav__item">

  162. <a class="md-nav__link" href="../developers/">

  163. <span class="md-ellipsis">

  164.     Developer manual

  165.   </span>

  166. </a>

  167. </li>

  168. <li class="md-nav__item md-nav__item--active">

  169. <input class="md-nav__toggle md-toggle" id="__toc" type="checkbox"/>

  170. <label class="md-nav__link md-nav__link--active" for="__toc">

  171. <span class="md-ellipsis">

  172.     Build system

  173.   </span>

  174. <span class="md-nav__icon md-icon"></span>

  175. </label>

  176. <a class="md-nav__link md-nav__link--active" href="./">

  177. <span class="md-ellipsis">

  178.     Build system

  179.   </span>

  180. </a>

  181. <nav aria-label="Table of contents" class="md-nav md-nav--secondary">

  182. <label class="md-nav__title" for="__toc">

  183. <span class="md-nav__icon md-icon"></span>

  184.       Table of contents

  185.     </label>

  186. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix="">

  187. <li class="md-nav__item">

  188. <a class="md-nav__link" href="#makefile-dependency-graph">

  189. <span class="md-ellipsis">

  190.       Makefile dependency graph

  191.     </span>

  192. </a>

  193. </li>

  194. <li class="md-nav__item">

  195. <a class="md-nav__link" href="#important-variables">

  196. <span class="md-ellipsis">

  197.       Important Variables

  198.     </span>

  199. </a>

  200. <nav aria-label="Important Variables" class="md-nav">

  201. <ul class="md-nav__list">

  202. <li class="md-nav__item">

  203. <a class="md-nav__link" href="#cpu-related">

  204. <span class="md-ellipsis">

  205.       CPU related

  206.     </span>

  207. </a>

  208. </li>

  209. <li class="md-nav__item">

  210. <a class="md-nav__link" href="#toolchain-related">

  211. <span class="md-ellipsis">

  212.       Toolchain related

  213.     </span>

  214. </a>

  215. </li>

  216. <li class="md-nav__item">

  217. <a class="md-nav__link" href="#library-related">

  218. <span class="md-ellipsis">

  219.       Library related

  220.     </span>

  221. </a>

  222. <nav aria-label="Library related" class="md-nav">

  223. <ul class="md-nav__list">

  224. <li class="md-nav__item">

  225. <a class="md-nav__link" href="#library-kind-and-bitness-options">

  226. <span class="md-ellipsis">

  227.       Library kind and bitness options

  228.     </span>

  229. </a>

  230. </li>

  231. <li class="md-nav__item">

  232. <a class="md-nav__link" href="#data-type-options">

  233. <span class="md-ellipsis">

  234.       Data type options

  235.     </span>

  236. </a>

  237. </li>

  238. <li class="md-nav__item">

  239. <a class="md-nav__link" href="#threading-options">

  240. <span class="md-ellipsis">

  241.       Threading options

  242.     </span>

  243. </a>

  244. </li>

  245. <li class="md-nav__item">

  246. <a class="md-nav__link" href="#library-and-symbol-name-options">

  247. <span class="md-ellipsis">

  248.       Library and symbol name options

  249.     </span>

  250. </a>

  251. </li>

  252. <li class="md-nav__item">

  253. <a class="md-nav__link" href="#blas-and-lapack-options">

  254. <span class="md-ellipsis">

  255.       BLAS and LAPACK options

  256.     </span>

  257. </a>

  258. </li>

  259. </ul>

  260. </nav>

  261. </li>

  262. </ul>

  263. </nav>

  264. </li>

  265. </ul>

  266. </nav>

  267. </li>

  268. <li class="md-nav__item">

  269. <a class="md-nav__link" href="../runtime_variables/">

  270. <span class="md-ellipsis">

  271.     Runtime variables

  272.   </span>

  273. </a>

  274. </li>

  275. <li class="md-nav__item">

  276. <a class="md-nav__link" href="../distributing/">

  277. <span class="md-ellipsis">

  278.     Redistributing OpenBLAS

  279.   </span>

  280. </a>

  281. </li>

  282. <li class="md-nav__item">

  283. <a class="md-nav__link" href="../ci/">

  284. <span class="md-ellipsis">

  285.     CI jobs

  286.   </span>

  287. </a>

  288. </li>

  289. <li class="md-nav__item">

  290. <a class="md-nav__link" href="../about/">

  291. <span class="md-ellipsis">

  292.     About

  293.   </span>

  294. </a>

  295. </li>

  296. <li class="md-nav__item">

  297. <a class="md-nav__link" href="../faq/">

  298. <span class="md-ellipsis">

  299.     FAQ

  300.   </span>

  301. </a>

  302. </li>

  303. </ul>

  304. </nav>

  305. </div>

  306. </div>

  307. </div>

  308. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc">

  309. <div class="md-sidebar__scrollwrap">

  310. <div class="md-sidebar__inner">

  311. <nav aria-label="Table of contents" class="md-nav md-nav--secondary">

  312. <label class="md-nav__title" for="__toc">

  313. <span class="md-nav__icon md-icon"></span>

  314.       Table of contents

  315.     </label>

  316. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix="">

  317. <li class="md-nav__item">

  318. <a class="md-nav__link" href="#makefile-dependency-graph">

  319. <span class="md-ellipsis">

  320.       Makefile dependency graph

  321.     </span>

  322. </a>

  323. </li>

  324. <li class="md-nav__item">

  325. <a class="md-nav__link" href="#important-variables">

  326. <span class="md-ellipsis">

  327.       Important Variables

  328.     </span>

  329. </a>

  330. <nav aria-label="Important Variables" class="md-nav">

  331. <ul class="md-nav__list">

  332. <li class="md-nav__item">

  333. <a class="md-nav__link" href="#cpu-related">

  334. <span class="md-ellipsis">

  335.       CPU related

  336.     </span>

  337. </a>

  338. </li>

  339. <li class="md-nav__item">

  340. <a class="md-nav__link" href="#toolchain-related">

  341. <span class="md-ellipsis">

  342.       Toolchain related

  343.     </span>

  344. </a>

  345. </li>

  346. <li class="md-nav__item">

  347. <a class="md-nav__link" href="#library-related">

  348. <span class="md-ellipsis">

  349.       Library related

  350.     </span>

  351. </a>

  352. <nav aria-label="Library related" class="md-nav">

  353. <ul class="md-nav__list">

  354. <li class="md-nav__item">

  355. <a class="md-nav__link" href="#library-kind-and-bitness-options">

  356. <span class="md-ellipsis">

  357.       Library kind and bitness options

  358.     </span>

  359. </a>

  360. </li>

  361. <li class="md-nav__item">

  362. <a class="md-nav__link" href="#data-type-options">

  363. <span class="md-ellipsis">

  364.       Data type options

  365.     </span>

  366. </a>

  367. </li>

  368. <li class="md-nav__item">

  369. <a class="md-nav__link" href="#threading-options">

  370. <span class="md-ellipsis">

  371.       Threading options

  372.     </span>

  373. </a>

  374. </li>

  375. <li class="md-nav__item">

  376. <a class="md-nav__link" href="#library-and-symbol-name-options">

  377. <span class="md-ellipsis">

  378.       Library and symbol name options

  379.     </span>

  380. </a>

  381. </li>

  382. <li class="md-nav__item">

  383. <a class="md-nav__link" href="#blas-and-lapack-options">

  384. <span class="md-ellipsis">

  385.       BLAS and LAPACK options

  386.     </span>

  387. </a>

  388. </li>

  389. </ul>

  390. </nav>

  391. </li>

  392. </ul>

  393. </nav>

  394. </li>

  395. </ul>

  396. </nav>

  397. </div>

  398. </div>

  399. </div>

  400. <div class="md-content" data-md-component="content">

  401. <article class="md-content__inner md-typeset">

  402. <h1>Build system</h1>

  403. <div class="admonition info">

  404. <p class="admonition-title">Supported build systems</p>

  405. <p>This page describes the Make-based build, which is the

  406. default/authoritative build method. Note that the OpenBLAS repository also

  407. supports building with CMake (not described here) - that generally works

  408. and is tested, however there may be small differences between the Make and

  409. CMake builds.</p>

  410. </div>

  411. <h2 id="makefile-dependency-graph">Makefile dependency graph</h2>

  412. <!---

  413. An easy way to update this diagram is to copy it into https://mermaid.live

  414. and edit it interactively.

  415. -->

  416. <pre class="mermaid"><code>flowchart LR

  417.     A[Makefile] --&gt;|included by many of the Makefiles in the subdirectories!| B(Makefile.system)

  418.         B --&gt;|triggered, not included, once by Makefile.system, and runs before any of the actual library code is built. builds and runs the 'getarch' tool for cpu identification, runs the compiler detection scripts c_check/f_check| C{Makefile.prebuild}

  419.             C --&gt;|either this or Makefile_kernel.conf is generated| D[Makefile.conf]

  420.             C --&gt;|temporary Makefile.conf during DYNAMIC_ARCH builds| E[Makefile_kernel.conf]

  421.         B --&gt;|defaults for build options that can be given on the make command line| F[Makefile.rule]

  422.         B --&gt;|architecture-specific compiler options and OpenBLAS buffer size values| G[Makefile.$ARCH]

  423.     A --&gt; exports

  424.     A --&gt;|directories: test, ctest, utest, cpp_thread_test| H(test directories)

  425.     A --&gt; I($BLASDIRS)

  426.         I --&gt; interface

  427.         I --&gt; driver/level2

  428.         I --&gt; driver/level3

  429.         I --&gt; driver/others

  430.     A --&gt;|for each target in DYNAMIC_CORE if DYNAMIC_ARCH=1| kernel

  431.     A --&gt;|subdirs: timing, testing, testing/EIG, testing/LIN| J($NETLIB_LAPACK_DIR)

  432.     A --&gt; relapack

  433. </code></pre>

  434. <h2 id="important-variables">Important Variables</h2>

  435. <p>Most of the tunable variables are found in

  436. <a href="https://github.com/xianyi/OpenBLAS/blob/develop/Makefile.rule">Makefile.rule</a>,

  437. along with their detailed descriptions.</p>

  438. <p>Most of the variables are detected automatically in

  439. <a href="https://github.com/xianyi/OpenBLAS/blob/develop/Makefile.prebuild">Makefile.prebuild</a>,

  440. if they are not set in the environment.</p>

  441. <p>The most commonly used variables are documented below. There are more options

  442. though - please read the linked Makefiles if you want to see all variables.</p>

  443. <h3 id="cpu-related">CPU related</h3>

  444. <ul>

  445. <li><code>ARCH</code>: target architecture (e.g., <code>x86-64</code>).</li>

  446. <li><code>DYNAMIC_ARCH</code>: For building library for multiple <code>TARGET</code>s (does not lose any

  447.   optimizations, but increases library size).</li>

  448. <li><code>DYNAMIC_LIST</code>: optional user-provided subset of the <code>DYNAMIC_CORE</code> list in

  449.    <a href="https://github.com/xianyi/OpenBLAS/blob/develop/Makefile.system">Makefile.system</a>.</li>

  450. <li><code>TARGET</code>: target CPU architecture. In case of <code>DYNAMIC_ARCH=1</code>, it means that

  451.   the library will not be usable on less capable CPUs.</li>

  452. <li><code>TARGET_CORE</code>: override <code>TARGET</code> internally during each CPU-specific cycle of

  453.   the build for <code>DYNAMIC_ARCH</code>.</li>

  454. </ul>

  455. <h3 id="toolchain-related">Toolchain related</h3>

  456. <ul>

  457. <li><code>CC</code>: <code>TARGET</code> C compiler used for compilation (can be cross-toolchains).</li>

  458. <li><code>FC</code>: <code>TARGET</code> Fortran compiler used for compilation (can be cross-toolchains,

  459.   set <code>NOFORTRAN=1</code> if the used cross-toolchain has no Fortran compiler).</li>

  460. <li><code>COMMON_OPT</code>: flags to add to all invocations of the target C and Fortran compilers

  461.   (overrides <code>CFLAGS</code>/<code>FFLAGS</code> - prefer using <code>COMMON_OPT</code>)</li>

  462. <li><code>CCOMMON_OPT</code>: flags to add to all invocations of the target C compiler

  463.   (overrides <code>CFLAGS</code>)</li>

  464. <li><code>FCOMMON_OPT</code>: flags to add to all invocations of the target Fortran compiler

  465.   (overrides <code>FFLAGS</code>)</li>

  466. <li><code>LDFLAGS</code>: flags to add to all target linker invocations</li>

  467. <li><code>AR</code>, <code>AS</code>, <code>LD</code>, <code>RANLIB</code>: <code>TARGET</code> toolchain helpers used for compilation

  468.   (can be cross-toolchains).</li>

  469. <li><code>HOSTCC</code>: compiler of build machine, needed to create proper config files for

  470.   the target architecture.</li>

  471. <li><code>HOST_CFLAGS</code>: flags for the build machine compiler.</li>

  472. </ul>

  473. <h3 id="library-related">Library related</h3>

  474. <h4 id="library-kind-and-bitness-options">Library kind and bitness options</h4>

  475. <ul>

  476. <li><code>BINARY</code>: whether to build a 32-bit or 64-bit library (default is <code>64</code>, set

  477.   to <code>32</code> on a 32-bit platform).</li>

  478. <li><code>INTERFACE64</code>: build with 64-bit (ILP64) integer representations to support

  479.   large array index values (incompatible with the standard 32-bit integer (LP64) API).</li>

  480. <li><code>NO_STATIC</code>: if set to <code>1</code>, don't build a static library (default is <code>0</code>)</li>

  481. <li><code>NO_SHARED</code>: if set to <code>1</code>, don't build a shared library (default is <code>0</code>)</li>

  482. </ul>

  483. <h4 id="data-type-options">Data type options</h4>

  484. <ul>

  485. <li><code>BUILD_SINGLE</code>: build the single-precision real functions of BLAS and (if

  486.   it's built) LAPACK</li>

  487. <li><code>BUILD_DOUBLE</code>: build the double-precision real functions</li>

  488. <li><code>BUILD_COMPLEX</code>: build the single-precision complex functions</li>

  489. <li><code>BUILD_COMPLEX16</code>: build the double-precision complex functions</li>

  490. <li><code>BUILD_BFLOAT16</code>: build the "half precision brainfloat" real functions </li>

  491. <li><code>EXPRECISION</code>: (do not use, this is a work in progress) option to use <code>long

  492.   double</code> functions</li>

  493. </ul>

  494. <p>By default, the single- and double-precision real and complex floating-point

  495. functions are included in the build, while the half- and extended-precision

  496. functions are not.</p>

  497. <h4 id="threading-options">Threading options</h4>

  498. <ul>

  499. <li><code>USE_THREAD</code>: Use a multithreading backend (defaults to <code>pthreads</code>).</li>

  500. <li><code>USE_LOCKING</code>: implement locking for thread safety even when <code>USE_THREAD</code> is

  501.   not set (so that the single-threaded library can safely be called from

  502.   multithreaded programs).</li>

  503. <li><code>USE_OPENMP</code>: Use OpenMP as multithreading backend</li>

  504. <li><code>NUM_THREADS</code>: define this to the maximum number of parallel threads you

  505.   expect to need (defaults to the number of cores in the build CPU).</li>

  506. <li><code>NUM_PARALLEL</code>: define this to the number of OpenMP instances that your code

  507.   may use for parallel calls into OpenBLAS (the default is <code>1</code>, see below).</li>

  508. </ul>

  509. <p>OpenBLAS uses a fixed set of memory buffers internally, used for communicating

  510. and compiling partial results from individual threads. For efficiency, the

  511. management array structure for these buffers is sized at build time - this

  512. makes it necessary to know in advance how many threads need to be supported on

  513. the target system(s).</p>

  514. <p>With OpenMP, there is an additional level of complexity as there may be calls

  515. originating from a parallel region in the calling program. If OpenBLAS gets

  516. called from a single parallel region, it runs single-threaded automatically to

  517. avoid overloading the system by fanning out its own set of threads. In the case

  518. that an OpenMP program makes multiple calls from independent regions or

  519. instances in parallel, this default serialization is not sufficient as the

  520. additional caller(s) would compete for the original set of buffers already in

  521. use by the first call. So if multiple OpenMP runtimes call into OpenBLAS at the

  522. same time, then only one of them will be able to make progress while all the

  523. rest of them spin-wait for the one available buffer. Setting <code>NUM_PARALLEL</code> to

  524. the upper bound on the number of OpenMP runtimes that you can have in a process

  525. ensures that there are a sufficient number of buffer sets available.</p>

  526. <h4 id="library-and-symbol-name-options">Library and symbol name options</h4>

  527. <ul>

  528. <li><code>FIXED_LIBNAME</code>: if set to <code>1</code>, uses a non-versioned name for the library and

  529.   no symbolic linking to variant names (default is <code>0</code>)</li>

  530. <li><code>LIBNAMEPREFIX</code>: prefix that, if given, will be inserted in the library name

  531.   before <code>openblas</code> (e.g., <code>xxx</code> will result in <code>libxxxopenblas.so</code>)</li>

  532. <li><code>LIBNAMESUFFIX</code>: suffix that, if given, will be inserted in the library name

  533.   after <code>openblas</code>, separated by an underscore (e.g., <code>yyy</code> will result in

  534.   <code>libopenblas_yyy.so</code>)</li>

  535. <li><code>SYMBOLPREFIX</code>: prefix that, if given, will be added to all symbol names

  536.   <em>and</em> to the library name</li>

  537. <li><code>SYMBOLSUFFIX</code>: suffix that, if given, will be added to all symbol names

  538.   <em>and</em> to the library name</li>

  539. </ul>

  540. <h4 id="blas-and-lapack-options">BLAS and LAPACK options</h4>

  541. <p>By default, the Fortran and C interfaces to BLAS and LAPACK are built,

  542. including deprecated functions, while

  543. <a href="https://github.com/HPAC/ReLAPACK">ReLAPACK</a> is not.</p>

  544. <ul>

  545. <li><code>NO_CBLAS</code>: if set to <code>1</code>, don't build the CBLAS interface (default is <code>0</code>)</li>

  546. <li><code>ONLY_CBLAS</code>: if set to <code>1</code>, only build the CBLAS interface (default is <code>0</code>)</li>

  547. <li><code>NO_LAPACK</code>: if set to <code>1</code>, don't build LAPACK (default is <code>0</code>)</li>

  548. <li><code>NO_LAPACKE</code>: if set to <code>1</code>, don't build the LAPACKE interface (default is <code>0</code>)</li>

  549. <li><code>BUILD_LAPACK_DEPRECATED</code>: if set to <code>0</code>, don't build deprecated LAPACK

  550.   functions (default is <code>1</code>)</li>

  551. <li><code>BUILD_RELAPACK</code>: if set to <code>1</code>, build Recursive LAPACK on top of LAPACK

  552.   (default is <code>0</code>)</li>

  553. </ul>

  554. <aside class="md-source-file">

  555. <span class="md-source-file__fact">

  556. <span class="md-icon" title="Last update">

  557. <svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"></path></svg>

  558. </span>

  559. <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">January 4, 2025</span>

  560. </span>

  561. <span class="md-source-file__fact">

  562. <span class="md-icon" title="Created">

  563. <svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M14.47 15.08 11 13V7h1.5v5.25l3.08 1.83c-.41.28-.79.62-1.11 1m-1.39 4.84c-.36.05-.71.08-1.08.08-4.42 0-8-3.58-8-8s3.58-8 8-8 8 3.58 8 8c0 .37-.03.72-.08 1.08.69.1 1.33.32 1.92.64.1-.56.16-1.13.16-1.72 0-5.5-4.5-10-10-10S2 6.5 2 12s4.47 10 10 10c.59 0 1.16-.06 1.72-.16-.32-.59-.54-1.23-.64-1.92M18 15v3h-3v2h3v3h2v-3h3v-2h-3v-3z"></path></svg>

  564. </span>

  565. <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 4, 2023</span>

  566. </span>

  567. </aside>

  568. </article>

  569. </div>

  570. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>

  571. </div>

  572. </main>

  573. <footer class="md-footer">

  574. <div class="md-footer-meta md-typeset">

  575. <div class="md-footer-meta__inner md-grid">

  576. <div class="md-copyright">

  577. <div class="md-copyright__highlight">

  578.       Copyright © 2012- OpenBLAS contributors

  579.     </div>

  580.   

  581.   

  582.     Made with

  583.     <a href="https://squidfunk.github.io/mkdocs-material/" rel="noopener" target="_blank">

  584.       Material for MkDocs

  585.     </a>

  586. </div>

  587. <div class="md-social">

  588. <a class="md-social__link" href="https://github.com/OpenMathLib/OpenBLAS" rel="noopener" target="_blank" title="github.com">

  589. <svg viewbox="0 0 496 512" xmlns="http://www.w3.org/2000/svg"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8M97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"></path></svg>

  590. </a>

  591. <a class="md-social__link" href="https://github.com/OpenMathLib/OpenBLAS/LICENSE" rel="noopener" target="_blank" title="github.com">

  592. <svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M9 10a3.04 3.04 0 0 1 3-3 3.04 3.04 0 0 1 3 3 3.04 3.04 0 0 1-3 3 3.04 3.04 0 0 1-3-3m3 9 4 1v-3.08A7.54 7.54 0 0 1 12 18a7.54 7.54 0 0 1-4-1.08V20m4-16a5.78 5.78 0 0 0-4.24 1.74A5.78 5.78 0 0 0 6 10a5.78 5.78 0 0 0 1.76 4.23A5.78 5.78 0 0 0 12 16a5.78 5.78 0 0 0 4.24-1.77A5.78 5.78 0 0 0 18 10a5.78 5.78 0 0 0-1.76-4.26A5.78 5.78 0 0 0 12 4m8 6a8 8 0 0 1-.57 2.8A7.8 7.8 0 0 1 18 15.28V23l-6-2-6 2v-7.72A7.9 7.9 0 0 1 4 10a7.68 7.68 0 0 1 2.33-5.64A7.73 7.73 0 0 1 12 2a7.73 7.73 0 0 1 5.67 2.36A7.68 7.68 0 0 1 20 10"></path></svg>

  593. </a>

  594. </div>

  595. </div>

  596. </div>

  597. </footer>

  598. </div>

  599. <div class="md-dialog" data-md-component="dialog">

  600. <div class="md-dialog__inner md-typeset"></div>

  601. </div>

  602. <script id="__config" type="application/json">{"base": "..", "features": ["header.autohide"], "search": "../assets/javascripts/workers/search.f8cc74c7.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>

  603. <script src="../assets/javascripts/bundle.60a45f97.min.js"></script>

  604. <script type="module">import mermaid from "https://unpkg.com/mermaid@10.4.0/dist/mermaid.esm.min.mjs";

  605. window.mermaidConfig = {default: {

  606.     startOnLoad: false

  607. }};</script></body>

  608. </html>