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/wait.h>
17 #include <linux/completion.h>
18 #include <linux/timer.h>
19 #include <linux/sched.h>
23 * XPC Version numbers consist of a major and minor number. XPC can always
24 * talk to versions with same major #, and never talk to versions with a
27 #define _XPC_VERSION(_maj, _min) (((_maj) << 4) | ((_min) & 0xf))
28 #define XPC_VERSION_MAJOR(_v) ((_v) >> 4)
29 #define XPC_VERSION_MINOR(_v) ((_v) & 0xf)
31 /* define frequency of the heartbeat and frequency how often it's checked */
32 #define XPC_HB_DEFAULT_INTERVAL 5 /* incr HB every x secs */
33 #define XPC_HB_CHECK_DEFAULT_INTERVAL 20 /* check HB every x secs */
35 /* define the process name of HB checker and the CPU it is pinned to */
36 #define XPC_HB_CHECK_THREAD_NAME "xpc_hb"
37 #define XPC_HB_CHECK_CPU 0
39 /* define the process name of the discovery thread */
40 #define XPC_DISCOVERY_THREAD_NAME "xpc_discovery"
45 * SAL reserves one page of memory per partition for XPC. Though a full page
46 * in length (16384 bytes), its starting address is not page aligned, but it
47 * is cacheline aligned. The reserved page consists of the following:
49 * reserved page header
51 * The first two 64-byte cachelines of the reserved page contain the
52 * header (struct xpc_rsvd_page). Before SAL initialization has completed,
53 * SAL has set up the following fields of the reserved page header:
54 * SAL_signature, SAL_version, SAL_partid, and SAL_nasids_size. The
55 * other fields are set up by XPC. (xpc_rsvd_page points to the local
56 * partition's reserved page.)
61 * SAL also sets up two bitmaps (or masks), one that reflects the actual
62 * nasids in this partition (part_nasids), and the other that reflects
63 * the actual nasids in the entire machine (mach_nasids). We're only
64 * interested in the even numbered nasids (which contain the processors
65 * and/or memory), so we only need half as many bits to represent the
66 * nasids. When mapping nasid to bit in a mask (or bit to nasid) be sure
67 * to either divide or multiply by 2. The part_nasids mask is located
68 * starting at the first cacheline following the reserved page header. The
69 * mach_nasids mask follows right after the part_nasids mask. The size in
70 * bytes of each mask is reflected by the reserved page header field
71 * 'SAL_nasids_size'. (Local partition's mask pointers are xpc_part_nasids
72 * and xpc_mach_nasids.)
74 * vars (ia64-sn2 only)
75 * vars part (ia64-sn2 only)
77 * Immediately following the mach_nasids mask are the XPC variables
78 * required by other partitions. First are those that are generic to all
79 * partitions (vars), followed on the next available cacheline by those
80 * which are partition specific (vars part). These are setup by XPC.
81 * (Local partition's vars pointers are xpc_vars and xpc_vars_part.)
83 * Note: Until 'ts_jiffies' is set non-zero, the partition XPC code has not been
86 struct xpc_rsvd_page {
87 u64 SAL_signature; /* SAL: unique signature */
88 u64 SAL_version; /* SAL: version */
89 short SAL_partid; /* SAL: partition ID */
90 short max_npartitions; /* value of XPC_MAX_PARTITIONS */
92 u8 pad1[3]; /* align to next u64 in 1st 64-byte cacheline */
94 unsigned long vars_pa; /* phys address of struct xpc_vars */
95 unsigned long activate_mq_gpa; /* gru phy addr of activate_mq */
97 unsigned long ts_jiffies; /* timestamp when rsvd pg was setup by XPC */
98 u64 pad2[10]; /* align to last u64 in 2nd 64-byte cacheline */
99 u64 SAL_nasids_size; /* SAL: size of each nasid mask in bytes */
102 #define XPC_RP_VERSION _XPC_VERSION(2, 0) /* version 2.0 of the reserved page */
105 * Define the structures by which XPC variables can be exported to other
106 * partitions. (There are two: struct xpc_vars and struct xpc_vars_part)
110 * The following structure describes the partition generic variables
111 * needed by other partitions in order to properly initialize.
113 * struct xpc_vars version number also applies to struct xpc_vars_part.
114 * Changes to either structure and/or related functionality should be
115 * reflected by incrementing either the major or minor version numbers
116 * of struct xpc_vars.
118 struct xpc_vars_sn2 {
121 DECLARE_BITMAP(heartbeating_to_mask, XP_MAX_NPARTITIONS_SN2);
122 u64 heartbeat_offline; /* if 0, heartbeat should be changing */
123 int activate_IRQ_nasid;
124 int activate_IRQ_phys_cpuid;
125 unsigned long vars_part_pa;
126 unsigned long amos_page_pa;/* paddr of page of amos from MSPEC driver */
127 struct amo *amos_page; /* vaddr of page of amos from MSPEC driver */
130 #define XPC_V_VERSION _XPC_VERSION(3, 1) /* version 3.1 of the cross vars */
133 * The following structure describes the per partition specific variables.
135 * An array of these structures, one per partition, will be defined. As a
136 * partition becomes active XPC will copy the array entry corresponding to
137 * itself from that partition. It is desirable that the size of this structure
138 * evenly divides into a 128-byte cacheline, such that none of the entries in
139 * this array crosses a 128-byte cacheline boundary. As it is now, each entry
142 struct xpc_vars_part_sn2 {
145 unsigned long openclose_args_pa; /* phys addr of open and close args */
146 unsigned long GPs_pa; /* physical address of Get/Put values */
148 unsigned long chctl_amo_pa; /* physical address of chctl flags' amo */
150 int notify_IRQ_nasid; /* nasid of where to send notify IRQs */
151 int notify_IRQ_phys_cpuid; /* CPUID of where to send notify IRQs */
153 u8 nchannels; /* #of defined channels supported */
155 u8 reserved[23]; /* pad to a full 64 bytes */
159 * The vars_part MAGIC numbers play a part in the first contact protocol.
161 * MAGIC1 indicates that the per partition specific variables for a remote
162 * partition have been initialized by this partition.
164 * MAGIC2 indicates that this partition has pulled the remote partititions
165 * per partition variables that pertain to this partition.
167 #define XPC_VP_MAGIC1_SN2 0x0053524156435058L /* 'XPCVARS\0'L (little endian) */
168 #define XPC_VP_MAGIC2_SN2 0x0073726176435058L /* 'XPCvars\0'L (little endian) */
170 /* the reserved page sizes and offsets */
172 #define XPC_RP_HEADER_SIZE L1_CACHE_ALIGN(sizeof(struct xpc_rsvd_page))
173 #define XPC_RP_VARS_SIZE L1_CACHE_ALIGN(sizeof(struct xpc_vars_sn2))
175 #define XPC_RP_PART_NASIDS(_rp) ((unsigned long *)((u8 *)(_rp) + \
177 #define XPC_RP_MACH_NASIDS(_rp) (XPC_RP_PART_NASIDS(_rp) + \
178 xpc_nasid_mask_nlongs)
179 #define XPC_RP_VARS(_rp) ((struct xpc_vars_sn2 *) \
180 (XPC_RP_MACH_NASIDS(_rp) + \
181 xpc_nasid_mask_nlongs))
184 * The activate_mq is used to send/receive messages that affect XPC's heartbeat,
185 * partition active state, and channel state. This is UV only.
187 struct xpc_activate_mq_msghdr_uv {
188 short partid; /* sender's partid */
189 u8 act_state; /* sender's act_state at time msg sent */
190 u8 type; /* message's type */
191 unsigned long rp_ts_jiffies; /* timestamp of sender's rp setup by XPC */
194 /* activate_mq defined message types */
195 #define XPC_ACTIVATE_MQ_MSG_SYNC_ACT_STATE_UV 0
196 #define XPC_ACTIVATE_MQ_MSG_INC_HEARTBEAT_UV 1
197 #define XPC_ACTIVATE_MQ_MSG_OFFLINE_HEARTBEAT_UV 2
198 #define XPC_ACTIVATE_MQ_MSG_ONLINE_HEARTBEAT_UV 3
200 #define XPC_ACTIVATE_MQ_MSG_ACTIVATE_REQ_UV 4
201 #define XPC_ACTIVATE_MQ_MSG_DEACTIVATE_REQ_UV 5
203 #define XPC_ACTIVATE_MQ_MSG_CHCTL_CLOSEREQUEST_UV 6
204 #define XPC_ACTIVATE_MQ_MSG_CHCTL_CLOSEREPLY_UV 7
205 #define XPC_ACTIVATE_MQ_MSG_CHCTL_OPENREQUEST_UV 8
206 #define XPC_ACTIVATE_MQ_MSG_CHCTL_OPENREPLY_UV 9
208 #define XPC_ACTIVATE_MQ_MSG_MARK_ENGAGED_UV 10
209 #define XPC_ACTIVATE_MQ_MSG_MARK_DISENGAGED_UV 11
211 struct xpc_activate_mq_msg_uv {
212 struct xpc_activate_mq_msghdr_uv header;
215 struct xpc_activate_mq_msg_heartbeat_req_uv {
216 struct xpc_activate_mq_msghdr_uv header;
220 struct xpc_activate_mq_msg_activate_req_uv {
221 struct xpc_activate_mq_msghdr_uv header;
222 unsigned long rp_gpa;
223 unsigned long activate_mq_gpa;
226 struct xpc_activate_mq_msg_deactivate_req_uv {
227 struct xpc_activate_mq_msghdr_uv header;
228 enum xp_retval reason;
231 struct xpc_activate_mq_msg_chctl_closerequest_uv {
232 struct xpc_activate_mq_msghdr_uv header;
234 enum xp_retval reason;
237 struct xpc_activate_mq_msg_chctl_closereply_uv {
238 struct xpc_activate_mq_msghdr_uv header;
242 struct xpc_activate_mq_msg_chctl_openrequest_uv {
243 struct xpc_activate_mq_msghdr_uv header;
245 short msg_size; /* size of notify_mq's messages */
246 short local_nentries; /* ??? Is this needed? What is? */
249 struct xpc_activate_mq_msg_chctl_openreply_uv {
250 struct xpc_activate_mq_msghdr_uv header;
252 short remote_nentries; /* ??? Is this needed? What is? */
253 short local_nentries; /* ??? Is this needed? What is? */
254 unsigned long local_notify_mq_gpa;
258 * Functions registered by add_timer() or called by kernel_thread() only
259 * allow for a single 64-bit argument. The following macros can be used to
260 * pack and unpack two (32-bit, 16-bit or 8-bit) arguments into or out from
261 * the passed argument.
263 #define XPC_PACK_ARGS(_arg1, _arg2) \
264 ((((u64)_arg1) & 0xffffffff) | \
265 ((((u64)_arg2) & 0xffffffff) << 32))
267 #define XPC_UNPACK_ARG1(_args) (((u64)_args) & 0xffffffff)
268 #define XPC_UNPACK_ARG2(_args) ((((u64)_args) >> 32) & 0xffffffff)
271 * Define a Get/Put value pair (pointers) used with a message queue.
274 s64 get; /* Get value */
275 s64 put; /* Put value */
278 #define XPC_GP_SIZE \
279 L1_CACHE_ALIGN(sizeof(struct xpc_gp_sn2) * XPC_MAX_NCHANNELS)
282 * Define a structure that contains arguments associated with opening and
285 struct xpc_openclose_args {
286 u16 reason; /* reason why channel is closing */
287 u16 msg_size; /* sizeof each message entry */
288 u16 remote_nentries; /* #of message entries in remote msg queue */
289 u16 local_nentries; /* #of message entries in local msg queue */
290 unsigned long local_msgqueue_pa; /* phys addr of local message queue */
293 #define XPC_OPENCLOSE_ARGS_SIZE \
294 L1_CACHE_ALIGN(sizeof(struct xpc_openclose_args) * \
297 /* struct xpc_msg flags */
299 #define XPC_M_DONE 0x01 /* msg has been received/consumed */
300 #define XPC_M_READY 0x02 /* msg is ready to be sent */
301 #define XPC_M_INTERRUPT 0x04 /* send interrupt when msg consumed */
303 #define XPC_MSG_ADDRESS(_payload) \
304 ((struct xpc_msg *)((u8 *)(_payload) - XPC_MSG_PAYLOAD_OFFSET))
307 * Defines notify entry.
309 * This is used to notify a message's sender that their message was received
310 * and consumed by the intended recipient.
313 u8 type; /* type of notification */
315 /* the following two fields are only used if type == XPC_N_CALL */
316 xpc_notify_func func; /* user's notify function */
317 void *key; /* pointer to user's key */
320 /* struct xpc_notify type of notification */
322 #define XPC_N_CALL 0x01 /* notify function provided by user */
325 * Define the structure that manages all the stuff required by a channel. In
326 * particular, they are used to manage the messages sent across the channel.
328 * This structure is private to a partition, and is NOT shared across the
329 * partition boundary.
331 * There is an array of these structures for each remote partition. It is
332 * allocated at the time a partition becomes active. The array contains one
333 * of these structures for each potential channel connection to that partition.
337 * The following is sn2 only.
339 * Each channel structure manages two message queues (circular buffers).
340 * They are allocated at the time a channel connection is made. One of
341 * these message queues (local_msgqueue) holds the locally created messages
342 * that are destined for the remote partition. The other of these message
343 * queues (remote_msgqueue) is a locally cached copy of the remote partition's
344 * own local_msgqueue.
346 * The following is a description of the Get/Put pointers used to manage these
347 * two message queues. Consider the local_msgqueue to be on one partition
348 * and the remote_msgqueue to be its cached copy on another partition. A
349 * description of what each of the lettered areas contains is included.
352 * local_msgqueue remote_msgqueue
354 * |/////////| |/////////|
355 * w_remote_GP.get --> +---------+ |/////////|
357 * remote_GP.get --> +---------+ +---------+ <-- local_GP->get
361 * | | +---------+ <-- w_local_GP.get
365 * | | +---------+ <-- w_remote_GP.put
367 * local_GP->put --> +---------+ +---------+ <-- remote_GP.put
371 * w_local_GP.put --> +---------+ |/////////|
372 * |/////////| |/////////|
375 * ( remote_GP.[get|put] are cached copies of the remote
376 * partition's local_GP->[get|put], and thus their values can
377 * lag behind their counterparts on the remote partition. )
380 * A - Messages that have been allocated, but have not yet been sent to the
383 * B - Messages that have been sent, but have not yet been acknowledged by the
384 * remote partition as having been received.
386 * C - Area that needs to be prepared for the copying of sent messages, by
387 * the clearing of the message flags of any previously received messages.
389 * D - Area into which sent messages are to be copied from the remote
390 * partition's local_msgqueue and then delivered to their intended
391 * recipients. [ To allow for a multi-message copy, another pointer
392 * (next_msg_to_pull) has been added to keep track of the next message
393 * number needing to be copied (pulled). It chases after w_remote_GP.put.
394 * Any messages lying between w_local_GP.get and next_msg_to_pull have
395 * been copied and are ready to be delivered. ]
397 * E - Messages that have been copied and delivered, but have not yet been
398 * acknowledged by the recipient as having been received.
400 * F - Messages that have been acknowledged, but XPC has not yet notified the
401 * sender that the message was received by its intended recipient.
402 * This is also an area that needs to be prepared for the allocating of
403 * new messages, by the clearing of the message flags of the acknowledged
407 struct xpc_channel_sn2 {
408 struct xpc_openclose_args *local_openclose_args; /* args passed on */
409 /* opening or closing of channel */
411 void *local_msgqueue_base; /* base address of kmalloc'd space */
412 struct xpc_msg *local_msgqueue; /* local message queue */
413 void *remote_msgqueue_base; /* base address of kmalloc'd space */
414 struct xpc_msg *remote_msgqueue; /* cached copy of remote partition's */
415 /* local message queue */
416 unsigned long remote_msgqueue_pa; /* phys addr of remote partition's */
417 /* local message queue */
419 struct xpc_notify *notify_queue; /* notify queue for messages sent */
421 /* various flavors of local and remote Get/Put values */
423 struct xpc_gp_sn2 *local_GP; /* local Get/Put values */
424 struct xpc_gp_sn2 remote_GP; /* remote Get/Put values */
425 struct xpc_gp_sn2 w_local_GP; /* working local Get/Put values */
426 struct xpc_gp_sn2 w_remote_GP; /* working remote Get/Put values */
427 s64 next_msg_to_pull; /* Put value of next msg to pull */
429 struct mutex msg_to_pull_mutex; /* next msg to pull serialization */
432 struct xpc_channel_uv {
433 unsigned long remote_notify_mq_gpa; /* gru phys address of remote */
434 /* partition's notify mq */
438 short partid; /* ID of remote partition connected */
439 spinlock_t lock; /* lock for updating this structure */
440 unsigned int flags; /* general flags */
442 enum xp_retval reason; /* reason why channel is disconnect'g */
443 int reason_line; /* line# disconnect initiated from */
445 u16 number; /* channel # */
447 u16 msg_size; /* sizeof each msg entry */
448 u16 local_nentries; /* #of msg entries in local msg queue */
449 u16 remote_nentries; /* #of msg entries in remote msg queue */
451 atomic_t references; /* #of external references to queues */
453 atomic_t n_on_msg_allocate_wq; /* #on msg allocation wait queue */
454 wait_queue_head_t msg_allocate_wq; /* msg allocation wait queue */
456 u8 delayed_chctl_flags; /* chctl flags received, but delayed */
457 /* action until channel disconnected */
459 atomic_t n_to_notify; /* #of msg senders to notify */
461 xpc_channel_func func; /* user's channel function */
462 void *key; /* pointer to user's key */
464 struct completion wdisconnect_wait; /* wait for channel disconnect */
466 /* kthread management related fields */
468 atomic_t kthreads_assigned; /* #of kthreads assigned to channel */
469 u32 kthreads_assigned_limit; /* limit on #of kthreads assigned */
470 atomic_t kthreads_idle; /* #of kthreads idle waiting for work */
471 u32 kthreads_idle_limit; /* limit on #of kthreads idle */
472 atomic_t kthreads_active; /* #of kthreads actively working */
474 wait_queue_head_t idle_wq; /* idle kthread wait queue */
477 struct xpc_channel_sn2 sn2;
478 struct xpc_channel_uv uv;
481 } ____cacheline_aligned;
483 /* struct xpc_channel flags */
485 #define XPC_C_WASCONNECTED 0x00000001 /* channel was connected */
487 #define XPC_C_ROPENREPLY 0x00000002 /* remote open channel reply */
488 #define XPC_C_OPENREPLY 0x00000004 /* local open channel reply */
489 #define XPC_C_ROPENREQUEST 0x00000008 /* remote open channel request */
490 #define XPC_C_OPENREQUEST 0x00000010 /* local open channel request */
492 #define XPC_C_SETUP 0x00000020 /* channel's msgqueues are alloc'd */
493 #define XPC_C_CONNECTEDCALLOUT 0x00000040 /* connected callout initiated */
494 #define XPC_C_CONNECTEDCALLOUT_MADE \
495 0x00000080 /* connected callout completed */
496 #define XPC_C_CONNECTED 0x00000100 /* local channel is connected */
497 #define XPC_C_CONNECTING 0x00000200 /* channel is being connected */
499 #define XPC_C_RCLOSEREPLY 0x00000400 /* remote close channel reply */
500 #define XPC_C_CLOSEREPLY 0x00000800 /* local close channel reply */
501 #define XPC_C_RCLOSEREQUEST 0x00001000 /* remote close channel request */
502 #define XPC_C_CLOSEREQUEST 0x00002000 /* local close channel request */
504 #define XPC_C_DISCONNECTED 0x00004000 /* channel is disconnected */
505 #define XPC_C_DISCONNECTING 0x00008000 /* channel is being disconnected */
506 #define XPC_C_DISCONNECTINGCALLOUT \
507 0x00010000 /* disconnecting callout initiated */
508 #define XPC_C_DISCONNECTINGCALLOUT_MADE \
509 0x00020000 /* disconnecting callout completed */
510 #define XPC_C_WDISCONNECT 0x00040000 /* waiting for channel disconnect */
513 * The channel control flags (chctl) union consists of a 64-bit variable which
514 * is divided up into eight bytes, ordered from right to left. Byte zero
515 * pertains to channel 0, byte one to channel 1, and so on. Each channel's byte
516 * can have one or more of the chctl flags set in it.
519 union xpc_channel_ctl_flags {
521 u8 flags[XPC_MAX_NCHANNELS];
525 #define XPC_CHCTL_CLOSEREQUEST 0x01
526 #define XPC_CHCTL_CLOSEREPLY 0x02
527 #define XPC_CHCTL_OPENREQUEST 0x04
528 #define XPC_CHCTL_OPENREPLY 0x08
529 #define XPC_CHCTL_MSGREQUEST 0x10
531 #define XPC_OPENCLOSE_CHCTL_FLAGS \
532 (XPC_CHCTL_CLOSEREQUEST | XPC_CHCTL_CLOSEREPLY | \
533 XPC_CHCTL_OPENREQUEST | XPC_CHCTL_OPENREPLY)
534 #define XPC_MSG_CHCTL_FLAGS XPC_CHCTL_MSGREQUEST
537 xpc_any_openclose_chctl_flags_set(union xpc_channel_ctl_flags *chctl)
541 for (ch_number = 0; ch_number < XPC_MAX_NCHANNELS; ch_number++) {
542 if (chctl->flags[ch_number] & XPC_OPENCLOSE_CHCTL_FLAGS)
549 xpc_any_msg_chctl_flags_set(union xpc_channel_ctl_flags *chctl)
553 for (ch_number = 0; ch_number < XPC_MAX_NCHANNELS; ch_number++) {
554 if (chctl->flags[ch_number] & XPC_MSG_CHCTL_FLAGS)
561 * Manage channels on a partition basis. There is one of these structures
562 * for each partition (a partition will never utilize the structure that
563 * represents itself).
566 struct xpc_partition_sn2 {
567 unsigned long remote_amos_page_pa; /* paddr of partition's amos page */
568 int activate_IRQ_nasid; /* active partition's act/deact nasid */
569 int activate_IRQ_phys_cpuid; /* active part's act/deact phys cpuid */
571 unsigned long remote_vars_pa; /* phys addr of partition's vars */
572 unsigned long remote_vars_part_pa; /* paddr of partition's vars part */
573 u8 remote_vars_version; /* version# of partition's vars */
575 void *local_GPs_base; /* base address of kmalloc'd space */
576 struct xpc_gp_sn2 *local_GPs; /* local Get/Put values */
577 void *remote_GPs_base; /* base address of kmalloc'd space */
578 struct xpc_gp_sn2 *remote_GPs; /* copy of remote partition's local */
580 unsigned long remote_GPs_pa; /* phys addr of remote partition's local */
583 void *local_openclose_args_base; /* base address of kmalloc'd space */
584 struct xpc_openclose_args *local_openclose_args; /* local's args */
585 unsigned long remote_openclose_args_pa; /* phys addr of remote's args */
587 int notify_IRQ_nasid; /* nasid of where to send notify IRQs */
588 int notify_IRQ_phys_cpuid; /* CPUID of where to send notify IRQs */
589 char notify_IRQ_owner[8]; /* notify IRQ's owner's name */
591 struct amo *remote_chctl_amo_va; /* addr of remote chctl flags' amo */
592 struct amo *local_chctl_amo_va; /* address of chctl flags' amo */
594 struct timer_list dropped_notify_IRQ_timer; /* dropped IRQ timer */
597 struct xpc_partition_uv {
598 unsigned long remote_activate_mq_gpa; /* gru phys address of remote */
599 /* partition's activate mq */
600 spinlock_t flags_lock; /* protect updating of flags */
601 unsigned int flags; /* general flags */
602 u8 remote_act_state; /* remote partition's act_state */
603 u8 act_state_req; /* act_state request from remote partition */
604 enum xp_retval reason; /* reason for deactivate act_state request */
605 u64 heartbeat; /* incremented by remote partition */
608 /* struct xpc_partition_uv flags */
610 #define XPC_P_HEARTBEAT_OFFLINE_UV 0x00000001
611 #define XPC_P_ENGAGED_UV 0x00000002
613 /* struct xpc_partition_uv act_state change requests */
615 #define XPC_P_ASR_ACTIVATE_UV 0x01
616 #define XPC_P_ASR_REACTIVATE_UV 0x02
617 #define XPC_P_ASR_DEACTIVATE_UV 0x03
619 struct xpc_partition {
621 /* XPC HB infrastructure */
623 u8 remote_rp_version; /* version# of partition's rsvd pg */
624 unsigned long remote_rp_ts_jiffies; /* timestamp when rsvd pg setup */
625 unsigned long remote_rp_pa; /* phys addr of partition's rsvd pg */
626 u64 last_heartbeat; /* HB at last read */
627 u32 activate_IRQ_rcvd; /* IRQs since activation */
628 spinlock_t act_lock; /* protect updating of act_state */
629 u8 act_state; /* from XPC HB viewpoint */
630 enum xp_retval reason; /* reason partition is deactivating */
631 int reason_line; /* line# deactivation initiated from */
633 unsigned long disengage_timeout; /* timeout in jiffies */
634 struct timer_list disengage_timer;
636 /* XPC infrastructure referencing and teardown control */
638 u8 setup_state; /* infrastructure setup state */
639 wait_queue_head_t teardown_wq; /* kthread waiting to teardown infra */
640 atomic_t references; /* #of references to infrastructure */
642 u8 nchannels; /* #of defined channels supported */
643 atomic_t nchannels_active; /* #of channels that are not DISCONNECTED */
644 atomic_t nchannels_engaged; /* #of channels engaged with remote part */
645 struct xpc_channel *channels; /* array of channel structures */
647 /* fields used for managing channel avialability and activity */
649 union xpc_channel_ctl_flags chctl; /* chctl flags yet to be processed */
650 spinlock_t chctl_lock; /* chctl flags lock */
652 void *remote_openclose_args_base; /* base address of kmalloc'd space */
653 struct xpc_openclose_args *remote_openclose_args; /* copy of remote's */
656 /* channel manager related fields */
658 atomic_t channel_mgr_requests; /* #of requests to activate chan mgr */
659 wait_queue_head_t channel_mgr_wq; /* channel mgr's wait queue */
662 struct xpc_partition_sn2 sn2;
663 struct xpc_partition_uv uv;
666 } ____cacheline_aligned;
668 /* struct xpc_partition act_state values (for XPC HB) */
670 #define XPC_P_AS_INACTIVE 0x00 /* partition is not active */
671 #define XPC_P_AS_ACTIVATION_REQ 0x01 /* created thread to activate */
672 #define XPC_P_AS_ACTIVATING 0x02 /* activation thread started */
673 #define XPC_P_AS_ACTIVE 0x03 /* xpc_partition_up() was called */
674 #define XPC_P_AS_DEACTIVATING 0x04 /* partition deactivation initiated */
676 #define XPC_DEACTIVATE_PARTITION(_p, _reason) \
677 xpc_deactivate_partition(__LINE__, (_p), (_reason))
679 /* struct xpc_partition setup_state values */
681 #define XPC_P_SS_UNSET 0x00 /* infrastructure was never setup */
682 #define XPC_P_SS_SETUP 0x01 /* infrastructure is setup */
683 #define XPC_P_SS_WTEARDOWN 0x02 /* waiting to teardown infrastructure */
684 #define XPC_P_SS_TORNDOWN 0x03 /* infrastructure is torndown */
687 * struct xpc_partition_sn2's dropped notify IRQ timer is set to wait the
688 * following interval #of seconds before checking for dropped notify IRQs.
689 * These can occur whenever an IRQ's associated amo write doesn't complete
690 * until after the IRQ was received.
692 #define XPC_DROPPED_NOTIFY_IRQ_WAIT_INTERVAL (0.25 * HZ)
694 /* number of seconds to wait for other partitions to disengage */
695 #define XPC_DISENGAGE_DEFAULT_TIMELIMIT 90
697 /* interval in seconds to print 'waiting deactivation' messages */
698 #define XPC_DEACTIVATE_PRINTMSG_INTERVAL 10
700 #define XPC_PARTID(_p) ((short)((_p) - &xpc_partitions[0]))
702 /* found in xp_main.c */
703 extern struct xpc_registration xpc_registrations[];
705 /* found in xpc_main.c */
706 extern struct device *xpc_part;
707 extern struct device *xpc_chan;
708 extern int xpc_disengage_timelimit;
709 extern int xpc_disengage_timedout;
710 extern int xpc_activate_IRQ_rcvd;
711 extern spinlock_t xpc_activate_IRQ_rcvd_lock;
712 extern wait_queue_head_t xpc_activate_IRQ_wq;
713 extern void *xpc_heartbeating_to_mask;
714 extern void *xpc_kzalloc_cacheline_aligned(size_t, gfp_t, void **);
715 extern void xpc_activate_partition(struct xpc_partition *);
716 extern void xpc_activate_kthreads(struct xpc_channel *, int);
717 extern void xpc_create_kthreads(struct xpc_channel *, int, int);
718 extern void xpc_disconnect_wait(int);
719 extern int (*xpc_setup_partitions_sn) (void);
720 extern enum xp_retval (*xpc_get_partition_rsvd_page_pa) (void *, u64 *,
723 extern int (*xpc_setup_rsvd_page_sn) (struct xpc_rsvd_page *);
724 extern void (*xpc_heartbeat_init) (void);
725 extern void (*xpc_heartbeat_exit) (void);
726 extern void (*xpc_increment_heartbeat) (void);
727 extern void (*xpc_offline_heartbeat) (void);
728 extern void (*xpc_online_heartbeat) (void);
729 extern enum xp_retval (*xpc_get_remote_heartbeat) (struct xpc_partition *);
730 extern enum xp_retval (*xpc_make_first_contact) (struct xpc_partition *);
731 extern u64 (*xpc_get_chctl_all_flags) (struct xpc_partition *);
732 extern enum xp_retval (*xpc_setup_msg_structures) (struct xpc_channel *);
733 extern void (*xpc_teardown_msg_structures) (struct xpc_channel *);
734 extern void (*xpc_notify_senders_of_disconnect) (struct xpc_channel *);
735 extern void (*xpc_process_msg_chctl_flags) (struct xpc_partition *, int);
736 extern int (*xpc_n_of_deliverable_msgs) (struct xpc_channel *);
737 extern struct xpc_msg *(*xpc_get_deliverable_msg) (struct xpc_channel *);
738 extern void (*xpc_request_partition_activation) (struct xpc_rsvd_page *,
740 extern void (*xpc_request_partition_reactivation) (struct xpc_partition *);
741 extern void (*xpc_request_partition_deactivation) (struct xpc_partition *);
742 extern void (*xpc_cancel_partition_deactivation_request) (
743 struct xpc_partition *);
744 extern void (*xpc_process_activate_IRQ_rcvd) (void);
745 extern enum xp_retval (*xpc_setup_ch_structures_sn) (struct xpc_partition *);
746 extern void (*xpc_teardown_ch_structures_sn) (struct xpc_partition *);
748 extern void (*xpc_indicate_partition_engaged) (struct xpc_partition *);
749 extern int (*xpc_partition_engaged) (short);
750 extern int (*xpc_any_partition_engaged) (void);
751 extern void (*xpc_indicate_partition_disengaged) (struct xpc_partition *);
752 extern void (*xpc_assume_partition_disengaged) (short);
754 extern void (*xpc_send_chctl_closerequest) (struct xpc_channel *,
756 extern void (*xpc_send_chctl_closereply) (struct xpc_channel *,
758 extern void (*xpc_send_chctl_openrequest) (struct xpc_channel *,
760 extern void (*xpc_send_chctl_openreply) (struct xpc_channel *, unsigned long *);
762 extern void (*xpc_save_remote_msgqueue_pa) (struct xpc_channel *,
765 extern enum xp_retval (*xpc_send_msg) (struct xpc_channel *, u32, void *, u16,
766 u8, xpc_notify_func, void *);
767 extern void (*xpc_received_msg) (struct xpc_channel *, struct xpc_msg *);
769 /* found in xpc_sn2.c */
770 extern int xpc_init_sn2(void);
771 extern void xpc_exit_sn2(void);
773 /* found in xpc_uv.c */
774 extern int xpc_init_uv(void);
775 extern void xpc_exit_uv(void);
777 /* found in xpc_partition.c */
778 extern int xpc_exiting;
779 extern int xpc_nasid_mask_nlongs;
780 extern struct xpc_rsvd_page *xpc_rsvd_page;
781 extern unsigned long *xpc_mach_nasids;
782 extern struct xpc_partition *xpc_partitions;
783 extern void *xpc_kmalloc_cacheline_aligned(size_t, gfp_t, void **);
784 extern int xpc_setup_rsvd_page(void);
785 extern void xpc_teardown_rsvd_page(void);
786 extern int xpc_identify_activate_IRQ_sender(void);
787 extern int xpc_partition_disengaged(struct xpc_partition *);
788 extern enum xp_retval xpc_mark_partition_active(struct xpc_partition *);
789 extern void xpc_mark_partition_inactive(struct xpc_partition *);
790 extern void xpc_discovery(void);
791 extern enum xp_retval xpc_get_remote_rp(int, unsigned long *,
792 struct xpc_rsvd_page *,
794 extern void xpc_deactivate_partition(const int, struct xpc_partition *,
796 extern enum xp_retval xpc_initiate_partid_to_nasids(short, void *);
798 /* found in xpc_channel.c */
799 extern void xpc_initiate_connect(int);
800 extern void xpc_initiate_disconnect(int);
801 extern enum xp_retval xpc_allocate_msg_wait(struct xpc_channel *);
802 extern enum xp_retval xpc_initiate_send(short, int, u32, void *, u16);
803 extern enum xp_retval xpc_initiate_send_notify(short, int, u32, void *, u16,
804 xpc_notify_func, void *);
805 extern void xpc_initiate_received(short, int, void *);
806 extern void xpc_process_sent_chctl_flags(struct xpc_partition *);
807 extern void xpc_connected_callout(struct xpc_channel *);
808 extern void xpc_deliver_msg(struct xpc_channel *);
809 extern void xpc_disconnect_channel(const int, struct xpc_channel *,
810 enum xp_retval, unsigned long *);
811 extern void xpc_disconnect_callout(struct xpc_channel *, enum xp_retval);
812 extern void xpc_partition_going_down(struct xpc_partition *, enum xp_retval);
815 xpc_hb_allowed(short partid, void *heartbeating_to_mask)
817 return test_bit(partid, heartbeating_to_mask);
821 xpc_any_hbs_allowed(void)
823 DBUG_ON(xpc_heartbeating_to_mask == NULL);
824 return !bitmap_empty(xpc_heartbeating_to_mask, xp_max_npartitions);
828 xpc_allow_hb(short partid)
830 DBUG_ON(xpc_heartbeating_to_mask == NULL);
831 set_bit(partid, xpc_heartbeating_to_mask);
835 xpc_disallow_hb(short partid)
837 DBUG_ON(xpc_heartbeating_to_mask == NULL);
838 clear_bit(partid, xpc_heartbeating_to_mask);
842 xpc_disallow_all_hbs(void)
844 DBUG_ON(xpc_heartbeating_to_mask == NULL);
845 bitmap_zero(xpc_heartbeating_to_mask, xp_max_npartitions);
849 xpc_wakeup_channel_mgr(struct xpc_partition *part)
851 if (atomic_inc_return(&part->channel_mgr_requests) == 1)
852 wake_up(&part->channel_mgr_wq);
856 * These next two inlines are used to keep us from tearing down a channel's
857 * msg queues while a thread may be referencing them.
860 xpc_msgqueue_ref(struct xpc_channel *ch)
862 atomic_inc(&ch->references);
866 xpc_msgqueue_deref(struct xpc_channel *ch)
868 s32 refs = atomic_dec_return(&ch->references);
872 xpc_wakeup_channel_mgr(&xpc_partitions[ch->partid]);
875 #define XPC_DISCONNECT_CHANNEL(_ch, _reason, _irqflgs) \
876 xpc_disconnect_channel(__LINE__, _ch, _reason, _irqflgs)
879 * These two inlines are used to keep us from tearing down a partition's
880 * setup infrastructure while a thread may be referencing it.
883 xpc_part_deref(struct xpc_partition *part)
885 s32 refs = atomic_dec_return(&part->references);
888 if (refs == 0 && part->setup_state == XPC_P_SS_WTEARDOWN)
889 wake_up(&part->teardown_wq);
893 xpc_part_ref(struct xpc_partition *part)
897 atomic_inc(&part->references);
898 setup = (part->setup_state == XPC_P_SS_SETUP);
900 xpc_part_deref(part);
906 * The following macro is to be used for the setting of the reason and
907 * reason_line fields in both the struct xpc_channel and struct xpc_partition
910 #define XPC_SET_REASON(_p, _reason, _line) \
912 (_p)->reason = _reason; \
913 (_p)->reason_line = _line; \
916 #endif /* _DRIVERS_MISC_SGIXP_XPC_H */