Subversion Repositories HelenOS

Rev

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

Rev 1005 Rev 1027
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 /**< This is answer to a call */
40
#define IPC_CALL_ANSWERED      1 /**< This is answer to a call */
41
#define IPC_CALL_STATIC_ALLOC  2 /**< This call will not be freed on error */
41
#define IPC_CALL_STATIC_ALLOC  2 /**< This call will not be freed on error */
42
 
42
 
43
/* Flags for ipc_wait_for_call */
43
/* Flags for ipc_wait_for_call */
44
#define IPC_WAIT_NONBLOCKING   1
44
#define IPC_WAIT_NONBLOCKING   1
45
 
45
 
46
/* Flags of callid */
46
/* Flags of callid */
47
#define IPC_CALLID_ANSWERED  1
47
#define IPC_CALLID_ANSWERED  1
48
 
48
 
49
/* Return values from IPC_ASYNC */
49
/* Return values from IPC_ASYNC */
50
#define IPC_CALLRET_FATAL         -1
50
#define IPC_CALLRET_FATAL         -1
51
#define IPC_CALLRET_TEMPORARY     -2
51
#define IPC_CALLRET_TEMPORARY     -2
52
 
52
 
53
 
53
 
54
/* Macros for manipulating calling data */
54
/* Macros for manipulating calling data */
55
#define IPC_SET_RETVAL(data, retval)   ((data)[0] = (retval))
55
#define IPC_SET_RETVAL(data, retval)   ((data)[0] = (retval))
56
#define IPC_SET_METHOD(data, val)   ((data)[0] = (val))
56
#define IPC_SET_METHOD(data, val)   ((data)[0] = (val))
57
#define IPC_SET_ARG1(data, val)   ((data)[1] = (val))
57
#define IPC_SET_ARG1(data, val)   ((data)[1] = (val))
58
#define IPC_SET_ARG2(data, val)   ((data)[2] = (val))
58
#define IPC_SET_ARG2(data, val)   ((data)[2] = (val))
59
#define IPC_SET_ARG3(data, val)   ((data)[3] = (val))
59
#define IPC_SET_ARG3(data, val)   ((data)[3] = (val))
60
 
60
 
61
#define IPC_GET_METHOD(data)           ((data)[0])
61
#define IPC_GET_METHOD(data)           ((data)[0])
62
#define IPC_GET_RETVAL(data)           ((data)[0])
62
#define IPC_GET_RETVAL(data)           ((data)[0])
63
 
63
 
64
#define IPC_GET_ARG1(data)              ((data)[1])
64
#define IPC_GET_ARG1(data)              ((data)[1])
65
#define IPC_GET_ARG2(data)              ((data)[2])
65
#define IPC_GET_ARG2(data)              ((data)[2])
66
#define IPC_GET_ARG3(data)              ((data)[3])
66
#define IPC_GET_ARG3(data)              ((data)[3])
67
 
67
 
68
/* Well known phone descriptors */
68
/* Well known phone descriptors */
69
#define PHONE_NS              0
69
#define PHONE_NS              0
70
 
70
 
-
 
71
/* System-specific methods - only through special syscalls
-
 
72
 * These methods have special behaviour
-
 
73
 */
-
 
74
#define IPC_M_IAMCONNECTING   0
-
 
75
/** Protocol for CONNECT - TO - ME
-
 
76
 *
-
 
77
 * Calling process asks the callee to create a callback connection,
-
 
78
 * so that it can start initiating new messages.
-
 
79
 *
-
 
80
 * The protocol for negotiating is as follows:
-
 
81
 * - sys_connecttome - sends a message IPC_M_CONNECTTOME
-
 
82
 * - sys_wait_for_call - upon receipt tries to allocate new phone
-
 
83
 *                       - if it fails, responds with ELIMIT
-
 
84
 *                     - passes call to userspace. If userspace
-
 
85
 *                       responds with error, phone is deallocated and
-
 
86
 *                       error is sent back to caller. Otherwise
-
 
87
 *                       the call is accepted and the response is sent back.
-
 
88
 *                     - the allocated phoneid is passed to userspace as
-
 
89
 *                       ARG3 of the call.
-
 
90
 *                     - the caller obtains taskid of the called thread
-
 
91
 */
-
 
92
#define IPC_M_CONNECTTOME     1
-
 
93
#define IPC_M_CONNECTMETO     2
-
 
94
 
-
 
95
 
-
 
96
/* Well-known methods */
-
 
97
#define IPC_M_FIRST_USER      512
-
 
98
#define IPC_M_PING            512
-
 
99
/* User methods */
-
 
100
#define FIRST_USER_METHOD     1024
-
 
101
 
71
#ifdef KERNEL
102
#ifdef KERNEL
72
 
103
 
73
#include <synch/mutex.h>
104
#include <synch/mutex.h>
74
#include <synch/condvar.h>
105
#include <synch/condvar.h>
75
#include <adt/list.h>
106
#include <adt/list.h>
76
 
107
 
77
#define IPC_MAX_PHONES  16
108
#define IPC_MAX_PHONES  16
78
 
109
 
79
 
-
 
80
typedef struct answerbox answerbox_t;
110
typedef struct answerbox answerbox_t;
-
 
111
typedef __native ipc_data_t[IPC_CALL_LEN];
81
 
112
 
82
typedef struct {
113
typedef struct {
83
    link_t list;
114
    link_t list;
84
    answerbox_t *callerbox;
115
    answerbox_t *callerbox;
85
    int flags;
116
    int flags;
86
    task_t *sender;
117
    task_t *sender;
87
    __native data[IPC_CALL_LEN];
118
    ipc_data_t data;
88
} call_t;
119
} call_t;
89
 
120
 
90
struct answerbox {
121
struct answerbox {
91
    SPINLOCK_DECLARE(lock);
122
    SPINLOCK_DECLARE(lock);
92
 
123
 
-
 
124
    task_t *task;
-
 
125
 
93
    mutex_t mutex;
126
    mutex_t mutex;
94
    condvar_t cv;
127
    condvar_t cv;
95
 
128
 
96
    link_t connected_phones; /**< Phones connected to this answerbox */
129
    link_t connected_phones; /**< Phones connected to this answerbox */
97
    link_t calls;            /**< Received calls */
130
    link_t calls;            /**< Received calls */
98
    link_t dispatched_calls; /* Should be hash table in the future */
131
    link_t dispatched_calls; /* Should be hash table in the future */
99
 
132
 
100
    link_t answers;          /**< Answered calls */
133
    link_t answers;          /**< Answered calls */
101
};
134
};
102
 
135
 
103
typedef struct {
136
typedef struct {
104
    SPINLOCK_DECLARE(lock);
137
    SPINLOCK_DECLARE(lock);
105
    link_t list;
138
    link_t list;
106
    answerbox_t *callee;
139
    answerbox_t *callee;
107
} phone_t;
140
} phone_t;
108
 
141
 
109
extern void ipc_init(void);
142
extern void ipc_init(void);
110
extern call_t * ipc_wait_for_call(answerbox_t *box, int flags);
143
extern call_t * ipc_wait_for_call(answerbox_t *box, int flags);
111
extern void ipc_answer(answerbox_t *box, call_t *request);
144
extern void ipc_answer(answerbox_t *box, call_t *request);
112
extern void ipc_call(phone_t *phone, call_t *request);
145
extern void ipc_call(phone_t *phone, call_t *request);
113
extern void ipc_call_sync(phone_t *phone, call_t *request);
146
extern void ipc_call_sync(phone_t *phone, call_t *request);
114
extern void ipc_phone_destroy(phone_t *phone);
147
extern void ipc_phone_destroy(phone_t *phone);
115
extern void ipc_phone_init(phone_t *phone, answerbox_t *box);
148
extern void ipc_phone_init(phone_t *phone, answerbox_t *box);
116
extern void ipc_call_free(call_t *call);
149
extern void ipc_call_free(call_t *call);
117
extern call_t * ipc_call_alloc(void);
150
extern call_t * ipc_call_alloc(void);
118
extern void ipc_answerbox_init(answerbox_t *box);
151
extern void ipc_answerbox_init(answerbox_t *box);
119
extern void ipc_phone_init(phone_t *phone, answerbox_t *box);
152
extern void ipc_phone_init(phone_t *phone, answerbox_t *box);
120
extern void ipc_call_init(call_t *call);
153
extern void ipc_call_init(call_t *call);
121
 
154
 
122
extern answerbox_t *ipc_phone_0;
155
extern answerbox_t *ipc_phone_0;
123
 
156
 
124
#endif
157
#endif
125
 
158
 
126
#endif
159
#endif
127
 
160