Subversion Repositories HelenOS-historic

Rev

Rev 1359 | Rev 1428 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 1359 Rev 1364
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
#ifndef __IPC_H__
29
#ifndef __IPC_H__
30
#define __IPC_H__
30
#define __IPC_H__
31
 
31
 
32
/* Length of data being transfered with IPC call */
32
/* Length of data being transfered with IPC call */
33
/* - the uspace may not be able to utilize full length */
33
/* - the uspace may not be able to utilize full length */
34
#define IPC_CALL_LEN    4
34
#define IPC_CALL_LEN    4
35
 
35
 
36
/** Maximum active async calls per thread */
36
/** Maximum active async calls per thread */
37
#define IPC_MAX_ASYNC_CALLS  4
37
#define IPC_MAX_ASYNC_CALLS  4
38
 
38
 
39
/* Flags for calls */
39
/* Flags for calls */
40
#define IPC_CALL_ANSWERED       (1<<0) /**< This is answer to a call */
40
#define IPC_CALL_ANSWERED       (1<<0) /**< This is answer to a call */
41
#define IPC_CALL_STATIC_ALLOC   (1<<1) /**< This call will not be freed on error */
41
#define IPC_CALL_STATIC_ALLOC   (1<<1) /**< This call will not be freed on error */
42
#define IPC_CALL_DISCARD_ANSWER (1<<2) /**< Answer will not be passed to
42
#define IPC_CALL_DISCARD_ANSWER (1<<2) /**< Answer will not be passed to
43
                    * userspace, will be discarded */
43
                    * userspace, will be discarded */
44
#define IPC_CALL_FORWARDED      (1<<3) /* Call was forwarded */
44
#define IPC_CALL_FORWARDED      (1<<3) /* Call was forwarded */
45
#define IPC_CALL_CONN_ME_TO     (1<<4) /* Identify connect_me_to */
45
#define IPC_CALL_CONN_ME_TO     (1<<4) /* Identify connect_me_to */
46
#define IPC_CALL_NOTIF          (1<<5) /* Interrupt notification */
46
#define IPC_CALL_NOTIF          (1<<5) /* Interrupt notification */
47
 
47
 
48
/* Flags for ipc_wait_for_call */
-
 
49
#define IPC_WAIT_NONBLOCKING   1
-
 
50
 
-
 
51
/* Flags of callid (the addresses are aligned at least to 4,
48
/* Flags of callid (the addresses are aligned at least to 4,
52
 * that is why we can use bottom 2 bits of the call address
49
 * that is why we can use bottom 2 bits of the call address
53
 */
50
 */
54
#define IPC_CALLID_ANSWERED       1 /**< Type of this msg is 'answer' */
51
#define IPC_CALLID_ANSWERED       1 /**< Type of this msg is 'answer' */
55
#define IPC_CALLID_NOTIFICATION   2 /**< Type of this msg is 'notification' */
52
#define IPC_CALLID_NOTIFICATION   2 /**< Type of this msg is 'notification' */
56
 
53
 
57
/* Return values from IPC_ASYNC */
54
/* Return values from IPC_ASYNC */
58
#define IPC_CALLRET_FATAL         -1
55
#define IPC_CALLRET_FATAL         -1
59
#define IPC_CALLRET_TEMPORARY     -2
56
#define IPC_CALLRET_TEMPORARY     -2
60
 
57
 
61
 
58
 
62
/* Macros for manipulating calling data */
59
/* Macros for manipulating calling data */
63
#define IPC_SET_RETVAL(data, retval)   ((data).args[0] = (retval))
60
#define IPC_SET_RETVAL(data, retval)   ((data).args[0] = (retval))
64
#define IPC_SET_METHOD(data, val)   ((data).args[0] = (val))
61
#define IPC_SET_METHOD(data, val)   ((data).args[0] = (val))
65
#define IPC_SET_ARG1(data, val)   ((data).args[1] = (val))
62
#define IPC_SET_ARG1(data, val)   ((data).args[1] = (val))
66
#define IPC_SET_ARG2(data, val)   ((data).args[2] = (val))
63
#define IPC_SET_ARG2(data, val)   ((data).args[2] = (val))
67
#define IPC_SET_ARG3(data, val)   ((data).args[3] = (val))
64
#define IPC_SET_ARG3(data, val)   ((data).args[3] = (val))
68
 
65
 
69
#define IPC_GET_METHOD(data)           ((data).args[0])
66
#define IPC_GET_METHOD(data)           ((data).args[0])
70
#define IPC_GET_RETVAL(data)           ((data).args[0])
67
#define IPC_GET_RETVAL(data)           ((data).args[0])
71
 
68
 
72
#define IPC_GET_ARG1(data)              ((data).args[1])
69
#define IPC_GET_ARG1(data)              ((data).args[1])
73
#define IPC_GET_ARG2(data)              ((data).args[2])
70
#define IPC_GET_ARG2(data)              ((data).args[2])
74
#define IPC_GET_ARG3(data)              ((data).args[3])
71
#define IPC_GET_ARG3(data)              ((data).args[3])
75
 
72
 
76
/* Well known phone descriptors */
73
/* Well known phone descriptors */
77
#define PHONE_NS              0
74
#define PHONE_NS              0
78
 
75
 
79
/* System-specific methods - only through special syscalls
76
/* System-specific methods - only through special syscalls
80
 * These methods have special behaviour
77
 * These methods have special behaviour
81
 */
78
 */
82
/** Protocol for CONNECT - TO - ME
79
/** Protocol for CONNECT - TO - ME
83
 *
80
 *
84
 * Calling process asks the callee to create a callback connection,
81
 * Calling process asks the callee to create a callback connection,
85
 * so that it can start initiating new messages.
82
 * so that it can start initiating new messages.
86
 *
83
 *
87
 * The protocol for negotiating is:
84
 * The protocol for negotiating is:
88
 * - sys_connect_to_me - sends a message IPC_M_CONNECTTOME
85
 * - sys_connect_to_me - sends a message IPC_M_CONNECTTOME
89
 * - sys_wait_for_call - upon receipt tries to allocate new phone
86
 * - sys_wait_for_call - upon receipt tries to allocate new phone
90
 *                       - if it fails, responds with ELIMIT
87
 *                       - if it fails, responds with ELIMIT
91
 *                     - passes call to userspace. If userspace
88
 *                     - passes call to userspace. If userspace
92
 *                       responds with error, phone is deallocated and
89
 *                       responds with error, phone is deallocated and
93
 *                       error is sent back to caller. Otherwise
90
 *                       error is sent back to caller. Otherwise
94
 *                       the call is accepted and the response is sent back.
91
 *                       the call is accepted and the response is sent back.
95
 *                     - the allocated phoneid is passed to userspace
92
 *                     - the allocated phoneid is passed to userspace
96
 *                       (on the receiving sid) as ARG3 of the call.
93
 *                       (on the receiving sid) as ARG3 of the call.
97
 *                     - the caller obtains taskid of the called thread
94
 *                     - the caller obtains taskid of the called thread
98
 */
95
 */
99
#define IPC_M_CONNECT_TO_ME     1
96
#define IPC_M_CONNECT_TO_ME     1
100
/** Protocol for CONNECT - ME - TO
97
/** Protocol for CONNECT - ME - TO
101
 *
98
 *
102
 * Calling process asks the callee to create for him a new connection.
99
 * Calling process asks the callee to create for him a new connection.
103
 * E.g. the caller wants a name server to connect him to print server.
100
 * E.g. the caller wants a name server to connect him to print server.
104
 *
101
 *
105
 * The protocol for negotiating is:
102
 * The protocol for negotiating is:
106
 * - sys_connect_me_to - send a synchronous message to name server
103
 * - sys_connect_me_to - send a synchronous message to name server
107
 *                       indicating that it wants to be connected to some
104
 *                       indicating that it wants to be connected to some
108
 *                       service
105
 *                       service
109
 *                     - arg1/2 are user specified, arg3 contains
106
 *                     - arg1/2 are user specified, arg3 contains
110
 *                       address of the phone that should be connected
107
 *                       address of the phone that should be connected
111
 *                       (TODO: it leaks to userspace)
108
 *                       (TODO: it leaks to userspace)
112
 *   recipient         -  if ipc_answer == 0, then accept connection
109
 *   recipient         -  if ipc_answer == 0, then accept connection
113
 *                     -  otherwise connection refused
110
 *                     -  otherwise connection refused
114
 *                     -  recepient may forward message. Forwarding
111
 *                     -  recepient may forward message. Forwarding
115
 *                        system message
112
 *                        system message
116
 *
113
 *
117
 */
114
 */
118
#define IPC_M_CONNECT_ME_TO     2
115
#define IPC_M_CONNECT_ME_TO     2
119
/** This message is sent to answerbox when the phone
116
/** This message is sent to answerbox when the phone
120
 * is hung up
117
 * is hung up
121
 */
118
 */
122
#define IPC_M_PHONE_HUNGUP      3
119
#define IPC_M_PHONE_HUNGUP      3
123
/** Interrupt notification */
120
/** Interrupt notification */
124
#define IPC_M_INTERRUPT         4
121
#define IPC_M_INTERRUPT         4
125
/** Send as_area over IPC
122
/** Send as_area over IPC
126
 * - ARG2 - src base address
123
 * - ARG2 - src base address
127
 * - ARG3 - size of src as(filled automatically by kernel)
124
 * - ARG3 - size of src as(filled automatically by kernel)
128
 * - on answer ARG1 - dst base adress
125
 * - on answer ARG1 - dst base adress
129
 */
126
 */
130
#define IPC_M_AS_AREA_SEND      5
127
#define IPC_M_AS_AREA_SEND      5
131
 
128
 
132
 
129
 
133
/* Well-known methods */
130
/* Well-known methods */
134
#define IPC_M_LAST_SYSTEM     511
131
#define IPC_M_LAST_SYSTEM     511
135
#define IPC_M_PING            512
132
#define IPC_M_PING            512
136
/* User methods */
133
/* User methods */
137
#define FIRST_USER_METHOD     1024
134
#define FIRST_USER_METHOD     1024
138
 
135
 
139
#ifdef KERNEL
136
#ifdef KERNEL
140
 
137
 
141
#include <synch/mutex.h>
138
#include <synch/mutex.h>
142
#include <synch/condvar.h>
139
#include <synch/condvar.h>
143
#include <adt/list.h>
140
#include <adt/list.h>
144
 
141
 
145
#define IPC_MAX_PHONES  16
142
#define IPC_MAX_PHONES  16
146
 
143
 
147
typedef struct answerbox_s answerbox_t;
144
typedef struct answerbox_s answerbox_t;
148
typedef struct phone_s phone_t;
145
typedef struct phone_s phone_t;
149
typedef struct {
146
typedef struct {
150
    __native args[IPC_CALL_LEN];
147
    __native args[IPC_CALL_LEN];
151
    phone_t *phone;
148
    phone_t *phone;
152
}ipc_data_t;
149
}ipc_data_t;
153
 
150
 
154
struct answerbox_s {
151
struct answerbox_s {
155
    SPINLOCK_DECLARE(lock);
152
    SPINLOCK_DECLARE(lock);
156
 
153
 
157
    task_t *task;
154
    task_t *task;
158
 
155
 
159
    waitq_t wq;
156
    waitq_t wq;
160
 
157
 
161
    link_t connected_phones; /**< Phones connected to this answerbox */
158
    link_t connected_phones; /**< Phones connected to this answerbox */
162
    link_t calls;            /**< Received calls */
159
    link_t calls;            /**< Received calls */
163
    link_t dispatched_calls; /* Should be hash table in the future */
160
    link_t dispatched_calls; /* Should be hash table in the future */
164
 
161
 
165
    link_t answers;          /**< Answered calls */
162
    link_t answers;          /**< Answered calls */
166
 
163
 
167
    SPINLOCK_DECLARE(irq_lock);
164
    SPINLOCK_DECLARE(irq_lock);
168
    link_t irq_notifs;       /**< Notifications from IRQ handlers */
165
    link_t irq_notifs;       /**< Notifications from IRQ handlers */
169
};
166
};
170
 
167
 
171
typedef enum {
168
typedef enum {
172
    IPC_BUSY_FREE = 0,
169
    IPC_BUSY_FREE = 0,
173
    IPC_BUSY_CONNECTING,
170
    IPC_BUSY_CONNECTING,
174
    IPC_BUSY_CONNECTED
171
    IPC_BUSY_CONNECTED
175
} ipc_busy_t;
172
} ipc_busy_t;
176
 
173
 
177
struct phone_s {
174
struct phone_s {
178
    SPINLOCK_DECLARE(lock);
175
    SPINLOCK_DECLARE(lock);
179
    link_t list;
176
    link_t list;
180
    answerbox_t *callee;
177
    answerbox_t *callee;
181
    ipc_busy_t busy;
178
    ipc_busy_t busy;
182
    atomic_t active_calls;
179
    atomic_t active_calls;
183
};
180
};
184
 
181
 
185
typedef struct {
182
typedef struct {
186
    link_t list;
183
    link_t list;
187
 
184
 
188
    int flags;
185
    int flags;
189
 
186
 
190
    /* Identification of the caller */
187
    /* Identification of the caller */
191
    task_t *sender;
188
    task_t *sender;
192
    /* The caller box is different from sender->answerbox
189
    /* The caller box is different from sender->answerbox
193
     * for synchronous calls
190
     * for synchronous calls
194
     */
191
     */
195
    answerbox_t *callerbox;
192
    answerbox_t *callerbox;
196
 
193
 
197
    __native private; /**< Private data to internal IPC */
194
    __native private; /**< Private data to internal IPC */
198
 
195
 
199
    ipc_data_t data;  /**< Data passed from/to userspace */
196
    ipc_data_t data;  /**< Data passed from/to userspace */
200
}call_t;
197
}call_t;
201
 
198
 
202
extern void ipc_init(void);
199
extern void ipc_init(void);
203
extern call_t * ipc_wait_for_call(answerbox_t *box, int flags);
200
extern call_t * ipc_wait_for_call(answerbox_t *box, __u32 usec, int nonblocking);
204
extern void ipc_answer(answerbox_t *box, call_t *request);
201
extern void ipc_answer(answerbox_t *box, call_t *request);
205
extern int ipc_call(phone_t *phone, call_t *call);
202
extern int ipc_call(phone_t *phone, call_t *call);
206
extern void ipc_call_sync(phone_t *phone, call_t *request);
203
extern void ipc_call_sync(phone_t *phone, call_t *request);
207
extern void ipc_phone_init(phone_t *phone);
204
extern void ipc_phone_init(phone_t *phone);
208
extern void ipc_phone_connect(phone_t *phone, answerbox_t *box);
205
extern void ipc_phone_connect(phone_t *phone, answerbox_t *box);
209
extern void ipc_call_free(call_t *call);
206
extern void ipc_call_free(call_t *call);
210
extern call_t * ipc_call_alloc(int flags);
207
extern call_t * ipc_call_alloc(int flags);
211
extern void ipc_answerbox_init(answerbox_t *box);
208
extern void ipc_answerbox_init(answerbox_t *box);
212
extern void ipc_call_static_init(call_t *call);
209
extern void ipc_call_static_init(call_t *call);
213
extern void task_print_list(void);
210
extern void task_print_list(void);
214
extern int ipc_forward(call_t *call, phone_t *newphone, answerbox_t *oldbox);
211
extern int ipc_forward(call_t *call, phone_t *newphone, answerbox_t *oldbox);
215
extern void ipc_cleanup(task_t *task);
212
extern void ipc_cleanup(task_t *task);
216
extern int ipc_phone_hangup(phone_t *phone);
213
extern int ipc_phone_hangup(phone_t *phone);
217
extern void ipc_backsend_err(phone_t *phone, call_t *call, __native err);
214
extern void ipc_backsend_err(phone_t *phone, call_t *call, __native err);
218
 
215
 
219
 
-
 
220
extern answerbox_t *ipc_phone_0;
216
extern answerbox_t *ipc_phone_0;
221
 
217
 
222
#endif
218
#endif
223
 
219
 
224
#endif
220
#endif
225
 
221