Subversion Repositories HelenOS-historic

Rev

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