Subversion Repositories HelenOS-historic

Rev

Rev 1702 | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

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