drivers/misc/sgi-gru/grutables.h

   1 /*
   2  * SN Platform GRU Driver
   3  *
   4  *            GRU DRIVER TABLES, MACROS, externs, etc
   5  *
   6  *  Copyright (c) 2008 Silicon Graphics, Inc.  All Rights Reserved.
   7  *
   8  *  This program is free software; you can redistribute it and/or modify
   9  *  it under the terms of the GNU General Public License as published by
  10  *  the Free Software Foundation; either version 2 of the License, or
  11  *  (at your option) any later version.
  12  *
  13  *  This program is distributed in the hope that it will be useful,
  14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *  GNU General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU General Public License
  19  *  along with this program; if not, write to the Free Software
  20  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  21  */
  22
  23 #ifndef __GRUTABLES_H__
  24 #define __GRUTABLES_H__
  25
  26 /*
  27  * GRU Chiplet:
  28  *   The GRU is a user addressible memory accelerator. It provides
  29  *   several forms of load, store, memset, bcopy instructions. In addition, it
  30  *   contains special instructions for AMOs, sending messages to message
  31  *   queues, etc.
  32  *
  33  *   The GRU is an integral part of the node controller. It connects
  34  *   directly to the cpu socket. In its current implementation, there are 2
  35  *   GRU chiplets in the node controller on each blade (~node).
  36  *
  37  *   The entire GRU memory space is fully coherent and cacheable by the cpus.
  38  *
  39  *   Each GRU chiplet has a physical memory map that looks like the following:
  40  *
  41  *      +-----------------+
  42  *      |/////////////////|
  43  *      |/////////////////|
  44  *      |/////////////////|
  45  *      |/////////////////|
  46  *      |/////////////////|
  47  *      |/////////////////|
  48  *      |/////////////////|
  49  *      |/////////////////|
  50  *      +-----------------+
  51  *      |  system control |
  52  *      +-----------------+        _______ +-------------+
  53  *      |/////////////////|       /        |             |
  54  *      |/////////////////|      /         |             |
  55  *      |/////////////////|     /          | instructions|
  56  *      |/////////////////|    /           |             |
  57  *      |/////////////////|   /            |             |
  58  *      |/////////////////|  /             |-------------|
  59  *      |/////////////////| /              |             |
  60  *      +-----------------+                |             |
  61  *      |   context 15    |                |  data       |
  62  *      +-----------------+                |             |
  63  *      |    ......       | \              |             |
  64  *      +-----------------+  \____________ +-------------+
  65  *      |   context 1     |
  66  *      +-----------------+
  67  *      |   context 0     |
  68  *      +-----------------+
  69  *
  70  *   Each of the "contexts" is a chunk of memory that can be mmaped into user
  71  *   space. The context consists of 2 parts:
  72  *
  73  *      - an instruction space that can be directly accessed by the user
  74  *        to issue GRU instructions and to check instruction status.
  75  *
  76  *      - a data area that acts as normal RAM.
  77  *
  78  *   User instructions contain virtual addresses of data to be accessed by the
  79  *   GRU. The GRU contains a TLB that is used to convert these user virtual
  80  *   addresses to physical addresses.
  81  *
  82  *   The "system control" area of the GRU chiplet is used by the kernel driver
  83  *   to manage user contexts and to perform functions such as TLB dropin and
  84  *   purging.
  85  *
  86  *   One context may be reserved for the kernel and used for cross-partition
  87  *   communication. The GRU will also be used to asynchronously zero out
  88  *   large blocks of memory (not currently implemented).
  89  *
  90  *
  91  * Tables:
  92  *
  93  *      VDATA-VMA Data          - Holds a few parameters. Head of linked list of
  94  *                                GTS tables for threads using the GSEG
  95  *      GTS - Gru Thread State  - contains info for managing a GSEG context. A
  96  *                                GTS is allocated for each thread accessing a
  97  *                                GSEG.
  98  *      GTD - GRU Thread Data   - contains shadow copy of GRU data when GSEG is
  99  *                                not loaded into a GRU
 100  *      GMS - GRU Memory Struct - Used to manage TLB shootdowns. Tracks GRUs
 101  *                                where a GSEG has been loaded. Similar to
 102  *                                an mm_struct but for GRU.
 103  *
 104  *      GS  - GRU State         - Used to manage the state of a GRU chiplet
 105  *      BS  - Blade State       - Used to manage state of all GRU chiplets
 106  *                                on a blade
 107  *
 108  *
 109  *  Normal task tables for task using GRU.
 110  *              - 2 threads in process
 111  *              - 2 GSEGs open in process
 112  *              - GSEG1 is being used by both threads
 113  *              - GSEG2 is used only by thread 2
 114  *
 115  *       task -->|
 116  *       task ---+---> mm ->------ (notifier) -------+-> gms
 117  *                     |                             |
 118  *                     |--> vma -> vdata ---> gts--->|          GSEG1 (thread1)
 119  *                     |                  |          |
 120  *                     |                  +-> gts--->|          GSEG1 (thread2)
 121  *                     |                             |
 122  *                     |--> vma -> vdata ---> gts--->|          GSEG2 (thread2)
 123  *                     .
 124  *                     .
 125  *
 126  *  GSEGs are marked DONTCOPY on fork
 127  *
 128  * At open
 129  *      file.private_data -> NULL
 130  *
 131  * At mmap,
 132  *      vma -> vdata
 133  *
 134  * After gseg reference
 135  *      vma -> vdata ->gts
 136  *
 137  * After fork
 138  *   parent
 139  *      vma -> vdata -> gts
 140  *   child
 141  *      (vma is not copied)
 142  *
 143  */
 144
 145 #include <linux/rmap.h>
 146 #include <linux/interrupt.h>
 147 #include <linux/mutex.h>
 148 #include <linux/wait.h>
 149 #include <linux/mmu_notifier.h>
 150 #include "gru.h"
 151 #include "gruhandles.h"
 152
 153 extern struct gru_stats_s gru_stats;
 154 extern struct gru_blade_state *gru_base[];
 155 extern unsigned long gru_start_paddr, gru_end_paddr;
 156 extern unsigned int gru_max_gids;
 157
 158 #define GRU_MAX_BLADES          MAX_NUMNODES
 159 #define GRU_MAX_GRUS            (GRU_MAX_BLADES * GRU_CHIPLETS_PER_BLADE)
 160
 161 #define GRU_DRIVER_ID_STR       "SGI GRU Device Driver"
 162 #define GRU_DRIVER_VERSION_STR  "0.80"
 163
 164 /*
 165  * GRU statistics.
 166  */
 167 struct gru_stats_s {
 168         atomic_long_t vdata_alloc;
 169         atomic_long_t vdata_free;
 170         atomic_long_t gts_alloc;
 171         atomic_long_t gts_free;
 172         atomic_long_t vdata_double_alloc;
 173         atomic_long_t gts_double_allocate;
 174         atomic_long_t assign_context;
 175         atomic_long_t assign_context_failed;
 176         atomic_long_t free_context;
 177         atomic_long_t load_context;
 178         atomic_long_t unload_context;
 179         atomic_long_t steal_context;
 180         atomic_long_t steal_context_failed;
 181         atomic_long_t nopfn;
 182         atomic_long_t break_cow;
 183         atomic_long_t asid_new;
 184         atomic_long_t asid_next;
 185         atomic_long_t asid_wrap;
 186         atomic_long_t asid_reuse;
 187         atomic_long_t intr;
 188         atomic_long_t intr_mm_lock_failed;
 189         atomic_long_t call_os;
 190         atomic_long_t call_os_offnode_reference;
 191         atomic_long_t call_os_check_for_bug;
 192         atomic_long_t call_os_wait_queue;
 193         atomic_long_t user_flush_tlb;
 194         atomic_long_t user_unload_context;
 195         atomic_long_t user_exception;
 196         atomic_long_t set_task_slice;
 197         atomic_long_t migrate_check;
 198         atomic_long_t migrated_retarget;
 199         atomic_long_t migrated_unload;
 200         atomic_long_t migrated_unload_delay;
 201         atomic_long_t migrated_nopfn_retarget;
 202         atomic_long_t migrated_nopfn_unload;
 203         atomic_long_t tlb_dropin;
 204         atomic_long_t tlb_dropin_fail_no_asid;
 205         atomic_long_t tlb_dropin_fail_upm;
 206         atomic_long_t tlb_dropin_fail_invalid;
 207         atomic_long_t tlb_dropin_fail_range_active;
 208         atomic_long_t tlb_dropin_fail_idle;
 209         atomic_long_t tlb_dropin_fail_fmm;
 210         atomic_long_t tlb_dropin_fail_no_exception;
 211         atomic_long_t tlb_dropin_fail_no_exception_war;
 212         atomic_long_t mmu_invalidate_range;
 213         atomic_long_t mmu_invalidate_page;
 214         atomic_long_t mmu_clear_flush_young;
 215         atomic_long_t flush_tlb;
 216         atomic_long_t flush_tlb_gru;
 217         atomic_long_t flush_tlb_gru_tgh;
 218         atomic_long_t flush_tlb_gru_zero_asid;
 219
 220         atomic_long_t copy_gpa;
 221
 222         atomic_long_t mesq_receive;
 223         atomic_long_t mesq_receive_none;
 224         atomic_long_t mesq_send;
 225         atomic_long_t mesq_send_failed;
 226         atomic_long_t mesq_noop;
 227         atomic_long_t mesq_send_unexpected_error;
 228         atomic_long_t mesq_send_lb_overflow;
 229         atomic_long_t mesq_send_qlimit_reached;
 230         atomic_long_t mesq_send_amo_nacked;
 231         atomic_long_t mesq_send_put_nacked;
 232         atomic_long_t mesq_qf_not_full;
 233         atomic_long_t mesq_qf_locked;
 234         atomic_long_t mesq_qf_noop_not_full;
 235         atomic_long_t mesq_qf_switch_head_failed;
 236         atomic_long_t mesq_qf_unexpected_error;
 237         atomic_long_t mesq_noop_unexpected_error;
 238         atomic_long_t mesq_noop_lb_overflow;
 239         atomic_long_t mesq_noop_qlimit_reached;
 240         atomic_long_t mesq_noop_amo_nacked;
 241         atomic_long_t mesq_noop_put_nacked;
 242
 243 };
 244
 245 enum mcs_op {cchop_allocate, cchop_start, cchop_interrupt, cchop_interrupt_sync,
 246         cchop_deallocate, tghop_invalidate, mcsop_last};
 247
 248 struct mcs_op_statistic {
 249         atomic_long_t   count;
 250         atomic_long_t   total;
 251         unsigned long   max;
 252 };
 253
 254 extern struct mcs_op_statistic mcs_op_statistics[mcsop_last];
 255
 256 #define OPT_DPRINT      1
 257 #define OPT_STATS       2
 258 #define GRU_QUICKLOOK   4
 259
 260
 261 #define IRQ_GRU                 110     /* Starting IRQ number for interrupts */
 262
 263 /* Delay in jiffies between attempts to assign a GRU context */
 264 #define GRU_ASSIGN_DELAY        ((HZ * 20) / 1000)
 265
 266 /*
 267  * If a process has it's context stolen, min delay in jiffies before trying to
 268  * steal a context from another process.
 269  */
 270 #define GRU_STEAL_DELAY         ((HZ * 200) / 1000)
 271
 272 #define STAT(id)        do {                                            \
 273                                 if (gru_options & OPT_STATS)            \
 274                                         atomic_long_inc(&gru_stats.id); \
 275                         } while (0)
 276
 277 #ifdef CONFIG_SGI_GRU_DEBUG
 278 #define gru_dbg(dev, fmt, x...)                                         \
 279         do {                                                            \
 280                 if (gru_options & OPT_DPRINT)                           \
 281                         dev_dbg(dev, "%s: " fmt, __func__, x);          \
 282         } while (0)
 283 #else
 284 #define gru_dbg(x...)
 285 #endif
 286
 287 /*-----------------------------------------------------------------------------
 288  * ASID management
 289  */
 290 #define MAX_ASID        0xfffff0
 291 #define MIN_ASID        8
 292 #define ASID_INC        8       /* number of regions */
 293
 294 /* Generate a GRU asid value from a GRU base asid & a virtual address. */
 295 #if defined CONFIG_IA64
 296 #define VADDR_HI_BIT            64
 297 #elif defined CONFIG_X86_64
 298 #define VADDR_HI_BIT            48
 299 #else
 300 #error "Unsupported architecture"
 301 #endif
 302 #define GRUREGION(addr)         ((addr) >> (VADDR_HI_BIT - 3) & 3)
 303 #define GRUASID(asid, addr)     ((asid) + GRUREGION(addr))
 304
 305 /*------------------------------------------------------------------------------
 306  *  File & VMS Tables
 307  */
 308
 309 struct gru_state;
 310
 311 /*
 312  * This structure is pointed to from the mmstruct via the notifier pointer.
 313  * There is one of these per address space.
 314  */
 315 struct gru_mm_tracker {                         /* pack to reduce size */
 316         unsigned int            mt_asid_gen:24; /* ASID wrap count */
 317         unsigned int            mt_asid:24;     /* current base ASID for gru */
 318         unsigned short          mt_ctxbitmap:16;/* bitmap of contexts using
 319                                                    asid */
 320 } __attribute__ ((packed));
 321
 322 struct gru_mm_struct {
 323         struct mmu_notifier     ms_notifier;
 324         atomic_t                ms_refcnt;
 325         spinlock_t              ms_asid_lock;   /* protects ASID assignment */
 326         atomic_t                ms_range_active;/* num range_invals active */
 327         char                    ms_released;
 328         wait_queue_head_t       ms_wait_queue;
 329         DECLARE_BITMAP(ms_asidmap, GRU_MAX_GRUS);
 330         struct gru_mm_tracker   ms_asids[GRU_MAX_GRUS];
 331 };
 332
 333 /*
 334  * One of these structures is allocated when a GSEG is mmaped. The
 335  * structure is pointed to by the vma->vm_private_data field in the vma struct.
 336  */
 337 struct gru_vma_data {
 338         spinlock_t              vd_lock;        /* Serialize access to vma */
 339         struct list_head        vd_head;        /* head of linked list of gts */
 340         long                    vd_user_options;/* misc user option flags */
 341         int                     vd_cbr_au_count;
 342         int                     vd_dsr_au_count;
 343 };
 344
 345 /*
 346  * One of these is allocated for each thread accessing a mmaped GRU. A linked
 347  * list of these structure is hung off the struct gru_vma_data in the mm_struct.
 348  */
 349 struct gru_thread_state {
 350         struct list_head        ts_next;        /* list - head at vma-private */
 351         struct mutex            ts_ctxlock;     /* load/unload CTX lock */
 352         struct mm_struct        *ts_mm;         /* mm currently mapped to
 353                                                    context */
 354         struct vm_area_struct   *ts_vma;        /* vma of GRU context */
 355         struct gru_state        *ts_gru;        /* GRU where the context is
 356                                                    loaded */
 357         struct gru_mm_struct    *ts_gms;        /* asid & ioproc struct */
 358         unsigned long           ts_cbr_map;     /* map of allocated CBRs */
 359         unsigned long           ts_dsr_map;     /* map of allocated DATA
 360                                                    resources */
 361         unsigned long           ts_steal_jiffies;/* jiffies when context last
 362                                                     stolen */
 363         long                    ts_user_options;/* misc user option flags */
 364         pid_t                   ts_tgid_owner;  /* task that is using the
 365                                                    context - for migration */
 366         unsigned short          ts_sizeavail;   /* Pagesizes in use */
 367         int                     ts_tsid;        /* thread that owns the
 368                                                    structure */
 369         int                     ts_tlb_int_select;/* target cpu if interrupts
 370                                                      enabled */
 371         int                     ts_ctxnum;      /* context number where the
 372                                                    context is loaded */
 373         atomic_t                ts_refcnt;      /* reference count GTS */
 374         unsigned char           ts_dsr_au_count;/* Number of DSR resources
 375                                                    required for contest */
 376         unsigned char           ts_cbr_au_count;/* Number of CBR resources
 377                                                    required for contest */
 378         char                    ts_blade;       /* If >= 0, migrate context if
 379                                                    ref from diferent blade */
 380         char                    ts_force_cch_reload;
 381         char                    ts_force_unload;/* force context to be unloaded
 382                                                    after migration */
 383         char                    ts_cbr_idx[GRU_CBR_AU];/* CBR numbers of each
 384                                                           allocated CB */
 385         unsigned long           ts_gdata[0];    /* save area for GRU data (CB,
 386                                                    DS, CBE) */
 387 };
 388
 389 /*
 390  * Threaded programs actually allocate an array of GSEGs when a context is
 391  * created. Each thread uses a separate GSEG. TSID is the index into the GSEG
 392  * array.
 393  */
 394 #define TSID(a, v)              (((a) - (v)->vm_start) / GRU_GSEG_PAGESIZE)
 395 #define UGRUADDR(gts)           ((gts)->ts_vma->vm_start +              \
 396                                         (gts)->ts_tsid * GRU_GSEG_PAGESIZE)
 397
 398 #define NULLCTX                 (-1)    /* if context not loaded into GRU */
 399
 400 /*-----------------------------------------------------------------------------
 401  *  GRU State Tables
 402  */
 403
 404 /*
 405  * One of these exists for each GRU chiplet.
 406  */
 407 struct gru_state {
 408         struct gru_blade_state  *gs_blade;              /* GRU state for entire
 409                                                            blade */
 410         unsigned long           gs_gru_base_paddr;      /* Physical address of
 411                                                            gru segments (64) */
 412         void                    *gs_gru_base_vaddr;     /* Virtual address of
 413                                                            gru segments (64) */
 414         unsigned short          gs_gid;                 /* unique GRU number */
 415         unsigned short          gs_blade_id;            /* blade of GRU */
 416         unsigned char           gs_tgh_local_shift;     /* used to pick TGH for
 417                                                            local flush */
 418         unsigned char           gs_tgh_first_remote;    /* starting TGH# for
 419                                                            remote flush */
 420         spinlock_t              gs_asid_lock;           /* lock used for
 421                                                            assigning asids */
 422         spinlock_t              gs_lock;                /* lock used for
 423                                                            assigning contexts */
 424
 425         /* -- the following are protected by the gs_asid_lock spinlock ---- */
 426         unsigned int            gs_asid;                /* Next availe ASID */
 427         unsigned int            gs_asid_limit;          /* Limit of available
 428                                                            ASIDs */
 429         unsigned int            gs_asid_gen;            /* asid generation.
 430                                                            Inc on wrap */
 431
 432         /* --- the following fields are protected by the gs_lock spinlock --- */
 433         unsigned long           gs_context_map;         /* bitmap to manage
 434                                                            contexts in use */
 435         unsigned long           gs_cbr_map;             /* bitmap to manage CB
 436                                                            resources */
 437         unsigned long           gs_dsr_map;             /* bitmap used to manage
 438                                                            DATA resources */
 439         unsigned int            gs_reserved_cbrs;       /* Number of kernel-
 440                                                            reserved cbrs */
 441         unsigned int            gs_reserved_dsr_bytes;  /* Bytes of kernel-
 442                                                            reserved dsrs */
 443         unsigned short          gs_active_contexts;     /* number of contexts
 444                                                            in use */
 445         struct gru_thread_state *gs_gts[GRU_NUM_CCH];   /* GTS currently using
 446                                                            the context */
 447 };
 448
 449 /*
 450  * This structure contains the GRU state for all the GRUs on a blade.
 451  */
 452 struct gru_blade_state {
 453         void                    *kernel_cb;             /* First kernel
 454                                                            reserved cb */
 455         void                    *kernel_dsr;            /* First kernel
 456                                                            reserved DSR */
 457         /* ---- the following are protected by the bs_lock spinlock ---- */
 458         spinlock_t              bs_lock;                /* lock used for
 459                                                            stealing contexts */
 460         int                     bs_lru_ctxnum;          /* STEAL - last context
 461                                                            stolen */
 462         struct gru_state        *bs_lru_gru;            /* STEAL - last gru
 463                                                            stolen */
 464
 465         struct gru_state        bs_grus[GRU_CHIPLETS_PER_BLADE];
 466 };
 467
 468 /*-----------------------------------------------------------------------------
 469  * Address Primitives
 470  */
 471 #define get_tfm_for_cpu(g, c)                                           \
 472         ((struct gru_tlb_fault_map *)get_tfm((g)->gs_gru_base_vaddr, (c)))
 473 #define get_tfh_by_index(g, i)                                          \
 474         ((struct gru_tlb_fault_handle *)get_tfh((g)->gs_gru_base_vaddr, (i)))
 475 #define get_tgh_by_index(g, i)                                          \
 476         ((struct gru_tlb_global_handle *)get_tgh((g)->gs_gru_base_vaddr, (i)))
 477 #define get_cbe_by_index(g, i)                                          \
 478         ((struct gru_control_block_extended *)get_cbe((g)->gs_gru_base_vaddr,\
 479                         (i)))
 480
 481 /*-----------------------------------------------------------------------------
 482  * Useful Macros
 483  */
 484
 485 /* Given a blade# & chiplet#, get a pointer to the GRU */
 486 #define get_gru(b, c)           (&gru_base[b]->bs_grus[c])
 487
 488 /* Number of bytes to save/restore when unloading/loading GRU contexts */
 489 #define DSR_BYTES(dsr)          ((dsr) * GRU_DSR_AU_BYTES)
 490 #define CBR_BYTES(cbr)          ((cbr) * GRU_HANDLE_BYTES * GRU_CBR_AU_SIZE * 2)
 491
 492 /* Convert a user CB number to the actual CBRNUM */
 493 #define thread_cbr_number(gts, n) ((gts)->ts_cbr_idx[(n) / GRU_CBR_AU_SIZE] \
 494                                   * GRU_CBR_AU_SIZE + (n) % GRU_CBR_AU_SIZE)
 495
 496 /* Convert a gid to a pointer to the GRU */
 497 #define GID_TO_GRU(gid)                                                 \
 498         (gru_base[(gid) / GRU_CHIPLETS_PER_BLADE] ?                     \
 499                 (&gru_base[(gid) / GRU_CHIPLETS_PER_BLADE]->            \
 500                         bs_grus[(gid) % GRU_CHIPLETS_PER_BLADE]) :      \
 501          NULL)
 502
 503 /* Scan all active GRUs in a GRU bitmap */
 504 #define for_each_gru_in_bitmap(gid, map)                                \
 505         for ((gid) = find_first_bit((map), GRU_MAX_GRUS); (gid) < GRU_MAX_GRUS;\
 506                 (gid)++, (gid) = find_next_bit((map), GRU_MAX_GRUS, (gid)))
 507
 508 /* Scan all active GRUs on a specific blade */
 509 #define for_each_gru_on_blade(gru, nid, i)                              \
 510         for ((gru) = gru_base[nid]->bs_grus, (i) = 0;                   \
 511                         (i) < GRU_CHIPLETS_PER_BLADE;                   \
 512                         (i)++, (gru)++)
 513
 514 /* Scan all GRUs */
 515 #define foreach_gid(gid)                                                \
 516         for ((gid) = 0; (gid) < gru_max_gids; (gid)++)
 517
 518 /* Scan all active GTSs on a gru. Note: must hold ss_lock to use this macro. */
 519 #define for_each_gts_on_gru(gts, gru, ctxnum)                           \
 520         for ((ctxnum) = 0; (ctxnum) < GRU_NUM_CCH; (ctxnum)++)          \
 521                 if (((gts) = (gru)->gs_gts[ctxnum]))
 522
 523 /* Scan each CBR whose bit is set in a TFM (or copy of) */
 524 #define for_each_cbr_in_tfm(i, map)                                     \
 525         for ((i) = find_first_bit(map, GRU_NUM_CBE);                    \
 526                         (i) < GRU_NUM_CBE;                              \
 527                         (i)++, (i) = find_next_bit(map, GRU_NUM_CBE, i))
 528
 529 /* Scan each CBR in a CBR bitmap. Note: multiple CBRs in an allocation unit */
 530 #define for_each_cbr_in_allocation_map(i, map, k)                       \
 531         for ((k) = find_first_bit(map, GRU_CBR_AU); (k) < GRU_CBR_AU;   \
 532                         (k) = find_next_bit(map, GRU_CBR_AU, (k) + 1))  \
 533                 for ((i) = (k)*GRU_CBR_AU_SIZE;                         \
 534                                 (i) < ((k) + 1) * GRU_CBR_AU_SIZE; (i)++)
 535
 536 /* Scan each DSR in a DSR bitmap. Note: multiple DSRs in an allocation unit */
 537 #define for_each_dsr_in_allocation_map(i, map, k)                       \
 538         for ((k) = find_first_bit((const unsigned long *)map, GRU_DSR_AU);\
 539                         (k) < GRU_DSR_AU;                               \
 540                         (k) = find_next_bit((const unsigned long *)map, \
 541                                           GRU_DSR_AU, (k) + 1))         \
 542                 for ((i) = (k) * GRU_DSR_AU_CL;                         \
 543                                 (i) < ((k) + 1) * GRU_DSR_AU_CL; (i)++)
 544
 545 #define gseg_physical_address(gru, ctxnum)                              \
 546                 ((gru)->gs_gru_base_paddr + ctxnum * GRU_GSEG_STRIDE)
 547 #define gseg_virtual_address(gru, ctxnum)                               \
 548                 ((gru)->gs_gru_base_vaddr + ctxnum * GRU_GSEG_STRIDE)
 549
 550 /*-----------------------------------------------------------------------------
 551  * Lock / Unlock GRU handles
 552  *      Use the "delresp" bit in the handle as a "lock" bit.
 553  */
 554
 555 /* Lock hierarchy checking enabled only in emulator */
 556
 557 /* 0 = lock failed, 1 = locked */
 558 static inline int __trylock_handle(void *h)
 559 {
 560         return !test_and_set_bit(1, h);
 561 }
 562
 563 static inline void __lock_handle(void *h)
 564 {
 565         while (test_and_set_bit(1, h))
 566                 cpu_relax();
 567 }
 568
 569 static inline void __unlock_handle(void *h)
 570 {
 571         clear_bit(1, h);
 572 }
 573
 574 static inline int trylock_cch_handle(struct gru_context_configuration_handle *cch)
 575 {
 576         return __trylock_handle(cch);
 577 }
 578
 579 static inline void lock_cch_handle(struct gru_context_configuration_handle *cch)
 580 {
 581         __lock_handle(cch);
 582 }
 583
 584 static inline void unlock_cch_handle(struct gru_context_configuration_handle
 585                                      *cch)
 586 {
 587         __unlock_handle(cch);
 588 }
 589
 590 static inline void lock_tgh_handle(struct gru_tlb_global_handle *tgh)
 591 {
 592         __lock_handle(tgh);
 593 }
 594
 595 static inline void unlock_tgh_handle(struct gru_tlb_global_handle *tgh)
 596 {
 597         __unlock_handle(tgh);
 598 }
 599
 600 /*-----------------------------------------------------------------------------
 601  * Function prototypes & externs
 602  */
 603 struct gru_unload_context_req;
 604
 605 extern struct vm_operations_struct gru_vm_ops;
 606 extern struct device *grudev;
 607
 608 extern struct gru_vma_data *gru_alloc_vma_data(struct vm_area_struct *vma,
 609                                 int tsid);
 610 extern struct gru_thread_state *gru_find_thread_state(struct vm_area_struct
 611                                 *vma, int tsid);
 612 extern struct gru_thread_state *gru_alloc_thread_state(struct vm_area_struct
 613                                 *vma, int tsid);
 614 extern struct gru_state *gru_assign_gru_context(struct gru_thread_state *gts,
 615                 int blade);
 616 extern void gru_load_context(struct gru_thread_state *gts);
 617 extern void gru_steal_context(struct gru_thread_state *gts, int blade_id);
 618 extern void gru_unload_context(struct gru_thread_state *gts, int savestate);
 619 extern int gru_update_cch(struct gru_thread_state *gts, int force_unload);
 620 extern void gts_drop(struct gru_thread_state *gts);
 621 extern void gru_tgh_flush_init(struct gru_state *gru);
 622 extern int gru_kservices_init(struct gru_state *gru);
 623 extern void gru_kservices_exit(struct gru_state *gru);
 624 extern int gru_dump_chiplet_request(unsigned long arg);
 625 extern irqreturn_t gru_intr(int irq, void *dev_id);
 626 extern int gru_handle_user_call_os(unsigned long address);
 627 extern int gru_user_flush_tlb(unsigned long arg);
 628 extern int gru_user_unload_context(unsigned long arg);
 629 extern int gru_get_exception_detail(unsigned long arg);
 630 extern int gru_set_task_slice(long address);
 631 extern int gru_cpu_fault_map_id(void);
 632 extern struct vm_area_struct *gru_find_vma(unsigned long vaddr);
 633 extern void gru_flush_all_tlb(struct gru_state *gru);
 634 extern int gru_proc_init(void);
 635 extern void gru_proc_exit(void);
 636
 637 extern struct gru_thread_state *gru_alloc_gts(struct vm_area_struct *vma,
 638                 int cbr_au_count, int dsr_au_count, int options, int tsid);
 639 extern unsigned long gru_reserve_cb_resources(struct gru_state *gru,
 640                 int cbr_au_count, char *cbmap);
 641 extern unsigned long gru_reserve_ds_resources(struct gru_state *gru,
 642                 int dsr_au_count, char *dsmap);
 643 extern int gru_fault(struct vm_area_struct *, struct vm_fault *vmf);
 644 extern struct gru_mm_struct *gru_register_mmu_notifier(void);
 645 extern void gru_drop_mmu_notifier(struct gru_mm_struct *gms);
 646
 647 extern void gru_flush_tlb_range(struct gru_mm_struct *gms, unsigned long start,
 648                                         unsigned long len);
 649
 650 extern unsigned long gru_options;
 651
 652 #endif /* __GRUTABLES_H__ */