1/*
2 * Copyright (c) 2015-2016 Apple Inc. All rights reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
14 *
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27 */
28
29/*
30 * Copyright (C) 2011-2014 Matteo Landi, Luigi Rizzo. All rights reserved.
31 * Copyright (C) 2013-2014 Universita` di Pisa. All rights reserved.
32 *
33 * Redistribution and use in source and binary forms, with or without
34 * modification, are permitted provided that the following conditions
35 * are met:
36 * 1. Redistributions of source code must retain the above copyright
37 * notice, this list of conditions and the following disclaimer.
38 * 2. Redistributions in binary form must reproduce the above copyright
39 * notice, this list of conditions and the following disclaimer in the
40 * documentation and/or other materials provided with the distribution.
41 *
42 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
43 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
44 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
45 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
46 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
47 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
48 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
49 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
50 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
51 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52 * SUCH DAMAGE.
53 */
54
55#ifndef _SKYWALK_NEXUS_USER_PIPE_H_
56#define _SKYWALK_NEXUS_USER_PIPE_H_
57
58#include <skywalk/os_skywalk_private.h>
59
60#if CONFIG_NEXUS_USER_PIPE
61#define NX_UPIPE_MAXPIPES 64 /* max number of pipes per adapter */
62
63struct nexus_upipe_adapter {
64 /*
65 * This is an overlay structure on nexus_adapter;
66 * make sure it contains 'up' as the first member.
67 */
68 struct nexus_adapter pna_up;
69
70 uint32_t pna_id; /* pipe identifier */
71 ch_endpoint_t pna_role; /* master or slave */
72
73 struct nexus_adapter *pna_parent; /* adapter that owns the memory */
74 struct nexus_upipe_adapter *pna_peer; /* the other end of the pipe */
75 boolean_t pna_peer_ref; /* 1 iff we are holding a ref to the peer */
76
77 uint32_t pna_parent_slot; /* index in the parent pipe array */
78};
79
80/*
81 * nx_upipe is a descriptor for a user pipe nexus instance.
82 */
83struct nx_upipe {
84 struct nexus_adapter *nup_pna;
85 uint32_t nup_pna_users;
86 struct nxbind *nup_cli_nxb;
87 struct nxbind *nup_srv_nxb;
88};
89
90#define NX_UPIPE_PRIVATE(_nx) ((struct nx_upipe *)(_nx)->nx_arg)
91
92#define NEXUS_PROVIDER_USER_PIPE "com.apple.nexus.upipe"
93
94extern struct nxdom nx_upipe_dom_s;
95
96__BEGIN_DECLS
97extern void nx_upipe_na_dealloc(struct nexus_adapter *);
98extern int nx_upipe_na_find(struct kern_nexus *, struct kern_channel *,
99 struct chreq *, struct nxbind *, struct proc *, struct nexus_adapter **,
100 boolean_t);
101__END_DECLS
102#else /* !CONFIG_NEXUS_USER_PIPE */
103#define NM_MAXPIPES 0
104#endif /* !CONFIG_NEXUS_USER_PIPE */
105#endif /* _SKYWALK_NEXUS_USER_PIPE_H_ */
106