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