lustre/obdclass/genops.c

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * lustre/obdclass/genops.c
   5  * Copyright (C) 2001-2002  Cluster File Systems, Inc.
   6  *
   7  * This code is issued under the GNU General Public License.
   8  * See the file COPYING in this distribution
   9  *
  10  * These are the only exported functions, they provide some generic
  11  * infrastructure for managing object devices
  12  *
  13  */
  14
  15 #define DEBUG_SUBSYSTEM S_CLASS
  16 #include <linux/kmod.h>   /* for request_module() */
  17 #include <linux/module.h>
  18 #include <linux/obd_class.h>
  19 #include <linux/random.h>
  20 #include <linux/slab.h>
  21
  22 extern struct list_head obd_types;
  23 extern struct obd_device obd_dev[MAX_OBD_DEVICES];
  24 kmem_cache_t *obdo_cachep = NULL;
  25 kmem_cache_t *export_cachep = NULL;
  26 kmem_cache_t *import_cachep = NULL;
  27
  28 /*
  29  * support functions: we could use inter-module communication, but this
  30  * is more portable to other OS's
  31  */
  32 static struct obd_type *class_search_type(char *nm)
  33 {
  34         struct list_head *tmp;
  35         struct obd_type *type;
  36         CDEBUG(D_INFO, "SEARCH %s\n", nm);
  37
  38         tmp = &obd_types;
  39         list_for_each(tmp, &obd_types) {
  40                 type = list_entry(tmp, struct obd_type, typ_chain);
  41                 CDEBUG(D_INFO, "TYP %s\n", type->typ_name);
  42                 if (strlen(type->typ_name) == strlen(nm) &&
  43                     strcmp(type->typ_name, nm) == 0 ) {
  44                         return type;
  45                 }
  46         }
  47         return NULL;
  48 }
  49
  50 struct obd_type *class_nm_to_type(char *nm)
  51 {
  52         struct obd_type *type = class_search_type(nm);
  53
  54 #ifdef CONFIG_KMOD
  55         if ( !type ) {
  56                 if ( !request_module(nm) ) {
  57                         CDEBUG(D_INFO, "Loaded module '%s'\n", nm);
  58                         type = class_search_type(nm);
  59                 } else {
  60                         CDEBUG(D_INFO, "Can't load module '%s'\n", nm);
  61                 }
  62         }
  63 #endif
  64         return type;
  65 }
  66
  67 int class_register_type(struct obd_ops *ops, char *nm)
  68 {
  69         struct obd_type *type;
  70
  71         ENTRY;
  72
  73         if (class_search_type(nm)) {
  74                 CDEBUG(D_IOCTL, "Type %s already registered\n", nm);
  75                 RETURN(-EEXIST);
  76         }
  77
  78         OBD_ALLOC(type, sizeof(*type));
  79         OBD_ALLOC(type->typ_ops, sizeof(*type->typ_ops));
  80         OBD_ALLOC(type->typ_name, strlen(nm) + 1);
  81         if (!type)
  82                 RETURN(-ENOMEM);
  83         INIT_LIST_HEAD(&type->typ_chain);
  84         MOD_INC_USE_COUNT;
  85         list_add(&type->typ_chain, &obd_types);
  86         memcpy(type->typ_ops, ops, sizeof(*type->typ_ops));
  87         strcpy(type->typ_name, nm);
  88         RETURN(0);
  89 }
  90
  91 int class_unregister_type(char *nm)
  92 {
  93         struct obd_type *type = class_nm_to_type(nm);
  94
  95         ENTRY;
  96
  97         if (!type) {
  98                 CERROR("unknown obd type\n");
  99                 RETURN(-EINVAL);
 100         }
 101
 102         if (type->typ_refcnt) {
 103                 CERROR("type %s has refcount (%d)\n", nm, type->typ_refcnt);
 104                 /* This is a bad situation, let's make the best of it */
 105                 /* Remove ops, but leave the name for debugging */
 106                 OBD_FREE(type->typ_ops, sizeof(*type->typ_ops));
 107                 RETURN(-EBUSY);
 108         }
 109
 110         list_del(&type->typ_chain);
 111         OBD_FREE(type->typ_name, strlen(nm) + 1);
 112         if (type->typ_ops != NULL)
 113                 OBD_FREE(type->typ_ops, sizeof(*type->typ_ops));
 114         OBD_FREE(type, sizeof(*type));
 115         MOD_DEC_USE_COUNT;
 116         RETURN(0);
 117 } /* class_unregister_type */
 118
 119 int class_name2dev(char *name)
 120 {
 121         int res = -1;
 122         int i;
 123
 124         if (!name)
 125                 return -1;
 126
 127         for (i=0; i < MAX_OBD_DEVICES; i++) {
 128                 struct obd_device *obd = &obd_dev[i];
 129                 if (obd->obd_name && strcmp(name, obd->obd_name) == 0) {
 130                         res = i;
 131                         return res;
 132                 }
 133         }
 134
 135         return res;
 136 }
 137
 138 int class_uuid2dev(char *name)
 139 {
 140         int res = -1;
 141         int i;
 142
 143         for (i=0; i < MAX_OBD_DEVICES; i++) {
 144                 struct obd_device *obd = &obd_dev[i];
 145                 if (obd->obd_name && strncmp(name, obd->obd_uuid, 37) == 0) {
 146                         res = i;
 147                         return res;
 148                 }
 149         }
 150
 151         return res;
 152 }
 153
 154
 155 struct obd_device *class_uuid2obd(char *name)
 156 {
 157         int i;
 158
 159         for (i=0; i < MAX_OBD_DEVICES; i++) {
 160                 struct obd_device *obd = &obd_dev[i];
 161                 if (obd->obd_name && strncmp(name, obd->obd_uuid, 37) == 0) {
 162                         return obd;
 163                 }
 164         }
 165
 166         return NULL;
 167 }
 168
 169 void obd_cleanup_caches(void)
 170 {
 171         int rc;
 172         ENTRY;
 173         if (obdo_cachep) {
 174                 rc = kmem_cache_destroy(obdo_cachep);
 175                 if (rc)
 176                         CERROR("Cannot destory obdo_cachep\n");
 177                 obdo_cachep = NULL;
 178         }
 179         if (import_cachep) {
 180                 rc = kmem_cache_destroy(import_cachep);
 181                 if (rc)
 182                         CERROR("Cannot destory import_cachep\n");
 183                 import_cachep = NULL;
 184         }
 185         if (export_cachep) {
 186                 rc = kmem_cache_destroy(export_cachep);
 187                 if (rc)
 188                         CERROR("Cannot destory import_cachep\n");
 189                 export_cachep = NULL;
 190         }
 191         EXIT;
 192 }
 193
 194 int obd_init_caches(void)
 195 {
 196         ENTRY;
 197         if (obdo_cachep == NULL) {
 198                 obdo_cachep = kmem_cache_create("obdo_cache",
 199                                                 sizeof(struct obdo),
 200                                                 0, SLAB_HWCACHE_ALIGN,
 201                                                 NULL, NULL);
 202                 if (obdo_cachep == NULL)
 203                         GOTO(out, -ENOMEM);
 204         }
 205
 206         if (export_cachep == NULL) {
 207                 export_cachep = kmem_cache_create("export_cache",
 208                                                 sizeof(struct obd_export),
 209                                                 0, SLAB_HWCACHE_ALIGN,
 210                                                 NULL, NULL);
 211                 if (export_cachep == NULL)
 212                         GOTO(out, -ENOMEM);
 213         }
 214
 215         if (import_cachep == NULL) {
 216                 import_cachep = kmem_cache_create("import_cache",
 217                                                 sizeof(struct obd_import),
 218                                                 0, SLAB_HWCACHE_ALIGN,
 219                                                 NULL, NULL);
 220                 if (import_cachep == NULL)
 221                         GOTO(out, -ENOMEM);
 222         }
 223         RETURN(0);
 224  out:
 225         obd_cleanup_caches();
 226         RETURN(-ENOMEM);
 227
 228 }
 229
 230 /* map connection to client */
 231 struct obd_export *class_conn2export(struct lustre_handle *conn)
 232 {
 233         struct obd_export *export;
 234
 235         if (!conn) {
 236                 CDEBUG(D_CACHE, "looking for null handle\n");
 237                 RETURN(NULL);
 238         }
 239
 240         if (conn->addr == -1) {  /* this means assign a new connection */
 241                 CDEBUG(D_CACHE, "want a new connection\n");
 242                 RETURN(NULL);
 243         }
 244
 245         if (!conn->addr) {
 246                 CDEBUG(D_CACHE, "looking for null addr\n");
 247                 fixme();
 248                 RETURN(NULL);
 249         }
 250
 251         CDEBUG(D_IOCTL, "looking for export addr %Lx cookie %Lx\n",
 252                conn->addr, conn->cookie);
 253         export = (struct obd_export *) (unsigned long)conn->addr;
 254         if (!kmem_cache_validate(export_cachep, (void *)export))
 255                 RETURN(NULL);
 256
 257         if (export->exp_cookie != conn->cookie)
 258                 return NULL;
 259         return export;
 260 } /* class_conn2export */
 261
 262 struct obd_device *class_conn2obd(struct lustre_handle *conn)
 263 {
 264         struct obd_export *export;
 265         export = class_conn2export(conn);
 266         if (export)
 267                 return export->exp_obd;
 268         fixme();
 269         return NULL;
 270 }
 271
 272 struct obd_export *class_new_export(struct obd_device *obddev)
 273 {
 274         struct obd_export * export;
 275
 276         export = kmem_cache_alloc(export_cachep, GFP_KERNEL);
 277         if ( !export ) {
 278                 CERROR("no memory! (minor %d)\n", obddev->obd_minor);
 279                 return NULL;
 280         }
 281
 282         memset(export, 0, sizeof(*export));
 283         get_random_bytes(&export->exp_cookie, sizeof(__u64));
 284         export->exp_obd = obddev;
 285         /* XXX should these be in MDS and LDLM init functions? */
 286         INIT_LIST_HEAD(&export->exp_mds_data.med_open_head);
 287         INIT_LIST_HEAD(&export->exp_ldlm_data.led_held_locks);
 288         spin_lock(&obddev->obd_dev_lock);
 289         list_add(&export->exp_chain, &export->exp_obd->obd_exports);
 290         spin_unlock(&obddev->obd_dev_lock);
 291         return export;
 292 }
 293
 294 void class_destroy_export(struct obd_export *exp)
 295 {
 296         int rc;
 297         ENTRY;
 298
 299         spin_lock(&exp->exp_obd->obd_dev_lock);
 300         list_del(&exp->exp_chain);
 301         spin_unlock(&exp->exp_obd->obd_dev_lock);
 302
 303         /* XXXshaver these bits want to be hung off the export, instead of
 304          * XXXshaver hard-coded here.
 305          */
 306         if (mds_destroy_export) {
 307                 rc = mds_destroy_export(exp);
 308                 if (rc)
 309                         CERROR("error freeing mds client data: rc = %d\n", rc);
 310         }
 311         if (ldlm_destroy_export) {
 312                 rc = ldlm_destroy_export(exp);
 313                 if (rc)
 314                         CERROR("error freeing dlm client data: rc = %d\n", rc);
 315         }
 316         kmem_cache_free(export_cachep, exp);
 317
 318         EXIT;
 319 }
 320
 321 /* a connection defines an export context in which preallocation can
 322    be managed. */
 323 int class_connect (struct lustre_handle *conn, struct obd_device *obd,
 324                    char *cluuid)
 325 {
 326         struct obd_export * export;
 327         if (conn == NULL) {
 328                 LBUG();
 329                 return -EINVAL;
 330         }
 331
 332         if (obd == NULL) {
 333                 LBUG();
 334                 return -EINVAL;
 335         }
 336
 337         export = class_new_export(obd);
 338         if (!export)
 339                 return -ENOMEM;
 340
 341         export->exp_rconnh.addr = conn->addr;
 342         export->exp_rconnh.cookie = conn->cookie;
 343
 344         conn->addr = (__u64) (unsigned long)export;
 345         conn->cookie = export->exp_cookie;
 346         CDEBUG(D_IOCTL, "connect: addr %Lx cookie %Lx\n",
 347                (long long)conn->addr, (long long)conn->cookie);
 348         return 0;
 349 }
 350
 351 int class_rconn2export(struct lustre_handle *conn, struct lustre_handle *rconn)
 352 {
 353         struct obd_export *export = class_conn2export(conn);
 354
 355         if (!export)
 356                 return -EINVAL;
 357
 358         export->exp_rconnh.addr = rconn->addr;
 359         export->exp_rconnh.cookie = rconn->cookie;
 360
 361         return 0;
 362 }
 363
 364 int class_disconnect(struct lustre_handle *conn)
 365 {
 366         struct obd_export *export;
 367         ENTRY;
 368
 369         if (!(export = class_conn2export(conn))) {
 370                 fixme();
 371                 CDEBUG(D_IOCTL, "disconnect: attempting to free "
 372                        "nonexistent client %Lx\n", conn->addr);
 373                 RETURN(-EINVAL);
 374         } else
 375                 CDEBUG(D_IOCTL, "disconnect: addr %Lx cookie %Lx\n",
 376                        (long long)conn->addr, (long long)conn->cookie);
 377
 378         class_destroy_export(export);
 379
 380         RETURN(0);
 381 }
 382
 383 void class_disconnect_all(struct obd_device *obddev)
 384 {
 385         struct list_head *tmp;
 386         int again = 1;
 387
 388         while (again) {
 389                 spin_lock(&obddev->obd_dev_lock);
 390                 if (!list_empty(&obddev->obd_exports)) {
 391                         struct obd_export *export;
 392                         struct lustre_handle conn;
 393                         int rc;
 394
 395                         export = list_entry(tmp, struct obd_export, exp_chain);
 396                         conn.addr = (__u64)(unsigned long)export;
 397                         conn.cookie = export->exp_cookie;
 398                         spin_unlock(&obddev->obd_dev_lock);
 399                         CERROR("force disconnecting export %p\n", export);
 400                         rc = obd_disconnect(&conn);
 401                         if (rc < 0) {
 402                                 /* AED: not so sure about this...  We can't
 403                                  * loop here forever, yet we shouldn't leak
 404                                  * exports on a struct we will soon destroy.
 405                                  */
 406                                 CERROR("destroy export %p with err: rc = %d\n",
 407                                        export, rc);
 408                                 class_destroy_export(export);
 409                         }
 410                 } else {
 411                         spin_unlock(&obddev->obd_dev_lock);
 412                         again = 0;
 413                 }
 414         }
 415 }
 416
 417 #if 0
 418
 419 /* FIXME: Data is a space- or comma-separated list of device IDs.  This will
 420  * have to change. */
 421 int class_multi_setup(struct obd_device *obddev, uint32_t len, void *data)
 422 {
 423         int count, rc;
 424         char *p;
 425         ENTRY;
 426
 427         for (p = data, count = 0; p < (char *)data + len; count++) {
 428                 char *end;
 429                 int tmp = simple_strtoul(p, &end, 0);
 430
 431                 if (p == end) {
 432                         CERROR("invalid device ID starting at: %s\n", p);
 433                         GOTO(err_disconnect, rc = -EINVAL);
 434                 }
 435
 436                 if (tmp < 0 || tmp >= MAX_OBD_DEVICES) {
 437                         CERROR("Trying to sub dev %d  - dev no too large\n",
 438                                tmp);
 439                         GOTO(err_disconnect, rc  = -EINVAL);
 440                 }
 441
 442                 rc = obd_connect(&obddev->obd_multi_conn[count], &obd_dev[tmp]);
 443                 if (rc) {
 444                         CERROR("cannot connect to device %d: rc = %d\n", tmp,
 445                                rc);
 446                         GOTO(err_disconnect, rc);
 447                 }
 448
 449                 CDEBUG(D_INFO, "target OBD %d is of type %s\n", count,
 450                        obd_dev[tmp].obd_type->typ_name);
 451
 452                 p = end + 1;
 453         }
 454
 455         obddev->obd_multi_count = count;
 456
 457         RETURN(0);
 458
 459  err_disconnect:
 460         for (count--; count >= 0; count--)
 461                 obd_disconnect(&obddev->obd_multi_conn[count]);
 462         return rc;
 463 }
 464
 465 /*
 466  *    remove all connections to this device
 467  *    close all connections to lower devices
 468  *    needed for forced unloads of OBD client drivers
 469  */
 470 int class_multi_cleanup(struct obd_device *obddev)
 471 {
 472         int i;
 473
 474         for (i = 0; i < obddev->obd_multi_count; i++) {
 475                 int rc;
 476                 struct obd_device *obd = class_conn2obd(&obddev->obd_multi_conn[i]);
 477
 478                 if (!obd) {
 479                         CERROR("no such device [i %d]\n", i);
 480                         RETURN(-EINVAL);
 481                 }
 482
 483                 rc = obd_disconnect(&obddev->obd_multi_conn[i]);
 484                 if (rc)
 485                         CERROR("disconnect failure %d\n", obd->obd_minor);
 486         }
 487         return 0;
 488 }
 489 #endif