Subversion Repositories HelenOS

Rev

Rev 2025 | Rev 2071 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
955 palkovsky 1
/*
2
 * Copyright (C) 2006 Ondrej Palkovsky
3
 * All rights reserved.
4
 *
5
 * Redistribution and use in source and binary forms, with or without
6
 * modification, are permitted provided that the following conditions
7
 * are met:
8
 *
9
 * - Redistributions of source code must retain the above copyright
10
 *   notice, this list of conditions and the following disclaimer.
11
 * - Redistributions in binary form must reproduce the above copyright
12
 *   notice, this list of conditions and the following disclaimer in the
13
 *   documentation and/or other materials provided with the distribution.
14
 * - The name of the author may not be used to endorse or promote products
15
 *   derived from this software without specific prior written permission.
16
 *
17
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27
 */
28
 
1888 jermar 29
/** @addtogroup genericipc
1702 cejka 30
 * @{
31
 */
32
/** @file
33
 */
34
 
1877 jermar 35
#ifndef KERN_IPC_H_
36
#define KERN_IPC_H_
955 palkovsky 37
 
965 palkovsky 38
/* Length of data being transfered with IPC call */
39
/* - the uspace may not be able to utilize full length */
40
#define IPC_CALL_LEN    4
955 palkovsky 41
 
998 palkovsky 42
/** Maximum active async calls per thread */
1643 palkovsky 43
#ifdef CONFIG_DEBUG
44
# define IPC_MAX_ASYNC_CALLS  4
45
#else
46
# define IPC_MAX_ASYNC_CALLS  4000
47
#endif
998 palkovsky 48
 
955 palkovsky 49
/* Flags for calls */
1088 palkovsky 50
#define IPC_CALL_ANSWERED       (1<<0) /**< This is answer to a call */
51
#define IPC_CALL_STATIC_ALLOC   (1<<1) /**< This call will not be freed on error */
1941 decky 52
#define IPC_CALL_DISCARD_ANSWER (1<<2) /**< Answer will not be passed to userspace, will be discarded */
53
#define IPC_CALL_FORWARDED      (1<<3) /**< Call was forwarded */
54
#define IPC_CALL_CONN_ME_TO     (1<<4) /**< Identify connect_me_to answer */
55
#define IPC_CALL_NOTIF          (1<<5) /**< Interrupt notification */
965 palkovsky 56
 
1086 palkovsky 57
/* Flags of callid (the addresses are aligned at least to 4,
58
 * that is why we can use bottom 2 bits of the call address
59
 */
60
#define IPC_CALLID_ANSWERED       1 /**< Type of this msg is 'answer' */
61
#define IPC_CALLID_NOTIFICATION   2 /**< Type of this msg is 'notification' */
965 palkovsky 62
 
63
/* Return values from IPC_ASYNC */
64
#define IPC_CALLRET_FATAL         -1
65
#define IPC_CALLRET_TEMPORARY     -2
66
 
67
 
68
/* Macros for manipulating calling data */
1086 palkovsky 69
#define IPC_SET_RETVAL(data, retval)   ((data).args[0] = (retval))
70
#define IPC_SET_METHOD(data, val)   ((data).args[0] = (val))
71
#define IPC_SET_ARG1(data, val)   ((data).args[1] = (val))
72
#define IPC_SET_ARG2(data, val)   ((data).args[2] = (val))
73
#define IPC_SET_ARG3(data, val)   ((data).args[3] = (val))
965 palkovsky 74
 
1086 palkovsky 75
#define IPC_GET_METHOD(data)           ((data).args[0])
76
#define IPC_GET_RETVAL(data)           ((data).args[0])
965 palkovsky 77
 
1086 palkovsky 78
#define IPC_GET_ARG1(data)              ((data).args[1])
79
#define IPC_GET_ARG2(data)              ((data).args[2])
80
#define IPC_GET_ARG3(data)              ((data).args[3])
965 palkovsky 81
 
82
/* Well known phone descriptors */
83
#define PHONE_NS              0
84
 
1027 palkovsky 85
/* System-specific methods - only through special syscalls
86
 * These methods have special behaviour
87
 */
88
/** Protocol for CONNECT - TO - ME
89
 *
90
 * Calling process asks the callee to create a callback connection,
91
 * so that it can start initiating new messages.
92
 *
1040 palkovsky 93
 * The protocol for negotiating is:
1066 jermar 94
 * - sys_connect_to_me - sends a message IPC_M_CONNECTTOME
1027 palkovsky 95
 * - sys_wait_for_call - upon receipt tries to allocate new phone
96
 *                       - if it fails, responds with ELIMIT
97
 *                     - passes call to userspace. If userspace
98
 *                       responds with error, phone is deallocated and
99
 *                       error is sent back to caller. Otherwise
100
 *                       the call is accepted and the response is sent back.
1040 palkovsky 101
 *                     - the allocated phoneid is passed to userspace
102
 *                       (on the receiving sid) as ARG3 of the call.
1027 palkovsky 103
 *                     - the caller obtains taskid of the called thread
104
 */
1086 palkovsky 105
#define IPC_M_CONNECT_TO_ME     1
1040 palkovsky 106
/** Protocol for CONNECT - ME - TO
107
 *
108
 * Calling process asks the callee to create for him a new connection.
109
 * E.g. the caller wants a name server to connect him to print server.
110
 *
111
 * The protocol for negotiating is:
112
 * - sys_connect_me_to - send a synchronous message to name server
113
 *                       indicating that it wants to be connected to some
114
 *                       service
1060 palkovsky 115
 *                     - arg1/2 are user specified, arg3 contains
116
 *                       address of the phone that should be connected
117
 *                       (TODO: it leaks to userspace)
1342 jermar 118
 *   recipient         -  if ipc_answer == 0, then accept connection
1040 palkovsky 119
 *                     -  otherwise connection refused
120
 *                     -  recepient may forward message. Forwarding
121
 *                        system message
122
 *
123
 */
1086 palkovsky 124
#define IPC_M_CONNECT_ME_TO     2
125
/** This message is sent to answerbox when the phone
126
 * is hung up
1040 palkovsky 127
 */
1086 palkovsky 128
#define IPC_M_PHONE_HUNGUP      3
1428 palkovsky 129
 
1342 jermar 130
/** Send as_area over IPC
2025 jermar 131
 * - ARG1 - src as_area base address
132
 * - ARG2 - size of src as_area (filled automatically by kernel)
133
 * - ARG3 - flags of the as_area being sent
134
 *
135
 * on answer:
136
 * - ARG1 - dst as_area base adress
1329 palkovsky 137
 */
1359 jermar 138
#define IPC_M_AS_AREA_SEND      5
1027 palkovsky 139
 
1428 palkovsky 140
/** Get as_area over IPC
2026 jermar 141
 * - ARG1 - dst as_area base address
142
 * - ARG2 - dst as_area size
2025 jermar 143
 * - ARG3 - user defined argument
144
 *
2026 jermar 145
 * on answer, the server must set:
2025 jermar 146
 *
147
 * - ARG1 - src as_area base address
148
 * - ARG2 - flags that will be used for sharing
1428 palkovsky 149
 */
150
#define IPC_M_AS_AREA_RECV      6
1027 palkovsky 151
 
1428 palkovsky 152
 
1027 palkovsky 153
/* Well-known methods */
1040 palkovsky 154
#define IPC_M_LAST_SYSTEM     511
1027 palkovsky 155
#define IPC_M_PING            512
156
/* User methods */
157
#define FIRST_USER_METHOD     1024
158
 
955 palkovsky 159
#ifdef KERNEL
160
 
1923 jermar 161
#include <synch/waitq.h>
955 palkovsky 162
#include <adt/list.h>
163
 
164
#define IPC_MAX_PHONES  16
165
 
1086 palkovsky 166
typedef struct answerbox_s answerbox_t;
167
typedef struct phone_s phone_t;
955 palkovsky 168
typedef struct {
1780 jermar 169
    unative_t args[IPC_CALL_LEN];
1086 palkovsky 170
    phone_t *phone;
1888 jermar 171
} ipc_data_t;
955 palkovsky 172
 
1086 palkovsky 173
struct answerbox_s {
955 palkovsky 174
    SPINLOCK_DECLARE(lock);
175
 
1027 palkovsky 176
    task_t *task;
177
 
1040 palkovsky 178
    waitq_t wq;
955 palkovsky 179
 
1933 jermar 180
    link_t connected_phones;    /**< Phones connected to this answerbox */
181
    link_t calls;           /**< Received calls */
182
    link_t dispatched_calls;    /* Should be hash table in the future */
955 palkovsky 183
 
1933 jermar 184
    link_t answers;         /**< Answered calls */
1258 palkovsky 185
 
186
    SPINLOCK_DECLARE(irq_lock);
1933 jermar 187
    link_t irq_notifs;          /**< Notifications from IRQ handlers */
188
    link_t irq_head;        /**< IRQs with notifications to this answerbox. */
955 palkovsky 189
};
190
 
1088 palkovsky 191
typedef enum {
1568 palkovsky 192
    IPC_PHONE_FREE = 0,     /**< Phone is free and can be allocated */
193
    IPC_PHONE_CONNECTING,   /**< Phone is connecting somewhere */
194
    IPC_PHONE_CONNECTED,    /**< Phone is connected */
1877 jermar 195
    IPC_PHONE_HUNGUP,   /**< Phone is hung up, waiting for answers to come */
1568 palkovsky 196
    IPC_PHONE_SLAMMED       /**< Phone was hungup from server */
197
} ipc_phone_state_t;
1088 palkovsky 198
 
1573 palkovsky 199
/** Structure identifying phone (in TASK structure) */
1086 palkovsky 200
struct phone_s {
955 palkovsky 201
    SPINLOCK_DECLARE(lock);
1573 palkovsky 202
    link_t link;
955 palkovsky 203
    answerbox_t *callee;
1568 palkovsky 204
    ipc_phone_state_t state;
1086 palkovsky 205
    atomic_t active_calls;
206
};
955 palkovsky 207
 
1086 palkovsky 208
typedef struct {
1573 palkovsky 209
    link_t link;
1086 palkovsky 210
 
211
    int flags;
212
 
213
    /* Identification of the caller */
214
    task_t *sender;
215
    /* The caller box is different from sender->answerbox
216
     * for synchronous calls
217
     */
218
    answerbox_t *callerbox;
219
 
1780 jermar 220
    unative_t private; /**< Private data to internal IPC */
1090 palkovsky 221
 
222
    ipc_data_t data;  /**< Data passed from/to userspace */
1888 jermar 223
} call_t;
1086 palkovsky 224
 
955 palkovsky 225
extern void ipc_init(void);
1780 jermar 226
extern call_t * ipc_wait_for_call(answerbox_t *box, uint32_t usec, int flags);
955 palkovsky 227
extern void ipc_answer(answerbox_t *box, call_t *request);
1088 palkovsky 228
extern int ipc_call(phone_t *phone, call_t *call);
959 palkovsky 229
extern void ipc_call_sync(phone_t *phone, call_t *request);
1040 palkovsky 230
extern void ipc_phone_init(phone_t *phone);
231
extern void ipc_phone_connect(phone_t *phone, answerbox_t *box);
955 palkovsky 232
extern void ipc_call_free(call_t *call);
1258 palkovsky 233
extern call_t * ipc_call_alloc(int flags);
965 palkovsky 234
extern void ipc_answerbox_init(answerbox_t *box);
1084 palkovsky 235
extern void ipc_call_static_init(call_t *call);
1060 palkovsky 236
extern void task_print_list(void);
1088 palkovsky 237
extern int ipc_forward(call_t *call, phone_t *newphone, answerbox_t *oldbox);
1582 palkovsky 238
void ipc_cleanup(void);
1591 palkovsky 239
int ipc_phone_hangup(phone_t *phone);
1780 jermar 240
extern void ipc_backsend_err(phone_t *phone, call_t *call, unative_t err);
1573 palkovsky 241
extern void ipc_print_task(task_id_t taskid);
955 palkovsky 242
 
1090 palkovsky 243
extern answerbox_t *ipc_phone_0;
244
 
955 palkovsky 245
#endif
246
 
247
#endif
1702 cejka 248
 
1877 jermar 249
/** @}
1702 cejka 250
 */