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