lnet/include/lnet/lib-lnet.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * lib-p30.h
   5  *
   6  * Top level include for library side routines
   7  */
   8
   9 #ifndef _LIB_P30_H_
  10 #define _LIB_P30_H_
  11
  12 #ifdef __KERNEL__
  13 # include <asm/page.h>
  14 # include <linux/string.h>
  15 #else
  16 # include <portals/list.h>
  17 # include <string.h>
  18 #endif
  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>
  25
  26 static inline int ptl_is_wire_handle_none (ptl_handle_wire_t *wh)
  27 {
  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);
  30 }
  31
  32 #define state_lock(nal,flagsp)                          \
  33 do {                                                    \
  34         CDEBUG(D_PORTALS, "taking state lock\n");       \
  35         nal->cb_cli(nal, flagsp);                       \
  36 } while (0)
  37
  38 #define state_unlock(nal,flagsp)                        \
  39 {                                                       \
  40         CDEBUG(D_PORTALS, "releasing state lock\n");    \
  41         nal->cb_sti(nal, flagsp);                       \
  42 }
  43
  44 #ifdef PTL_USE_LIB_FREELIST
  45
  46 #define MAX_MES         2048
  47 #define MAX_MDS         2048
  48 #define MAX_MSGS        2048    /* Outstanding messages */
  49 #define MAX_EQS         512
  50
  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);
  53
  54 static inline void *
  55 lib_freelist_alloc (lib_freelist_t *fl)
  56 {
  57         /* ALWAYS called with statelock held */
  58         lib_freeobj_t *o;
  59
  60         if (list_empty (&fl->fl_list))
  61                 return (NULL);
  62
  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);
  66 }
  67
  68 static inline void
  69 lib_freelist_free (lib_freelist_t *fl, void *obj)
  70 {
  71         /* ALWAYS called with statelock held */
  72         lib_freeobj_t *o = list_entry (obj, lib_freeobj_t, fo_contents);
  73
  74         list_add (&o->fo_list, &fl->fl_list);
  75 }
  76
  77
  78 static inline lib_eq_t *
  79 lib_eq_alloc (nal_cb_t *nal)
  80 {
  81         /* NEVER called with statelock held */
  82         unsigned long  flags;
  83         lib_eq_t      *eq;
  84
  85         state_lock (nal, &flags);
  86         eq = (lib_eq_t *)lib_freelist_alloc (&nal->ni.ni_free_eqs);
  87         state_unlock (nal, &flags);
  88
  89         return (eq);
  90 }
  91
  92 static inline void
  93 lib_eq_free (nal_cb_t *nal, lib_eq_t *eq)
  94 {
  95         /* ALWAYS called with statelock held */
  96         lib_freelist_free (&nal->ni.ni_free_eqs, eq);
  97 }
  98
  99 static inline lib_md_t *
 100 lib_md_alloc (nal_cb_t *nal, ptl_md_t *umd)
 101 {
 102         /* NEVER called with statelock held */
 103         unsigned long  flags;
 104         lib_md_t      *md;
 105
 106         state_lock (nal, &flags);
 107         md = (lib_md_t *)lib_freelist_alloc (&nal->ni.ni_free_mds);
 108         state_unlock (nal, &flags);
 109
 110         return (md);
 111 }
 112
 113 static inline void
 114 lib_md_free (nal_cb_t *nal, lib_md_t *md)
 115 {
 116         /* ALWAYS called with statelock held */
 117         lib_freelist_free (&nal->ni.ni_free_mds, md);
 118 }
 119
 120 static inline lib_me_t *
 121 lib_me_alloc (nal_cb_t *nal)
 122 {
 123         /* NEVER called with statelock held */
 124         unsigned long  flags;
 125         lib_me_t      *me;
 126
 127         state_lock (nal, &flags);
 128         me = (lib_me_t *)lib_freelist_alloc (&nal->ni.ni_free_mes);
 129         state_unlock (nal, &flags);
 130
 131         return (me);
 132 }
 133
 134 static inline void
 135 lib_me_free (nal_cb_t *nal, lib_me_t *me)
 136 {
 137         /* ALWAYS called with statelock held */
 138         lib_freelist_free (&nal->ni.ni_free_mes, me);
 139 }
 140
 141 static inline lib_msg_t *
 142 lib_msg_alloc (nal_cb_t *nal)
 143 {
 144         /* NEVER called with statelock held */
 145         unsigned long  flags;
 146         lib_msg_t     *msg;
 147
 148         state_lock (nal, &flags);
 149         msg = (lib_msg_t *)lib_freelist_alloc (&nal->ni.ni_free_msgs);
 150         state_unlock (nal, &flags);
 151
 152         if (msg != NULL) {
 153                 /* NULL pointers, clear flags etc */
 154                 memset (msg, 0, sizeof (*msg));
 155                 msg->ack_wmd = PTL_WIRE_HANDLE_NONE;
 156         }
 157         return(msg);
 158 }
 159
 160 static inline void
 161 lib_msg_free (nal_cb_t *nal, lib_msg_t *msg)
 162 {
 163         /* ALWAYS called with statelock held */
 164         lib_freelist_free (&nal->ni.ni_free_msgs, msg);
 165 }
 166
 167 #else
 168
 169 static inline lib_eq_t *
 170 lib_eq_alloc (nal_cb_t *nal)
 171 {
 172         /* NEVER called with statelock held */
 173         lib_eq_t *eq;
 174
 175         PORTAL_ALLOC(eq, sizeof(*eq));
 176         return (eq);
 177 }
 178
 179 static inline void
 180 lib_eq_free (nal_cb_t *nal, lib_eq_t *eq)
 181 {
 182         /* ALWAYS called with statelock held */
 183         PORTAL_FREE(eq, sizeof(*eq));
 184 }
 185
 186 static inline lib_md_t *
 187 lib_md_alloc (nal_cb_t *nal, ptl_md_t *umd)
 188 {
 189         /* NEVER called with statelock held */
 190         lib_md_t *md;
 191         int       size;
 192         int       niov;
 193
 194         if ((umd->options & PTL_MD_KIOV) != 0) {
 195                 niov = umd->niov;
 196                 size = offsetof(lib_md_t, md_iov.kiov[niov]);
 197         } else {
 198                 niov = ((umd->options & PTL_MD_IOV) != 0) ?
 199                        umd->niov : 1;
 200                 size = offsetof(lib_md_t, md_iov.iov[niov]);
 201         }
 202
 203         PORTAL_ALLOC(md, size);
 204
 205         if (md != NULL) {
 206                 /* Set here in case of early free */
 207                 md->options = umd->options;
 208                 md->md_niov = niov;
 209         }
 210
 211         return (md);
 212 }
 213
 214 static inline void
 215 lib_md_free (nal_cb_t *nal, lib_md_t *md)
 216 {
 217         /* ALWAYS called with statelock held */
 218         int       size;
 219
 220         if ((md->options & PTL_MD_KIOV) != 0)
 221                 size = offsetof(lib_md_t, md_iov.kiov[md->md_niov]);
 222         else
 223                 size = offsetof(lib_md_t, md_iov.iov[md->md_niov]);
 224
 225         PORTAL_FREE(md, size);
 226 }
 227
 228 static inline lib_me_t *
 229 lib_me_alloc (nal_cb_t *nal)
 230 {
 231         /* NEVER called with statelock held */
 232         lib_me_t *me;
 233
 234         PORTAL_ALLOC(me, sizeof(*me));
 235         return (me);
 236 }
 237
 238 static inline void
 239 lib_me_free(nal_cb_t *nal, lib_me_t *me)
 240 {
 241         /* ALWAYS called with statelock held */
 242         PORTAL_FREE(me, sizeof(*me));
 243 }
 244
 245 static inline lib_msg_t *
 246 lib_msg_alloc(nal_cb_t *nal)
 247 {
 248         /* NEVER called with statelock held */
 249         lib_msg_t *msg;
 250
 251         PORTAL_ALLOC(msg, sizeof(*msg));
 252         if (msg != NULL) {
 253                 /* NULL pointers, clear flags etc */
 254                 memset (msg, 0, sizeof (*msg));
 255                 msg->ack_wmd = PTL_WIRE_HANDLE_NONE;
 256         }
 257         return (msg);
 258 }
 259
 260 static inline void
 261 lib_msg_free(nal_cb_t *nal, lib_msg_t *msg)
 262 {
 263         /* ALWAYS called with statelock held */
 264         PORTAL_FREE(msg, sizeof(*msg));
 265 }
 266 #endif
 267
 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);
 271
 272 static inline void
 273 ptl_eq2handle (ptl_handle_eq_t *handle, lib_eq_t *eq)
 274 {
 275         handle->cookie = eq->eq_lh.lh_cookie;
 276 }
 277
 278 static inline lib_eq_t *
 279 ptl_handle2eq (ptl_handle_eq_t *handle, nal_cb_t *nal)
 280 {
 281         /* ALWAYS called with statelock held */
 282         lib_handle_t *lh = lib_lookup_cookie (nal, handle->cookie,
 283                                               PTL_COOKIE_TYPE_EQ);
 284         if (lh == NULL)
 285                 return (NULL);
 286
 287         return (lh_entry (lh, lib_eq_t, eq_lh));
 288 }
 289
 290 static inline void
 291 ptl_md2handle (ptl_handle_md_t *handle, lib_md_t *md)
 292 {
 293         handle->cookie = md->md_lh.lh_cookie;
 294 }
 295
 296 static inline lib_md_t *
 297 ptl_handle2md (ptl_handle_md_t *handle, nal_cb_t *nal)
 298 {
 299         /* ALWAYS called with statelock held */
 300         lib_handle_t *lh = lib_lookup_cookie (nal, handle->cookie,
 301                                               PTL_COOKIE_TYPE_MD);
 302         if (lh == NULL)
 303                 return (NULL);
 304
 305         return (lh_entry (lh, lib_md_t, md_lh));
 306 }
 307
 308 static inline lib_md_t *
 309 ptl_wire_handle2md (ptl_handle_wire_t *wh, nal_cb_t *nal)
 310 {
 311         /* ALWAYS called with statelock held */
 312         lib_handle_t *lh;
 313
 314         if (wh->wh_interface_cookie != nal->ni.ni_interface_cookie)
 315                 return (NULL);
 316
 317         lh = lib_lookup_cookie (nal, wh->wh_object_cookie,
 318                                 PTL_COOKIE_TYPE_MD);
 319         if (lh == NULL)
 320                 return (NULL);
 321
 322         return (lh_entry (lh, lib_md_t, md_lh));
 323 }
 324
 325 static inline void
 326 ptl_me2handle (ptl_handle_me_t *handle, lib_me_t *me)
 327 {
 328         handle->cookie = me->me_lh.lh_cookie;
 329 }
 330
 331 static inline lib_me_t *
 332 ptl_handle2me (ptl_handle_me_t *handle, nal_cb_t *nal)
 333 {
 334         /* ALWAYS called with statelock held */
 335         lib_handle_t *lh = lib_lookup_cookie (nal, handle->cookie,
 336                                               PTL_COOKIE_TYPE_ME);
 337         if (lh == NULL)
 338                 return (NULL);
 339
 340         return (lh_entry (lh, lib_me_t, me_lh));
 341 }
 342
 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);
 349
 350 /*
 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.
 357  *
 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
 361  * replies and so on.
 362  */
 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,
 366                           ptl_err_t status);
 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,
 369                                       lib_md_t *getmd);
 370 extern void print_hdr (nal_cb_t * nal, ptl_hdr_t * hdr);
 371
 372
 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);
 381
 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);
 390
 391 extern void lib_assert_wire_constants (void);
 392
 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);
 398
 399 extern void lib_md_deconstruct(nal_cb_t * nal, lib_md_t * md_in,
 400                                ptl_md_t * md_out);
 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);
 403 #endif