1 /* 2 * Copyright (c) 2013-2015, ARM Limited and Contributors. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions are met: 6 * 7 * Redistributions of source code must retain the above copyright notice, this 8 * list of conditions and the following disclaimer. 9 * 10 * Redistributions in binary form must reproduce the above copyright notice, 11 * this list of conditions and the following disclaimer in the documentation 12 * and/or other materials provided with the distribution. 13 * 14 * Neither the name of ARM nor the names of its contributors may be used 15 * to endorse or promote products derived from this software without specific 16 * prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28 * POSSIBILITY OF SUCH DAMAGE. 29 */ 30 31 #include <arch_helpers.h> 32 #include <assert.h> 33 #include <bakery_lock.h> 34 #include <cpu_data.h> 35 #include <platform.h> 36 #include <string.h> 37 38 /* 39 * Functions in this file implement Bakery Algorithm for mutual exclusion with the 40 * bakery lock data structures in coherent memory. 41 * 42 * ARM architecture offers a family of exclusive access instructions to 43 * efficiently implement mutual exclusion with hardware support. However, as 44 * well as depending on external hardware, the these instructions have defined 45 * behavior only on certain memory types (cacheable and Normal memory in 46 * particular; see ARMv8 Architecture Reference Manual section B2.10). Use cases 47 * in trusted firmware are such that mutual exclusion implementation cannot 48 * expect that accesses to the lock have the specific type required by the 49 * architecture for these primitives to function (for example, not all 50 * contenders may have address translation enabled). 51 * 52 * This implementation does not use mutual exclusion primitives. It expects 53 * memory regions where the locks reside to be fully ordered and coherent 54 * (either by disabling address translation, or by assigning proper attributes 55 * when translation is enabled). 56 * 57 * Note that the ARM architecture guarantees single-copy atomicity for aligned 58 * accesses regardless of status of address translation. 59 */ 60 61 #define assert_bakery_entry_valid(entry, bakery) do { \ 62 assert(bakery); \ 63 assert(entry < BAKERY_LOCK_MAX_CPUS); \ 64 } while (0) 65 66 /* Initialize Bakery Lock to reset all ticket values */ 67 void bakery_lock_init(bakery_lock_t *bakery) 68 { 69 assert(bakery); 70 71 /* All ticket values need to be 0 */ 72 memset(bakery, 0, sizeof(*bakery)); 73 } 74 75 76 /* Obtain a ticket for a given CPU */ 77 static unsigned int bakery_get_ticket(bakery_lock_t *bakery, unsigned int me) 78 { 79 unsigned int my_ticket, their_ticket; 80 unsigned int they; 81 82 /* Prevent recursive acquisition */ 83 assert(!bakery_ticket_number(bakery->lock_data[me])); 84 85 /* 86 * Flag that we're busy getting our ticket. All CPUs are iterated in the 87 * order of their ordinal position to decide the maximum ticket value 88 * observed so far. Our priority is set to be greater than the maximum 89 * observed priority 90 * 91 * Note that it's possible that more than one contender gets the same 92 * ticket value. That's OK as the lock is acquired based on the priority 93 * value, not the ticket value alone. 94 */ 95 my_ticket = 0; 96 bakery->lock_data[me] = make_bakery_data(CHOOSING_TICKET, my_ticket); 97 for (they = 0; they < BAKERY_LOCK_MAX_CPUS; they++) { 98 their_ticket = bakery_ticket_number(bakery->lock_data[they]); 99 if (their_ticket > my_ticket) 100 my_ticket = their_ticket; 101 } 102 103 /* 104 * Compute ticket; then signal to other contenders waiting for us to 105 * finish calculating our ticket value that we're done 106 */ 107 ++my_ticket; 108 bakery->lock_data[me] = make_bakery_data(CHOSEN_TICKET, my_ticket); 109 110 return my_ticket; 111 } 112 113 114 /* 115 * Acquire bakery lock 116 * 117 * Contending CPUs need first obtain a non-zero ticket and then calculate 118 * priority value. A contending CPU iterate over all other CPUs in the platform, 119 * which may be contending for the same lock, in the order of their ordinal 120 * position (CPU0, CPU1 and so on). A non-contending CPU will have its ticket 121 * (and priority) value as 0. The contending CPU compares its priority with that 122 * of others'. The CPU with the highest priority (lowest numerical value) 123 * acquires the lock 124 */ 125 void bakery_lock_get(bakery_lock_t *bakery) 126 { 127 unsigned int they, me; 128 unsigned int my_ticket, my_prio, their_ticket; 129 unsigned int their_bakery_data; 130 131 me = plat_my_core_pos(); 132 133 assert_bakery_entry_valid(me, bakery); 134 135 /* Get a ticket */ 136 my_ticket = bakery_get_ticket(bakery, me); 137 138 /* 139 * Now that we got our ticket, compute our priority value, then compare 140 * with that of others, and proceed to acquire the lock 141 */ 142 my_prio = PRIORITY(my_ticket, me); 143 for (they = 0; they < BAKERY_LOCK_MAX_CPUS; they++) { 144 if (me == they) 145 continue; 146 147 /* Wait for the contender to get their ticket */ 148 do { 149 their_bakery_data = bakery->lock_data[they]; 150 } while (bakery_is_choosing(their_bakery_data)); 151 152 /* 153 * If the other party is a contender, they'll have non-zero 154 * (valid) ticket value. If they do, compare priorities 155 */ 156 their_ticket = bakery_ticket_number(their_bakery_data); 157 if (their_ticket && (PRIORITY(their_ticket, they) < my_prio)) { 158 /* 159 * They have higher priority (lower value). Wait for 160 * their ticket value to change (either release the lock 161 * to have it dropped to 0; or drop and probably content 162 * again for the same lock to have an even higher value) 163 */ 164 do { 165 wfe(); 166 } while (their_ticket == 167 bakery_ticket_number(bakery->lock_data[they])); 168 } 169 } 170 /* Lock acquired */ 171 } 172 173 174 /* Release the lock and signal contenders */ 175 void bakery_lock_release(bakery_lock_t *bakery) 176 { 177 unsigned int me = plat_my_core_pos(); 178 179 assert_bakery_entry_valid(me, bakery); 180 assert(bakery_ticket_number(bakery->lock_data[me])); 181 182 /* 183 * Release lock by resetting ticket. Then signal other 184 * waiting contenders 185 */ 186 bakery->lock_data[me] = 0; 187 dsb(); 188 sev(); 189 } 190