adaf691d59f5f3fee90181bbea2866847344732a
[linux-2.6.git] / 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 "grulib.h"
152 #include "gruhandles.h"
153
154 extern struct gru_stats_s gru_stats;
155 extern struct gru_blade_state *gru_base[];
156 extern unsigned long gru_start_paddr, gru_end_paddr;
157 extern void *gru_start_vaddr;
158 extern unsigned int gru_max_gids;
159
160 #define GRU_MAX_BLADES          MAX_NUMNODES
161 #define GRU_MAX_GRUS            (GRU_MAX_BLADES * GRU_CHIPLETS_PER_BLADE)
162
163 #define GRU_DRIVER_ID_STR       "SGI GRU Device Driver"
164 #define GRU_DRIVER_VERSION_STR  "0.80"
165
166 /*
167  * GRU statistics.
168  */
169 struct gru_stats_s {
170         atomic_long_t vdata_alloc;
171         atomic_long_t vdata_free;
172         atomic_long_t gts_alloc;
173         atomic_long_t gts_free;
174         atomic_long_t gms_alloc;
175         atomic_long_t gms_free;
176         atomic_long_t gts_double_allocate;
177         atomic_long_t assign_context;
178         atomic_long_t assign_context_failed;
179         atomic_long_t free_context;
180         atomic_long_t load_user_context;
181         atomic_long_t load_kernel_context;
182         atomic_long_t lock_kernel_context;
183         atomic_long_t unlock_kernel_context;
184         atomic_long_t steal_user_context;
185         atomic_long_t steal_kernel_context;
186         atomic_long_t steal_context_failed;
187         atomic_long_t nopfn;
188         atomic_long_t asid_new;
189         atomic_long_t asid_next;
190         atomic_long_t asid_wrap;
191         atomic_long_t asid_reuse;
192         atomic_long_t intr;
193         atomic_long_t intr_cbr;
194         atomic_long_t intr_tfh;
195         atomic_long_t intr_mm_lock_failed;
196         atomic_long_t call_os;
197         atomic_long_t call_os_wait_queue;
198         atomic_long_t user_flush_tlb;
199         atomic_long_t user_unload_context;
200         atomic_long_t user_exception;
201         atomic_long_t set_context_option;
202         atomic_long_t check_context_retarget_intr;
203         atomic_long_t check_context_unload;
204         atomic_long_t tlb_dropin;
205         atomic_long_t tlb_preload_page;
206         atomic_long_t tlb_dropin_fail_no_asid;
207         atomic_long_t tlb_dropin_fail_upm;
208         atomic_long_t tlb_dropin_fail_invalid;
209         atomic_long_t tlb_dropin_fail_range_active;
210         atomic_long_t tlb_dropin_fail_idle;
211         atomic_long_t tlb_dropin_fail_fmm;
212         atomic_long_t tlb_dropin_fail_no_exception;
213         atomic_long_t tfh_stale_on_fault;
214         atomic_long_t mmu_invalidate_range;
215         atomic_long_t mmu_invalidate_page;
216         atomic_long_t flush_tlb;
217         atomic_long_t flush_tlb_gru;
218         atomic_long_t flush_tlb_gru_tgh;
219         atomic_long_t flush_tlb_gru_zero_asid;
220
221         atomic_long_t copy_gpa;
222         atomic_long_t read_gpa;
223
224         atomic_long_t mesq_receive;
225         atomic_long_t mesq_receive_none;
226         atomic_long_t mesq_send;
227         atomic_long_t mesq_send_failed;
228         atomic_long_t mesq_noop;
229         atomic_long_t mesq_send_unexpected_error;
230         atomic_long_t mesq_send_lb_overflow;
231         atomic_long_t mesq_send_qlimit_reached;
232         atomic_long_t mesq_send_amo_nacked;
233         atomic_long_t mesq_send_put_nacked;
234         atomic_long_t mesq_page_overflow;
235         atomic_long_t mesq_qf_locked;
236         atomic_long_t mesq_qf_noop_not_full;
237         atomic_long_t mesq_qf_switch_head_failed;
238         atomic_long_t mesq_qf_unexpected_error;
239         atomic_long_t mesq_noop_unexpected_error;
240         atomic_long_t mesq_noop_lb_overflow;
241         atomic_long_t mesq_noop_qlimit_reached;
242         atomic_long_t mesq_noop_amo_nacked;
243         atomic_long_t mesq_noop_put_nacked;
244         atomic_long_t mesq_noop_page_overflow;
245
246 };
247
248 enum mcs_op {cchop_allocate, cchop_start, cchop_interrupt, cchop_interrupt_sync,
249         cchop_deallocate, tfhop_write_only, tfhop_write_restart,
250         tghop_invalidate, mcsop_last};
251
252 struct mcs_op_statistic {
253         atomic_long_t   count;
254         atomic_long_t   total;
255         unsigned long   max;
256 };
257
258 extern struct mcs_op_statistic mcs_op_statistics[mcsop_last];
259
260 #define OPT_DPRINT              1
261 #define OPT_STATS               2
262
263
264 #define IRQ_GRU                 110     /* Starting IRQ number for interrupts */
265
266 /* Delay in jiffies between attempts to assign a GRU context */
267 #define GRU_ASSIGN_DELAY        ((HZ * 20) / 1000)
268
269 /*
270  * If a process has it's context stolen, min delay in jiffies before trying to
271  * steal a context from another process.
272  */
273 #define GRU_STEAL_DELAY         ((HZ * 200) / 1000)
274
275 #define STAT(id)        do {                                            \
276                                 if (gru_options & OPT_STATS)            \
277                                         atomic_long_inc(&gru_stats.id); \
278                         } while (0)
279
280 #ifdef CONFIG_SGI_GRU_DEBUG
281 #define gru_dbg(dev, fmt, x...)                                         \
282         do {                                                            \
283                 if (gru_options & OPT_DPRINT)                           \
284                         printk(KERN_DEBUG "GRU:%d %s: " fmt, smp_processor_id(), __func__, x);\
285         } while (0)
286 #else
287 #define gru_dbg(x...)
288 #endif
289
290 /*-----------------------------------------------------------------------------
291  * ASID management
292  */
293 #define MAX_ASID        0xfffff0
294 #define MIN_ASID        8
295 #define ASID_INC        8       /* number of regions */
296
297 /* Generate a GRU asid value from a GRU base asid & a virtual address. */
298 #define VADDR_HI_BIT            64
299 #define GRUREGION(addr)         ((addr) >> (VADDR_HI_BIT - 3) & 3)
300 #define GRUASID(asid, addr)     ((asid) + GRUREGION(addr))
301
302 /*------------------------------------------------------------------------------
303  *  File & VMS Tables
304  */
305
306 struct gru_state;
307
308 /*
309  * This structure is pointed to from the mmstruct via the notifier pointer.
310  * There is one of these per address space.
311  */
312 struct gru_mm_tracker {                         /* pack to reduce size */
313         unsigned int            mt_asid_gen:24; /* ASID wrap count */
314         unsigned int            mt_asid:24;     /* current base ASID for gru */
315         unsigned short          mt_ctxbitmap:16;/* bitmap of contexts using
316                                                    asid */
317 } __attribute__ ((packed));
318
319 struct gru_mm_struct {
320         struct mmu_notifier     ms_notifier;
321         atomic_t                ms_refcnt;
322         spinlock_t              ms_asid_lock;   /* protects ASID assignment */
323         atomic_t                ms_range_active;/* num range_invals active */
324         char                    ms_released;
325         wait_queue_head_t       ms_wait_queue;
326         DECLARE_BITMAP(ms_asidmap, GRU_MAX_GRUS);
327         struct gru_mm_tracker   ms_asids[GRU_MAX_GRUS];
328 };
329
330 /*
331  * One of these structures is allocated when a GSEG is mmaped. The
332  * structure is pointed to by the vma->vm_private_data field in the vma struct.
333  */
334 struct gru_vma_data {
335         spinlock_t              vd_lock;        /* Serialize access to vma */
336         struct list_head        vd_head;        /* head of linked list of gts */
337         long                    vd_user_options;/* misc user option flags */
338         int                     vd_cbr_au_count;
339         int                     vd_dsr_au_count;
340         unsigned char           vd_tlb_preload_count;
341 };
342
343 /*
344  * One of these is allocated for each thread accessing a mmaped GRU. A linked
345  * list of these structure is hung off the struct gru_vma_data in the mm_struct.
346  */
347 struct gru_thread_state {
348         struct list_head        ts_next;        /* list - head at vma-private */
349         struct mutex            ts_ctxlock;     /* load/unload CTX lock */
350         struct mm_struct        *ts_mm;         /* mm currently mapped to
351                                                    context */
352         struct vm_area_struct   *ts_vma;        /* vma of GRU context */
353         struct gru_state        *ts_gru;        /* GRU where the context is
354                                                    loaded */
355         struct gru_mm_struct    *ts_gms;        /* asid & ioproc struct */
356         unsigned char           ts_tlb_preload_count; /* TLB preload pages */
357         unsigned long           ts_cbr_map;     /* map of allocated CBRs */
358         unsigned long           ts_dsr_map;     /* map of allocated DATA
359                                                    resources */
360         unsigned long           ts_steal_jiffies;/* jiffies when context last
361                                                     stolen */
362         long                    ts_user_options;/* misc user option flags */
363         pid_t                   ts_tgid_owner;  /* task that is using the
364                                                    context - for migration */
365         short                   ts_user_blade_id;/* user selected blade */
366         char                    ts_user_chiplet_id;/* user selected chiplet */
367         unsigned short          ts_sizeavail;   /* Pagesizes in use */
368         int                     ts_tsid;        /* thread that owns the
369                                                    structure */
370         int                     ts_tlb_int_select;/* target cpu if interrupts
371                                                      enabled */
372         int                     ts_ctxnum;      /* context number where the
373                                                    context is loaded */
374         atomic_t                ts_refcnt;      /* reference count GTS */
375         unsigned char           ts_dsr_au_count;/* Number of DSR resources
376                                                    required for contest */
377         unsigned char           ts_cbr_au_count;/* Number of CBR resources
378                                                    required for contest */
379         char                    ts_cch_req_slice;/* CCH packet slice */
380         char                    ts_blade;       /* If >= 0, migrate context if
381                                                    ref from diferent blade */
382         char                    ts_force_cch_reload;
383         char                    ts_cbr_idx[GRU_CBR_AU];/* CBR numbers of each
384                                                           allocated CB */
385         int                     ts_data_valid;  /* Indicates if ts_gdata has
386                                                    valid data */
387         struct gts_statistics   ustats;         /* User statistics */
388         unsigned long           ts_gdata[0];    /* save area for GRU data (CB,
389                                                    DS, CBE) */
390 };
391
392 /*
393  * Threaded programs actually allocate an array of GSEGs when a context is
394  * created. Each thread uses a separate GSEG. TSID is the index into the GSEG
395  * array.
396  */
397 #define TSID(a, v)              (((a) - (v)->vm_start) / GRU_GSEG_PAGESIZE)
398 #define UGRUADDR(gts)           ((gts)->ts_vma->vm_start +              \
399                                         (gts)->ts_tsid * GRU_GSEG_PAGESIZE)
400
401 #define NULLCTX                 (-1)    /* if context not loaded into GRU */
402
403 /*-----------------------------------------------------------------------------
404  *  GRU State Tables
405  */
406
407 /*
408  * One of these exists for each GRU chiplet.
409  */
410 struct gru_state {
411         struct gru_blade_state  *gs_blade;              /* GRU state for entire
412                                                            blade */
413         unsigned long           gs_gru_base_paddr;      /* Physical address of
414                                                            gru segments (64) */
415         void                    *gs_gru_base_vaddr;     /* Virtual address of
416                                                            gru segments (64) */
417         unsigned short          gs_gid;                 /* unique GRU number */
418         unsigned short          gs_blade_id;            /* blade of GRU */
419         unsigned char           gs_chiplet_id;          /* blade chiplet of GRU */
420         unsigned char           gs_tgh_local_shift;     /* used to pick TGH for
421                                                            local flush */
422         unsigned char           gs_tgh_first_remote;    /* starting TGH# for
423                                                            remote flush */
424         spinlock_t              gs_asid_lock;           /* lock used for
425                                                            assigning asids */
426         spinlock_t              gs_lock;                /* lock used for
427                                                            assigning contexts */
428
429         /* -- the following are protected by the gs_asid_lock spinlock ---- */
430         unsigned int            gs_asid;                /* Next availe ASID */
431         unsigned int            gs_asid_limit;          /* Limit of available
432                                                            ASIDs */
433         unsigned int            gs_asid_gen;            /* asid generation.
434                                                            Inc on wrap */
435
436         /* --- the following fields are protected by the gs_lock spinlock --- */
437         unsigned long           gs_context_map;         /* bitmap to manage
438                                                            contexts in use */
439         unsigned long           gs_cbr_map;             /* bitmap to manage CB
440                                                            resources */
441         unsigned long           gs_dsr_map;             /* bitmap used to manage
442                                                            DATA resources */
443         unsigned int            gs_reserved_cbrs;       /* Number of kernel-
444                                                            reserved cbrs */
445         unsigned int            gs_reserved_dsr_bytes;  /* Bytes of kernel-
446                                                            reserved dsrs */
447         unsigned short          gs_active_contexts;     /* number of contexts
448                                                            in use */
449         struct gru_thread_state *gs_gts[GRU_NUM_CCH];   /* GTS currently using
450                                                            the context */
451         int                     gs_irq[GRU_NUM_TFM];    /* Interrupt irqs */
452 };
453
454 /*
455  * This structure contains the GRU state for all the GRUs on a blade.
456  */
457 struct gru_blade_state {
458         void                    *kernel_cb;             /* First kernel
459                                                            reserved cb */
460         void                    *kernel_dsr;            /* First kernel
461                                                            reserved DSR */
462         struct rw_semaphore     bs_kgts_sema;           /* lock for kgts */
463         struct gru_thread_state *bs_kgts;               /* GTS for kernel use */
464
465         /* ---- the following are used for managing kernel async GRU CBRs --- */
466         int                     bs_async_dsr_bytes;     /* DSRs for async */
467         int                     bs_async_cbrs;          /* CBRs AU for async */
468         struct completion       *bs_async_wq;
469
470         /* ---- the following are protected by the bs_lock spinlock ---- */
471         spinlock_t              bs_lock;                /* lock used for
472                                                            stealing contexts */
473         int                     bs_lru_ctxnum;          /* STEAL - last context
474                                                            stolen */
475         struct gru_state        *bs_lru_gru;            /* STEAL - last gru
476                                                            stolen */
477
478         struct gru_state        bs_grus[GRU_CHIPLETS_PER_BLADE];
479 };
480
481 /*-----------------------------------------------------------------------------
482  * Address Primitives
483  */
484 #define get_tfm_for_cpu(g, c)                                           \
485         ((struct gru_tlb_fault_map *)get_tfm((g)->gs_gru_base_vaddr, (c)))
486 #define get_tfh_by_index(g, i)                                          \
487         ((struct gru_tlb_fault_handle *)get_tfh((g)->gs_gru_base_vaddr, (i)))
488 #define get_tgh_by_index(g, i)                                          \
489         ((struct gru_tlb_global_handle *)get_tgh((g)->gs_gru_base_vaddr, (i)))
490 #define get_cbe_by_index(g, i)                                          \
491         ((struct gru_control_block_extended *)get_cbe((g)->gs_gru_base_vaddr,\
492                         (i)))
493
494 /*-----------------------------------------------------------------------------
495  * Useful Macros
496  */
497
498 /* Given a blade# & chiplet#, get a pointer to the GRU */
499 #define get_gru(b, c)           (&gru_base[b]->bs_grus[c])
500
501 /* Number of bytes to save/restore when unloading/loading GRU contexts */
502 #define DSR_BYTES(dsr)          ((dsr) * GRU_DSR_AU_BYTES)
503 #define CBR_BYTES(cbr)          ((cbr) * GRU_HANDLE_BYTES * GRU_CBR_AU_SIZE * 2)
504
505 /* Convert a user CB number to the actual CBRNUM */
506 #define thread_cbr_number(gts, n) ((gts)->ts_cbr_idx[(n) / GRU_CBR_AU_SIZE] \
507                                   * GRU_CBR_AU_SIZE + (n) % GRU_CBR_AU_SIZE)
508
509 /* Convert a gid to a pointer to the GRU */
510 #define GID_TO_GRU(gid)                                                 \
511         (gru_base[(gid) / GRU_CHIPLETS_PER_BLADE] ?                     \
512                 (&gru_base[(gid) / GRU_CHIPLETS_PER_BLADE]->            \
513                         bs_grus[(gid) % GRU_CHIPLETS_PER_BLADE]) :      \
514          NULL)
515
516 /* Scan all active GRUs in a GRU bitmap */
517 #define for_each_gru_in_bitmap(gid, map)                                \
518         for ((gid) = find_first_bit((map), GRU_MAX_GRUS); (gid) < GRU_MAX_GRUS;\
519                 (gid)++, (gid) = find_next_bit((map), GRU_MAX_GRUS, (gid)))
520
521 /* Scan all active GRUs on a specific blade */
522 #define for_each_gru_on_blade(gru, nid, i)                              \
523         for ((gru) = gru_base[nid]->bs_grus, (i) = 0;                   \
524                         (i) < GRU_CHIPLETS_PER_BLADE;                   \
525                         (i)++, (gru)++)
526
527 /* Scan all GRUs */
528 #define foreach_gid(gid)                                                \
529         for ((gid) = 0; (gid) < gru_max_gids; (gid)++)
530
531 /* Scan all active GTSs on a gru. Note: must hold ss_lock to use this macro. */
532 #define for_each_gts_on_gru(gts, gru, ctxnum)                           \
533         for ((ctxnum) = 0; (ctxnum) < GRU_NUM_CCH; (ctxnum)++)          \
534                 if (((gts) = (gru)->gs_gts[ctxnum]))
535
536 /* Scan each CBR whose bit is set in a TFM (or copy of) */
537 #define for_each_cbr_in_tfm(i, map)                                     \
538         for ((i) = find_first_bit(map, GRU_NUM_CBE);                    \
539                         (i) < GRU_NUM_CBE;                              \
540                         (i)++, (i) = find_next_bit(map, GRU_NUM_CBE, i))
541
542 /* Scan each CBR in a CBR bitmap. Note: multiple CBRs in an allocation unit */
543 #define for_each_cbr_in_allocation_map(i, map, k)                       \
544         for ((k) = find_first_bit(map, GRU_CBR_AU); (k) < GRU_CBR_AU;   \
545                         (k) = find_next_bit(map, GRU_CBR_AU, (k) + 1))  \
546                 for ((i) = (k)*GRU_CBR_AU_SIZE;                         \
547                                 (i) < ((k) + 1) * GRU_CBR_AU_SIZE; (i)++)
548
549 /* Scan each DSR in a DSR bitmap. Note: multiple DSRs in an allocation unit */
550 #define for_each_dsr_in_allocation_map(i, map, k)                       \
551         for ((k) = find_first_bit((const unsigned long *)map, GRU_DSR_AU);\
552                         (k) < GRU_DSR_AU;                               \
553                         (k) = find_next_bit((const unsigned long *)map, \
554                                           GRU_DSR_AU, (k) + 1))         \
555                 for ((i) = (k) * GRU_DSR_AU_CL;                         \
556                                 (i) < ((k) + 1) * GRU_DSR_AU_CL; (i)++)
557
558 #define gseg_physical_address(gru, ctxnum)                              \
559                 ((gru)->gs_gru_base_paddr + ctxnum * GRU_GSEG_STRIDE)
560 #define gseg_virtual_address(gru, ctxnum)                               \
561                 ((gru)->gs_gru_base_vaddr + ctxnum * GRU_GSEG_STRIDE)
562
563 /*-----------------------------------------------------------------------------
564  * Lock / Unlock GRU handles
565  *      Use the "delresp" bit in the handle as a "lock" bit.
566  */
567
568 /* Lock hierarchy checking enabled only in emulator */
569
570 /* 0 = lock failed, 1 = locked */
571 static inline int __trylock_handle(void *h)
572 {
573         return !test_and_set_bit(1, h);
574 }
575
576 static inline void __lock_handle(void *h)
577 {
578         while (test_and_set_bit(1, h))
579                 cpu_relax();
580 }
581
582 static inline void __unlock_handle(void *h)
583 {
584         clear_bit(1, h);
585 }
586
587 static inline int trylock_cch_handle(struct gru_context_configuration_handle *cch)
588 {
589         return __trylock_handle(cch);
590 }
591
592 static inline void lock_cch_handle(struct gru_context_configuration_handle *cch)
593 {
594         __lock_handle(cch);
595 }
596
597 static inline void unlock_cch_handle(struct gru_context_configuration_handle
598                                      *cch)
599 {
600         __unlock_handle(cch);
601 }
602
603 static inline void lock_tgh_handle(struct gru_tlb_global_handle *tgh)
604 {
605         __lock_handle(tgh);
606 }
607
608 static inline void unlock_tgh_handle(struct gru_tlb_global_handle *tgh)
609 {
610         __unlock_handle(tgh);
611 }
612
613 static inline int is_kernel_context(struct gru_thread_state *gts)
614 {
615         return !gts->ts_mm;
616 }
617
618 /*
619  * The following are for Nehelem-EX. A more general scheme is needed for
620  * future processors.
621  */
622 #define UV_MAX_INT_CORES                8
623 #define uv_cpu_socket_number(p)         ((cpu_physical_id(p) >> 5) & 1)
624 #define uv_cpu_ht_number(p)             (cpu_physical_id(p) & 1)
625 #define uv_cpu_core_number(p)           (((cpu_physical_id(p) >> 2) & 4) |      \
626                                         ((cpu_physical_id(p) >> 1) & 3))
627 /*-----------------------------------------------------------------------------
628  * Function prototypes & externs
629  */
630 struct gru_unload_context_req;
631
632 extern const struct vm_operations_struct gru_vm_ops;
633 extern struct device *grudev;
634
635 extern struct gru_vma_data *gru_alloc_vma_data(struct vm_area_struct *vma,
636                                 int tsid);
637 extern struct gru_thread_state *gru_find_thread_state(struct vm_area_struct
638                                 *vma, int tsid);
639 extern struct gru_thread_state *gru_alloc_thread_state(struct vm_area_struct
640                                 *vma, int tsid);
641 extern struct gru_state *gru_assign_gru_context(struct gru_thread_state *gts);
642 extern void gru_load_context(struct gru_thread_state *gts);
643 extern void gru_steal_context(struct gru_thread_state *gts);
644 extern void gru_unload_context(struct gru_thread_state *gts, int savestate);
645 extern int gru_update_cch(struct gru_thread_state *gts);
646 extern void gts_drop(struct gru_thread_state *gts);
647 extern void gru_tgh_flush_init(struct gru_state *gru);
648 extern int gru_kservices_init(void);
649 extern void gru_kservices_exit(void);
650 extern irqreturn_t gru0_intr(int irq, void *dev_id);
651 extern irqreturn_t gru1_intr(int irq, void *dev_id);
652 extern irqreturn_t gru_intr_mblade(int irq, void *dev_id);
653 extern int gru_dump_chiplet_request(unsigned long arg);
654 extern long gru_get_gseg_statistics(unsigned long arg);
655 extern int gru_handle_user_call_os(unsigned long address);
656 extern int gru_user_flush_tlb(unsigned long arg);
657 extern int gru_user_unload_context(unsigned long arg);
658 extern int gru_get_exception_detail(unsigned long arg);
659 extern int gru_set_context_option(unsigned long address);
660 extern void gru_check_context_placement(struct gru_thread_state *gts);
661 extern int gru_cpu_fault_map_id(void);
662 extern struct vm_area_struct *gru_find_vma(unsigned long vaddr);
663 extern void gru_flush_all_tlb(struct gru_state *gru);
664 extern int gru_proc_init(void);
665 extern void gru_proc_exit(void);
666
667 extern struct gru_thread_state *gru_alloc_gts(struct vm_area_struct *vma,
668                 int cbr_au_count, int dsr_au_count,
669                 unsigned char tlb_preload_count, int options, int tsid);
670 extern unsigned long gru_reserve_cb_resources(struct gru_state *gru,
671                 int cbr_au_count, char *cbmap);
672 extern unsigned long gru_reserve_ds_resources(struct gru_state *gru,
673                 int dsr_au_count, char *dsmap);
674 extern int gru_fault(struct vm_area_struct *, struct vm_fault *vmf);
675 extern struct gru_mm_struct *gru_register_mmu_notifier(void);
676 extern void gru_drop_mmu_notifier(struct gru_mm_struct *gms);
677
678 extern int gru_ktest(unsigned long arg);
679 extern void gru_flush_tlb_range(struct gru_mm_struct *gms, unsigned long start,
680                                         unsigned long len);
681
682 extern unsigned long gru_options;
683
684 #endif /* __GRUTABLES_H__ */