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 IPI_amo_pa;         /* physical address of IPI AMO_t structure */
 190         int IPI_nasid;          /* nasid of where to send IPIs */
 191         int IPI_phys_cpuid;     /* physical CPU ID of where to send IPIs */
 192
 193         u8 nchannels;           /* #of defined channels supported */
 194
 195         u8 reserved[23];        /* pad to a full 64 bytes */
 196 };
 197
 198 /*
 199  * The vars_part MAGIC numbers play a part in the first contact protocol.
 200  *
 201  * MAGIC1 indicates that the per partition specific variables for a remote
 202  * partition have been initialized by this partition.
 203  *
 204  * MAGIC2 indicates that this partition has pulled the remote partititions
 205  * per partition variables that pertain to this partition.
 206  */
 207 #define XPC_VP_MAGIC1   0x0053524156435058L   /* 'XPCVARS\0'L (little endian) */
 208 #define XPC_VP_MAGIC2   0x0073726176435058L   /* 'XPCvars\0'L (little endian) */
 209
 210 /* the reserved page sizes and offsets */
 211
 212 #define XPC_RP_HEADER_SIZE      L1_CACHE_ALIGN(sizeof(struct xpc_rsvd_page))
 213 #define XPC_RP_VARS_SIZE        L1_CACHE_ALIGN(sizeof(struct xpc_vars_sn2))
 214
 215 #define XPC_RP_PART_NASIDS(_rp) ((u64 *)((u8 *)(_rp) + XPC_RP_HEADER_SIZE))
 216 #define XPC_RP_MACH_NASIDS(_rp) (XPC_RP_PART_NASIDS(_rp) + xp_nasid_mask_words)
 217 #define XPC_RP_VARS(_rp)        ((struct xpc_vars_sn2 *)(XPC_RP_MACH_NASIDS(_rp) + \
 218                                     xp_nasid_mask_words))
 219
 220 /*
 221  * Functions registered by add_timer() or called by kernel_thread() only
 222  * allow for a single 64-bit argument. The following macros can be used to
 223  * pack and unpack two (32-bit, 16-bit or 8-bit) arguments into or out from
 224  * the passed argument.
 225  */
 226 #define XPC_PACK_ARGS(_arg1, _arg2) \
 227                         ((((u64) _arg1) & 0xffffffff) | \
 228                         ((((u64) _arg2) & 0xffffffff) << 32))
 229
 230 #define XPC_UNPACK_ARG1(_args)  (((u64) _args) & 0xffffffff)
 231 #define XPC_UNPACK_ARG2(_args)  ((((u64) _args) >> 32) & 0xffffffff)
 232
 233 /*
 234  * Define a Get/Put value pair (pointers) used with a message queue.
 235  */
 236 struct xpc_gp {
 237         s64 get;                /* Get value */
 238         s64 put;                /* Put value */
 239 };
 240
 241 #define XPC_GP_SIZE \
 242                 L1_CACHE_ALIGN(sizeof(struct xpc_gp) * XPC_MAX_NCHANNELS)
 243
 244 /*
 245  * Define a structure that contains arguments associated with opening and
 246  * closing a channel.
 247  */
 248 struct xpc_openclose_args {
 249         u16 reason;             /* reason why channel is closing */
 250         u16 msg_size;           /* sizeof each message entry */
 251         u16 remote_nentries;    /* #of message entries in remote msg queue */
 252         u16 local_nentries;     /* #of message entries in local msg queue */
 253         u64 local_msgqueue_pa;  /* physical address of local message queue */
 254 };
 255
 256 #define XPC_OPENCLOSE_ARGS_SIZE \
 257               L1_CACHE_ALIGN(sizeof(struct xpc_openclose_args) * \
 258               XPC_MAX_NCHANNELS)
 259
 260 /* struct xpc_msg flags */
 261
 262 #define XPC_M_DONE              0x01    /* msg has been received/consumed */
 263 #define XPC_M_READY             0x02    /* msg is ready to be sent */
 264 #define XPC_M_INTERRUPT         0x04    /* send interrupt when msg consumed */
 265
 266 #define XPC_MSG_ADDRESS(_payload) \
 267                 ((struct xpc_msg *)((u8 *)(_payload) - XPC_MSG_PAYLOAD_OFFSET))
 268
 269 /*
 270  * Defines notify entry.
 271  *
 272  * This is used to notify a message's sender that their message was received
 273  * and consumed by the intended recipient.
 274  */
 275 struct xpc_notify {
 276         u8 type;                /* type of notification */
 277
 278         /* the following two fields are only used if type == XPC_N_CALL */
 279         xpc_notify_func func;   /* user's notify function */
 280         void *key;              /* pointer to user's key */
 281 };
 282
 283 /* struct xpc_notify type of notification */
 284
 285 #define XPC_N_CALL              0x01    /* notify function provided by user */
 286
 287 /*
 288  * Define the structure that manages all the stuff required by a channel. In
 289  * particular, they are used to manage the messages sent across the channel.
 290  *
 291  * This structure is private to a partition, and is NOT shared across the
 292  * partition boundary.
 293  *
 294  * There is an array of these structures for each remote partition. It is
 295  * allocated at the time a partition becomes active. The array contains one
 296  * of these structures for each potential channel connection to that partition.
 297  *
 298 >>> sn2 only!!!
 299  * Each of these structures manages two message queues (circular buffers).
 300  * They are allocated at the time a channel connection is made. One of
 301  * these message queues (local_msgqueue) holds the locally created messages
 302  * that are destined for the remote partition. The other of these message
 303  * queues (remote_msgqueue) is a locally cached copy of the remote partition's
 304  * own local_msgqueue.
 305  *
 306  * The following is a description of the Get/Put pointers used to manage these
 307  * two message queues. Consider the local_msgqueue to be on one partition
 308  * and the remote_msgqueue to be its cached copy on another partition. A
 309  * description of what each of the lettered areas contains is included.
 310  *
 311  *
 312  *                     local_msgqueue      remote_msgqueue
 313  *
 314  *                        |/////////|      |/////////|
 315  *    w_remote_GP.get --> +---------+      |/////////|
 316  *                        |    F    |      |/////////|
 317  *     remote_GP.get  --> +---------+      +---------+ <-- local_GP->get
 318  *                        |         |      |         |
 319  *                        |         |      |    E    |
 320  *                        |         |      |         |
 321  *                        |         |      +---------+ <-- w_local_GP.get
 322  *                        |    B    |      |/////////|
 323  *                        |         |      |////D////|
 324  *                        |         |      |/////////|
 325  *                        |         |      +---------+ <-- w_remote_GP.put
 326  *                        |         |      |////C////|
 327  *      local_GP->put --> +---------+      +---------+ <-- remote_GP.put
 328  *                        |         |      |/////////|
 329  *                        |    A    |      |/////////|
 330  *                        |         |      |/////////|
 331  *     w_local_GP.put --> +---------+      |/////////|
 332  *                        |/////////|      |/////////|
 333  *
 334  *
 335  *          ( remote_GP.[get|put] are cached copies of the remote
 336  *            partition's local_GP->[get|put], and thus their values can
 337  *            lag behind their counterparts on the remote partition. )
 338  *
 339  *
 340  *  A - Messages that have been allocated, but have not yet been sent to the
 341  *      remote partition.
 342  *
 343  *  B - Messages that have been sent, but have not yet been acknowledged by the
 344  *      remote partition as having been received.
 345  *
 346  *  C - Area that needs to be prepared for the copying of sent messages, by
 347  *      the clearing of the message flags of any previously received messages.
 348  *
 349  *  D - Area into which sent messages are to be copied from the remote
 350  *      partition's local_msgqueue and then delivered to their intended
 351  *      recipients. [ To allow for a multi-message copy, another pointer
 352  *      (next_msg_to_pull) has been added to keep track of the next message
 353  *      number needing to be copied (pulled). It chases after w_remote_GP.put.
 354  *      Any messages lying between w_local_GP.get and next_msg_to_pull have
 355  *      been copied and are ready to be delivered. ]
 356  *
 357  *  E - Messages that have been copied and delivered, but have not yet been
 358  *      acknowledged by the recipient as having been received.
 359  *
 360  *  F - Messages that have been acknowledged, but XPC has not yet notified the
 361  *      sender that the message was received by its intended recipient.
 362  *      This is also an area that needs to be prepared for the allocating of
 363  *      new messages, by the clearing of the message flags of the acknowledged
 364  *      messages.
 365  */
 366 struct xpc_channel_sn2 {
 367
 368         /* various flavors of local and remote Get/Put values */
 369
 370         struct xpc_gp *local_GP;        /* local Get/Put values */
 371         struct xpc_gp remote_GP;        /* remote Get/Put values */
 372         struct xpc_gp w_local_GP;       /* working local Get/Put values */
 373         struct xpc_gp w_remote_GP;      /* working remote Get/Put values */
 374         s64 next_msg_to_pull;   /* Put value of next msg to pull */
 375
 376         struct mutex msg_to_pull_mutex; /* next msg to pull serialization */
 377 };
 378
 379 struct xpc_channel_uv {
 380         /* >>> code is coming */
 381 };
 382
 383 struct xpc_channel {
 384         short partid;           /* ID of remote partition connected */
 385         spinlock_t lock;        /* lock for updating this structure */
 386         u32 flags;              /* general flags */
 387
 388         enum xp_retval reason;  /* reason why channel is disconnect'g */
 389         int reason_line;        /* line# disconnect initiated from */
 390
 391         u16 number;             /* channel # */
 392
 393         u16 msg_size;           /* sizeof each msg entry */
 394         u16 local_nentries;     /* #of msg entries in local msg queue */
 395         u16 remote_nentries;    /* #of msg entries in remote msg queue */
 396
 397         void *local_msgqueue_base;      /* base address of kmalloc'd space */
 398         struct xpc_msg *local_msgqueue; /* local message queue */
 399         void *remote_msgqueue_base;     /* base address of kmalloc'd space */
 400         struct xpc_msg *remote_msgqueue; /* cached copy of remote partition's */
 401                                          /* local message queue */
 402         u64 remote_msgqueue_pa; /* phys addr of remote partition's */
 403                                 /* local message queue */
 404
 405         atomic_t references;    /* #of external references to queues */
 406
 407         atomic_t n_on_msg_allocate_wq;  /* #on msg allocation wait queue */
 408         wait_queue_head_t msg_allocate_wq;      /* msg allocation wait queue */
 409
 410         u8 delayed_IPI_flags;   /* IPI flags received, but delayed */
 411                                 /* action until channel disconnected */
 412
 413         /* queue of msg senders who want to be notified when msg received */
 414
 415         atomic_t n_to_notify;   /* #of msg senders to notify */
 416         struct xpc_notify *notify_queue;    /* notify queue for messages sent */
 417
 418         xpc_channel_func func;  /* user's channel function */
 419         void *key;              /* pointer to user's key */
 420
 421         struct completion wdisconnect_wait;    /* wait for channel disconnect */
 422
 423         struct xpc_openclose_args *local_openclose_args; /* args passed on */
 424                                              /* opening or closing of channel */
 425
 426         /* kthread management related fields */
 427
 428         atomic_t kthreads_assigned;     /* #of kthreads assigned to channel */
 429         u32 kthreads_assigned_limit;    /* limit on #of kthreads assigned */
 430         atomic_t kthreads_idle; /* #of kthreads idle waiting for work */
 431         u32 kthreads_idle_limit;        /* limit on #of kthreads idle */
 432         atomic_t kthreads_active;       /* #of kthreads actively working */
 433
 434         wait_queue_head_t idle_wq;      /* idle kthread wait queue */
 435
 436         union {
 437                 struct xpc_channel_sn2 sn2;
 438                 struct xpc_channel_uv uv;
 439         } sn;
 440
 441 } ____cacheline_aligned;
 442
 443 /* struct xpc_channel flags */
 444
 445 #define XPC_C_WASCONNECTED      0x00000001      /* channel was connected */
 446
 447 #define XPC_C_ROPENREPLY        0x00000002      /* remote open channel reply */
 448 #define XPC_C_OPENREPLY         0x00000004      /* local open channel reply */
 449 #define XPC_C_ROPENREQUEST      0x00000008     /* remote open channel request */
 450 #define XPC_C_OPENREQUEST       0x00000010      /* local open channel request */
 451
 452 #define XPC_C_SETUP             0x00000020 /* channel's msgqueues are alloc'd */
 453 #define XPC_C_CONNECTEDCALLOUT  0x00000040     /* connected callout initiated */
 454 #define XPC_C_CONNECTEDCALLOUT_MADE \
 455                                 0x00000080     /* connected callout completed */
 456 #define XPC_C_CONNECTED         0x00000100      /* local channel is connected */
 457 #define XPC_C_CONNECTING        0x00000200      /* channel is being connected */
 458
 459 #define XPC_C_RCLOSEREPLY       0x00000400      /* remote close channel reply */
 460 #define XPC_C_CLOSEREPLY        0x00000800      /* local close channel reply */
 461 #define XPC_C_RCLOSEREQUEST     0x00001000    /* remote close channel request */
 462 #define XPC_C_CLOSEREQUEST      0x00002000     /* local close channel request */
 463
 464 #define XPC_C_DISCONNECTED      0x00004000      /* channel is disconnected */
 465 #define XPC_C_DISCONNECTING     0x00008000   /* channel is being disconnected */
 466 #define XPC_C_DISCONNECTINGCALLOUT \
 467                                 0x00010000 /* disconnecting callout initiated */
 468 #define XPC_C_DISCONNECTINGCALLOUT_MADE \
 469                                 0x00020000 /* disconnecting callout completed */
 470 #define XPC_C_WDISCONNECT       0x00040000  /* waiting for channel disconnect */
 471
 472 /*
 473  * Manages channels on a partition basis. There is one of these structures
 474  * for each partition (a partition will never utilize the structure that
 475  * represents itself).
 476  */
 477
 478 struct xpc_partition_sn2 {
 479         u64 remote_amos_page_pa;        /* phys addr of partition's amos page */
 480         int activate_IRQ_nasid; /* active partition's act/deact nasid */
 481         int activate_IRQ_phys_cpuid;    /* active part's act/deact phys cpuid */
 482
 483         u64 remote_vars_pa;     /* phys addr of partition's vars */
 484         u64 remote_vars_part_pa;        /* phys addr of partition's vars part */
 485         u8 remote_vars_version; /* version# of partition's vars */
 486
 487         void *local_GPs_base;   /* base address of kmalloc'd space */
 488         struct xpc_gp *local_GPs;       /* local Get/Put values */
 489         void *remote_GPs_base;  /* base address of kmalloc'd space */
 490         struct xpc_gp *remote_GPs;      /* copy of remote partition's local */
 491                                         /* Get/Put values */
 492         u64 remote_GPs_pa;      /* phys address of remote partition's local */
 493                                 /* Get/Put values */
 494
 495         u64 remote_openclose_args_pa;   /* phys addr of remote's args */
 496
 497         int remote_IPI_nasid;   /* nasid of where to send IPIs */
 498         int remote_IPI_phys_cpuid;      /* phys CPU ID of where to send IPIs */
 499         char IPI_owner[8];      /* IPI owner's name */
 500
 501         AMO_t *remote_IPI_amo_va;    /* address of remote IPI AMO_t structure */
 502         AMO_t *local_IPI_amo_va;        /* address of IPI AMO_t structure */
 503
 504         struct timer_list dropped_notify_IRQ_timer;     /* dropped IRQ timer */
 505 };
 506
 507 struct xpc_partition_uv {
 508         /* >>> code is coming */
 509 };
 510
 511 struct xpc_partition {
 512
 513         /* XPC HB infrastructure */
 514
 515         u8 remote_rp_version;   /* version# of partition's rsvd pg */
 516         unsigned long remote_rp_stamp; /* time when rsvd pg was initialized */
 517         u64 remote_rp_pa;       /* phys addr of partition's rsvd pg */
 518         u64 last_heartbeat;     /* HB at last read */
 519         u32 activate_IRQ_rcvd;  /* IRQs since activation */
 520         spinlock_t act_lock;    /* protect updating of act_state */
 521         u8 act_state;           /* from XPC HB viewpoint */
 522         enum xp_retval reason;  /* reason partition is deactivating */
 523         int reason_line;        /* line# deactivation initiated from */
 524
 525         unsigned long disengage_timeout;        /* timeout in jiffies */
 526         struct timer_list disengage_timer;
 527
 528         /* XPC infrastructure referencing and teardown control */
 529
 530         u8 setup_state;         /* infrastructure setup state */
 531         wait_queue_head_t teardown_wq;  /* kthread waiting to teardown infra */
 532         atomic_t references;    /* #of references to infrastructure */
 533
 534         u8 nchannels;           /* #of defined channels supported */
 535         atomic_t nchannels_active;  /* #of channels that are not DISCONNECTED */
 536         atomic_t nchannels_engaged;  /* #of channels engaged with remote part */
 537         struct xpc_channel *channels;   /* array of channel structures */
 538
 539         /* fields used to pass args when opening or closing a channel */
 540
 541         void *local_openclose_args_base;   /* base address of kmalloc'd space */
 542         struct xpc_openclose_args *local_openclose_args;      /* local's args */
 543         void *remote_openclose_args_base;  /* base address of kmalloc'd space */
 544         struct xpc_openclose_args *remote_openclose_args; /* copy of remote's */
 545                                                           /* args */
 546
 547         /* IPI sending, receiving and handling related fields */
 548
 549         u64 local_IPI_amo;      /* IPI amo flags yet to be handled */
 550         spinlock_t IPI_lock;    /* IPI handler lock */
 551
 552         /* channel manager related fields */
 553
 554         atomic_t channel_mgr_requests;  /* #of requests to activate chan mgr */
 555         wait_queue_head_t channel_mgr_wq;       /* channel mgr's wait queue */
 556
 557         union {
 558                 struct xpc_partition_sn2 sn2;
 559                 struct xpc_partition_uv uv;
 560         } sn;
 561
 562 } ____cacheline_aligned;
 563
 564 /* struct xpc_partition act_state values (for XPC HB) */
 565
 566 #define XPC_P_INACTIVE          0x00    /* partition is not active */
 567 #define XPC_P_ACTIVATION_REQ    0x01    /* created thread to activate */
 568 #define XPC_P_ACTIVATING        0x02    /* activation thread started */
 569 #define XPC_P_ACTIVE            0x03    /* xpc_partition_up() was called */
 570 #define XPC_P_DEACTIVATING      0x04    /* partition deactivation initiated */
 571
 572 #define XPC_DEACTIVATE_PARTITION(_p, _reason) \
 573                         xpc_deactivate_partition(__LINE__, (_p), (_reason))
 574
 575 /* struct xpc_partition setup_state values */
 576
 577 #define XPC_P_UNSET             0x00    /* infrastructure was never setup */
 578 #define XPC_P_SETUP             0x01    /* infrastructure is setup */
 579 #define XPC_P_WTEARDOWN         0x02    /* waiting to teardown infrastructure */
 580 #define XPC_P_TORNDOWN          0x03    /* infrastructure is torndown */
 581
 582 /*
 583  * struct xpc_partition IPI_timer #of seconds to wait before checking for
 584  * dropped IPIs. These occur whenever an IPI amo write doesn't complete until
 585  * after the IPI was received.
 586  */
 587 #define XPC_P_DROPPED_IPI_WAIT_INTERVAL (0.25 * HZ)
 588
 589 /* number of seconds to wait for other partitions to disengage */
 590 #define XPC_DISENGAGE_DEFAULT_TIMELIMIT         90
 591
 592 /* interval in seconds to print 'waiting deactivation' messages */
 593 #define XPC_DEACTIVATE_PRINTMSG_INTERVAL        10
 594
 595 #define XPC_PARTID(_p)  ((short)((_p) - &xpc_partitions[0]))
 596
 597 /* found in xp_main.c */
 598 extern struct xpc_registration xpc_registrations[];
 599
 600 /* found in xpc_main.c */
 601 extern struct device *xpc_part;
 602 extern struct device *xpc_chan;
 603 extern int xpc_disengage_timelimit;
 604 extern int xpc_disengage_timedout;
 605 extern atomic_t xpc_activate_IRQ_rcvd;
 606 extern wait_queue_head_t xpc_activate_IRQ_wq;
 607 extern void *xpc_heartbeating_to_mask;
 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 void (*xpc_notify_senders_of_disconnect) (struct xpc_channel *);
 622 extern void (*xpc_process_msg_IPI) (struct xpc_partition *, int);
 623 extern int (*xpc_n_of_deliverable_msgs) (struct xpc_channel *);
 624 extern struct xpc_msg *(*xpc_get_deliverable_msg) (struct xpc_channel *);
 625 extern void (*xpc_request_partition_activation) (struct xpc_rsvd_page *, u64,
 626                                                  int);
 627 extern void (*xpc_request_partition_reactivation) (struct xpc_partition *);
 628 extern void (*xpc_request_partition_deactivation) (struct xpc_partition *);
 629 extern void (*xpc_cancel_partition_deactivation_request) (
 630                                                         struct xpc_partition *);
 631 extern void (*xpc_process_activate_IRQ_rcvd) (int);
 632 extern enum xp_retval (*xpc_setup_infrastructure) (struct xpc_partition *);
 633 extern void (*xpc_teardown_infrastructure) (struct xpc_partition *);
 634
 635 extern void (*xpc_indicate_partition_engaged) (struct xpc_partition *);
 636 extern int (*xpc_partition_engaged) (short);
 637 extern int (*xpc_any_partition_engaged) (void);
 638 extern void (*xpc_indicate_partition_disengaged) (struct xpc_partition *);
 639 extern void (*xpc_assume_partition_disengaged) (short);
 640
 641 extern void (*xpc_send_channel_closerequest) (struct xpc_channel *,
 642                                               unsigned long *);
 643 extern void (*xpc_send_channel_closereply) (struct xpc_channel *,
 644                                             unsigned long *);
 645 extern void (*xpc_send_channel_openrequest) (struct xpc_channel *,
 646                                              unsigned long *);
 647 extern void (*xpc_send_channel_openreply) (struct xpc_channel *,
 648                                            unsigned long *);
 649
 650 extern enum xp_retval (*xpc_send_msg) (struct xpc_channel *, u32, void *, u16,
 651                                        u8, xpc_notify_func, void *);
 652 extern void (*xpc_received_msg) (struct xpc_channel *, struct xpc_msg *);
 653
 654 /* found in xpc_sn2.c */
 655 extern int xpc_init_sn2(void);
 656 extern void xpc_exit_sn2(void);
 657
 658 /* found in xpc_uv.c */
 659 extern void xpc_init_uv(void);
 660 extern void xpc_exit_uv(void);
 661
 662 /* found in xpc_partition.c */
 663 extern int xpc_exiting;
 664 extern int xp_nasid_mask_words;
 665 extern struct xpc_rsvd_page *xpc_rsvd_page;
 666 extern u64 *xpc_mach_nasids;
 667 extern struct xpc_partition *xpc_partitions;
 668 extern char *xpc_remote_copy_buffer;
 669 extern void *xpc_remote_copy_buffer_base;
 670 extern void *xpc_kmalloc_cacheline_aligned(size_t, gfp_t, void **);
 671 extern struct xpc_rsvd_page *xpc_setup_rsvd_page(void);
 672 extern int xpc_identify_activate_IRQ_sender(void);
 673 extern int xpc_partition_disengaged(struct xpc_partition *);
 674 extern enum xp_retval xpc_mark_partition_active(struct xpc_partition *);
 675 extern void xpc_mark_partition_inactive(struct xpc_partition *);
 676 extern void xpc_discovery(void);
 677 extern enum xp_retval xpc_get_remote_rp(int, u64 *, struct xpc_rsvd_page *,
 678                                         u64 *);
 679 extern void xpc_deactivate_partition(const int, struct xpc_partition *,
 680                                      enum xp_retval);
 681 extern enum xp_retval xpc_initiate_partid_to_nasids(short, void *);
 682
 683 /* found in xpc_channel.c */
 684 extern void *xpc_kzalloc_cacheline_aligned(size_t, gfp_t, void **);
 685 extern void xpc_initiate_connect(int);
 686 extern void xpc_initiate_disconnect(int);
 687 extern enum xp_retval xpc_allocate_msg_wait(struct xpc_channel *);
 688 extern enum xp_retval xpc_initiate_send(short, int, u32, void *, u16);
 689 extern enum xp_retval xpc_initiate_send_notify(short, int, u32, void *, u16,
 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);
 699
 700 static inline int
 701 xpc_hb_allowed(short partid, void *heartbeating_to_mask)
 702 {
 703         return test_bit(partid, heartbeating_to_mask);
 704 }
 705
 706 static inline int
 707 xpc_any_hbs_allowed(void)
 708 {
 709         DBUG_ON(xpc_heartbeating_to_mask == NULL);
 710         return !bitmap_empty(xpc_heartbeating_to_mask, xp_max_npartitions);
 711 }
 712
 713 static inline void
 714 xpc_allow_hb(short partid)
 715 {
 716         DBUG_ON(xpc_heartbeating_to_mask == NULL);
 717         set_bit(partid, xpc_heartbeating_to_mask);
 718 }
 719
 720 static inline void
 721 xpc_disallow_hb(short partid)
 722 {
 723         DBUG_ON(xpc_heartbeating_to_mask == NULL);
 724         clear_bit(partid, xpc_heartbeating_to_mask);
 725 }
 726
 727 static inline void
 728 xpc_disallow_all_hbs(void)
 729 {
 730         DBUG_ON(xpc_heartbeating_to_mask == NULL);
 731         bitmap_zero(xpc_heartbeating_to_mask, xp_max_npartitions);
 732 }
 733
 734 static inline void
 735 xpc_wakeup_channel_mgr(struct xpc_partition *part)
 736 {
 737         if (atomic_inc_return(&part->channel_mgr_requests) == 1)
 738                 wake_up(&part->channel_mgr_wq);
 739 }
 740
 741 /*
 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.
 744  */
 745 static inline void
 746 xpc_msgqueue_ref(struct xpc_channel *ch)
 747 {
 748         atomic_inc(&ch->references);
 749 }
 750
 751 static inline void
 752 xpc_msgqueue_deref(struct xpc_channel *ch)
 753 {
 754         s32 refs = atomic_dec_return(&ch->references);
 755
 756         DBUG_ON(refs < 0);
 757         if (refs == 0)
 758                 xpc_wakeup_channel_mgr(&xpc_partitions[ch->partid]);
 759 }
 760
 761 #define XPC_DISCONNECT_CHANNEL(_ch, _reason, _irqflgs) \
 762                 xpc_disconnect_channel(__LINE__, _ch, _reason, _irqflgs)
 763
 764 /*
 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.
 767  */
 768 static inline void
 769 xpc_part_deref(struct xpc_partition *part)
 770 {
 771         s32 refs = atomic_dec_return(&part->references);
 772
 773         DBUG_ON(refs < 0);
 774         if (refs == 0 && part->setup_state == XPC_P_WTEARDOWN)
 775                 wake_up(&part->teardown_wq);
 776 }
 777
 778 static inline int
 779 xpc_part_ref(struct xpc_partition *part)
 780 {
 781         int setup;
 782
 783         atomic_inc(&part->references);
 784         setup = (part->setup_state == XPC_P_SETUP);
 785         if (!setup)
 786                 xpc_part_deref(part);
 787
 788         return setup;
 789 }
 790
 791 /*
 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
 794  * structures.
 795  */
 796 #define XPC_SET_REASON(_p, _reason, _line) \
 797         { \
 798                 (_p)->reason = _reason; \
 799                 (_p)->reason_line = _line; \
 800         }
 801
 802 /*
 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.
 808  */
 809
 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
 815
 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))
 819
 820 #define XPC_ANY_OPENCLOSE_IPI_FLAGS_SET(_amo) ((_amo) & 0x0f0f0f0f0f0f0f0fUL)
 821 #define XPC_ANY_MSG_IPI_FLAGS_SET(_amo)       ((_amo) & 0x1010101010101010UL)
 822
 823 #endif /* _DRIVERS_MISC_SGIXP_XPC_H */