parlib: Add __uth_sync_swap and __uth_sync_is_empty
[akaros.git] / user / parlib / asynccall.c
1 #include <stdlib.h>
2
3 #include <parlib/common.h>
4 #include <parlib/assert.h>
5 #include <parlib/stdio.h>
6 #include <ros/syscall.h>
7 #include <ros/ring_syscall.h>
8 #include <ros/sysevent.h>
9 #include <parlib/arc.h>
10 #include <errno.h>
11 #include <parlib/arch/arch.h>
12 #include <sys/param.h>
13 #include <parlib/arch/atomic.h>
14 #include <parlib/vcore.h>
15
16 syscall_desc_pool_t syscall_desc_pool;
17 async_desc_pool_t async_desc_pool;
18 async_desc_t* current_async_desc;
19
20 struct arsc_channel global_ac;
21
22 void init_arc(struct arsc_channel* ac)
23 {
24         // Set up the front ring for the general syscall ring
25         // and the back ring for the general sysevent ring
26         mcs_lock_init(&ac->aclock);
27         ac->ring_page = (syscall_sring_t*)sys_init_arsc();
28
29         FRONT_RING_INIT(&ac->sysfr, ac->ring_page, SYSCALLRINGSIZE);
30         //BACK_RING_INIT(&syseventbackring, &(__procdata.syseventring), SYSEVENTRINGSIZE);
31         //TODO: eventually rethink about desc pools, they are here but no longer necessary
32         POOL_INIT(&syscall_desc_pool, MAX_SYSCALLS);
33         POOL_INIT(&async_desc_pool, MAX_ASYNCCALLS);
34 }
35
36 // Wait on all syscalls within this async call.  TODO - timeout or something?
37 int waiton_group_call(async_desc_t* desc, async_rsp_t* rsp)
38 {
39         syscall_rsp_t syscall_rsp;
40         syscall_desc_t* d;
41         int retval = 0;
42         int err = 0;
43         if (!desc) {
44                 errno = EINVAL;
45                 return -1;
46         }
47
48         while (!(TAILQ_EMPTY(&desc->syslist))) {
49                 d = TAILQ_FIRST(&desc->syslist);
50                 err = waiton_syscall(d);
51                 // TODO: processing the retval out of rsp here.  might be specific to
52                 // the async call.  do we want to accumulate?  return any negative
53                 // values?  depends what we want from the return value, so we might
54                 // have to pass in a function that is used to do the processing and
55                 // pass the answer back out in rsp.
56                 //rsp->retval += syscall_rsp.retval; // For example
57                 retval = MIN(retval, err);
58                 // remove from the list and free the syscall desc
59                 TAILQ_REMOVE(&desc->syslist, d, next);
60                 POOL_PUT(&syscall_desc_pool, d);
61         }
62         // run a cleanup function for this desc, if available
63         if (desc->cleanup)
64                 desc->cleanup(desc->data);
65         // free the asynccall desc
66         POOL_PUT(&async_desc_pool, desc);
67         return err;
68 }
69
70 // Finds a free async_desc_t, on which you can wait for a series of syscalls
71 async_desc_t* get_async_desc(void)
72 {
73         async_desc_t* desc = POOL_GET(&async_desc_pool);
74         if (desc) {
75                 // Clear out any data that was in the old desc
76                 memset(desc, 0, sizeof(*desc));
77                 TAILQ_INIT(&desc->syslist);
78         }
79         return desc;
80 }
81
82 // Finds a free sys_desc_t, on which you can wait for a specific syscall, and
83 // binds it to the group desc.
84 syscall_desc_t* get_sys_desc(async_desc_t* desc)
85 {
86         syscall_desc_t* d = POOL_GET(&syscall_desc_pool);
87         if (d) {
88                 // Clear out any data that was in the old desc
89                 memset(d, 0, sizeof(*d));
90         TAILQ_INSERT_TAIL(&desc->syslist, d, next);
91         }
92         return d;
93 }
94
95 // Gets an async and a sys desc, with the sys bound to async.  Also sets
96 // current_async_desc.  This is meant as an easy wrapper when there is only one
97 // syscall for an async call.
98 int get_all_desc(async_desc_t** a_desc, syscall_desc_t** s_desc)
99 {
100         assert(a_desc && s_desc);
101         if ((current_async_desc = get_async_desc()) == NULL){
102                 errno = EBUSY;
103                 return -1;
104         }
105         *a_desc = current_async_desc;
106         if ((*s_desc = get_sys_desc(current_async_desc)))
107                 return 0;
108         // in case we could get an async, but not a syscall desc, then clean up.
109         POOL_PUT(&async_desc_pool, current_async_desc);
110         current_async_desc = NULL;
111         errno = EBUSY;
112         return -1;
113 }
114
115 // This runs one syscall instead of a group. 
116
117 // TODO: right now there is one channel (remote), in the future, the caller
118 // may specify local which will cause it to give up the core to do the work.
119 // creation of additional remote channel also allows the caller to prioritize
120 // work, because the default policy for the kernel is to roundrobin between them.
121 int async_syscall(arsc_channel_t* chan, syscall_req_t* req, syscall_desc_t** desc_ptr2)
122 {
123         // Note that this assumes one global frontring (TODO)
124         // abort if there is no room for our request.  ring size is currently 64.
125         // we could spin til it's free, but that could deadlock if this same thread
126         // is supposed to consume the requests it is waiting on later.
127         syscall_desc_t* desc = malloc(sizeof (syscall_desc_t));
128         desc->channel = chan;
129         syscall_front_ring_t *fr = &(desc->channel->sysfr);
130         //TODO: can do it locklessly using CAS, but could change with local async calls
131         struct mcs_lock_qnode local_qn = {0};
132         mcs_lock_lock(&(chan->aclock), &local_qn);
133         if (RING_FULL(fr)) {
134                 errno = EBUSY;
135                 return -1;
136         }
137         // req_prod_pvt comes in as the previously produced item.  need to
138         // increment to the next available spot, which is the one we'll work on.
139         // at some point, we need to listen for the responses.
140         desc->idx = ++(fr->req_prod_pvt);
141         syscall_req_t* r = RING_GET_REQUEST(fr, desc->idx);
142         // CAS on the req->status perhaps
143         req->status = REQ_alloc;
144
145         memcpy(r, req, sizeof(syscall_req_t));
146         r->status = REQ_ready;
147         // push our updates to syscallfrontring.req_prod_pvt
148         // note: it is ok to push without protection since it is atomic and kernel
149         // won't process any requests until they are marked REQ_ready (also atomic)
150         RING_PUSH_REQUESTS(fr);
151         //cprintf("DEBUG: sring->req_prod: %d, sring->rsp_prod: %d\n", 
152         mcs_lock_unlock(&desc->channel->aclock, &local_qn);
153         *desc_ptr2 = desc;
154         return 0;
155 }
156 // Default convinence wrapper before other method of posting calls are available
157
158 syscall_desc_t* arc_call(long int num, ...)
159 {
160         va_list vl;
161         va_start(vl,num);
162         struct syscall *p_sysc = malloc(sizeof (struct syscall));
163         syscall_desc_t* desc;
164         if (p_sysc == NULL) {
165                 errno = ENOMEM;
166                 return 0;
167         }
168         p_sysc->num = num;
169         p_sysc->arg0 = va_arg(vl,long int);
170         p_sysc->arg1 = va_arg(vl,long int);
171         p_sysc->arg2 = va_arg(vl,long int);
172         p_sysc->arg3 = va_arg(vl,long int);
173         p_sysc->arg4 = va_arg(vl,long int);
174         p_sysc->arg5 = va_arg(vl,long int);
175         va_end(vl);
176         syscall_req_t arc = {REQ_alloc,NULL, NULL, p_sysc};
177         async_syscall(&SYS_CHANNEL, &arc, &desc);
178         printf ( "%d pushed at %p \n", desc);
179         return desc;
180 }
181
182 // consider a timeout too
183 // Wait until arsc returns, caller provides rsp buffer.
184 // eventually change this to return ret_val, set errno
185
186 // What if someone calls waiton the same desc several times?
187 int waiton_syscall(syscall_desc_t* desc)
188 {
189         int retval = 0;
190         if (desc == NULL || desc->channel == NULL){
191                 errno = EFAULT;
192                 return -1;
193         }
194         // Make sure we were given a desc with a non-NULL frontring.  This could
195         // happen if someone forgot to check the error code on the paired syscall.
196         syscall_front_ring_t *fr =  &desc->channel->sysfr;
197         
198         if (!fr){
199                 errno = EFAULT;
200                 return -1;
201         }
202         printf("waiting %d\n", vcore_id());
203         syscall_rsp_t* rsp = RING_GET_RESPONSE(fr, desc->idx);
204
205         // ignoring the ring push response from the kernel side now
206         while (atomic_read(&rsp->sc->flags) != SC_DONE)
207                 cpu_relax();
208         // memcpy(rsp, rsp_inring, sizeof(*rsp));
209         
210     // run a cleanup function for this desc, if available
211     if (rsp->cleanup)
212         rsp->cleanup(rsp->data);
213         if (RSP_ERRNO(rsp)){
214                 errno = RSP_ERRNO(rsp);
215                 retval = -1;
216         } else 
217                 retval =  RSP_RESULT(rsp); 
218         atomic_inc((atomic_t*) &(fr->rsp_cons));
219         return retval;
220 }
221
222