Added global OMLP to GSN-EDF.

This is the variant of the OMLP that uses priority inheritance,
and comes from BBB's dissertation work.

3 files changed, 285 insertions, 2 deletions

diff --git a/include/litmus/fdso.h b/include/litmus/fdso.h
index fd9b30dbfb34..49513497766f 100644
--- a/include/litmus/fdso.h
+++ b/include/litmus/fdso.h
@@ -27,7 +27,9 @@ typedef enum  {
 
         DFLP_SEM        = 6,
 
-        MAX_OBJ_TYPE    = 6
+        OMLP_SEM        = 7,
+
+        MAX_OBJ_TYPE    = 7
 } obj_type_t;
 
 struct inode_obj_id {
diff --git a/litmus/fdso.c b/litmus/fdso.c
index 0ff54e41839c..e96e575d912e 100644
--- a/litmus/fdso.c
+++ b/litmus/fdso.c
@@ -28,6 +28,7 @@ static const struct fdso_ops* fdso_ops[] = {
         &generic_lock_ops, /* DPCP_SEM */
         &generic_lock_ops, /* PCP_SEM */
         &generic_lock_ops, /* DFLP_SEM */
+        &generic_lock_ops, /* OMLP_SEM */
 };
 
 static int fdso_create(void** obj_ref, obj_type_t type, void* __user config)
diff --git a/litmus/sched_gsn_edf.c b/litmus/sched_gsn_edf.c
index 8f28dc4e5192..d5f8dd89f79a 100644
--- a/litmus/sched_gsn_edf.c
+++ b/litmus/sched_gsn_edf.c
@@ -627,6 +627,7 @@ static long gsnedf_admit_task(struct task_struct* tsk)
 #ifdef CONFIG_LITMUS_LOCKING
 
 #include <litmus/fdso.h>
+#include <litmus/wait.h>
 
 /* called with IRQs off */
 static void set_priority_inheritance(struct task_struct* t, struct task_struct* prio_inh)
@@ -924,6 +925,275 @@ static struct litmus_lock* gsnedf_new_fmlp(void)
         return &sem->litmus_lock;
 }
 
+
+
+/* ******************** OMLP support ********************** */
+
+/* struct for semaphore with priority inheritance */
+struct omlp_semaphore {
+        struct litmus_lock litmus_lock;
+
+        /* current resource holder */
+        struct task_struct *owner;
+
+        /* highest-priority waiter */
+        struct task_struct *hp_waiter;
+
+        /* FIFO queue of waiting tasks */
+        wait_queue_head_t fifo_wait;
+        /* Priority queue of waiting tasks */
+        wait_queue_head_t prio_wait;
+
+        /* How many slots remaining in FIFO queue? */
+        unsigned int num_free;
+};
+
+static inline struct omlp_semaphore* omlp_from_lock(struct litmus_lock* lock)
+{
+        return container_of(lock, struct omlp_semaphore, litmus_lock);
+}
+
+/* already locked */
+static void omlp_enqueue(struct omlp_semaphore *sem, prio_wait_queue_t* wait)
+{
+        if (sem->num_free) {
+                /* there is space in the FIFO queue */
+                sem->num_free--;
+                __add_wait_queue_tail_exclusive(&sem->fifo_wait, &wait->wq);
+        } else {
+                /* nope, gotta go to the priority queue */
+                __add_wait_queue_prio_exclusive(&sem->prio_wait, wait);
+        }
+}
+
+/* already locked */
+static int omlp_move(struct omlp_semaphore *sem)
+{
+        struct list_head* first;
+
+        if (waitqueue_active(&sem->prio_wait)) {
+                first = sem->prio_wait.task_list.next;
+                list_move_tail(first, &sem->fifo_wait.task_list);
+                return 1;
+        }
+        else
+                return 0;
+}
+
+static struct task_struct* omlp_dequeue(struct omlp_semaphore *sem)
+{
+        struct task_struct* first = __waitqueue_remove_first(&sem->fifo_wait);
+
+        if (first && !omlp_move(sem))
+                sem->num_free++;
+
+        return first;
+}
+
+/* caller is responsible for locking */
+static struct task_struct* omlp_find_hp_waiter(struct omlp_semaphore *sem,
+                                        struct task_struct* skip)
+{
+        struct list_head        *pos;
+        struct task_struct      *queued, *found = NULL;
+
+        /* check FIFO queue first */
+        list_for_each(pos, &sem->fifo_wait.task_list) {
+                queued  = (struct task_struct*) list_entry(pos, wait_queue_t,
+                                                           task_list)->private;
+
+                /* Compare task prios, find high prio task. */
+                if (queued != skip && edf_higher_prio(queued, found))
+                        found = queued;
+        }
+
+        /* check priority queue next */
+        if (waitqueue_active(&sem->prio_wait)) {
+                /* first has highest priority */
+                pos = sem->prio_wait.task_list.next;
+                queued  = (struct task_struct*) list_entry(pos, wait_queue_t,
+                                                           task_list)->private;
+                if (edf_higher_prio(queued, found))
+                        found = queued;
+        }
+
+        return found;
+}
+
+int gsnedf_omlp_lock(struct litmus_lock* l)
+{
+        struct task_struct* t = current;
+        struct omlp_semaphore *sem = omlp_from_lock(l);
+        prio_wait_queue_t wait;
+        unsigned long flags;
+
+        if (!is_realtime(t))
+                return -EPERM;
+
+        /* prevent nested lock acquisition --- not supported by global OMLP
+           by default */
+        if (tsk_rt(t)->num_locks_held)
+                return -EBUSY;
+
+        spin_lock_irqsave(&sem->fifo_wait.lock, flags);
+
+        if (sem->owner) {
+                /* resource is not free => must suspend and wait */
+
+                init_prio_waitqueue_entry(&wait, t, get_deadline(t));
+
+                set_task_state(t, TASK_UNINTERRUPTIBLE);
+
+                omlp_enqueue(sem, &wait);
+
+                /* check if we need to activate priority inheritance */
+                if (edf_higher_prio(t, sem->hp_waiter)) {
+                        sem->hp_waiter = t;
+                        if (edf_higher_prio(t, sem->owner))
+                                set_priority_inheritance(sem->owner, sem->hp_waiter);
+                }
+
+                TS_LOCK_SUSPEND;
+
+                /* release lock before sleeping */
+                spin_unlock_irqrestore(&sem->fifo_wait.lock, flags);
+
+                schedule();
+
+                TS_LOCK_RESUME;
+
+                /* Since we hold the lock, no other task will change
+                 * ->owner. We can thus check it without acquiring the spin
+                 * lock. */
+                BUG_ON(sem->owner != t);
+        } else {
+                /* it's ours now */
+                sem->owner = t;
+
+                spin_unlock_irqrestore(&sem->fifo_wait.lock, flags);
+        }
+
+        tsk_rt(t)->num_locks_held++;
+
+        return 0;
+}
+
+static int gsnedf_omlp_unlock(struct litmus_lock* l)
+{
+        struct task_struct *t = current, *next;
+        struct omlp_semaphore *sem = omlp_from_lock(l);
+        unsigned long flags;
+        int err = 0;
+
+        spin_lock_irqsave(&sem->fifo_wait.lock, flags);
+
+        if (sem->owner != t) {
+                err = -EINVAL;
+                goto out;
+        }
+
+        tsk_rt(t)->num_locks_held--;
+
+        /* check if there are jobs waiting for this resource */
+        next = omlp_dequeue(sem);
+        if (next) {
+                /* next becomes the resouce holder */
+                sem->owner = next;
+                TRACE_CUR("lock ownership passed to %s/%d\n", next->comm, next->pid);
+
+                /* determine new hp_waiter if necessary */
+                if (next == sem->hp_waiter) {
+                        TRACE_TASK(next, "was highest-prio waiter\n");
+                        /* next has the highest priority --- it doesn't need to
+                         * inherit.  However, we need to make sure that the
+                         * next-highest priority in the queue is reflected in
+                         * hp_waiter. */
+                        sem->hp_waiter = omlp_find_hp_waiter(sem, next);
+                        if (sem->hp_waiter)
+                                TRACE_TASK(sem->hp_waiter, "is new highest-prio waiter\n");
+                        else
+                                TRACE("no further waiters\n");
+                } else {
+                        /* Well, if next is not the highest-priority waiter,
+                         * then it ought to inherit the highest-priority
+                         * waiter's priority. */
+                        set_priority_inheritance(next, sem->hp_waiter);
+                }
+
+                /* wake up next */
+                wake_up_process(next);
+        } else
+                /* becomes available */
+                sem->owner = NULL;
+
+        /* we lose the benefit of priority inheritance (if any) */
+        if (tsk_rt(t)->inh_task)
+                clear_priority_inheritance(t);
+
+out:
+        spin_unlock_irqrestore(&sem->fifo_wait.lock, flags);
+
+        return err;
+}
+
+static int gsnedf_omlp_close(struct litmus_lock* l)
+{
+        struct task_struct *t = current;
+        struct omlp_semaphore *sem = omlp_from_lock(l);
+        unsigned long flags;
+
+        int owner;
+
+        spin_lock_irqsave(&sem->fifo_wait.lock, flags);
+
+        owner = sem->owner == t;
+
+        spin_unlock_irqrestore(&sem->fifo_wait.lock, flags);
+
+        if (owner)
+                gsnedf_omlp_unlock(l);
+
+        return 0;
+}
+
+static void gsnedf_omlp_free(struct litmus_lock* lock)
+{
+        kfree(omlp_from_lock(lock));
+}
+
+static struct litmus_lock_ops gsnedf_omlp_lock_ops = {
+        .close  = gsnedf_omlp_close,
+        .lock   = gsnedf_omlp_lock,
+        .unlock = gsnedf_omlp_unlock,
+        .deallocate = gsnedf_omlp_free,
+};
+
+static struct litmus_lock* gsnedf_new_omlp(void)
+{
+        struct omlp_semaphore* sem;
+
+        sem = kmalloc(sizeof(*sem), GFP_KERNEL);
+        if (!sem)
+                return NULL;
+
+        sem->owner   = NULL;
+        sem->hp_waiter = NULL;
+        init_waitqueue_head(&sem->fifo_wait);
+        init_waitqueue_head(&sem->prio_wait);
+        sem->litmus_lock.ops = &gsnedf_omlp_lock_ops;
+        /* free = cpus -1 since ->owner is the head and also counted */
+        sem->num_free = num_online_cpus() - 1;
+
+#ifdef CONFIG_RELEASE_MASTER
+        /* If we use dedicated interrupt handling, then there are actually
+         * only m - 1 CPUs around. */
+        if (gsnedf.release_master != NO_CPU)
+                sem->num_free -= 1;
+#endif
+
+        return &sem->litmus_lock;
+}
+
 /* **** lock constructor **** */
 
 
@@ -932,7 +1202,8 @@ static long gsnedf_allocate_lock(struct litmus_lock **lock, int type,
 {
         int err = -ENXIO;
 
-        /* GSN-EDF currently only supports the FMLP for global resources. */
+        /* GSN-EDF currently only supports the FMLP and OMLP
+           for global resources. */
         switch (type) {
 
         case FMLP_SEM:
@@ -944,6 +1215,15 @@ static long gsnedf_allocate_lock(struct litmus_lock **lock, int type,
                         err = -ENOMEM;
                 break;
 
+        case OMLP_SEM:
+                /* O(m) Multiprocessor Locking Protocol */
+                *lock  = gsnedf_new_omlp();
+                if (*lock)
+                        err = 0;
+                else
+                        err = -ENOMEM;
+                break;
+
         };
 
         return err;