<h2>thread_swap_exception_ports</h2>

<strong>Function</strong> - Swap exception ports for a thread.

<h3>SYNOPSIS</h3>

<strong>kern_return_t thread_swap_exception_ports</strong>

<strong>(thread_act_t</strong> <var>thread</var>,

<strong>exception_mask_t</strong> <var>exception_types</var>,

<strong>mach_port_t</strong> <var>exception_port</var>,

<strong>exception_behavior_t</strong> <var>behavior</var>,

<strong>thread_state_flavor_t</strong> <var>flavor</var>,

<strong>exception_mask_array_t</strong> <var>old_exception_masks</var>,

<strong>old_exception_masks</strong> <var>old_exception_count</var>,

<strong>exception_port_array_t</strong> <var>old_exception_ports</var>,

<strong>exception_behavior_array_t</strong> <var>old_behaviors</var>,

<strong>exception_flavor_array_t</strong> <var>old_flavors</var><strong>);</strong>

<h3>PARAMETERS</h3>

<dt> <var>thread</var>

[in thread send right]

The thread for which to set the ports.

<dt> <var>exception_types</var>

[in scalar]

A flag word indicating the types of exceptions for which the

exception port applies:

<dt> <strong>EXC_MASK_BAD_ACCESS</strong>

Could not access memory.

<dt> <strong>EXC_MASK_BAD_INSTRUCTION</strong>

Instruction failed. Illegal or undefined instruction or operand.

<dt> <strong>EXC_MASK_ARITHMETIC</strong>

Arithmetic exception

<dt> <strong>EXC_MASK_EMULATION</strong>

Emulation instruction. Emulation support instruction

encountered.

<dt> <strong>EXC_MASK_SOFTWARE</strong>

Software generated exception.

<dt> <strong>EXC_MASK_BREAKPOINT</strong>

Trace, breakpoint, etc.

<dt> <strong>EXC_MASK_SYSCALL</strong>

System call requested.

<dt> <strong>EXC_MASK_MACH_SYSCALL</strong>

System call with a number in the Mach call range requested.

<dt> <var>exception_port</var>

[in exception send right]

The exception port for all selected exception

types.

<dt> <var>behavior</var>

[in scalar]

Control of the behavior of the exception processing. Defined

types are:

<dt> <strong>EXCEPTION_DEFAULT</strong>

Send a <strong>catch_exception_raise</strong> message including the thread

identity.

<dt> <strong>EXCEPTION_DEFAULT_PROTECTED</strong>

Send a <strong>catch_exception_raise</strong> message including the thread

identity. Mark the exception port (and associated exceptions)

as protected.

<dt> <strong>EXCEPTION_STATE</strong>

Send a <strong>catch_exception_raise_state</strong> message including the

thread state.

<dt> <strong>EXCEPTION_STATE_PROTECTED</strong>

Send a <strong>catch_exception_raise_state</strong> message including the

thread state. Mark the exception port (and associated

exceptions) as protected.

<dt> <strong>EXCEPTION_STATE_IDENTITY</strong>

Send a <strong>catch_exception_raise_state_identity</strong> message

including the thread identity and state.

<dt> <strong>EXCEPTION_STATE_IDENTITY_PROTECTED</strong>

Send a <strong>catch_exception_raise_state_identity</strong> message

including the thread identity and state. Mark the exception port

(and associated exceptions) as protected.

<dt> <var>flavor</var>

[in scalar]

The type of state to be sent with the exception message.

These types are defined in \*L<mach/thread_states.h>\*O.

<dt> <var>old_exception_masks</var>

[out array of <var>exception_mask_t</var>]

An array, each element being a mask

specifying for which exception types the corresponding element of the

other arrays apply.

<dt> <var>old_exception_count</var>

[pointer to in/out scalar]

On input, the maximum size of the array

buffers; on output, the number of returned <exception type mask,

exception port, behavior, flavor> sets returned.

<dt> <var>old_exception_ports</var>

[out array of exception send rights]

The returned exception ports.

<dt> <var>old_behaviors</var>

[out array of <var>exception_behavior_t</var>]

The type of exception message to

be sent as with <var>behavior</var>.

<dt> <var>old_flavors</var>

[out array of <var>thread_state_flavor_t</var>]

The type of state to be sent with

the exception message. These types are defined in

\*L<mach/thread_states.h>\*O.

<h3>DESCRIPTION</h3>

The <strong>thread_swap_exception_ports</strong> function sets a specified

set of exception

ports belonging to <var>thread</var>, returning the old set.

<h3>NOTES</h3>

If the value of the <strong>EXC_MACH_SYSCALL</strong> exception class exception port is

the host name port, Mach kernel traps are executed by the kernel as expected;

any other value causes the attempted execution of these system call numbers to

be considered an exception.

A "protected" exception port is one which cannot be fetched and for which

exception processing cannot be aborted (<strong>thread_abort</strong>).

<h3>RETURN VALUES</h3>

<dt> <strong>KERN_EXCEPTION_PROTECTED</strong>

One of the requested exception ports is protected and cannot be returned.

<h3>RELATED INFORMATION</h3>

Functions:

<a href="mach_thread_self.html"><strong>mach_thread_self</strong></a>,

<a href="task_get_exception_ports.html"><strong>task_get_exception_ports</strong></a>,

<a href="task_set_exception_ports.html"><strong>task_set_exception_ports</strong></a>,

<a href="task_swap_exception_ports.html"><strong>task_swap_exception_ports</strong></a>,

<a href="thread_create.html"><strong>thread_create</strong></a>,

<a href="thread_get_exception_ports.html"><strong>thread_get_exception_ports</strong></a>,

<a href="thread_set_exception_ports.html"><strong>thread_set_exception_ports</strong></a>,

<a href="catch_exception_raise.html"><strong>catch_exception_raise</strong></a>,

<a href="thread_abort.html"><strong>thread_abort</strong></a>.