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
6 * Copyright (c) 2004-2005 Silicon Graphics, Inc. All Rights Reserved.
11 * Cross Partition Communication (XPC) channel support.
13 * This is the part of XPC that manages the channels and
14 * sends/receives messages across them to/from other partitions.
19 #include <linux/kernel.h>
20 #include <linux/init.h>
21 #include <linux/sched.h>
22 #include <linux/cache.h>
23 #include <linux/interrupt.h>
24 #include <linux/slab.h>
25 #include <asm/sn/bte.h>
26 #include <asm/sn/sn_sal.h>
31 * Set up the initial values for the XPartition Communication channels.
34 xpc_initialize_channels(struct xpc_partition *part, partid_t partid)
37 struct xpc_channel *ch;
40 for (ch_number = 0; ch_number < part->nchannels; ch_number++) {
41 ch = &part->channels[ch_number];
44 ch->number = ch_number;
45 ch->flags = XPC_C_DISCONNECTED;
47 ch->local_GP = &part->local_GPs[ch_number];
48 ch->local_openclose_args =
49 &part->local_openclose_args[ch_number];
51 atomic_set(&ch->kthreads_assigned, 0);
52 atomic_set(&ch->kthreads_idle, 0);
53 atomic_set(&ch->kthreads_active, 0);
55 atomic_set(&ch->references, 0);
56 atomic_set(&ch->n_to_notify, 0);
58 spin_lock_init(&ch->lock);
59 sema_init(&ch->msg_to_pull_sema, 1); /* mutex */
60 sema_init(&ch->wdisconnect_sema, 0); /* event wait */
62 atomic_set(&ch->n_on_msg_allocate_wq, 0);
63 init_waitqueue_head(&ch->msg_allocate_wq);
64 init_waitqueue_head(&ch->idle_wq);
70 * Setup the infrastructure necessary to support XPartition Communication
71 * between the specified remote partition and the local one.
74 xpc_setup_infrastructure(struct xpc_partition *part)
77 struct timer_list *timer;
78 partid_t partid = XPC_PARTID(part);
82 * Zero out MOST of the entry for this partition. Only the fields
83 * starting with `nchannels' will be zeroed. The preceding fields must
84 * remain `viable' across partition ups and downs, since they may be
85 * referenced during this memset() operation.
87 memset(&part->nchannels, 0, sizeof(struct xpc_partition) -
88 offsetof(struct xpc_partition, nchannels));
91 * Allocate all of the channel structures as a contiguous chunk of
94 part->channels = kmalloc(sizeof(struct xpc_channel) * XPC_NCHANNELS,
96 if (part->channels == NULL) {
97 dev_err(xpc_chan, "can't get memory for channels\n");
100 memset(part->channels, 0, sizeof(struct xpc_channel) * XPC_NCHANNELS);
102 part->nchannels = XPC_NCHANNELS;
105 /* allocate all the required GET/PUT values */
107 part->local_GPs = xpc_kmalloc_cacheline_aligned(XPC_GP_SIZE,
108 GFP_KERNEL, &part->local_GPs_base);
109 if (part->local_GPs == NULL) {
110 kfree(part->channels);
111 part->channels = NULL;
112 dev_err(xpc_chan, "can't get memory for local get/put "
116 memset(part->local_GPs, 0, XPC_GP_SIZE);
118 part->remote_GPs = xpc_kmalloc_cacheline_aligned(XPC_GP_SIZE,
119 GFP_KERNEL, &part->remote_GPs_base);
120 if (part->remote_GPs == NULL) {
121 kfree(part->channels);
122 part->channels = NULL;
123 kfree(part->local_GPs_base);
124 part->local_GPs = NULL;
125 dev_err(xpc_chan, "can't get memory for remote get/put "
129 memset(part->remote_GPs, 0, XPC_GP_SIZE);
132 /* allocate all the required open and close args */
134 part->local_openclose_args = xpc_kmalloc_cacheline_aligned(
135 XPC_OPENCLOSE_ARGS_SIZE, GFP_KERNEL,
136 &part->local_openclose_args_base);
137 if (part->local_openclose_args == NULL) {
138 kfree(part->channels);
139 part->channels = NULL;
140 kfree(part->local_GPs_base);
141 part->local_GPs = NULL;
142 kfree(part->remote_GPs_base);
143 part->remote_GPs = NULL;
144 dev_err(xpc_chan, "can't get memory for local connect args\n");
147 memset(part->local_openclose_args, 0, XPC_OPENCLOSE_ARGS_SIZE);
149 part->remote_openclose_args = xpc_kmalloc_cacheline_aligned(
150 XPC_OPENCLOSE_ARGS_SIZE, GFP_KERNEL,
151 &part->remote_openclose_args_base);
152 if (part->remote_openclose_args == NULL) {
153 kfree(part->channels);
154 part->channels = NULL;
155 kfree(part->local_GPs_base);
156 part->local_GPs = NULL;
157 kfree(part->remote_GPs_base);
158 part->remote_GPs = NULL;
159 kfree(part->local_openclose_args_base);
160 part->local_openclose_args = NULL;
161 dev_err(xpc_chan, "can't get memory for remote connect args\n");
164 memset(part->remote_openclose_args, 0, XPC_OPENCLOSE_ARGS_SIZE);
167 xpc_initialize_channels(part, partid);
169 atomic_set(&part->nchannels_active, 0);
170 atomic_set(&part->nchannels_engaged, 0);
173 /* local_IPI_amo were set to 0 by an earlier memset() */
175 /* Initialize this partitions AMO_t structure */
176 part->local_IPI_amo_va = xpc_IPI_init(partid);
178 spin_lock_init(&part->IPI_lock);
180 atomic_set(&part->channel_mgr_requests, 1);
181 init_waitqueue_head(&part->channel_mgr_wq);
183 sprintf(part->IPI_owner, "xpc%02d", partid);
184 ret = request_irq(SGI_XPC_NOTIFY, xpc_notify_IRQ_handler, SA_SHIRQ,
185 part->IPI_owner, (void *) (u64) partid);
187 kfree(part->channels);
188 part->channels = NULL;
189 kfree(part->local_GPs_base);
190 part->local_GPs = NULL;
191 kfree(part->remote_GPs_base);
192 part->remote_GPs = NULL;
193 kfree(part->local_openclose_args_base);
194 part->local_openclose_args = NULL;
195 kfree(part->remote_openclose_args_base);
196 part->remote_openclose_args = NULL;
197 dev_err(xpc_chan, "can't register NOTIFY IRQ handler, "
199 return xpcLackOfResources;
202 /* Setup a timer to check for dropped IPIs */
203 timer = &part->dropped_IPI_timer;
205 timer->function = (void (*)(unsigned long)) xpc_dropped_IPI_check;
206 timer->data = (unsigned long) part;
207 timer->expires = jiffies + XPC_P_DROPPED_IPI_WAIT;
211 * With the setting of the partition setup_state to XPC_P_SETUP, we're
212 * declaring that this partition is ready to go.
214 part->setup_state = XPC_P_SETUP;
218 * Setup the per partition specific variables required by the
219 * remote partition to establish channel connections with us.
221 * The setting of the magic # indicates that these per partition
222 * specific variables are ready to be used.
224 xpc_vars_part[partid].GPs_pa = __pa(part->local_GPs);
225 xpc_vars_part[partid].openclose_args_pa =
226 __pa(part->local_openclose_args);
227 xpc_vars_part[partid].IPI_amo_pa = __pa(part->local_IPI_amo_va);
228 cpuid = raw_smp_processor_id(); /* any CPU in this partition will do */
229 xpc_vars_part[partid].IPI_nasid = cpuid_to_nasid(cpuid);
230 xpc_vars_part[partid].IPI_phys_cpuid = cpu_physical_id(cpuid);
231 xpc_vars_part[partid].nchannels = part->nchannels;
232 xpc_vars_part[partid].magic = XPC_VP_MAGIC1;
239 * Create a wrapper that hides the underlying mechanism for pulling a cacheline
240 * (or multiple cachelines) from a remote partition.
242 * src must be a cacheline aligned physical address on the remote partition.
243 * dst must be a cacheline aligned virtual address on this partition.
244 * cnt must be an cacheline sized
246 static enum xpc_retval
247 xpc_pull_remote_cachelines(struct xpc_partition *part, void *dst,
248 const void *src, size_t cnt)
250 bte_result_t bte_ret;
253 DBUG_ON((u64) src != L1_CACHE_ALIGN((u64) src));
254 DBUG_ON((u64) dst != L1_CACHE_ALIGN((u64) dst));
255 DBUG_ON(cnt != L1_CACHE_ALIGN(cnt));
257 if (part->act_state == XPC_P_DEACTIVATING) {
261 bte_ret = xp_bte_copy((u64) src, (u64) ia64_tpa((u64) dst),
262 (u64) cnt, (BTE_NORMAL | BTE_WACQUIRE), NULL);
263 if (bte_ret == BTE_SUCCESS) {
267 dev_dbg(xpc_chan, "xp_bte_copy() from partition %d failed, ret=%d\n",
268 XPC_PARTID(part), bte_ret);
270 return xpc_map_bte_errors(bte_ret);
275 * Pull the remote per partititon specific variables from the specified
279 xpc_pull_remote_vars_part(struct xpc_partition *part)
281 u8 buffer[L1_CACHE_BYTES * 2];
282 struct xpc_vars_part *pulled_entry_cacheline =
283 (struct xpc_vars_part *) L1_CACHE_ALIGN((u64) buffer);
284 struct xpc_vars_part *pulled_entry;
285 u64 remote_entry_cacheline_pa, remote_entry_pa;
286 partid_t partid = XPC_PARTID(part);
290 /* pull the cacheline that contains the variables we're interested in */
292 DBUG_ON(part->remote_vars_part_pa !=
293 L1_CACHE_ALIGN(part->remote_vars_part_pa));
294 DBUG_ON(sizeof(struct xpc_vars_part) != L1_CACHE_BYTES / 2);
296 remote_entry_pa = part->remote_vars_part_pa +
297 sn_partition_id * sizeof(struct xpc_vars_part);
299 remote_entry_cacheline_pa = (remote_entry_pa & ~(L1_CACHE_BYTES - 1));
301 pulled_entry = (struct xpc_vars_part *) ((u64) pulled_entry_cacheline +
302 (remote_entry_pa & (L1_CACHE_BYTES - 1)));
304 ret = xpc_pull_remote_cachelines(part, pulled_entry_cacheline,
305 (void *) remote_entry_cacheline_pa,
307 if (ret != xpcSuccess) {
308 dev_dbg(xpc_chan, "failed to pull XPC vars_part from "
309 "partition %d, ret=%d\n", partid, ret);
314 /* see if they've been set up yet */
316 if (pulled_entry->magic != XPC_VP_MAGIC1 &&
317 pulled_entry->magic != XPC_VP_MAGIC2) {
319 if (pulled_entry->magic != 0) {
320 dev_dbg(xpc_chan, "partition %d's XPC vars_part for "
321 "partition %d has bad magic value (=0x%lx)\n",
322 partid, sn_partition_id, pulled_entry->magic);
326 /* they've not been initialized yet */
330 if (xpc_vars_part[partid].magic == XPC_VP_MAGIC1) {
332 /* validate the variables */
334 if (pulled_entry->GPs_pa == 0 ||
335 pulled_entry->openclose_args_pa == 0 ||
336 pulled_entry->IPI_amo_pa == 0) {
338 dev_err(xpc_chan, "partition %d's XPC vars_part for "
339 "partition %d are not valid\n", partid,
341 return xpcInvalidAddress;
344 /* the variables we imported look to be valid */
346 part->remote_GPs_pa = pulled_entry->GPs_pa;
347 part->remote_openclose_args_pa =
348 pulled_entry->openclose_args_pa;
349 part->remote_IPI_amo_va =
350 (AMO_t *) __va(pulled_entry->IPI_amo_pa);
351 part->remote_IPI_nasid = pulled_entry->IPI_nasid;
352 part->remote_IPI_phys_cpuid = pulled_entry->IPI_phys_cpuid;
354 if (part->nchannels > pulled_entry->nchannels) {
355 part->nchannels = pulled_entry->nchannels;
358 /* let the other side know that we've pulled their variables */
360 xpc_vars_part[partid].magic = XPC_VP_MAGIC2;
363 if (pulled_entry->magic == XPC_VP_MAGIC1) {
372 * Get the IPI flags and pull the openclose args and/or remote GPs as needed.
375 xpc_get_IPI_flags(struct xpc_partition *part)
377 unsigned long irq_flags;
383 * See if there are any IPI flags to be handled.
386 spin_lock_irqsave(&part->IPI_lock, irq_flags);
387 if ((IPI_amo = part->local_IPI_amo) != 0) {
388 part->local_IPI_amo = 0;
390 spin_unlock_irqrestore(&part->IPI_lock, irq_flags);
393 if (XPC_ANY_OPENCLOSE_IPI_FLAGS_SET(IPI_amo)) {
394 ret = xpc_pull_remote_cachelines(part,
395 part->remote_openclose_args,
396 (void *) part->remote_openclose_args_pa,
397 XPC_OPENCLOSE_ARGS_SIZE);
398 if (ret != xpcSuccess) {
399 XPC_DEACTIVATE_PARTITION(part, ret);
401 dev_dbg(xpc_chan, "failed to pull openclose args from "
402 "partition %d, ret=%d\n", XPC_PARTID(part),
405 /* don't bother processing IPIs anymore */
410 if (XPC_ANY_MSG_IPI_FLAGS_SET(IPI_amo)) {
411 ret = xpc_pull_remote_cachelines(part, part->remote_GPs,
412 (void *) part->remote_GPs_pa,
414 if (ret != xpcSuccess) {
415 XPC_DEACTIVATE_PARTITION(part, ret);
417 dev_dbg(xpc_chan, "failed to pull GPs from partition "
418 "%d, ret=%d\n", XPC_PARTID(part), ret);
420 /* don't bother processing IPIs anymore */
430 * Allocate the local message queue and the notify queue.
432 static enum xpc_retval
433 xpc_allocate_local_msgqueue(struct xpc_channel *ch)
435 unsigned long irq_flags;
440 // >>> may want to check for ch->flags & XPC_C_DISCONNECTING between
441 // >>> iterations of the for-loop, bail if set?
443 // >>> should we impose a minumum #of entries? like 4 or 8?
444 for (nentries = ch->local_nentries; nentries > 0; nentries--) {
446 nbytes = nentries * ch->msg_size;
447 ch->local_msgqueue = xpc_kmalloc_cacheline_aligned(nbytes,
448 (GFP_KERNEL | GFP_DMA),
449 &ch->local_msgqueue_base);
450 if (ch->local_msgqueue == NULL) {
453 memset(ch->local_msgqueue, 0, nbytes);
455 nbytes = nentries * sizeof(struct xpc_notify);
456 ch->notify_queue = kmalloc(nbytes, (GFP_KERNEL | GFP_DMA));
457 if (ch->notify_queue == NULL) {
458 kfree(ch->local_msgqueue_base);
459 ch->local_msgqueue = NULL;
462 memset(ch->notify_queue, 0, nbytes);
464 spin_lock_irqsave(&ch->lock, irq_flags);
465 if (nentries < ch->local_nentries) {
466 dev_dbg(xpc_chan, "nentries=%d local_nentries=%d, "
467 "partid=%d, channel=%d\n", nentries,
468 ch->local_nentries, ch->partid, ch->number);
470 ch->local_nentries = nentries;
472 spin_unlock_irqrestore(&ch->lock, irq_flags);
476 dev_dbg(xpc_chan, "can't get memory for local message queue and notify "
477 "queue, partid=%d, channel=%d\n", ch->partid, ch->number);
483 * Allocate the cached remote message queue.
485 static enum xpc_retval
486 xpc_allocate_remote_msgqueue(struct xpc_channel *ch)
488 unsigned long irq_flags;
493 DBUG_ON(ch->remote_nentries <= 0);
495 // >>> may want to check for ch->flags & XPC_C_DISCONNECTING between
496 // >>> iterations of the for-loop, bail if set?
498 // >>> should we impose a minumum #of entries? like 4 or 8?
499 for (nentries = ch->remote_nentries; nentries > 0; nentries--) {
501 nbytes = nentries * ch->msg_size;
502 ch->remote_msgqueue = xpc_kmalloc_cacheline_aligned(nbytes,
503 (GFP_KERNEL | GFP_DMA),
504 &ch->remote_msgqueue_base);
505 if (ch->remote_msgqueue == NULL) {
508 memset(ch->remote_msgqueue, 0, nbytes);
510 spin_lock_irqsave(&ch->lock, irq_flags);
511 if (nentries < ch->remote_nentries) {
512 dev_dbg(xpc_chan, "nentries=%d remote_nentries=%d, "
513 "partid=%d, channel=%d\n", nentries,
514 ch->remote_nentries, ch->partid, ch->number);
516 ch->remote_nentries = nentries;
518 spin_unlock_irqrestore(&ch->lock, irq_flags);
522 dev_dbg(xpc_chan, "can't get memory for cached remote message queue, "
523 "partid=%d, channel=%d\n", ch->partid, ch->number);
529 * Allocate message queues and other stuff associated with a channel.
531 * Note: Assumes all of the channel sizes are filled in.
533 static enum xpc_retval
534 xpc_allocate_msgqueues(struct xpc_channel *ch)
536 unsigned long irq_flags;
541 DBUG_ON(ch->flags & XPC_C_SETUP);
543 if ((ret = xpc_allocate_local_msgqueue(ch)) != xpcSuccess) {
547 if ((ret = xpc_allocate_remote_msgqueue(ch)) != xpcSuccess) {
548 kfree(ch->local_msgqueue_base);
549 ch->local_msgqueue = NULL;
550 kfree(ch->notify_queue);
551 ch->notify_queue = NULL;
555 for (i = 0; i < ch->local_nentries; i++) {
556 /* use a semaphore as an event wait queue */
557 sema_init(&ch->notify_queue[i].sema, 0);
560 spin_lock_irqsave(&ch->lock, irq_flags);
561 ch->flags |= XPC_C_SETUP;
562 spin_unlock_irqrestore(&ch->lock, irq_flags);
569 * Process a connect message from a remote partition.
571 * Note: xpc_process_connect() is expecting to be called with the
572 * spin_lock_irqsave held and will leave it locked upon return.
575 xpc_process_connect(struct xpc_channel *ch, unsigned long *irq_flags)
580 DBUG_ON(!spin_is_locked(&ch->lock));
582 if (!(ch->flags & XPC_C_OPENREQUEST) ||
583 !(ch->flags & XPC_C_ROPENREQUEST)) {
584 /* nothing more to do for now */
587 DBUG_ON(!(ch->flags & XPC_C_CONNECTING));
589 if (!(ch->flags & XPC_C_SETUP)) {
590 spin_unlock_irqrestore(&ch->lock, *irq_flags);
591 ret = xpc_allocate_msgqueues(ch);
592 spin_lock_irqsave(&ch->lock, *irq_flags);
594 if (ret != xpcSuccess) {
595 XPC_DISCONNECT_CHANNEL(ch, ret, irq_flags);
597 if (ch->flags & (XPC_C_CONNECTED | XPC_C_DISCONNECTING)) {
601 DBUG_ON(!(ch->flags & XPC_C_SETUP));
602 DBUG_ON(ch->local_msgqueue == NULL);
603 DBUG_ON(ch->remote_msgqueue == NULL);
606 if (!(ch->flags & XPC_C_OPENREPLY)) {
607 ch->flags |= XPC_C_OPENREPLY;
608 xpc_IPI_send_openreply(ch, irq_flags);
611 if (!(ch->flags & XPC_C_ROPENREPLY)) {
615 DBUG_ON(ch->remote_msgqueue_pa == 0);
617 ch->flags = (XPC_C_CONNECTED | XPC_C_SETUP); /* clear all else */
619 dev_info(xpc_chan, "channel %d to partition %d connected\n",
620 ch->number, ch->partid);
622 spin_unlock_irqrestore(&ch->lock, *irq_flags);
623 xpc_create_kthreads(ch, 1);
624 spin_lock_irqsave(&ch->lock, *irq_flags);
629 * Notify those who wanted to be notified upon delivery of their message.
632 xpc_notify_senders(struct xpc_channel *ch, enum xpc_retval reason, s64 put)
634 struct xpc_notify *notify;
636 s64 get = ch->w_remote_GP.get - 1;
639 while (++get < put && atomic_read(&ch->n_to_notify) > 0) {
641 notify = &ch->notify_queue[get % ch->local_nentries];
644 * See if the notify entry indicates it was associated with
645 * a message who's sender wants to be notified. It is possible
646 * that it is, but someone else is doing or has done the
649 notify_type = notify->type;
650 if (notify_type == 0 ||
651 cmpxchg(¬ify->type, notify_type, 0) !=
656 DBUG_ON(notify_type != XPC_N_CALL);
658 atomic_dec(&ch->n_to_notify);
660 if (notify->func != NULL) {
661 dev_dbg(xpc_chan, "notify->func() called, notify=0x%p, "
662 "msg_number=%ld, partid=%d, channel=%d\n",
663 (void *) notify, get, ch->partid, ch->number);
665 notify->func(reason, ch->partid, ch->number,
668 dev_dbg(xpc_chan, "notify->func() returned, "
669 "notify=0x%p, msg_number=%ld, partid=%d, "
670 "channel=%d\n", (void *) notify, get,
671 ch->partid, ch->number);
678 * Free up message queues and other stuff that were allocated for the specified
681 * Note: ch->reason and ch->reason_line are left set for debugging purposes,
682 * they're cleared when XPC_C_DISCONNECTED is cleared.
685 xpc_free_msgqueues(struct xpc_channel *ch)
687 DBUG_ON(!spin_is_locked(&ch->lock));
688 DBUG_ON(atomic_read(&ch->n_to_notify) != 0);
690 ch->remote_msgqueue_pa = 0;
694 ch->local_nentries = 0;
695 ch->remote_nentries = 0;
696 ch->kthreads_assigned_limit = 0;
697 ch->kthreads_idle_limit = 0;
699 ch->local_GP->get = 0;
700 ch->local_GP->put = 0;
701 ch->remote_GP.get = 0;
702 ch->remote_GP.put = 0;
703 ch->w_local_GP.get = 0;
704 ch->w_local_GP.put = 0;
705 ch->w_remote_GP.get = 0;
706 ch->w_remote_GP.put = 0;
707 ch->next_msg_to_pull = 0;
709 if (ch->flags & XPC_C_SETUP) {
710 ch->flags &= ~XPC_C_SETUP;
712 dev_dbg(xpc_chan, "ch->flags=0x%x, partid=%d, channel=%d\n",
713 ch->flags, ch->partid, ch->number);
715 kfree(ch->local_msgqueue_base);
716 ch->local_msgqueue = NULL;
717 kfree(ch->remote_msgqueue_base);
718 ch->remote_msgqueue = NULL;
719 kfree(ch->notify_queue);
720 ch->notify_queue = NULL;
726 * spin_lock_irqsave() is expected to be held on entry.
729 xpc_process_disconnect(struct xpc_channel *ch, unsigned long *irq_flags)
731 struct xpc_partition *part = &xpc_partitions[ch->partid];
732 u32 channel_was_connected = (ch->flags & XPC_C_WASCONNECTED);
735 DBUG_ON(!spin_is_locked(&ch->lock));
737 if (!(ch->flags & XPC_C_DISCONNECTING)) {
741 DBUG_ON(!(ch->flags & XPC_C_CLOSEREQUEST));
743 /* make sure all activity has settled down first */
745 if (atomic_read(&ch->references) > 0) {
748 DBUG_ON(atomic_read(&ch->kthreads_assigned) != 0);
750 if (part->act_state == XPC_P_DEACTIVATING) {
751 /* can't proceed until the other side disengages from us */
752 if (xpc_partition_engaged(1UL << ch->partid)) {
758 /* as long as the other side is up do the full protocol */
760 if (!(ch->flags & XPC_C_RCLOSEREQUEST)) {
764 if (!(ch->flags & XPC_C_CLOSEREPLY)) {
765 ch->flags |= XPC_C_CLOSEREPLY;
766 xpc_IPI_send_closereply(ch, irq_flags);
769 if (!(ch->flags & XPC_C_RCLOSEREPLY)) {
774 /* wake those waiting for notify completion */
775 if (atomic_read(&ch->n_to_notify) > 0) {
776 /* >>> we do callout while holding ch->lock */
777 xpc_notify_senders(ch, ch->reason, ch->w_local_GP.put);
780 /* both sides are disconnected now */
782 /* it's now safe to free the channel's message queues */
783 xpc_free_msgqueues(ch);
785 /* mark disconnected, clear all other flags except XPC_C_WDISCONNECT */
786 ch->flags = (XPC_C_DISCONNECTED | (ch->flags & XPC_C_WDISCONNECT));
788 atomic_dec(&part->nchannels_active);
790 if (channel_was_connected) {
791 dev_info(xpc_chan, "channel %d to partition %d disconnected, "
792 "reason=%d\n", ch->number, ch->partid, ch->reason);
795 if (ch->flags & XPC_C_WDISCONNECT) {
796 spin_unlock_irqrestore(&ch->lock, *irq_flags);
797 up(&ch->wdisconnect_sema);
798 spin_lock_irqsave(&ch->lock, *irq_flags);
800 } else if (ch->delayed_IPI_flags) {
801 if (part->act_state != XPC_P_DEACTIVATING) {
802 /* time to take action on any delayed IPI flags */
803 spin_lock(&part->IPI_lock);
804 XPC_SET_IPI_FLAGS(part->local_IPI_amo, ch->number,
805 ch->delayed_IPI_flags);
806 spin_unlock(&part->IPI_lock);
808 ch->delayed_IPI_flags = 0;
814 * Process a change in the channel's remote connection state.
817 xpc_process_openclose_IPI(struct xpc_partition *part, int ch_number,
820 unsigned long irq_flags;
821 struct xpc_openclose_args *args =
822 &part->remote_openclose_args[ch_number];
823 struct xpc_channel *ch = &part->channels[ch_number];
824 enum xpc_retval reason;
828 spin_lock_irqsave(&ch->lock, irq_flags);
832 if ((ch->flags & XPC_C_DISCONNECTED) &&
833 (ch->flags & XPC_C_WDISCONNECT)) {
835 * Delay processing IPI flags until thread waiting disconnect
836 * has had a chance to see that the channel is disconnected.
838 ch->delayed_IPI_flags |= IPI_flags;
839 spin_unlock_irqrestore(&ch->lock, irq_flags);
844 if (IPI_flags & XPC_IPI_CLOSEREQUEST) {
846 dev_dbg(xpc_chan, "XPC_IPI_CLOSEREQUEST (reason=%d) received "
847 "from partid=%d, channel=%d\n", args->reason,
848 ch->partid, ch->number);
851 * If RCLOSEREQUEST is set, we're probably waiting for
852 * RCLOSEREPLY. We should find it and a ROPENREQUEST packed
853 * with this RCLOSEREQUEST in the IPI_flags.
856 if (ch->flags & XPC_C_RCLOSEREQUEST) {
857 DBUG_ON(!(ch->flags & XPC_C_DISCONNECTING));
858 DBUG_ON(!(ch->flags & XPC_C_CLOSEREQUEST));
859 DBUG_ON(!(ch->flags & XPC_C_CLOSEREPLY));
860 DBUG_ON(ch->flags & XPC_C_RCLOSEREPLY);
862 DBUG_ON(!(IPI_flags & XPC_IPI_CLOSEREPLY));
863 IPI_flags &= ~XPC_IPI_CLOSEREPLY;
864 ch->flags |= XPC_C_RCLOSEREPLY;
866 /* both sides have finished disconnecting */
867 xpc_process_disconnect(ch, &irq_flags);
868 DBUG_ON(!(ch->flags & XPC_C_DISCONNECTED));
872 if (ch->flags & XPC_C_DISCONNECTED) {
873 if (!(IPI_flags & XPC_IPI_OPENREQUEST)) {
874 if ((XPC_GET_IPI_FLAGS(part->local_IPI_amo,
875 ch_number) & XPC_IPI_OPENREQUEST)) {
877 DBUG_ON(ch->delayed_IPI_flags != 0);
878 spin_lock(&part->IPI_lock);
879 XPC_SET_IPI_FLAGS(part->local_IPI_amo,
881 XPC_IPI_CLOSEREQUEST);
882 spin_unlock(&part->IPI_lock);
884 spin_unlock_irqrestore(&ch->lock, irq_flags);
888 XPC_SET_REASON(ch, 0, 0);
889 ch->flags &= ~XPC_C_DISCONNECTED;
891 atomic_inc(&part->nchannels_active);
892 ch->flags |= (XPC_C_CONNECTING | XPC_C_ROPENREQUEST);
895 IPI_flags &= ~(XPC_IPI_OPENREQUEST | XPC_IPI_OPENREPLY);
898 * The meaningful CLOSEREQUEST connection state fields are:
899 * reason = reason connection is to be closed
902 ch->flags |= XPC_C_RCLOSEREQUEST;
904 if (!(ch->flags & XPC_C_DISCONNECTING)) {
905 reason = args->reason;
906 if (reason <= xpcSuccess || reason > xpcUnknownReason) {
907 reason = xpcUnknownReason;
908 } else if (reason == xpcUnregistering) {
909 reason = xpcOtherUnregistering;
912 XPC_DISCONNECT_CHANNEL(ch, reason, &irq_flags);
914 DBUG_ON(IPI_flags & XPC_IPI_CLOSEREPLY);
915 spin_unlock_irqrestore(&ch->lock, irq_flags);
919 xpc_process_disconnect(ch, &irq_flags);
923 if (IPI_flags & XPC_IPI_CLOSEREPLY) {
925 dev_dbg(xpc_chan, "XPC_IPI_CLOSEREPLY received from partid=%d,"
926 " channel=%d\n", ch->partid, ch->number);
928 if (ch->flags & XPC_C_DISCONNECTED) {
929 DBUG_ON(part->act_state != XPC_P_DEACTIVATING);
930 spin_unlock_irqrestore(&ch->lock, irq_flags);
934 DBUG_ON(!(ch->flags & XPC_C_CLOSEREQUEST));
936 if (!(ch->flags & XPC_C_RCLOSEREQUEST)) {
937 if ((XPC_GET_IPI_FLAGS(part->local_IPI_amo, ch_number)
938 & XPC_IPI_CLOSEREQUEST)) {
940 DBUG_ON(ch->delayed_IPI_flags != 0);
941 spin_lock(&part->IPI_lock);
942 XPC_SET_IPI_FLAGS(part->local_IPI_amo,
943 ch_number, XPC_IPI_CLOSEREPLY);
944 spin_unlock(&part->IPI_lock);
946 spin_unlock_irqrestore(&ch->lock, irq_flags);
950 ch->flags |= XPC_C_RCLOSEREPLY;
952 if (ch->flags & XPC_C_CLOSEREPLY) {
953 /* both sides have finished disconnecting */
954 xpc_process_disconnect(ch, &irq_flags);
959 if (IPI_flags & XPC_IPI_OPENREQUEST) {
961 dev_dbg(xpc_chan, "XPC_IPI_OPENREQUEST (msg_size=%d, "
962 "local_nentries=%d) received from partid=%d, "
963 "channel=%d\n", args->msg_size, args->local_nentries,
964 ch->partid, ch->number);
966 if (part->act_state == XPC_P_DEACTIVATING ||
967 (ch->flags & XPC_C_ROPENREQUEST)) {
968 spin_unlock_irqrestore(&ch->lock, irq_flags);
972 if (ch->flags & (XPC_C_DISCONNECTING | XPC_C_WDISCONNECT)) {
973 ch->delayed_IPI_flags |= XPC_IPI_OPENREQUEST;
974 spin_unlock_irqrestore(&ch->lock, irq_flags);
977 DBUG_ON(!(ch->flags & (XPC_C_DISCONNECTED |
978 XPC_C_OPENREQUEST)));
979 DBUG_ON(ch->flags & (XPC_C_ROPENREQUEST | XPC_C_ROPENREPLY |
980 XPC_C_OPENREPLY | XPC_C_CONNECTED));
983 * The meaningful OPENREQUEST connection state fields are:
984 * msg_size = size of channel's messages in bytes
985 * local_nentries = remote partition's local_nentries
987 if (args->msg_size == 0 || args->local_nentries == 0) {
988 /* assume OPENREQUEST was delayed by mistake */
989 spin_unlock_irqrestore(&ch->lock, irq_flags);
993 ch->flags |= (XPC_C_ROPENREQUEST | XPC_C_CONNECTING);
994 ch->remote_nentries = args->local_nentries;
997 if (ch->flags & XPC_C_OPENREQUEST) {
998 if (args->msg_size != ch->msg_size) {
999 XPC_DISCONNECT_CHANNEL(ch, xpcUnequalMsgSizes,
1001 spin_unlock_irqrestore(&ch->lock, irq_flags);
1005 ch->msg_size = args->msg_size;
1007 XPC_SET_REASON(ch, 0, 0);
1008 ch->flags &= ~XPC_C_DISCONNECTED;
1010 atomic_inc(&part->nchannels_active);
1013 xpc_process_connect(ch, &irq_flags);
1017 if (IPI_flags & XPC_IPI_OPENREPLY) {
1019 dev_dbg(xpc_chan, "XPC_IPI_OPENREPLY (local_msgqueue_pa=0x%lx, "
1020 "local_nentries=%d, remote_nentries=%d) received from "
1021 "partid=%d, channel=%d\n", args->local_msgqueue_pa,
1022 args->local_nentries, args->remote_nentries,
1023 ch->partid, ch->number);
1025 if (ch->flags & (XPC_C_DISCONNECTING | XPC_C_DISCONNECTED)) {
1026 spin_unlock_irqrestore(&ch->lock, irq_flags);
1029 if (!(ch->flags & XPC_C_OPENREQUEST)) {
1030 XPC_DISCONNECT_CHANNEL(ch, xpcOpenCloseError,
1032 spin_unlock_irqrestore(&ch->lock, irq_flags);
1036 DBUG_ON(!(ch->flags & XPC_C_ROPENREQUEST));
1037 DBUG_ON(ch->flags & XPC_C_CONNECTED);
1040 * The meaningful OPENREPLY connection state fields are:
1041 * local_msgqueue_pa = physical address of remote
1042 * partition's local_msgqueue
1043 * local_nentries = remote partition's local_nentries
1044 * remote_nentries = remote partition's remote_nentries
1046 DBUG_ON(args->local_msgqueue_pa == 0);
1047 DBUG_ON(args->local_nentries == 0);
1048 DBUG_ON(args->remote_nentries == 0);
1050 ch->flags |= XPC_C_ROPENREPLY;
1051 ch->remote_msgqueue_pa = args->local_msgqueue_pa;
1053 if (args->local_nentries < ch->remote_nentries) {
1054 dev_dbg(xpc_chan, "XPC_IPI_OPENREPLY: new "
1055 "remote_nentries=%d, old remote_nentries=%d, "
1056 "partid=%d, channel=%d\n",
1057 args->local_nentries, ch->remote_nentries,
1058 ch->partid, ch->number);
1060 ch->remote_nentries = args->local_nentries;
1062 if (args->remote_nentries < ch->local_nentries) {
1063 dev_dbg(xpc_chan, "XPC_IPI_OPENREPLY: new "
1064 "local_nentries=%d, old local_nentries=%d, "
1065 "partid=%d, channel=%d\n",
1066 args->remote_nentries, ch->local_nentries,
1067 ch->partid, ch->number);
1069 ch->local_nentries = args->remote_nentries;
1072 xpc_process_connect(ch, &irq_flags);
1075 spin_unlock_irqrestore(&ch->lock, irq_flags);
1080 * Attempt to establish a channel connection to a remote partition.
1082 static enum xpc_retval
1083 xpc_connect_channel(struct xpc_channel *ch)
1085 unsigned long irq_flags;
1086 struct xpc_registration *registration = &xpc_registrations[ch->number];
1089 if (down_trylock(®istration->sema) != 0) {
1093 if (!XPC_CHANNEL_REGISTERED(ch->number)) {
1094 up(®istration->sema);
1095 return xpcUnregistered;
1098 spin_lock_irqsave(&ch->lock, irq_flags);
1100 DBUG_ON(ch->flags & XPC_C_CONNECTED);
1101 DBUG_ON(ch->flags & XPC_C_OPENREQUEST);
1103 if (ch->flags & XPC_C_DISCONNECTING) {
1104 spin_unlock_irqrestore(&ch->lock, irq_flags);
1105 up(®istration->sema);
1110 /* add info from the channel connect registration to the channel */
1112 ch->kthreads_assigned_limit = registration->assigned_limit;
1113 ch->kthreads_idle_limit = registration->idle_limit;
1114 DBUG_ON(atomic_read(&ch->kthreads_assigned) != 0);
1115 DBUG_ON(atomic_read(&ch->kthreads_idle) != 0);
1116 DBUG_ON(atomic_read(&ch->kthreads_active) != 0);
1118 ch->func = registration->func;
1119 DBUG_ON(registration->func == NULL);
1120 ch->key = registration->key;
1122 ch->local_nentries = registration->nentries;
1124 if (ch->flags & XPC_C_ROPENREQUEST) {
1125 if (registration->msg_size != ch->msg_size) {
1126 /* the local and remote sides aren't the same */
1129 * Because XPC_DISCONNECT_CHANNEL() can block we're
1130 * forced to up the registration sema before we unlock
1131 * the channel lock. But that's okay here because we're
1132 * done with the part that required the registration
1133 * sema. XPC_DISCONNECT_CHANNEL() requires that the
1134 * channel lock be locked and will unlock and relock
1135 * the channel lock as needed.
1137 up(®istration->sema);
1138 XPC_DISCONNECT_CHANNEL(ch, xpcUnequalMsgSizes,
1140 spin_unlock_irqrestore(&ch->lock, irq_flags);
1141 return xpcUnequalMsgSizes;
1144 ch->msg_size = registration->msg_size;
1146 XPC_SET_REASON(ch, 0, 0);
1147 ch->flags &= ~XPC_C_DISCONNECTED;
1149 atomic_inc(&xpc_partitions[ch->partid].nchannels_active);
1152 up(®istration->sema);
1155 /* initiate the connection */
1157 ch->flags |= (XPC_C_OPENREQUEST | XPC_C_CONNECTING);
1158 xpc_IPI_send_openrequest(ch, &irq_flags);
1160 xpc_process_connect(ch, &irq_flags);
1162 spin_unlock_irqrestore(&ch->lock, irq_flags);
1169 * Clear some of the msg flags in the local message queue.
1172 xpc_clear_local_msgqueue_flags(struct xpc_channel *ch)
1174 struct xpc_msg *msg;
1178 get = ch->w_remote_GP.get;
1180 msg = (struct xpc_msg *) ((u64) ch->local_msgqueue +
1181 (get % ch->local_nentries) * ch->msg_size);
1183 } while (++get < (volatile s64) ch->remote_GP.get);
1188 * Clear some of the msg flags in the remote message queue.
1191 xpc_clear_remote_msgqueue_flags(struct xpc_channel *ch)
1193 struct xpc_msg *msg;
1197 put = ch->w_remote_GP.put;
1199 msg = (struct xpc_msg *) ((u64) ch->remote_msgqueue +
1200 (put % ch->remote_nentries) * ch->msg_size);
1202 } while (++put < (volatile s64) ch->remote_GP.put);
1207 xpc_process_msg_IPI(struct xpc_partition *part, int ch_number)
1209 struct xpc_channel *ch = &part->channels[ch_number];
1213 ch->remote_GP = part->remote_GPs[ch_number];
1216 /* See what, if anything, has changed for each connected channel */
1218 xpc_msgqueue_ref(ch);
1220 if (ch->w_remote_GP.get == ch->remote_GP.get &&
1221 ch->w_remote_GP.put == ch->remote_GP.put) {
1222 /* nothing changed since GPs were last pulled */
1223 xpc_msgqueue_deref(ch);
1227 if (!(ch->flags & XPC_C_CONNECTED)){
1228 xpc_msgqueue_deref(ch);
1234 * First check to see if messages recently sent by us have been
1235 * received by the other side. (The remote GET value will have
1236 * changed since we last looked at it.)
1239 if (ch->w_remote_GP.get != ch->remote_GP.get) {
1242 * We need to notify any senders that want to be notified
1243 * that their sent messages have been received by their
1244 * intended recipients. We need to do this before updating
1245 * w_remote_GP.get so that we don't allocate the same message
1246 * queue entries prematurely (see xpc_allocate_msg()).
1248 if (atomic_read(&ch->n_to_notify) > 0) {
1250 * Notify senders that messages sent have been
1251 * received and delivered by the other side.
1253 xpc_notify_senders(ch, xpcMsgDelivered,
1258 * Clear msg->flags in previously sent messages, so that
1259 * they're ready for xpc_allocate_msg().
1261 xpc_clear_local_msgqueue_flags(ch);
1263 ch->w_remote_GP.get = ch->remote_GP.get;
1265 dev_dbg(xpc_chan, "w_remote_GP.get changed to %ld, partid=%d, "
1266 "channel=%d\n", ch->w_remote_GP.get, ch->partid,
1270 * If anyone was waiting for message queue entries to become
1271 * available, wake them up.
1273 if (atomic_read(&ch->n_on_msg_allocate_wq) > 0) {
1274 wake_up(&ch->msg_allocate_wq);
1280 * Now check for newly sent messages by the other side. (The remote
1281 * PUT value will have changed since we last looked at it.)
1284 if (ch->w_remote_GP.put != ch->remote_GP.put) {
1286 * Clear msg->flags in previously received messages, so that
1287 * they're ready for xpc_get_deliverable_msg().
1289 xpc_clear_remote_msgqueue_flags(ch);
1291 ch->w_remote_GP.put = ch->remote_GP.put;
1293 dev_dbg(xpc_chan, "w_remote_GP.put changed to %ld, partid=%d, "
1294 "channel=%d\n", ch->w_remote_GP.put, ch->partid,
1297 nmsgs_sent = ch->w_remote_GP.put - ch->w_local_GP.get;
1298 if (nmsgs_sent > 0) {
1299 dev_dbg(xpc_chan, "msgs waiting to be copied and "
1300 "delivered=%d, partid=%d, channel=%d\n",
1301 nmsgs_sent, ch->partid, ch->number);
1303 if (ch->flags & XPC_C_CONNECTCALLOUT) {
1304 xpc_activate_kthreads(ch, nmsgs_sent);
1309 xpc_msgqueue_deref(ch);
1314 xpc_process_channel_activity(struct xpc_partition *part)
1316 unsigned long irq_flags;
1317 u64 IPI_amo, IPI_flags;
1318 struct xpc_channel *ch;
1323 IPI_amo = xpc_get_IPI_flags(part);
1326 * Initiate channel connections for registered channels.
1328 * For each connected channel that has pending messages activate idle
1329 * kthreads and/or create new kthreads as needed.
1332 for (ch_number = 0; ch_number < part->nchannels; ch_number++) {
1333 ch = &part->channels[ch_number];
1337 * Process any open or close related IPI flags, and then deal
1338 * with connecting or disconnecting the channel as required.
1341 IPI_flags = XPC_GET_IPI_FLAGS(IPI_amo, ch_number);
1343 if (XPC_ANY_OPENCLOSE_IPI_FLAGS_SET(IPI_flags)) {
1344 xpc_process_openclose_IPI(part, ch_number, IPI_flags);
1347 ch_flags = ch->flags; /* need an atomic snapshot of flags */
1349 if (ch_flags & XPC_C_DISCONNECTING) {
1350 spin_lock_irqsave(&ch->lock, irq_flags);
1351 xpc_process_disconnect(ch, &irq_flags);
1352 spin_unlock_irqrestore(&ch->lock, irq_flags);
1356 if (part->act_state == XPC_P_DEACTIVATING) {
1360 if (!(ch_flags & XPC_C_CONNECTED)) {
1361 if (!(ch_flags & XPC_C_OPENREQUEST)) {
1362 DBUG_ON(ch_flags & XPC_C_SETUP);
1363 (void) xpc_connect_channel(ch);
1365 spin_lock_irqsave(&ch->lock, irq_flags);
1366 xpc_process_connect(ch, &irq_flags);
1367 spin_unlock_irqrestore(&ch->lock, irq_flags);
1374 * Process any message related IPI flags, this may involve the
1375 * activation of kthreads to deliver any pending messages sent
1376 * from the other partition.
1379 if (XPC_ANY_MSG_IPI_FLAGS_SET(IPI_flags)) {
1380 xpc_process_msg_IPI(part, ch_number);
1387 * XPC's heartbeat code calls this function to inform XPC that a partition is
1388 * going down. XPC responds by tearing down the XPartition Communication
1389 * infrastructure used for the just downed partition.
1391 * XPC's heartbeat code will never call this function and xpc_partition_up()
1392 * at the same time. Nor will it ever make multiple calls to either function
1396 xpc_partition_going_down(struct xpc_partition *part, enum xpc_retval reason)
1398 unsigned long irq_flags;
1400 struct xpc_channel *ch;
1403 dev_dbg(xpc_chan, "deactivating partition %d, reason=%d\n",
1404 XPC_PARTID(part), reason);
1406 if (!xpc_part_ref(part)) {
1407 /* infrastructure for this partition isn't currently set up */
1412 /* disconnect channels associated with the partition going down */
1414 for (ch_number = 0; ch_number < part->nchannels; ch_number++) {
1415 ch = &part->channels[ch_number];
1417 xpc_msgqueue_ref(ch);
1418 spin_lock_irqsave(&ch->lock, irq_flags);
1420 XPC_DISCONNECT_CHANNEL(ch, reason, &irq_flags);
1422 spin_unlock_irqrestore(&ch->lock, irq_flags);
1423 xpc_msgqueue_deref(ch);
1426 xpc_wakeup_channel_mgr(part);
1428 xpc_part_deref(part);
1433 * Teardown the infrastructure necessary to support XPartition Communication
1434 * between the specified remote partition and the local one.
1437 xpc_teardown_infrastructure(struct xpc_partition *part)
1439 partid_t partid = XPC_PARTID(part);
1443 * We start off by making this partition inaccessible to local
1444 * processes by marking it as no longer setup. Then we make it
1445 * inaccessible to remote processes by clearing the XPC per partition
1446 * specific variable's magic # (which indicates that these variables
1447 * are no longer valid) and by ignoring all XPC notify IPIs sent to
1451 DBUG_ON(atomic_read(&part->nchannels_engaged) != 0);
1452 DBUG_ON(atomic_read(&part->nchannels_active) != 0);
1453 DBUG_ON(part->setup_state != XPC_P_SETUP);
1454 part->setup_state = XPC_P_WTEARDOWN;
1456 xpc_vars_part[partid].magic = 0;
1459 free_irq(SGI_XPC_NOTIFY, (void *) (u64) partid);
1463 * Before proceding with the teardown we have to wait until all
1464 * existing references cease.
1466 wait_event(part->teardown_wq, (atomic_read(&part->references) == 0));
1469 /* now we can begin tearing down the infrastructure */
1471 part->setup_state = XPC_P_TORNDOWN;
1473 /* in case we've still got outstanding timers registered... */
1474 del_timer_sync(&part->dropped_IPI_timer);
1476 kfree(part->remote_openclose_args_base);
1477 part->remote_openclose_args = NULL;
1478 kfree(part->local_openclose_args_base);
1479 part->local_openclose_args = NULL;
1480 kfree(part->remote_GPs_base);
1481 part->remote_GPs = NULL;
1482 kfree(part->local_GPs_base);
1483 part->local_GPs = NULL;
1484 kfree(part->channels);
1485 part->channels = NULL;
1486 part->local_IPI_amo_va = NULL;
1491 * Called by XP at the time of channel connection registration to cause
1492 * XPC to establish connections to all currently active partitions.
1495 xpc_initiate_connect(int ch_number)
1498 struct xpc_partition *part;
1499 struct xpc_channel *ch;
1502 DBUG_ON(ch_number < 0 || ch_number >= XPC_NCHANNELS);
1504 for (partid = 1; partid < XP_MAX_PARTITIONS; partid++) {
1505 part = &xpc_partitions[partid];
1507 if (xpc_part_ref(part)) {
1508 ch = &part->channels[ch_number];
1511 * Initiate the establishment of a connection on the
1512 * newly registered channel to the remote partition.
1514 xpc_wakeup_channel_mgr(part);
1515 xpc_part_deref(part);
1522 xpc_connected_callout(struct xpc_channel *ch)
1524 /* let the registerer know that a connection has been established */
1526 if (ch->func != NULL) {
1527 dev_dbg(xpc_chan, "ch->func() called, reason=xpcConnected, "
1528 "partid=%d, channel=%d\n", ch->partid, ch->number);
1530 ch->func(xpcConnected, ch->partid, ch->number,
1531 (void *) (u64) ch->local_nentries, ch->key);
1533 dev_dbg(xpc_chan, "ch->func() returned, reason=xpcConnected, "
1534 "partid=%d, channel=%d\n", ch->partid, ch->number);
1540 * Called by XP at the time of channel connection unregistration to cause
1541 * XPC to teardown all current connections for the specified channel.
1543 * Before returning xpc_initiate_disconnect() will wait until all connections
1544 * on the specified channel have been closed/torndown. So the caller can be
1545 * assured that they will not be receiving any more callouts from XPC to the
1546 * function they registered via xpc_connect().
1550 * ch_number - channel # to unregister.
1553 xpc_initiate_disconnect(int ch_number)
1555 unsigned long irq_flags;
1557 struct xpc_partition *part;
1558 struct xpc_channel *ch;
1561 DBUG_ON(ch_number < 0 || ch_number >= XPC_NCHANNELS);
1563 /* initiate the channel disconnect for every active partition */
1564 for (partid = 1; partid < XP_MAX_PARTITIONS; partid++) {
1565 part = &xpc_partitions[partid];
1567 if (xpc_part_ref(part)) {
1568 ch = &part->channels[ch_number];
1569 xpc_msgqueue_ref(ch);
1571 spin_lock_irqsave(&ch->lock, irq_flags);
1573 if (!(ch->flags & XPC_C_DISCONNECTED)) {
1574 ch->flags |= XPC_C_WDISCONNECT;
1576 XPC_DISCONNECT_CHANNEL(ch, xpcUnregistering,
1580 spin_unlock_irqrestore(&ch->lock, irq_flags);
1582 xpc_msgqueue_deref(ch);
1583 xpc_part_deref(part);
1587 xpc_disconnect_wait(ch_number);
1592 * To disconnect a channel, and reflect it back to all who may be waiting.
1594 * An OPEN is not allowed until XPC_C_DISCONNECTING is cleared by
1595 * xpc_process_disconnect(), and if set, XPC_C_WDISCONNECT is cleared by
1596 * xpc_disconnect_wait().
1598 * THE CHANNEL IS TO BE LOCKED BY THE CALLER AND WILL REMAIN LOCKED UPON RETURN.
1601 xpc_disconnect_channel(const int line, struct xpc_channel *ch,
1602 enum xpc_retval reason, unsigned long *irq_flags)
1604 u32 channel_was_connected = (ch->flags & XPC_C_CONNECTED);
1607 DBUG_ON(!spin_is_locked(&ch->lock));
1609 if (ch->flags & (XPC_C_DISCONNECTING | XPC_C_DISCONNECTED)) {
1612 DBUG_ON(!(ch->flags & (XPC_C_CONNECTING | XPC_C_CONNECTED)));
1614 dev_dbg(xpc_chan, "reason=%d, line=%d, partid=%d, channel=%d\n",
1615 reason, line, ch->partid, ch->number);
1617 XPC_SET_REASON(ch, reason, line);
1619 ch->flags |= (XPC_C_CLOSEREQUEST | XPC_C_DISCONNECTING);
1620 /* some of these may not have been set */
1621 ch->flags &= ~(XPC_C_OPENREQUEST | XPC_C_OPENREPLY |
1622 XPC_C_ROPENREQUEST | XPC_C_ROPENREPLY |
1623 XPC_C_CONNECTING | XPC_C_CONNECTED);
1625 xpc_IPI_send_closerequest(ch, irq_flags);
1627 if (channel_was_connected) {
1628 ch->flags |= XPC_C_WASCONNECTED;
1631 spin_unlock_irqrestore(&ch->lock, *irq_flags);
1633 /* wake all idle kthreads so they can exit */
1634 if (atomic_read(&ch->kthreads_idle) > 0) {
1635 wake_up_all(&ch->idle_wq);
1638 /* wake those waiting to allocate an entry from the local msg queue */
1639 if (atomic_read(&ch->n_on_msg_allocate_wq) > 0) {
1640 wake_up(&ch->msg_allocate_wq);
1643 spin_lock_irqsave(&ch->lock, *irq_flags);
1648 xpc_disconnecting_callout(struct xpc_channel *ch)
1651 * Let the channel's registerer know that the channel is being
1652 * disconnected. We don't want to do this if the registerer was never
1653 * informed of a connection being made.
1656 if (ch->func != NULL) {
1657 dev_dbg(xpc_chan, "ch->func() called, reason=xpcDisconnecting,"
1658 " partid=%d, channel=%d\n", ch->partid, ch->number);
1660 ch->func(xpcDisconnecting, ch->partid, ch->number, NULL,
1663 dev_dbg(xpc_chan, "ch->func() returned, reason="
1664 "xpcDisconnecting, partid=%d, channel=%d\n",
1665 ch->partid, ch->number);
1671 * Wait for a message entry to become available for the specified channel,
1672 * but don't wait any longer than 1 jiffy.
1674 static enum xpc_retval
1675 xpc_allocate_msg_wait(struct xpc_channel *ch)
1677 enum xpc_retval ret;
1680 if (ch->flags & XPC_C_DISCONNECTING) {
1681 DBUG_ON(ch->reason == xpcInterrupted); // >>> Is this true?
1685 atomic_inc(&ch->n_on_msg_allocate_wq);
1686 ret = interruptible_sleep_on_timeout(&ch->msg_allocate_wq, 1);
1687 atomic_dec(&ch->n_on_msg_allocate_wq);
1689 if (ch->flags & XPC_C_DISCONNECTING) {
1691 DBUG_ON(ch->reason == xpcInterrupted); // >>> Is this true?
1692 } else if (ret == 0) {
1695 ret = xpcInterrupted;
1703 * Allocate an entry for a message from the message queue associated with the
1704 * specified channel.
1706 static enum xpc_retval
1707 xpc_allocate_msg(struct xpc_channel *ch, u32 flags,
1708 struct xpc_msg **address_of_msg)
1710 struct xpc_msg *msg;
1711 enum xpc_retval ret;
1715 /* this reference will be dropped in xpc_send_msg() */
1716 xpc_msgqueue_ref(ch);
1718 if (ch->flags & XPC_C_DISCONNECTING) {
1719 xpc_msgqueue_deref(ch);
1722 if (!(ch->flags & XPC_C_CONNECTED)) {
1723 xpc_msgqueue_deref(ch);
1724 return xpcNotConnected;
1729 * Get the next available message entry from the local message queue.
1730 * If none are available, we'll make sure that we grab the latest
1737 put = (volatile s64) ch->w_local_GP.put;
1738 if (put - (volatile s64) ch->w_remote_GP.get <
1739 ch->local_nentries) {
1741 /* There are available message entries. We need to try
1742 * to secure one for ourselves. We'll do this by trying
1743 * to increment w_local_GP.put as long as someone else
1744 * doesn't beat us to it. If they do, we'll have to
1747 if (cmpxchg(&ch->w_local_GP.put, put, put + 1) ==
1749 /* we got the entry referenced by put */
1752 continue; /* try again */
1757 * There aren't any available msg entries at this time.
1759 * In waiting for a message entry to become available,
1760 * we set a timeout in case the other side is not
1761 * sending completion IPIs. This lets us fake an IPI
1762 * that will cause the IPI handler to fetch the latest
1763 * GP values as if an IPI was sent by the other side.
1765 if (ret == xpcTimeout) {
1766 xpc_IPI_send_local_msgrequest(ch);
1769 if (flags & XPC_NOWAIT) {
1770 xpc_msgqueue_deref(ch);
1774 ret = xpc_allocate_msg_wait(ch);
1775 if (ret != xpcInterrupted && ret != xpcTimeout) {
1776 xpc_msgqueue_deref(ch);
1782 /* get the message's address and initialize it */
1783 msg = (struct xpc_msg *) ((u64) ch->local_msgqueue +
1784 (put % ch->local_nentries) * ch->msg_size);
1787 DBUG_ON(msg->flags != 0);
1790 dev_dbg(xpc_chan, "w_local_GP.put changed to %ld; msg=0x%p, "
1791 "msg_number=%ld, partid=%d, channel=%d\n", put + 1,
1792 (void *) msg, msg->number, ch->partid, ch->number);
1794 *address_of_msg = msg;
1801 * Allocate an entry for a message from the message queue associated with the
1802 * specified channel. NOTE that this routine can sleep waiting for a message
1803 * entry to become available. To not sleep, pass in the XPC_NOWAIT flag.
1807 * partid - ID of partition to which the channel is connected.
1808 * ch_number - channel #.
1809 * flags - see xpc.h for valid flags.
1810 * payload - address of the allocated payload area pointer (filled in on
1811 * return) in which the user-defined message is constructed.
1814 xpc_initiate_allocate(partid_t partid, int ch_number, u32 flags, void **payload)
1816 struct xpc_partition *part = &xpc_partitions[partid];
1817 enum xpc_retval ret = xpcUnknownReason;
1818 struct xpc_msg *msg;
1821 DBUG_ON(partid <= 0 || partid >= XP_MAX_PARTITIONS);
1822 DBUG_ON(ch_number < 0 || ch_number >= part->nchannels);
1826 if (xpc_part_ref(part)) {
1827 ret = xpc_allocate_msg(&part->channels[ch_number], flags, &msg);
1828 xpc_part_deref(part);
1831 *payload = &msg->payload;
1840 * Now we actually send the messages that are ready to be sent by advancing
1841 * the local message queue's Put value and then send an IPI to the recipient
1845 xpc_send_msgs(struct xpc_channel *ch, s64 initial_put)
1847 struct xpc_msg *msg;
1848 s64 put = initial_put + 1;
1855 if (put == (volatile s64) ch->w_local_GP.put) {
1859 msg = (struct xpc_msg *) ((u64) ch->local_msgqueue +
1860 (put % ch->local_nentries) * ch->msg_size);
1862 if (!(msg->flags & XPC_M_READY)) {
1869 if (put == initial_put) {
1870 /* nothing's changed */
1874 if (cmpxchg_rel(&ch->local_GP->put, initial_put, put) !=
1876 /* someone else beat us to it */
1877 DBUG_ON((volatile s64) ch->local_GP->put < initial_put);
1881 /* we just set the new value of local_GP->put */
1883 dev_dbg(xpc_chan, "local_GP->put changed to %ld, partid=%d, "
1884 "channel=%d\n", put, ch->partid, ch->number);
1889 * We need to ensure that the message referenced by
1890 * local_GP->put is not XPC_M_READY or that local_GP->put
1891 * equals w_local_GP.put, so we'll go have a look.
1897 xpc_IPI_send_msgrequest(ch);
1903 * Common code that does the actual sending of the message by advancing the
1904 * local message queue's Put value and sends an IPI to the partition the
1905 * message is being sent to.
1907 static enum xpc_retval
1908 xpc_send_msg(struct xpc_channel *ch, struct xpc_msg *msg, u8 notify_type,
1909 xpc_notify_func func, void *key)
1911 enum xpc_retval ret = xpcSuccess;
1912 struct xpc_notify *notify = notify;
1913 s64 put, msg_number = msg->number;
1916 DBUG_ON(notify_type == XPC_N_CALL && func == NULL);
1917 DBUG_ON((((u64) msg - (u64) ch->local_msgqueue) / ch->msg_size) !=
1918 msg_number % ch->local_nentries);
1919 DBUG_ON(msg->flags & XPC_M_READY);
1921 if (ch->flags & XPC_C_DISCONNECTING) {
1922 /* drop the reference grabbed in xpc_allocate_msg() */
1923 xpc_msgqueue_deref(ch);
1927 if (notify_type != 0) {
1929 * Tell the remote side to send an ACK interrupt when the
1930 * message has been delivered.
1932 msg->flags |= XPC_M_INTERRUPT;
1934 atomic_inc(&ch->n_to_notify);
1936 notify = &ch->notify_queue[msg_number % ch->local_nentries];
1937 notify->func = func;
1939 notify->type = notify_type;
1941 // >>> is a mb() needed here?
1943 if (ch->flags & XPC_C_DISCONNECTING) {
1945 * An error occurred between our last error check and
1946 * this one. We will try to clear the type field from
1947 * the notify entry. If we succeed then
1948 * xpc_disconnect_channel() didn't already process
1951 if (cmpxchg(¬ify->type, notify_type, 0) ==
1953 atomic_dec(&ch->n_to_notify);
1957 /* drop the reference grabbed in xpc_allocate_msg() */
1958 xpc_msgqueue_deref(ch);
1963 msg->flags |= XPC_M_READY;
1966 * The preceding store of msg->flags must occur before the following
1967 * load of ch->local_GP->put.
1971 /* see if the message is next in line to be sent, if so send it */
1973 put = ch->local_GP->put;
1974 if (put == msg_number) {
1975 xpc_send_msgs(ch, put);
1978 /* drop the reference grabbed in xpc_allocate_msg() */
1979 xpc_msgqueue_deref(ch);
1985 * Send a message previously allocated using xpc_initiate_allocate() on the
1986 * specified channel connected to the specified partition.
1988 * This routine will not wait for the message to be received, nor will
1989 * notification be given when it does happen. Once this routine has returned
1990 * the message entry allocated via xpc_initiate_allocate() is no longer
1991 * accessable to the caller.
1993 * This routine, although called by users, does not call xpc_part_ref() to
1994 * ensure that the partition infrastructure is in place. It relies on the
1995 * fact that we called xpc_msgqueue_ref() in xpc_allocate_msg().
1999 * partid - ID of partition to which the channel is connected.
2000 * ch_number - channel # to send message on.
2001 * payload - pointer to the payload area allocated via
2002 * xpc_initiate_allocate().
2005 xpc_initiate_send(partid_t partid, int ch_number, void *payload)
2007 struct xpc_partition *part = &xpc_partitions[partid];
2008 struct xpc_msg *msg = XPC_MSG_ADDRESS(payload);
2009 enum xpc_retval ret;
2012 dev_dbg(xpc_chan, "msg=0x%p, partid=%d, channel=%d\n", (void *) msg,
2015 DBUG_ON(partid <= 0 || partid >= XP_MAX_PARTITIONS);
2016 DBUG_ON(ch_number < 0 || ch_number >= part->nchannels);
2017 DBUG_ON(msg == NULL);
2019 ret = xpc_send_msg(&part->channels[ch_number], msg, 0, NULL, NULL);
2026 * Send a message previously allocated using xpc_initiate_allocate on the
2027 * specified channel connected to the specified partition.
2029 * This routine will not wait for the message to be sent. Once this routine
2030 * has returned the message entry allocated via xpc_initiate_allocate() is no
2031 * longer accessable to the caller.
2033 * Once the remote end of the channel has received the message, the function
2034 * passed as an argument to xpc_initiate_send_notify() will be called. This
2035 * allows the sender to free up or re-use any buffers referenced by the
2036 * message, but does NOT mean the message has been processed at the remote
2037 * end by a receiver.
2039 * If this routine returns an error, the caller's function will NOT be called.
2041 * This routine, although called by users, does not call xpc_part_ref() to
2042 * ensure that the partition infrastructure is in place. It relies on the
2043 * fact that we called xpc_msgqueue_ref() in xpc_allocate_msg().
2047 * partid - ID of partition to which the channel is connected.
2048 * ch_number - channel # to send message on.
2049 * payload - pointer to the payload area allocated via
2050 * xpc_initiate_allocate().
2051 * func - function to call with asynchronous notification of message
2052 * receipt. THIS FUNCTION MUST BE NON-BLOCKING.
2053 * key - user-defined key to be passed to the function when it's called.
2056 xpc_initiate_send_notify(partid_t partid, int ch_number, void *payload,
2057 xpc_notify_func func, void *key)
2059 struct xpc_partition *part = &xpc_partitions[partid];
2060 struct xpc_msg *msg = XPC_MSG_ADDRESS(payload);
2061 enum xpc_retval ret;
2064 dev_dbg(xpc_chan, "msg=0x%p, partid=%d, channel=%d\n", (void *) msg,
2067 DBUG_ON(partid <= 0 || partid >= XP_MAX_PARTITIONS);
2068 DBUG_ON(ch_number < 0 || ch_number >= part->nchannels);
2069 DBUG_ON(msg == NULL);
2070 DBUG_ON(func == NULL);
2072 ret = xpc_send_msg(&part->channels[ch_number], msg, XPC_N_CALL,
2078 static struct xpc_msg *
2079 xpc_pull_remote_msg(struct xpc_channel *ch, s64 get)
2081 struct xpc_partition *part = &xpc_partitions[ch->partid];
2082 struct xpc_msg *remote_msg, *msg;
2083 u32 msg_index, nmsgs;
2085 enum xpc_retval ret;
2088 if (down_interruptible(&ch->msg_to_pull_sema) != 0) {
2089 /* we were interrupted by a signal */
2093 while (get >= ch->next_msg_to_pull) {
2095 /* pull as many messages as are ready and able to be pulled */
2097 msg_index = ch->next_msg_to_pull % ch->remote_nentries;
2099 DBUG_ON(ch->next_msg_to_pull >=
2100 (volatile s64) ch->w_remote_GP.put);
2101 nmsgs = (volatile s64) ch->w_remote_GP.put -
2102 ch->next_msg_to_pull;
2103 if (msg_index + nmsgs > ch->remote_nentries) {
2104 /* ignore the ones that wrap the msg queue for now */
2105 nmsgs = ch->remote_nentries - msg_index;
2108 msg_offset = msg_index * ch->msg_size;
2109 msg = (struct xpc_msg *) ((u64) ch->remote_msgqueue +
2111 remote_msg = (struct xpc_msg *) (ch->remote_msgqueue_pa +
2114 if ((ret = xpc_pull_remote_cachelines(part, msg, remote_msg,
2115 nmsgs * ch->msg_size)) != xpcSuccess) {
2117 dev_dbg(xpc_chan, "failed to pull %d msgs starting with"
2118 " msg %ld from partition %d, channel=%d, "
2119 "ret=%d\n", nmsgs, ch->next_msg_to_pull,
2120 ch->partid, ch->number, ret);
2122 XPC_DEACTIVATE_PARTITION(part, ret);
2124 up(&ch->msg_to_pull_sema);
2128 mb(); /* >>> this may not be needed, we're not sure */
2130 ch->next_msg_to_pull += nmsgs;
2133 up(&ch->msg_to_pull_sema);
2135 /* return the message we were looking for */
2136 msg_offset = (get % ch->remote_nentries) * ch->msg_size;
2137 msg = (struct xpc_msg *) ((u64) ch->remote_msgqueue + msg_offset);
2144 * Get a message to be delivered.
2146 static struct xpc_msg *
2147 xpc_get_deliverable_msg(struct xpc_channel *ch)
2149 struct xpc_msg *msg = NULL;
2154 if ((volatile u32) ch->flags & XPC_C_DISCONNECTING) {
2158 get = (volatile s64) ch->w_local_GP.get;
2159 if (get == (volatile s64) ch->w_remote_GP.put) {
2163 /* There are messages waiting to be pulled and delivered.
2164 * We need to try to secure one for ourselves. We'll do this
2165 * by trying to increment w_local_GP.get and hope that no one
2166 * else beats us to it. If they do, we'll we'll simply have
2167 * to try again for the next one.
2170 if (cmpxchg(&ch->w_local_GP.get, get, get + 1) == get) {
2171 /* we got the entry referenced by get */
2173 dev_dbg(xpc_chan, "w_local_GP.get changed to %ld, "
2174 "partid=%d, channel=%d\n", get + 1,
2175 ch->partid, ch->number);
2177 /* pull the message from the remote partition */
2179 msg = xpc_pull_remote_msg(ch, get);
2181 DBUG_ON(msg != NULL && msg->number != get);
2182 DBUG_ON(msg != NULL && (msg->flags & XPC_M_DONE));
2183 DBUG_ON(msg != NULL && !(msg->flags & XPC_M_READY));
2195 * Deliver a message to its intended recipient.
2198 xpc_deliver_msg(struct xpc_channel *ch)
2200 struct xpc_msg *msg;
2203 if ((msg = xpc_get_deliverable_msg(ch)) != NULL) {
2206 * This ref is taken to protect the payload itself from being
2207 * freed before the user is finished with it, which the user
2208 * indicates by calling xpc_initiate_received().
2210 xpc_msgqueue_ref(ch);
2212 atomic_inc(&ch->kthreads_active);
2214 if (ch->func != NULL) {
2215 dev_dbg(xpc_chan, "ch->func() called, msg=0x%p, "
2216 "msg_number=%ld, partid=%d, channel=%d\n",
2217 (void *) msg, msg->number, ch->partid,
2220 /* deliver the message to its intended recipient */
2221 ch->func(xpcMsgReceived, ch->partid, ch->number,
2222 &msg->payload, ch->key);
2224 dev_dbg(xpc_chan, "ch->func() returned, msg=0x%p, "
2225 "msg_number=%ld, partid=%d, channel=%d\n",
2226 (void *) msg, msg->number, ch->partid,
2230 atomic_dec(&ch->kthreads_active);
2236 * Now we actually acknowledge the messages that have been delivered and ack'd
2237 * by advancing the cached remote message queue's Get value and if requested
2238 * send an IPI to the message sender's partition.
2241 xpc_acknowledge_msgs(struct xpc_channel *ch, s64 initial_get, u8 msg_flags)
2243 struct xpc_msg *msg;
2244 s64 get = initial_get + 1;
2251 if (get == (volatile s64) ch->w_local_GP.get) {
2255 msg = (struct xpc_msg *) ((u64) ch->remote_msgqueue +
2256 (get % ch->remote_nentries) * ch->msg_size);
2258 if (!(msg->flags & XPC_M_DONE)) {
2262 msg_flags |= msg->flags;
2266 if (get == initial_get) {
2267 /* nothing's changed */
2271 if (cmpxchg_rel(&ch->local_GP->get, initial_get, get) !=
2273 /* someone else beat us to it */
2274 DBUG_ON((volatile s64) ch->local_GP->get <=
2279 /* we just set the new value of local_GP->get */
2281 dev_dbg(xpc_chan, "local_GP->get changed to %ld, partid=%d, "
2282 "channel=%d\n", get, ch->partid, ch->number);
2284 send_IPI = (msg_flags & XPC_M_INTERRUPT);
2287 * We need to ensure that the message referenced by
2288 * local_GP->get is not XPC_M_DONE or that local_GP->get
2289 * equals w_local_GP.get, so we'll go have a look.
2295 xpc_IPI_send_msgrequest(ch);
2301 * Acknowledge receipt of a delivered message.
2303 * If a message has XPC_M_INTERRUPT set, send an interrupt to the partition
2304 * that sent the message.
2306 * This function, although called by users, does not call xpc_part_ref() to
2307 * ensure that the partition infrastructure is in place. It relies on the
2308 * fact that we called xpc_msgqueue_ref() in xpc_deliver_msg().
2312 * partid - ID of partition to which the channel is connected.
2313 * ch_number - channel # message received on.
2314 * payload - pointer to the payload area allocated via
2315 * xpc_initiate_allocate().
2318 xpc_initiate_received(partid_t partid, int ch_number, void *payload)
2320 struct xpc_partition *part = &xpc_partitions[partid];
2321 struct xpc_channel *ch;
2322 struct xpc_msg *msg = XPC_MSG_ADDRESS(payload);
2323 s64 get, msg_number = msg->number;
2326 DBUG_ON(partid <= 0 || partid >= XP_MAX_PARTITIONS);
2327 DBUG_ON(ch_number < 0 || ch_number >= part->nchannels);
2329 ch = &part->channels[ch_number];
2331 dev_dbg(xpc_chan, "msg=0x%p, msg_number=%ld, partid=%d, channel=%d\n",
2332 (void *) msg, msg_number, ch->partid, ch->number);
2334 DBUG_ON((((u64) msg - (u64) ch->remote_msgqueue) / ch->msg_size) !=
2335 msg_number % ch->remote_nentries);
2336 DBUG_ON(msg->flags & XPC_M_DONE);
2338 msg->flags |= XPC_M_DONE;
2341 * The preceding store of msg->flags must occur before the following
2342 * load of ch->local_GP->get.
2347 * See if this message is next in line to be acknowledged as having
2350 get = ch->local_GP->get;
2351 if (get == msg_number) {
2352 xpc_acknowledge_msgs(ch, get, msg->flags);
2355 /* the call to xpc_msgqueue_ref() was done by xpc_deliver_msg() */
2356 xpc_msgqueue_deref(ch);