Subversion Repositories HelenOS

Rev

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