linked_list.h revision 5821806d5e7f356e8fa4b058a389a808ea183019
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2008, Google Inc.
25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// All rights reserved.
35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//
45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Redistribution and use in source and binary forms, with or without
55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// modification, are permitted provided that the following conditions are
65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// met:
75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//
85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//     * Redistributions of source code must retain the above copyright
95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// notice, this list of conditions and the following disclaimer.
105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//     * Redistributions in binary form must reproduce the above
115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// copyright notice, this list of conditions and the following disclaimer
125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// in the documentation and/or other materials provided with the
135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// distribution.
145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//     * Neither the name of Google Inc. nor the names of its
155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// contributors may be used to endorse or promote products derived from
165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// this software without specific prior written permission.
175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//
185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// ---
315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Author: Sanjay Ghemawat <opensource@google.com>
325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//
335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Some very basic linked list functions for dealing with using void * as
345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// storage.
355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef TCMALLOC_LINKED_LIST_H_
375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define TCMALLOC_LINKED_LIST_H_
385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <stddef.h>
405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace tcmalloc {
425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)inline void *SLL_Next(void *t) {
445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  return *(reinterpret_cast<void**>(t));
455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)inline void SLL_SetNext(void *t, void *n) {
485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  *(reinterpret_cast<void**>(t)) = n;
495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)inline void SLL_Push(void **list, void *element) {
525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  SLL_SetNext(element, *list);
535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  *list = element;
545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)inline void *SLL_Pop(void **list) {
575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  void *result = *list;
585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  *list = SLL_Next(*list);
595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  return result;
605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Remove N elements from a linked list to which head points.  head will be
635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// modified to point to the new head.  start and end will point to the first
645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// and last nodes of the range.  Note that end will point to NULL after this
655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// function is called.
665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)inline void SLL_PopRange(void **head, int N, void **start, void **end) {
675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (N == 0) {
685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    *start = NULL;
695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    *end = NULL;
705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    return;
715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  }
725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  void *tmp = *head;
745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  for (int i = 1; i < N; ++i) {
755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    tmp = SLL_Next(tmp);
765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  }
775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  *start = *head;
795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  *end = tmp;
805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  *head = SLL_Next(tmp);
815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // Unlink range from list.
825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  SLL_SetNext(tmp, NULL);
835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)inline void SLL_PushRange(void **head, void *start, void *end) {
865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (!start) return;
875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  SLL_SetNext(end, *head);
885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  *head = start;
895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)inline size_t SLL_Size(void *head) {
925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  int count = 0;
935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  while (head) {
945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    count++;
955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    head = SLL_Next(head);
965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  }
975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  return count;
985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}  // namespace tcmalloc
1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif  // TCMALLOC_LINKED_LIST_H_
103