include/linux/fence.h

   1 /*
   2  * Fence mechanism for dma-buf to allow for asynchronous dma access
   3  *
   4  * Copyright (C) 2012 Canonical Ltd
   5  * Copyright (C) 2012 Texas Instruments
   6  *
   7  * Authors:
   8  * Rob Clark <robdclark@gmail.com>
   9  * Maarten Lankhorst <maarten.lankhorst@canonical.com>
  10  *
  11  * This program is free software; you can redistribute it and/or modify it
  12  * under the terms of the GNU General Public License version 2 as published by
  13  * the Free Software Foundation.
  14  *
  15  * This program is distributed in the hope that it will be useful, but WITHOUT
  16  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  17  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  18  * more details.
  19  */
  20
  21 #ifndef __LINUX_FENCE_H
  22 #define __LINUX_FENCE_H
  23
  24 #include <linux/err.h>
  25 #include <linux/wait.h>
  26 #include <linux/list.h>
  27 #include <linux/bitops.h>
  28 #include <linux/kref.h>
  29 #include <linux/sched.h>
  30 #include <linux/printk.h>
  31 #include <linux/rcupdate.h>
  32
  33 struct fence;
  34 struct fence_ops;
  35 struct fence_cb;
  36
  37 /**
  38  * struct fence - software synchronization primitive
  39  * @refcount: refcount for this fence
  40  * @ops: fence_ops associated with this fence
  41  * @rcu: used for releasing fence with kfree_rcu
  42  * @cb_list: list of all callbacks to call
  43  * @lock: spin_lock_irqsave used for locking
  44  * @context: execution context this fence belongs to, returned by
  45  *           fence_context_alloc()
  46  * @seqno: the sequence number of this fence inside the execution context,
  47  * can be compared to decide which fence would be signaled later.
  48  * @flags: A mask of FENCE_FLAG_* defined below
  49  * @timestamp: Timestamp when the fence was signaled.
  50  * @status: Optional, only valid if < 0, must be set before calling
  51  * fence_signal, indicates that the fence has completed with an error.
  52  * @child_list: list of children fences
  53  * @active_list: list of active fences
  54  *
  55  * the flags member must be manipulated and read using the appropriate
  56  * atomic ops (bit_*), so taking the spinlock will not be needed most
  57  * of the time.
  58  *
  59  * FENCE_FLAG_SIGNALED_BIT - fence is already signaled
  60  * FENCE_FLAG_ENABLE_SIGNAL_BIT - enable_signaling might have been called*
  61  * FENCE_FLAG_USER_BITS - start of the unused bits, can be used by the
  62  * implementer of the fence for its own purposes. Can be used in different
  63  * ways by different fence implementers, so do not rely on this.
  64  *
  65  * *) Since atomic bitops are used, this is not guaranteed to be the case.
  66  * Particularly, if the bit was set, but fence_signal was called right
  67  * before this bit was set, it would have been able to set the
  68  * FENCE_FLAG_SIGNALED_BIT, before enable_signaling was called.
  69  * Adding a check for FENCE_FLAG_SIGNALED_BIT after setting
  70  * FENCE_FLAG_ENABLE_SIGNAL_BIT closes this race, and makes sure that
  71  * after fence_signal was called, any enable_signaling call will have either
  72  * been completed, or never called at all.
  73  */
  74 struct fence {
  75         struct kref refcount;
  76         const struct fence_ops *ops;
  77         struct rcu_head rcu;
  78         struct list_head cb_list;
  79         spinlock_t *lock;
  80         unsigned context, seqno;
  81         unsigned long flags;
  82         ktime_t timestamp;
  83         int status;
  84         struct list_head child_list;
  85         struct list_head active_list;
  86 };
  87
  88 enum fence_flag_bits {
  89         FENCE_FLAG_SIGNALED_BIT,
  90         FENCE_FLAG_ENABLE_SIGNAL_BIT,
  91         FENCE_FLAG_USER_BITS, /* must always be last member */
  92 };
  93
  94 typedef void (*fence_func_t)(struct fence *fence, struct fence_cb *cb);
  95
  96 /**
  97  * struct fence_cb - callback for fence_add_callback
  98  * @node: used by fence_add_callback to append this struct to fence::cb_list
  99  * @func: fence_func_t to call
 100  *
 101  * This struct will be initialized by fence_add_callback, additional
 102  * data can be passed along by embedding fence_cb in another struct.
 103  */
 104 struct fence_cb {
 105         struct list_head node;
 106         fence_func_t func;
 107 };
 108
 109 /**
 110  * struct fence_ops - operations implemented for fence
 111  * @get_driver_name: returns the driver name.
 112  * @get_timeline_name: return the name of the context this fence belongs to.
 113  * @enable_signaling: enable software signaling of fence.
 114  * @signaled: [optional] peek whether the fence is signaled, can be null.
 115  * @wait: custom wait implementation, or fence_default_wait.
 116  * @release: [optional] called on destruction of fence, can be null
 117  * @fill_driver_data: [optional] callback to fill in free-form debug info
 118  * Returns amount of bytes filled, or -errno.
 119  * @fence_value_str: [optional] fills in the value of the fence as a string
 120  * @timeline_value_str: [optional] fills in the current value of the timeline
 121  * as a string
 122  *
 123  * Notes on enable_signaling:
 124  * For fence implementations that have the capability for hw->hw
 125  * signaling, they can implement this op to enable the necessary
 126  * irqs, or insert commands into cmdstream, etc.  This is called
 127  * in the first wait() or add_callback() path to let the fence
 128  * implementation know that there is another driver waiting on
 129  * the signal (ie. hw->sw case).
 130  *
 131  * This function can be called called from atomic context, but not
 132  * from irq context, so normal spinlocks can be used.
 133  *
 134  * A return value of false indicates the fence already passed,
 135  * or some failure occurred that made it impossible to enable
 136  * signaling. True indicates successful enabling.
 137  *
 138  * fence->status may be set in enable_signaling, but only when false is
 139  * returned.
 140  *
 141  * Calling fence_signal before enable_signaling is called allows
 142  * for a tiny race window in which enable_signaling is called during,
 143  * before, or after fence_signal. To fight this, it is recommended
 144  * that before enable_signaling returns true an extra reference is
 145  * taken on the fence, to be released when the fence is signaled.
 146  * This will mean fence_signal will still be called twice, but
 147  * the second time will be a noop since it was already signaled.
 148  *
 149  * Notes on signaled:
 150  * May set fence->status if returning true.
 151  *
 152  * Notes on wait:
 153  * Must not be NULL, set to fence_default_wait for default implementation.
 154  * the fence_default_wait implementation should work for any fence, as long
 155  * as enable_signaling works correctly.
 156  *
 157  * Must return -ERESTARTSYS if the wait is intr = true and the wait was
 158  * interrupted, and remaining jiffies if fence has signaled, or 0 if wait
 159  * timed out. Can also return other error values on custom implementations,
 160  * which should be treated as if the fence is signaled. For example a hardware
 161  * lockup could be reported like that.
 162  *
 163  * Notes on release:
 164  * Can be NULL, this function allows additional commands to run on
 165  * destruction of the fence. Can be called from irq context.
 166  * If pointer is set to NULL, kfree will get called instead.
 167  */
 168
 169 struct fence_ops {
 170         const char * (*get_driver_name)(struct fence *fence);
 171         const char * (*get_timeline_name)(struct fence *fence);
 172         bool (*enable_signaling)(struct fence *fence);
 173         bool (*signaled)(struct fence *fence);
 174         signed long (*wait)(struct fence *fence, bool intr, signed long timeout);
 175         void (*release)(struct fence *fence);
 176
 177         int (*fill_driver_data)(struct fence *fence, void *data, int size);
 178         void (*fence_value_str)(struct fence *fence, char *str, int size);
 179         void (*timeline_value_str)(struct fence *fence, char *str, int size);
 180 };
 181
 182 void fence_init(struct fence *fence, const struct fence_ops *ops,
 183                 spinlock_t *lock, unsigned context, unsigned seqno);
 184
 185 void fence_release(struct kref *kref);
 186 void fence_free(struct fence *fence);
 187
 188 /**
 189  * fence_get - increases refcount of the fence
 190  * @fence:      [in]    fence to increase refcount of
 191  *
 192  * Returns the same fence, with refcount increased by 1.
 193  */
 194 static inline struct fence *fence_get(struct fence *fence)
 195 {
 196         if (fence)
 197                 kref_get(&fence->refcount);
 198         return fence;
 199 }
 200
 201 /**
 202  * fence_get_rcu - get a fence from a reservation_object_list with rcu read lock
 203  * @fence:      [in]    fence to increase refcount of
 204  *
 205  * Function returns NULL if no refcount could be obtained, or the fence.
 206  */
 207 static inline struct fence *fence_get_rcu(struct fence *fence)
 208 {
 209         if (kref_get_unless_zero(&fence->refcount))
 210                 return fence;
 211         else
 212                 return NULL;
 213 }
 214
 215 /**
 216  * fence_put - decreases refcount of the fence
 217  * @fence:      [in]    fence to reduce refcount of
 218  */
 219 static inline void fence_put(struct fence *fence)
 220 {
 221         if (fence)
 222                 kref_put(&fence->refcount, fence_release);
 223 }
 224
 225 int fence_signal(struct fence *fence);
 226 int fence_signal_locked(struct fence *fence);
 227 signed long fence_default_wait(struct fence *fence, bool intr, signed long timeout);
 228 int fence_add_callback(struct fence *fence, struct fence_cb *cb,
 229                        fence_func_t func);
 230 bool fence_remove_callback(struct fence *fence, struct fence_cb *cb);
 231 void fence_enable_sw_signaling(struct fence *fence);
 232
 233 /**
 234  * fence_is_signaled_locked - Return an indication if the fence is signaled yet.
 235  * @fence:      [in]    the fence to check
 236  *
 237  * Returns true if the fence was already signaled, false if not. Since this
 238  * function doesn't enable signaling, it is not guaranteed to ever return
 239  * true if fence_add_callback, fence_wait or fence_enable_sw_signaling
 240  * haven't been called before.
 241  *
 242  * This function requires fence->lock to be held.
 243  */
 244 static inline bool
 245 fence_is_signaled_locked(struct fence *fence)
 246 {
 247         if (test_bit(FENCE_FLAG_SIGNALED_BIT, &fence->flags))
 248                 return true;
 249
 250         if (fence->ops->signaled && fence->ops->signaled(fence)) {
 251                 fence_signal_locked(fence);
 252                 return true;
 253         }
 254
 255         return false;
 256 }
 257
 258 /**
 259  * fence_is_signaled - Return an indication if the fence is signaled yet.
 260  * @fence:      [in]    the fence to check
 261  *
 262  * Returns true if the fence was already signaled, false if not. Since this
 263  * function doesn't enable signaling, it is not guaranteed to ever return
 264  * true if fence_add_callback, fence_wait or fence_enable_sw_signaling
 265  * haven't been called before.
 266  *
 267  * It's recommended for seqno fences to call fence_signal when the
 268  * operation is complete, it makes it possible to prevent issues from
 269  * wraparound between time of issue and time of use by checking the return
 270  * value of this function before calling hardware-specific wait instructions.
 271  */
 272 static inline bool
 273 fence_is_signaled(struct fence *fence)
 274 {
 275         if (test_bit(FENCE_FLAG_SIGNALED_BIT, &fence->flags))
 276                 return true;
 277
 278         if (fence->ops->signaled && fence->ops->signaled(fence)) {
 279                 fence_signal(fence);
 280                 return true;
 281         }
 282
 283         return false;
 284 }
 285
 286 /**
 287  * fence_is_later - return if f1 is chronologically later than f2
 288  * @f1: [in]    the first fence from the same context
 289  * @f2: [in]    the second fence from the same context
 290  *
 291  * Returns true if f1 is chronologically later than f2. Both fences must be
 292  * from the same context, since a seqno is not re-used across contexts.
 293  */
 294 static inline bool fence_is_later(struct fence *f1, struct fence *f2)
 295 {
 296         if (WARN_ON(f1->context != f2->context))
 297                 return false;
 298
 299         return (int)(f1->seqno - f2->seqno) > 0;
 300 }
 301
 302 /**
 303  * fence_later - return the chronologically later fence
 304  * @f1: [in]    the first fence from the same context
 305  * @f2: [in]    the second fence from the same context
 306  *
 307  * Returns NULL if both fences are signaled, otherwise the fence that would be
 308  * signaled last. Both fences must be from the same context, since a seqno is
 309  * not re-used across contexts.
 310  */
 311 static inline struct fence *fence_later(struct fence *f1, struct fence *f2)
 312 {
 313         if (WARN_ON(f1->context != f2->context))
 314                 return NULL;
 315
 316         /*
 317          * can't check just FENCE_FLAG_SIGNALED_BIT here, it may never have been
 318          * set if enable_signaling wasn't called, and enabling that here is
 319          * overkill.
 320          */
 321         if (fence_is_later(f1, f2))
 322                 return fence_is_signaled(f1) ? NULL : f1;
 323         else
 324                 return fence_is_signaled(f2) ? NULL : f2;
 325 }
 326
 327 signed long fence_wait_timeout(struct fence *, bool intr, signed long timeout);
 328 signed long fence_wait_any_timeout(struct fence **fences, uint32_t count,
 329                                    bool intr, signed long timeout);
 330
 331 /**
 332  * fence_wait - sleep until the fence gets signaled
 333  * @fence:      [in]    the fence to wait on
 334  * @intr:       [in]    if true, do an interruptible wait
 335  *
 336  * This function will return -ERESTARTSYS if interrupted by a signal,
 337  * or 0 if the fence was signaled. Other error values may be
 338  * returned on custom implementations.
 339  *
 340  * Performs a synchronous wait on this fence. It is assumed the caller
 341  * directly or indirectly holds a reference to the fence, otherwise the
 342  * fence might be freed before return, resulting in undefined behavior.
 343  */
 344 static inline signed long fence_wait(struct fence *fence, bool intr)
 345 {
 346         signed long ret;
 347
 348         /* Since fence_wait_timeout cannot timeout with
 349          * MAX_SCHEDULE_TIMEOUT, only valid return values are
 350          * -ERESTARTSYS and MAX_SCHEDULE_TIMEOUT.
 351          */
 352         ret = fence_wait_timeout(fence, intr, MAX_SCHEDULE_TIMEOUT);
 353
 354         return ret < 0 ? ret : 0;
 355 }
 356
 357 unsigned fence_context_alloc(unsigned num);
 358
 359 #define FENCE_TRACE(f, fmt, args...) \
 360         do {                                                            \
 361                 struct fence *__ff = (f);                               \
 362                 if (config_enabled(CONFIG_FENCE_TRACE))                 \
 363                         pr_info("f %u#%u: " fmt,                        \
 364                                 __ff->context, __ff->seqno, ##args);    \
 365         } while (0)
 366
 367 #define FENCE_WARN(f, fmt, args...) \
 368         do {                                                            \
 369                 struct fence *__ff = (f);                               \
 370                 pr_warn("f %u#%u: " fmt, __ff->context, __ff->seqno,    \
 371                          ##args);                                       \
 372         } while (0)
 373
 374 #define FENCE_ERR(f, fmt, args...) \
 375         do {                                                            \
 376                 struct fence *__ff = (f);                               \
 377                 pr_err("f %u#%u: " fmt, __ff->context, __ff->seqno,     \
 378                         ##args);                                        \
 379         } while (0)
 380
 381 #endif /* __LINUX_FENCE_H */