drivers/misc/sgi-xp/xpc.h

   1 /*
   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
   4  * for more details.
   5  *
   6  * Copyright (c) 2004-2008 Silicon Graphics, Inc.  All Rights Reserved.
   7  */
   8
   9 /*
  10  * Cross Partition Communication (XPC) structures and macros.
  11  */
  12
  13 #ifndef _DRIVERS_MISC_SGIXP_XPC_H
  14 #define _DRIVERS_MISC_SGIXP_XPC_H
  15
  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>
  27 #include "xp.h"
  28
  29 /*
  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
  32  * different major #.
  33  */
  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)
  37
  38 /*
  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.
  43  *
  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.
  48  */
  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)
  54
  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 */
  57
  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
  61
  62 /* define the process name of the discovery thread */
  63 #define XPC_DISCOVERY_THREAD_NAME       "xpc_discovery"
  64
  65 /*
  66  * the reserved page
  67  *
  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:
  71  *
  72  *   reserved page header
  73  *
  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.)
  80  *
  81  *   part_nasids mask
  82  *   mach_nasids mask
  83  *
  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.)
  94  *
  95  *   vars       (ia64-sn2 only)
  96  *   vars part  (ia64-sn2 only)
  97  *
  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.)
 103  *
 104  * Note: Until 'stamp' is set non-zero, the partition XPC code has not been
 105  *       initialized.
 106  */
 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 */
 112         u8 version;
 113         u8 pad1[3];             /* align to next u64 in 1st 64-byte cacheline */
 114         union {
 115                 u64 vars_pa;    /* physical address of struct xpc_vars */
 116                 u64 activate_mq_gpa;    /* global phys address of activate_mq */
 117         } sn;
 118         unsigned long stamp;    /* time when reserved page was setup by XPC */
 119         u64 pad2[10];           /* align to last u64 in 2nd 64-byte cacheline */
 120         u64 SAL_nasids_size;    /* SAL: size of each nasid mask in bytes */
 121 };
 122
 123 #define XPC_RP_VERSION _XPC_VERSION(2, 0) /* version 2.0 of the reserved page */
 124
 125 /*
 126  * Define the structures by which XPC variables can be exported to other
 127  * partitions. (There are two: struct xpc_vars and struct xpc_vars_part)
 128  */
 129
 130 /*
 131  * The following structure describes the partition generic variables
 132  * needed by other partitions in order to properly initialize.
 133  *
 134  * struct xpc_vars version number also applies to struct xpc_vars_part.
 135  * Changes to either structure and/or related functionality should be
 136  * reflected by incrementing either the major or minor version numbers
 137  * of struct xpc_vars.
 138  */
 139 struct xpc_vars_sn2 {
 140         u8 version;
 141         u64 heartbeat;
 142         DECLARE_BITMAP(heartbeating_to_mask, XP_MAX_NPARTITIONS_SN2);
 143         u64 heartbeat_offline;  /* if 0, heartbeat should be changing */
 144         int activate_IRQ_nasid;
 145         int activate_IRQ_phys_cpuid;
 146         u64 vars_part_pa;
 147         u64 amos_page_pa;       /* paddr of page of AMOs from MSPEC driver */
 148         AMO_t *amos_page;       /* vaddr of page of AMOs from MSPEC driver */
 149 };
 150
 151 #define XPC_V_VERSION _XPC_VERSION(3, 1)    /* version 3.1 of the cross vars */
 152
 153 /*
 154  * The following pertains to ia64-sn2 only.
 155  *
 156  * Memory for XPC's AMO variables is allocated by the MSPEC driver. These
 157  * pages are located in the lowest granule. The lowest granule uses 4k pages
 158  * for cached references and an alternate TLB handler to never provide a
 159  * cacheable mapping for the entire region. This will prevent speculative
 160  * reading of cached copies of our lines from being issued which will cause
 161  * a PI FSB Protocol error to be generated by the SHUB. For XPC, we need 64
 162  * AMO variables (based on XP_MAX_NPARTITIONS_SN2) to identify the senders of
 163  * NOTIFY IRQs, 128 AMO variables (based on XP_NASID_MASK_WORDS) to identify
 164  * the senders of ACTIVATE IRQs, 1 AMO variable to identify which remote
 165  * partitions (i.e., XPCs) consider themselves currently engaged with the
 166  * local XPC and 1 AMO variable to request partition deactivation.
 167  */
 168 #define XPC_NOTIFY_IRQ_AMOS     0
 169 #define XPC_ACTIVATE_IRQ_AMOS   (XPC_NOTIFY_IRQ_AMOS + XP_MAX_NPARTITIONS_SN2)
 170 #define XPC_ENGAGED_PARTITIONS_AMO (XPC_ACTIVATE_IRQ_AMOS + XP_NASID_MASK_WORDS)
 171 #define XPC_DEACTIVATE_REQUEST_AMO  (XPC_ENGAGED_PARTITIONS_AMO + 1)
 172
 173 /*
 174  * The following structure describes the per partition specific variables.
 175  *
 176  * An array of these structures, one per partition, will be defined. As a
 177  * partition becomes active XPC will copy the array entry corresponding to
 178  * itself from that partition. It is desirable that the size of this structure
 179  * evenly divides into a 128-byte cacheline, such that none of the entries in
 180  * this array crosses a 128-byte cacheline boundary. As it is now, each entry
 181  * occupies 64-bytes.
 182  */
 183 struct xpc_vars_part_sn2 {
 184         u64 magic;
 185
 186         u64 openclose_args_pa;  /* physical address of open and close args */
 187         u64 GPs_pa;             /* physical address of Get/Put values */
 188
 189         u64 chctl_amo_pa;       /* physical address of chctl flags' AMO_t */
 190
 191         int notify_IRQ_nasid;   /* nasid of where to send notify IRQs */
 192         int notify_IRQ_phys_cpuid;      /* CPUID of where to send notify IRQs */
 193
 194         u8 nchannels;           /* #of defined channels supported */
 195
 196         u8 reserved[23];        /* pad to a full 64 bytes */
 197 };
 198
 199 /*
 200  * The vars_part MAGIC numbers play a part in the first contact protocol.
 201  *
 202  * MAGIC1 indicates that the per partition specific variables for a remote
 203  * partition have been initialized by this partition.
 204  *
 205  * MAGIC2 indicates that this partition has pulled the remote partititions
 206  * per partition variables that pertain to this partition.
 207  */
 208 #define XPC_VP_MAGIC1   0x0053524156435058L   /* 'XPCVARS\0'L (little endian) */
 209 #define XPC_VP_MAGIC2   0x0073726176435058L   /* 'XPCvars\0'L (little endian) */
 210
 211 /* the reserved page sizes and offsets */
 212
 213 #define XPC_RP_HEADER_SIZE      L1_CACHE_ALIGN(sizeof(struct xpc_rsvd_page))
 214 #define XPC_RP_VARS_SIZE        L1_CACHE_ALIGN(sizeof(struct xpc_vars_sn2))
 215
 216 #define XPC_RP_PART_NASIDS(_rp) ((u64 *)((u8 *)(_rp) + XPC_RP_HEADER_SIZE))
 217 #define XPC_RP_MACH_NASIDS(_rp) (XPC_RP_PART_NASIDS(_rp) + xp_nasid_mask_words)
 218 #define XPC_RP_VARS(_rp)        ((struct xpc_vars_sn2 *)(XPC_RP_MACH_NASIDS(_rp) + \
 219                                     xp_nasid_mask_words))
 220
 221 /*
 222  * Functions registered by add_timer() or called by kernel_thread() only
 223  * allow for a single 64-bit argument. The following macros can be used to
 224  * pack and unpack two (32-bit, 16-bit or 8-bit) arguments into or out from
 225  * the passed argument.
 226  */
 227 #define XPC_PACK_ARGS(_arg1, _arg2) \
 228                         ((((u64) _arg1) & 0xffffffff) | \
 229                         ((((u64) _arg2) & 0xffffffff) << 32))
 230
 231 #define XPC_UNPACK_ARG1(_args)  (((u64) _args) & 0xffffffff)
 232 #define XPC_UNPACK_ARG2(_args)  ((((u64) _args) >> 32) & 0xffffffff)
 233
 234 /*
 235  * Define a Get/Put value pair (pointers) used with a message queue.
 236  */
 237 struct xpc_gp {
 238         s64 get;                /* Get value */
 239         s64 put;                /* Put value */
 240 };
 241
 242 #define XPC_GP_SIZE \
 243                 L1_CACHE_ALIGN(sizeof(struct xpc_gp) * XPC_MAX_NCHANNELS)
 244
 245 /*
 246  * Define a structure that contains arguments associated with opening and
 247  * closing a channel.
 248  */
 249 struct xpc_openclose_args {
 250         u16 reason;             /* reason why channel is closing */
 251         u16 msg_size;           /* sizeof each message entry */
 252         u16 remote_nentries;    /* #of message entries in remote msg queue */
 253         u16 local_nentries;     /* #of message entries in local msg queue */
 254         u64 local_msgqueue_pa;  /* physical address of local message queue */
 255 };
 256
 257 #define XPC_OPENCLOSE_ARGS_SIZE \
 258               L1_CACHE_ALIGN(sizeof(struct xpc_openclose_args) * \
 259               XPC_MAX_NCHANNELS)
 260
 261 /* struct xpc_msg flags */
 262
 263 #define XPC_M_DONE              0x01    /* msg has been received/consumed */
 264 #define XPC_M_READY             0x02    /* msg is ready to be sent */
 265 #define XPC_M_INTERRUPT         0x04    /* send interrupt when msg consumed */
 266
 267 #define XPC_MSG_ADDRESS(_payload) \
 268                 ((struct xpc_msg *)((u8 *)(_payload) - XPC_MSG_PAYLOAD_OFFSET))
 269
 270 /*
 271  * Defines notify entry.
 272  *
 273  * This is used to notify a message's sender that their message was received
 274  * and consumed by the intended recipient.
 275  */
 276 struct xpc_notify {
 277         u8 type;                /* type of notification */
 278
 279         /* the following two fields are only used if type == XPC_N_CALL */
 280         xpc_notify_func func;   /* user's notify function */
 281         void *key;              /* pointer to user's key */
 282 };
 283
 284 /* struct xpc_notify type of notification */
 285
 286 #define XPC_N_CALL              0x01    /* notify function provided by user */
 287
 288 /*
 289  * Define the structure that manages all the stuff required by a channel. In
 290  * particular, they are used to manage the messages sent across the channel.
 291  *
 292  * This structure is private to a partition, and is NOT shared across the
 293  * partition boundary.
 294  *
 295  * There is an array of these structures for each remote partition. It is
 296  * allocated at the time a partition becomes active. The array contains one
 297  * of these structures for each potential channel connection to that partition.
 298  *
 299 >>> sn2 only!!!
 300  * Each of these structures manages two message queues (circular buffers).
 301  * They are allocated at the time a channel connection is made. One of
 302  * these message queues (local_msgqueue) holds the locally created messages
 303  * that are destined for the remote partition. The other of these message
 304  * queues (remote_msgqueue) is a locally cached copy of the remote partition's
 305  * own local_msgqueue.
 306  *
 307  * The following is a description of the Get/Put pointers used to manage these
 308  * two message queues. Consider the local_msgqueue to be on one partition
 309  * and the remote_msgqueue to be its cached copy on another partition. A
 310  * description of what each of the lettered areas contains is included.
 311  *
 312  *
 313  *                     local_msgqueue      remote_msgqueue
 314  *
 315  *                        |/////////|      |/////////|
 316  *    w_remote_GP.get --> +---------+      |/////////|
 317  *                        |    F    |      |/////////|
 318  *     remote_GP.get  --> +---------+      +---------+ <-- local_GP->get
 319  *                        |         |      |         |
 320  *                        |         |      |    E    |
 321  *                        |         |      |         |
 322  *                        |         |      +---------+ <-- w_local_GP.get
 323  *                        |    B    |      |/////////|
 324  *                        |         |      |////D////|
 325  *                        |         |      |/////////|
 326  *                        |         |      +---------+ <-- w_remote_GP.put
 327  *                        |         |      |////C////|
 328  *      local_GP->put --> +---------+      +---------+ <-- remote_GP.put
 329  *                        |         |      |/////////|
 330  *                        |    A    |      |/////////|
 331  *                        |         |      |/////////|
 332  *     w_local_GP.put --> +---------+      |/////////|
 333  *                        |/////////|      |/////////|
 334  *
 335  *
 336  *          ( remote_GP.[get|put] are cached copies of the remote
 337  *            partition's local_GP->[get|put], and thus their values can
 338  *            lag behind their counterparts on the remote partition. )
 339  *
 340  *
 341  *  A - Messages that have been allocated, but have not yet been sent to the
 342  *      remote partition.
 343  *
 344  *  B - Messages that have been sent, but have not yet been acknowledged by the
 345  *      remote partition as having been received.
 346  *
 347  *  C - Area that needs to be prepared for the copying of sent messages, by
 348  *      the clearing of the message flags of any previously received messages.
 349  *
 350  *  D - Area into which sent messages are to be copied from the remote
 351  *      partition's local_msgqueue and then delivered to their intended
 352  *      recipients. [ To allow for a multi-message copy, another pointer
 353  *      (next_msg_to_pull) has been added to keep track of the next message
 354  *      number needing to be copied (pulled). It chases after w_remote_GP.put.
 355  *      Any messages lying between w_local_GP.get and next_msg_to_pull have
 356  *      been copied and are ready to be delivered. ]
 357  *
 358  *  E - Messages that have been copied and delivered, but have not yet been
 359  *      acknowledged by the recipient as having been received.
 360  *
 361  *  F - Messages that have been acknowledged, but XPC has not yet notified the
 362  *      sender that the message was received by its intended recipient.
 363  *      This is also an area that needs to be prepared for the allocating of
 364  *      new messages, by the clearing of the message flags of the acknowledged
 365  *      messages.
 366  */
 367 struct xpc_channel_sn2 {
 368
 369         /* various flavors of local and remote Get/Put values */
 370
 371         struct xpc_gp *local_GP;        /* local Get/Put values */
 372         struct xpc_gp remote_GP;        /* remote Get/Put values */
 373         struct xpc_gp w_local_GP;       /* working local Get/Put values */
 374         struct xpc_gp w_remote_GP;      /* working remote Get/Put values */
 375         s64 next_msg_to_pull;   /* Put value of next msg to pull */
 376
 377         struct mutex msg_to_pull_mutex; /* next msg to pull serialization */
 378 };
 379
 380 struct xpc_channel_uv {
 381         /* >>> code is coming */
 382 };
 383
 384 struct xpc_channel {
 385         short partid;           /* ID of remote partition connected */
 386         spinlock_t lock;        /* lock for updating this structure */
 387         u32 flags;              /* general flags */
 388
 389         enum xp_retval reason;  /* reason why channel is disconnect'g */
 390         int reason_line;        /* line# disconnect initiated from */
 391
 392         u16 number;             /* channel # */
 393
 394         u16 msg_size;           /* sizeof each msg entry */
 395         u16 local_nentries;     /* #of msg entries in local msg queue */
 396         u16 remote_nentries;    /* #of msg entries in remote msg queue */
 397
 398         void *local_msgqueue_base;      /* base address of kmalloc'd space */
 399         struct xpc_msg *local_msgqueue; /* local message queue */
 400         void *remote_msgqueue_base;     /* base address of kmalloc'd space */
 401         struct xpc_msg *remote_msgqueue; /* cached copy of remote partition's */
 402                                          /* local message queue */
 403         u64 remote_msgqueue_pa; /* phys addr of remote partition's */
 404                                 /* local message queue */
 405
 406         atomic_t references;    /* #of external references to queues */
 407
 408         atomic_t n_on_msg_allocate_wq;  /* #on msg allocation wait queue */
 409         wait_queue_head_t msg_allocate_wq;      /* msg allocation wait queue */
 410
 411         u8 delayed_chctl_flags; /* chctl flags received, but delayed */
 412                                 /* action until channel disconnected */
 413
 414         /* queue of msg senders who want to be notified when msg received */
 415
 416         atomic_t n_to_notify;   /* #of msg senders to notify */
 417         struct xpc_notify *notify_queue;    /* notify queue for messages sent */
 418
 419         xpc_channel_func func;  /* user's channel function */
 420         void *key;              /* pointer to user's key */
 421
 422         struct completion wdisconnect_wait;    /* wait for channel disconnect */
 423
 424         struct xpc_openclose_args *local_openclose_args; /* args passed on */
 425                                              /* opening or closing of channel */
 426
 427         /* kthread management related fields */
 428
 429         atomic_t kthreads_assigned;     /* #of kthreads assigned to channel */
 430         u32 kthreads_assigned_limit;    /* limit on #of kthreads assigned */
 431         atomic_t kthreads_idle; /* #of kthreads idle waiting for work */
 432         u32 kthreads_idle_limit;        /* limit on #of kthreads idle */
 433         atomic_t kthreads_active;       /* #of kthreads actively working */
 434
 435         wait_queue_head_t idle_wq;      /* idle kthread wait queue */
 436
 437         union {
 438                 struct xpc_channel_sn2 sn2;
 439                 struct xpc_channel_uv uv;
 440         } sn;
 441
 442 } ____cacheline_aligned;
 443
 444 /* struct xpc_channel flags */
 445
 446 #define XPC_C_WASCONNECTED      0x00000001      /* channel was connected */
 447
 448 #define XPC_C_ROPENREPLY        0x00000002      /* remote open channel reply */
 449 #define XPC_C_OPENREPLY         0x00000004      /* local open channel reply */
 450 #define XPC_C_ROPENREQUEST      0x00000008     /* remote open channel request */
 451 #define XPC_C_OPENREQUEST       0x00000010      /* local open channel request */
 452
 453 #define XPC_C_SETUP             0x00000020 /* channel's msgqueues are alloc'd */
 454 #define XPC_C_CONNECTEDCALLOUT  0x00000040     /* connected callout initiated */
 455 #define XPC_C_CONNECTEDCALLOUT_MADE \
 456                                 0x00000080     /* connected callout completed */
 457 #define XPC_C_CONNECTED         0x00000100      /* local channel is connected */
 458 #define XPC_C_CONNECTING        0x00000200      /* channel is being connected */
 459
 460 #define XPC_C_RCLOSEREPLY       0x00000400      /* remote close channel reply */
 461 #define XPC_C_CLOSEREPLY        0x00000800      /* local close channel reply */
 462 #define XPC_C_RCLOSEREQUEST     0x00001000    /* remote close channel request */
 463 #define XPC_C_CLOSEREQUEST      0x00002000     /* local close channel request */
 464
 465 #define XPC_C_DISCONNECTED      0x00004000      /* channel is disconnected */
 466 #define XPC_C_DISCONNECTING     0x00008000   /* channel is being disconnected */
 467 #define XPC_C_DISCONNECTINGCALLOUT \
 468                                 0x00010000 /* disconnecting callout initiated */
 469 #define XPC_C_DISCONNECTINGCALLOUT_MADE \
 470                                 0x00020000 /* disconnecting callout completed */
 471 #define XPC_C_WDISCONNECT       0x00040000  /* waiting for channel disconnect */
 472
 473 /*
 474  * The channel control flags (chctl) union consists of a 64-bit variable which
 475  * is divided up into eight bytes, ordered from right to left. Byte zero
 476  * pertains to channel 0, byte one to channel 1, and so on. Each channel's byte
 477  * can have one or more of the chctl flags set in it.
 478  */
 479
 480 union xpc_channel_ctl_flags {
 481         u64 all_flags;
 482         u8 flags[XPC_MAX_NCHANNELS];
 483 };
 484
 485 /* chctl flags */
 486 #define XPC_CHCTL_CLOSEREQUEST  0x01
 487 #define XPC_CHCTL_CLOSEREPLY    0x02
 488 #define XPC_CHCTL_OPENREQUEST   0x04
 489 #define XPC_CHCTL_OPENREPLY     0x08
 490 #define XPC_CHCTL_MSGREQUEST    0x10
 491
 492 #define XPC_OPENCLOSE_CHCTL_FLAGS \
 493                         (XPC_CHCTL_CLOSEREQUEST | XPC_CHCTL_CLOSEREPLY | \
 494                          XPC_CHCTL_OPENREQUEST | XPC_CHCTL_OPENREPLY)
 495 #define XPC_MSG_CHCTL_FLAGS     XPC_CHCTL_MSGREQUEST
 496
 497 static inline int
 498 xpc_any_openclose_chctl_flags_set(union xpc_channel_ctl_flags *chctl)
 499 {
 500         int ch_number;
 501
 502         for (ch_number = 0; ch_number < XPC_MAX_NCHANNELS; ch_number++) {
 503                 if (chctl->flags[ch_number] & XPC_OPENCLOSE_CHCTL_FLAGS)
 504                         return 1;
 505         }
 506         return 0;
 507 }
 508
 509 static inline int
 510 xpc_any_msg_chctl_flags_set(union xpc_channel_ctl_flags *chctl)
 511 {
 512         int ch_number;
 513
 514         for (ch_number = 0; ch_number < XPC_MAX_NCHANNELS; ch_number++) {
 515                 if (chctl->flags[ch_number] & XPC_MSG_CHCTL_FLAGS)
 516                         return 1;
 517         }
 518         return 0;
 519 }
 520
 521 /*
 522  * Manages channels on a partition basis. There is one of these structures
 523  * for each partition (a partition will never utilize the structure that
 524  * represents itself).
 525  */
 526
 527 struct xpc_partition_sn2 {
 528         u64 remote_amos_page_pa;        /* phys addr of partition's amos page */
 529         int activate_IRQ_nasid; /* active partition's act/deact nasid */
 530         int activate_IRQ_phys_cpuid;    /* active part's act/deact phys cpuid */
 531
 532         u64 remote_vars_pa;     /* phys addr of partition's vars */
 533         u64 remote_vars_part_pa;        /* phys addr of partition's vars part */
 534         u8 remote_vars_version; /* version# of partition's vars */
 535
 536         void *local_GPs_base;   /* base address of kmalloc'd space */
 537         struct xpc_gp *local_GPs;       /* local Get/Put values */
 538         void *remote_GPs_base;  /* base address of kmalloc'd space */
 539         struct xpc_gp *remote_GPs;      /* copy of remote partition's local */
 540                                         /* Get/Put values */
 541         u64 remote_GPs_pa;      /* phys address of remote partition's local */
 542                                 /* Get/Put values */
 543
 544         u64 remote_openclose_args_pa;   /* phys addr of remote's args */
 545
 546         int notify_IRQ_nasid;   /* nasid of where to send notify IRQs */
 547         int notify_IRQ_phys_cpuid;      /* CPUID of where to send notify IRQs */
 548         char notify_IRQ_owner[8];       /* notify IRQ's owner's name */
 549
 550         AMO_t *remote_chctl_amo_va; /* address of remote chctl flags' AMO_t */
 551         AMO_t *local_chctl_amo_va;      /* address of chctl flags' AMO_t */
 552
 553         struct timer_list dropped_notify_IRQ_timer;     /* dropped IRQ timer */
 554 };
 555
 556 struct xpc_partition_uv {
 557         /* >>> code is coming */
 558 };
 559
 560 struct xpc_partition {
 561
 562         /* XPC HB infrastructure */
 563
 564         u8 remote_rp_version;   /* version# of partition's rsvd pg */
 565         unsigned long remote_rp_stamp; /* time when rsvd pg was initialized */
 566         u64 remote_rp_pa;       /* phys addr of partition's rsvd pg */
 567         u64 last_heartbeat;     /* HB at last read */
 568         u32 activate_IRQ_rcvd;  /* IRQs since activation */
 569         spinlock_t act_lock;    /* protect updating of act_state */
 570         u8 act_state;           /* from XPC HB viewpoint */
 571         enum xp_retval reason;  /* reason partition is deactivating */
 572         int reason_line;        /* line# deactivation initiated from */
 573
 574         unsigned long disengage_timeout;        /* timeout in jiffies */
 575         struct timer_list disengage_timer;
 576
 577         /* XPC infrastructure referencing and teardown control */
 578
 579         u8 setup_state;         /* infrastructure setup state */
 580         wait_queue_head_t teardown_wq;  /* kthread waiting to teardown infra */
 581         atomic_t references;    /* #of references to infrastructure */
 582
 583         u8 nchannels;           /* #of defined channels supported */
 584         atomic_t nchannels_active;  /* #of channels that are not DISCONNECTED */
 585         atomic_t nchannels_engaged;  /* #of channels engaged with remote part */
 586         struct xpc_channel *channels;   /* array of channel structures */
 587
 588         /* fields used for managing channel avialability and activity */
 589
 590         union xpc_channel_ctl_flags chctl; /* chctl flags yet to be processed */
 591         spinlock_t chctl_lock;  /* chctl flags lock */
 592
 593         void *local_openclose_args_base;   /* base address of kmalloc'd space */
 594         struct xpc_openclose_args *local_openclose_args;      /* local's args */
 595         void *remote_openclose_args_base;  /* base address of kmalloc'd space */
 596         struct xpc_openclose_args *remote_openclose_args; /* copy of remote's */
 597                                                           /* args */
 598
 599         /* channel manager related fields */
 600
 601         atomic_t channel_mgr_requests;  /* #of requests to activate chan mgr */
 602         wait_queue_head_t channel_mgr_wq;       /* channel mgr's wait queue */
 603
 604         union {
 605                 struct xpc_partition_sn2 sn2;
 606                 struct xpc_partition_uv uv;
 607         } sn;
 608
 609 } ____cacheline_aligned;
 610
 611 /* struct xpc_partition act_state values (for XPC HB) */
 612
 613 #define XPC_P_INACTIVE          0x00    /* partition is not active */
 614 #define XPC_P_ACTIVATION_REQ    0x01    /* created thread to activate */
 615 #define XPC_P_ACTIVATING        0x02    /* activation thread started */
 616 #define XPC_P_ACTIVE            0x03    /* xpc_partition_up() was called */
 617 #define XPC_P_DEACTIVATING      0x04    /* partition deactivation initiated */
 618
 619 #define XPC_DEACTIVATE_PARTITION(_p, _reason) \
 620                         xpc_deactivate_partition(__LINE__, (_p), (_reason))
 621
 622 /* struct xpc_partition setup_state values */
 623
 624 #define XPC_P_UNSET             0x00    /* infrastructure was never setup */
 625 #define XPC_P_SETUP             0x01    /* infrastructure is setup */
 626 #define XPC_P_WTEARDOWN         0x02    /* waiting to teardown infrastructure */
 627 #define XPC_P_TORNDOWN          0x03    /* infrastructure is torndown */
 628
 629 /*
 630  * struct xpc_partition_sn2's dropped notify IRQ timer is set to wait the
 631  * following interval #of seconds before checking for dropped notify IRQs.
 632  * These can occur whenever an IRQ's associated amo write doesn't complete
 633  * until after the IRQ was received.
 634  */
 635 #define XPC_DROPPED_NOTIFY_IRQ_WAIT_INTERVAL    (0.25 * HZ)
 636
 637 /* number of seconds to wait for other partitions to disengage */
 638 #define XPC_DISENGAGE_DEFAULT_TIMELIMIT         90
 639
 640 /* interval in seconds to print 'waiting deactivation' messages */
 641 #define XPC_DEACTIVATE_PRINTMSG_INTERVAL        10
 642
 643 #define XPC_PARTID(_p)  ((short)((_p) - &xpc_partitions[0]))
 644
 645 /* found in xp_main.c */
 646 extern struct xpc_registration xpc_registrations[];
 647
 648 /* found in xpc_main.c */
 649 extern struct device *xpc_part;
 650 extern struct device *xpc_chan;
 651 extern int xpc_disengage_timelimit;
 652 extern int xpc_disengage_timedout;
 653 extern atomic_t xpc_activate_IRQ_rcvd;
 654 extern wait_queue_head_t xpc_activate_IRQ_wq;
 655 extern void *xpc_heartbeating_to_mask;
 656 extern void xpc_activate_partition(struct xpc_partition *);
 657 extern void xpc_activate_kthreads(struct xpc_channel *, int);
 658 extern void xpc_create_kthreads(struct xpc_channel *, int, int);
 659 extern void xpc_disconnect_wait(int);
 660 extern enum xp_retval (*xpc_rsvd_page_init) (struct xpc_rsvd_page *);
 661 extern void (*xpc_heartbeat_init) (void);
 662 extern void (*xpc_heartbeat_exit) (void);
 663 extern void (*xpc_increment_heartbeat) (void);
 664 extern void (*xpc_offline_heartbeat) (void);
 665 extern void (*xpc_online_heartbeat) (void);
 666 extern void (*xpc_check_remote_hb) (void);
 667 extern enum xp_retval (*xpc_make_first_contact) (struct xpc_partition *);
 668 extern u64 (*xpc_get_chctl_all_flags) (struct xpc_partition *);
 669 extern void (*xpc_notify_senders_of_disconnect) (struct xpc_channel *);
 670 extern void (*xpc_process_msg_chctl_flags) (struct xpc_partition *, int);
 671 extern int (*xpc_n_of_deliverable_msgs) (struct xpc_channel *);
 672 extern struct xpc_msg *(*xpc_get_deliverable_msg) (struct xpc_channel *);
 673 extern void (*xpc_request_partition_activation) (struct xpc_rsvd_page *, u64,
 674                                                  int);
 675 extern void (*xpc_request_partition_reactivation) (struct xpc_partition *);
 676 extern void (*xpc_request_partition_deactivation) (struct xpc_partition *);
 677 extern void (*xpc_cancel_partition_deactivation_request) (
 678                                                         struct xpc_partition *);
 679 extern void (*xpc_process_activate_IRQ_rcvd) (int);
 680 extern enum xp_retval (*xpc_setup_infrastructure) (struct xpc_partition *);
 681 extern void (*xpc_teardown_infrastructure) (struct xpc_partition *);
 682
 683 extern void (*xpc_indicate_partition_engaged) (struct xpc_partition *);
 684 extern int (*xpc_partition_engaged) (short);
 685 extern int (*xpc_any_partition_engaged) (void);
 686 extern void (*xpc_indicate_partition_disengaged) (struct xpc_partition *);
 687 extern void (*xpc_assume_partition_disengaged) (short);
 688
 689 extern void (*xpc_send_chctl_closerequest) (struct xpc_channel *,
 690                                             unsigned long *);
 691 extern void (*xpc_send_chctl_closereply) (struct xpc_channel *,
 692                                           unsigned long *);
 693 extern void (*xpc_send_chctl_openrequest) (struct xpc_channel *,
 694                                            unsigned long *);
 695 extern void (*xpc_send_chctl_openreply) (struct xpc_channel *, unsigned long *);
 696
 697 extern enum xp_retval (*xpc_send_msg) (struct xpc_channel *, u32, void *, u16,
 698                                        u8, xpc_notify_func, void *);
 699 extern void (*xpc_received_msg) (struct xpc_channel *, struct xpc_msg *);
 700
 701 /* found in xpc_sn2.c */
 702 extern int xpc_init_sn2(void);
 703 extern void xpc_exit_sn2(void);
 704
 705 /* found in xpc_uv.c */
 706 extern void xpc_init_uv(void);
 707 extern void xpc_exit_uv(void);
 708
 709 /* found in xpc_partition.c */
 710 extern int xpc_exiting;
 711 extern int xp_nasid_mask_words;
 712 extern struct xpc_rsvd_page *xpc_rsvd_page;
 713 extern u64 *xpc_mach_nasids;
 714 extern struct xpc_partition *xpc_partitions;
 715 extern char *xpc_remote_copy_buffer;
 716 extern void *xpc_remote_copy_buffer_base;
 717 extern void *xpc_kmalloc_cacheline_aligned(size_t, gfp_t, void **);
 718 extern struct xpc_rsvd_page *xpc_setup_rsvd_page(void);
 719 extern int xpc_identify_activate_IRQ_sender(void);
 720 extern int xpc_partition_disengaged(struct xpc_partition *);
 721 extern enum xp_retval xpc_mark_partition_active(struct xpc_partition *);
 722 extern void xpc_mark_partition_inactive(struct xpc_partition *);
 723 extern void xpc_discovery(void);
 724 extern enum xp_retval xpc_get_remote_rp(int, u64 *, struct xpc_rsvd_page *,
 725                                         u64 *);
 726 extern void xpc_deactivate_partition(const int, struct xpc_partition *,
 727                                      enum xp_retval);
 728 extern enum xp_retval xpc_initiate_partid_to_nasids(short, void *);
 729
 730 /* found in xpc_channel.c */
 731 extern void *xpc_kzalloc_cacheline_aligned(size_t, gfp_t, void **);
 732 extern void xpc_initiate_connect(int);
 733 extern void xpc_initiate_disconnect(int);
 734 extern enum xp_retval xpc_allocate_msg_wait(struct xpc_channel *);
 735 extern enum xp_retval xpc_initiate_send(short, int, u32, void *, u16);
 736 extern enum xp_retval xpc_initiate_send_notify(short, int, u32, void *, u16,
 737                                                xpc_notify_func, void *);
 738 extern void xpc_initiate_received(short, int, void *);
 739 extern void xpc_process_sent_chctl_flags(struct xpc_partition *);
 740 extern void xpc_connected_callout(struct xpc_channel *);
 741 extern void xpc_deliver_msg(struct xpc_channel *);
 742 extern void xpc_disconnect_channel(const int, struct xpc_channel *,
 743                                    enum xp_retval, unsigned long *);
 744 extern void xpc_disconnect_callout(struct xpc_channel *, enum xp_retval);
 745 extern void xpc_partition_going_down(struct xpc_partition *, enum xp_retval);
 746
 747 static inline int
 748 xpc_hb_allowed(short partid, void *heartbeating_to_mask)
 749 {
 750         return test_bit(partid, heartbeating_to_mask);
 751 }
 752
 753 static inline int
 754 xpc_any_hbs_allowed(void)
 755 {
 756         DBUG_ON(xpc_heartbeating_to_mask == NULL);
 757         return !bitmap_empty(xpc_heartbeating_to_mask, xp_max_npartitions);
 758 }
 759
 760 static inline void
 761 xpc_allow_hb(short partid)
 762 {
 763         DBUG_ON(xpc_heartbeating_to_mask == NULL);
 764         set_bit(partid, xpc_heartbeating_to_mask);
 765 }
 766
 767 static inline void
 768 xpc_disallow_hb(short partid)
 769 {
 770         DBUG_ON(xpc_heartbeating_to_mask == NULL);
 771         clear_bit(partid, xpc_heartbeating_to_mask);
 772 }
 773
 774 static inline void
 775 xpc_disallow_all_hbs(void)
 776 {
 777         DBUG_ON(xpc_heartbeating_to_mask == NULL);
 778         bitmap_zero(xpc_heartbeating_to_mask, xp_max_npartitions);
 779 }
 780
 781 static inline void
 782 xpc_wakeup_channel_mgr(struct xpc_partition *part)
 783 {
 784         if (atomic_inc_return(&part->channel_mgr_requests) == 1)
 785                 wake_up(&part->channel_mgr_wq);
 786 }
 787
 788 /*
 789  * These next two inlines are used to keep us from tearing down a channel's
 790  * msg queues while a thread may be referencing them.
 791  */
 792 static inline void
 793 xpc_msgqueue_ref(struct xpc_channel *ch)
 794 {
 795         atomic_inc(&ch->references);
 796 }
 797
 798 static inline void
 799 xpc_msgqueue_deref(struct xpc_channel *ch)
 800 {
 801         s32 refs = atomic_dec_return(&ch->references);
 802
 803         DBUG_ON(refs < 0);
 804         if (refs == 0)
 805                 xpc_wakeup_channel_mgr(&xpc_partitions[ch->partid]);
 806 }
 807
 808 #define XPC_DISCONNECT_CHANNEL(_ch, _reason, _irqflgs) \
 809                 xpc_disconnect_channel(__LINE__, _ch, _reason, _irqflgs)
 810
 811 /*
 812  * These two inlines are used to keep us from tearing down a partition's
 813  * setup infrastructure while a thread may be referencing it.
 814  */
 815 static inline void
 816 xpc_part_deref(struct xpc_partition *part)
 817 {
 818         s32 refs = atomic_dec_return(&part->references);
 819
 820         DBUG_ON(refs < 0);
 821         if (refs == 0 && part->setup_state == XPC_P_WTEARDOWN)
 822                 wake_up(&part->teardown_wq);
 823 }
 824
 825 static inline int
 826 xpc_part_ref(struct xpc_partition *part)
 827 {
 828         int setup;
 829
 830         atomic_inc(&part->references);
 831         setup = (part->setup_state == XPC_P_SETUP);
 832         if (!setup)
 833                 xpc_part_deref(part);
 834
 835         return setup;
 836 }
 837
 838 /*
 839  * The following macro is to be used for the setting of the reason and
 840  * reason_line fields in both the struct xpc_channel and struct xpc_partition
 841  * structures.
 842  */
 843 #define XPC_SET_REASON(_p, _reason, _line) \
 844         { \
 845                 (_p)->reason = _reason; \
 846                 (_p)->reason_line = _line; \
 847         }
 848
 849 #endif /* _DRIVERS_MISC_SGIXP_XPC_H */