]> git.saurik.com Git - apple/xnu.git/blobdiff - osfmk/kern/queue.h
xnu-2782.1.97.tar.gz
[apple/xnu.git] / osfmk / kern / queue.h
index bdb700fb3806396b0cb5e66f33247f53af20bd8f..338395b17e333e135e1e18466bd550234b3670b5 100644 (file)
@@ -1,23 +1,29 @@
 /*
- * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2009 Apple Inc. All rights reserved.
  *
- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 
- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License").  You may not use this file except in compliance with the
- * License.  Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.
  * 
- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
+ * 
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
  * 
- * @APPLE_LICENSE_HEADER_END@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 /*
  * @OSF_COPYRIGHT@
 #ifndef        _KERN_QUEUE_H_
 #define        _KERN_QUEUE_H_
 
-#include <kern/lock.h>
+#include <mach/mach_types.h>
 #include <kern/macro_help.h>
 
+#include <sys/cdefs.h>
+
+__BEGIN_DECLS
+
 /*
  *     Queue of abstract objects.  Queue is maintained
  *     within that object.
@@ -100,56 +110,55 @@ typedef   struct queue_entry      *queue_entry_t;
 /*
  *     enqueue puts "elt" on the "queue".
  *     dequeue returns the first element in the "queue".
- *     remqueue removes the specified "elt" from the specified "queue".
+ *     remqueue removes the specified "elt" from its queue.
  */
 
 #define enqueue(queue,elt)     enqueue_tail(queue, elt)
 #define        dequeue(queue)          dequeue_head(queue)
 
-#if    !defined(__GNUC__)
-
-/* Enqueue element to head of queue */
-extern void            enqueue_head(
-                               queue_t         que,
-                               queue_entry_t   elt);
-
-/* Enqueue element to tail of queue */
-extern void            enqueue_tail(
-                               queue_t         que,
-                               queue_entry_t   elt);
-
-/* Dequeue element from head of queue */
-extern queue_entry_t   dequeue_head(
-                               queue_t que);
-
-/* Dequeue element from tail of queue */
-extern queue_entry_t   dequeue_tail(
-                               queue_t que);
-
-/* Dequeue element */
-extern void            remqueue(
-                               queue_t         que,
-                               queue_entry_t   elt);
-
-/* Enqueue element after a particular elem */
-extern void            insque(
-                               queue_entry_t   entry,
-                               queue_entry_t   pred);
-
-/* Dequeue element */
-extern int             remque(
-                               queue_entry_t elt);
+#ifdef XNU_KERNEL_PRIVATE
+#include <kern/debug.h>
+#include <mach/branch_predicates.h>
+static inline void __QUEUE_ELT_VALIDATE(queue_entry_t elt) {
+       queue_entry_t   elt_next, elt_prev;
+       
+       if (__improbable(elt == (queue_entry_t)0)) {
+               panic("Invalid queue element %p", elt);
+       }
+       
+       elt_next = elt->next;
+       elt_prev = elt->prev;
+       
+       if (__improbable(elt_next == (queue_entry_t)0 || elt_prev == (queue_entry_t)0)) {
+               panic("Invalid queue element pointers for %p: next %p prev %p", elt, elt_next, elt_prev);
+       }
+       if (__improbable(elt_next->prev != elt || elt_prev->next != elt)) {
+               panic("Invalid queue element linkage for %p: next %p next->prev %p prev %p prev->next %p", 
+                         elt, elt_next, elt_next->prev, elt_prev, elt_prev->next);
+       }
+}
 
+static inline void __DEQUEUE_ELT_CLEANUP(queue_entry_t elt) {
+       (elt)->next = (queue_entry_t) 0;
+       (elt)->prev = (queue_entry_t) 0;
+}
 #else
+#define __QUEUE_ELT_VALIDATE(elt) do { } while (0)
+#define __DEQUEUE_ELT_CLEANUP(elt) do { } while(0)
+#endif /* !XNU_KERNEL_PRIVATE */
 
 static __inline__ void
 enqueue_head(
        queue_t         que,
        queue_entry_t   elt)
 {
-       elt->next = que->next;
+       queue_entry_t   old_head;
+
+       __QUEUE_ELT_VALIDATE((queue_entry_t)que);
+       old_head = que->next;
+       elt->next = old_head;
        elt->prev = que;
-       elt->next->prev = elt;
+       old_head->prev = elt;
        que->next = elt;
 }
 
@@ -158,9 +167,13 @@ enqueue_tail(
                queue_t         que,
                queue_entry_t   elt)
 {
+       queue_entry_t   old_tail;
+
+       __QUEUE_ELT_VALIDATE((queue_entry_t)que);
+       old_tail = que->prev;
        elt->next = que;
-       elt->prev = que->prev;
-       elt->prev->next = elt;
+       elt->prev = old_tail;
+       old_tail->next = elt;
        que->prev = elt;
 }
 
@@ -168,12 +181,16 @@ static __inline__ queue_entry_t
 dequeue_head(
        queue_t que)
 {
-       register queue_entry_t  elt = (queue_entry_t) 0;
+       queue_entry_t   elt = (queue_entry_t) 0;
+       queue_entry_t   new_head;
 
        if (que->next != que) {
                elt = que->next;
-               elt->next->prev = que;
-               que->next = elt->next;
+               __QUEUE_ELT_VALIDATE(elt);
+               new_head = elt->next; /* new_head may point to que if elt was the only element */
+               new_head->prev = que;
+               que->next = new_head;
+               __DEQUEUE_ELT_CLEANUP(elt);
        }
 
        return (elt);
@@ -183,12 +200,16 @@ static __inline__ queue_entry_t
 dequeue_tail(
        queue_t que)
 {
-       register queue_entry_t  elt = (queue_entry_t) 0;
+       queue_entry_t   elt = (queue_entry_t) 0;
+       queue_entry_t   new_tail;
 
        if (que->prev != que) {
                elt = que->prev;
-               elt->prev->next = que;
-               que->prev = elt->prev;
+               __QUEUE_ELT_VALIDATE(elt);
+               new_tail = elt->prev; /* new_tail may point to queue if elt was the only element */
+               new_tail->next = que;
+               que->prev = new_tail;
+               __DEQUEUE_ELT_CLEANUP(elt);
        }
 
        return (elt);
@@ -196,11 +217,16 @@ dequeue_tail(
 
 static __inline__ void
 remqueue(
-       queue_t         que,
        queue_entry_t   elt)
 {
-       elt->next->prev = elt->prev;
-       elt->prev->next = elt->next;
+       queue_entry_t   next_elt, prev_elt;
+
+       __QUEUE_ELT_VALIDATE(elt);
+       next_elt = elt->next;
+       prev_elt = elt->prev; /* next_elt may equal prev_elt (and the queue head) if elt was the only element */
+       next_elt->prev = prev_elt;
+       prev_elt->next = next_elt;
+       __DEQUEUE_ELT_CLEANUP(elt);
 }
 
 static __inline__ void
@@ -208,24 +234,30 @@ insque(
        queue_entry_t   entry,
        queue_entry_t   pred)
 {
-       entry->next = pred->next;
+       queue_entry_t   successor;
+
+       __QUEUE_ELT_VALIDATE(pred);
+       successor = pred->next;
+       entry->next = successor;
        entry->prev = pred;
-       (pred->next)->prev = entry;
+       successor->prev = entry;
        pred->next = entry;
 }
 
-static __inline__ integer_t
+static __inline__ void
 remque(
-       register queue_entry_t elt)
+       queue_entry_t elt)
 {
-       (elt->next)->prev = elt->prev;
-       (elt->prev)->next = elt->next;
-
-       return((integer_t)elt);
+       queue_entry_t   next_elt, prev_elt;
+
+       __QUEUE_ELT_VALIDATE(elt);
+       next_elt = elt->next;
+       prev_elt = elt->prev; /* next_elt may equal prev_elt (and the queue head) if elt was the only element */
+       next_elt->prev = prev_elt;
+       prev_elt->next = next_elt;
+       __DEQUEUE_ELT_CLEANUP(elt);
 }
 
-#endif /* defined(__GNUC__) */
-
 /*
  *     Macro:          queue_init
  *     Function:
@@ -323,16 +355,17 @@ MACRO_END
  */
 #define queue_enter(head, elt, type, field)                    \
 MACRO_BEGIN                                                    \
-       register queue_entry_t prev;                            \
+       queue_entry_t __prev;                                   \
                                                                \
-       prev = (head)->prev;                                    \
-       if ((head) == prev) {                                   \
+       __prev = (head)->prev;                                  \
+       if ((head) == __prev) {                                 \
                (head)->next = (queue_entry_t) (elt);           \
        }                                                       \
        else {                                                  \
-               ((type)prev)->field.next = (queue_entry_t)(elt);\
+               ((type)(void *)__prev)->field.next =            \
+                       (queue_entry_t)(elt);                   \
        }                                                       \
-       (elt)->field.prev = prev;                               \
+       (elt)->field.prev = __prev;                             \
        (elt)->field.next = head;                               \
        (head)->prev = (queue_entry_t) elt;                     \
 MACRO_END
@@ -350,16 +383,17 @@ MACRO_END
  */
 #define queue_enter_first(head, elt, type, field)              \
 MACRO_BEGIN                                                    \
-       register queue_entry_t next;                            \
+       queue_entry_t __next;                                   \
                                                                \
-       next = (head)->next;                                    \
-       if ((head) == next) {                                   \
+       __next = (head)->next;                                  \
+       if ((head) == __next) {                                 \
                (head)->prev = (queue_entry_t) (elt);           \
        }                                                       \
        else {                                                  \
-               ((type)next)->field.prev = (queue_entry_t)(elt);\
+               ((type)(void *)__next)->field.prev =            \
+                       (queue_entry_t)(elt);                   \
        }                                                       \
-       (elt)->field.next = next;                               \
+       (elt)->field.next = __next;                             \
        (elt)->field.prev = head;                               \
        (head)->next = (queue_entry_t) elt;                     \
 MACRO_END
@@ -378,7 +412,7 @@ MACRO_END
  */
 #define queue_insert_before(head, elt, cur, type, field)               \
 MACRO_BEGIN                                                            \
-       register queue_entry_t prev;                                    \
+       queue_entry_t __prev;                                           \
                                                                        \
        if ((head) == (queue_entry_t)(cur)) {                           \
                (elt)->field.next = (head);                             \
@@ -386,8 +420,9 @@ MACRO_BEGIN                                                         \
                        (elt)->field.prev = (head);                     \
                        (head)->next = (queue_entry_t)(elt);            \
                } else {                        /* last element */      \
-                       prev = (elt)->field.prev = (head)->prev;        \
-                       ((type)prev)->field.next = (queue_entry_t)(elt);\
+                       __prev = (elt)->field.prev = (head)->prev;      \
+                       ((type)(void *)__prev)->field.next =            \
+                               (queue_entry_t)(elt);                   \
                }                                                       \
                (head)->prev = (queue_entry_t)(elt);                    \
        } else {                                                        \
@@ -397,8 +432,9 @@ MACRO_BEGIN                                                         \
                        (elt)->field.prev = (head);                     \
                        (head)->next = (queue_entry_t)(elt);            \
                } else {                        /* middle element */    \
-                       prev = (elt)->field.prev = (cur)->field.prev;   \
-                       ((type)prev)->field.next = (queue_entry_t)(elt);\
+                       __prev = (elt)->field.prev = (cur)->field.prev; \
+                       ((type)(void *)__prev)->field.next =            \
+                               (queue_entry_t)(elt);                   \
                }                                                       \
                (cur)->field.prev = (queue_entry_t)(elt);               \
        }                                                               \
@@ -418,7 +454,7 @@ MACRO_END
  */
 #define queue_insert_after(head, elt, cur, type, field)                        \
 MACRO_BEGIN                                                            \
-       register queue_entry_t next;                                    \
+       queue_entry_t __next;                                           \
                                                                        \
        if ((head) == (queue_entry_t)(cur)) {                           \
                (elt)->field.prev = (head);                             \
@@ -426,8 +462,9 @@ MACRO_BEGIN                                                         \
                        (elt)->field.next = (head);                     \
                        (head)->prev = (queue_entry_t)(elt);            \
                } else {                        /* first element */     \
-                       next = (elt)->field.next = (head)->next;        \
-                       ((type)next)->field.prev = (queue_entry_t)(elt);\
+                       __next = (elt)->field.next = (head)->next;      \
+                       ((type)(void *)__next)->field.prev =            \
+                               (queue_entry_t)(elt);                   \
                }                                                       \
                (head)->next = (queue_entry_t)(elt);                    \
        } else {                                                        \
@@ -437,8 +474,9 @@ MACRO_BEGIN                                                         \
                        (elt)->field.next = (head);                     \
                        (head)->prev = (queue_entry_t)(elt);            \
                } else {                        /* middle element */    \
-                       next = (elt)->field.next = (cur)->field.next;   \
-                       ((type)next)->field.prev = (queue_entry_t)(elt);\
+                       __next = (elt)->field.next = (cur)->field.next; \
+                       ((type)(void *)__next)->field.prev =            \
+                               (queue_entry_t)(elt);                   \
                }                                                       \
                (cur)->field.next = (queue_entry_t)(elt);               \
        }                                                               \
@@ -451,7 +489,7 @@ MACRO_END
  *             given element (thing) in the given queue (head)
  */
 #define        queue_field(head, thing, type, field)                   \
-               (((head) == (thing)) ? (head) : &((type)(thing))->field)
+               (((head) == (thing)) ? (head) : &((type)(void *)(thing))->field)
 
 /*
  *     Macro:          queue_remove
@@ -463,20 +501,23 @@ MACRO_END
  */
 #define        queue_remove(head, elt, type, field)                    \
 MACRO_BEGIN                                                    \
-       register queue_entry_t  next, prev;                     \
+       queue_entry_t   __next, __prev;                         \
                                                                \
-       next = (elt)->field.next;                               \
-       prev = (elt)->field.prev;                               \
+       __next = (elt)->field.next;                             \
+       __prev = (elt)->field.prev;                             \
                                                                \
-       if ((head) == next)                                     \
-               (head)->prev = prev;                            \
+       if ((head) == __next)                                   \
+               (head)->prev = __prev;                          \
        else                                                    \
-               ((type)next)->field.prev = prev;                \
+               ((type)(void *)__next)->field.prev = __prev;    \
                                                                \
-       if ((head) == prev)                                     \
-               (head)->next = next;                            \
+       if ((head) == __prev)                                   \
+               (head)->next = __next;                          \
        else                                                    \
-               ((type)prev)->field.next = next;                \
+               ((type)(void *)__prev)->field.next = __next;    \
+                                                               \
+       (elt)->field.next = NULL;                               \
+       (elt)->field.prev = NULL;                               \
 MACRO_END
 
 /*
@@ -490,16 +531,19 @@ MACRO_END
  */
 #define        queue_remove_first(head, entry, type, field)            \
 MACRO_BEGIN                                                    \
-       register queue_entry_t  next;                           \
+       queue_entry_t   __next;                                 \
                                                                \
-       (entry) = (type) ((head)->next);                        \
-       next = (entry)->field.next;                             \
+       (entry) = (type)(void *) ((head)->next);                \
+       __next = (entry)->field.next;                           \
                                                                \
-       if ((head) == next)                                     \
+       if ((head) == __next)                                   \
                (head)->prev = (head);                          \
        else                                                    \
-               ((type)(next))->field.prev = (head);            \
-       (head)->next = next;                                    \
+               ((type)(void *)(__next))->field.prev = (head);  \
+       (head)->next = __next;                                  \
+                                                               \
+       (entry)->field.next = NULL;                             \
+       (entry)->field.prev = NULL;                             \
 MACRO_END
 
 /*
@@ -513,16 +557,19 @@ MACRO_END
  */
 #define        queue_remove_last(head, entry, type, field)             \
 MACRO_BEGIN                                                    \
-       register queue_entry_t  prev;                           \
+       queue_entry_t   __prev;                                 \
                                                                \
-       (entry) = (type) ((head)->prev);                        \
-       prev = (entry)->field.prev;                             \
+       (entry) = (type)(void *) ((head)->prev);                \
+       __prev = (entry)->field.prev;                           \
                                                                \
-       if ((head) == prev)                                     \
+       if ((head) == __prev)                                   \
                (head)->next = (head);                          \
        else                                                    \
-               ((type)(prev))->field.next = (head);            \
-       (head)->prev = prev;                                    \
+               ((type)(void *)(__prev))->field.next = (head);  \
+       (head)->prev = __prev;                                  \
+                                                               \
+       (entry)->field.next = NULL;                             \
+       (entry)->field.prev = NULL;                             \
 MACRO_END
 
 /*
@@ -530,8 +577,8 @@ MACRO_END
  */
 #define        queue_assign(to, from, type, field)                     \
 MACRO_BEGIN                                                    \
-       ((type)((from)->prev))->field.next = (to);              \
-       ((type)((from)->next))->field.prev = (to);              \
+       ((type)(void *)((from)->prev))->field.next = (to);      \
+       ((type)(void *)((from)->next))->field.prev = (to);      \
        *to = *from;                                            \
 MACRO_END
 
@@ -548,10 +595,12 @@ MACRO_END
  */
 #define queue_new_head(old, new, type, field)                  \
 MACRO_BEGIN                                                    \
-       if (!queue_empty(new)) {                                \
+       if (!queue_empty(old)) {                                \
                *(new) = *(old);                                \
-               ((type)((new)->next))->field.prev = (new);      \
-               ((type)((new)->prev))->field.next = (new);      \
+               ((type)(void *)((new)->next))->field.prev =     \
+                       (new);                                  \
+               ((type)(void *)((new)->prev))->field.next =     \
+                       (new);                                  \
        } else {                                                \
                queue_init(new);                                \
        }                                                       \
@@ -571,54 +620,79 @@ MACRO_END
  *                     <field> is the chain field in (*<type>)
  */
 #define queue_iterate(head, elt, type, field)                  \
-       for ((elt) = (type) queue_first(head);                  \
+       for ((elt) = (type)(void *) queue_first(head);          \
             !queue_end((head), (queue_entry_t)(elt));          \
-            (elt) = (type) queue_next(&(elt)->field))
-
-#include <sys/appleapiopts.h>
-
-#ifdef __APPLE_API_PRIVATE
+            (elt) = (type)(void *) queue_next(&(elt)->field))
 
 #ifdef MACH_KERNEL_PRIVATE
 
+#include <kern/locks.h>
+
 /*----------------------------------------------------------------*/
 /*
  *     Define macros for queues with locks.
  */
 struct mpqueue_head {
        struct queue_entry      head;           /* header for queue */
-       decl_simple_lock_data(, lock)           /* lock for queue */
+       uint64_t                earliest_soft_deadline;
+       uint64_t                count;
+#if defined(__i386__) || defined(__x86_64__)
+       lck_mtx_t               lock_data;
+       lck_mtx_ext_t           lock_data_ext;
+#else
+       lck_spin_t              lock_data;
+#endif
 };
 
 typedef struct mpqueue_head    mpqueue_head_t;
 
 #define        round_mpq(size)         (size)
 
-#define mpqueue_init(q)                                        \
+
+#if defined(__i386__) || defined(__x86_64__)
+
+#define mpqueue_init(q, lck_grp, lck_attr)             \
 MACRO_BEGIN                                            \
        queue_init(&(q)->head);                         \
-       simple_lock_init(&(q)->lock, ETAP_MISC_Q);      \
+        lck_mtx_init_ext(&(q)->lock_data,              \
+                        &(q)->lock_data_ext,           \
+                        lck_grp,                       \
+                        lck_attr);                     \
+       (q)->earliest_soft_deadline = UINT64_MAX;       \
+       (q)->count = 0;                                 \
 MACRO_END
 
+#else
+
+#define mpqueue_init(q, lck_grp, lck_attr)             \
+MACRO_BEGIN                                            \
+       queue_init(&(q)->head);                         \
+        lck_spin_init(&(q)->lock_data,                 \
+                     lck_grp,                          \
+                     lck_attr);                        \
+MACRO_END
+#endif
+
+
 #define mpenqueue_tail(q, elt)                         \
 MACRO_BEGIN                                            \
-       simple_lock(&(q)->lock);                        \
+        lck_mtx_lock_spin_always(&(q)->lock_data);     \
        enqueue_tail(&(q)->head, elt);                  \
-       simple_unlock(&(q)->lock);                      \
+       lck_mtx_unlock_always(&(q)->lock_data);         \
 MACRO_END
 
 #define mpdequeue_head(q, elt)                         \
 MACRO_BEGIN                                            \
-       simple_lock(&(q)->lock);                        \
+        lck_mtx_lock_spin_always(&(q)->lock_data);     \
        if (queue_empty(&(q)->head))                    \
                *(elt) = 0;                             \
        else                                            \
                *(elt) = dequeue_head(&(q)->head);      \
-       simple_unlock(&(q)->lock);                      \
+       lck_mtx_unlock_always(&(q)->lock_data);         \
 MACRO_END
 
 #endif /* MACH_KERNEL_PRIVATE */
 
-#endif /* __APPLE_API_PRIVATE */
+__END_DECLS
 
 #endif /* _KERN_QUEUE_H_ */