| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| |
| <html lang="en"> |
| |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>LCOV - skiboot.info - include/lock.h</title> |
| <link rel="stylesheet" type="text/css" href="../gcov.css"> |
| </head> |
| |
| <body> |
| |
| <table width="100%" border=0 cellspacing=0 cellpadding=0> |
| <tr><td class="title">LCOV - code coverage report</td></tr> |
| <tr><td class="ruler"><img src="../glass.png" width=3 height=3 alt=""></td></tr> |
| |
| <tr> |
| <td width="100%"> |
| <table cellpadding=1 border=0 width="100%"> |
| <tr> |
| <td width="10%" class="headerItem">Current view:</td> |
| <td width="10%" class="headerValue"><a href="../index.html">top level</a> - <a href="index.html">include</a> - lock.h<span style="font-size: 80%;"> (source / <a href="lock.h.func-c.html">functions</a>)</span></td> |
| <td width="5%"></td> |
| <td width="5%"></td> |
| <td width="5%" class="headerCovTableHead">Coverage</td> |
| <td width="5%" class="headerCovTableHead" title="Covered + Uncovered code">Total</td> |
| <td width="5%" class="headerCovTableHead" title="Exercised code only">Hit</td> |
| </tr> |
| <tr> |
| <td class="headerItem">Test:</td> |
| <td class="headerValue">skiboot.info</td> |
| <td></td> |
| <td class="headerItem">Lines:</td> |
| <td class="headerCovTableEntryHi">100.0 %</td> |
| <td class="headerCovTableEntry">3</td> |
| <td class="headerCovTableEntry">3</td> |
| </tr> |
| <tr> |
| <td class="headerItem">Test Date:</td> |
| <td class="headerValue">2025-06-27 16:54:26</td> |
| <td></td> |
| <td class="headerItem">Functions:</td> |
| <td class="headerCovTableEntryHi">100.0 %</td> |
| <td class="headerCovTableEntry">1</td> |
| <td class="headerCovTableEntry">1</td> |
| </tr> |
| <tr> |
| <td></td> |
| <td></td> |
| <td></td> |
| <td class="headerItem">Branches:</td> |
| <td class="headerCovTableEntryHi">-</td> |
| <td class="headerCovTableEntry">0</td> |
| <td class="headerCovTableEntry">0</td> |
| </tr> |
| <tr><td><img src="../glass.png" width=3 height=3 alt=""></td></tr> |
| </table> |
| </td> |
| </tr> |
| |
| <tr><td class="ruler"><img src="../glass.png" width=3 height=3 alt=""></td></tr> |
| </table> |
| |
| <table cellpadding=0 cellspacing=0 border=0> |
| <tr> |
| <td><br></td> |
| </tr> |
| <tr> |
| <td> |
| <pre class="sourceHeading"> Branch data Line data Source code</pre> |
| <pre class="source"> |
| <span id="L1"><span class="lineNum"> 1</span> : : // SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later</span> |
| <span id="L2"><span class="lineNum"> 2</span> : : /* Copyright 2013-2019 IBM Corp. */</span> |
| <span id="L3"><span class="lineNum"> 3</span> : : </span> |
| <span id="L4"><span class="lineNum"> 4</span> : : #ifndef __LOCK_H</span> |
| <span id="L5"><span class="lineNum"> 5</span> : : #define __LOCK_H</span> |
| <span id="L6"><span class="lineNum"> 6</span> : : </span> |
| <span id="L7"><span class="lineNum"> 7</span> : : #include <stdbool.h></span> |
| <span id="L8"><span class="lineNum"> 8</span> : : #include <processor.h></span> |
| <span id="L9"><span class="lineNum"> 9</span> : : #include <cmpxchg.h></span> |
| <span id="L10"><span class="lineNum"> 10</span> : : #include <ccan/list/list.h></span> |
| <span id="L11"><span class="lineNum"> 11</span> : : #include <ccan/str/str.h></span> |
| <span id="L12"><span class="lineNum"> 12</span> : : </span> |
| <span id="L13"><span class="lineNum"> 13</span> : : #ifdef DEBUG_LOCKS_BACKTRACE</span> |
| <span id="L14"><span class="lineNum"> 14</span> : : #include <stack.h></span> |
| <span id="L15"><span class="lineNum"> 15</span> : : </span> |
| <span id="L16"><span class="lineNum"> 16</span> : : #define LOCKS_BACKTRACE_MAX_ENTS 60</span> |
| <span id="L17"><span class="lineNum"> 17</span> : : #endif</span> |
| <span id="L18"><span class="lineNum"> 18</span> : : </span> |
| <span id="L19"><span class="lineNum"> 19</span> : : struct lock {</span> |
| <span id="L20"><span class="lineNum"> 20</span> : : /* Lock value has bit 63 as lock bit and the PIR of the owner</span> |
| <span id="L21"><span class="lineNum"> 21</span> : : * in the top 32-bit</span> |
| <span id="L22"><span class="lineNum"> 22</span> : : */</span> |
| <span id="L23"><span class="lineNum"> 23</span> : : uint64_t lock_val;</span> |
| <span id="L24"><span class="lineNum"> 24</span> : : </span> |
| <span id="L25"><span class="lineNum"> 25</span> : : /*</span> |
| <span id="L26"><span class="lineNum"> 26</span> : : * Set to true if lock is involved in the console flush path</span> |
| <span id="L27"><span class="lineNum"> 27</span> : : * in which case taking it will suspend console flushing</span> |
| <span id="L28"><span class="lineNum"> 28</span> : : */</span> |
| <span id="L29"><span class="lineNum"> 29</span> : : bool in_con_path;</span> |
| <span id="L30"><span class="lineNum"> 30</span> : : </span> |
| <span id="L31"><span class="lineNum"> 31</span> : : /* file/line of lock owner */</span> |
| <span id="L32"><span class="lineNum"> 32</span> : : const char *owner;</span> |
| <span id="L33"><span class="lineNum"> 33</span> : : </span> |
| <span id="L34"><span class="lineNum"> 34</span> : : #ifdef DEBUG_LOCKS_BACKTRACE</span> |
| <span id="L35"><span class="lineNum"> 35</span> : : struct bt_entry bt_buf[LOCKS_BACKTRACE_MAX_ENTS];</span> |
| <span id="L36"><span class="lineNum"> 36</span> : : struct bt_metadata bt_metadata;</span> |
| <span id="L37"><span class="lineNum"> 37</span> : : #endif</span> |
| <span id="L38"><span class="lineNum"> 38</span> : : </span> |
| <span id="L39"><span class="lineNum"> 39</span> : : /* linkage in per-cpu list of owned locks */</span> |
| <span id="L40"><span class="lineNum"> 40</span> : : struct list_node list;</span> |
| <span id="L41"><span class="lineNum"> 41</span> : : };</span> |
| <span id="L42"><span class="lineNum"> 42</span> : : </span> |
| <span id="L43"><span class="lineNum"> 43</span> : : /* Initializer... not ideal but works for now. If we need different</span> |
| <span id="L44"><span class="lineNum"> 44</span> : : * values for the fields and/or start getting warnings we'll have to</span> |
| <span id="L45"><span class="lineNum"> 45</span> : : * play macro tricks</span> |
| <span id="L46"><span class="lineNum"> 46</span> : : */</span> |
| <span id="L47"><span class="lineNum"> 47</span> : : #define LOCK_UNLOCKED { 0 }</span> |
| <span id="L48"><span class="lineNum"> 48</span> : : </span> |
| <span id="L49"><span class="lineNum"> 49</span> : : /* Note vs. libc and locking:</span> |
| <span id="L50"><span class="lineNum"> 50</span> : : *</span> |
| <span id="L51"><span class="lineNum"> 51</span> : : * The printf() family of</span> |
| <span id="L52"><span class="lineNum"> 52</span> : : * functions use stack based t buffers and call into skiboot</span> |
| <span id="L53"><span class="lineNum"> 53</span> : : * underlying read() and write() which use a console lock.</span> |
| <span id="L54"><span class="lineNum"> 54</span> : : *</span> |
| <span id="L55"><span class="lineNum"> 55</span> : : * The underlying FSP console code will thus operate within that</span> |
| <span id="L56"><span class="lineNum"> 56</span> : : * console lock.</span> |
| <span id="L57"><span class="lineNum"> 57</span> : : *</span> |
| <span id="L58"><span class="lineNum"> 58</span> : : * The libc does *NOT* lock stream buffer operations, so don't</span> |
| <span id="L59"><span class="lineNum"> 59</span> : : * try to scanf() from the same FILE from two different processors.</span> |
| <span id="L60"><span class="lineNum"> 60</span> : : *</span> |
| <span id="L61"><span class="lineNum"> 61</span> : : * FSP operations are locked using an FSP lock, so all processors</span> |
| <span id="L62"><span class="lineNum"> 62</span> : : * can safely call the FSP API</span> |
| <span id="L63"><span class="lineNum"> 63</span> : : *</span> |
| <span id="L64"><span class="lineNum"> 64</span> : : * Note about ordering:</span> |
| <span id="L65"><span class="lineNum"> 65</span> : : *</span> |
| <span id="L66"><span class="lineNum"> 66</span> : : * lock() is a full memory barrier. unlock() is a lwsync</span> |
| <span id="L67"><span class="lineNum"> 67</span> : : *</span> |
| <span id="L68"><span class="lineNum"> 68</span> : : */</span> |
| <span id="L69"><span class="lineNum"> 69</span> : : </span> |
| <span id="L70"><span class="lineNum"> 70</span> : : extern bool bust_locks;</span> |
| <span id="L71"><span class="lineNum"> 71</span> : : </span> |
| <span id="L72"><span class="lineNum"> 72</span> :<span class="tlaGNC tlaBgGNC"> 150 : static inline void init_lock(struct lock *l)</span></span> |
| <span id="L73"><span class="lineNum"> 73</span> : : {</span> |
| <span id="L74"><span class="lineNum"> 74</span> :<span class="tlaGNC"> 150 : *l = (struct lock)LOCK_UNLOCKED;</span></span> |
| <span id="L75"><span class="lineNum"> 75</span> :<span class="tlaGNC"> 150 : }</span></span> |
| <span id="L76"><span class="lineNum"> 76</span> : : </span> |
| <span id="L77"><span class="lineNum"> 77</span> : : #define LOCK_CALLER __FILE__ ":" stringify(__LINE__)</span> |
| <span id="L78"><span class="lineNum"> 78</span> : : </span> |
| <span id="L79"><span class="lineNum"> 79</span> : : #define try_lock(l) try_lock_caller(l, LOCK_CALLER)</span> |
| <span id="L80"><span class="lineNum"> 80</span> : : #define lock(l) lock_caller(l, LOCK_CALLER)</span> |
| <span id="L81"><span class="lineNum"> 81</span> : : #define lock_recursive(l) lock_recursive_caller(l, LOCK_CALLER)</span> |
| <span id="L82"><span class="lineNum"> 82</span> : : </span> |
| <span id="L83"><span class="lineNum"> 83</span> : : extern bool try_lock_caller(struct lock *l, const char *caller);</span> |
| <span id="L84"><span class="lineNum"> 84</span> : : extern void lock_caller(struct lock *l, const char *caller);</span> |
| <span id="L85"><span class="lineNum"> 85</span> : : extern void unlock(struct lock *l);</span> |
| <span id="L86"><span class="lineNum"> 86</span> : : </span> |
| <span id="L87"><span class="lineNum"> 87</span> : : extern bool lock_held_by_me(struct lock *l);</span> |
| <span id="L88"><span class="lineNum"> 88</span> : : </span> |
| <span id="L89"><span class="lineNum"> 89</span> : : /* The debug output can happen while the FSP lock, so we need some kind</span> |
| <span id="L90"><span class="lineNum"> 90</span> : : * of recursive lock support here. I don't want all locks to be recursive</span> |
| <span id="L91"><span class="lineNum"> 91</span> : : * though, thus the caller need to explicitly call lock_recursive which</span> |
| <span id="L92"><span class="lineNum"> 92</span> : : * returns false if the lock was already held by this cpu. If it returns</span> |
| <span id="L93"><span class="lineNum"> 93</span> : : * true, then the caller shall release it when done.</span> |
| <span id="L94"><span class="lineNum"> 94</span> : : */</span> |
| <span id="L95"><span class="lineNum"> 95</span> : : extern bool lock_recursive_caller(struct lock *l, const char *caller);</span> |
| <span id="L96"><span class="lineNum"> 96</span> : : </span> |
| <span id="L97"><span class="lineNum"> 97</span> : : /* Called after per-cpu data structures are available */</span> |
| <span id="L98"><span class="lineNum"> 98</span> : : extern void init_locks(void);</span> |
| <span id="L99"><span class="lineNum"> 99</span> : : </span> |
| <span id="L100"><span class="lineNum"> 100</span> : : /* Dump the list of locks held by this CPU */</span> |
| <span id="L101"><span class="lineNum"> 101</span> : : extern void dump_locks_list(void);</span> |
| <span id="L102"><span class="lineNum"> 102</span> : : </span> |
| <span id="L103"><span class="lineNum"> 103</span> : : /* Clean all locks held by CPU (and warn if any) */</span> |
| <span id="L104"><span class="lineNum"> 104</span> : : extern void drop_my_locks(bool warn);</span> |
| <span id="L105"><span class="lineNum"> 105</span> : : </span> |
| <span id="L106"><span class="lineNum"> 106</span> : : #endif /* __LOCK_H */</span> |
| </pre> |
| </td> |
| </tr> |
| </table> |
| <br> |
| |
| <table width="100%" border=0 cellspacing=0 cellpadding=0> |
| <tr><td class="ruler"><img src="../glass.png" width=3 height=3 alt=""></td></tr> |
| <tr><td class="versionInfo">Generated by: <a href="https://github.com//linux-test-project/lcov" target="_parent">LCOV version 2.0-1</a></td></tr> |
| </table> |
| <br> |
| |
| </body> |
| </html> |
