2 * This file is subject to the terms and conditions of the GNU General Public
3 * License. See the file "COPYING" in the main directory of this archive
6 * Copyright (c) 2004-2008 Silicon Graphics, Inc. All Rights Reserved.
10 * Cross Partition Communication (XPC) structures and macros.
13 #ifndef _DRIVERS_MISC_SGIXP_XPC_H
14 #define _DRIVERS_MISC_SGIXP_XPC_H
16 #include <linux/interrupt.h>
17 #include <linux/sysctl.h>
18 #include <linux/device.h>
19 #include <linux/mutex.h>
20 #include <linux/completion.h>
21 #include <asm/pgtable.h>
22 #include <asm/processor.h>
23 #include <asm/sn/bte.h>
24 #include <asm/sn/clksupport.h>
25 #include <asm/sn/addrs.h>
26 #include <asm/sn/mspec.h>
27 #include <asm/sn/shub_mmr.h>
31 * XPC Version numbers consist of a major and minor number. XPC can always
32 * talk to versions with same major #, and never talk to versions with a
35 #define _XPC_VERSION(_maj, _min) (((_maj) << 4) | ((_min) & 0xf))
36 #define XPC_VERSION_MAJOR(_v) ((_v) >> 4)
37 #define XPC_VERSION_MINOR(_v) ((_v) & 0xf)
40 * The next macros define word or bit representations for given
41 * C-brick nasid in either the SAL provided bit array representing
42 * nasids in the partition/machine or the AMO_t array used for
43 * inter-partition initiation communications.
45 * For SN2 machines, C-Bricks are alway even numbered NASIDs. As
46 * such, some space will be saved by insisting that nasid information
47 * passed from SAL always be packed for C-Bricks and the
48 * cross-partition interrupts use the same packing scheme.
50 #define XPC_NASID_W_INDEX(_n) (((_n) / 64) / 2)
51 #define XPC_NASID_B_INDEX(_n) (((_n) / 2) & (64 - 1))
52 #define XPC_NASID_IN_ARRAY(_n, _p) ((_p)[XPC_NASID_W_INDEX(_n)] & \
53 (1UL << XPC_NASID_B_INDEX(_n)))
54 #define XPC_NASID_FROM_W_B(_w, _b) (((_w) * 64 + (_b)) * 2)
56 #define XPC_HB_DEFAULT_INTERVAL 5 /* incr HB every x secs */
57 #define XPC_HB_CHECK_DEFAULT_INTERVAL 20 /* check HB every x secs */
59 /* define the process name of HB checker and the CPU it is pinned to */
60 #define XPC_HB_CHECK_THREAD_NAME "xpc_hb"
61 #define XPC_HB_CHECK_CPU 0
63 /* define the process name of the discovery thread */
64 #define XPC_DISCOVERY_THREAD_NAME "xpc_discovery"
69 * SAL reserves one page of memory per partition for XPC. Though a full page
70 * in length (16384 bytes), its starting address is not page aligned, but it
71 * is cacheline aligned. The reserved page consists of the following:
73 * reserved page header
75 * The first cacheline of the reserved page contains the header
76 * (struct xpc_rsvd_page). Before SAL initialization has completed,
77 * SAL has set up the following fields of the reserved page header:
78 * SAL_signature, SAL_version, partid, and nasids_size. The other
79 * fields are set up by XPC. (xpc_rsvd_page points to the local
80 * partition's reserved page.)
85 * SAL also sets up two bitmaps (or masks), one that reflects the actual
86 * nasids in this partition (part_nasids), and the other that reflects
87 * the actual nasids in the entire machine (mach_nasids). We're only
88 * interested in the even numbered nasids (which contain the processors
89 * and/or memory), so we only need half as many bits to represent the
90 * nasids. The part_nasids mask is located starting at the first cacheline
91 * following the reserved page header. The mach_nasids mask follows right
92 * after the part_nasids mask. The size in bytes of each mask is reflected
93 * by the reserved page header field 'nasids_size'. (Local partition's
94 * mask pointers are xpc_part_nasids and xpc_mach_nasids.)
99 * Immediately following the mach_nasids mask are the XPC variables
100 * required by other partitions. First are those that are generic to all
101 * partitions (vars), followed on the next available cacheline by those
102 * which are partition specific (vars part). These are setup by XPC.
103 * (Local partition's vars pointers are xpc_vars and xpc_vars_part.)
105 * Note: Until vars_pa is set, the partition XPC code has not been initialized.
107 struct xpc_rsvd_page {
108 u64 SAL_signature; /* SAL: unique signature */
109 u64 SAL_version; /* SAL: version */
110 u8 partid; /* SAL: partition ID */
112 u8 pad1[6]; /* align to next u64 in cacheline */
113 volatile u64 vars_pa;
114 struct timespec stamp; /* time when reserved page was setup by XPC */
115 u64 pad2[9]; /* align to last u64 in cacheline */
116 u64 nasids_size; /* SAL: size of each nasid mask in bytes */
119 #define XPC_RP_VERSION _XPC_VERSION(1,1) /* version 1.1 of the reserved page */
121 #define XPC_SUPPORTS_RP_STAMP(_version) \
122 (_version >= _XPC_VERSION(1,1))
125 * compare stamps - the return value is:
127 * < 0, if stamp1 < stamp2
128 * = 0, if stamp1 == stamp2
129 * > 0, if stamp1 > stamp2
132 xpc_compare_stamps(struct timespec *stamp1, struct timespec *stamp2)
136 if ((ret = stamp1->tv_sec - stamp2->tv_sec) == 0) {
137 ret = stamp1->tv_nsec - stamp2->tv_nsec;
143 * Define the structures by which XPC variables can be exported to other
144 * partitions. (There are two: struct xpc_vars and struct xpc_vars_part)
148 * The following structure describes the partition generic variables
149 * needed by other partitions in order to properly initialize.
151 * struct xpc_vars version number also applies to struct xpc_vars_part.
152 * Changes to either structure and/or related functionality should be
153 * reflected by incrementing either the major or minor version numbers
154 * of struct xpc_vars.
159 u64 heartbeating_to_mask;
160 u64 heartbeat_offline; /* if 0, heartbeat should be changing */
164 u64 amos_page_pa; /* paddr of page of AMOs from MSPEC driver */
165 AMO_t *amos_page; /* vaddr of page of AMOs from MSPEC driver */
168 #define XPC_V_VERSION _XPC_VERSION(3,1) /* version 3.1 of the cross vars */
170 #define XPC_SUPPORTS_DISENGAGE_REQUEST(_version) \
171 (_version >= _XPC_VERSION(3,1))
174 xpc_hb_allowed(partid_t partid, struct xpc_vars *vars)
176 return ((vars->heartbeating_to_mask & (1UL << partid)) != 0);
180 xpc_allow_hb(partid_t partid, struct xpc_vars *vars)
182 u64 old_mask, new_mask;
185 old_mask = vars->heartbeating_to_mask;
186 new_mask = (old_mask | (1UL << partid));
187 } while (cmpxchg(&vars->heartbeating_to_mask, old_mask, new_mask) !=
192 xpc_disallow_hb(partid_t partid, struct xpc_vars *vars)
194 u64 old_mask, new_mask;
197 old_mask = vars->heartbeating_to_mask;
198 new_mask = (old_mask & ~(1UL << partid));
199 } while (cmpxchg(&vars->heartbeating_to_mask, old_mask, new_mask) !=
204 * The AMOs page consists of a number of AMO variables which are divided into
205 * four groups, The first two groups are used to identify an IRQ's sender.
206 * These two groups consist of 64 and 128 AMO variables respectively. The last
207 * two groups, consisting of just one AMO variable each, are used to identify
208 * the remote partitions that are currently engaged (from the viewpoint of
209 * the XPC running on the remote partition).
211 #define XPC_NOTIFY_IRQ_AMOS 0
212 #define XPC_ACTIVATE_IRQ_AMOS (XPC_NOTIFY_IRQ_AMOS + XP_MAX_PARTITIONS)
213 #define XPC_ENGAGED_PARTITIONS_AMO (XPC_ACTIVATE_IRQ_AMOS + XP_NASID_MASK_WORDS)
214 #define XPC_DISENGAGE_REQUEST_AMO (XPC_ENGAGED_PARTITIONS_AMO + 1)
217 * The following structure describes the per partition specific variables.
219 * An array of these structures, one per partition, will be defined. As a
220 * partition becomes active XPC will copy the array entry corresponding to
221 * itself from that partition. It is desirable that the size of this
222 * structure evenly divide into a cacheline, such that none of the entries
223 * in this array crosses a cacheline boundary. As it is now, each entry
224 * occupies half a cacheline.
226 struct xpc_vars_part {
229 u64 openclose_args_pa; /* physical address of open and close args */
230 u64 GPs_pa; /* physical address of Get/Put values */
232 u64 IPI_amo_pa; /* physical address of IPI AMO_t structure */
233 int IPI_nasid; /* nasid of where to send IPIs */
234 int IPI_phys_cpuid; /* physical CPU ID of where to send IPIs */
236 u8 nchannels; /* #of defined channels supported */
238 u8 reserved[23]; /* pad to a full 64 bytes */
242 * The vars_part MAGIC numbers play a part in the first contact protocol.
244 * MAGIC1 indicates that the per partition specific variables for a remote
245 * partition have been initialized by this partition.
247 * MAGIC2 indicates that this partition has pulled the remote partititions
248 * per partition variables that pertain to this partition.
250 #define XPC_VP_MAGIC1 0x0053524156435058L /* 'XPCVARS\0'L (little endian) */
251 #define XPC_VP_MAGIC2 0x0073726176435058L /* 'XPCvars\0'L (little endian) */
253 /* the reserved page sizes and offsets */
255 #define XPC_RP_HEADER_SIZE L1_CACHE_ALIGN(sizeof(struct xpc_rsvd_page))
256 #define XPC_RP_VARS_SIZE L1_CACHE_ALIGN(sizeof(struct xpc_vars))
258 #define XPC_RP_PART_NASIDS(_rp) (u64 *) ((u8 *) _rp + XPC_RP_HEADER_SIZE)
259 #define XPC_RP_MACH_NASIDS(_rp) (XPC_RP_PART_NASIDS(_rp) + xp_nasid_mask_words)
260 #define XPC_RP_VARS(_rp) ((struct xpc_vars *) XPC_RP_MACH_NASIDS(_rp) + xp_nasid_mask_words)
261 #define XPC_RP_VARS_PART(_rp) (struct xpc_vars_part *) ((u8 *) XPC_RP_VARS(rp) + XPC_RP_VARS_SIZE)
264 * Functions registered by add_timer() or called by kernel_thread() only
265 * allow for a single 64-bit argument. The following macros can be used to
266 * pack and unpack two (32-bit, 16-bit or 8-bit) arguments into or out from
267 * the passed argument.
269 #define XPC_PACK_ARGS(_arg1, _arg2) \
270 ((((u64) _arg1) & 0xffffffff) | \
271 ((((u64) _arg2) & 0xffffffff) << 32))
273 #define XPC_UNPACK_ARG1(_args) (((u64) _args) & 0xffffffff)
274 #define XPC_UNPACK_ARG2(_args) ((((u64) _args) >> 32) & 0xffffffff)
277 * Define a Get/Put value pair (pointers) used with a message queue.
280 volatile s64 get; /* Get value */
281 volatile s64 put; /* Put value */
284 #define XPC_GP_SIZE \
285 L1_CACHE_ALIGN(sizeof(struct xpc_gp) * XPC_NCHANNELS)
288 * Define a structure that contains arguments associated with opening and
291 struct xpc_openclose_args {
292 u16 reason; /* reason why channel is closing */
293 u16 msg_size; /* sizeof each message entry */
294 u16 remote_nentries; /* #of message entries in remote msg queue */
295 u16 local_nentries; /* #of message entries in local msg queue */
296 u64 local_msgqueue_pa; /* physical address of local message queue */
299 #define XPC_OPENCLOSE_ARGS_SIZE \
300 L1_CACHE_ALIGN(sizeof(struct xpc_openclose_args) * XPC_NCHANNELS)
302 /* struct xpc_msg flags */
304 #define XPC_M_DONE 0x01 /* msg has been received/consumed */
305 #define XPC_M_READY 0x02 /* msg is ready to be sent */
306 #define XPC_M_INTERRUPT 0x04 /* send interrupt when msg consumed */
308 #define XPC_MSG_ADDRESS(_payload) \
309 ((struct xpc_msg *)((u8 *)(_payload) - XPC_MSG_PAYLOAD_OFFSET))
312 * Defines notify entry.
314 * This is used to notify a message's sender that their message was received
315 * and consumed by the intended recipient.
318 volatile u8 type; /* type of notification */
320 /* the following two fields are only used if type == XPC_N_CALL */
321 xpc_notify_func func; /* user's notify function */
322 void *key; /* pointer to user's key */
325 /* struct xpc_notify type of notification */
327 #define XPC_N_CALL 0x01 /* notify function provided by user */
330 * Define the structure that manages all the stuff required by a channel. In
331 * particular, they are used to manage the messages sent across the channel.
333 * This structure is private to a partition, and is NOT shared across the
334 * partition boundary.
336 * There is an array of these structures for each remote partition. It is
337 * allocated at the time a partition becomes active. The array contains one
338 * of these structures for each potential channel connection to that partition.
340 * Each of these structures manages two message queues (circular buffers).
341 * They are allocated at the time a channel connection is made. One of
342 * these message queues (local_msgqueue) holds the locally created messages
343 * that are destined for the remote partition. The other of these message
344 * queues (remote_msgqueue) is a locally cached copy of the remote partition's
345 * own local_msgqueue.
347 * The following is a description of the Get/Put pointers used to manage these
348 * two message queues. Consider the local_msgqueue to be on one partition
349 * and the remote_msgqueue to be its cached copy on another partition. A
350 * description of what each of the lettered areas contains is included.
353 * local_msgqueue remote_msgqueue
355 * |/////////| |/////////|
356 * w_remote_GP.get --> +---------+ |/////////|
358 * remote_GP.get --> +---------+ +---------+ <-- local_GP->get
362 * | | +---------+ <-- w_local_GP.get
366 * | | +---------+ <-- w_remote_GP.put
368 * local_GP->put --> +---------+ +---------+ <-- remote_GP.put
372 * w_local_GP.put --> +---------+ |/////////|
373 * |/////////| |/////////|
376 * ( remote_GP.[get|put] are cached copies of the remote
377 * partition's local_GP->[get|put], and thus their values can
378 * lag behind their counterparts on the remote partition. )
381 * A - Messages that have been allocated, but have not yet been sent to the
384 * B - Messages that have been sent, but have not yet been acknowledged by the
385 * remote partition as having been received.
387 * C - Area that needs to be prepared for the copying of sent messages, by
388 * the clearing of the message flags of any previously received messages.
390 * D - Area into which sent messages are to be copied from the remote
391 * partition's local_msgqueue and then delivered to their intended
392 * recipients. [ To allow for a multi-message copy, another pointer
393 * (next_msg_to_pull) has been added to keep track of the next message
394 * number needing to be copied (pulled). It chases after w_remote_GP.put.
395 * Any messages lying between w_local_GP.get and next_msg_to_pull have
396 * been copied and are ready to be delivered. ]
398 * E - Messages that have been copied and delivered, but have not yet been
399 * acknowledged by the recipient as having been received.
401 * F - Messages that have been acknowledged, but XPC has not yet notified the
402 * sender that the message was received by its intended recipient.
403 * This is also an area that needs to be prepared for the allocating of
404 * new messages, by the clearing of the message flags of the acknowledged
408 partid_t partid; /* ID of remote partition connected */
409 spinlock_t lock; /* lock for updating this structure */
410 u32 flags; /* general flags */
412 enum xpc_retval reason; /* reason why channel is disconnect'g */
413 int reason_line; /* line# disconnect initiated from */
415 u16 number; /* channel # */
417 u16 msg_size; /* sizeof each msg entry */
418 u16 local_nentries; /* #of msg entries in local msg queue */
419 u16 remote_nentries; /* #of msg entries in remote msg queue */
421 void *local_msgqueue_base; /* base address of kmalloc'd space */
422 struct xpc_msg *local_msgqueue; /* local message queue */
423 void *remote_msgqueue_base; /* base address of kmalloc'd space */
424 struct xpc_msg *remote_msgqueue; /* cached copy of remote partition's */
425 /* local message queue */
426 u64 remote_msgqueue_pa; /* phys addr of remote partition's */
427 /* local message queue */
429 atomic_t references; /* #of external references to queues */
431 atomic_t n_on_msg_allocate_wq; /* #on msg allocation wait queue */
432 wait_queue_head_t msg_allocate_wq; /* msg allocation wait queue */
434 u8 delayed_IPI_flags; /* IPI flags received, but delayed */
435 /* action until channel disconnected */
437 /* queue of msg senders who want to be notified when msg received */
439 atomic_t n_to_notify; /* #of msg senders to notify */
440 struct xpc_notify *notify_queue; /* notify queue for messages sent */
442 xpc_channel_func func; /* user's channel function */
443 void *key; /* pointer to user's key */
445 struct mutex msg_to_pull_mutex; /* next msg to pull serialization */
446 struct completion wdisconnect_wait; /* wait for channel disconnect */
448 struct xpc_openclose_args *local_openclose_args; /* args passed on */
449 /* opening or closing of channel */
451 /* various flavors of local and remote Get/Put values */
453 struct xpc_gp *local_GP; /* local Get/Put values */
454 struct xpc_gp remote_GP; /* remote Get/Put values */
455 struct xpc_gp w_local_GP; /* working local Get/Put values */
456 struct xpc_gp w_remote_GP; /* working remote Get/Put values */
457 s64 next_msg_to_pull; /* Put value of next msg to pull */
459 /* kthread management related fields */
461 // >>> rethink having kthreads_assigned_limit and kthreads_idle_limit; perhaps
462 // >>> allow the assigned limit be unbounded and let the idle limit be dynamic
463 // >>> dependent on activity over the last interval of time
464 atomic_t kthreads_assigned; /* #of kthreads assigned to channel */
465 u32 kthreads_assigned_limit; /* limit on #of kthreads assigned */
466 atomic_t kthreads_idle; /* #of kthreads idle waiting for work */
467 u32 kthreads_idle_limit; /* limit on #of kthreads idle */
468 atomic_t kthreads_active; /* #of kthreads actively working */
469 // >>> following field is temporary
470 u32 kthreads_created; /* total #of kthreads created */
472 wait_queue_head_t idle_wq; /* idle kthread wait queue */
474 } ____cacheline_aligned;
476 /* struct xpc_channel flags */
478 #define XPC_C_WASCONNECTED 0x00000001 /* channel was connected */
480 #define XPC_C_ROPENREPLY 0x00000002 /* remote open channel reply */
481 #define XPC_C_OPENREPLY 0x00000004 /* local open channel reply */
482 #define XPC_C_ROPENREQUEST 0x00000008 /* remote open channel request */
483 #define XPC_C_OPENREQUEST 0x00000010 /* local open channel request */
485 #define XPC_C_SETUP 0x00000020 /* channel's msgqueues are alloc'd */
486 #define XPC_C_CONNECTEDCALLOUT 0x00000040 /* connected callout initiated */
487 #define XPC_C_CONNECTEDCALLOUT_MADE \
488 0x00000080 /* connected callout completed */
489 #define XPC_C_CONNECTED 0x00000100 /* local channel is connected */
490 #define XPC_C_CONNECTING 0x00000200 /* channel is being connected */
492 #define XPC_C_RCLOSEREPLY 0x00000400 /* remote close channel reply */
493 #define XPC_C_CLOSEREPLY 0x00000800 /* local close channel reply */
494 #define XPC_C_RCLOSEREQUEST 0x00001000 /* remote close channel request */
495 #define XPC_C_CLOSEREQUEST 0x00002000 /* local close channel request */
497 #define XPC_C_DISCONNECTED 0x00004000 /* channel is disconnected */
498 #define XPC_C_DISCONNECTING 0x00008000 /* channel is being disconnected */
499 #define XPC_C_DISCONNECTINGCALLOUT \
500 0x00010000 /* disconnecting callout initiated */
501 #define XPC_C_DISCONNECTINGCALLOUT_MADE \
502 0x00020000 /* disconnecting callout completed */
503 #define XPC_C_WDISCONNECT 0x00040000 /* waiting for channel disconnect */
506 * Manages channels on a partition basis. There is one of these structures
507 * for each partition (a partition will never utilize the structure that
508 * represents itself).
510 struct xpc_partition {
512 /* XPC HB infrastructure */
514 u8 remote_rp_version; /* version# of partition's rsvd pg */
515 struct timespec remote_rp_stamp; /* time when rsvd pg was initialized */
516 u64 remote_rp_pa; /* phys addr of partition's rsvd pg */
517 u64 remote_vars_pa; /* phys addr of partition's vars */
518 u64 remote_vars_part_pa; /* phys addr of partition's vars part */
519 u64 last_heartbeat; /* HB at last read */
520 u64 remote_amos_page_pa; /* phys addr of partition's amos page */
521 int remote_act_nasid; /* active part's act/deact nasid */
522 int remote_act_phys_cpuid; /* active part's act/deact phys cpuid */
523 u32 act_IRQ_rcvd; /* IRQs since activation */
524 spinlock_t act_lock; /* protect updating of act_state */
525 u8 act_state; /* from XPC HB viewpoint */
526 u8 remote_vars_version; /* version# of partition's vars */
527 enum xpc_retval reason; /* reason partition is deactivating */
528 int reason_line; /* line# deactivation initiated from */
529 int reactivate_nasid; /* nasid in partition to reactivate */
531 unsigned long disengage_request_timeout; /* timeout in jiffies */
532 struct timer_list disengage_request_timer;
534 /* XPC infrastructure referencing and teardown control */
536 volatile u8 setup_state; /* infrastructure setup state */
537 wait_queue_head_t teardown_wq; /* kthread waiting to teardown infra */
538 atomic_t references; /* #of references to infrastructure */
541 * NONE OF THE PRECEDING FIELDS OF THIS STRUCTURE WILL BE CLEARED WHEN
542 * XPC SETS UP THE NECESSARY INFRASTRUCTURE TO SUPPORT CROSS PARTITION
543 * COMMUNICATION. ALL OF THE FOLLOWING FIELDS WILL BE CLEARED. (THE
544 * 'nchannels' FIELD MUST BE THE FIRST OF THE FIELDS TO BE CLEARED.)
547 u8 nchannels; /* #of defined channels supported */
548 atomic_t nchannels_active; /* #of channels that are not DISCONNECTED */
549 atomic_t nchannels_engaged; /* #of channels engaged with remote part */
550 struct xpc_channel *channels; /* array of channel structures */
552 void *local_GPs_base; /* base address of kmalloc'd space */
553 struct xpc_gp *local_GPs; /* local Get/Put values */
554 void *remote_GPs_base; /* base address of kmalloc'd space */
555 struct xpc_gp *remote_GPs; /* copy of remote partition's local Get/Put */
557 u64 remote_GPs_pa; /* phys address of remote partition's local */
560 /* fields used to pass args when opening or closing a channel */
562 void *local_openclose_args_base; /* base address of kmalloc'd space */
563 struct xpc_openclose_args *local_openclose_args; /* local's args */
564 void *remote_openclose_args_base; /* base address of kmalloc'd space */
565 struct xpc_openclose_args *remote_openclose_args; /* copy of remote's */
567 u64 remote_openclose_args_pa; /* phys addr of remote's args */
569 /* IPI sending, receiving and handling related fields */
571 int remote_IPI_nasid; /* nasid of where to send IPIs */
572 int remote_IPI_phys_cpuid; /* phys CPU ID of where to send IPIs */
573 AMO_t *remote_IPI_amo_va; /* address of remote IPI AMO_t structure */
575 AMO_t *local_IPI_amo_va; /* address of IPI AMO_t structure */
576 u64 local_IPI_amo; /* IPI amo flags yet to be handled */
577 char IPI_owner[8]; /* IPI owner's name */
578 struct timer_list dropped_IPI_timer; /* dropped IPI timer */
580 spinlock_t IPI_lock; /* IPI handler lock */
582 /* channel manager related fields */
584 atomic_t channel_mgr_requests; /* #of requests to activate chan mgr */
585 wait_queue_head_t channel_mgr_wq; /* channel mgr's wait queue */
587 } ____cacheline_aligned;
589 /* struct xpc_partition act_state values (for XPC HB) */
591 #define XPC_P_INACTIVE 0x00 /* partition is not active */
592 #define XPC_P_ACTIVATION_REQ 0x01 /* created thread to activate */
593 #define XPC_P_ACTIVATING 0x02 /* activation thread started */
594 #define XPC_P_ACTIVE 0x03 /* xpc_partition_up() was called */
595 #define XPC_P_DEACTIVATING 0x04 /* partition deactivation initiated */
597 #define XPC_DEACTIVATE_PARTITION(_p, _reason) \
598 xpc_deactivate_partition(__LINE__, (_p), (_reason))
600 /* struct xpc_partition setup_state values */
602 #define XPC_P_UNSET 0x00 /* infrastructure was never setup */
603 #define XPC_P_SETUP 0x01 /* infrastructure is setup */
604 #define XPC_P_WTEARDOWN 0x02 /* waiting to teardown infrastructure */
605 #define XPC_P_TORNDOWN 0x03 /* infrastructure is torndown */
608 * struct xpc_partition IPI_timer #of seconds to wait before checking for
609 * dropped IPIs. These occur whenever an IPI amo write doesn't complete until
610 * after the IPI was received.
612 #define XPC_P_DROPPED_IPI_WAIT (0.25 * HZ)
614 /* number of seconds to wait for other partitions to disengage */
615 #define XPC_DISENGAGE_REQUEST_DEFAULT_TIMELIMIT 90
617 /* interval in seconds to print 'waiting disengagement' messages */
618 #define XPC_DISENGAGE_PRINTMSG_INTERVAL 10
620 #define XPC_PARTID(_p) ((partid_t) ((_p) - &xpc_partitions[0]))
622 /* found in xp_main.c */
623 extern struct xpc_registration xpc_registrations[];
625 /* found in xpc_main.c */
626 extern struct device *xpc_part;
627 extern struct device *xpc_chan;
628 extern int xpc_disengage_request_timelimit;
629 extern int xpc_disengage_request_timedout;
630 extern irqreturn_t xpc_notify_IRQ_handler(int, void *);
631 extern void xpc_dropped_IPI_check(struct xpc_partition *);
632 extern void xpc_activate_partition(struct xpc_partition *);
633 extern void xpc_activate_kthreads(struct xpc_channel *, int);
634 extern void xpc_create_kthreads(struct xpc_channel *, int, int);
635 extern void xpc_disconnect_wait(int);
637 /* found in xpc_partition.c */
638 extern int xpc_exiting;
639 extern struct xpc_vars *xpc_vars;
640 extern struct xpc_rsvd_page *xpc_rsvd_page;
641 extern struct xpc_vars_part *xpc_vars_part;
642 extern struct xpc_partition xpc_partitions[XP_MAX_PARTITIONS + 1];
643 extern char *xpc_remote_copy_buffer;
644 extern void *xpc_remote_copy_buffer_base;
645 extern void *xpc_kmalloc_cacheline_aligned(size_t, gfp_t, void **);
646 extern struct xpc_rsvd_page *xpc_rsvd_page_init(void);
647 extern void xpc_allow_IPI_ops(void);
648 extern void xpc_restrict_IPI_ops(void);
649 extern int xpc_identify_act_IRQ_sender(void);
650 extern int xpc_partition_disengaged(struct xpc_partition *);
651 extern enum xpc_retval xpc_mark_partition_active(struct xpc_partition *);
652 extern void xpc_mark_partition_inactive(struct xpc_partition *);
653 extern void xpc_discovery(void);
654 extern void xpc_check_remote_hb(void);
655 extern void xpc_deactivate_partition(const int, struct xpc_partition *,
657 extern enum xpc_retval xpc_initiate_partid_to_nasids(partid_t, void *);
659 /* found in xpc_channel.c */
660 extern void xpc_initiate_connect(int);
661 extern void xpc_initiate_disconnect(int);
662 extern enum xpc_retval xpc_initiate_allocate(partid_t, int, u32, void **);
663 extern enum xpc_retval xpc_initiate_send(partid_t, int, void *);
664 extern enum xpc_retval xpc_initiate_send_notify(partid_t, int, void *,
665 xpc_notify_func, void *);
666 extern void xpc_initiate_received(partid_t, int, void *);
667 extern enum xpc_retval xpc_setup_infrastructure(struct xpc_partition *);
668 extern enum xpc_retval xpc_pull_remote_vars_part(struct xpc_partition *);
669 extern void xpc_process_channel_activity(struct xpc_partition *);
670 extern void xpc_connected_callout(struct xpc_channel *);
671 extern void xpc_deliver_msg(struct xpc_channel *);
672 extern void xpc_disconnect_channel(const int, struct xpc_channel *,
673 enum xpc_retval, unsigned long *);
674 extern void xpc_disconnect_callout(struct xpc_channel *, enum xpc_retval);
675 extern void xpc_partition_going_down(struct xpc_partition *, enum xpc_retval);
676 extern void xpc_teardown_infrastructure(struct xpc_partition *);
679 xpc_wakeup_channel_mgr(struct xpc_partition *part)
681 if (atomic_inc_return(&part->channel_mgr_requests) == 1) {
682 wake_up(&part->channel_mgr_wq);
687 * These next two inlines are used to keep us from tearing down a channel's
688 * msg queues while a thread may be referencing them.
691 xpc_msgqueue_ref(struct xpc_channel *ch)
693 atomic_inc(&ch->references);
697 xpc_msgqueue_deref(struct xpc_channel *ch)
699 s32 refs = atomic_dec_return(&ch->references);
703 xpc_wakeup_channel_mgr(&xpc_partitions[ch->partid]);
707 #define XPC_DISCONNECT_CHANNEL(_ch, _reason, _irqflgs) \
708 xpc_disconnect_channel(__LINE__, _ch, _reason, _irqflgs)
711 * These two inlines are used to keep us from tearing down a partition's
712 * setup infrastructure while a thread may be referencing it.
715 xpc_part_deref(struct xpc_partition *part)
717 s32 refs = atomic_dec_return(&part->references);
720 if (refs == 0 && part->setup_state == XPC_P_WTEARDOWN) {
721 wake_up(&part->teardown_wq);
726 xpc_part_ref(struct xpc_partition *part)
730 atomic_inc(&part->references);
731 setup = (part->setup_state == XPC_P_SETUP);
733 xpc_part_deref(part);
739 * The following macro is to be used for the setting of the reason and
740 * reason_line fields in both the struct xpc_channel and struct xpc_partition
743 #define XPC_SET_REASON(_p, _reason, _line) \
745 (_p)->reason = _reason; \
746 (_p)->reason_line = _line; \
750 * This next set of inlines are used to keep track of when a partition is
751 * potentially engaged in accessing memory belonging to another partition.
755 xpc_mark_partition_engaged(struct xpc_partition *part)
757 unsigned long irq_flags;
758 AMO_t *amo = (AMO_t *)__va(part->remote_amos_page_pa +
759 (XPC_ENGAGED_PARTITIONS_AMO *
762 local_irq_save(irq_flags);
764 /* set bit corresponding to our partid in remote partition's AMO */
765 FETCHOP_STORE_OP(TO_AMO((u64)&amo->variable), FETCHOP_OR,
766 (1UL << sn_partition_id));
768 * We must always use the nofault function regardless of whether we
769 * are on a Shub 1.1 system or a Shub 1.2 slice 0xc processor. If we
770 * didn't, we'd never know that the other partition is down and would
771 * keep sending IPIs and AMOs to it until the heartbeat times out.
773 (void)xp_nofault_PIOR((u64 *)GLOBAL_MMR_ADDR(NASID_GET(&amo->
775 xp_nofault_PIOR_target));
777 local_irq_restore(irq_flags);
781 xpc_mark_partition_disengaged(struct xpc_partition *part)
783 unsigned long irq_flags;
784 AMO_t *amo = (AMO_t *)__va(part->remote_amos_page_pa +
785 (XPC_ENGAGED_PARTITIONS_AMO *
788 local_irq_save(irq_flags);
790 /* clear bit corresponding to our partid in remote partition's AMO */
791 FETCHOP_STORE_OP(TO_AMO((u64)&amo->variable), FETCHOP_AND,
792 ~(1UL << sn_partition_id));
794 * We must always use the nofault function regardless of whether we
795 * are on a Shub 1.1 system or a Shub 1.2 slice 0xc processor. If we
796 * didn't, we'd never know that the other partition is down and would
797 * keep sending IPIs and AMOs to it until the heartbeat times out.
799 (void)xp_nofault_PIOR((u64 *)GLOBAL_MMR_ADDR(NASID_GET(&amo->
801 xp_nofault_PIOR_target));
803 local_irq_restore(irq_flags);
807 xpc_request_partition_disengage(struct xpc_partition *part)
809 unsigned long irq_flags;
810 AMO_t *amo = (AMO_t *)__va(part->remote_amos_page_pa +
811 (XPC_DISENGAGE_REQUEST_AMO * sizeof(AMO_t)));
813 local_irq_save(irq_flags);
815 /* set bit corresponding to our partid in remote partition's AMO */
816 FETCHOP_STORE_OP(TO_AMO((u64)&amo->variable), FETCHOP_OR,
817 (1UL << sn_partition_id));
819 * We must always use the nofault function regardless of whether we
820 * are on a Shub 1.1 system or a Shub 1.2 slice 0xc processor. If we
821 * didn't, we'd never know that the other partition is down and would
822 * keep sending IPIs and AMOs to it until the heartbeat times out.
824 (void)xp_nofault_PIOR((u64 *)GLOBAL_MMR_ADDR(NASID_GET(&amo->
826 xp_nofault_PIOR_target));
828 local_irq_restore(irq_flags);
832 xpc_cancel_partition_disengage_request(struct xpc_partition *part)
834 unsigned long irq_flags;
835 AMO_t *amo = (AMO_t *)__va(part->remote_amos_page_pa +
836 (XPC_DISENGAGE_REQUEST_AMO * sizeof(AMO_t)));
838 local_irq_save(irq_flags);
840 /* clear bit corresponding to our partid in remote partition's AMO */
841 FETCHOP_STORE_OP(TO_AMO((u64)&amo->variable), FETCHOP_AND,
842 ~(1UL << sn_partition_id));
844 * We must always use the nofault function regardless of whether we
845 * are on a Shub 1.1 system or a Shub 1.2 slice 0xc processor. If we
846 * didn't, we'd never know that the other partition is down and would
847 * keep sending IPIs and AMOs to it until the heartbeat times out.
849 (void)xp_nofault_PIOR((u64 *)GLOBAL_MMR_ADDR(NASID_GET(&amo->
851 xp_nofault_PIOR_target));
853 local_irq_restore(irq_flags);
857 xpc_partition_engaged(u64 partid_mask)
859 AMO_t *amo = xpc_vars->amos_page + XPC_ENGAGED_PARTITIONS_AMO;
861 /* return our partition's AMO variable ANDed with partid_mask */
862 return (FETCHOP_LOAD_OP(TO_AMO((u64)&amo->variable), FETCHOP_LOAD) &
867 xpc_partition_disengage_requested(u64 partid_mask)
869 AMO_t *amo = xpc_vars->amos_page + XPC_DISENGAGE_REQUEST_AMO;
871 /* return our partition's AMO variable ANDed with partid_mask */
872 return (FETCHOP_LOAD_OP(TO_AMO((u64)&amo->variable), FETCHOP_LOAD) &
877 xpc_clear_partition_engaged(u64 partid_mask)
879 AMO_t *amo = xpc_vars->amos_page + XPC_ENGAGED_PARTITIONS_AMO;
881 /* clear bit(s) based on partid_mask in our partition's AMO */
882 FETCHOP_STORE_OP(TO_AMO((u64)&amo->variable), FETCHOP_AND,
887 xpc_clear_partition_disengage_request(u64 partid_mask)
889 AMO_t *amo = xpc_vars->amos_page + XPC_DISENGAGE_REQUEST_AMO;
891 /* clear bit(s) based on partid_mask in our partition's AMO */
892 FETCHOP_STORE_OP(TO_AMO((u64)&amo->variable), FETCHOP_AND,
897 * The following set of macros and inlines are used for the sending and
898 * receiving of IPIs (also known as IRQs). There are two flavors of IPIs,
899 * one that is associated with partition activity (SGI_XPC_ACTIVATE) and
900 * the other that is associated with channel activity (SGI_XPC_NOTIFY).
904 xpc_IPI_receive(AMO_t *amo)
906 return FETCHOP_LOAD_OP(TO_AMO((u64)&amo->variable), FETCHOP_CLEAR);
909 static inline enum xpc_retval
910 xpc_IPI_send(AMO_t *amo, u64 flag, int nasid, int phys_cpuid, int vector)
913 unsigned long irq_flags;
915 local_irq_save(irq_flags);
917 FETCHOP_STORE_OP(TO_AMO((u64)&amo->variable), FETCHOP_OR, flag);
918 sn_send_IPI_phys(nasid, phys_cpuid, vector, 0);
921 * We must always use the nofault function regardless of whether we
922 * are on a Shub 1.1 system or a Shub 1.2 slice 0xc processor. If we
923 * didn't, we'd never know that the other partition is down and would
924 * keep sending IPIs and AMOs to it until the heartbeat times out.
926 ret = xp_nofault_PIOR((u64 *)GLOBAL_MMR_ADDR(NASID_GET(&amo->variable),
927 xp_nofault_PIOR_target));
929 local_irq_restore(irq_flags);
931 return ((ret == 0) ? xpcSuccess : xpcPioReadError);
935 * IPIs associated with SGI_XPC_ACTIVATE IRQ.
939 * Flag the appropriate AMO variable and send an IPI to the specified node.
942 xpc_activate_IRQ_send(u64 amos_page_pa, int from_nasid, int to_nasid,
945 int w_index = XPC_NASID_W_INDEX(from_nasid);
946 int b_index = XPC_NASID_B_INDEX(from_nasid);
947 AMO_t *amos = (AMO_t *)__va(amos_page_pa +
948 (XPC_ACTIVATE_IRQ_AMOS * sizeof(AMO_t)));
950 (void)xpc_IPI_send(&amos[w_index], (1UL << b_index), to_nasid,
951 to_phys_cpuid, SGI_XPC_ACTIVATE);
955 xpc_IPI_send_activate(struct xpc_vars *vars)
957 xpc_activate_IRQ_send(vars->amos_page_pa, cnodeid_to_nasid(0),
958 vars->act_nasid, vars->act_phys_cpuid);
962 xpc_IPI_send_activated(struct xpc_partition *part)
964 xpc_activate_IRQ_send(part->remote_amos_page_pa, cnodeid_to_nasid(0),
965 part->remote_act_nasid,
966 part->remote_act_phys_cpuid);
970 xpc_IPI_send_reactivate(struct xpc_partition *part)
972 xpc_activate_IRQ_send(xpc_vars->amos_page_pa, part->reactivate_nasid,
973 xpc_vars->act_nasid, xpc_vars->act_phys_cpuid);
977 xpc_IPI_send_disengage(struct xpc_partition *part)
979 xpc_activate_IRQ_send(part->remote_amos_page_pa, cnodeid_to_nasid(0),
980 part->remote_act_nasid,
981 part->remote_act_phys_cpuid);
985 * IPIs associated with SGI_XPC_NOTIFY IRQ.
989 * Send an IPI to the remote partition that is associated with the
992 #define XPC_NOTIFY_IRQ_SEND(_ch, _ipi_f, _irq_f) \
993 xpc_notify_IRQ_send(_ch, _ipi_f, #_ipi_f, _irq_f)
996 xpc_notify_IRQ_send(struct xpc_channel *ch, u8 ipi_flag, char *ipi_flag_string,
997 unsigned long *irq_flags)
999 struct xpc_partition *part = &xpc_partitions[ch->partid];
1000 enum xpc_retval ret;
1002 if (likely(part->act_state != XPC_P_DEACTIVATING)) {
1003 ret = xpc_IPI_send(part->remote_IPI_amo_va,
1004 (u64)ipi_flag << (ch->number * 8),
1005 part->remote_IPI_nasid,
1006 part->remote_IPI_phys_cpuid, SGI_XPC_NOTIFY);
1007 dev_dbg(xpc_chan, "%s sent to partid=%d, channel=%d, ret=%d\n",
1008 ipi_flag_string, ch->partid, ch->number, ret);
1009 if (unlikely(ret != xpcSuccess)) {
1010 if (irq_flags != NULL) {
1011 spin_unlock_irqrestore(&ch->lock, *irq_flags);
1013 XPC_DEACTIVATE_PARTITION(part, ret);
1014 if (irq_flags != NULL) {
1015 spin_lock_irqsave(&ch->lock, *irq_flags);
1022 * Make it look like the remote partition, which is associated with the
1023 * specified channel, sent us an IPI. This faked IPI will be handled
1024 * by xpc_dropped_IPI_check().
1026 #define XPC_NOTIFY_IRQ_SEND_LOCAL(_ch, _ipi_f) \
1027 xpc_notify_IRQ_send_local(_ch, _ipi_f, #_ipi_f)
1030 xpc_notify_IRQ_send_local(struct xpc_channel *ch, u8 ipi_flag,
1031 char *ipi_flag_string)
1033 struct xpc_partition *part = &xpc_partitions[ch->partid];
1035 FETCHOP_STORE_OP(TO_AMO((u64)&part->local_IPI_amo_va->variable),
1036 FETCHOP_OR, ((u64)ipi_flag << (ch->number * 8)));
1037 dev_dbg(xpc_chan, "%s sent local from partid=%d, channel=%d\n",
1038 ipi_flag_string, ch->partid, ch->number);
1042 * The sending and receiving of IPIs includes the setting of an AMO variable
1043 * to indicate the reason the IPI was sent. The 64-bit variable is divided
1044 * up into eight bytes, ordered from right to left. Byte zero pertains to
1045 * channel 0, byte one to channel 1, and so on. Each byte is described by
1046 * the following IPI flags.
1049 #define XPC_IPI_CLOSEREQUEST 0x01
1050 #define XPC_IPI_CLOSEREPLY 0x02
1051 #define XPC_IPI_OPENREQUEST 0x04
1052 #define XPC_IPI_OPENREPLY 0x08
1053 #define XPC_IPI_MSGREQUEST 0x10
1055 /* given an AMO variable and a channel#, get its associated IPI flags */
1056 #define XPC_GET_IPI_FLAGS(_amo, _c) ((u8) (((_amo) >> ((_c) * 8)) & 0xff))
1057 #define XPC_SET_IPI_FLAGS(_amo, _c, _f) (_amo) |= ((u64) (_f) << ((_c) * 8))
1059 #define XPC_ANY_OPENCLOSE_IPI_FLAGS_SET(_amo) ((_amo) & __IA64_UL_CONST(0x0f0f0f0f0f0f0f0f))
1060 #define XPC_ANY_MSG_IPI_FLAGS_SET(_amo) ((_amo) & __IA64_UL_CONST(0x1010101010101010))
1063 xpc_IPI_send_closerequest(struct xpc_channel *ch, unsigned long *irq_flags)
1065 struct xpc_openclose_args *args = ch->local_openclose_args;
1067 args->reason = ch->reason;
1069 XPC_NOTIFY_IRQ_SEND(ch, XPC_IPI_CLOSEREQUEST, irq_flags);
1073 xpc_IPI_send_closereply(struct xpc_channel *ch, unsigned long *irq_flags)
1075 XPC_NOTIFY_IRQ_SEND(ch, XPC_IPI_CLOSEREPLY, irq_flags);
1079 xpc_IPI_send_openrequest(struct xpc_channel *ch, unsigned long *irq_flags)
1081 struct xpc_openclose_args *args = ch->local_openclose_args;
1083 args->msg_size = ch->msg_size;
1084 args->local_nentries = ch->local_nentries;
1086 XPC_NOTIFY_IRQ_SEND(ch, XPC_IPI_OPENREQUEST, irq_flags);
1090 xpc_IPI_send_openreply(struct xpc_channel *ch, unsigned long *irq_flags)
1092 struct xpc_openclose_args *args = ch->local_openclose_args;
1094 args->remote_nentries = ch->remote_nentries;
1095 args->local_nentries = ch->local_nentries;
1096 args->local_msgqueue_pa = __pa(ch->local_msgqueue);
1098 XPC_NOTIFY_IRQ_SEND(ch, XPC_IPI_OPENREPLY, irq_flags);
1102 xpc_IPI_send_msgrequest(struct xpc_channel *ch)
1104 XPC_NOTIFY_IRQ_SEND(ch, XPC_IPI_MSGREQUEST, NULL);
1108 xpc_IPI_send_local_msgrequest(struct xpc_channel *ch)
1110 XPC_NOTIFY_IRQ_SEND_LOCAL(ch, XPC_IPI_MSGREQUEST);
1114 * Memory for XPC's AMO variables is allocated by the MSPEC driver. These
1115 * pages are located in the lowest granule. The lowest granule uses 4k pages
1116 * for cached references and an alternate TLB handler to never provide a
1117 * cacheable mapping for the entire region. This will prevent speculative
1118 * reading of cached copies of our lines from being issued which will cause
1119 * a PI FSB Protocol error to be generated by the SHUB. For XPC, we need 64
1120 * AMO variables (based on XP_MAX_PARTITIONS) for message notification and an
1121 * additional 128 AMO variables (based on XP_NASID_MASK_WORDS) for partition
1122 * activation and 2 AMO variables for partition deactivation.
1124 static inline AMO_t *
1125 xpc_IPI_init(int index)
1127 AMO_t *amo = xpc_vars->amos_page + index;
1129 (void)xpc_IPI_receive(amo); /* clear AMO variable */
1133 static inline enum xpc_retval
1134 xpc_map_bte_errors(bte_result_t error)
1136 if (error == BTE_SUCCESS)
1140 if (BTE_VALID_SH2_ERROR(error))
1141 return xpcBteSh2Start + error;
1142 return xpcBteUnmappedError;
1148 return xpcBteDirectoryError;
1149 case BTEFAIL_POISON:
1150 return xpcBtePoisonError;
1152 return xpcBteWriteError;
1153 case BTEFAIL_ACCESS:
1154 return xpcBteAccessError;
1156 return xpcBtePWriteError;
1158 return xpcBtePReadError;
1160 return xpcBteTimeOutError;
1162 return xpcBteXtalkError;
1163 case BTEFAIL_NOTAVAIL:
1164 return xpcBteNotAvailable;
1166 return xpcBteUnmappedError;
1171 * Check to see if there is any channel activity to/from the specified
1175 xpc_check_for_channel_activity(struct xpc_partition *part)
1178 unsigned long irq_flags;
1180 IPI_amo = xpc_IPI_receive(part->local_IPI_amo_va);
1185 spin_lock_irqsave(&part->IPI_lock, irq_flags);
1186 part->local_IPI_amo |= IPI_amo;
1187 spin_unlock_irqrestore(&part->IPI_lock, irq_flags);
1189 dev_dbg(xpc_chan, "received IPI from partid=%d, IPI_amo=0x%lx\n",
1190 XPC_PARTID(part), IPI_amo);
1192 xpc_wakeup_channel_mgr(part);
1195 #endif /* _DRIVERS_MISC_SGIXP_XPC_H */