1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * Top level include for library side routines
13 # include <asm/page.h>
14 # include <linux/string.h>
16 # include <portals/list.h>
19 #include <portals/types.h>
20 #include <linux/kp30.h>
21 #include <portals/p30.h>
22 #include <portals/lib-types.h>
23 #include <portals/lib-nal.h>
24 #include <portals/lib-dispatch.h>
26 static inline int ptl_is_wire_handle_none (ptl_handle_wire_t *wh)
28 return (wh->wh_interface_cookie == PTL_WIRE_HANDLE_NONE.wh_interface_cookie &&
29 wh->wh_object_cookie == PTL_WIRE_HANDLE_NONE.wh_object_cookie);
32 #define state_lock(nal,flagsp) \
34 CDEBUG(D_PORTALS, "taking state lock\n"); \
35 nal->cb_cli(nal, flagsp); \
38 #define state_unlock(nal,flagsp) \
40 CDEBUG(D_PORTALS, "releasing state lock\n"); \
41 nal->cb_sti(nal, flagsp); \
44 #ifdef PTL_USE_LIB_FREELIST
48 #define MAX_MSGS 2048 /* Outstanding messages */
51 extern int lib_freelist_init (nal_cb_t *nal, lib_freelist_t *fl, int nobj, int objsize);
52 extern void lib_freelist_fini (nal_cb_t *nal, lib_freelist_t *fl);
55 lib_freelist_alloc (lib_freelist_t *fl)
57 /* ALWAYS called with statelock held */
60 if (list_empty (&fl->fl_list))
63 o = list_entry (fl->fl_list.next, lib_freeobj_t, fo_list);
64 list_del (&o->fo_list);
65 return ((void *)&o->fo_contents);
69 lib_freelist_free (lib_freelist_t *fl, void *obj)
71 /* ALWAYS called with statelock held */
72 lib_freeobj_t *o = list_entry (obj, lib_freeobj_t, fo_contents);
74 list_add (&o->fo_list, &fl->fl_list);
78 static inline lib_eq_t *
79 lib_eq_alloc (nal_cb_t *nal)
81 /* NEVER called with statelock held */
85 state_lock (nal, &flags);
86 eq = (lib_eq_t *)lib_freelist_alloc (&nal->ni.ni_free_eqs);
87 state_unlock (nal, &flags);
93 lib_eq_free (nal_cb_t *nal, lib_eq_t *eq)
95 /* ALWAYS called with statelock held */
96 lib_freelist_free (&nal->ni.ni_free_eqs, eq);
99 static inline lib_md_t *
100 lib_md_alloc (nal_cb_t *nal, ptl_md_t *umd)
102 /* NEVER called with statelock held */
106 state_lock (nal, &flags);
107 md = (lib_md_t *)lib_freelist_alloc (&nal->ni.ni_free_mds);
108 state_unlock (nal, &flags);
114 lib_md_free (nal_cb_t *nal, lib_md_t *md)
116 /* ALWAYS called with statelock held */
117 lib_freelist_free (&nal->ni.ni_free_mds, md);
120 static inline lib_me_t *
121 lib_me_alloc (nal_cb_t *nal)
123 /* NEVER called with statelock held */
127 state_lock (nal, &flags);
128 me = (lib_me_t *)lib_freelist_alloc (&nal->ni.ni_free_mes);
129 state_unlock (nal, &flags);
135 lib_me_free (nal_cb_t *nal, lib_me_t *me)
137 /* ALWAYS called with statelock held */
138 lib_freelist_free (&nal->ni.ni_free_mes, me);
141 static inline lib_msg_t *
142 lib_msg_alloc (nal_cb_t *nal)
144 /* NEVER called with statelock held */
148 state_lock (nal, &flags);
149 msg = (lib_msg_t *)lib_freelist_alloc (&nal->ni.ni_free_msgs);
150 state_unlock (nal, &flags);
153 /* NULL pointers, clear flags etc */
154 memset (msg, 0, sizeof (*msg));
155 msg->ack_wmd = PTL_WIRE_HANDLE_NONE;
161 lib_msg_free (nal_cb_t *nal, lib_msg_t *msg)
163 /* ALWAYS called with statelock held */
164 lib_freelist_free (&nal->ni.ni_free_msgs, msg);
169 static inline lib_eq_t *
170 lib_eq_alloc (nal_cb_t *nal)
172 /* NEVER called with statelock held */
175 PORTAL_ALLOC(eq, sizeof(*eq));
180 lib_eq_free (nal_cb_t *nal, lib_eq_t *eq)
182 /* ALWAYS called with statelock held */
183 PORTAL_FREE(eq, sizeof(*eq));
186 static inline lib_md_t *
187 lib_md_alloc (nal_cb_t *nal, ptl_md_t *umd)
189 /* NEVER called with statelock held */
194 if ((umd->options & PTL_MD_KIOV) != 0) {
196 size = offsetof(lib_md_t, md_iov.kiov[niov]);
198 niov = ((umd->options & PTL_MD_IOV) != 0) ?
200 size = offsetof(lib_md_t, md_iov.iov[niov]);
203 PORTAL_ALLOC(md, size);
206 /* Set here in case of early free */
207 md->options = umd->options;
215 lib_md_free (nal_cb_t *nal, lib_md_t *md)
217 /* ALWAYS called with statelock held */
220 if ((md->options & PTL_MD_KIOV) != 0)
221 size = offsetof(lib_md_t, md_iov.kiov[md->md_niov]);
223 size = offsetof(lib_md_t, md_iov.iov[md->md_niov]);
225 PORTAL_FREE(md, size);
228 static inline lib_me_t *
229 lib_me_alloc (nal_cb_t *nal)
231 /* NEVER called with statelock held */
234 PORTAL_ALLOC(me, sizeof(*me));
239 lib_me_free(nal_cb_t *nal, lib_me_t *me)
241 /* ALWAYS called with statelock held */
242 PORTAL_FREE(me, sizeof(*me));
245 static inline lib_msg_t *
246 lib_msg_alloc(nal_cb_t *nal)
248 /* NEVER called with statelock held */
251 PORTAL_ALLOC(msg, sizeof(*msg));
253 /* NULL pointers, clear flags etc */
254 memset (msg, 0, sizeof (*msg));
255 msg->ack_wmd = PTL_WIRE_HANDLE_NONE;
261 lib_msg_free(nal_cb_t *nal, lib_msg_t *msg)
263 /* ALWAYS called with statelock held */
264 PORTAL_FREE(msg, sizeof(*msg));
268 extern lib_handle_t *lib_lookup_cookie (nal_cb_t *nal, __u64 cookie, int type);
269 extern void lib_initialise_handle (nal_cb_t *nal, lib_handle_t *lh, int type);
270 extern void lib_invalidate_handle (nal_cb_t *nal, lib_handle_t *lh);
273 ptl_eq2handle (ptl_handle_eq_t *handle, lib_eq_t *eq)
275 handle->cookie = eq->eq_lh.lh_cookie;
278 static inline lib_eq_t *
279 ptl_handle2eq (ptl_handle_eq_t *handle, nal_cb_t *nal)
281 /* ALWAYS called with statelock held */
282 lib_handle_t *lh = lib_lookup_cookie (nal, handle->cookie,
287 return (lh_entry (lh, lib_eq_t, eq_lh));
291 ptl_md2handle (ptl_handle_md_t *handle, lib_md_t *md)
293 handle->cookie = md->md_lh.lh_cookie;
296 static inline lib_md_t *
297 ptl_handle2md (ptl_handle_md_t *handle, nal_cb_t *nal)
299 /* ALWAYS called with statelock held */
300 lib_handle_t *lh = lib_lookup_cookie (nal, handle->cookie,
305 return (lh_entry (lh, lib_md_t, md_lh));
308 static inline lib_md_t *
309 ptl_wire_handle2md (ptl_handle_wire_t *wh, nal_cb_t *nal)
311 /* ALWAYS called with statelock held */
314 if (wh->wh_interface_cookie != nal->ni.ni_interface_cookie)
317 lh = lib_lookup_cookie (nal, wh->wh_object_cookie,
322 return (lh_entry (lh, lib_md_t, md_lh));
326 ptl_me2handle (ptl_handle_me_t *handle, lib_me_t *me)
328 handle->cookie = me->me_lh.lh_cookie;
331 static inline lib_me_t *
332 ptl_handle2me (ptl_handle_me_t *handle, nal_cb_t *nal)
334 /* ALWAYS called with statelock held */
335 lib_handle_t *lh = lib_lookup_cookie (nal, handle->cookie,
340 return (lh_entry (lh, lib_me_t, me_lh));
343 extern int lib_init(nal_cb_t * cb, ptl_nid_t nid, ptl_pid_t pid, int gsize,
344 ptl_pt_index_t tbl_size, ptl_ac_index_t ac_size);
345 extern int lib_fini(nal_cb_t * cb);
346 extern void lib_dispatch(nal_cb_t * cb, void *private, int index,
347 void *arg_block, void *ret_block);
348 extern char *dispatch_name(int index);
351 * When the NAL detects an incoming message, it should call
352 * lib_parse() decode it. The NAL callbacks will be handed
353 * the private cookie as a way for the NAL to maintain state
354 * about which transaction is being processed. An extra parameter,
355 * lib_cookie will contain the necessary information for
356 * finalizing the message.
358 * After it has finished the handling the message, it should
359 * call lib_finalize() with the lib_cookie parameter.
360 * Call backs will be made to write events, send acks or
363 extern void lib_enq_event_locked (nal_cb_t *nal, void *private,
364 lib_eq_t *eq, ptl_event_t *ev);
365 extern void lib_finalize (nal_cb_t *nal, void *private, lib_msg_t *msg,
367 extern void lib_parse (nal_cb_t *nal, ptl_hdr_t *hdr, void *private);
368 extern lib_msg_t *lib_fake_reply_msg (nal_cb_t *nal, ptl_nid_t peer_nid,
370 extern void print_hdr (nal_cb_t * nal, ptl_hdr_t * hdr);
373 extern ptl_size_t lib_iov_nob (int niov, struct iovec *iov);
374 extern void lib_copy_iov2buf (char *dest, int niov, struct iovec *iov,
375 ptl_size_t offset, ptl_size_t len);
376 extern void lib_copy_buf2iov (int niov, struct iovec *iov, ptl_size_t offset,
377 char *src, ptl_size_t len);
378 extern int lib_extract_iov (int dst_niov, struct iovec *dst,
379 int src_niov, struct iovec *src,
380 ptl_size_t offset, ptl_size_t len);
382 extern ptl_size_t lib_kiov_nob (int niov, ptl_kiov_t *iov);
383 extern void lib_copy_kiov2buf (char *dest, int niov, ptl_kiov_t *kiov,
384 ptl_size_t offset, ptl_size_t len);
385 extern void lib_copy_buf2kiov (int niov, ptl_kiov_t *kiov, ptl_size_t offset,
386 char *src, ptl_size_t len);
387 extern int lib_extract_kiov (int dst_niov, ptl_kiov_t *dst,
388 int src_niov, ptl_kiov_t *src,
389 ptl_size_t offset, ptl_size_t len);
391 extern void lib_assert_wire_constants (void);
393 extern ptl_err_t lib_recv (nal_cb_t *nal, void *private, lib_msg_t *msg, lib_md_t *md,
394 ptl_size_t offset, ptl_size_t mlen, ptl_size_t rlen);
395 extern ptl_err_t lib_send (nal_cb_t *nal, void *private, lib_msg_t *msg,
396 ptl_hdr_t *hdr, int type, ptl_nid_t nid, ptl_pid_t pid,
397 lib_md_t *md, ptl_size_t offset, ptl_size_t len);
399 extern void lib_md_deconstruct(nal_cb_t * nal, lib_md_t * md_in,
401 extern void lib_md_unlink(nal_cb_t * nal, lib_md_t * md_in);
402 extern void lib_me_unlink(nal_cb_t * nal, lib_me_t * me_in);