Pthread Workqueue Regulator (pwqr) initial commit.
authorPierre Habouzit <pierre.habouzit@intersec.com>
Fri, 16 Dec 2011 15:24:24 +0000 (16:24 +0100)
committerPierre Habouzit <pierre.habouzit@intersec.com>
Sat, 14 Jan 2012 17:03:33 +0000 (18:03 +0100)
This contains an alpha/beta quality kernel proof-of-concept driver, plus
some code concepts to wrap the syscall in lib/libpwqr.c

Signed-off-by: Pierre Habouzit <pierre.habouzit@intersec.com>
.gitignore [new file with mode: 0644]
Makefile [new file with mode: 0644]
kernel/Makefile [new file with mode: 0644]
kernel/pwqr.c [new file with mode: 0644]
kernel/pwqr.h [new file with mode: 0644]
lib/COPYING [new file with mode: 0644]
lib/Makefile [new file with mode: 0644]
lib/libpwqr.c [new file with mode: 0644]

diff --git a/.gitignore b/.gitignore
new file mode 100644 (file)
index 0000000..32058e5
--- /dev/null
@@ -0,0 +1,8 @@
+*.o
+*.ko
+*.so
+*.mod.c
+.*.cmd
+.tmp_versions
+Module.symvers
+modules.order
diff --git a/Makefile b/Makefile
new file mode 100644 (file)
index 0000000..7558a97
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,5 @@
+all clean:
+       $(MAKE) -C kernel $@
+       $(MAKE) -C lib $@
+
+.PHONY: all clean
diff --git a/kernel/Makefile b/kernel/Makefile
new file mode 100644 (file)
index 0000000..94c9f88
--- /dev/null
@@ -0,0 +1,14 @@
+KVERSION = $(shell uname -r)
+
+obj-m = pwqr.o
+
+all: pwqr.ko
+
+pwqr.ko: pwqr.c pwqr.h
+       $(MAKE) -C /lib/modules/$(KVERSION)/build M=$(PWD) modules
+
+clean:
+       $(MAKE) -C /lib/modules/$(KVERSION)/build M=$(PWD) clean
+       $(RM) test
+
+.PHONY: all clean
diff --git a/kernel/pwqr.c b/kernel/pwqr.c
new file mode 100644 (file)
index 0000000..0dd026f
--- /dev/null
@@ -0,0 +1,648 @@
+/*
+ * Copyright (C) 2012   Pierre Habouzit <pierre.habouzit@intersec.com>
+ * Copyright (C) 2012   Intersec SAS
+ *
+ * This file implements the Linux Pthread Workqueue Regulator, and is part
+ * of the linux kernel.
+ *
+ * The Linux Kernel is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 as published by
+ * the Free Software Foundation.
+ *
+ * The Linux Kernel is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+ * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
+ * License for more details.
+ *
+ * You should have received a copy of the GNU General Public License version 2
+ * along with The Linux Kernel.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <linux/cdev.h>
+#include <linux/device.h>
+#include <linux/file.h>
+#include <linux/fs.h>
+#include <linux/hash.h>
+#include <linux/init.h>
+#include <linux/kref.h>
+#include <linux/module.h>
+#include <linux/sched.h>
+#include <linux/slab.h>
+#include <linux/spinlock.h>
+#include <linux/uaccess.h>
+#include <linux/wait.h>
+
+#ifndef CONFIG_PREEMPT_NOTIFIERS
+#  error PWQ module requires CONFIG_PREEMPT_NOTIFIERS
+#endif
+
+#include "pwqr.h"
+
+#define PWQR_HASH_BITS         5
+#define PWQR_HASH_SIZE         (1 << PWQR_HASH_BITS)
+
+struct pwqr_task_bucket {
+       spinlock_t              lock;
+       struct hlist_head       tasks;
+};
+
+struct pwqr_sb {
+       struct kref             kref;
+       struct rcu_head         rcu;
+       wait_queue_head_t       wqh;
+       pid_t                   tgid;
+
+       unsigned                concurrency;
+       unsigned                registered;
+
+       unsigned                running;
+       unsigned                waiting;
+       unsigned                quarantined;
+       unsigned                parked;
+       unsigned                overcommit_wakes;
+
+       unsigned                dead;
+};
+
+struct pwqr_task {
+       struct preempt_notifier notifier;
+       struct hlist_node       link;
+       struct rcu_head         rcu;
+       struct task_struct     *task;
+       struct pwqr_sb         *sb;
+};
+
+/*
+ * Global variables
+ */
+static struct class           *pwqr_class;
+static int                     pwqr_major;
+static struct pwqr_task_bucket pwqr_tasks_hash[PWQR_HASH_SIZE];
+static struct preempt_ops      pwqr_preempt_running_ops;
+static struct preempt_ops      pwqr_preempt_blocked_ops;
+static struct preempt_ops      pwqr_preempt_noop_ops;
+
+/*****************************************************************************
+ * Scoreboards
+ */
+
+#define pwqr_sb_lock_irqsave(sb, flags) \
+       spin_lock_irqsave(&(sb)->wqh.lock, flags)
+#define pwqr_sb_unlock_irqrestore(sb, flags) \
+       spin_unlock_irqrestore(&(sb)->wqh.lock, flags)
+
+static inline void __pwqr_sb_update_state(struct pwqr_sb *sb, int running_delta)
+{
+       int overcommit;
+
+       sb->running += running_delta;
+       overcommit = sb->running + sb->waiting - sb->concurrency;
+       if (overcommit == 0)
+               return;
+
+       if (overcommit > 0) {
+               if (overcommit > sb->waiting) {
+                       sb->quarantined += sb->waiting;
+                       sb->waiting      = 0;
+               } else {
+                       sb->quarantined += overcommit;
+                       sb->waiting     -= overcommit;
+               }
+       } else {
+               unsigned undercommit = -overcommit;
+
+               if (undercommit < sb->quarantined) {
+                       sb->waiting     += undercommit;
+                       sb->quarantined -= undercommit;
+               } else if (sb->quarantined) {
+                       sb->waiting     += sb->quarantined;
+                       sb->quarantined  = 0;
+               } else if (sb->waiting == 0 && sb->parked) {
+                       wake_up_locked(&sb->wqh);
+               }
+       }
+}
+
+static struct pwqr_sb *pwqr_sb_create(void)
+{
+       struct pwqr_sb *sb;
+
+       sb = kzalloc(sizeof(struct pwqr_sb), GFP_KERNEL);
+       if (sb == NULL)
+               return ERR_PTR(-ENOMEM);
+
+       kref_init(&sb->kref);
+       init_waitqueue_head(&sb->wqh);
+       sb->tgid        = current->tgid;
+       sb->concurrency = num_online_cpus();
+
+       __module_get(THIS_MODULE);
+       return sb;
+}
+static inline void pwqr_sb_get(struct pwqr_sb *sb)
+{
+       kref_get(&sb->kref);
+}
+
+static void pwqr_sb_finalize(struct rcu_head *rcu)
+{
+       struct pwqr_sb *sb = container_of(rcu, struct pwqr_sb, rcu);
+
+       module_put(THIS_MODULE);
+       kfree(sb);
+}
+
+static void pwqr_sb_release(struct kref *kref)
+{
+       struct pwqr_sb *sb = container_of(kref, struct pwqr_sb, kref);
+
+       call_rcu(&sb->rcu, pwqr_sb_finalize);
+}
+static inline void pwqr_sb_put(struct pwqr_sb *sb)
+{
+       kref_put(&sb->kref, pwqr_sb_release);
+}
+
+/*****************************************************************************
+ * tasks
+ */
+static inline struct pwqr_task_bucket *task_hbucket(struct task_struct *task)
+{
+       return &pwqr_tasks_hash[hash_ptr(task, PWQR_HASH_BITS)];
+}
+
+static struct pwqr_task *pwqr_task_find(struct task_struct *task)
+{
+       struct pwqr_task_bucket *b = task_hbucket(task);
+       struct hlist_node *node;
+       struct pwqr_task *pwqt = NULL;
+
+       spin_lock(&b->lock);
+       hlist_for_each_entry(pwqt, node, &b->tasks, link) {
+               if (pwqt->task == task)
+                       break;
+       }
+       spin_unlock(&b->lock);
+       return pwqt;
+}
+
+static struct pwqr_task *pwqr_task_create(struct task_struct *task)
+{
+       struct pwqr_task_bucket *b = task_hbucket(task);
+       struct pwqr_task *pwqt;
+
+       pwqt = kmalloc(sizeof(*pwqt), GFP_KERNEL);
+       if (pwqt == NULL)
+               return ERR_PTR(-ENOMEM);
+
+       preempt_notifier_init(&pwqt->notifier, &pwqr_preempt_running_ops);
+       preempt_notifier_register(&pwqt->notifier);
+       pwqt->task = task;
+
+       spin_lock(&b->lock);
+       hlist_add_head(&pwqt->link, &b->tasks);
+       spin_unlock(&b->lock);
+
+       return pwqt;
+}
+
+__cold
+static void pwqr_task_detach(struct pwqr_task *pwqt, struct pwqr_sb *sb)
+{
+       unsigned long flags;
+
+       pwqr_sb_lock_irqsave(sb, flags);
+       sb->registered--;
+       if (pwqt->notifier.ops == &pwqr_preempt_running_ops) {
+               __pwqr_sb_update_state(sb, -1);
+       } else {
+               __pwqr_sb_update_state(sb, 0);
+       }
+       pwqr_sb_unlock_irqrestore(sb, flags);
+       pwqr_sb_put(sb);
+       pwqt->sb = NULL;
+}
+
+__cold
+static void pwqr_task_attach(struct pwqr_task *pwqt, struct pwqr_sb *sb)
+{
+       unsigned long flags;
+
+       pwqr_sb_lock_irqsave(sb, flags);
+       pwqr_sb_get(pwqt->sb = sb);
+       sb->registered++;
+       __pwqr_sb_update_state(sb, 1);
+       pwqr_sb_unlock_irqrestore(sb, flags);
+}
+
+__cold
+static void pwqr_task_release(struct pwqr_task *pwqt, bool from_notifier)
+{
+       struct pwqr_task_bucket *b = task_hbucket(pwqt->task);
+
+       spin_lock(&b->lock);
+       hlist_del(&pwqt->link);
+       spin_unlock(&b->lock);
+       pwqt->notifier.ops = &pwqr_preempt_noop_ops;
+
+       if (from_notifier) {
+               /* When called from sched_{out,in}, it's not allowed to
+                * call preempt_notifier_unregister (or worse kfree())
+                *
+                * Though it's not a good idea to kfree() still registered
+                * callbacks if we're not dying, it'll panic on the next
+                * sched_{in,out} call.
+                */
+               BUG_ON(!(pwqt->task->state & TASK_DEAD));
+               kfree_rcu(pwqt, rcu);
+       } else {
+               preempt_notifier_unregister(&pwqt->notifier);
+               kfree(pwqt);
+       }
+}
+
+static void pwqr_task_noop_sched_in(struct preempt_notifier *notifier, int cpu)
+{
+}
+
+static void pwqr_task_noop_sched_out(struct preempt_notifier *notifier,
+                                   struct task_struct *next)
+{
+}
+
+static void pwqr_task_blocked_sched_in(struct preempt_notifier *notifier, int cpu)
+{
+       struct pwqr_task *pwqt = container_of(notifier, struct pwqr_task, notifier);
+       struct pwqr_sb   *sb   = pwqt->sb;
+       unsigned long flags;
+
+       if (unlikely(sb->dead)) {
+               pwqr_task_detach(pwqt, sb);
+               pwqr_task_release(pwqt, true);
+               return;
+       }
+
+       pwqt->notifier.ops = &pwqr_preempt_running_ops;
+       pwqr_sb_lock_irqsave(sb, flags);
+       __pwqr_sb_update_state(sb, 1);
+       pwqr_sb_unlock_irqrestore(sb, flags);
+}
+
+static void pwqr_task_sched_out(struct preempt_notifier *notifier,
+                              struct task_struct *next)
+{
+       struct pwqr_task    *pwqt = container_of(notifier, struct pwqr_task, notifier);
+       struct pwqr_sb      *sb   = pwqt->sb;
+       struct task_struct *p    = pwqt->task;
+
+       if (unlikely(p->state & TASK_DEAD) || unlikely(sb->dead)) {
+               pwqr_task_detach(pwqt, sb);
+               pwqr_task_release(pwqt, true);
+               return;
+       }
+       if (p->state == 0 || (p->state & (__TASK_STOPPED | __TASK_TRACED)))
+               return;
+
+       pwqt->notifier.ops = &pwqr_preempt_blocked_ops;
+       /* see preempt.h: irq are disabled for sched_out */
+       spin_lock(&sb->wqh.lock);
+       __pwqr_sb_update_state(sb, -1);
+       spin_unlock(&sb->wqh.lock);
+}
+
+static struct preempt_ops __read_mostly pwqr_preempt_noop_ops = {
+       .sched_in       = pwqr_task_noop_sched_in,
+       .sched_out      = pwqr_task_noop_sched_out,
+};
+
+static struct preempt_ops __read_mostly pwqr_preempt_running_ops = {
+       .sched_in       = pwqr_task_noop_sched_in,
+       .sched_out      = pwqr_task_sched_out,
+};
+
+static struct preempt_ops __read_mostly pwqr_preempt_blocked_ops = {
+       .sched_in       = pwqr_task_blocked_sched_in,
+       .sched_out      = pwqr_task_sched_out,
+};
+
+/*****************************************************************************
+ * file descriptor
+ */
+static int pwqr_open(struct inode *inode, struct file *filp)
+{
+       struct pwqr_sb *sb;
+
+       sb = pwqr_sb_create();
+       if (IS_ERR(sb))
+               return PTR_ERR(sb);
+       filp->private_data = sb;
+       return 0;
+}
+
+static int pwqr_release(struct inode *inode, struct file *filp)
+{
+       struct pwqr_sb *sb = filp->private_data;
+       unsigned long flags;
+
+       pwqr_sb_lock_irqsave(sb, flags);
+       sb->dead = true;
+       pwqr_sb_unlock_irqrestore(sb, flags);
+       wake_up_all(&sb->wqh);
+       pwqr_sb_put(sb);
+       return 0;
+}
+
+static long
+do_pwqr_wait(struct pwqr_sb *sb, struct pwqr_task *pwqt,
+           int in_pool, struct pwqr_ioc_wait __user *arg)
+{
+       unsigned long flags;
+       struct pwqr_ioc_wait wait;
+       long rc = 0;
+       u32 uval;
+
+       preempt_notifier_unregister(&pwqt->notifier);
+
+       if (in_pool && copy_from_user(&wait, arg, sizeof(wait))) {
+               rc = -EFAULT;
+               goto out;
+       }
+
+       pwqr_sb_lock_irqsave(sb, flags);
+       if (sb->running + sb->waiting <= sb->concurrency) {
+               if (in_pool) {
+                       while (probe_kernel_address(wait.pwqr_uaddr, uval)) {
+                               pwqr_sb_unlock_irqrestore(sb, flags);
+                               rc = get_user(uval, (u32 *)wait.pwqr_uaddr);
+                               if (rc)
+                                       goto out;
+                               pwqr_sb_lock_irqsave(sb, flags);
+                       }
+
+                       if (uval != (u32)wait.pwqr_ticket) {
+                               rc = -EWOULDBLOCK;
+                               goto out_unlock;
+                       }
+               } else {
+                       BUG_ON(sb->quarantined != 0);
+                       goto out_unlock;
+               }
+       }
+
+       /* @ see <wait_event_interruptible_exclusive_locked_irq> */
+       if (likely(!sb->dead)) {
+               DEFINE_WAIT(__wait);
+
+               __wait.flags |= WQ_FLAG_EXCLUSIVE;
+
+               if (in_pool) {
+                       sb->waiting++;
+                       __add_wait_queue(&sb->wqh, &__wait);
+               } else {
+                       sb->parked++;
+                       __add_wait_queue_tail(&sb->wqh, &__wait);
+               }
+               __pwqr_sb_update_state(sb, -1);
+               set_current_state(TASK_INTERRUPTIBLE);
+
+               do {
+                       if (sb->overcommit_wakes)
+                               break;
+                       if (signal_pending(current)) {
+                               rc = -ERESTARTSYS;
+                               break;
+                       }
+                       spin_unlock_irq(&sb->wqh.lock);
+                       schedule();
+                       spin_lock_irq(&sb->wqh.lock);
+                       if (in_pool && sb->waiting)
+                               break;
+                       if (sb->running + sb->waiting < sb->concurrency)
+                               break;
+               } while (likely(!sb->dead));
+
+               __remove_wait_queue(&sb->wqh, &__wait);
+               __set_current_state(TASK_RUNNING);
+
+               if (in_pool) {
+                       if (sb->waiting) {
+                               sb->waiting--;
+                       } else {
+                               BUG_ON(!sb->quarantined);
+                               sb->quarantined--;
+                       }
+               } else {
+                       sb->parked--;
+               }
+               __pwqr_sb_update_state(sb, 1);
+               if (sb->overcommit_wakes)
+                       sb->overcommit_wakes--;
+               if (sb->waiting + sb->running > sb->concurrency)
+                       rc = -EDQUOT;
+       }
+
+out_unlock:
+       if (unlikely(sb->dead))
+               rc = -EBADFD;
+       pwqr_sb_unlock_irqrestore(sb, flags);
+out:
+       preempt_notifier_register(&pwqt->notifier);
+       return rc;
+}
+
+static long do_pwqr_unregister(struct pwqr_sb *sb, struct pwqr_task *pwqt)
+{
+       if (!pwqt)
+               return -EINVAL;
+       if (pwqt->sb != sb)
+               return -ENOENT;
+       pwqr_task_detach(pwqt, sb);
+       pwqr_task_release(pwqt, false);
+       return 0;
+}
+
+static long do_pwqr_set_conc(struct pwqr_sb *sb, int conc)
+{
+       long old_conc = sb->concurrency;
+       unsigned long flags;
+
+       pwqr_sb_lock_irqsave(sb, flags);
+       if (conc <= 0)
+               conc = num_online_cpus();
+       if (conc != old_conc) {
+               sb->concurrency = conc;
+               __pwqr_sb_update_state(sb, 0);
+       }
+       pwqr_sb_unlock_irqrestore(sb, flags);
+
+       return old_conc;
+}
+
+static long do_pwqr_wake(struct pwqr_sb *sb, int oc, int count)
+{
+       unsigned long flags;
+       int nwake;
+
+       if (count < 0)
+               return -EINVAL;
+
+       pwqr_sb_lock_irqsave(sb, flags);
+
+       if (oc) {
+               nwake = sb->waiting + sb->quarantined + sb->parked - sb->overcommit_wakes;
+               if (count > nwake) {
+                       count = nwake;
+               } else {
+                       nwake = count;
+               }
+               sb->overcommit_wakes += count;
+       } else if (sb->running + sb->overcommit_wakes < sb->concurrency) {
+               nwake = sb->concurrency - sb->overcommit_wakes - sb->running;
+               if (count > nwake) {
+                       count = nwake;
+               } else {
+                       nwake = count;
+               }
+       } else {
+               /*
+                * This codepath deserves an explanation: when the thread is
+                * quarantined, for is, really, it's already "parked". Though
+                * userland doesn't know about, so wake as many threads as
+                * userlands would have liked to, and let the wakeup tell
+                * userland those should be parked.
+                *
+                * That's why we lie about the number of woken threads,
+                * really, userlandwise we woke up a thread so that it could
+                * be parked for real and avoid spurious syscalls. So it's as
+                * if we woke up 0 threads.
+                */
+               nwake = sb->quarantined;
+               if (sb->waiting < sb->overcommit_wakes)
+                       nwake -= sb->overcommit_wakes - sb->waiting;
+               if (nwake > count)
+                       nwake = count;
+               count = 0;
+       }
+       while (nwake-- > 0)
+               wake_up_locked(&sb->wqh);
+       pwqr_sb_unlock_irqrestore(sb, flags);
+
+       return count;
+}
+
+static long pwqr_ioctl(struct file *filp, unsigned command, unsigned long arg)
+{
+       struct pwqr_sb      *sb   = filp->private_data;
+       struct task_struct *task = current;
+       struct pwqr_task    *pwqt;
+       int rc = 0;
+
+       if (sb->tgid != current->tgid)
+               return -EBADFD;
+
+       switch (command) {
+       case PWQR_GET_CONC:
+               return sb->concurrency;
+       case PWQR_SET_CONC:
+               return do_pwqr_set_conc(sb, (int)arg);
+
+       case PWQR_WAKE:
+       case PWQR_WAKE_OC:
+               return do_pwqr_wake(sb, command == PWQR_WAKE_OC, (int)arg);
+
+       case PWQR_WAIT:
+       case PWQR_PARK:
+       case PWQR_REGISTER:
+       case PWQR_UNREGISTER:
+               break;
+       default:
+               return -EINVAL;
+       }
+
+       pwqt = pwqr_task_find(task);
+       if (command == PWQR_UNREGISTER)
+               return do_pwqr_unregister(sb, pwqt);
+
+       if (pwqt == NULL) {
+               pwqt = pwqr_task_create(task);
+               if (IS_ERR(pwqt))
+                       return PTR_ERR(pwqt);
+               pwqr_task_attach(pwqt, sb);
+       } else if (unlikely(pwqt->sb != sb)) {
+               pwqr_task_detach(pwqt, pwqt->sb);
+               pwqr_task_attach(pwqt, sb);
+       }
+
+       switch (command) {
+       case PWQR_WAIT:
+               rc = do_pwqr_wait(sb, pwqt, true, (struct pwqr_ioc_wait __user *)arg);
+               break;
+       case PWQR_PARK:
+               rc = do_pwqr_wait(sb, pwqt, false, NULL);
+               break;
+       }
+
+       if (unlikely(sb->dead)) {
+               pwqr_task_detach(pwqt, pwqt->sb);
+               return -EBADFD;
+       }
+       return rc;
+}
+
+static const struct file_operations pwqr_dev_fops = {
+       .owner          = THIS_MODULE,
+       .open           = pwqr_open,
+       .release        = pwqr_release,
+       .unlocked_ioctl = pwqr_ioctl,
+#ifdef CONFIG_COMPAT
+       .compat_ioctl   = pwqr_ioctl,
+#endif
+};
+
+/*****************************************************************************
+ * module
+ */
+static int __init pwqr_start(void)
+{
+       int i;
+
+       for (i = 0; i < PWQR_HASH_SIZE; i++) {
+               spin_lock_init(&pwqr_tasks_hash[i].lock);
+               INIT_HLIST_HEAD(&pwqr_tasks_hash[i].tasks);
+       }
+
+       /* Register as a character device */
+       pwqr_major = register_chrdev(0, "pwqr", &pwqr_dev_fops);
+       if (pwqr_major < 0) {
+               printk(KERN_ERR "pwqr: register_chrdev() failed\n");
+               return pwqr_major;
+       }
+
+       /* Create a device node */
+       pwqr_class = class_create(THIS_MODULE, PWQR_DEVICE_NAME);
+       if (IS_ERR(pwqr_class)) {
+               printk(KERN_ERR "pwqr: Error creating raw class\n");
+               unregister_chrdev(pwqr_major, PWQR_DEVICE_NAME);
+               return PTR_ERR(pwqr_class);
+       }
+       device_create(pwqr_class, NULL, MKDEV(pwqr_major, 0), NULL, PWQR_DEVICE_NAME);
+       printk(KERN_INFO "pwqr: PThreads Work Queues Regulator v1 loaded");
+       return 0;
+}
+
+static void __exit pwqr_end(void)
+{
+       rcu_barrier();
+       device_destroy(pwqr_class, MKDEV(pwqr_major, 0));
+       class_destroy(pwqr_class);
+       unregister_chrdev(pwqr_major, PWQR_DEVICE_NAME);
+}
+
+module_init(pwqr_start);
+module_exit(pwqr_end);
+
+MODULE_LICENSE("GPL");
+MODULE_AUTHOR("Pierre Habouzit <pierre.habouzit@intersec.com>");
+MODULE_DESCRIPTION("PThreads Work Queues Regulator");
+
+// vim:noet:sw=8:cinoptions+=\:0,L-1,=1s:
diff --git a/kernel/pwqr.h b/kernel/pwqr.h
new file mode 100644 (file)
index 0000000..a7aa086
--- /dev/null
@@ -0,0 +1,42 @@
+/*
+ * Copyright (C) 2012   Pierre Habouzit <pierre.habouzit@intersec.com>
+ * Copyright (C) 2012   Intersec SAS
+ *
+ * This file implements the Linux Pthread Workqueue Regulator, and is part
+ * of the linux kernel.
+ *
+ * The Linux Kernel is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 as published by
+ * the Free Software Foundation.
+ *
+ * The Linux Kernel is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+ * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
+ * License for more details.
+ *
+ * You should have received a copy of the GNU General Public License version 2
+ * along with The Linux Kernel.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef _LINUX_PWQR_H
+#define _LINUX_PWQR_H
+#include <linux/ioctl.h>
+
+#define PWQR_DEVICE_NAME       "pwq"
+#define PWQR_IO                        '}'
+
+struct pwqr_ioc_wait {
+       int     pwqr_ticket;
+       void   *pwqr_uaddr;
+};
+
+#define PWQR_GET_CONC          _IO (PWQR_IO, 0)
+#define PWQR_SET_CONC          _IO (PWQR_IO, 1)
+#define PWQR_REGISTER          _IO (PWQR_IO, 2)
+#define PWQR_UNREGISTER                _IO (PWQR_IO, 3)
+#define PWQR_WAKE              _IO (PWQR_IO, 4)
+#define PWQR_WAKE_OC           _IO (PWQR_IO, 5)
+#define PWQR_WAIT              _IOW(PWQR_IO, 6, struct pwqr_ioc_wait)
+#define PWQR_PARK              _IO (PWQR_IO, 7)
+
+#endif
diff --git a/lib/COPYING b/lib/COPYING
new file mode 100644 (file)
index 0000000..4362b49
--- /dev/null
@@ -0,0 +1,502 @@
+                  GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 2.1, February 1999
+
+ Copyright (C) 1991, 1999 Free Software Foundation, Inc.
+ 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+[This is the first released version of the Lesser GPL.  It also counts
+ as the successor of the GNU Library Public License, version 2, hence
+ the version number 2.1.]
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+Licenses are intended to guarantee your freedom to share and change
+free software--to make sure the software is free for all its users.
+
+  This license, the Lesser General Public License, applies to some
+specially designated software packages--typically libraries--of the
+Free Software Foundation and other authors who decide to use it.  You
+can use it too, but we suggest you first think carefully about whether
+this license or the ordinary General Public License is the better
+strategy to use in any particular case, based on the explanations below.
+
+  When we speak of free software, we are referring to freedom of use,
+not price.  Our General Public Licenses are designed to make sure that
+you have the freedom to distribute copies of free software (and charge
+for this service if you wish); that you receive source code or can get
+it if you want it; that you can change the software and use pieces of
+it in new free programs; and that you are informed that you can do
+these things.
+
+  To protect your rights, we need to make restrictions that forbid
+distributors to deny you these rights or to ask you to surrender these
+rights.  These restrictions translate to certain responsibilities for
+you if you distribute copies of the library or if you modify it.
+
+  For example, if you distribute copies of the library, whether gratis
+or for a fee, you must give the recipients all the rights that we gave
+you.  You must make sure that they, too, receive or can get the source
+code.  If you link other code with the library, you must provide
+complete object files to the recipients, so that they can relink them
+with the library after making changes to the library and recompiling
+it.  And you must show them these terms so they know their rights.
+
+  We protect your rights with a two-step method: (1) we copyright the
+library, and (2) we offer you this license, which gives you legal
+permission to copy, distribute and/or modify the library.
+
+  To protect each distributor, we want to make it very clear that
+there is no warranty for the free library.  Also, if the library is
+modified by someone else and passed on, the recipients should know
+that what they have is not the original version, so that the original
+author's reputation will not be affected by problems that might be
+introduced by others.
+\f
+  Finally, software patents pose a constant threat to the existence of
+any free program.  We wish to make sure that a company cannot
+effectively restrict the users of a free program by obtaining a
+restrictive license from a patent holder.  Therefore, we insist that
+any patent license obtained for a version of the library must be
+consistent with the full freedom of use specified in this license.
+
+  Most GNU software, including some libraries, is covered by the
+ordinary GNU General Public License.  This license, the GNU Lesser
+General Public License, applies to certain designated libraries, and
+is quite different from the ordinary General Public License.  We use
+this license for certain libraries in order to permit linking those
+libraries into non-free programs.
+
+  When a program is linked with a library, whether statically or using
+a shared library, the combination of the two is legally speaking a
+combined work, a derivative of the original library.  The ordinary
+General Public License therefore permits such linking only if the
+entire combination fits its criteria of freedom.  The Lesser General
+Public License permits more lax criteria for linking other code with
+the library.
+
+  We call this license the "Lesser" General Public License because it
+does Less to protect the user's freedom than the ordinary General
+Public License.  It also provides other free software developers Less
+of an advantage over competing non-free programs.  These disadvantages
+are the reason we use the ordinary General Public License for many
+libraries.  However, the Lesser license provides advantages in certain
+special circumstances.
+
+  For example, on rare occasions, there may be a special need to
+encourage the widest possible use of a certain library, so that it becomes
+a de-facto standard.  To achieve this, non-free programs must be
+allowed to use the library.  A more frequent case is that a free
+library does the same job as widely used non-free libraries.  In this
+case, there is little to gain by limiting the free library to free
+software only, so we use the Lesser General Public License.
+
+  In other cases, permission to use a particular library in non-free
+programs enables a greater number of people to use a large body of
+free software.  For example, permission to use the GNU C Library in
+non-free programs enables many more people to use the whole GNU
+operating system, as well as its variant, the GNU/Linux operating
+system.
+
+  Although the Lesser General Public License is Less protective of the
+users' freedom, it does ensure that the user of a program that is
+linked with the Library has the freedom and the wherewithal to run
+that program using a modified version of the Library.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.  Pay close attention to the difference between a
+"work based on the library" and a "work that uses the library".  The
+former contains code derived from the library, whereas the latter must
+be combined with the library in order to run.
+\f
+                  GNU LESSER GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License Agreement applies to any software library or other
+program which contains a notice placed by the copyright holder or
+other authorized party saying it may be distributed under the terms of
+this Lesser General Public License (also called "this License").
+Each licensee is addressed as "you".
+
+  A "library" means a collection of software functions and/or data
+prepared so as to be conveniently linked with application programs
+(which use some of those functions and data) to form executables.
+
+  The "Library", below, refers to any such software library or work
+which has been distributed under these terms.  A "work based on the
+Library" means either the Library or any derivative work under
+copyright law: that is to say, a work containing the Library or a
+portion of it, either verbatim or with modifications and/or translated
+straightforwardly into another language.  (Hereinafter, translation is
+included without limitation in the term "modification".)
+
+  "Source code" for a work means the preferred form of the work for
+making modifications to it.  For a library, complete source code means
+all the source code for all modules it contains, plus any associated
+interface definition files, plus the scripts used to control compilation
+and installation of the library.
+
+  Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running a program using the Library is not restricted, and output from
+such a program is covered only if its contents constitute a work based
+on the Library (independent of the use of the Library in a tool for
+writing it).  Whether that is true depends on what the Library does
+and what the program that uses the Library does.
+
+  1. You may copy and distribute verbatim copies of the Library's
+complete source code as you receive it, in any medium, provided that
+you conspicuously and appropriately publish on each copy an
+appropriate copyright notice and disclaimer of warranty; keep intact
+all the notices that refer to this License and to the absence of any
+warranty; and distribute a copy of this License along with the
+Library.
+
+  You may charge a fee for the physical act of transferring a copy,
+and you may at your option offer warranty protection in exchange for a
+fee.
+\f
+  2. You may modify your copy or copies of the Library or any portion
+of it, thus forming a work based on the Library, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) The modified work must itself be a software library.
+
+    b) You must cause the files modified to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    c) You must cause the whole of the work to be licensed at no
+    charge to all third parties under the terms of this License.
+
+    d) If a facility in the modified Library refers to a function or a
+    table of data to be supplied by an application program that uses
+    the facility, other than as an argument passed when the facility
+    is invoked, then you must make a good faith effort to ensure that,
+    in the event an application does not supply such function or
+    table, the facility still operates, and performs whatever part of
+    its purpose remains meaningful.
+
+    (For example, a function in a library to compute square roots has
+    a purpose that is entirely well-defined independent of the
+    application.  Therefore, Subsection 2d requires that any
+    application-supplied function or table used by this function must
+    be optional: if the application does not supply it, the square
+    root function must still compute square roots.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Library,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Library, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote
+it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Library.
+
+In addition, mere aggregation of another work not based on the Library
+with the Library (or with a work based on the Library) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may opt to apply the terms of the ordinary GNU General Public
+License instead of this License to a given copy of the Library.  To do
+this, you must alter all the notices that refer to this License, so
+that they refer to the ordinary GNU General Public License, version 2,
+instead of to this License.  (If a newer version than version 2 of the
+ordinary GNU General Public License has appeared, then you can specify
+that version instead if you wish.)  Do not make any other change in
+these notices.
+\f
+  Once this change is made in a given copy, it is irreversible for
+that copy, so the ordinary GNU General Public License applies to all
+subsequent copies and derivative works made from that copy.
+
+  This option is useful when you wish to copy part of the code of
+the Library into a program that is not a library.
+
+  4. You may copy and distribute the Library (or a portion or
+derivative of it, under Section 2) in object code or executable form
+under the terms of Sections 1 and 2 above provided that you accompany
+it with the complete corresponding machine-readable source code, which
+must be distributed under the terms of Sections 1 and 2 above on a
+medium customarily used for software interchange.
+
+  If distribution of object code is made by offering access to copy
+from a designated place, then offering equivalent access to copy the
+source code from the same place satisfies the requirement to
+distribute the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  5. A program that contains no derivative of any portion of the
+Library, but is designed to work with the Library by being compiled or
+linked with it, is called a "work that uses the Library".  Such a
+work, in isolation, is not a derivative work of the Library, and
+therefore falls outside the scope of this License.
+
+  However, linking a "work that uses the Library" with the Library
+creates an executable that is a derivative of the Library (because it
+contains portions of the Library), rather than a "work that uses the
+library".  The executable is therefore covered by this License.
+Section 6 states terms for distribution of such executables.
+
+  When a "work that uses the Library" uses material from a header file
+that is part of the Library, the object code for the work may be a
+derivative work of the Library even though the source code is not.
+Whether this is true is especially significant if the work can be
+linked without the Library, or if the work is itself a library.  The
+threshold for this to be true is not precisely defined by law.
+
+  If such an object file uses only numerical parameters, data
+structure layouts and accessors, and small macros and small inline
+functions (ten lines or less in length), then the use of the object
+file is unrestricted, regardless of whether it is legally a derivative
+work.  (Executables containing this object code plus portions of the
+Library will still fall under Section 6.)
+
+  Otherwise, if the work is a derivative of the Library, you may
+distribute the object code for the work under the terms of Section 6.
+Any executables containing that work also fall under Section 6,
+whether or not they are linked directly with the Library itself.
+\f
+  6. As an exception to the Sections above, you may also combine or
+link a "work that uses the Library" with the Library to produce a
+work containing portions of the Library, and distribute that work
+under terms of your choice, provided that the terms permit
+modification of the work for the customer's own use and reverse
+engineering for debugging such modifications.
+
+  You must give prominent notice with each copy of the work that the
+Library is used in it and that the Library and its use are covered by
+this License.  You must supply a copy of this License.  If the work
+during execution displays copyright notices, you must include the
+copyright notice for the Library among them, as well as a reference
+directing the user to the copy of this License.  Also, you must do one
+of these things:
+
+    a) Accompany the work with the complete corresponding
+    machine-readable source code for the Library including whatever
+    changes were used in the work (which must be distributed under
+    Sections 1 and 2 above); and, if the work is an executable linked
+    with the Library, with the complete machine-readable "work that
+    uses the Library", as object code and/or source code, so that the
+    user can modify the Library and then relink to produce a modified
+    executable containing the modified Library.  (It is understood
+    that the user who changes the contents of definitions files in the
+    Library will not necessarily be able to recompile the application
+    to use the modified definitions.)
+
+    b) Use a suitable shared library mechanism for linking with the
+    Library.  A suitable mechanism is one that (1) uses at run time a
+    copy of the library already present on the user's computer system,
+    rather than copying library functions into the executable, and (2)
+    will operate properly with a modified version of the library, if
+    the user installs one, as long as the modified version is
+    interface-compatible with the version that the work was made with.
+
+    c) Accompany the work with a written offer, valid for at
+    least three years, to give the same user the materials
+    specified in Subsection 6a, above, for a charge no more
+    than the cost of performing this distribution.
+
+    d) If distribution of the work is made by offering access to copy
+    from a designated place, offer equivalent access to copy the above
+    specified materials from the same place.
+
+    e) Verify that the user has already received a copy of these
+    materials or that you have already sent this user a copy.
+
+  For an executable, the required form of the "work that uses the
+Library" must include any data and utility programs needed for
+reproducing the executable from it.  However, as a special exception,
+the materials to be distributed need not include anything that is
+normally distributed (in either source or binary form) with the major
+components (compiler, kernel, and so on) of the operating system on
+which the executable runs, unless that component itself accompanies
+the executable.
+
+  It may happen that this requirement contradicts the license
+restrictions of other proprietary libraries that do not normally
+accompany the operating system.  Such a contradiction means you cannot
+use both them and the Library together in an executable that you
+distribute.
+\f
+  7. You may place library facilities that are a work based on the
+Library side-by-side in a single library together with other library
+facilities not covered by this License, and distribute such a combined
+library, provided that the separate distribution of the work based on
+the Library and of the other library facilities is otherwise
+permitted, and provided that you do these two things:
+
+    a) Accompany the combined library with a copy of the same work
+    based on the Library, uncombined with any other library
+    facilities.  This must be distributed under the terms of the
+    Sections above.
+
+    b) Give prominent notice with the combined library of the fact
+    that part of it is a work based on the Library, and explaining
+    where to find the accompanying uncombined form of the same work.
+
+  8. You may not copy, modify, sublicense, link with, or distribute
+the Library except as expressly provided under this License.  Any
+attempt otherwise to copy, modify, sublicense, link with, or
+distribute the Library is void, and will automatically terminate your
+rights under this License.  However, parties who have received copies,
+or rights, from you under this License will not have their licenses
+terminated so long as such parties remain in full compliance.
+
+  9. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Library or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Library (or any work based on the
+Library), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Library or works based on it.
+
+  10. Each time you redistribute the Library (or any work based on the
+Library), the recipient automatically receives a license from the
+original licensor to copy, distribute, link with or modify the Library
+subject to these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties with
+this License.
+\f
+  11. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Library at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Library by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Library.
+
+If any portion of this section is held invalid or unenforceable under any
+particular circumstance, the balance of the section is intended to apply,
+and the section as a whole is intended to apply in other circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  12. If the distribution and/or use of the Library is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Library under this License may add
+an explicit geographical distribution limitation excluding those countries,
+so that distribution is permitted only in or among countries not thus
+excluded.  In such case, this License incorporates the limitation as if
+written in the body of this License.
+
+  13. The Free Software Foundation may publish revised and/or new
+versions of the Lesser General Public License from time to time.
+Such new versions will be similar in spirit to the present version,
+but may differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Library
+specifies a version number of this License which applies to it and
+"any later version", you have the option of following the terms and
+conditions either of that version or of any later version published by
+the Free Software Foundation.  If the Library does not specify a
+license version number, you may choose any version ever published by
+the Free Software Foundation.
+\f
+  14. If you wish to incorporate parts of the Library into other free
+programs whose distribution conditions are incompatible with these,
+write to the author to ask for permission.  For software which is
+copyrighted by the Free Software Foundation, write to the Free
+Software Foundation; we sometimes make exceptions for this.  Our
+decision will be guided by the two goals of preserving the free status
+of all derivatives of our free software and of promoting the sharing
+and reuse of software generally.
+
+                            NO WARRANTY
+
+  15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
+WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
+EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
+OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
+KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
+LIBRARY IS WITH YOU.  SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
+THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
+WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
+AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
+FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
+CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
+LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
+RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
+FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
+SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+\f
+           How to Apply These Terms to Your New Libraries
+
+  If you develop a new library, and you want it to be of the greatest
+possible use to the public, we recommend making it free software that
+everyone can redistribute and change.  You can do so by permitting
+redistribution under these terms (or, alternatively, under the terms of the
+ordinary General Public License).
+
+  To apply these terms, attach the following notices to the library.  It is
+safest to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least the
+"copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the library's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 2.1 of the License, or (at your option) any later version.
+
+    This library is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public
+    License along with this library; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+Also add information on how to contact you by electronic and paper mail.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the library, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the
+  library `Frob' (a library for tweaking knobs) written by James Random Hacker.
+
+  <signature of Ty Coon>, 1 April 1990
+  Ty Coon, President of Vice
+
+That's all there is to it!
diff --git a/lib/Makefile b/lib/Makefile
new file mode 100644 (file)
index 0000000..814ba75
--- /dev/null
@@ -0,0 +1,9 @@
+all: libpwqr.so
+
+libpwqr.so: libpwqr.c
+       $(CC) -Wall -Werror -Wextra -Wno-unused-parameter $(CFLAGS) -O2 -fPIC -g -shared -lpthread -o $@ $<
+
+clean:
+       $(RM) libpwqr.so
+
+.PHONY: all clean
diff --git a/lib/libpwqr.c b/lib/libpwqr.c
new file mode 100644 (file)
index 0000000..f5d53a2
--- /dev/null
@@ -0,0 +1,345 @@
+/*
+ * Copyright (C) 2012   Pierre Habouzit <pierre.habouzit@intersec.com>
+ * Copyright (C) 2012   Intersec SAS
+ *
+ * This file implements the Linux Pthread Workqueue Regulator usperspace.
+ *
+ * The Linux Pthread Workqueue Regulator is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU Lesser
+ * General Public License as published by the Free Software Foundation,
+ * either version 2.1 of the License, or (at your option) any later version.
+ *
+ * The Linux Pthread Workqueue Regulator is distributed in the hope that it
+ * will be useful, but WITHOUT ANY WARRANTY; without even the implied
+ * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with The Linux Pthread Workqueue Regultaor.
+ * If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <assert.h>
+#include <errno.h>
+#include <fcntl.h>
+#include <pthread.h>
+#include <sched.h>
+#include <stddef.h>
+#include <stdint.h>
+#include <sys/ioctl.h>
+#include <sys/types.h>
+#include <unistd.h>
+
+#include "../kernel/pwqr.h"
+
+#define INPOOL          0
+#define PARKED          1
+#define PARKED_MAX     16
+#define THREADS_MAX   128 /* something dynamic is probably better */
+
+/* Compiler stuff {{{ */
+
+#if defined(__x86_64__)
+#  define mb()          asm volatile("mfence":::"memory")
+#elif defined(__i386__)
+#  define mb()          asm volatile("lock; addl $0,0(%%esp)":::"memory")
+#else
+#  error unsupported architecture
+#endif
+
+#define container_of(obj, type_t, member) \
+      ({ const typeof(((type_t *)0)->member) *__mptr = (obj); \
+         ((type_t *)((char *)__mptr) - offsetof(type_t, member)); })
+#define likely(expr)     __builtin_expect(!!(expr), 1)
+#define unlikely(expr)   __builtin_expect((expr), 0)
+
+#define barrier()          asm volatile("":::"memory")
+#define access_once(x)     (*(volatile typeof(x) *)&(x))
+
+#define atomic_fetch_and_add(ptr, n) __sync_fetch_and_add(ptr, n)
+#define atomic_add(ptr, n)           (void)atomic_fetch_and_add(ptr, n)
+#define atomic_fetch_and_sub(ptr, n) __sync_fetch_and_sub(ptr, n)
+#define atomic_sub(ptr, n)           (void)atomic_fetch_and_sub(ptr, n)
+
+#define ALWAYS_INLINE     __attribute__((always_inline)) inline
+
+/* }}} */
+/* pwqr wrapping {{{ */
+
+static int pwqr_create(void)
+{
+    return open("/dev/"PWQR_DEVICE_NAME, O_RDWR);
+}
+
+static int pwqr_ctl(int fd, int op, int val, void *uaddr)
+{
+    struct pwqr_ioc_wait wait;
+
+    switch (op) {
+      case PWQR_GET_CONC:
+      case PWQR_REGISTER:
+      case PWQR_UNREGISTER:
+      case PWQR_PARK:
+        return ioctl(fd, op);
+      case PWQR_SET_CONC:
+      case PWQR_WAKE:
+      case PWQR_WAKE_OC:
+        return ioctl(fd, op, val);
+      case PWQR_WAIT:
+        wait.pwqr_ticket = val;
+        wait.pwqr_uaddr  = uaddr;
+        return ioctl(fd, op, &wait);
+      default:
+        errno = EINVAL;
+        return -1;
+    }
+}
+
+/* }}} */
+
+static struct {
+    int fd;
+    /* atomic */ int spinlock;
+    /* atomic */ int nthreads;
+    /* atomic */ int waiters;
+    /* atomic */ int parked;
+
+    union {
+        struct {
+#if __BYTE_ORDER == __LITTLE_ENDIAN
+            /* atomic */ uint32_t lo;
+            /* atomic */ uint32_t hi;
+#elif __BYTE_ORDER == __BIG_ENDIAN
+            /* atomic */ uint32_t hi;
+            /* atomic */ uint32_t lo;
+#else
+#error  Unsupported endianness
+#endif
+        };
+        uint64_t ticket;
+    };
+} pwqr_g = {
+    .fd = -1,
+};
+
+static ALWAYS_INLINE void pwqr_lock(void)
+{
+    while (unlikely(__sync_lock_test_and_set(&pwqr_g.spinlock, 1)))
+        sched_yield();
+}
+
+static ALWAYS_INLINE void pwqr_unlock(void)
+{
+    __sync_lock_release(&pwqr_g.spinlock);
+}
+
+static ALWAYS_INLINE uint64_t pwqr_get_ticket(void)
+{
+    mb();
+    return access_once(pwqr_g.ticket);
+}
+
+static ALWAYS_INLINE void pwqr_signal_n(int n)
+{
+#if ULONG_MAX == UINT32_MAX
+    /*
+     * We don't know how slow things are between a pwqr_get() and a
+     * pwqr_wait. Hence it's not safe to assume the "count" will never
+     * rotate fully between the two.
+     *
+     * In 64bits mode, well, we have 64-bits atomic increments and all is
+     * fine. In 32bits mode, we increment the high word manually every 2^24
+     * low-word increment.
+     *
+     * This assumes that at least one of the 256 threads that will try to
+     * perform the "hi" increment won't be stalled between deciding the modulo
+     * is zero and the increment itself for an almost full cycle (2^32 - 2^24)
+     * of the low word counter.
+     */
+    if (unlikely(atomic_fetch_and_add(&pwqr_g.lo, 1) % (1U << 24) == 0))
+        atomic_add(&pwqr_g.hi, 1);
+#else
+    atomic_add(&pwqr_g.ticket, 1);
+#endif
+    if (atomic_fetch_and_add(&pwqr_g.waiters, 0))
+        pwqr_ctl(pwqr_g.fd, PWQR_WAKE, n, NULL);
+}
+static ALWAYS_INLINE void pwqr_signal(void)
+{
+    pwqr_signal_n(1);
+}
+
+static ALWAYS_INLINE void pwqr_signal_relaxed_n(int n)
+{
+    if (access_once(pwqr_g.waiters))
+        pwqr_signal_n(n);
+}
+static ALWAYS_INLINE void pwqr_signal_relaxed(void)
+{
+    pwqr_signal_relaxed_n(1);
+}
+
+
+/* returns:
+   - INPOOL if we were woken to run jobs.
+   - PARKED if we were woken to be parked (possibly consume overcommit stuff)
+ */
+static void pwqr_do_wait_cleanup(void *arg)
+{
+    atomic_sub(&pwqr_g.waiters, 1);
+}
+static int pwqr_do_wait(uint64_t ticket)
+{
+    int canceltype, rc;
+
+    mb();
+#if ULONG_MAX == UINT32_MAX
+    if ((unsigned)(ticket >> 32) != access_once(pwqr_g.hi))
+        return INPOOL;
+#else
+    if (ticket != access_once(pwqr_g.ticket))
+        return INPOOL;
+#endif
+
+    atomic_add(&pwqr_g.waiters, 1);
+    pthread_cleanup_push(&pwqr_do_wait_cleanup, NULL);
+    pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS, &canceltype);
+
+    rc = pwqr_ctl(pwqr_g.fd, PWQR_WAIT, ticket, &pwqr_g.lo);
+    if (rc < 0) {
+        if (errno == EINTR) {
+            rc = INPOOL;
+        } else if (errno == EDQUOT) {
+            rc = PARKED;
+        } else {
+            assert (errno == EBADFD);
+        }
+    }
+
+    pthread_setcanceltype(canceltype, NULL);
+    pthread_cleanup_pop(1);
+}
+
+/* returns INPOOL if the thread is to run some jobs or go to WAIT
+ * returns -1 if the pwqr_g.fd is broken
+ */
+static void pwqr_do_park_cleanup(void *arg)
+{
+    atomic_sub(&pwqr_g.parked, 1);
+}
+static void pwqr_spawn_thread(int initial_state, int count);
+static int pwqr_do_park(void)
+{
+    int canceltype, rc = -1;
+
+    if (atomic_fetch_and_add(&pwqr_g.parked, 1) > PARKED_MAX) {
+        atomic_sub(&pwqr_g.parked, 1);
+        return -1;
+    }
+
+    pthread_cleanup_push(&pwqr_do_park_cleanup, NULL);
+    pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS, &canceltype);
+
+    for (;;) {
+#ifdef PSEUDO_CODE
+        while ((job = find_some_job(OC_JOB)))
+            run_job(job);
+#endif
+
+        if ((rc = pwqr_ctl(pwqr_g.fd, PWQR_PARK, 0, NULL)) == 0) {
+            if (atomic_fetch_and_sub(&pwqr_g.parked, 1) == 0) {
+                pwqr_spawn_thread(PARKED, 1);
+            }
+            break;
+        }
+
+        if (rc < 0) {
+            if (errno == EBADFD) {
+                atomic_sub(&pwqr_g.parked, 1);
+                return -1;
+            }
+            assert (errno == EINTR || errno == EDQUOT);
+            continue;
+        }
+    }
+
+    pthread_setcanceltype(canceltype, NULL);
+    pthread_cleanup_pop(0);
+    return rc;
+}
+
+static void pwqr_main_cleanup(void *arg)
+{
+    atomic_sub(&pwqr_g.nthreads, 1);
+}
+static void *pwqr_main(void *arg)
+{
+    int state = (long)arg;
+
+    if (atomic_fetch_and_add(&pwqr_g.nthreads, 1) > THREADS_MAX)
+        goto out;
+
+    pthread_cleanup_push(&pwqr_main_cleanup, NULL);
+    if (pwqr_ctl(pwqr_g.fd, PWQR_REGISTER, 0, NULL) < 0)
+        goto out;
+
+    do {
+        uint64_t ticket;
+
+        if (state == PARKED && (state = pwqr_do_park()) < 0)
+            break;
+#ifdef PSEUDO_CODE
+        while ((job = find_some_job(ANY_JOB)))
+            run_job(job);
+#endif
+        ticket = pwqr_get_ticket();
+#ifdef PSEUDO_CODE
+        if ((job = find_some_job(ANY_JOB))) {
+            run_job(job);
+            continue;
+        }
+#endif
+        state = pwqr_do_wait(ticket);
+    } while (state >= 0);
+
+  out:
+    pthread_cleanup_pop(1);
+    return NULL;
+}
+
+static void pwqr_spawn_thread(int initial_state, int count)
+{
+    pthread_t thr;
+    pthread_attr_t attr;
+
+    pthread_attr_init(&attr);
+    pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
+    while (count-- > 0)
+        pthread_create(&thr, &attr, pwqr_main, (void *)(long)initial_state);
+    pthread_attr_destroy(&attr);
+}
+
+__attribute__((cold, noinline, unused))
+static int _pthread_workqueue_init_np(void)
+{
+    int rc = 0, fd, n;
+
+    pwqr_lock();
+    if (pwqr_g.fd >= 0)
+        goto out;
+
+    fd = pwqr_create();
+    if (fd < 0) {
+        rc = -1;
+        goto out;
+    }
+
+    pwqr_g.fd = fd;
+    n = pwqr_ctl(pwqr_g.fd, PWQR_GET_CONC, 0, NULL) + 4;
+    pwqr_spawn_thread(INPOOL, n);
+    pwqr_spawn_thread(PARKED, 4);
+
+  out:
+    pwqr_unlock();
+    return rc;
+}