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-2009 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/wait.h>
  17 #include <linux/completion.h>
  18 #include <linux/timer.h>
  19 #include <linux/sched.h>
  20 #include "xp.h"
  21
  22 /*
  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
  25  * different major #.
  26  */
  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)
  30
  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 */
  34
  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
  38
  39 /* define the process name of the discovery thread */
  40 #define XPC_DISCOVERY_THREAD_NAME       "xpc_discovery"
  41
  42 /*
  43  * the reserved page
  44  *
  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:
  48  *
  49  *   reserved page header
  50  *
  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.)
  57  *
  58  *   part_nasids mask
  59  *   mach_nasids mask
  60  *
  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.)
  73  *
  74  *   vars       (ia64-sn2 only)
  75  *   vars part  (ia64-sn2 only)
  76  *
  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.)
  82  *
  83  * Note: Until 'ts_jiffies' is set non-zero, the partition XPC code has not been
  84  *       initialized.
  85  */
  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 */
  91         u8 version;
  92         u8 pad1[3];             /* align to next u64 in 1st 64-byte cacheline */
  93         union {
  94                 unsigned long vars_pa;  /* phys address of struct xpc_vars */
  95                 unsigned long activate_gru_mq_desc_gpa; /* phys addr of */
  96                                                         /* activate mq's */
  97                                                         /* gru mq descriptor */
  98         } sn;
  99         unsigned long ts_jiffies; /* timestamp when rsvd pg was setup by XPC */
 100         u64 pad2[10];           /* align to last u64 in 2nd 64-byte cacheline */
 101         u64 SAL_nasids_size;    /* SAL: size of each nasid mask in bytes */
 102 };
 103
 104 #define XPC_RP_VERSION _XPC_VERSION(2, 0) /* version 2.0 of the reserved page */
 105
 106 /*
 107  * Define the structures by which XPC variables can be exported to other
 108  * partitions. (There are two: struct xpc_vars and struct xpc_vars_part)
 109  */
 110
 111 /*
 112  * The following structure describes the partition generic variables
 113  * needed by other partitions in order to properly initialize.
 114  *
 115  * struct xpc_vars version number also applies to struct xpc_vars_part.
 116  * Changes to either structure and/or related functionality should be
 117  * reflected by incrementing either the major or minor version numbers
 118  * of struct xpc_vars.
 119  */
 120 struct xpc_vars_sn2 {
 121         u8 version;
 122         u64 heartbeat;
 123         DECLARE_BITMAP(heartbeating_to_mask, XP_MAX_NPARTITIONS_SN2);
 124         u64 heartbeat_offline;  /* if 0, heartbeat should be changing */
 125         int activate_IRQ_nasid;
 126         int activate_IRQ_phys_cpuid;
 127         unsigned long vars_part_pa;
 128         unsigned long amos_page_pa;/* paddr of page of amos from MSPEC driver */
 129         struct amo *amos_page;  /* vaddr of page of amos from MSPEC driver */
 130 };
 131
 132 #define XPC_V_VERSION _XPC_VERSION(3, 1)    /* version 3.1 of the cross vars */
 133
 134 /*
 135  * The following structure describes the per partition specific variables.
 136  *
 137  * An array of these structures, one per partition, will be defined. As a
 138  * partition becomes active XPC will copy the array entry corresponding to
 139  * itself from that partition. It is desirable that the size of this structure
 140  * evenly divides into a 128-byte cacheline, such that none of the entries in
 141  * this array crosses a 128-byte cacheline boundary. As it is now, each entry
 142  * occupies 64-bytes.
 143  */
 144 struct xpc_vars_part_sn2 {
 145         u64 magic;
 146
 147         unsigned long openclose_args_pa; /* phys addr of open and close args */
 148         unsigned long GPs_pa;   /* physical address of Get/Put values */
 149
 150         unsigned long chctl_amo_pa; /* physical address of chctl flags' amo */
 151
 152         int notify_IRQ_nasid;   /* nasid of where to send notify IRQs */
 153         int notify_IRQ_phys_cpuid;      /* CPUID of where to send notify IRQs */
 154
 155         u8 nchannels;           /* #of defined channels supported */
 156
 157         u8 reserved[23];        /* pad to a full 64 bytes */
 158 };
 159
 160 /*
 161  * The vars_part MAGIC numbers play a part in the first contact protocol.
 162  *
 163  * MAGIC1 indicates that the per partition specific variables for a remote
 164  * partition have been initialized by this partition.
 165  *
 166  * MAGIC2 indicates that this partition has pulled the remote partititions
 167  * per partition variables that pertain to this partition.
 168  */
 169 #define XPC_VP_MAGIC1_SN2 0x0053524156435058L /* 'XPCVARS\0'L (little endian) */
 170 #define XPC_VP_MAGIC2_SN2 0x0073726176435058L /* 'XPCvars\0'L (little endian) */
 171
 172 /* the reserved page sizes and offsets */
 173
 174 #define XPC_RP_HEADER_SIZE      L1_CACHE_ALIGN(sizeof(struct xpc_rsvd_page))
 175 #define XPC_RP_VARS_SIZE        L1_CACHE_ALIGN(sizeof(struct xpc_vars_sn2))
 176
 177 #define XPC_RP_PART_NASIDS(_rp) ((unsigned long *)((u8 *)(_rp) + \
 178                                  XPC_RP_HEADER_SIZE))
 179 #define XPC_RP_MACH_NASIDS(_rp) (XPC_RP_PART_NASIDS(_rp) + \
 180                                  xpc_nasid_mask_nlongs)
 181 #define XPC_RP_VARS(_rp)        ((struct xpc_vars_sn2 *) \
 182                                  (XPC_RP_MACH_NASIDS(_rp) + \
 183                                   xpc_nasid_mask_nlongs))
 184
 185 /*
 186  * Info pertinent to a GRU message queue using a watch list for irq generation.
 187  */
 188 struct xpc_gru_mq_uv {
 189         void *address;          /* address of GRU message queue */
 190         unsigned int order;     /* size of GRU message queue as a power of 2 */
 191         int irq;                /* irq raised when message is received in mq */
 192         int mmr_blade;          /* blade where watchlist was allocated from */
 193         unsigned long mmr_offset; /* offset of irq mmr located on mmr_blade */
 194         unsigned long mmr_value; /* value of irq mmr located on mmr_blade */
 195         int watchlist_num;      /* number of watchlist allocatd by BIOS */
 196         void *gru_mq_desc;      /* opaque structure used by the GRU driver */
 197 };
 198
 199 /*
 200  * The activate_mq is used to send/receive GRU messages that affect XPC's
 201  * heartbeat, partition active state, and channel state. This is UV only.
 202  */
 203 struct xpc_activate_mq_msghdr_uv {
 204         unsigned int gru_msg_hdr; /* FOR GRU INTERNAL USE ONLY */
 205         short partid;           /* sender's partid */
 206         u8 act_state;           /* sender's act_state at time msg sent */
 207         u8 type;                /* message's type */
 208         unsigned long rp_ts_jiffies; /* timestamp of sender's rp setup by XPC */
 209 };
 210
 211 /* activate_mq defined message types */
 212 #define XPC_ACTIVATE_MQ_MSG_SYNC_ACT_STATE_UV           0
 213 #define XPC_ACTIVATE_MQ_MSG_INC_HEARTBEAT_UV            1
 214 #define XPC_ACTIVATE_MQ_MSG_OFFLINE_HEARTBEAT_UV        2
 215 #define XPC_ACTIVATE_MQ_MSG_ONLINE_HEARTBEAT_UV         3
 216
 217 #define XPC_ACTIVATE_MQ_MSG_ACTIVATE_REQ_UV             4
 218 #define XPC_ACTIVATE_MQ_MSG_DEACTIVATE_REQ_UV           5
 219
 220 #define XPC_ACTIVATE_MQ_MSG_CHCTL_CLOSEREQUEST_UV       6
 221 #define XPC_ACTIVATE_MQ_MSG_CHCTL_CLOSEREPLY_UV         7
 222 #define XPC_ACTIVATE_MQ_MSG_CHCTL_OPENREQUEST_UV        8
 223 #define XPC_ACTIVATE_MQ_MSG_CHCTL_OPENREPLY_UV          9
 224
 225 #define XPC_ACTIVATE_MQ_MSG_MARK_ENGAGED_UV             10
 226 #define XPC_ACTIVATE_MQ_MSG_MARK_DISENGAGED_UV          11
 227
 228 struct xpc_activate_mq_msg_uv {
 229         struct xpc_activate_mq_msghdr_uv hdr;
 230 };
 231
 232 struct xpc_activate_mq_msg_heartbeat_req_uv {
 233         struct xpc_activate_mq_msghdr_uv hdr;
 234         u64 heartbeat;
 235 };
 236
 237 struct xpc_activate_mq_msg_activate_req_uv {
 238         struct xpc_activate_mq_msghdr_uv hdr;
 239         unsigned long rp_gpa;
 240         unsigned long activate_gru_mq_desc_gpa;
 241 };
 242
 243 struct xpc_activate_mq_msg_deactivate_req_uv {
 244         struct xpc_activate_mq_msghdr_uv hdr;
 245         enum xp_retval reason;
 246 };
 247
 248 struct xpc_activate_mq_msg_chctl_closerequest_uv {
 249         struct xpc_activate_mq_msghdr_uv hdr;
 250         short ch_number;
 251         enum xp_retval reason;
 252 };
 253
 254 struct xpc_activate_mq_msg_chctl_closereply_uv {
 255         struct xpc_activate_mq_msghdr_uv hdr;
 256         short ch_number;
 257 };
 258
 259 struct xpc_activate_mq_msg_chctl_openrequest_uv {
 260         struct xpc_activate_mq_msghdr_uv hdr;
 261         short ch_number;
 262         short entry_size;       /* size of notify_mq's GRU messages */
 263         short local_nentries;   /* ??? Is this needed? What is? */
 264 };
 265
 266 struct xpc_activate_mq_msg_chctl_openreply_uv {
 267         struct xpc_activate_mq_msghdr_uv hdr;
 268         short ch_number;
 269         short remote_nentries;  /* ??? Is this needed? What is? */
 270         short local_nentries;   /* ??? Is this needed? What is? */
 271         unsigned long notify_gru_mq_desc_gpa;
 272 };
 273
 274 /*
 275  * Functions registered by add_timer() or called by kernel_thread() only
 276  * allow for a single 64-bit argument. The following macros can be used to
 277  * pack and unpack two (32-bit, 16-bit or 8-bit) arguments into or out from
 278  * the passed argument.
 279  */
 280 #define XPC_PACK_ARGS(_arg1, _arg2) \
 281                         ((((u64)_arg1) & 0xffffffff) | \
 282                         ((((u64)_arg2) & 0xffffffff) << 32))
 283
 284 #define XPC_UNPACK_ARG1(_args)  (((u64)_args) & 0xffffffff)
 285 #define XPC_UNPACK_ARG2(_args)  ((((u64)_args) >> 32) & 0xffffffff)
 286
 287 /*
 288  * Define a Get/Put value pair (pointers) used with a message queue.
 289  */
 290 struct xpc_gp_sn2 {
 291         s64 get;                /* Get value */
 292         s64 put;                /* Put value */
 293 };
 294
 295 #define XPC_GP_SIZE \
 296                 L1_CACHE_ALIGN(sizeof(struct xpc_gp_sn2) * XPC_MAX_NCHANNELS)
 297
 298 /*
 299  * Define a structure that contains arguments associated with opening and
 300  * closing a channel.
 301  */
 302 struct xpc_openclose_args {
 303         u16 reason;             /* reason why channel is closing */
 304         u16 entry_size;         /* sizeof each message entry */
 305         u16 remote_nentries;    /* #of message entries in remote msg queue */
 306         u16 local_nentries;     /* #of message entries in local msg queue */
 307         unsigned long local_msgqueue_pa; /* phys addr of local message queue */
 308 };
 309
 310 #define XPC_OPENCLOSE_ARGS_SIZE \
 311               L1_CACHE_ALIGN(sizeof(struct xpc_openclose_args) * \
 312               XPC_MAX_NCHANNELS)
 313
 314
 315 /*
 316  * Structures to define a fifo singly-linked list.
 317  */
 318
 319 struct xpc_fifo_entry_uv {
 320         struct xpc_fifo_entry_uv *next;
 321 };
 322
 323 struct xpc_fifo_head_uv {
 324         struct xpc_fifo_entry_uv *first;
 325         struct xpc_fifo_entry_uv *last;
 326         spinlock_t lock;
 327         int n_entries;
 328 };
 329
 330 /*
 331  * Define a sn2 styled message.
 332  *
 333  * A user-defined message resides in the payload area. The max size of the
 334  * payload is defined by the user via xpc_connect().
 335  *
 336  * The size of a message entry (within a message queue) must be a 128-byte
 337  * cacheline sized multiple in order to facilitate the BTE transfer of messages
 338  * from one message queue to another.
 339  */
 340 struct xpc_msg_sn2 {
 341         u8 flags;               /* FOR XPC INTERNAL USE ONLY */
 342         u8 reserved[7];         /* FOR XPC INTERNAL USE ONLY */
 343         s64 number;             /* FOR XPC INTERNAL USE ONLY */
 344
 345         u64 payload;            /* user defined portion of message */
 346 };
 347
 348 /* struct xpc_msg_sn2 flags */
 349
 350 #define XPC_M_SN2_DONE          0x01    /* msg has been received/consumed */
 351 #define XPC_M_SN2_READY         0x02    /* msg is ready to be sent */
 352 #define XPC_M_SN2_INTERRUPT     0x04    /* send interrupt when msg consumed */
 353
 354 /*
 355  * The format of a uv XPC notify_mq GRU message is as follows:
 356  *
 357  * A user-defined message resides in the payload area. The max size of the
 358  * payload is defined by the user via xpc_connect().
 359  *
 360  * The size of a message (payload and header) sent via the GRU must be either 1
 361  * or 2 GRU_CACHE_LINE_BYTES in length.
 362  */
 363
 364 struct xpc_notify_mq_msghdr_uv {
 365         union {
 366                 unsigned int gru_msg_hdr;       /* FOR GRU INTERNAL USE ONLY */
 367                 struct xpc_fifo_entry_uv next;  /* FOR XPC INTERNAL USE ONLY */
 368         } u;
 369         short partid;           /* FOR XPC INTERNAL USE ONLY */
 370         u8 ch_number;           /* FOR XPC INTERNAL USE ONLY */
 371         u8 size;                /* FOR XPC INTERNAL USE ONLY */
 372         unsigned int msg_slot_number;   /* FOR XPC INTERNAL USE ONLY */
 373 };
 374
 375 struct xpc_notify_mq_msg_uv {
 376         struct xpc_notify_mq_msghdr_uv hdr;
 377         unsigned long payload;
 378 };
 379
 380 /*
 381  * Define sn2's notify entry.
 382  *
 383  * This is used to notify a message's sender that their message was received
 384  * and consumed by the intended recipient.
 385  */
 386 struct xpc_notify_sn2 {
 387         u8 type;                /* type of notification */
 388
 389         /* the following two fields are only used if type == XPC_N_CALL */
 390         xpc_notify_func func;   /* user's notify function */
 391         void *key;              /* pointer to user's key */
 392 };
 393
 394 /* struct xpc_notify_sn2 type of notification */
 395
 396 #define XPC_N_CALL      0x01    /* notify function provided by user */
 397
 398 /*
 399  * Define uv's version of the notify entry. It additionally is used to allocate
 400  * a msg slot on the remote partition into which is copied a sent message.
 401  */
 402 struct xpc_send_msg_slot_uv {
 403         struct xpc_fifo_entry_uv next;
 404         unsigned int msg_slot_number;
 405         xpc_notify_func func;   /* user's notify function */
 406         void *key;              /* pointer to user's key */
 407 };
 408
 409 /*
 410  * Define the structure that manages all the stuff required by a channel. In
 411  * particular, they are used to manage the messages sent across the channel.
 412  *
 413  * This structure is private to a partition, and is NOT shared across the
 414  * partition boundary.
 415  *
 416  * There is an array of these structures for each remote partition. It is
 417  * allocated at the time a partition becomes active. The array contains one
 418  * of these structures for each potential channel connection to that partition.
 419  */
 420
 421 /*
 422  * The following is sn2 only.
 423  *
 424  * Each channel structure manages two message queues (circular buffers).
 425  * They are allocated at the time a channel connection is made. One of
 426  * these message queues (local_msgqueue) holds the locally created messages
 427  * that are destined for the remote partition. The other of these message
 428  * queues (remote_msgqueue) is a locally cached copy of the remote partition's
 429  * own local_msgqueue.
 430  *
 431  * The following is a description of the Get/Put pointers used to manage these
 432  * two message queues. Consider the local_msgqueue to be on one partition
 433  * and the remote_msgqueue to be its cached copy on another partition. A
 434  * description of what each of the lettered areas contains is included.
 435  *
 436  *
 437  *                     local_msgqueue      remote_msgqueue
 438  *
 439  *                        |/////////|      |/////////|
 440  *    w_remote_GP.get --> +---------+      |/////////|
 441  *                        |    F    |      |/////////|
 442  *     remote_GP.get  --> +---------+      +---------+ <-- local_GP->get
 443  *                        |         |      |         |
 444  *                        |         |      |    E    |
 445  *                        |         |      |         |
 446  *                        |         |      +---------+ <-- w_local_GP.get
 447  *                        |    B    |      |/////////|
 448  *                        |         |      |////D////|
 449  *                        |         |      |/////////|
 450  *                        |         |      +---------+ <-- w_remote_GP.put
 451  *                        |         |      |////C////|
 452  *      local_GP->put --> +---------+      +---------+ <-- remote_GP.put
 453  *                        |         |      |/////////|
 454  *                        |    A    |      |/////////|
 455  *                        |         |      |/////////|
 456  *     w_local_GP.put --> +---------+      |/////////|
 457  *                        |/////////|      |/////////|
 458  *
 459  *
 460  *          ( remote_GP.[get|put] are cached copies of the remote
 461  *            partition's local_GP->[get|put], and thus their values can
 462  *            lag behind their counterparts on the remote partition. )
 463  *
 464  *
 465  *  A - Messages that have been allocated, but have not yet been sent to the
 466  *      remote partition.
 467  *
 468  *  B - Messages that have been sent, but have not yet been acknowledged by the
 469  *      remote partition as having been received.
 470  *
 471  *  C - Area that needs to be prepared for the copying of sent messages, by
 472  *      the clearing of the message flags of any previously received messages.
 473  *
 474  *  D - Area into which sent messages are to be copied from the remote
 475  *      partition's local_msgqueue and then delivered to their intended
 476  *      recipients. [ To allow for a multi-message copy, another pointer
 477  *      (next_msg_to_pull) has been added to keep track of the next message
 478  *      number needing to be copied (pulled). It chases after w_remote_GP.put.
 479  *      Any messages lying between w_local_GP.get and next_msg_to_pull have
 480  *      been copied and are ready to be delivered. ]
 481  *
 482  *  E - Messages that have been copied and delivered, but have not yet been
 483  *      acknowledged by the recipient as having been received.
 484  *
 485  *  F - Messages that have been acknowledged, but XPC has not yet notified the
 486  *      sender that the message was received by its intended recipient.
 487  *      This is also an area that needs to be prepared for the allocating of
 488  *      new messages, by the clearing of the message flags of the acknowledged
 489  *      messages.
 490  */
 491
 492 struct xpc_channel_sn2 {
 493         struct xpc_openclose_args *local_openclose_args; /* args passed on */
 494                                              /* opening or closing of channel */
 495
 496         void *local_msgqueue_base;      /* base address of kmalloc'd space */
 497         struct xpc_msg_sn2 *local_msgqueue;     /* local message queue */
 498         void *remote_msgqueue_base;     /* base address of kmalloc'd space */
 499         struct xpc_msg_sn2 *remote_msgqueue; /* cached copy of remote */
 500                                            /* partition's local message queue */
 501         unsigned long remote_msgqueue_pa; /* phys addr of remote partition's */
 502                                           /* local message queue */
 503
 504         struct xpc_notify_sn2 *notify_queue;/* notify queue for messages sent */
 505
 506         /* various flavors of local and remote Get/Put values */
 507
 508         struct xpc_gp_sn2 *local_GP;    /* local Get/Put values */
 509         struct xpc_gp_sn2 remote_GP;    /* remote Get/Put values */
 510         struct xpc_gp_sn2 w_local_GP;   /* working local Get/Put values */
 511         struct xpc_gp_sn2 w_remote_GP;  /* working remote Get/Put values */
 512         s64 next_msg_to_pull;   /* Put value of next msg to pull */
 513
 514         struct mutex msg_to_pull_mutex; /* next msg to pull serialization */
 515 };
 516
 517 struct xpc_channel_uv {
 518         void *cached_notify_gru_mq_desc; /* remote partition's notify mq's */
 519                                          /* gru mq descriptor */
 520
 521         struct xpc_send_msg_slot_uv *send_msg_slots;
 522         void *recv_msg_slots;   /* each slot will hold a xpc_notify_mq_msg_uv */
 523                                 /* structure plus the user's payload */
 524
 525         struct xpc_fifo_head_uv msg_slot_free_list;
 526         struct xpc_fifo_head_uv recv_msg_list;  /* deliverable payloads */
 527 };
 528
 529 struct xpc_channel {
 530         short partid;           /* ID of remote partition connected */
 531         spinlock_t lock;        /* lock for updating this structure */
 532         unsigned int flags;     /* general flags */
 533
 534         enum xp_retval reason;  /* reason why channel is disconnect'g */
 535         int reason_line;        /* line# disconnect initiated from */
 536
 537         u16 number;             /* channel # */
 538
 539         u16 entry_size;         /* sizeof each msg entry */
 540         u16 local_nentries;     /* #of msg entries in local msg queue */
 541         u16 remote_nentries;    /* #of msg entries in remote msg queue */
 542
 543         atomic_t references;    /* #of external references to queues */
 544
 545         atomic_t n_on_msg_allocate_wq;  /* #on msg allocation wait queue */
 546         wait_queue_head_t msg_allocate_wq;      /* msg allocation wait queue */
 547
 548         u8 delayed_chctl_flags; /* chctl flags received, but delayed */
 549                                 /* action until channel disconnected */
 550
 551         atomic_t n_to_notify;   /* #of msg senders to notify */
 552
 553         xpc_channel_func func;  /* user's channel function */
 554         void *key;              /* pointer to user's key */
 555
 556         struct completion wdisconnect_wait;    /* wait for channel disconnect */
 557
 558         /* kthread management related fields */
 559
 560         atomic_t kthreads_assigned;     /* #of kthreads assigned to channel */
 561         u32 kthreads_assigned_limit;    /* limit on #of kthreads assigned */
 562         atomic_t kthreads_idle; /* #of kthreads idle waiting for work */
 563         u32 kthreads_idle_limit;        /* limit on #of kthreads idle */
 564         atomic_t kthreads_active;       /* #of kthreads actively working */
 565
 566         wait_queue_head_t idle_wq;      /* idle kthread wait queue */
 567
 568         union {
 569                 struct xpc_channel_sn2 sn2;
 570                 struct xpc_channel_uv uv;
 571         } sn;
 572
 573 } ____cacheline_aligned;
 574
 575 /* struct xpc_channel flags */
 576
 577 #define XPC_C_WASCONNECTED      0x00000001      /* channel was connected */
 578
 579 #define XPC_C_ROPENREPLY        0x00000002      /* remote open channel reply */
 580 #define XPC_C_OPENREPLY         0x00000004      /* local open channel reply */
 581 #define XPC_C_ROPENREQUEST      0x00000008     /* remote open channel request */
 582 #define XPC_C_OPENREQUEST       0x00000010      /* local open channel request */
 583
 584 #define XPC_C_SETUP             0x00000020 /* channel's msgqueues are alloc'd */
 585 #define XPC_C_CONNECTEDCALLOUT  0x00000040     /* connected callout initiated */
 586 #define XPC_C_CONNECTEDCALLOUT_MADE \
 587                                 0x00000080     /* connected callout completed */
 588 #define XPC_C_CONNECTED         0x00000100      /* local channel is connected */
 589 #define XPC_C_CONNECTING        0x00000200      /* channel is being connected */
 590
 591 #define XPC_C_RCLOSEREPLY       0x00000400      /* remote close channel reply */
 592 #define XPC_C_CLOSEREPLY        0x00000800      /* local close channel reply */
 593 #define XPC_C_RCLOSEREQUEST     0x00001000    /* remote close channel request */
 594 #define XPC_C_CLOSEREQUEST      0x00002000     /* local close channel request */
 595
 596 #define XPC_C_DISCONNECTED      0x00004000      /* channel is disconnected */
 597 #define XPC_C_DISCONNECTING     0x00008000   /* channel is being disconnected */
 598 #define XPC_C_DISCONNECTINGCALLOUT \
 599                                 0x00010000 /* disconnecting callout initiated */
 600 #define XPC_C_DISCONNECTINGCALLOUT_MADE \
 601                                 0x00020000 /* disconnecting callout completed */
 602 #define XPC_C_WDISCONNECT       0x00040000  /* waiting for channel disconnect */
 603
 604 /*
 605  * The channel control flags (chctl) union consists of a 64-bit variable which
 606  * is divided up into eight bytes, ordered from right to left. Byte zero
 607  * pertains to channel 0, byte one to channel 1, and so on. Each channel's byte
 608  * can have one or more of the chctl flags set in it.
 609  */
 610
 611 union xpc_channel_ctl_flags {
 612         u64 all_flags;
 613         u8 flags[XPC_MAX_NCHANNELS];
 614 };
 615
 616 /* chctl flags */
 617 #define XPC_CHCTL_CLOSEREQUEST  0x01
 618 #define XPC_CHCTL_CLOSEREPLY    0x02
 619 #define XPC_CHCTL_OPENREQUEST   0x04
 620 #define XPC_CHCTL_OPENREPLY     0x08
 621 #define XPC_CHCTL_MSGREQUEST    0x10
 622
 623 #define XPC_OPENCLOSE_CHCTL_FLAGS \
 624                         (XPC_CHCTL_CLOSEREQUEST | XPC_CHCTL_CLOSEREPLY | \
 625                          XPC_CHCTL_OPENREQUEST | XPC_CHCTL_OPENREPLY)
 626 #define XPC_MSG_CHCTL_FLAGS     XPC_CHCTL_MSGREQUEST
 627
 628 static inline int
 629 xpc_any_openclose_chctl_flags_set(union xpc_channel_ctl_flags *chctl)
 630 {
 631         int ch_number;
 632
 633         for (ch_number = 0; ch_number < XPC_MAX_NCHANNELS; ch_number++) {
 634                 if (chctl->flags[ch_number] & XPC_OPENCLOSE_CHCTL_FLAGS)
 635                         return 1;
 636         }
 637         return 0;
 638 }
 639
 640 static inline int
 641 xpc_any_msg_chctl_flags_set(union xpc_channel_ctl_flags *chctl)
 642 {
 643         int ch_number;
 644
 645         for (ch_number = 0; ch_number < XPC_MAX_NCHANNELS; ch_number++) {
 646                 if (chctl->flags[ch_number] & XPC_MSG_CHCTL_FLAGS)
 647                         return 1;
 648         }
 649         return 0;
 650 }
 651
 652 /*
 653  * Manage channels on a partition basis. There is one of these structures
 654  * for each partition (a partition will never utilize the structure that
 655  * represents itself).
 656  */
 657
 658 struct xpc_partition_sn2 {
 659         unsigned long remote_amos_page_pa; /* paddr of partition's amos page */
 660         int activate_IRQ_nasid; /* active partition's act/deact nasid */
 661         int activate_IRQ_phys_cpuid;    /* active part's act/deact phys cpuid */
 662
 663         unsigned long remote_vars_pa;   /* phys addr of partition's vars */
 664         unsigned long remote_vars_part_pa; /* paddr of partition's vars part */
 665         u8 remote_vars_version; /* version# of partition's vars */
 666
 667         void *local_GPs_base;   /* base address of kmalloc'd space */
 668         struct xpc_gp_sn2 *local_GPs;   /* local Get/Put values */
 669         void *remote_GPs_base;  /* base address of kmalloc'd space */
 670         struct xpc_gp_sn2 *remote_GPs;  /* copy of remote partition's local */
 671                                         /* Get/Put values */
 672         unsigned long remote_GPs_pa; /* phys addr of remote partition's local */
 673                                      /* Get/Put values */
 674
 675         void *local_openclose_args_base;   /* base address of kmalloc'd space */
 676         struct xpc_openclose_args *local_openclose_args;      /* local's args */
 677         unsigned long remote_openclose_args_pa; /* phys addr of remote's args */
 678
 679         int notify_IRQ_nasid;   /* nasid of where to send notify IRQs */
 680         int notify_IRQ_phys_cpuid;      /* CPUID of where to send notify IRQs */
 681         char notify_IRQ_owner[8];       /* notify IRQ's owner's name */
 682
 683         struct amo *remote_chctl_amo_va; /* addr of remote chctl flags' amo */
 684         struct amo *local_chctl_amo_va; /* address of chctl flags' amo */
 685
 686         struct timer_list dropped_notify_IRQ_timer;     /* dropped IRQ timer */
 687 };
 688
 689 struct xpc_partition_uv {
 690         unsigned long activate_gru_mq_desc_gpa; /* phys addr of parititon's */
 691                                                 /* activate mq's gru mq */
 692                                                 /* descriptor */
 693         void *cached_activate_gru_mq_desc; /* cached copy of partition's */
 694                                            /* activate mq's gru mq descriptor */
 695         struct mutex cached_activate_gru_mq_desc_mutex;
 696         spinlock_t flags_lock;  /* protect updating of flags */
 697         unsigned int flags;     /* general flags */
 698         u8 remote_act_state;    /* remote partition's act_state */
 699         u8 act_state_req;       /* act_state request from remote partition */
 700         enum xp_retval reason;  /* reason for deactivate act_state request */
 701         u64 heartbeat;          /* incremented by remote partition */
 702 };
 703
 704 /* struct xpc_partition_uv flags */
 705
 706 #define XPC_P_HEARTBEAT_OFFLINE_UV              0x00000001
 707 #define XPC_P_ENGAGED_UV                        0x00000002
 708 #define XPC_P_CACHED_ACTIVATE_GRU_MQ_DESC_UV    0x00000004
 709
 710 /* struct xpc_partition_uv act_state change requests */
 711
 712 #define XPC_P_ASR_ACTIVATE_UV           0x01
 713 #define XPC_P_ASR_REACTIVATE_UV         0x02
 714 #define XPC_P_ASR_DEACTIVATE_UV         0x03
 715
 716 struct xpc_partition {
 717
 718         /* XPC HB infrastructure */
 719
 720         u8 remote_rp_version;   /* version# of partition's rsvd pg */
 721         unsigned long remote_rp_ts_jiffies; /* timestamp when rsvd pg setup */
 722         unsigned long remote_rp_pa;     /* phys addr of partition's rsvd pg */
 723         u64 last_heartbeat;     /* HB at last read */
 724         u32 activate_IRQ_rcvd;  /* IRQs since activation */
 725         spinlock_t act_lock;    /* protect updating of act_state */
 726         u8 act_state;           /* from XPC HB viewpoint */
 727         enum xp_retval reason;  /* reason partition is deactivating */
 728         int reason_line;        /* line# deactivation initiated from */
 729
 730         unsigned long disengage_timeout;        /* timeout in jiffies */
 731         struct timer_list disengage_timer;
 732
 733         /* XPC infrastructure referencing and teardown control */
 734
 735         u8 setup_state;         /* infrastructure setup state */
 736         wait_queue_head_t teardown_wq;  /* kthread waiting to teardown infra */
 737         atomic_t references;    /* #of references to infrastructure */
 738
 739         u8 nchannels;           /* #of defined channels supported */
 740         atomic_t nchannels_active;  /* #of channels that are not DISCONNECTED */
 741         atomic_t nchannels_engaged;  /* #of channels engaged with remote part */
 742         struct xpc_channel *channels;   /* array of channel structures */
 743
 744         /* fields used for managing channel avialability and activity */
 745
 746         union xpc_channel_ctl_flags chctl; /* chctl flags yet to be processed */
 747         spinlock_t chctl_lock;  /* chctl flags lock */
 748
 749         void *remote_openclose_args_base;  /* base address of kmalloc'd space */
 750         struct xpc_openclose_args *remote_openclose_args; /* copy of remote's */
 751                                                           /* args */
 752
 753         /* channel manager related fields */
 754
 755         atomic_t channel_mgr_requests;  /* #of requests to activate chan mgr */
 756         wait_queue_head_t channel_mgr_wq;       /* channel mgr's wait queue */
 757
 758         union {
 759                 struct xpc_partition_sn2 sn2;
 760                 struct xpc_partition_uv uv;
 761         } sn;
 762
 763 } ____cacheline_aligned;
 764
 765 /* struct xpc_partition act_state values (for XPC HB) */
 766
 767 #define XPC_P_AS_INACTIVE       0x00    /* partition is not active */
 768 #define XPC_P_AS_ACTIVATION_REQ 0x01    /* created thread to activate */
 769 #define XPC_P_AS_ACTIVATING     0x02    /* activation thread started */
 770 #define XPC_P_AS_ACTIVE         0x03    /* xpc_partition_up() was called */
 771 #define XPC_P_AS_DEACTIVATING   0x04    /* partition deactivation initiated */
 772
 773 #define XPC_DEACTIVATE_PARTITION(_p, _reason) \
 774                         xpc_deactivate_partition(__LINE__, (_p), (_reason))
 775
 776 /* struct xpc_partition setup_state values */
 777
 778 #define XPC_P_SS_UNSET          0x00    /* infrastructure was never setup */
 779 #define XPC_P_SS_SETUP          0x01    /* infrastructure is setup */
 780 #define XPC_P_SS_WTEARDOWN      0x02    /* waiting to teardown infrastructure */
 781 #define XPC_P_SS_TORNDOWN       0x03    /* infrastructure is torndown */
 782
 783 /*
 784  * struct xpc_partition_sn2's dropped notify IRQ timer is set to wait the
 785  * following interval #of seconds before checking for dropped notify IRQs.
 786  * These can occur whenever an IRQ's associated amo write doesn't complete
 787  * until after the IRQ was received.
 788  */
 789 #define XPC_DROPPED_NOTIFY_IRQ_WAIT_INTERVAL    (0.25 * HZ)
 790
 791 /* number of seconds to wait for other partitions to disengage */
 792 #define XPC_DISENGAGE_DEFAULT_TIMELIMIT         90
 793
 794 /* interval in seconds to print 'waiting deactivation' messages */
 795 #define XPC_DEACTIVATE_PRINTMSG_INTERVAL        10
 796
 797 #define XPC_PARTID(_p)  ((short)((_p) - &xpc_partitions[0]))
 798
 799 /* found in xp_main.c */
 800 extern struct xpc_registration xpc_registrations[];
 801
 802 /* found in xpc_main.c */
 803 extern struct device *xpc_part;
 804 extern struct device *xpc_chan;
 805 extern int xpc_disengage_timelimit;
 806 extern int xpc_disengage_timedout;
 807 extern int xpc_activate_IRQ_rcvd;
 808 extern spinlock_t xpc_activate_IRQ_rcvd_lock;
 809 extern wait_queue_head_t xpc_activate_IRQ_wq;
 810 extern void *xpc_heartbeating_to_mask;
 811 extern void *xpc_kzalloc_cacheline_aligned(size_t, gfp_t, void **);
 812 extern void xpc_activate_partition(struct xpc_partition *);
 813 extern void xpc_activate_kthreads(struct xpc_channel *, int);
 814 extern void xpc_create_kthreads(struct xpc_channel *, int, int);
 815 extern void xpc_disconnect_wait(int);
 816 extern int (*xpc_setup_partitions_sn) (void);
 817 extern void (*xpc_teardown_partitions_sn) (void);
 818 extern enum xp_retval (*xpc_get_partition_rsvd_page_pa) (void *, u64 *,
 819                                                          unsigned long *,
 820                                                          size_t *);
 821 extern int (*xpc_setup_rsvd_page_sn) (struct xpc_rsvd_page *);
 822 extern void (*xpc_heartbeat_init) (void);
 823 extern void (*xpc_heartbeat_exit) (void);
 824 extern void (*xpc_increment_heartbeat) (void);
 825 extern void (*xpc_offline_heartbeat) (void);
 826 extern void (*xpc_online_heartbeat) (void);
 827 extern enum xp_retval (*xpc_get_remote_heartbeat) (struct xpc_partition *);
 828 extern enum xp_retval (*xpc_make_first_contact) (struct xpc_partition *);
 829 extern u64 (*xpc_get_chctl_all_flags) (struct xpc_partition *);
 830 extern enum xp_retval (*xpc_setup_msg_structures) (struct xpc_channel *);
 831 extern void (*xpc_teardown_msg_structures) (struct xpc_channel *);
 832 extern void (*xpc_notify_senders_of_disconnect) (struct xpc_channel *);
 833 extern void (*xpc_process_msg_chctl_flags) (struct xpc_partition *, int);
 834 extern int (*xpc_n_of_deliverable_payloads) (struct xpc_channel *);
 835 extern void *(*xpc_get_deliverable_payload) (struct xpc_channel *);
 836 extern void (*xpc_request_partition_activation) (struct xpc_rsvd_page *,
 837                                                  unsigned long, int);
 838 extern void (*xpc_request_partition_reactivation) (struct xpc_partition *);
 839 extern void (*xpc_request_partition_deactivation) (struct xpc_partition *);
 840 extern void (*xpc_cancel_partition_deactivation_request) (
 841                                                         struct xpc_partition *);
 842 extern void (*xpc_process_activate_IRQ_rcvd) (void);
 843 extern enum xp_retval (*xpc_setup_ch_structures_sn) (struct xpc_partition *);
 844 extern void (*xpc_teardown_ch_structures_sn) (struct xpc_partition *);
 845
 846 extern void (*xpc_indicate_partition_engaged) (struct xpc_partition *);
 847 extern int (*xpc_partition_engaged) (short);
 848 extern int (*xpc_any_partition_engaged) (void);
 849 extern void (*xpc_indicate_partition_disengaged) (struct xpc_partition *);
 850 extern void (*xpc_assume_partition_disengaged) (short);
 851
 852 extern void (*xpc_send_chctl_closerequest) (struct xpc_channel *,
 853                                             unsigned long *);
 854 extern void (*xpc_send_chctl_closereply) (struct xpc_channel *,
 855                                           unsigned long *);
 856 extern void (*xpc_send_chctl_openrequest) (struct xpc_channel *,
 857                                            unsigned long *);
 858 extern void (*xpc_send_chctl_openreply) (struct xpc_channel *, unsigned long *);
 859
 860 extern enum xp_retval (*xpc_save_remote_msgqueue_pa) (struct xpc_channel *,
 861                                                       unsigned long);
 862
 863 extern enum xp_retval (*xpc_send_payload) (struct xpc_channel *, u32, void *,
 864                                            u16, u8, xpc_notify_func, void *);
 865 extern void (*xpc_received_payload) (struct xpc_channel *, void *);
 866
 867 /* found in xpc_sn2.c */
 868 extern int xpc_init_sn2(void);
 869 extern void xpc_exit_sn2(void);
 870
 871 /* found in xpc_uv.c */
 872 extern int xpc_init_uv(void);
 873 extern void xpc_exit_uv(void);
 874
 875 /* found in xpc_partition.c */
 876 extern int xpc_exiting;
 877 extern int xpc_nasid_mask_nlongs;
 878 extern struct xpc_rsvd_page *xpc_rsvd_page;
 879 extern unsigned long *xpc_mach_nasids;
 880 extern struct xpc_partition *xpc_partitions;
 881 extern void *xpc_kmalloc_cacheline_aligned(size_t, gfp_t, void **);
 882 extern int xpc_setup_rsvd_page(void);
 883 extern void xpc_teardown_rsvd_page(void);
 884 extern int xpc_identify_activate_IRQ_sender(void);
 885 extern int xpc_partition_disengaged(struct xpc_partition *);
 886 extern enum xp_retval xpc_mark_partition_active(struct xpc_partition *);
 887 extern void xpc_mark_partition_inactive(struct xpc_partition *);
 888 extern void xpc_discovery(void);
 889 extern enum xp_retval xpc_get_remote_rp(int, unsigned long *,
 890                                         struct xpc_rsvd_page *,
 891                                         unsigned long *);
 892 extern void xpc_deactivate_partition(const int, struct xpc_partition *,
 893                                      enum xp_retval);
 894 extern enum xp_retval xpc_initiate_partid_to_nasids(short, void *);
 895
 896 /* found in xpc_channel.c */
 897 extern void xpc_initiate_connect(int);
 898 extern void xpc_initiate_disconnect(int);
 899 extern enum xp_retval xpc_allocate_msg_wait(struct xpc_channel *);
 900 extern enum xp_retval xpc_initiate_send(short, int, u32, void *, u16);
 901 extern enum xp_retval xpc_initiate_send_notify(short, int, u32, void *, u16,
 902                                                xpc_notify_func, void *);
 903 extern void xpc_initiate_received(short, int, void *);
 904 extern void xpc_process_sent_chctl_flags(struct xpc_partition *);
 905 extern void xpc_connected_callout(struct xpc_channel *);
 906 extern void xpc_deliver_payload(struct xpc_channel *);
 907 extern void xpc_disconnect_channel(const int, struct xpc_channel *,
 908                                    enum xp_retval, unsigned long *);
 909 extern void xpc_disconnect_callout(struct xpc_channel *, enum xp_retval);
 910 extern void xpc_partition_going_down(struct xpc_partition *, enum xp_retval);
 911
 912 static inline int
 913 xpc_hb_allowed(short partid, void *heartbeating_to_mask)
 914 {
 915         return test_bit(partid, heartbeating_to_mask);
 916 }
 917
 918 static inline int
 919 xpc_any_hbs_allowed(void)
 920 {
 921         DBUG_ON(xpc_heartbeating_to_mask == NULL);
 922         return !bitmap_empty(xpc_heartbeating_to_mask, xp_max_npartitions);
 923 }
 924
 925 static inline void
 926 xpc_allow_hb(short partid)
 927 {
 928         DBUG_ON(xpc_heartbeating_to_mask == NULL);
 929         set_bit(partid, xpc_heartbeating_to_mask);
 930 }
 931
 932 static inline void
 933 xpc_disallow_hb(short partid)
 934 {
 935         DBUG_ON(xpc_heartbeating_to_mask == NULL);
 936         clear_bit(partid, xpc_heartbeating_to_mask);
 937 }
 938
 939 static inline void
 940 xpc_disallow_all_hbs(void)
 941 {
 942         DBUG_ON(xpc_heartbeating_to_mask == NULL);
 943         bitmap_zero(xpc_heartbeating_to_mask, xp_max_npartitions);
 944 }
 945
 946 static inline void
 947 xpc_wakeup_channel_mgr(struct xpc_partition *part)
 948 {
 949         if (atomic_inc_return(&part->channel_mgr_requests) == 1)
 950                 wake_up(&part->channel_mgr_wq);
 951 }
 952
 953 /*
 954  * These next two inlines are used to keep us from tearing down a channel's
 955  * msg queues while a thread may be referencing them.
 956  */
 957 static inline void
 958 xpc_msgqueue_ref(struct xpc_channel *ch)
 959 {
 960         atomic_inc(&ch->references);
 961 }
 962
 963 static inline void
 964 xpc_msgqueue_deref(struct xpc_channel *ch)
 965 {
 966         s32 refs = atomic_dec_return(&ch->references);
 967
 968         DBUG_ON(refs < 0);
 969         if (refs == 0)
 970                 xpc_wakeup_channel_mgr(&xpc_partitions[ch->partid]);
 971 }
 972
 973 #define XPC_DISCONNECT_CHANNEL(_ch, _reason, _irqflgs) \
 974                 xpc_disconnect_channel(__LINE__, _ch, _reason, _irqflgs)
 975
 976 /*
 977  * These two inlines are used to keep us from tearing down a partition's
 978  * setup infrastructure while a thread may be referencing it.
 979  */
 980 static inline void
 981 xpc_part_deref(struct xpc_partition *part)
 982 {
 983         s32 refs = atomic_dec_return(&part->references);
 984
 985         DBUG_ON(refs < 0);
 986         if (refs == 0 && part->setup_state == XPC_P_SS_WTEARDOWN)
 987                 wake_up(&part->teardown_wq);
 988 }
 989
 990 static inline int
 991 xpc_part_ref(struct xpc_partition *part)
 992 {
 993         int setup;
 994
 995         atomic_inc(&part->references);
 996         setup = (part->setup_state == XPC_P_SS_SETUP);
 997         if (!setup)
 998                 xpc_part_deref(part);
 999
1000         return setup;
1001 }
1002
1003 /*
1004  * The following macro is to be used for the setting of the reason and
1005  * reason_line fields in both the struct xpc_channel and struct xpc_partition
1006  * structures.
1007  */
1008 #define XPC_SET_REASON(_p, _reason, _line) \
1009         { \
1010                 (_p)->reason = _reason; \
1011                 (_p)->reason_line = _line; \
1012         }
1013
1014 #endif /* _DRIVERS_MISC_SGIXP_XPC_H */