fs/btrfs/async-thread.h

   1 /*
   2  * Copyright (C) 2007 Oracle.  All rights reserved.
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public
   6  * License v2 as published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11  * General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public
  14  * License along with this program; if not, write to the
  15  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  16  * Boston, MA 021110-1307, USA.
  17  */
  18
  19 #ifndef __BTRFS_ASYNC_THREAD_
  20 #define __BTRFS_ASYNC_THREAD_
  21
  22 struct btrfs_worker_thread;
  23
  24 /*
  25  * This is similar to a workqueue, but it is meant to spread the operations
  26  * across all available cpus instead of just the CPU that was used to
  27  * queue the work.  There is also some batching introduced to try and
  28  * cut down on context switches.
  29  *
  30  * By default threads are added on demand up to 2 * the number of cpus.
  31  * Changing struct btrfs_workers->max_workers is one way to prevent
  32  * demand creation of kthreads.
  33  *
  34  * the basic model of these worker threads is to embed a btrfs_work
  35  * structure in your own data struct, and use container_of in a
  36  * work function to get back to your data struct.
  37  */
  38 struct btrfs_work {
  39         /*
  40          * func should be set to the function you want called
  41          * your work struct is passed as the only arg
  42          *
  43          * ordered_func must be set for work sent to an ordered work queue,
  44          * and it is called to complete a given work item in the same
  45          * order they were sent to the queue.
  46          */
  47         void (*func)(struct btrfs_work *work);
  48         void (*ordered_func)(struct btrfs_work *work);
  49         void (*ordered_free)(struct btrfs_work *work);
  50
  51         /*
  52          * flags should be set to zero.  It is used to make sure the
  53          * struct is only inserted once into the list.
  54          */
  55         unsigned long flags;
  56
  57         /* don't touch these */
  58         struct btrfs_worker_thread *worker;
  59         struct list_head list;
  60         struct list_head order_list;
  61 };
  62
  63 struct btrfs_workers {
  64         /* current number of running workers */
  65         int num_workers;
  66
  67         /* max number of workers allowed.  changed by btrfs_start_workers */
  68         int max_workers;
  69
  70         /* once a worker has this many requests or fewer, it is idle */
  71         int idle_thresh;
  72
  73         /* force completions in the order they were queued */
  74         int ordered;
  75
  76         /* list with all the work threads.  The workers on the idle thread
  77          * may be actively servicing jobs, but they haven't yet hit the
  78          * idle thresh limit above.
  79          */
  80         struct list_head worker_list;
  81         struct list_head idle_list;
  82
  83         /*
  84          * when operating in ordered mode, this maintains the list
  85          * of work items waiting for completion
  86          */
  87         struct list_head order_list;
  88
  89         /* lock for finding the next worker thread to queue on */
  90         spinlock_t lock;
  91
  92         /* extra name for this worker, used for current->name */
  93         char *name;
  94 };
  95
  96 int btrfs_queue_worker(struct btrfs_workers *workers, struct btrfs_work *work);
  97 int btrfs_start_workers(struct btrfs_workers *workers, int num_workers);
  98 int btrfs_stop_workers(struct btrfs_workers *workers);
  99 void btrfs_init_workers(struct btrfs_workers *workers, char *name, int max);
 100 int btrfs_requeue_work(struct btrfs_work *work);
 101 #endif