OLD | NEW |
(Empty) | |
| 1 // Copyright (c) 2011, Google Inc. |
| 2 // 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 |
| 6 // met: |
| 7 // |
| 8 // * Redistributions of source code must retain the above copyright |
| 9 // notice, this list of conditions and the following disclaimer. |
| 10 // * Redistributions in binary form must reproduce the above |
| 11 // copyright notice, this list of conditions and the following disclaimer |
| 12 // in the documentation and/or other materials provided with the |
| 13 // distribution. |
| 14 // * Neither the name of Google Inc. nor the names of its |
| 15 // contributors may be used to endorse or promote products derived from |
| 16 // this software without specific prior written permission. |
| 17 // |
| 18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| 19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| 20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| 21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| 22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| 23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| 24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| 25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| 26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| 28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 29 |
| 30 // --- |
| 31 // Author: Rebecca Shapiro <bxx@google.com> |
| 32 // |
| 33 // This file contains functions that implement doubly linked and |
| 34 // singly linked lists. The singly linked lists are null terminated, |
| 35 // use raw pointers to link neighboring elements, and these pointers |
| 36 // are stored at the start of each element, independently of the |
| 37 // elements's size. Because pointers are stored within each element, |
| 38 // each element must be large enough to store two raw pointers if |
| 39 // doubly linked lists are employed, or one raw pointer if singly |
| 40 // linked lists are employed. On machines with 64 bit pointers, this |
| 41 // means elements must be at least 16 bytes in size for doubly linked |
| 42 // list support, and 8 bytes for singly linked list support. No |
| 43 // attempts are made to preserve the data in elements stored in the |
| 44 // list. |
| 45 // |
| 46 // Given a machine with pointers of size N (on a 64bit machine N=8, on |
| 47 // a 32bit machine, N=4), the list pointers are stored in the |
| 48 // following manner: |
| 49 // -In doubly linked lists, the |next| pointer is stored in the first N |
| 50 // bytes of the node and the |previous| pointer is writtend into the |
| 51 // second N bytes. |
| 52 // -In singly linked lists, the |next| pointer is stored in the first N |
| 53 // bytes of the node. |
| 54 // |
| 55 // For both types of lists: when a pop operation is performed on a non |
| 56 // empty list, the new list head becomes that which is pointed to by |
| 57 // the former head's |next| pointer. If the list is doubly linked, the |
| 58 // new head |previous| pointer gets changed from pointing to the former |
| 59 // head to NULL. |
| 60 |
| 61 |
| 62 #include <stddef.h> |
| 63 #include "free_list.h" |
| 64 |
| 65 #if defined(TCMALLOC_USE_DOUBLYLINKED_FREELIST) |
| 66 |
| 67 // TODO(jar): We should use C++ rather than a macro here. |
| 68 #define MEMORY_CHECK(v1, v2) \ |
| 69 if (v1 != v2) CRASH("Memory corruption detected.\n") |
| 70 |
| 71 namespace { |
| 72 void EnsureNonLoop(void* node, void* next) { |
| 73 // We only have time to do minimal checking. We don't traverse the list, but |
| 74 // only look for an immediate loop (cycle back to ourself). |
| 75 if (node != next) return; |
| 76 CRASH("Circular loop in list detected: %p\n", next); |
| 77 } |
| 78 |
| 79 // Returns value of the |previous| pointer w/out running a sanity |
| 80 // check. |
| 81 inline void *FL_Previous_No_Check(void *t) { |
| 82 return reinterpret_cast<void**>(t)[1]; |
| 83 } |
| 84 |
| 85 // Returns value of the |next| pointer w/out running a sanity check. |
| 86 inline void *FL_Next_No_Check(void *t) { |
| 87 return reinterpret_cast<void**>(t)[0]; |
| 88 } |
| 89 |
| 90 void *FL_Previous(void *t) { |
| 91 void *previous = FL_Previous_No_Check(t); |
| 92 if (previous) { |
| 93 MEMORY_CHECK(FL_Next_No_Check(previous), t); |
| 94 } |
| 95 return previous; |
| 96 } |
| 97 |
| 98 inline void FL_SetPrevious(void *t, void *n) { |
| 99 EnsureNonLoop(t, n); |
| 100 reinterpret_cast<void**>(t)[1] = n; |
| 101 } |
| 102 |
| 103 inline void FL_SetNext(void *t, void *n) { |
| 104 EnsureNonLoop(t, n); |
| 105 reinterpret_cast<void**>(t)[0] = n; |
| 106 } |
| 107 |
| 108 } // namespace |
| 109 |
| 110 namespace tcmalloc { |
| 111 |
| 112 void *FL_Next(void *t) { |
| 113 void *next = FL_Next_No_Check(t); |
| 114 if (next) { |
| 115 MEMORY_CHECK(FL_Previous_No_Check(next), t); |
| 116 } |
| 117 return next; |
| 118 } |
| 119 |
| 120 // Makes the element at |t| a singleton doubly linked list. |
| 121 void FL_Init(void *t) { |
| 122 FL_SetPrevious(t, NULL); |
| 123 FL_SetNext(t, NULL); |
| 124 } |
| 125 |
| 126 // Pushes element to a linked list whose first element is at |
| 127 // |*list|. When this call returns, |list| will point to the new head |
| 128 // of the linked list. |
| 129 void FL_Push(void **list, void *element) { |
| 130 void *old = *list; |
| 131 if (old == NULL) { // Builds singleton list. |
| 132 FL_Init(element); |
| 133 } else { |
| 134 ASSERT(FL_Previous_No_Check(old) == NULL); |
| 135 FL_SetNext(element, old); |
| 136 FL_SetPrevious(old, element); |
| 137 FL_SetPrevious(element, NULL); |
| 138 } |
| 139 *list = element; |
| 140 } |
| 141 |
| 142 // Pops the top element off the linked list whose first element is at |
| 143 // |*list|, and updates |*list| to point to the next element in the |
| 144 // list. Returns the address of the element that was removed from the |
| 145 // linked list. |list| must not be NULL. |
| 146 void *FL_Pop(void **list) { |
| 147 void *result = *list; |
| 148 ASSERT(FL_Previous_No_Check(result) == NULL); |
| 149 *list = FL_Next(result); |
| 150 if (*list != NULL) { |
| 151 FL_SetPrevious(*list, NULL); |
| 152 } |
| 153 return result; |
| 154 } |
| 155 |
| 156 // Remove |n| elements from linked list at whose first element is at |
| 157 // |*head|. |head| will be modified to point to the new head. |
| 158 // |start| will point to the first node of the range, |end| will point |
| 159 // to the last node in the range. |n| must be <= FL_Size(|*head|) |
| 160 // If |n| > 0, |head| must not be NULL. |
| 161 void FL_PopRange(void **head, int n, void **start, void **end) { |
| 162 if (n == 0) { |
| 163 *start = NULL; |
| 164 *end = NULL; |
| 165 return; |
| 166 } |
| 167 |
| 168 *start = *head; // Remember the first node in the range. |
| 169 void *tmp = *head; |
| 170 for (int i = 1; i < n; ++i) { // Find end of range. |
| 171 tmp = FL_Next(tmp); |
| 172 } |
| 173 *end = tmp; // |end| now set to point to last node in range. |
| 174 *head = FL_Next(*end); |
| 175 FL_SetNext(*end, NULL); // Unlink range from list. |
| 176 |
| 177 if (*head ) { // Fixup popped list. |
| 178 FL_SetPrevious(*head, NULL); |
| 179 } |
| 180 } |
| 181 |
| 182 // Pushes the nodes in the list begginning at |start| whose last node |
| 183 // is |end| into the linked list at |*head|. |*head| is updated to |
| 184 // point be the new head of the list. |head| must not be NULL. |
| 185 void FL_PushRange(void **head, void *start, void *end) { |
| 186 if (!start) return; |
| 187 |
| 188 // Sanity checking of ends of list to push is done by calling |
| 189 // FL_Next and FL_Previous. |
| 190 FL_Next(start); |
| 191 FL_Previous(end); |
| 192 ASSERT(FL_Previous_No_Check(start) == NULL); |
| 193 ASSERT(FL_Next_No_Check(end) == NULL); |
| 194 |
| 195 if (*head) { |
| 196 MEMORY_CHECK(FL_Previous_No_Check(*head), NULL); |
| 197 FL_SetNext(end, *head); |
| 198 FL_SetPrevious(*head, end); |
| 199 } |
| 200 *head = start; |
| 201 } |
| 202 |
| 203 // Calculates the size of the list that begins at |head|. |
| 204 size_t FL_Size(void *head){ |
| 205 int count = 0; |
| 206 if (head) { |
| 207 MEMORY_CHECK(FL_Previous_No_Check(head), NULL); |
| 208 } |
| 209 while (head) { |
| 210 count++; |
| 211 head = FL_Next(head); |
| 212 } |
| 213 return count; |
| 214 } |
| 215 |
| 216 } // namespace tcmalloc |
| 217 |
| 218 #else |
| 219 #include "linked_list.h" // for SLL_SetNext |
| 220 |
| 221 namespace { |
| 222 |
| 223 inline void FL_SetNext(void *t, void *n) { |
| 224 tcmalloc::SLL_SetNext(t,n); |
| 225 } |
| 226 |
| 227 } |
| 228 |
| 229 #endif // TCMALLOC_USE_DOUBLYLINKED_FREELIST |
OLD | NEW |