1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * Copyright (c) 2001, 2002 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);
41 * support functions: we could use inter-module communication, but this
42 * is more portable to other OS's
44 static struct obd_type *class_search_type(char *nm)
46 struct list_head *tmp;
47 struct obd_type *type;
48 CDEBUG(D_INFO, "SEARCH %s\n", nm);
51 list_for_each(tmp, &obd_types) {
52 type = list_entry(tmp, struct obd_type, typ_chain);
53 CDEBUG(D_INFO, "TYP %s\n", type->typ_name);
54 if (strlen(type->typ_name) == strlen(nm) &&
55 strcmp(type->typ_name, nm) == 0 ) {
62 struct obd_type *class_nm_to_type(char *nm)
64 struct obd_type *type = class_search_type(nm);
68 if ( !request_module(nm) ) {
69 CDEBUG(D_INFO, "Loaded module '%s'\n", nm);
70 type = class_search_type(nm);
72 CDEBUG(D_INFO, "Can't load module '%s'\n", nm);
79 int class_register_type(struct obd_ops *ops, struct lprocfs_vars *vars,
82 struct obd_type *type;
87 if (class_search_type(nm)) {
88 CDEBUG(D_IOCTL, "Type %s already registered\n", nm);
92 OBD_ALLOC(type, sizeof(*type));
93 OBD_ALLOC(type->typ_ops, sizeof(*type->typ_ops));
94 OBD_ALLOC(type->typ_name, strlen(nm) + 1);
97 INIT_LIST_HEAD(&type->typ_chain);
98 CDEBUG(D_INFO, "MOD_INC_USE for register_type: count = %d\n",
99 atomic_read(&(THIS_MODULE)->uc.usecount));
101 list_add(&type->typ_chain, &obd_types);
102 memcpy(type->typ_ops, ops, sizeof(*type->typ_ops));
103 strcpy(type->typ_name, nm);
104 rc = lprocfs_reg_class(type, vars, type);
109 int class_unregister_type(char *nm)
111 struct obd_type *type = class_nm_to_type(nm);
116 CERROR("unknown obd type\n");
120 if (type->typ_refcnt) {
121 CERROR("type %s has refcount (%d)\n", nm, type->typ_refcnt);
122 /* This is a bad situation, let's make the best of it */
123 /* Remove ops, but leave the name for debugging */
124 OBD_FREE(type->typ_ops, sizeof(*type->typ_ops));
127 if(type->typ_procroot)
128 lprocfs_dereg_class(type);
130 list_del(&type->typ_chain);
131 OBD_FREE(type->typ_name, strlen(nm) + 1);
132 if (type->typ_ops != NULL)
133 OBD_FREE(type->typ_ops, sizeof(*type->typ_ops));
134 OBD_FREE(type, sizeof(*type));
135 CDEBUG(D_INFO, "MOD_DEC_USE for register_type: count = %d\n",
136 atomic_read(&(THIS_MODULE)->uc.usecount) - 1);
139 } /* class_unregister_type */
141 int class_name2dev(char *name)
149 for (i=0; i < MAX_OBD_DEVICES; i++) {
150 struct obd_device *obd = &obd_dev[i];
151 if (obd->obd_name && strcmp(name, obd->obd_name) == 0) {
160 int class_uuid2dev(char *uuid)
165 for (i=0; i < MAX_OBD_DEVICES; i++) {
166 struct obd_device *obd = &obd_dev[i];
167 if (strncmp(uuid, obd->obd_uuid, sizeof(obd->obd_uuid)) == 0) {
177 struct obd_device *class_uuid2obd(char *uuid)
181 for (i=0; i < MAX_OBD_DEVICES; i++) {
182 struct obd_device *obd = &obd_dev[i];
183 if (strncmp(uuid, obd->obd_uuid, sizeof(obd->obd_uuid)) == 0)
190 void obd_cleanup_caches(void)
195 rc = kmem_cache_destroy(obdo_cachep);
197 CERROR("Cannot destory ll_obdo_cache\n");
201 rc = kmem_cache_destroy(import_cachep);
203 CERROR("Cannot destory ll_import_cache\n");
204 import_cachep = NULL;
207 rc = kmem_cache_destroy(export_cachep);
209 CERROR("Cannot destory ll_export_cache\n");
210 export_cachep = NULL;
215 int obd_init_caches(void)
218 LASSERT(obdo_cachep == NULL);
219 obdo_cachep = kmem_cache_create("ll_obdo_cache", sizeof(struct obdo),
224 LASSERT(export_cachep == NULL);
225 export_cachep = kmem_cache_create("ll_export_cache",
226 sizeof(struct obd_export),
231 LASSERT(import_cachep == NULL);
232 import_cachep = kmem_cache_create("ll_import_cache",
233 sizeof(struct obd_import),
240 obd_cleanup_caches();
245 /* map connection to client */
246 struct obd_export *class_conn2export(struct lustre_handle *conn)
248 struct obd_export *export;
252 CDEBUG(D_CACHE, "looking for null handle\n");
256 if (conn->addr == -1) { /* this means assign a new connection */
257 CDEBUG(D_CACHE, "want a new connection\n");
262 CDEBUG(D_CACHE, "looking for null addr\n");
267 CDEBUG(D_IOCTL, "looking for export addr "LPX64" cookie "LPX64"\n",
268 conn->addr, conn->cookie);
269 export = (struct obd_export *) (unsigned long)conn->addr;
270 if (!kmem_cache_validate(export_cachep, (void *)export))
273 if (export->exp_cookie != conn->cookie)
276 } /* class_conn2export */
278 struct obd_device *class_conn2obd(struct lustre_handle *conn)
280 struct obd_export *export;
281 export = class_conn2export(conn);
283 return export->exp_obd;
288 struct obd_import *class_conn2cliimp(struct lustre_handle *conn)
290 return &class_conn2obd(conn)->u.cli.cl_import;
293 struct obd_import *class_conn2ldlmimp(struct lustre_handle *conn)
295 return &class_conn2export(conn)->exp_ldlm_data.led_import;
298 struct obd_export *class_new_export(struct obd_device *obddev)
300 struct obd_export * export;
302 export = kmem_cache_alloc(export_cachep, GFP_KERNEL);
304 CERROR("no memory! (minor %d)\n", obddev->obd_minor);
308 memset(export, 0, sizeof(*export));
309 get_random_bytes(&export->exp_cookie, sizeof(export->exp_cookie));
310 export->exp_obd = obddev;
311 /* XXX this should be in LDLM init */
312 INIT_LIST_HEAD(&export->exp_ldlm_data.led_held_locks);
313 INIT_LIST_HEAD(&export->exp_conn_chain);
314 spin_lock(&obddev->obd_dev_lock);
315 list_add(&export->exp_obd_chain, &export->exp_obd->obd_exports);
316 spin_unlock(&obddev->obd_dev_lock);
320 void class_destroy_export(struct obd_export *exp)
324 LASSERT(exp->exp_cookie != DEAD_HANDLE_MAGIC);
326 spin_lock(&exp->exp_obd->obd_dev_lock);
327 list_del(&exp->exp_obd_chain);
328 spin_unlock(&exp->exp_obd->obd_dev_lock);
330 /* XXXshaver no connection here... */
331 if (exp->exp_connection)
332 spin_lock(&exp->exp_connection->c_lock);
333 list_del(&exp->exp_conn_chain);
334 if (exp->exp_connection) {
335 spin_unlock(&exp->exp_connection->c_lock);
336 ptlrpc_put_connection_superhack(exp->exp_connection);
339 exp->exp_cookie = DEAD_HANDLE_MAGIC;
340 kmem_cache_free(export_cachep, exp);
345 /* a connection defines an export context in which preallocation can
347 int class_connect(struct lustre_handle *conn, struct obd_device *obd,
350 struct obd_export * export;
361 export = class_new_export(obd);
365 conn->addr = (__u64) (unsigned long)export;
366 conn->cookie = export->exp_cookie;
368 CDEBUG(D_IOCTL, "connect: addr %Lx cookie %Lx\n",
369 (long long)conn->addr, (long long)conn->cookie);
373 int class_disconnect(struct lustre_handle *conn)
375 struct obd_export *export;
378 if (!(export = class_conn2export(conn))) {
380 CDEBUG(D_IOCTL, "disconnect: attempting to free "
381 "nonexistent client "LPX64"\n", conn->addr);
385 CDEBUG(D_IOCTL, "disconnect: addr %Lx cookie %Lx\n",
386 (long long)conn->addr, (long long)conn->cookie);
388 class_destroy_export(export);
393 void class_disconnect_all(struct obd_device *obddev)
398 spin_lock(&obddev->obd_dev_lock);
399 if (!list_empty(&obddev->obd_exports)) {
400 struct obd_export *export;
401 struct lustre_handle conn;
404 export = list_entry(obddev->obd_exports.next,
407 conn.addr = (__u64)(unsigned long)export;
408 conn.cookie = export->exp_cookie;
409 spin_unlock(&obddev->obd_dev_lock);
410 CERROR("force disconnecting %s:%s export %p\n",
411 export->exp_obd->obd_type->typ_name,
412 export->exp_connection->c_remote_uuid, export);
413 rc = obd_disconnect(&conn);
415 /* AED: not so sure about this... We can't
416 * loop here forever, yet we shouldn't leak
417 * exports on a struct we will soon destroy.
419 CERROR("destroy export %p with err: rc = %d\n",
421 class_destroy_export(export);
424 spin_unlock(&obddev->obd_dev_lock);
432 /* FIXME: Data is a space- or comma-separated list of device IDs. This will
434 int class_multi_setup(struct obd_device *obddev, uint32_t len, void *data)
440 for (p = data, count = 0; p < (char *)data + len; count++) {
442 int tmp = simple_strtoul(p, &end, 0);
445 CERROR("invalid device ID starting at: %s\n", p);
446 GOTO(err_disconnect, rc = -EINVAL);
449 if (tmp < 0 || tmp >= MAX_OBD_DEVICES) {
450 CERROR("Trying to sub dev %d - dev no too large\n",
452 GOTO(err_disconnect, rc = -EINVAL);
455 rc = obd_connect(&obddev->obd_multi_conn[count], &obd_dev[tmp]);
457 CERROR("cannot connect to device %d: rc = %d\n", tmp,
459 GOTO(err_disconnect, rc);
462 CDEBUG(D_INFO, "target OBD %d is of type %s\n", count,
463 obd_dev[tmp].obd_type->typ_name);
468 obddev->obd_multi_count = count;
473 for (count--; count >= 0; count--)
474 obd_disconnect(&obddev->obd_multi_conn[count]);
479 * remove all connections to this device
480 * close all connections to lower devices
481 * needed for forced unloads of OBD client drivers
483 int class_multi_cleanup(struct obd_device *obddev)
487 for (i = 0; i < obddev->obd_multi_count; i++) {
489 struct obd_device *obd =
490 class_conn2obd(&obddev->obd_multi_conn[i]);
493 CERROR("no such device [i %d]\n", i);
497 rc = obd_disconnect(&obddev->obd_multi_conn[i]);
499 CERROR("disconnect failure %d\n", obd->obd_minor);