sgi-gru: change GRU CCH commands from inline functions to outofline functions
[linux-2.6/mini2440.git] / drivers / misc / sgi-gru / grutables.h
blob378a0894198e07ec1c3a93bfc2f0484755c063cc
1 /*
2 * SN Platform GRU Driver
4 * GRU DRIVER TABLES, MACROS, externs, etc
6 * Copyright (c) 2008 Silicon Graphics, Inc. All Rights Reserved.
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.
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.
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
23 #ifndef __GRUTABLES_H__
24 #define __GRUTABLES_H__
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.
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).
37 * The entire GRU memory space is fully coherent and cacheable by the cpus.
39 * Each GRU chiplet has a physical memory map that looks like the following:
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 * +-----------------+
70 * Each of the "contexts" is a chunk of memory that can be mmaped into user
71 * space. The context consists of 2 parts:
73 * - an instruction space that can be directly accessed by the user
74 * to issue GRU instructions and to check instruction status.
76 * - a data area that acts as normal RAM.
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.
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.
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).
91 * Tables:
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.
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
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
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)
126 * GSEGs are marked DONTCOPY on fork
128 * At open
129 * file.private_data -> NULL
131 * At mmap,
132 * vma -> vdata
134 * After gseg reference
135 * vma -> vdata ->gts
137 * After fork
138 * parent
139 * vma -> vdata -> gts
140 * child
141 * (vma is not copied)
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"
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;
157 #define GRU_MAX_BLADES MAX_NUMNODES
158 #define GRU_MAX_GRUS (GRU_MAX_BLADES * GRU_CHIPLETS_PER_BLADE)
160 #define GRU_DRIVER_ID_STR "SGI GRU Device Driver"
161 #define GRU_DRIVER_VERSION_STR "0.80"
164 * GRU statistics.
166 struct gru_stats_s {
167 atomic_long_t vdata_alloc;
168 atomic_long_t vdata_free;
169 atomic_long_t gts_alloc;
170 atomic_long_t gts_free;
171 atomic_long_t vdata_double_alloc;
172 atomic_long_t gts_double_allocate;
173 atomic_long_t assign_context;
174 atomic_long_t assign_context_failed;
175 atomic_long_t free_context;
176 atomic_long_t load_context;
177 atomic_long_t unload_context;
178 atomic_long_t steal_context;
179 atomic_long_t steal_context_failed;
180 atomic_long_t nopfn;
181 atomic_long_t break_cow;
182 atomic_long_t asid_new;
183 atomic_long_t asid_next;
184 atomic_long_t asid_wrap;
185 atomic_long_t asid_reuse;
186 atomic_long_t intr;
187 atomic_long_t intr_mm_lock_failed;
188 atomic_long_t call_os;
189 atomic_long_t call_os_offnode_reference;
190 atomic_long_t call_os_check_for_bug;
191 atomic_long_t call_os_wait_queue;
192 atomic_long_t user_flush_tlb;
193 atomic_long_t user_unload_context;
194 atomic_long_t user_exception;
195 atomic_long_t set_task_slice;
196 atomic_long_t migrate_check;
197 atomic_long_t migrated_retarget;
198 atomic_long_t migrated_unload;
199 atomic_long_t migrated_unload_delay;
200 atomic_long_t migrated_nopfn_retarget;
201 atomic_long_t migrated_nopfn_unload;
202 atomic_long_t tlb_dropin;
203 atomic_long_t tlb_dropin_fail_no_asid;
204 atomic_long_t tlb_dropin_fail_upm;
205 atomic_long_t tlb_dropin_fail_invalid;
206 atomic_long_t tlb_dropin_fail_range_active;
207 atomic_long_t tlb_dropin_fail_idle;
208 atomic_long_t tlb_dropin_fail_fmm;
209 atomic_long_t mmu_invalidate_range;
210 atomic_long_t mmu_invalidate_page;
211 atomic_long_t mmu_clear_flush_young;
212 atomic_long_t flush_tlb;
213 atomic_long_t flush_tlb_gru;
214 atomic_long_t flush_tlb_gru_tgh;
215 atomic_long_t flush_tlb_gru_zero_asid;
217 atomic_long_t copy_gpa;
219 atomic_long_t mesq_receive;
220 atomic_long_t mesq_receive_none;
221 atomic_long_t mesq_send;
222 atomic_long_t mesq_send_failed;
223 atomic_long_t mesq_noop;
224 atomic_long_t mesq_send_unexpected_error;
225 atomic_long_t mesq_send_lb_overflow;
226 atomic_long_t mesq_send_qlimit_reached;
227 atomic_long_t mesq_send_amo_nacked;
228 atomic_long_t mesq_send_put_nacked;
229 atomic_long_t mesq_qf_not_full;
230 atomic_long_t mesq_qf_locked;
231 atomic_long_t mesq_qf_noop_not_full;
232 atomic_long_t mesq_qf_switch_head_failed;
233 atomic_long_t mesq_qf_unexpected_error;
234 atomic_long_t mesq_noop_unexpected_error;
235 atomic_long_t mesq_noop_lb_overflow;
236 atomic_long_t mesq_noop_qlimit_reached;
237 atomic_long_t mesq_noop_amo_nacked;
238 atomic_long_t mesq_noop_put_nacked;
242 enum mcs_op {cchop_allocate, cchop_start, cchop_interrupt, cchop_interrupt_sync,
243 cchop_deallocate, tghop_invalidate, mcsop_last};
245 #define OPT_DPRINT 1
246 #define OPT_STATS 2
247 #define GRU_QUICKLOOK 4
250 #define IRQ_GRU 110 /* Starting IRQ number for interrupts */
252 /* Delay in jiffies between attempts to assign a GRU context */
253 #define GRU_ASSIGN_DELAY ((HZ * 20) / 1000)
256 * If a process has it's context stolen, min delay in jiffies before trying to
257 * steal a context from another process.
259 #define GRU_STEAL_DELAY ((HZ * 200) / 1000)
261 #define STAT(id) do { \
262 if (gru_options & OPT_STATS) \
263 atomic_long_inc(&gru_stats.id); \
264 } while (0)
266 #ifdef CONFIG_SGI_GRU_DEBUG
267 #define gru_dbg(dev, fmt, x...) \
268 do { \
269 if (gru_options & OPT_DPRINT) \
270 dev_dbg(dev, "%s: " fmt, __func__, x); \
271 } while (0)
272 #else
273 #define gru_dbg(x...)
274 #endif
276 /*-----------------------------------------------------------------------------
277 * ASID management
279 #define MAX_ASID 0xfffff0
280 #define MIN_ASID 8
281 #define ASID_INC 8 /* number of regions */
283 /* Generate a GRU asid value from a GRU base asid & a virtual address. */
284 #if defined CONFIG_IA64
285 #define VADDR_HI_BIT 64
286 #elif defined CONFIG_X86_64
287 #define VADDR_HI_BIT 48
288 #else
289 #error "Unsupported architecture"
290 #endif
291 #define GRUREGION(addr) ((addr) >> (VADDR_HI_BIT - 3) & 3)
292 #define GRUASID(asid, addr) ((asid) + GRUREGION(addr))
294 /*------------------------------------------------------------------------------
295 * File & VMS Tables
298 struct gru_state;
301 * This structure is pointed to from the mmstruct via the notifier pointer.
302 * There is one of these per address space.
304 struct gru_mm_tracker { /* pack to reduce size */
305 unsigned int mt_asid_gen:24; /* ASID wrap count */
306 unsigned int mt_asid:24; /* current base ASID for gru */
307 unsigned short mt_ctxbitmap:16;/* bitmap of contexts using
308 asid */
309 } __attribute__ ((packed));
311 struct gru_mm_struct {
312 struct mmu_notifier ms_notifier;
313 atomic_t ms_refcnt;
314 spinlock_t ms_asid_lock; /* protects ASID assignment */
315 atomic_t ms_range_active;/* num range_invals active */
316 char ms_released;
317 wait_queue_head_t ms_wait_queue;
318 DECLARE_BITMAP(ms_asidmap, GRU_MAX_GRUS);
319 struct gru_mm_tracker ms_asids[GRU_MAX_GRUS];
323 * One of these structures is allocated when a GSEG is mmaped. The
324 * structure is pointed to by the vma->vm_private_data field in the vma struct.
326 struct gru_vma_data {
327 spinlock_t vd_lock; /* Serialize access to vma */
328 struct list_head vd_head; /* head of linked list of gts */
329 long vd_user_options;/* misc user option flags */
330 int vd_cbr_au_count;
331 int vd_dsr_au_count;
335 * One of these is allocated for each thread accessing a mmaped GRU. A linked
336 * list of these structure is hung off the struct gru_vma_data in the mm_struct.
338 struct gru_thread_state {
339 struct list_head ts_next; /* list - head at vma-private */
340 struct mutex ts_ctxlock; /* load/unload CTX lock */
341 struct mm_struct *ts_mm; /* mm currently mapped to
342 context */
343 struct vm_area_struct *ts_vma; /* vma of GRU context */
344 struct gru_state *ts_gru; /* GRU where the context is
345 loaded */
346 struct gru_mm_struct *ts_gms; /* asid & ioproc struct */
347 unsigned long ts_cbr_map; /* map of allocated CBRs */
348 unsigned long ts_dsr_map; /* map of allocated DATA
349 resources */
350 unsigned long ts_steal_jiffies;/* jiffies when context last
351 stolen */
352 long ts_user_options;/* misc user option flags */
353 pid_t ts_tgid_owner; /* task that is using the
354 context - for migration */
355 int ts_tsid; /* thread that owns the
356 structure */
357 int ts_tlb_int_select;/* target cpu if interrupts
358 enabled */
359 int ts_ctxnum; /* context number where the
360 context is loaded */
361 atomic_t ts_refcnt; /* reference count GTS */
362 unsigned char ts_dsr_au_count;/* Number of DSR resources
363 required for contest */
364 unsigned char ts_cbr_au_count;/* Number of CBR resources
365 required for contest */
366 char ts_blade; /* If >= 0, migrate context if
367 ref from diferent blade */
368 char ts_force_unload;/* force context to be unloaded
369 after migration */
370 char ts_cbr_idx[GRU_CBR_AU];/* CBR numbers of each
371 allocated CB */
372 unsigned long ts_gdata[0]; /* save area for GRU data (CB,
373 DS, CBE) */
377 * Threaded programs actually allocate an array of GSEGs when a context is
378 * created. Each thread uses a separate GSEG. TSID is the index into the GSEG
379 * array.
381 #define TSID(a, v) (((a) - (v)->vm_start) / GRU_GSEG_PAGESIZE)
382 #define UGRUADDR(gts) ((gts)->ts_vma->vm_start + \
383 (gts)->ts_tsid * GRU_GSEG_PAGESIZE)
385 #define NULLCTX (-1) /* if context not loaded into GRU */
387 /*-----------------------------------------------------------------------------
388 * GRU State Tables
392 * One of these exists for each GRU chiplet.
394 struct gru_state {
395 struct gru_blade_state *gs_blade; /* GRU state for entire
396 blade */
397 unsigned long gs_gru_base_paddr; /* Physical address of
398 gru segments (64) */
399 void *gs_gru_base_vaddr; /* Virtual address of
400 gru segments (64) */
401 unsigned char gs_gid; /* unique GRU number */
402 unsigned char gs_tgh_local_shift; /* used to pick TGH for
403 local flush */
404 unsigned char gs_tgh_first_remote; /* starting TGH# for
405 remote flush */
406 unsigned short gs_blade_id; /* blade of GRU */
407 spinlock_t gs_asid_lock; /* lock used for
408 assigning asids */
409 spinlock_t gs_lock; /* lock used for
410 assigning contexts */
412 /* -- the following are protected by the gs_asid_lock spinlock ---- */
413 unsigned int gs_asid; /* Next availe ASID */
414 unsigned int gs_asid_limit; /* Limit of available
415 ASIDs */
416 unsigned int gs_asid_gen; /* asid generation.
417 Inc on wrap */
419 /* --- the following fields are protected by the gs_lock spinlock --- */
420 unsigned long gs_context_map; /* bitmap to manage
421 contexts in use */
422 unsigned long gs_cbr_map; /* bitmap to manage CB
423 resources */
424 unsigned long gs_dsr_map; /* bitmap used to manage
425 DATA resources */
426 unsigned int gs_reserved_cbrs; /* Number of kernel-
427 reserved cbrs */
428 unsigned int gs_reserved_dsr_bytes; /* Bytes of kernel-
429 reserved dsrs */
430 unsigned short gs_active_contexts; /* number of contexts
431 in use */
432 struct gru_thread_state *gs_gts[GRU_NUM_CCH]; /* GTS currently using
433 the context */
437 * This structure contains the GRU state for all the GRUs on a blade.
439 struct gru_blade_state {
440 void *kernel_cb; /* First kernel
441 reserved cb */
442 void *kernel_dsr; /* First kernel
443 reserved DSR */
444 /* ---- the following are protected by the bs_lock spinlock ---- */
445 spinlock_t bs_lock; /* lock used for
446 stealing contexts */
447 int bs_lru_ctxnum; /* STEAL - last context
448 stolen */
449 struct gru_state *bs_lru_gru; /* STEAL - last gru
450 stolen */
452 struct gru_state bs_grus[GRU_CHIPLETS_PER_BLADE];
455 /*-----------------------------------------------------------------------------
456 * Address Primitives
458 #define get_tfm_for_cpu(g, c) \
459 ((struct gru_tlb_fault_map *)get_tfm((g)->gs_gru_base_vaddr, (c)))
460 #define get_tfh_by_index(g, i) \
461 ((struct gru_tlb_fault_handle *)get_tfh((g)->gs_gru_base_vaddr, (i)))
462 #define get_tgh_by_index(g, i) \
463 ((struct gru_tlb_global_handle *)get_tgh((g)->gs_gru_base_vaddr, (i)))
464 #define get_cbe_by_index(g, i) \
465 ((struct gru_control_block_extended *)get_cbe((g)->gs_gru_base_vaddr,\
466 (i)))
468 /*-----------------------------------------------------------------------------
469 * Useful Macros
472 /* Given a blade# & chiplet#, get a pointer to the GRU */
473 #define get_gru(b, c) (&gru_base[b]->bs_grus[c])
475 /* Number of bytes to save/restore when unloading/loading GRU contexts */
476 #define DSR_BYTES(dsr) ((dsr) * GRU_DSR_AU_BYTES)
477 #define CBR_BYTES(cbr) ((cbr) * GRU_HANDLE_BYTES * GRU_CBR_AU_SIZE * 2)
479 /* Convert a user CB number to the actual CBRNUM */
480 #define thread_cbr_number(gts, n) ((gts)->ts_cbr_idx[(n) / GRU_CBR_AU_SIZE] \
481 * GRU_CBR_AU_SIZE + (n) % GRU_CBR_AU_SIZE)
483 /* Convert a gid to a pointer to the GRU */
484 #define GID_TO_GRU(gid) \
485 (gru_base[(gid) / GRU_CHIPLETS_PER_BLADE] ? \
486 (&gru_base[(gid) / GRU_CHIPLETS_PER_BLADE]-> \
487 bs_grus[(gid) % GRU_CHIPLETS_PER_BLADE]) : \
488 NULL)
490 /* Scan all active GRUs in a GRU bitmap */
491 #define for_each_gru_in_bitmap(gid, map) \
492 for ((gid) = find_first_bit((map), GRU_MAX_GRUS); (gid) < GRU_MAX_GRUS;\
493 (gid)++, (gid) = find_next_bit((map), GRU_MAX_GRUS, (gid)))
495 /* Scan all active GRUs on a specific blade */
496 #define for_each_gru_on_blade(gru, nid, i) \
497 for ((gru) = gru_base[nid]->bs_grus, (i) = 0; \
498 (i) < GRU_CHIPLETS_PER_BLADE; \
499 (i)++, (gru)++)
501 /* Scan all active GTSs on a gru. Note: must hold ss_lock to use this macro. */
502 #define for_each_gts_on_gru(gts, gru, ctxnum) \
503 for ((ctxnum) = 0; (ctxnum) < GRU_NUM_CCH; (ctxnum)++) \
504 if (((gts) = (gru)->gs_gts[ctxnum]))
506 /* Scan each CBR whose bit is set in a TFM (or copy of) */
507 #define for_each_cbr_in_tfm(i, map) \
508 for ((i) = find_first_bit(map, GRU_NUM_CBE); \
509 (i) < GRU_NUM_CBE; \
510 (i)++, (i) = find_next_bit(map, GRU_NUM_CBE, i))
512 /* Scan each CBR in a CBR bitmap. Note: multiple CBRs in an allocation unit */
513 #define for_each_cbr_in_allocation_map(i, map, k) \
514 for ((k) = find_first_bit(map, GRU_CBR_AU); (k) < GRU_CBR_AU; \
515 (k) = find_next_bit(map, GRU_CBR_AU, (k) + 1)) \
516 for ((i) = (k)*GRU_CBR_AU_SIZE; \
517 (i) < ((k) + 1) * GRU_CBR_AU_SIZE; (i)++)
519 /* Scan each DSR in a DSR bitmap. Note: multiple DSRs in an allocation unit */
520 #define for_each_dsr_in_allocation_map(i, map, k) \
521 for ((k) = find_first_bit((const unsigned long *)map, GRU_DSR_AU);\
522 (k) < GRU_DSR_AU; \
523 (k) = find_next_bit((const unsigned long *)map, \
524 GRU_DSR_AU, (k) + 1)) \
525 for ((i) = (k) * GRU_DSR_AU_CL; \
526 (i) < ((k) + 1) * GRU_DSR_AU_CL; (i)++)
528 #define gseg_physical_address(gru, ctxnum) \
529 ((gru)->gs_gru_base_paddr + ctxnum * GRU_GSEG_STRIDE)
530 #define gseg_virtual_address(gru, ctxnum) \
531 ((gru)->gs_gru_base_vaddr + ctxnum * GRU_GSEG_STRIDE)
533 /*-----------------------------------------------------------------------------
534 * Lock / Unlock GRU handles
535 * Use the "delresp" bit in the handle as a "lock" bit.
538 /* Lock hierarchy checking enabled only in emulator */
540 static inline void __lock_handle(void *h)
542 while (test_and_set_bit(1, h))
543 cpu_relax();
546 static inline void __unlock_handle(void *h)
548 clear_bit(1, h);
551 static inline void lock_cch_handle(struct gru_context_configuration_handle *cch)
553 __lock_handle(cch);
556 static inline void unlock_cch_handle(struct gru_context_configuration_handle
557 *cch)
559 __unlock_handle(cch);
562 static inline void lock_tgh_handle(struct gru_tlb_global_handle *tgh)
564 __lock_handle(tgh);
567 static inline void unlock_tgh_handle(struct gru_tlb_global_handle *tgh)
569 __unlock_handle(tgh);
572 /*-----------------------------------------------------------------------------
573 * Function prototypes & externs
575 struct gru_unload_context_req;
577 extern struct vm_operations_struct gru_vm_ops;
578 extern struct device *grudev;
580 extern struct gru_vma_data *gru_alloc_vma_data(struct vm_area_struct *vma,
581 int tsid);
582 extern struct gru_thread_state *gru_find_thread_state(struct vm_area_struct
583 *vma, int tsid);
584 extern struct gru_thread_state *gru_alloc_thread_state(struct vm_area_struct
585 *vma, int tsid);
586 extern void gru_unload_context(struct gru_thread_state *gts, int savestate);
587 extern void gts_drop(struct gru_thread_state *gts);
588 extern void gru_tgh_flush_init(struct gru_state *gru);
589 extern int gru_kservices_init(struct gru_state *gru);
590 extern irqreturn_t gru_intr(int irq, void *dev_id);
591 extern int gru_handle_user_call_os(unsigned long address);
592 extern int gru_user_flush_tlb(unsigned long arg);
593 extern int gru_user_unload_context(unsigned long arg);
594 extern int gru_get_exception_detail(unsigned long arg);
595 extern int gru_set_task_slice(long address);
596 extern int gru_cpu_fault_map_id(void);
597 extern struct vm_area_struct *gru_find_vma(unsigned long vaddr);
598 extern void gru_flush_all_tlb(struct gru_state *gru);
599 extern int gru_proc_init(void);
600 extern void gru_proc_exit(void);
602 extern unsigned long gru_reserve_cb_resources(struct gru_state *gru,
603 int cbr_au_count, char *cbmap);
604 extern unsigned long gru_reserve_ds_resources(struct gru_state *gru,
605 int dsr_au_count, char *dsmap);
606 extern int gru_fault(struct vm_area_struct *, struct vm_fault *vmf);
607 extern struct gru_mm_struct *gru_register_mmu_notifier(void);
608 extern void gru_drop_mmu_notifier(struct gru_mm_struct *gms);
610 extern void gru_flush_tlb_range(struct gru_mm_struct *gms, unsigned long start,
611 unsigned long len);
613 extern unsigned long gru_options;
615 #endif /* __GRUTABLES_H__ */