lustre/include/linux/lustre_lib.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  *  Copyright (C) 2001 Cluster File Systems, Inc. <braam@clusterfs.com>
   5  *
   6  *   This file is part of Lustre, http://www.lustre.org.
   7  *
   8  *   Lustre is free software; you can redistribute it and/or
   9  *   modify it under the terms of version 2 of the GNU General Public
  10  *   License as published by the Free Software Foundation.
  11  *
  12  *   Lustre is distributed in the hope that it will be useful,
  13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *   GNU General Public License for more details.
  16  *
  17  *   You should have received a copy of the GNU General Public License
  18  *   along with Lustre; if not, write to the Free Software
  19  *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20  *
  21  * Basic Lustre library routines.
  22  *
  23  */
  24
  25 #ifndef _LUSTRE_LIB_H
  26 #define _LUSTRE_LIB_H
  27
  28 #ifndef __KERNEL__
  29 # include <string.h>
  30 #else
  31 # include <asm/semaphore.h>
  32 #include <linux/kp30.h> /* XXX just for LASSERT! */
  33 #endif
  34 #include <linux/portals_lib.h>
  35 #include <linux/lustre_idl.h>
  36
  37 #ifdef __KERNEL__
  38 /* l_net.c */
  39 struct ptlrpc_request;
  40 struct obd_device;
  41 struct recovd_data;
  42
  43 int target_handle_connect(struct ptlrpc_request *req);
  44 int target_handle_disconnect(struct ptlrpc_request *req);
  45 int client_obd_connect(struct lustre_handle *conn, struct obd_device *obd,
  46                        char *cluuid);
  47 int client_obd_disconnect(struct lustre_handle *conn);
  48 int client_obd_setup(struct obd_device *obddev, obd_count len, void *buf);
  49 int client_obd_cleanup(struct obd_device * obddev);
  50 struct client_obd *client_conn2cli(struct lustre_handle *conn);
  51
  52 int target_revoke_connection(struct recovd_data *rd, int phase);
  53
  54 /* l_lock.c */
  55 struct lustre_lock {
  56         int l_depth;
  57         struct task_struct *l_owner;
  58         struct semaphore l_sem;
  59         spinlock_t l_spin;
  60 };
  61
  62 void l_lock_init(struct lustre_lock *);
  63 void l_lock(struct lustre_lock *);
  64 void l_unlock(struct lustre_lock *);
  65
  66
  67 /* page.c */
  68 #define CB_PHASE_START   12
  69 #define CB_PHASE_FINISH  13
  70
  71 /*
  72  * io_cb_data: io callback data merged into one struct to simplify
  73  *   memory managment. This may be turn out to be too simple.
  74  */
  75 struct io_cb_data;
  76 typedef int (*brw_callback_t)(struct io_cb_data *, int err, int phase);
  77
  78 struct io_cb_data {
  79         wait_queue_head_t waitq;
  80         atomic_t refcount;
  81         int complete;
  82         int err;
  83         struct ptlrpc_bulk_desc *desc;
  84         brw_callback_t    cb;
  85 };
  86
  87 int ll_sync_io_cb(struct io_cb_data *data, int err, int phase);
  88 struct  io_cb_data *ll_init_cb(void);
  89 inline void lustre_put_page(struct page *page);
  90 struct page *lustre_get_page_read(struct inode *dir, unsigned long index);
  91 struct page *lustre_get_page_write(struct inode *dir, unsigned long index);
  92 int lustre_commit_write(struct page *page, unsigned from, unsigned to);
  93 void set_page_clean(struct page *page);
  94 void set_page_dirty(struct page *page);
  95
  96 /* simple.c */
  97 struct obd_run_ctxt;
  98 void push_ctxt(struct obd_run_ctxt *save, struct obd_run_ctxt *new);
  99 void pop_ctxt(struct obd_run_ctxt *saved);
 100 struct dentry *simple_mkdir(struct dentry *dir, char *name, int mode);
 101 int lustre_fread(struct file *file, char *str, int len, loff_t *off);
 102 int lustre_fwrite(struct file *file, const char *str, int len, loff_t *off);
 103 int lustre_fsync(struct file *file);
 104
 105 static inline void l_dput(struct dentry *de)
 106 {
 107         if (!de || IS_ERR(de))
 108                 return;
 109         shrink_dcache_parent(de);
 110         LASSERT(atomic_read(&de->d_count) > 0);
 111         dput(de);
 112 }
 113
 114 static inline void ll_sleep(int t)
 115 {
 116         set_current_state(TASK_INTERRUPTIBLE);
 117         schedule_timeout(t * HZ);
 118         set_current_state(TASK_RUNNING);
 119 }
 120 #endif
 121
 122 /* FIXME: This needs to validate pointers and cookies */
 123 static inline void *lustre_handle2object(struct lustre_handle *handle)
 124 {
 125         if (handle)
 126                 return (void *)(unsigned long)(handle->addr);
 127         return NULL;
 128 }
 129
 130 static inline void ldlm_object2handle(void *object, struct lustre_handle *handle)
 131 {
 132         handle->addr = (__u64)(unsigned long)object;
 133 }
 134
 135 struct obd_statfs;
 136 struct statfs;
 137 void obd_statfs_pack(struct obd_statfs *osfs, struct statfs *sfs);
 138 void obd_statfs_unpack(struct obd_statfs *osfs, struct statfs *sfs);
 139
 140 #include <linux/portals_lib.h>
 141
 142 /*
 143  *   OBD IOCTLS
 144  */
 145 #define OBD_IOCTL_VERSION 0x00010001
 146
 147 struct obd_ioctl_data {
 148         uint32_t ioc_len;
 149         uint32_t ioc_version;
 150
 151         uint64_t ioc_addr;
 152         uint64_t ioc_cookie;
 153         uint32_t ioc_conn1;
 154         uint32_t ioc_conn2;
 155
 156         struct obdo ioc_obdo1;
 157         struct obdo ioc_obdo2;
 158
 159         obd_size         ioc_count;
 160         obd_off          ioc_offset;
 161         uint32_t         ioc_dev;
 162         uint32_t         ____padding;
 163
 164         /* buffers the kernel will treat as user pointers */
 165         uint32_t ioc_plen1;
 166         char    *ioc_pbuf1;
 167         uint32_t ioc_plen2;
 168         char    *ioc_pbuf2;
 169
 170         /* two inline buffers */
 171         uint32_t ioc_inllen1;
 172         char    *ioc_inlbuf1;
 173         uint32_t ioc_inllen2;
 174         char    *ioc_inlbuf2;
 175         uint32_t ioc_inllen3;
 176         char    *ioc_inlbuf3;
 177
 178         char    ioc_bulk[0];
 179 };
 180
 181 struct obd_ioctl_hdr {
 182         uint32_t ioc_len;
 183         uint32_t ioc_version;
 184 };
 185
 186 static inline int obd_ioctl_packlen(struct obd_ioctl_data *data)
 187 {
 188         int len = size_round(sizeof(struct obd_ioctl_data));
 189         len += size_round(data->ioc_inllen1);
 190         len += size_round(data->ioc_inllen2);
 191         len += size_round(data->ioc_inllen3);
 192         return len;
 193 }
 194
 195
 196 static inline int obd_ioctl_is_invalid(struct obd_ioctl_data *data)
 197 {
 198         if (data->ioc_len > (1<<30)) {
 199                 printk("OBD ioctl: ioc_len larger than 1<<30\n");
 200                 return 1;
 201         }
 202         if (data->ioc_inllen1 > (1<<30)) {
 203                 printk("OBD ioctl: ioc_inllen1 larger than 1<<30\n");
 204                 return 1;
 205         }
 206         if (data->ioc_inllen2 > (1<<30)) {
 207                 printk("OBD ioctl: ioc_inllen2 larger than 1<<30\n");
 208                 return 1;
 209         }
 210
 211         if (data->ioc_inllen3 > (1<<30)) {
 212                 printk("OBD ioctl: ioc_inllen3 larger than 1<<30\n");
 213                 return 1;
 214         }
 215         if (data->ioc_inlbuf1 && !data->ioc_inllen1) {
 216                 printk("OBD ioctl: inlbuf1 pointer but 0 length\n");
 217                 return 1;
 218         }
 219         if (data->ioc_inlbuf2 && !data->ioc_inllen2) {
 220                 printk("OBD ioctl: inlbuf2 pointer but 0 length\n");
 221                 return 1;
 222         }
 223         if (data->ioc_inlbuf3 && !data->ioc_inllen3) {
 224                 printk("OBD ioctl: inlbuf3 pointer but 0 length\n");
 225                 return 1;
 226         }
 227         if (data->ioc_pbuf1 && !data->ioc_plen1) {
 228                 printk("OBD ioctl: pbuf1 pointer but 0 length\n");
 229                 return 1;
 230         }
 231         if (data->ioc_pbuf2 && !data->ioc_plen2) {
 232                 printk("OBD ioctl: pbuf2 pointer but 0 length\n");
 233                 return 1;
 234         }
 235         /*
 236         if (data->ioc_inllen1 && !data->ioc_inlbuf1) {
 237                 printk("OBD ioctl: inllen1 set but NULL pointer\n");
 238                 return 1;
 239         }
 240         if (data->ioc_inllen2 && !data->ioc_inlbuf2) {
 241                 printk("OBD ioctl: inllen2 set but NULL pointer\n");
 242                 return 1;
 243         }
 244         if (data->ioc_inllen3 && !data->ioc_inlbuf3) {
 245                 printk("OBD ioctl: inllen3 set but NULL pointer\n");
 246                 return 1;
 247         }
 248         */
 249         if (data->ioc_plen1 && !data->ioc_pbuf1) {
 250                 printk("OBD ioctl: plen1 set but NULL pointer\n");
 251                 return 1;
 252         }
 253         if (data->ioc_plen2 && !data->ioc_pbuf2) {
 254                 printk("OBD ioctl: plen2 set but NULL pointer\n");
 255                 return 1;
 256         }
 257         if (obd_ioctl_packlen(data) != data->ioc_len ) {
 258                 printk("OBD ioctl: packlen exceeds ioc_len\n");
 259                 return 1;
 260         }
 261 #if 0
 262         if (data->ioc_inllen1 &&
 263             data->ioc_bulk[data->ioc_inllen1 - 1] != '\0') {
 264                 printk("OBD ioctl: inlbuf1 not 0 terminated\n");
 265                 return 1;
 266         }
 267         if (data->ioc_inllen2 &&
 268             data->ioc_bulk[size_round(data->ioc_inllen1) + data->ioc_inllen2 - 1] != '\0') {
 269                 printk("OBD ioctl: inlbuf2 not 0 terminated\n");
 270                 return 1;
 271         }
 272         if (data->ioc_inllen3 &&
 273             data->ioc_bulk[size_round(data->ioc_inllen1) + size_round(data->ioc_inllen2)
 274                            + data->ioc_inllen3 - 1] != '\0') {
 275                 printk("OBD ioctl: inlbuf3 not 0 terminated\n");
 276                 return 1;
 277         }
 278 #endif
 279         return 0;
 280 }
 281
 282 #ifndef __KERNEL__
 283 static inline int obd_ioctl_pack(struct obd_ioctl_data *data, char **pbuf,
 284                                  int max)
 285 {
 286         char *ptr;
 287         struct obd_ioctl_data *overlay;
 288         data->ioc_len = obd_ioctl_packlen(data);
 289         data->ioc_version = OBD_IOCTL_VERSION;
 290
 291         if (*pbuf && obd_ioctl_packlen(data) > max)
 292                 return 1;
 293         if (*pbuf == NULL) {
 294                 *pbuf = malloc(data->ioc_len);
 295         }
 296         if (!*pbuf)
 297                 return 1;
 298         overlay = (struct obd_ioctl_data *)*pbuf;
 299         memcpy(*pbuf, data, sizeof(*data));
 300
 301         ptr = overlay->ioc_bulk;
 302         if (data->ioc_inlbuf1)
 303                 LOGL(data->ioc_inlbuf1, data->ioc_inllen1, ptr);
 304         if (data->ioc_inlbuf2)
 305                 LOGL(data->ioc_inlbuf2, data->ioc_inllen2, ptr);
 306         if (data->ioc_inlbuf3)
 307                 LOGL(data->ioc_inlbuf3, data->ioc_inllen3, ptr);
 308         if (obd_ioctl_is_invalid(overlay))
 309                 return 1;
 310
 311         return 0;
 312 }
 313
 314 #else
 315
 316 #include <linux/obd_support.h>
 317
 318 /* buffer MUST be at least the size of obd_ioctl_hdr */
 319 static inline int obd_ioctl_getdata(char **buf, int *len, void *arg)
 320 {
 321         struct obd_ioctl_hdr hdr;
 322         struct obd_ioctl_data *data;
 323         int err;
 324         ENTRY;
 325
 326
 327         err = copy_from_user(&hdr, (void *)arg, sizeof(hdr));
 328         if ( err ) {
 329                 EXIT;
 330                 return err;
 331         }
 332
 333         if (hdr.ioc_version != OBD_IOCTL_VERSION) {
 334                 printk("OBD: version mismatch kernel vs application\n");
 335                 return -EINVAL;
 336         }
 337
 338         if (hdr.ioc_len > 8192) {
 339                 printk("OBD: user buffer exceeds 8192 max buffer\n");
 340                 return -EINVAL;
 341         }
 342
 343         if (hdr.ioc_len < sizeof(struct obd_ioctl_data)) {
 344                 printk("OBD: user buffer too small for ioctl\n");
 345                 return -EINVAL;
 346         }
 347
 348         OBD_ALLOC(*buf, hdr.ioc_len);
 349         if (!*buf) {
 350                 CERROR("Cannot allocate control buffer of len %d\n",
 351                        hdr.ioc_len);
 352                 RETURN(-EINVAL);
 353         }
 354         *len = hdr.ioc_len;
 355         data = (struct obd_ioctl_data *)*buf;
 356
 357         err = copy_from_user(*buf, (void *)arg, hdr.ioc_len);
 358         if ( err ) {
 359                 EXIT;
 360                 return err;
 361         }
 362
 363         if (obd_ioctl_is_invalid(data)) {
 364                 printk("OBD: ioctl not correctly formatted\n");
 365                 return -EINVAL;
 366         }
 367
 368         if (data->ioc_inllen1) {
 369                 data->ioc_inlbuf1 = &data->ioc_bulk[0];
 370         }
 371
 372         if (data->ioc_inllen2) {
 373                 data->ioc_inlbuf2 = &data->ioc_bulk[0] + size_round(data->ioc_inllen1);
 374         }
 375
 376         if (data->ioc_inllen3) {
 377                 data->ioc_inlbuf3 = &data->ioc_bulk[0] + size_round(data->ioc_inllen1) +
 378                         size_round(data->ioc_inllen2);
 379         }
 380
 381         EXIT;
 382         return 0;
 383 }
 384 #endif
 385
 386 #define OBD_IOC_CREATE                 _IOR ('f', 101, long)
 387 #define OBD_IOC_SETUP                  _IOW ('f', 102, long)
 388 #define OBD_IOC_CLEANUP                _IO  ('f', 103      )
 389 #define OBD_IOC_DESTROY                _IOW ('f', 104, long)
 390 #define OBD_IOC_PREALLOCATE            _IOWR('f', 105, long)
 391 #define OBD_IOC_DEC_USE_COUNT          _IO  ('f', 106      )
 392 #define OBD_IOC_SETATTR                _IOW ('f', 107, long)
 393 #define OBD_IOC_GETATTR                _IOR ('f', 108, long)
 394 #define OBD_IOC_READ                   _IOWR('f', 109, long)
 395 #define OBD_IOC_WRITE                  _IOWR('f', 110, long)
 396 #define OBD_IOC_CONNECT                _IOR ('f', 111, long)
 397 #define OBD_IOC_DISCONNECT             _IOW ('f', 112, long)
 398 #define OBD_IOC_STATFS                 _IOWR('f', 113, long)
 399 #define OBD_IOC_SYNC                   _IOR ('f', 114, long)
 400 #define OBD_IOC_READ2                  _IOWR('f', 115, long)
 401 #define OBD_IOC_FORMAT                 _IOWR('f', 116, long)
 402 #define OBD_IOC_PARTITION              _IOWR('f', 117, long)
 403 #define OBD_IOC_ATTACH                 _IOWR('f', 118, long)
 404 #define OBD_IOC_DETACH                 _IOWR('f', 119, long)
 405 #define OBD_IOC_COPY                   _IOWR('f', 120, long)
 406 #define OBD_IOC_MIGR                   _IOWR('f', 121, long)
 407 #define OBD_IOC_PUNCH                  _IOWR('f', 122, long)
 408 #define OBD_IOC_DEVICE                 _IOWR('f', 123, long)
 409 #define OBD_IOC_MODULE_DEBUG           _IOWR('f', 124, long)
 410 #define OBD_IOC_BRW_READ               _IOWR('f', 125, long)
 411 #define OBD_IOC_BRW_WRITE              _IOWR('f', 126, long)
 412 #define OBD_IOC_NAME2DEV               _IOWR('f', 127, long)
 413 #define OBD_IOC_NEWDEV                 _IOWR('f', 128, long)
 414 #define OBD_IOC_LIST                   _IOWR('f', 129, long)
 415 #define OBD_IOC_UUID2DEV               _IOWR('f', 130, long)
 416
 417 #define OBD_IOC_RECOVD_NEWCONN         _IOWR('f', 131, long)
 418 #define OBD_IOC_LOV_CONFIG             _IOWR('f', 132, long)
 419
 420 #define OBD_IOC_DEC_FS_USE_COUNT       _IO  ('f', 133      )
 421
 422 /*
 423  * l_wait_event is a flexible sleeping function, permitting simple caller
 424  * configuration of interrupt and timeout sensitivity along with actions to
 425  * be performed in the event of either exception.
 426  *
 427  * Common usage looks like this:
 428  *
 429  * struct l_wait_info lwi = LWI_TIMEOUT_INTR(timeout, timeout_handler,
 430  *                                           intr_handler, callback_data);
 431  * rc = l_wait_event(waitq, condition, &lwi);
 432  *
 433  * (LWI_TIMEOUT and LWI_INTR macros are available for timeout- and
 434  * interrupt-only variants, respectively.)
 435  *
 436  * If a timeout is specified, the timeout_handler will be invoked in the event
 437  * that the timeout expires before the process is awakened.  (Note that any
 438  * waking of the process will restart the timeout, even if the condition is
 439  * not satisfied and the process immediately returns to sleep.  This might be
 440  * considered a bug.)  If the timeout_handler returns non-zero, l_wait_event
 441  * will return -ETIMEDOUT and the caller will continue.  If the handler returns
 442  * zero instead, the process will go back to sleep until it is awakened by the
 443  * waitq or some similar mechanism, or an interrupt occurs (if the caller has
 444  * asked for interrupts to be detected).  The timeout will only fire once, so
 445  * callers should take care that a timeout_handler which returns zero will take
 446  * future steps to awaken the process.  N.B. that these steps must include making
 447  * the provided condition become true.
 448  *
 449  * If the interrupt flag (lwi_signals) is non-zero, then the process will be
 450  * interruptible, and will be awakened by any "killable" signal (SIGTERM,
 451  * SIGKILL or SIGINT).  If a timeout is also specified, then the process will
 452  * only become interruptible _after_ the timeout has expired, though it can be
 453  * awakened by a signal that was delivered before the timeout and is still
 454  * pending when the timeout expires.  If a timeout is not specified, the process
 455  * will be interruptible at all times during l_wait_event.
 456  */
 457
 458 struct l_wait_info {
 459         long   lwi_timeout;
 460         int  (*lwi_on_timeout)(void *);
 461         long   lwi_signals;
 462         int  (*lwi_on_signal)(void *); /* XXX return is ignored for now */
 463         void  *lwi_cb_data;
 464 };
 465
 466 #define LWI_TIMEOUT(time, cb, data)                                             \
 467 ((struct l_wait_info) {                                                         \
 468         lwi_timeout:    time,                                                   \
 469         lwi_on_timeout: cb,                                                     \
 470         lwi_cb_data:    data                                                    \
 471 })
 472
 473 #define LWI_INTR(cb, data)                                                      \
 474 ((struct l_wait_info) {                                                         \
 475         lwi_signals:   1,                                                       \
 476         lwi_on_signal: cb,                                                      \
 477         lwi_cb_data:   data                                                     \
 478 })
 479
 480 #define LWI_TIMEOUT_INTR(time, time_cb, sig_cb, data)                           \
 481 ((struct l_wait_info) {                                                         \
 482         lwi_timeout:    time,                                                   \
 483         lwi_on_timeout: time_cb,                                                \
 484         lwi_signals:    1,                                                      \
 485         lwi_on_signal:  sig_cb,                                                 \
 486         lwi_cb_data:    data                                                    \
 487 })
 488
 489 /* XXX this should be one mask-check */
 490 #define l_killable_pending(task)                                                \
 491 (sigismember(&(task->pending.signal), SIGKILL) ||                               \
 492  sigismember(&(task->pending.signal), SIGINT) ||                                \
 493  sigismember(&(task->pending.signal), SIGTERM))
 494
 495 #define __l_wait_event(wq, condition, info, ret)                                \
 496 do {                                                                            \
 497         wait_queue_t __wait;                                                    \
 498         long __state;                                                           \
 499         int __timed_out = 0;                                                    \
 500         init_waitqueue_entry(&__wait, current);                                 \
 501                                                                                 \
 502         add_wait_queue(&wq, &__wait);                                           \
 503         if (info->lwi_signals && !info->lwi_timeout)                            \
 504             __state = TASK_INTERRUPTIBLE;                                       \
 505         else                                                                    \
 506             __state = TASK_UNINTERRUPTIBLE;                                     \
 507         for (;;) {                                                              \
 508             set_current_state(__state);                                         \
 509             if (condition)                                                      \
 510                     break;                                                      \
 511             if (__state == TASK_INTERRUPTIBLE && l_killable_pending(current)) { \
 512                 CERROR("lwe: interrupt\n");                                     \
 513                 if (info->lwi_on_signal)                                        \
 514                         info->lwi_on_signal(info->lwi_cb_data);                 \
 515                 ret = -EINTR;                                                   \
 516                 break;                                                          \
 517             }                                                                   \
 518             if (info->lwi_timeout && !__timed_out) {                            \
 519                 if (schedule_timeout(info->lwi_timeout) == 0) {                 \
 520                     CERROR("lwe: timeout\n");                                   \
 521                     __timed_out = 1;                                            \
 522                     if (!info->lwi_on_timeout ||                                \
 523                         info->lwi_on_timeout(info->lwi_cb_data)) {              \
 524                         ret = -ETIMEDOUT;                                       \
 525                         break;                                                  \
 526                     }                                                           \
 527                     /* We'll take signals after a timeout. */                   \
 528                     if (info->lwi_signals) {                                    \
 529                         __state = TASK_INTERRUPTIBLE;                           \
 530                         /* Check for a pending interrupt. */                    \
 531                         if (info->lwi_signals && l_killable_pending(current)) { \
 532                             CERROR("lwe: pending interrupt\n");                 \
 533                             if (info->lwi_on_signal)                            \
 534                                 info->lwi_on_signal(info->lwi_cb_data);         \
 535                             ret = -EINTR;                                       \
 536                             break;                                              \
 537                         }                                                       \
 538                     }                                                           \
 539                 }                                                               \
 540             } else {                                                            \
 541                 schedule();                                                     \
 542             }                                                                   \
 543         }                                                                       \
 544         current->state = TASK_RUNNING;                                          \
 545         remove_wait_queue(&wq, &__wait);                                        \
 546 } while(0)
 547
 548 #define l_wait_event(wq, condition, info)                                       \
 549 ({                                                                              \
 550         int __ret = 0;                                                          \
 551         struct l_wait_info *__info = (info);                                    \
 552         if (!(condition))                                                       \
 553                 __l_wait_event(wq, condition, __info, __ret);                   \
 554         __ret;                                                                  \
 555 })
 556
 557 #endif /* _LUSTRE_LIB_H */