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/clksupport.h>
24 #include <asm/sn/addrs.h>
25 #include <asm/sn/mspec.h>
26 #include <asm/sn/shub_mmr.h>
30 * XPC Version numbers consist of a major and minor number. XPC can always
31 * talk to versions with same major #, and never talk to versions with a
34 #define _XPC_VERSION(_maj, _min) (((_maj) << 4) | ((_min) & 0xf))
35 #define XPC_VERSION_MAJOR(_v) ((_v) >> 4)
36 #define XPC_VERSION_MINOR(_v) ((_v) & 0xf)
39 * The next macros define word or bit representations for given
40 * C-brick nasid in either the SAL provided bit array representing
41 * nasids in the partition/machine or the AMO_t array used for
42 * inter-partition initiation communications.
44 * For SN2 machines, C-Bricks are alway even numbered NASIDs. As
45 * such, some space will be saved by insisting that nasid information
46 * passed from SAL always be packed for C-Bricks and the
47 * cross-partition interrupts use the same packing scheme.
49 #define XPC_NASID_W_INDEX(_n) (((_n) / 64) / 2)
50 #define XPC_NASID_B_INDEX(_n) (((_n) / 2) & (64 - 1))
51 #define XPC_NASID_IN_ARRAY(_n, _p) ((_p)[XPC_NASID_W_INDEX(_n)] & \
52 (1UL << XPC_NASID_B_INDEX(_n)))
53 #define XPC_NASID_FROM_W_B(_w, _b) (((_w) * 64 + (_b)) * 2)
55 #define XPC_HB_DEFAULT_INTERVAL 5 /* incr HB every x secs */
56 #define XPC_HB_CHECK_DEFAULT_INTERVAL 20 /* check HB every x secs */
58 /* define the process name of HB checker and the CPU it is pinned to */
59 #define XPC_HB_CHECK_THREAD_NAME "xpc_hb"
60 #define XPC_HB_CHECK_CPU 0
62 /* define the process name of the discovery thread */
63 #define XPC_DISCOVERY_THREAD_NAME "xpc_discovery"
68 * SAL reserves one page of memory per partition for XPC. Though a full page
69 * in length (16384 bytes), its starting address is not page aligned, but it
70 * is cacheline aligned. The reserved page consists of the following:
72 * reserved page header
74 * The first two 64-byte cachelines of the reserved page contain the
75 * header (struct xpc_rsvd_page). Before SAL initialization has completed,
76 * SAL has set up the following fields of the reserved page header:
77 * SAL_signature, SAL_version, SAL_partid, and SAL_nasids_size. The
78 * other fields are set up by XPC. (xpc_rsvd_page points to the local
79 * partition's reserved page.)
84 * SAL also sets up two bitmaps (or masks), one that reflects the actual
85 * nasids in this partition (part_nasids), and the other that reflects
86 * the actual nasids in the entire machine (mach_nasids). We're only
87 * interested in the even numbered nasids (which contain the processors
88 * and/or memory), so we only need half as many bits to represent the
89 * nasids. The part_nasids mask is located starting at the first cacheline
90 * following the reserved page header. The mach_nasids mask follows right
91 * after the part_nasids mask. The size in bytes of each mask is reflected
92 * by the reserved page header field 'SAL_nasids_size'. (Local partition's
93 * mask pointers are xpc_part_nasids and xpc_mach_nasids.)
95 * vars (ia64-sn2 only)
96 * vars part (ia64-sn2 only)
98 * Immediately following the mach_nasids mask are the XPC variables
99 * required by other partitions. First are those that are generic to all
100 * partitions (vars), followed on the next available cacheline by those
101 * which are partition specific (vars part). These are setup by XPC.
102 * (Local partition's vars pointers are xpc_vars and xpc_vars_part.)
104 * Note: Until 'stamp' is set non-zero, the partition XPC code has not been
107 struct xpc_rsvd_page
{
108 u64 SAL_signature
; /* SAL: unique signature */
109 u64 SAL_version
; /* SAL: version */
110 short SAL_partid
; /* SAL: partition ID */
111 short max_npartitions
; /* value of XPC_MAX_PARTITIONS */
113 u8 pad1
[3]; /* align to next u64 in 1st 64-byte cacheline */
115 u64 vars_pa
; /* physical address of struct xpc_vars */
116 u64 activate_mq_gpa
; /* global phys address of activate_mq */
118 struct timespec stamp
; /* time when reserved page was setup by XPC */
119 u64 pad2
[9]; /* align to last u64 in 2nd 64-byte cacheline */
120 u64 SAL_nasids_size
; /* SAL: size of each nasid mask in bytes */
123 #define XPC_RP_VERSION _XPC_VERSION(2, 0) /* version 2.0 of the reserved page */
125 #define XPC_SUPPORTS_RP_STAMP(_version) \
126 (_version >= _XPC_VERSION(1, 1))
128 #define ZERO_STAMP ((struct timespec){0, 0})
130 * compare stamps - the return value is:
132 * < 0, if stamp1 < stamp2
133 * = 0, if stamp1 == stamp2
134 * > 0, if stamp1 > stamp2
137 xpc_compare_stamps(struct timespec
*stamp1
, struct timespec
*stamp2
)
141 ret
= stamp1
->tv_sec
- stamp2
->tv_sec
;
143 ret
= stamp1
->tv_nsec
- stamp2
->tv_nsec
;
149 * Define the structures by which XPC variables can be exported to other
150 * partitions. (There are two: struct xpc_vars and struct xpc_vars_part)
154 * The following structure describes the partition generic variables
155 * needed by other partitions in order to properly initialize.
157 * struct xpc_vars version number also applies to struct xpc_vars_part.
158 * Changes to either structure and/or related functionality should be
159 * reflected by incrementing either the major or minor version numbers
160 * of struct xpc_vars.
162 struct xpc_vars_sn2
{
165 DECLARE_BITMAP(heartbeating_to_mask
, XP_MAX_NPARTITIONS_SN2
);
166 u64 heartbeat_offline
; /* if 0, heartbeat should be changing */
170 u64 amos_page_pa
; /* paddr of page of AMOs from MSPEC driver */
171 AMO_t
*amos_page
; /* vaddr of page of AMOs from MSPEC driver */
174 #define XPC_V_VERSION _XPC_VERSION(3, 1) /* version 3.1 of the cross vars */
176 #define XPC_SUPPORTS_DISENGAGE_REQUEST(_version) \
177 (_version >= _XPC_VERSION(3, 1))
180 * The following pertains to ia64-sn2 only.
182 * Memory for XPC's AMO variables is allocated by the MSPEC driver. These
183 * pages are located in the lowest granule. The lowest granule uses 4k pages
184 * for cached references and an alternate TLB handler to never provide a
185 * cacheable mapping for the entire region. This will prevent speculative
186 * reading of cached copies of our lines from being issued which will cause
187 * a PI FSB Protocol error to be generated by the SHUB. For XPC, we need 64
188 * AMO variables (based on XP_MAX_NPARTITIONS_SN2) to identify the senders of
189 * NOTIFY IRQs, 128 AMO variables (based on XP_NASID_MASK_WORDS) to identify
190 * the senders of ACTIVATE IRQs, and 2 AMO variables to identify which remote
191 * partitions (i.e., XPCs) consider themselves currently engaged with the
194 #define XPC_NOTIFY_IRQ_AMOS 0
195 #define XPC_ACTIVATE_IRQ_AMOS (XPC_NOTIFY_IRQ_AMOS + XP_MAX_NPARTITIONS_SN2)
196 #define XPC_ENGAGED_PARTITIONS_AMO (XPC_ACTIVATE_IRQ_AMOS + XP_NASID_MASK_WORDS)
197 #define XPC_DISENGAGE_REQUEST_AMO (XPC_ENGAGED_PARTITIONS_AMO + 1)
200 * The following structure describes the per partition specific variables.
202 * An array of these structures, one per partition, will be defined. As a
203 * partition becomes active XPC will copy the array entry corresponding to
204 * itself from that partition. It is desirable that the size of this structure
205 * evenly divides into a 128-byte cacheline, such that none of the entries in
206 * this array crosses a 128-byte cacheline boundary. As it is now, each entry
209 struct xpc_vars_part_sn2
{
212 u64 openclose_args_pa
; /* physical address of open and close args */
213 u64 GPs_pa
; /* physical address of Get/Put values */
215 u64 IPI_amo_pa
; /* physical address of IPI AMO_t structure */
216 int IPI_nasid
; /* nasid of where to send IPIs */
217 int IPI_phys_cpuid
; /* physical CPU ID of where to send IPIs */
219 u8 nchannels
; /* #of defined channels supported */
221 u8 reserved
[23]; /* pad to a full 64 bytes */
225 * The vars_part MAGIC numbers play a part in the first contact protocol.
227 * MAGIC1 indicates that the per partition specific variables for a remote
228 * partition have been initialized by this partition.
230 * MAGIC2 indicates that this partition has pulled the remote partititions
231 * per partition variables that pertain to this partition.
233 #define XPC_VP_MAGIC1 0x0053524156435058L /* 'XPCVARS\0'L (little endian) */
234 #define XPC_VP_MAGIC2 0x0073726176435058L /* 'XPCvars\0'L (little endian) */
236 /* the reserved page sizes and offsets */
238 #define XPC_RP_HEADER_SIZE L1_CACHE_ALIGN(sizeof(struct xpc_rsvd_page))
239 #define XPC_RP_VARS_SIZE L1_CACHE_ALIGN(sizeof(struct xpc_vars_sn2))
241 #define XPC_RP_PART_NASIDS(_rp) ((u64 *)((u8 *)(_rp) + XPC_RP_HEADER_SIZE))
242 #define XPC_RP_MACH_NASIDS(_rp) (XPC_RP_PART_NASIDS(_rp) + xp_nasid_mask_words)
243 #define XPC_RP_VARS(_rp) ((struct xpc_vars_sn2 *)(XPC_RP_MACH_NASIDS(_rp) + \
244 xp_nasid_mask_words))
247 * Functions registered by add_timer() or called by kernel_thread() only
248 * allow for a single 64-bit argument. The following macros can be used to
249 * pack and unpack two (32-bit, 16-bit or 8-bit) arguments into or out from
250 * the passed argument.
252 #define XPC_PACK_ARGS(_arg1, _arg2) \
253 ((((u64) _arg1) & 0xffffffff) | \
254 ((((u64) _arg2) & 0xffffffff) << 32))
256 #define XPC_UNPACK_ARG1(_args) (((u64) _args) & 0xffffffff)
257 #define XPC_UNPACK_ARG2(_args) ((((u64) _args) >> 32) & 0xffffffff)
260 * Define a Get/Put value pair (pointers) used with a message queue.
263 s64 get
; /* Get value */
264 s64 put
; /* Put value */
267 #define XPC_GP_SIZE \
268 L1_CACHE_ALIGN(sizeof(struct xpc_gp) * XPC_MAX_NCHANNELS)
271 * Define a structure that contains arguments associated with opening and
274 struct xpc_openclose_args
{
275 u16 reason
; /* reason why channel is closing */
276 u16 msg_size
; /* sizeof each message entry */
277 u16 remote_nentries
; /* #of message entries in remote msg queue */
278 u16 local_nentries
; /* #of message entries in local msg queue */
279 u64 local_msgqueue_pa
; /* physical address of local message queue */
282 #define XPC_OPENCLOSE_ARGS_SIZE \
283 L1_CACHE_ALIGN(sizeof(struct xpc_openclose_args) * \
286 /* struct xpc_msg flags */
288 #define XPC_M_DONE 0x01 /* msg has been received/consumed */
289 #define XPC_M_READY 0x02 /* msg is ready to be sent */
290 #define XPC_M_INTERRUPT 0x04 /* send interrupt when msg consumed */
292 #define XPC_MSG_ADDRESS(_payload) \
293 ((struct xpc_msg *)((u8 *)(_payload) - XPC_MSG_PAYLOAD_OFFSET))
296 * Defines notify entry.
298 * This is used to notify a message's sender that their message was received
299 * and consumed by the intended recipient.
302 u8 type
; /* type of notification */
304 /* the following two fields are only used if type == XPC_N_CALL */
305 xpc_notify_func func
; /* user's notify function */
306 void *key
; /* pointer to user's key */
309 /* struct xpc_notify type of notification */
311 #define XPC_N_CALL 0x01 /* notify function provided by user */
314 * Define the structure that manages all the stuff required by a channel. In
315 * particular, they are used to manage the messages sent across the channel.
317 * This structure is private to a partition, and is NOT shared across the
318 * partition boundary.
320 * There is an array of these structures for each remote partition. It is
321 * allocated at the time a partition becomes active. The array contains one
322 * of these structures for each potential channel connection to that partition.
325 * Each of these structures manages two message queues (circular buffers).
326 * They are allocated at the time a channel connection is made. One of
327 * these message queues (local_msgqueue) holds the locally created messages
328 * that are destined for the remote partition. The other of these message
329 * queues (remote_msgqueue) is a locally cached copy of the remote partition's
330 * own local_msgqueue.
332 * The following is a description of the Get/Put pointers used to manage these
333 * two message queues. Consider the local_msgqueue to be on one partition
334 * and the remote_msgqueue to be its cached copy on another partition. A
335 * description of what each of the lettered areas contains is included.
338 * local_msgqueue remote_msgqueue
340 * |/////////| |/////////|
341 * w_remote_GP.get --> +---------+ |/////////|
343 * remote_GP.get --> +---------+ +---------+ <-- local_GP->get
347 * | | +---------+ <-- w_local_GP.get
351 * | | +---------+ <-- w_remote_GP.put
353 * local_GP->put --> +---------+ +---------+ <-- remote_GP.put
357 * w_local_GP.put --> +---------+ |/////////|
358 * |/////////| |/////////|
361 * ( remote_GP.[get|put] are cached copies of the remote
362 * partition's local_GP->[get|put], and thus their values can
363 * lag behind their counterparts on the remote partition. )
366 * A - Messages that have been allocated, but have not yet been sent to the
369 * B - Messages that have been sent, but have not yet been acknowledged by the
370 * remote partition as having been received.
372 * C - Area that needs to be prepared for the copying of sent messages, by
373 * the clearing of the message flags of any previously received messages.
375 * D - Area into which sent messages are to be copied from the remote
376 * partition's local_msgqueue and then delivered to their intended
377 * recipients. [ To allow for a multi-message copy, another pointer
378 * (next_msg_to_pull) has been added to keep track of the next message
379 * number needing to be copied (pulled). It chases after w_remote_GP.put.
380 * Any messages lying between w_local_GP.get and next_msg_to_pull have
381 * been copied and are ready to be delivered. ]
383 * E - Messages that have been copied and delivered, but have not yet been
384 * acknowledged by the recipient as having been received.
386 * F - Messages that have been acknowledged, but XPC has not yet notified the
387 * sender that the message was received by its intended recipient.
388 * This is also an area that needs to be prepared for the allocating of
389 * new messages, by the clearing of the message flags of the acknowledged
393 short partid
; /* ID of remote partition connected */
394 spinlock_t lock
; /* lock for updating this structure */
395 u32 flags
; /* general flags */
397 enum xp_retval reason
; /* reason why channel is disconnect'g */
398 int reason_line
; /* line# disconnect initiated from */
400 u16 number
; /* channel # */
402 u16 msg_size
; /* sizeof each msg entry */
403 u16 local_nentries
; /* #of msg entries in local msg queue */
404 u16 remote_nentries
; /* #of msg entries in remote msg queue */
406 void *local_msgqueue_base
; /* base address of kmalloc'd space */
407 struct xpc_msg
*local_msgqueue
; /* local message queue */
408 void *remote_msgqueue_base
; /* base address of kmalloc'd space */
409 struct xpc_msg
*remote_msgqueue
; /* cached copy of remote partition's */
410 /* local message queue */
411 u64 remote_msgqueue_pa
; /* phys addr of remote partition's */
412 /* local message queue */
414 atomic_t references
; /* #of external references to queues */
416 atomic_t n_on_msg_allocate_wq
; /* #on msg allocation wait queue */
417 wait_queue_head_t msg_allocate_wq
; /* msg allocation wait queue */
419 u8 delayed_IPI_flags
; /* IPI flags received, but delayed */
420 /* action until channel disconnected */
422 /* queue of msg senders who want to be notified when msg received */
424 atomic_t n_to_notify
; /* #of msg senders to notify */
425 struct xpc_notify
*notify_queue
; /* notify queue for messages sent */
427 xpc_channel_func func
; /* user's channel function */
428 void *key
; /* pointer to user's key */
430 struct mutex msg_to_pull_mutex
; /* next msg to pull serialization */
431 struct completion wdisconnect_wait
; /* wait for channel disconnect */
433 struct xpc_openclose_args
*local_openclose_args
; /* args passed on */
434 /* opening or closing of channel */
436 /* various flavors of local and remote Get/Put values */
438 struct xpc_gp
*local_GP
; /* local Get/Put values */
439 struct xpc_gp remote_GP
; /* remote Get/Put values */
440 struct xpc_gp w_local_GP
; /* working local Get/Put values */
441 struct xpc_gp w_remote_GP
; /* working remote Get/Put values */
442 s64 next_msg_to_pull
; /* Put value of next msg to pull */
444 /* kthread management related fields */
446 atomic_t kthreads_assigned
; /* #of kthreads assigned to channel */
447 u32 kthreads_assigned_limit
; /* limit on #of kthreads assigned */
448 atomic_t kthreads_idle
; /* #of kthreads idle waiting for work */
449 u32 kthreads_idle_limit
; /* limit on #of kthreads idle */
450 atomic_t kthreads_active
; /* #of kthreads actively working */
452 wait_queue_head_t idle_wq
; /* idle kthread wait queue */
454 } ____cacheline_aligned
;
456 /* struct xpc_channel flags */
458 #define XPC_C_WASCONNECTED 0x00000001 /* channel was connected */
460 #define XPC_C_ROPENREPLY 0x00000002 /* remote open channel reply */
461 #define XPC_C_OPENREPLY 0x00000004 /* local open channel reply */
462 #define XPC_C_ROPENREQUEST 0x00000008 /* remote open channel request */
463 #define XPC_C_OPENREQUEST 0x00000010 /* local open channel request */
465 #define XPC_C_SETUP 0x00000020 /* channel's msgqueues are alloc'd */
466 #define XPC_C_CONNECTEDCALLOUT 0x00000040 /* connected callout initiated */
467 #define XPC_C_CONNECTEDCALLOUT_MADE \
468 0x00000080 /* connected callout completed */
469 #define XPC_C_CONNECTED 0x00000100 /* local channel is connected */
470 #define XPC_C_CONNECTING 0x00000200 /* channel is being connected */
472 #define XPC_C_RCLOSEREPLY 0x00000400 /* remote close channel reply */
473 #define XPC_C_CLOSEREPLY 0x00000800 /* local close channel reply */
474 #define XPC_C_RCLOSEREQUEST 0x00001000 /* remote close channel request */
475 #define XPC_C_CLOSEREQUEST 0x00002000 /* local close channel request */
477 #define XPC_C_DISCONNECTED 0x00004000 /* channel is disconnected */
478 #define XPC_C_DISCONNECTING 0x00008000 /* channel is being disconnected */
479 #define XPC_C_DISCONNECTINGCALLOUT \
480 0x00010000 /* disconnecting callout initiated */
481 #define XPC_C_DISCONNECTINGCALLOUT_MADE \
482 0x00020000 /* disconnecting callout completed */
483 #define XPC_C_WDISCONNECT 0x00040000 /* waiting for channel disconnect */
486 * Manages channels on a partition basis. There is one of these structures
487 * for each partition (a partition will never utilize the structure that
488 * represents itself).
490 struct xpc_partition
{
492 /* XPC HB infrastructure */
494 u8 remote_rp_version
; /* version# of partition's rsvd pg */
495 struct timespec remote_rp_stamp
; /* time when rsvd pg was initialized */
496 u64 remote_rp_pa
; /* phys addr of partition's rsvd pg */
497 u64 remote_vars_pa
; /* phys addr of partition's vars */
498 u64 remote_vars_part_pa
; /* phys addr of partition's vars part */
499 u64 last_heartbeat
; /* HB at last read */
500 u64 remote_amos_page_pa
; /* phys addr of partition's amos page */
501 int remote_act_nasid
; /* active part's act/deact nasid */
502 int remote_act_phys_cpuid
; /* active part's act/deact phys cpuid */
503 u32 act_IRQ_rcvd
; /* IRQs since activation */
504 spinlock_t act_lock
; /* protect updating of act_state */
505 u8 act_state
; /* from XPC HB viewpoint */
506 u8 remote_vars_version
; /* version# of partition's vars */
507 enum xp_retval reason
; /* reason partition is deactivating */
508 int reason_line
; /* line# deactivation initiated from */
509 int reactivate_nasid
; /* nasid in partition to reactivate */
511 unsigned long disengage_request_timeout
; /* timeout in jiffies */
512 struct timer_list disengage_request_timer
;
514 /* XPC infrastructure referencing and teardown control */
516 u8 setup_state
; /* infrastructure setup state */
517 wait_queue_head_t teardown_wq
; /* kthread waiting to teardown infra */
518 atomic_t references
; /* #of references to infrastructure */
520 u8 nchannels
; /* #of defined channels supported */
521 atomic_t nchannels_active
; /* #of channels that are not DISCONNECTED */
522 atomic_t nchannels_engaged
; /* #of channels engaged with remote part */
523 struct xpc_channel
*channels
; /* array of channel structures */
525 void *local_GPs_base
; /* base address of kmalloc'd space */
526 struct xpc_gp
*local_GPs
; /* local Get/Put values */
527 void *remote_GPs_base
; /* base address of kmalloc'd space */
528 struct xpc_gp
*remote_GPs
; /* copy of remote partition's local */
530 u64 remote_GPs_pa
; /* phys address of remote partition's local */
533 /* fields used to pass args when opening or closing a channel */
535 void *local_openclose_args_base
; /* base address of kmalloc'd space */
536 struct xpc_openclose_args
*local_openclose_args
; /* local's args */
537 void *remote_openclose_args_base
; /* base address of kmalloc'd space */
538 struct xpc_openclose_args
*remote_openclose_args
; /* copy of remote's */
540 u64 remote_openclose_args_pa
; /* phys addr of remote's args */
542 /* IPI sending, receiving and handling related fields */
544 int remote_IPI_nasid
; /* nasid of where to send IPIs */
545 int remote_IPI_phys_cpuid
; /* phys CPU ID of where to send IPIs */
546 AMO_t
*remote_IPI_amo_va
; /* address of remote IPI AMO_t structure */
548 AMO_t
*local_IPI_amo_va
; /* address of IPI AMO_t structure */
549 u64 local_IPI_amo
; /* IPI amo flags yet to be handled */
550 char IPI_owner
[8]; /* IPI owner's name */
551 struct timer_list dropped_IPI_timer
; /* dropped IPI timer */
553 spinlock_t IPI_lock
; /* IPI handler lock */
555 /* channel manager related fields */
557 atomic_t channel_mgr_requests
; /* #of requests to activate chan mgr */
558 wait_queue_head_t channel_mgr_wq
; /* channel mgr's wait queue */
560 } ____cacheline_aligned
;
562 /* struct xpc_partition act_state values (for XPC HB) */
564 #define XPC_P_INACTIVE 0x00 /* partition is not active */
565 #define XPC_P_ACTIVATION_REQ 0x01 /* created thread to activate */
566 #define XPC_P_ACTIVATING 0x02 /* activation thread started */
567 #define XPC_P_ACTIVE 0x03 /* xpc_partition_up() was called */
568 #define XPC_P_DEACTIVATING 0x04 /* partition deactivation initiated */
570 #define XPC_DEACTIVATE_PARTITION(_p, _reason) \
571 xpc_deactivate_partition(__LINE__, (_p), (_reason))
573 /* struct xpc_partition setup_state values */
575 #define XPC_P_UNSET 0x00 /* infrastructure was never setup */
576 #define XPC_P_SETUP 0x01 /* infrastructure is setup */
577 #define XPC_P_WTEARDOWN 0x02 /* waiting to teardown infrastructure */
578 #define XPC_P_TORNDOWN 0x03 /* infrastructure is torndown */
581 * struct xpc_partition IPI_timer #of seconds to wait before checking for
582 * dropped IPIs. These occur whenever an IPI amo write doesn't complete until
583 * after the IPI was received.
585 #define XPC_P_DROPPED_IPI_WAIT_INTERVAL (0.25 * HZ)
587 /* number of seconds to wait for other partitions to disengage */
588 #define XPC_DISENGAGE_REQUEST_DEFAULT_TIMELIMIT 90
590 /* interval in seconds to print 'waiting disengagement' messages */
591 #define XPC_DISENGAGE_PRINTMSG_INTERVAL 10
593 #define XPC_PARTID(_p) ((short)((_p) - &xpc_partitions[0]))
595 /* found in xp_main.c */
596 extern struct xpc_registration xpc_registrations
[];
598 /* found in xpc_main.c */
599 extern struct device
*xpc_part
;
600 extern struct device
*xpc_chan
;
601 extern int xpc_disengage_request_timelimit
;
602 extern int xpc_disengage_request_timedout
;
603 extern atomic_t xpc_act_IRQ_rcvd
;
604 extern wait_queue_head_t xpc_act_IRQ_wq
;
605 extern void *xpc_heartbeating_to_mask
;
606 extern irqreturn_t
xpc_notify_IRQ_handler(int, void *);
607 extern void xpc_dropped_IPI_check(struct xpc_partition
*);
608 extern void xpc_activate_partition(struct xpc_partition
*);
609 extern void xpc_activate_kthreads(struct xpc_channel
*, int);
610 extern void xpc_create_kthreads(struct xpc_channel
*, int, int);
611 extern void xpc_disconnect_wait(int);
612 extern enum xp_retval (*xpc_rsvd_page_init
) (struct xpc_rsvd_page
*);
613 extern void (*xpc_heartbeat_init
) (void);
614 extern void (*xpc_heartbeat_exit
) (void);
615 extern void (*xpc_increment_heartbeat
) (void);
616 extern void (*xpc_offline_heartbeat
) (void);
617 extern void (*xpc_online_heartbeat
) (void);
618 extern void (*xpc_check_remote_hb
) (void);
619 extern enum xp_retval (*xpc_make_first_contact
) (struct xpc_partition
*);
620 extern u64 (*xpc_get_IPI_flags
) (struct xpc_partition
*);
621 extern struct xpc_msg
*(*xpc_get_deliverable_msg
) (struct xpc_channel
*);
622 extern void (*xpc_initiate_partition_activation
) (struct xpc_rsvd_page
*, u64
,
624 extern void (*xpc_process_act_IRQ_rcvd
) (int);
625 extern enum xp_retval (*xpc_setup_infrastructure
) (struct xpc_partition
*);
626 extern void (*xpc_teardown_infrastructure
) (struct xpc_partition
*);
627 extern void (*xpc_mark_partition_engaged
) (struct xpc_partition
*);
628 extern void (*xpc_mark_partition_disengaged
) (struct xpc_partition
*);
629 extern void (*xpc_request_partition_disengage
) (struct xpc_partition
*);
630 extern void (*xpc_cancel_partition_disengage_request
) (struct xpc_partition
*);
631 extern u64 (*xpc_partition_engaged
) (u64
);
632 extern u64 (*xpc_partition_disengage_requested
) (u64
);;
633 extern void (*xpc_clear_partition_engaged
) (u64
);
634 extern void (*xpc_clear_partition_disengage_request
) (u64
);
636 extern void (*xpc_IPI_send_local_activate
) (int);
637 extern void (*xpc_IPI_send_activated
) (struct xpc_partition
*);
638 extern void (*xpc_IPI_send_local_reactivate
) (int);
639 extern void (*xpc_IPI_send_disengage
) (struct xpc_partition
*);
641 extern void (*xpc_IPI_send_closerequest
) (struct xpc_channel
*,
643 extern void (*xpc_IPI_send_closereply
) (struct xpc_channel
*, unsigned long *);
644 extern void (*xpc_IPI_send_openrequest
) (struct xpc_channel
*, unsigned long *);
645 extern void (*xpc_IPI_send_openreply
) (struct xpc_channel
*, unsigned long *);
647 extern enum xp_retval (*xpc_allocate_msg
) (struct xpc_channel
*, u32
,
649 extern enum xp_retval (*xpc_send_msg
) (struct xpc_channel
*, struct xpc_msg
*,
650 u8
, xpc_notify_func
, void *);
651 extern void (*xpc_received_msg
) (struct xpc_channel
*, struct xpc_msg
*);
653 /* found in xpc_sn2.c */
654 extern void xpc_init_sn2(void);
656 /* found in xpc_uv.c */
657 extern void xpc_init_uv(void);
659 /* found in xpc_partition.c */
660 extern int xpc_exiting
;
661 extern int xp_nasid_mask_words
;
662 extern struct xpc_rsvd_page
*xpc_rsvd_page
;
663 extern u64
*xpc_mach_nasids
;
664 extern struct xpc_partition
*xpc_partitions
;
665 extern char *xpc_remote_copy_buffer
;
666 extern void *xpc_remote_copy_buffer_base
;
667 extern void *xpc_kmalloc_cacheline_aligned(size_t, gfp_t
, void **);
668 extern struct xpc_rsvd_page
*xpc_setup_rsvd_page(void);
669 extern void xpc_allow_IPI_ops(void);
670 extern void xpc_restrict_IPI_ops(void);
671 extern int xpc_identify_act_IRQ_sender(void);
672 extern int xpc_partition_disengaged(struct xpc_partition
*);
673 extern enum xp_retval
xpc_mark_partition_active(struct xpc_partition
*);
674 extern void xpc_mark_partition_inactive(struct xpc_partition
*);
675 extern void xpc_discovery(void);
676 extern enum xp_retval
xpc_get_remote_rp(int, u64
*, struct xpc_rsvd_page
*,
678 extern void xpc_deactivate_partition(const int, struct xpc_partition
*,
680 extern enum xp_retval
xpc_initiate_partid_to_nasids(short, void *);
682 /* found in xpc_channel.c */
683 extern void *xpc_kzalloc_cacheline_aligned(size_t, gfp_t
, void **);
684 extern void xpc_initiate_connect(int);
685 extern void xpc_initiate_disconnect(int);
686 extern enum xp_retval
xpc_allocate_msg_wait(struct xpc_channel
*);
687 extern enum xp_retval
xpc_initiate_allocate(short, int, u32
, void **);
688 extern enum xp_retval
xpc_initiate_send(short, int, void *);
689 extern enum xp_retval
xpc_initiate_send_notify(short, int, void *,
690 xpc_notify_func
, void *);
691 extern void xpc_initiate_received(short, int, void *);
692 extern void xpc_process_channel_activity(struct xpc_partition
*);
693 extern void xpc_connected_callout(struct xpc_channel
*);
694 extern void xpc_deliver_msg(struct xpc_channel
*);
695 extern void xpc_disconnect_channel(const int, struct xpc_channel
*,
696 enum xp_retval
, unsigned long *);
697 extern void xpc_disconnect_callout(struct xpc_channel
*, enum xp_retval
);
698 extern void xpc_partition_going_down(struct xpc_partition
*, enum xp_retval
);
701 xpc_hb_allowed(short partid
, void *heartbeating_to_mask
)
703 return test_bit(partid
, heartbeating_to_mask
);
707 xpc_any_hbs_allowed(void)
709 DBUG_ON(xpc_heartbeating_to_mask
== NULL
);
710 return !bitmap_empty(xpc_heartbeating_to_mask
, xp_max_npartitions
);
714 xpc_allow_hb(short partid
)
716 DBUG_ON(xpc_heartbeating_to_mask
== NULL
);
717 set_bit(partid
, xpc_heartbeating_to_mask
);
721 xpc_disallow_hb(short partid
)
723 DBUG_ON(xpc_heartbeating_to_mask
== NULL
);
724 clear_bit(partid
, xpc_heartbeating_to_mask
);
728 xpc_disallow_all_hbs(void)
730 DBUG_ON(xpc_heartbeating_to_mask
== NULL
);
731 bitmap_zero(xpc_heartbeating_to_mask
, xp_max_npartitions
);
735 xpc_wakeup_channel_mgr(struct xpc_partition
*part
)
737 if (atomic_inc_return(&part
->channel_mgr_requests
) == 1)
738 wake_up(&part
->channel_mgr_wq
);
742 * These next two inlines are used to keep us from tearing down a channel's
743 * msg queues while a thread may be referencing them.
746 xpc_msgqueue_ref(struct xpc_channel
*ch
)
748 atomic_inc(&ch
->references
);
752 xpc_msgqueue_deref(struct xpc_channel
*ch
)
754 s32 refs
= atomic_dec_return(&ch
->references
);
758 xpc_wakeup_channel_mgr(&xpc_partitions
[ch
->partid
]);
761 #define XPC_DISCONNECT_CHANNEL(_ch, _reason, _irqflgs) \
762 xpc_disconnect_channel(__LINE__, _ch, _reason, _irqflgs)
765 * These two inlines are used to keep us from tearing down a partition's
766 * setup infrastructure while a thread may be referencing it.
769 xpc_part_deref(struct xpc_partition
*part
)
771 s32 refs
= atomic_dec_return(&part
->references
);
774 if (refs
== 0 && part
->setup_state
== XPC_P_WTEARDOWN
)
775 wake_up(&part
->teardown_wq
);
779 xpc_part_ref(struct xpc_partition
*part
)
783 atomic_inc(&part
->references
);
784 setup
= (part
->setup_state
== XPC_P_SETUP
);
786 xpc_part_deref(part
);
792 * The following macro is to be used for the setting of the reason and
793 * reason_line fields in both the struct xpc_channel and struct xpc_partition
796 #define XPC_SET_REASON(_p, _reason, _line) \
798 (_p)->reason = _reason; \
799 (_p)->reason_line = _line; \
803 * The sending and receiving of IPIs includes the setting of an >>>AMO variable
804 * to indicate the reason the IPI was sent. The 64-bit variable is divided
805 * up into eight bytes, ordered from right to left. Byte zero pertains to
806 * channel 0, byte one to channel 1, and so on. Each byte is described by
807 * the following IPI flags.
810 #define XPC_IPI_CLOSEREQUEST 0x01
811 #define XPC_IPI_CLOSEREPLY 0x02
812 #define XPC_IPI_OPENREQUEST 0x04
813 #define XPC_IPI_OPENREPLY 0x08
814 #define XPC_IPI_MSGREQUEST 0x10
816 /* given an >>>AMO variable and a channel#, get its associated IPI flags */
817 #define XPC_GET_IPI_FLAGS(_amo, _c) ((u8) (((_amo) >> ((_c) * 8)) & 0xff))
818 #define XPC_SET_IPI_FLAGS(_amo, _c, _f) (_amo) |= ((u64) (_f) << ((_c) * 8))
820 #define XPC_ANY_OPENCLOSE_IPI_FLAGS_SET(_amo) ((_amo) & 0x0f0f0f0f0f0f0f0fUL)
821 #define XPC_ANY_MSG_IPI_FLAGS_SET(_amo) ((_amo) & 0x1010101010101010UL)
823 #endif /* _DRIVERS_MISC_SGIXP_XPC_H */