1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * Copyright (c) 2001-2003 Cluster File Systems, Inc.
6 * This file is part of Lustre, http://www.lustre.org.
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.
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.
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.
21 * These are the only exported functions, they provide some generic
22 * infrastructure for managing object devices
25 #define DEBUG_SUBSYSTEM S_CLASS
26 #include <linux/kmod.h> /* for request_module() */
27 #include <linux/module.h>
28 #include <linux/obd_class.h>
29 #include <linux/random.h>
30 #include <linux/slab.h>
31 #include <linux/lprocfs_status.h>
33 extern struct list_head obd_types;
34 kmem_cache_t *obdo_cachep = NULL;
35 kmem_cache_t *import_cachep = NULL;
36 kmem_cache_t *export_cachep = NULL;
38 int (*ptlrpc_put_connection_superhack)(struct ptlrpc_connection *c);
39 void (*ptlrpc_abort_inflight_superhack)(struct obd_import *imp,
43 * support functions: we could use inter-module communication, but this
44 * is more portable to other OS's
46 static struct obd_type *class_search_type(char *name)
48 struct list_head *tmp;
49 struct obd_type *type;
50 CDEBUG(D_INFO, "SEARCH %s\n", name);
53 list_for_each(tmp, &obd_types) {
54 type = list_entry(tmp, struct obd_type, typ_chain);
55 CDEBUG(D_INFO, "TYP %s\n", type->typ_name);
56 if (strlen(type->typ_name) == strlen(name) &&
57 strcmp(type->typ_name, name) == 0) {
64 struct obd_type *class_get_type(char *name)
66 struct obd_type *type = class_search_type(name);
70 if (!request_module(name)) {
71 CDEBUG(D_INFO, "Loaded module '%s'\n", name);
72 type = class_search_type(name);
74 CDEBUG(D_INFO, "Can't load module '%s'\n", name);
78 __MOD_INC_USE_COUNT(type->typ_ops->o_owner);
82 void class_put_type(struct obd_type *type)
85 __MOD_DEC_USE_COUNT(type->typ_ops->o_owner);
88 int class_register_type(struct obd_ops *ops, struct lprocfs_vars *vars,
91 struct obd_type *type;
95 LASSERT(strnlen(name, 1024) < 1024); /* sanity check */
97 if (class_search_type(name)) {
98 CDEBUG(D_IOCTL, "Type %s already registered\n", name);
103 OBD_ALLOC(type, sizeof(*type));
107 OBD_ALLOC(type->typ_ops, sizeof(*type->typ_ops));
108 OBD_ALLOC(type->typ_name, strlen(name) + 1);
109 if (type->typ_ops == NULL || type->typ_name == NULL)
112 *(type->typ_ops) = *ops;
113 strcpy(type->typ_name, name);
114 list_add(&type->typ_chain, &obd_types);
116 type->typ_procroot = lprocfs_register(type->typ_name, proc_lustre_root,
118 if (IS_ERR(type->typ_procroot)) {
119 rc = PTR_ERR(type->typ_procroot);
120 type->typ_procroot = NULL;
121 list_del(&type->typ_chain);
128 if (type->typ_ops != NULL)
129 OBD_FREE(type->typ_name, strlen(name) + 1);
130 if (type->typ_ops != NULL)
131 OBD_FREE (type->typ_ops, sizeof (*type->typ_ops));
135 int class_unregister_type(char *name)
137 struct obd_type *type = class_search_type(name);
141 CERROR("unknown obd type\n");
145 if (type->typ_refcnt) {
146 CERROR("type %s has refcount (%d)\n", name, type->typ_refcnt);
147 /* This is a bad situation, let's make the best of it */
148 /* Remove ops, but leave the name for debugging */
149 OBD_FREE(type->typ_ops, sizeof(*type->typ_ops));
153 if (type->typ_procroot) {
154 lprocfs_remove(type->typ_procroot);
155 type->typ_procroot = NULL;
158 list_del(&type->typ_chain);
159 OBD_FREE(type->typ_name, strlen(name) + 1);
160 if (type->typ_ops != NULL)
161 OBD_FREE(type->typ_ops, sizeof(*type->typ_ops));
162 OBD_FREE(type, sizeof(*type));
164 } /* class_unregister_type */
166 int class_name2dev(char *name)
174 for (i = 0; i < MAX_OBD_DEVICES; i++) {
175 struct obd_device *obd = &obd_dev[i];
176 if (obd->obd_name && strcmp(name, obd->obd_name) == 0) {
185 int class_uuid2dev(struct obd_uuid *uuid)
190 for (i = 0; i < MAX_OBD_DEVICES; i++) {
191 struct obd_device *obd = &obd_dev[i];
192 if (strncmp(uuid->uuid, obd->obd_uuid.uuid, sizeof(obd->obd_uuid.uuid)) == 0) {
202 struct obd_device *class_uuid2obd(struct obd_uuid *uuid)
206 for (i = 0; i < MAX_OBD_DEVICES; i++) {
207 struct obd_device *obd = &obd_dev[i];
208 if (strncmp(uuid->uuid, obd->obd_uuid.uuid, sizeof(obd->obd_uuid.uuid)) == 0)
215 void obd_cleanup_caches(void)
220 rc = kmem_cache_destroy(obdo_cachep);
222 CERROR("Cannot destory ll_obdo_cache\n");
226 rc = kmem_cache_destroy(import_cachep);
228 CERROR("Cannot destory ll_import_cache\n");
229 import_cachep = NULL;
232 rc = kmem_cache_destroy(export_cachep);
234 CERROR("Cannot destory ll_export_cache\n");
235 export_cachep = NULL;
240 int obd_init_caches(void)
243 LASSERT(obdo_cachep == NULL);
244 obdo_cachep = kmem_cache_create("ll_obdo_cache", sizeof(struct obdo),
249 LASSERT(export_cachep == NULL);
250 export_cachep = kmem_cache_create("ll_export_cache",
251 sizeof(struct obd_export),
256 LASSERT(import_cachep == NULL);
257 import_cachep = kmem_cache_create("ll_import_cache",
258 sizeof(struct obd_import),
265 obd_cleanup_caches();
270 /* map connection to client */
271 struct obd_export *class_conn2export(struct lustre_handle *conn)
273 struct obd_export *export;
277 CDEBUG(D_CACHE, "looking for null handle\n");
281 if (conn->addr == -1) { /* this means assign a new connection */
282 CDEBUG(D_CACHE, "want a new connection\n");
287 CDEBUG(D_CACHE, "looking for null addr\n");
292 CDEBUG(D_IOCTL, "looking for export addr "LPX64" cookie "LPX64"\n",
293 conn->addr, conn->cookie);
294 export = (struct obd_export *) (unsigned long)conn->addr;
295 if (!kmem_cache_validate(export_cachep, (void *)export))
298 if (export->exp_cookie != conn->cookie)
301 } /* class_conn2export */
303 struct obd_device *class_conn2obd(struct lustre_handle *conn)
305 struct obd_export *export;
306 export = class_conn2export(conn);
308 return export->exp_obd;
313 struct obd_import *class_conn2cliimp(struct lustre_handle *conn)
315 return &class_conn2obd(conn)->u.cli.cl_import;
318 struct obd_import *class_conn2ldlmimp(struct lustre_handle *conn)
320 return &class_conn2export(conn)->exp_ldlm_data.led_import;
323 struct obd_export *class_new_export(struct obd_device *obddev)
325 struct obd_export * export;
327 export = kmem_cache_alloc(export_cachep, GFP_KERNEL);
329 CERROR("no memory! (minor %d)\n", obddev->obd_minor);
333 memset(export, 0, sizeof(*export));
334 get_random_bytes(&export->exp_cookie, sizeof(export->exp_cookie));
335 export->exp_obd = obddev;
336 /* XXX this should be in LDLM init */
337 INIT_LIST_HEAD(&export->exp_ldlm_data.led_held_locks);
338 INIT_LIST_HEAD(&export->exp_conn_chain);
339 spin_lock(&obddev->obd_dev_lock);
340 list_add(&export->exp_obd_chain, &export->exp_obd->obd_exports);
341 spin_unlock(&obddev->obd_dev_lock);
345 void class_destroy_export(struct obd_export *exp)
349 LASSERT(exp->exp_cookie != DEAD_HANDLE_MAGIC);
351 spin_lock(&exp->exp_obd->obd_dev_lock);
352 list_del(&exp->exp_obd_chain);
353 spin_unlock(&exp->exp_obd->obd_dev_lock);
355 /* XXXshaver no connection here... */
356 if (exp->exp_connection)
357 spin_lock(&exp->exp_connection->c_lock);
358 list_del(&exp->exp_conn_chain);
359 if (exp->exp_connection) {
360 spin_unlock(&exp->exp_connection->c_lock);
361 ptlrpc_put_connection_superhack(exp->exp_connection);
364 /* Abort any inflight DLM requests and NULL out their (about to be
366 if (exp->exp_ldlm_data.led_import.imp_obd)
367 ptlrpc_abort_inflight_superhack(&exp->exp_ldlm_data.led_import,
370 exp->exp_cookie = DEAD_HANDLE_MAGIC;
371 kmem_cache_free(export_cachep, exp);
376 /* a connection defines an export context in which preallocation can
378 int class_connect(struct lustre_handle *conn, struct obd_device *obd,
379 struct obd_uuid *cluuid)
381 struct obd_export * export;
392 if (cluuid == NULL) {
397 export = class_new_export(obd);
401 conn->addr = (__u64) (unsigned long)export;
402 conn->cookie = export->exp_cookie;
403 memcpy(&export->exp_client_uuid, cluuid, sizeof(export->exp_client_uuid));
405 CDEBUG(D_IOCTL, "connect: addr %Lx cookie %Lx\n",
406 (long long)conn->addr, (long long)conn->cookie);
410 int class_disconnect(struct lustre_handle *conn)
412 struct obd_export *export;
415 if (!(export = class_conn2export(conn))) {
417 CDEBUG(D_IOCTL, "disconnect: attempting to free "
418 "nonexistent client "LPX64"\n", conn->addr);
422 CDEBUG(D_IOCTL, "disconnect: addr %Lx cookie %Lx\n",
423 (long long)conn->addr, (long long)conn->cookie);
425 class_destroy_export(export);
430 void class_disconnect_all(struct obd_device *obddev)
435 spin_lock(&obddev->obd_dev_lock);
436 if (!list_empty(&obddev->obd_exports)) {
437 struct obd_export *export;
438 struct lustre_handle conn;
441 export = list_entry(obddev->obd_exports.next,
444 conn.addr = (__u64)(unsigned long)export;
445 conn.cookie = export->exp_cookie;
446 spin_unlock(&obddev->obd_dev_lock);
447 CERROR("force disconnecting %s:%s export %p\n",
448 export->exp_obd->obd_type->typ_name,
449 export->exp_connection ?
450 (char *)export->exp_connection->c_remote_uuid.uuid :
451 "<unconnected>", export);
452 rc = obd_disconnect(&conn);
454 /* AED: not so sure about this... We can't
455 * loop here forever, yet we shouldn't leak
456 * exports on a struct we will soon destroy.
458 CERROR("destroy export %p with err: rc = %d\n",
460 class_destroy_export(export);
463 spin_unlock(&obddev->obd_dev_lock);
471 /* FIXME: Data is a space- or comma-separated list of device IDs. This will
473 int class_multi_setup(struct obd_device *obddev, uint32_t len, void *data)
479 for (p = data, count = 0; p < (char *)data + len; count++) {
481 int tmp = simple_strtoul(p, &end, 0);
484 CERROR("invalid device ID starting at: %s\n", p);
485 GOTO(err_disconnect, rc = -EINVAL);
488 if (tmp < 0 || tmp >= MAX_OBD_DEVICES) {
489 CERROR("Trying to sub dev %d - dev no too large\n",
491 GOTO(err_disconnect, rc = -EINVAL);
494 rc = obd_connect(&obddev->obd_multi_conn[count], &obd_dev[tmp]);
496 CERROR("cannot connect to device %d: rc = %d\n", tmp,
498 GOTO(err_disconnect, rc);
501 CDEBUG(D_INFO, "target OBD %d is of type %s\n", count,
502 obd_dev[tmp].obd_type->typ_name);
507 obddev->obd_multi_count = count;
512 for (count--; count >= 0; count--)
513 obd_disconnect(&obddev->obd_multi_conn[count]);
518 * remove all connections to this device
519 * close all connections to lower devices
520 * needed for forced unloads of OBD client drivers
522 int class_multi_cleanup(struct obd_device *obddev)
526 for (i = 0; i < obddev->obd_multi_count; i++) {
528 struct obd_device *obd =
529 class_conn2obd(&obddev->obd_multi_conn[i]);
532 CERROR("no such device [i %d]\n", i);
536 rc = obd_disconnect(&obddev->obd_multi_conn[i]);
538 CERROR("disconnect failure %d\n", obd->obd_minor);