lnet/include/lnet/lib-p30.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 #include "build_check.h"
  13
  14 #ifdef __KERNEL__
  15 # include <asm/page.h>
  16 # include <linux/string.h>
  17 #else
  18 # include <portals/list.h>
  19 # include <string.h>
  20 #endif
  21 #include <portals/types.h>
  22 #include <linux/kp30.h>
  23 #include <portals/p30.h>
  24 #include <portals/lib-types.h>
  25 #include <portals/lib-nal.h>
  26 #include <portals/lib-dispatch.h>
  27
  28 static inline int ptl_is_wire_handle_none (ptl_handle_wire_t *wh)
  29 {
  30         return (wh->wh_interface_cookie == PTL_WIRE_HANDLE_NONE.wh_interface_cookie &&
  31                 wh->wh_object_cookie == PTL_WIRE_HANDLE_NONE.wh_object_cookie);
  32 }
  33
  34 #define state_lock(nal,flagsp)                          \
  35 do {                                                    \
  36         CDEBUG(D_PORTALS, "taking state lock\n");       \
  37         nal->cb_cli(nal, flagsp);                       \
  38 } while (0)
  39
  40 #define state_unlock(nal,flagsp)                        \
  41 {                                                       \
  42         CDEBUG(D_PORTALS, "releasing state lock\n");    \
  43         nal->cb_sti(nal, flagsp);                       \
  44 }
  45
  46 #ifdef PTL_USE_LIB_FREELIST
  47
  48 #define MAX_MES         2048
  49 #define MAX_MDS         2048
  50 #define MAX_MSGS        2048    /* Outstanding messages */
  51 #define MAX_EQS         512
  52
  53 extern int lib_freelist_init (nal_cb_t *nal, lib_freelist_t *fl, int nobj, int objsize);
  54 extern void lib_freelist_fini (nal_cb_t *nal, lib_freelist_t *fl);
  55
  56 static inline void *
  57 lib_freelist_alloc (lib_freelist_t *fl)
  58 {
  59         /* ALWAYS called with statelock held */
  60         lib_freeobj_t *o;
  61
  62         if (list_empty (&fl->fl_list))
  63                 return (NULL);
  64
  65         o = list_entry (fl->fl_list.next, lib_freeobj_t, fo_list);
  66         list_del (&o->fo_list);
  67         return ((void *)&o->fo_contents);
  68 }
  69
  70 static inline void
  71 lib_freelist_free (lib_freelist_t *fl, void *obj)
  72 {
  73         /* ALWAYS called with statelock held */
  74         lib_freeobj_t *o = list_entry (obj, lib_freeobj_t, fo_contents);
  75
  76         list_add (&o->fo_list, &fl->fl_list);
  77 }
  78
  79
  80 static inline lib_eq_t *
  81 lib_eq_alloc (nal_cb_t *nal)
  82 {
  83         /* NEVER called with statelock held */
  84         unsigned long  flags;
  85         lib_eq_t      *eq;
  86
  87         state_lock (nal, &flags);
  88         eq = (lib_eq_t *)lib_freelist_alloc (&nal->ni.ni_free_eqs);
  89         state_unlock (nal, &flags);
  90
  91         return (eq);
  92 }
  93
  94 static inline void
  95 lib_eq_free (nal_cb_t *nal, lib_eq_t *eq)
  96 {
  97         /* ALWAYS called with statelock held */
  98         lib_freelist_free (&nal->ni.ni_free_eqs, eq);
  99 }
 100
 101 static inline lib_md_t *
 102 lib_md_alloc (nal_cb_t *nal, ptl_md_t *umd)
 103 {
 104         /* NEVER called with statelock held */
 105         unsigned long  flags;
 106         lib_md_t      *md;
 107
 108         state_lock (nal, &flags);
 109         md = (lib_md_t *)lib_freelist_alloc (&nal->ni.ni_free_mds);
 110         state_unlock (nal, &flags);
 111
 112         return (md);
 113 }
 114
 115 static inline void
 116 lib_md_free (nal_cb_t *nal, lib_md_t *md)
 117 {
 118         /* ALWAYS called with statelock held */
 119         lib_freelist_free (&nal->ni.ni_free_mds, md);
 120 }
 121
 122 static inline lib_me_t *
 123 lib_me_alloc (nal_cb_t *nal)
 124 {
 125         /* NEVER called with statelock held */
 126         unsigned long  flags;
 127         lib_me_t      *me;
 128
 129         state_lock (nal, &flags);
 130         me = (lib_me_t *)lib_freelist_alloc (&nal->ni.ni_free_mes);
 131         state_unlock (nal, &flags);
 132
 133         return (me);
 134 }
 135
 136 static inline void
 137 lib_me_free (nal_cb_t *nal, lib_me_t *me)
 138 {
 139         /* ALWAYS called with statelock held */
 140         lib_freelist_free (&nal->ni.ni_free_mes, me);
 141 }
 142
 143 static inline lib_msg_t *
 144 lib_msg_alloc (nal_cb_t *nal)
 145 {
 146         /* NEVER called with statelock held */
 147         unsigned long  flags;
 148         lib_msg_t     *msg;
 149
 150         state_lock (nal, &flags);
 151         msg = (lib_msg_t *)lib_freelist_alloc (&nal->ni.ni_free_msgs);
 152         state_unlock (nal, &flags);
 153
 154         if (msg != NULL) {
 155                 /* NULL pointers, clear flags etc */
 156                 memset (msg, 0, sizeof (*msg));
 157                 msg->ack_wmd = PTL_WIRE_HANDLE_NONE;
 158         }
 159         return(msg);
 160 }
 161
 162 static inline void
 163 lib_msg_free (nal_cb_t *nal, lib_msg_t *msg)
 164 {
 165         /* ALWAYS called with statelock held */
 166         lib_freelist_free (&nal->ni.ni_free_msgs, msg);
 167 }
 168
 169 #else
 170
 171 static inline lib_eq_t *
 172 lib_eq_alloc (nal_cb_t *nal)
 173 {
 174         /* NEVER called with statelock held */
 175         lib_eq_t *eq;
 176
 177         PORTAL_ALLOC(eq, sizeof(*eq));
 178         return (eq);
 179 }
 180
 181 static inline void
 182 lib_eq_free (nal_cb_t *nal, lib_eq_t *eq)
 183 {
 184         /* ALWAYS called with statelock held */
 185         PORTAL_FREE(eq, sizeof(*eq));
 186 }
 187
 188 static inline lib_md_t *
 189 lib_md_alloc (nal_cb_t *nal, ptl_md_t *umd)
 190 {
 191         /* NEVER called with statelock held */
 192         lib_md_t *md;
 193         int       size;
 194         int       niov;
 195
 196         if ((umd->options & PTL_MD_KIOV) != 0) {
 197                 niov = umd->niov;
 198                 size = offsetof(lib_md_t, md_iov.kiov[niov]);
 199         } else {
 200                 niov = ((umd->options & PTL_MD_IOVEC) != 0) ?
 201                        umd->niov : 1;
 202                 size = offsetof(lib_md_t, md_iov.iov[niov]);
 203         }
 204
 205         PORTAL_ALLOC(md, size);
 206
 207         if (md != NULL) {
 208                 /* Set here in case of early free */
 209                 md->options = umd->options;
 210                 md->md_niov = niov;
 211         }
 212
 213         return (md);
 214 }
 215
 216 static inline void
 217 lib_md_free (nal_cb_t *nal, lib_md_t *md)
 218 {
 219         /* ALWAYS called with statelock held */
 220         int       size;
 221
 222         if ((md->options & PTL_MD_KIOV) != 0)
 223                 size = offsetof(lib_md_t, md_iov.kiov[md->md_niov]);
 224         else
 225                 size = offsetof(lib_md_t, md_iov.iov[md->md_niov]);
 226
 227         PORTAL_FREE(md, size);
 228 }
 229
 230 static inline lib_me_t *
 231 lib_me_alloc (nal_cb_t *nal)
 232 {
 233         /* NEVER called with statelock held */
 234         lib_me_t *me;
 235
 236         PORTAL_ALLOC(me, sizeof(*me));
 237         return (me);
 238 }
 239
 240 static inline void
 241 lib_me_free(nal_cb_t *nal, lib_me_t *me)
 242 {
 243         /* ALWAYS called with statelock held */
 244         PORTAL_FREE(me, sizeof(*me));
 245 }
 246
 247 static inline lib_msg_t *
 248 lib_msg_alloc(nal_cb_t *nal)
 249 {
 250         /* NEVER called with statelock held; may be in interrupt... */
 251         lib_msg_t *msg;
 252
 253         if (in_interrupt())
 254                 PORTAL_ALLOC_ATOMIC(msg, sizeof(*msg));
 255         else
 256                 PORTAL_ALLOC(msg, sizeof(*msg));
 257
 258         if (msg != NULL) {
 259                 /* NULL pointers, clear flags etc */
 260                 memset (msg, 0, sizeof (*msg));
 261                 msg->ack_wmd = PTL_WIRE_HANDLE_NONE;
 262         }
 263         return (msg);
 264 }
 265
 266 static inline void
 267 lib_msg_free(nal_cb_t *nal, lib_msg_t *msg)
 268 {
 269         /* ALWAYS called with statelock held */
 270         PORTAL_FREE(msg, sizeof(*msg));
 271 }
 272 #endif
 273
 274 extern lib_handle_t *lib_lookup_cookie (nal_cb_t *nal, __u64 cookie, int type);
 275 extern void lib_initialise_handle (nal_cb_t *nal, lib_handle_t *lh, int type);
 276 extern void lib_invalidate_handle (nal_cb_t *nal, lib_handle_t *lh);
 277
 278 static inline void
 279 ptl_eq2handle (ptl_handle_eq_t *handle, lib_eq_t *eq)
 280 {
 281         handle->cookie = eq->eq_lh.lh_cookie;
 282 }
 283
 284 static inline lib_eq_t *
 285 ptl_handle2eq (ptl_handle_eq_t *handle, nal_cb_t *nal)
 286 {
 287         /* ALWAYS called with statelock held */
 288         lib_handle_t *lh = lib_lookup_cookie (nal, handle->cookie,
 289                                               PTL_COOKIE_TYPE_EQ);
 290         if (lh == NULL)
 291                 return (NULL);
 292
 293         return (lh_entry (lh, lib_eq_t, eq_lh));
 294 }
 295
 296 static inline void
 297 ptl_md2handle (ptl_handle_md_t *handle, lib_md_t *md)
 298 {
 299         handle->cookie = md->md_lh.lh_cookie;
 300 }
 301
 302 static inline lib_md_t *
 303 ptl_handle2md (ptl_handle_md_t *handle, nal_cb_t *nal)
 304 {
 305         /* ALWAYS called with statelock held */
 306         lib_handle_t *lh = lib_lookup_cookie (nal, handle->cookie,
 307                                               PTL_COOKIE_TYPE_MD);
 308         if (lh == NULL)
 309                 return (NULL);
 310
 311         return (lh_entry (lh, lib_md_t, md_lh));
 312 }
 313
 314 static inline lib_md_t *
 315 ptl_wire_handle2md (ptl_handle_wire_t *wh, nal_cb_t *nal)
 316 {
 317         /* ALWAYS called with statelock held */
 318         lib_handle_t *lh;
 319
 320         if (wh->wh_interface_cookie != nal->ni.ni_interface_cookie)
 321                 return (NULL);
 322
 323         lh = lib_lookup_cookie (nal, wh->wh_object_cookie,
 324                                 PTL_COOKIE_TYPE_MD);
 325         if (lh == NULL)
 326                 return (NULL);
 327
 328         return (lh_entry (lh, lib_md_t, md_lh));
 329 }
 330
 331 static inline void
 332 ptl_me2handle (ptl_handle_me_t *handle, lib_me_t *me)
 333 {
 334         handle->cookie = me->me_lh.lh_cookie;
 335 }
 336
 337 static inline lib_me_t *
 338 ptl_handle2me (ptl_handle_me_t *handle, nal_cb_t *nal)
 339 {
 340         /* ALWAYS called with statelock held */
 341         lib_handle_t *lh = lib_lookup_cookie (nal, handle->cookie,
 342                                               PTL_COOKIE_TYPE_ME);
 343         if (lh == NULL)
 344                 return (NULL);
 345
 346         return (lh_entry (lh, lib_me_t, me_lh));
 347 }
 348
 349 extern int lib_init(nal_cb_t * cb, ptl_nid_t nid, ptl_pid_t pid, int gsize,
 350                     ptl_pt_index_t tbl_size, ptl_ac_index_t ac_size);
 351 extern int lib_fini(nal_cb_t * cb);
 352 extern void lib_dispatch(nal_cb_t * cb, void *private, int index,
 353                          void *arg_block, void *ret_block);
 354 extern char *dispatch_name(int index);
 355
 356 /*
 357  * When the NAL detects an incoming message, it should call
 358  * lib_parse() decode it.  The NAL callbacks will be handed
 359  * the private cookie as a way for the NAL to maintain state
 360  * about which transaction is being processed.  An extra parameter,
 361  * lib_cookie will contain the necessary information for
 362  * finalizing the message.
 363  *
 364  * After it has finished the handling the message, it should
 365  * call lib_finalize() with the lib_cookie parameter.
 366  * Call backs will be made to write events, send acks or
 367  * replies and so on.
 368  */
 369 extern void lib_enq_event_locked (nal_cb_t *nal, void *private,
 370                                   lib_eq_t *eq, ptl_event_t *ev);
 371 extern void lib_finalize (nal_cb_t *nal, void *private, lib_msg_t *msg,
 372                           ptl_ni_fail_t ni_fail_type);
 373 extern void lib_parse (nal_cb_t *nal, ptl_hdr_t *hdr, void *private);
 374 extern lib_msg_t *lib_create_reply_msg (nal_cb_t *nal, ptl_nid_t peer_nid,
 375                                         lib_msg_t *get_msg);
 376 extern void print_hdr (nal_cb_t * nal, ptl_hdr_t * hdr);
 377
 378
 379 extern ptl_size_t lib_iov_nob (int niov, struct iovec *iov);
 380 extern void lib_copy_iov2buf (char *dest, int niov, struct iovec *iov,
 381                               ptl_size_t offset, ptl_size_t len);
 382 extern void lib_copy_buf2iov (int niov, struct iovec *iov, ptl_size_t offset,
 383                               char *src, ptl_size_t len);
 384 extern int lib_extract_iov (int dst_niov, struct iovec *dst,
 385                             int src_niov, struct iovec *src,
 386                             ptl_size_t offset, ptl_size_t len);
 387
 388 extern ptl_size_t lib_kiov_nob (int niov, ptl_kiov_t *iov);
 389 extern void lib_copy_kiov2buf (char *dest, int niov, ptl_kiov_t *kiov,
 390                                ptl_size_t offset, ptl_size_t len);
 391 extern void lib_copy_buf2kiov (int niov, ptl_kiov_t *kiov, ptl_size_t offset,
 392                                char *src, ptl_size_t len);
 393 extern int lib_extract_kiov (int dst_niov, ptl_kiov_t *dst,
 394                              int src_niov, ptl_kiov_t *src,
 395                              ptl_size_t offset, ptl_size_t len);
 396
 397 extern void lib_assert_wire_constants (void);
 398
 399 extern ptl_err_t lib_recv (nal_cb_t *nal, void *private, lib_msg_t *msg, lib_md_t *md,
 400                            ptl_size_t offset, ptl_size_t mlen, ptl_size_t rlen);
 401 extern ptl_err_t lib_send (nal_cb_t *nal, void *private, lib_msg_t *msg,
 402                            ptl_hdr_t *hdr, int type, ptl_nid_t nid, ptl_pid_t pid,
 403                            lib_md_t *md, ptl_size_t offset, ptl_size_t len);
 404
 405 extern void lib_md_deconstruct(nal_cb_t * nal, lib_md_t * md_in,
 406                                ptl_md_t * md_out);
 407 extern void lib_md_unlink(nal_cb_t * nal, lib_md_t * md_in);
 408 extern void lib_me_unlink(nal_cb_t * nal, lib_me_t * me_in);
 409 #endif