1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * lustre/obdclass/genops.c
5 * Copyright (C) 2001-2002 Cluster File Systems, Inc.
7 * This code is issued under the GNU General Public License.
8 * See the file COPYING in this distribution
10 * These are the only exported functions, they provide some generic
11 * infrastructure for managing object devices
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 #include <linux/lprocfs_status.h>
23 extern struct list_head obd_types;
24 kmem_cache_t *obdo_cachep = NULL;
25 kmem_cache_t *import_cachep = NULL;
26 kmem_cache_t *export_cachep = NULL;
28 int (*ptlrpc_put_connection_superhack)(struct ptlrpc_connection *c);
30 /* I would prefer if these next four functions were in ptlrpc, to be honest,
31 * but obdclass uses them for the netregression ioctls. -phil */
32 static int sync_io_timeout(void *data)
34 struct io_cb_data *cbd = data;
35 struct ptlrpc_bulk_desc *desc;
42 CERROR("no desc for timed-out BRW, reopen Bugzilla 214!\n");
43 RETURN(0); /* back to sleep -- someone had better wake us up! */
46 LASSERT(desc->bd_connection);
48 CERROR("IO of %d pages to/from %s:%d (conn %p) timed out\n",
49 desc->bd_page_count, desc->bd_connection->c_remote_uuid,
50 desc->bd_portal, desc->bd_connection);
51 desc->bd_connection->c_level = LUSTRE_CONN_RECOVD;
52 desc->bd_flags |= PTL_RPC_FL_TIMEOUT;
53 if (desc->bd_connection && class_signal_connection_failure) {
54 class_signal_connection_failure(desc->bd_connection);
56 /* We go back to sleep, until we're resumed or interrupted. */
60 /* If we can't be recovered, just abort the syscall with -ETIMEDOUT. */
64 static int sync_io_intr(void *data)
66 struct io_cb_data *cbd = data;
67 struct ptlrpc_bulk_desc *desc = cbd->desc;
70 desc->bd_flags |= PTL_RPC_FL_INTR;
71 RETURN(1); /* ignored, as of this writing */
74 int ll_sync_io_cb(struct io_cb_data *data, int err, int phase)
79 if (phase == CB_PHASE_START) {
80 struct l_wait_info lwi;
81 lwi = LWI_TIMEOUT_INTR(obd_timeout * HZ, sync_io_timeout,
83 ret = l_wait_event(data->waitq, data->complete, &lwi);
84 if (atomic_dec_and_test(&data->refcount))
85 OBD_FREE(data, sizeof(*data));
88 } else if (phase == CB_PHASE_FINISH) {
91 wake_up(&data->waitq);
92 if (atomic_dec_and_test(&data->refcount))
93 OBD_FREE(data, sizeof(*data));
101 struct io_cb_data *ll_init_cb(void)
103 struct io_cb_data *d;
105 OBD_ALLOC(d, sizeof(*d));
107 init_waitqueue_head(&d->waitq);
108 atomic_set(&d->refcount, 2);
114 * support functions: we could use inter-module communication, but this
115 * is more portable to other OS's
117 static struct obd_type *class_search_type(char *nm)
119 struct list_head *tmp;
120 struct obd_type *type;
121 CDEBUG(D_INFO, "SEARCH %s\n", nm);
124 list_for_each(tmp, &obd_types) {
125 type = list_entry(tmp, struct obd_type, typ_chain);
126 CDEBUG(D_INFO, "TYP %s\n", type->typ_name);
127 if (strlen(type->typ_name) == strlen(nm) &&
128 strcmp(type->typ_name, nm) == 0 ) {
135 struct obd_type *class_nm_to_type(char *nm)
137 struct obd_type *type = class_search_type(nm);
141 if ( !request_module(nm) ) {
142 CDEBUG(D_INFO, "Loaded module '%s'\n", nm);
143 type = class_search_type(nm);
145 CDEBUG(D_INFO, "Can't load module '%s'\n", nm);
152 int class_register_type(struct obd_ops *ops, struct lprocfs_vars* vars, char *nm)
154 struct obd_type *type;
159 if (class_search_type(nm)) {
160 CDEBUG(D_IOCTL, "Type %s already registered\n", nm);
164 OBD_ALLOC(type, sizeof(*type));
165 OBD_ALLOC(type->typ_ops, sizeof(*type->typ_ops));
166 OBD_ALLOC(type->typ_name, strlen(nm) + 1);
169 INIT_LIST_HEAD(&type->typ_chain);
170 CDEBUG(D_INFO, "MOD_INC_USE for register_type: count = %d\n",
171 atomic_read(&(THIS_MODULE)->uc.usecount));
173 list_add(&type->typ_chain, &obd_types);
174 memcpy(type->typ_ops, ops, sizeof(*type->typ_ops));
175 strcpy(type->typ_name, nm);
176 rc = lprocfs_reg_class(type, (lprocfs_vars_t *)vars, (void*)type);
183 int class_unregister_type(char *nm)
185 struct obd_type *type = class_nm_to_type(nm);
190 CERROR("unknown obd type\n");
194 if (type->typ_refcnt) {
195 CERROR("type %s has refcount (%d)\n", nm, type->typ_refcnt);
196 /* This is a bad situation, let's make the best of it */
197 /* Remove ops, but leave the name for debugging */
198 OBD_FREE(type->typ_ops, sizeof(*type->typ_ops));
201 if(type->typ_procroot)
202 lprocfs_dereg_class(type);
204 list_del(&type->typ_chain);
205 OBD_FREE(type->typ_name, strlen(nm) + 1);
206 if (type->typ_ops != NULL)
207 OBD_FREE(type->typ_ops, sizeof(*type->typ_ops));
208 OBD_FREE(type, sizeof(*type));
209 CDEBUG(D_INFO, "MOD_DEC_USE for register_type: count = %d\n",
210 atomic_read(&(THIS_MODULE)->uc.usecount) - 1);
213 } /* class_unregister_type */
215 int class_name2dev(char *name)
223 for (i=0; i < MAX_OBD_DEVICES; i++) {
224 struct obd_device *obd = &obd_dev[i];
225 if (obd->obd_name && strcmp(name, obd->obd_name) == 0) {
234 int class_uuid2dev(char *uuid)
239 for (i=0; i < MAX_OBD_DEVICES; i++) {
240 struct obd_device *obd = &obd_dev[i];
241 if (strncmp(uuid, obd->obd_uuid, sizeof(obd->obd_uuid)) == 0) {
251 struct obd_device *class_uuid2obd(char *uuid)
255 for (i=0; i < MAX_OBD_DEVICES; i++) {
256 struct obd_device *obd = &obd_dev[i];
257 if (strncmp(uuid, obd->obd_uuid, sizeof(obd->obd_uuid)) == 0)
264 void obd_cleanup_caches(void)
269 rc = kmem_cache_destroy(obdo_cachep);
271 CERROR("Cannot destory ll_obdo_cache\n");
275 rc = kmem_cache_destroy(import_cachep);
277 CERROR("Cannot destory ll_import_cache\n");
278 import_cachep = NULL;
281 rc = kmem_cache_destroy(export_cachep);
283 CERROR("Cannot destory ll_export_cache\n");
284 export_cachep = NULL;
289 int obd_init_caches(void)
292 LASSERT(obdo_cachep == NULL);
293 obdo_cachep = kmem_cache_create("ll_obdo_cache", sizeof(struct obdo),
298 LASSERT(export_cachep == NULL);
299 export_cachep = kmem_cache_create("ll_export_cache",
300 sizeof(struct obd_export),
305 LASSERT(import_cachep == NULL);
306 import_cachep = kmem_cache_create("ll_import_cache",
307 sizeof(struct obd_import),
314 obd_cleanup_caches();
319 /* map connection to client */
320 struct obd_export *class_conn2export(struct lustre_handle *conn)
322 struct obd_export *export;
325 CDEBUG(D_CACHE, "looking for null handle\n");
329 if (conn->addr == -1) { /* this means assign a new connection */
330 CDEBUG(D_CACHE, "want a new connection\n");
335 CDEBUG(D_CACHE, "looking for null addr\n");
340 CDEBUG(D_IOCTL, "looking for export addr "LPX64" cookie "LPX64"\n",
341 conn->addr, conn->cookie);
342 export = (struct obd_export *) (unsigned long)conn->addr;
343 if (!kmem_cache_validate(export_cachep, (void *)export))
346 if (export->exp_cookie != conn->cookie)
349 } /* class_conn2export */
351 struct obd_device *class_conn2obd(struct lustre_handle *conn)
353 struct obd_export *export;
354 export = class_conn2export(conn);
356 return export->exp_obd;
361 struct obd_import *class_conn2cliimp(struct lustre_handle *conn)
363 return &class_conn2obd(conn)->u.cli.cl_import;
366 struct obd_import *class_conn2ldlmimp(struct lustre_handle *conn)
368 return &class_conn2export(conn)->exp_ldlm_data.led_import;
371 struct obd_export *class_new_export(struct obd_device *obddev)
373 struct obd_export * export;
375 export = kmem_cache_alloc(export_cachep, GFP_KERNEL);
377 CERROR("no memory! (minor %d)\n", obddev->obd_minor);
381 memset(export, 0, sizeof(*export));
382 get_random_bytes(&export->exp_cookie, sizeof(export->exp_cookie));
383 export->exp_obd = obddev;
384 /* XXX this should be in LDLM init */
385 INIT_LIST_HEAD(&export->exp_ldlm_data.led_held_locks);
386 INIT_LIST_HEAD(&export->exp_conn_chain);
387 spin_lock(&obddev->obd_dev_lock);
388 list_add(&export->exp_obd_chain, &export->exp_obd->obd_exports);
389 spin_unlock(&obddev->obd_dev_lock);
393 void class_destroy_export(struct obd_export *exp)
397 LASSERT(exp->exp_cookie != DEAD_HANDLE_MAGIC);
399 spin_lock(&exp->exp_obd->obd_dev_lock);
400 list_del(&exp->exp_obd_chain);
401 spin_unlock(&exp->exp_obd->obd_dev_lock);
403 /* XXXshaver no connection here... */
404 if (exp->exp_connection)
405 spin_lock(&exp->exp_connection->c_lock);
406 list_del(&exp->exp_conn_chain);
407 if (exp->exp_connection) {
408 spin_unlock(&exp->exp_connection->c_lock);
409 ptlrpc_put_connection_superhack(exp->exp_connection);
412 exp->exp_cookie = DEAD_HANDLE_MAGIC;
413 kmem_cache_free(export_cachep, exp);
418 /* a connection defines an export context in which preallocation can
420 int class_connect(struct lustre_handle *conn, struct obd_device *obd,
423 struct obd_export * export;
434 export = class_new_export(obd);
438 conn->addr = (__u64) (unsigned long)export;
439 conn->cookie = export->exp_cookie;
441 CDEBUG(D_IOCTL, "connect: addr %Lx cookie %Lx\n",
442 (long long)conn->addr, (long long)conn->cookie);
446 int class_disconnect(struct lustre_handle *conn)
448 struct obd_export *export;
451 if (!(export = class_conn2export(conn))) {
453 CDEBUG(D_IOCTL, "disconnect: attempting to free "
454 "nonexistent client "LPX64"\n", conn->addr);
458 CDEBUG(D_IOCTL, "disconnect: addr %Lx cookie %Lx\n",
459 (long long)conn->addr, (long long)conn->cookie);
461 class_destroy_export(export);
466 void class_disconnect_all(struct obd_device *obddev)
471 spin_lock(&obddev->obd_dev_lock);
472 if (!list_empty(&obddev->obd_exports)) {
473 struct obd_export *export;
474 struct lustre_handle conn;
477 export = list_entry(obddev->obd_exports.next,
480 conn.addr = (__u64)(unsigned long)export;
481 conn.cookie = export->exp_cookie;
482 spin_unlock(&obddev->obd_dev_lock);
483 CERROR("force disconnecting export %p\n", export);
484 rc = obd_disconnect(&conn);
486 /* AED: not so sure about this... We can't
487 * loop here forever, yet we shouldn't leak
488 * exports on a struct we will soon destroy.
490 CERROR("destroy export %p with err: rc = %d\n",
492 class_destroy_export(export);
495 spin_unlock(&obddev->obd_dev_lock);
503 /* FIXME: Data is a space- or comma-separated list of device IDs. This will
505 int class_multi_setup(struct obd_device *obddev, uint32_t len, void *data)
511 for (p = data, count = 0; p < (char *)data + len; count++) {
513 int tmp = simple_strtoul(p, &end, 0);
516 CERROR("invalid device ID starting at: %s\n", p);
517 GOTO(err_disconnect, rc = -EINVAL);
520 if (tmp < 0 || tmp >= MAX_OBD_DEVICES) {
521 CERROR("Trying to sub dev %d - dev no too large\n",
523 GOTO(err_disconnect, rc = -EINVAL);
526 rc = obd_connect(&obddev->obd_multi_conn[count], &obd_dev[tmp]);
528 CERROR("cannot connect to device %d: rc = %d\n", tmp,
530 GOTO(err_disconnect, rc);
533 CDEBUG(D_INFO, "target OBD %d is of type %s\n", count,
534 obd_dev[tmp].obd_type->typ_name);
539 obddev->obd_multi_count = count;
544 for (count--; count >= 0; count--)
545 obd_disconnect(&obddev->obd_multi_conn[count]);
550 * remove all connections to this device
551 * close all connections to lower devices
552 * needed for forced unloads of OBD client drivers
554 int class_multi_cleanup(struct obd_device *obddev)
558 for (i = 0; i < obddev->obd_multi_count; i++) {
560 struct obd_device *obd =
561 class_conn2obd(&obddev->obd_multi_conn[i]);
564 CERROR("no such device [i %d]\n", i);
568 rc = obd_disconnect(&obddev->obd_multi_conn[i]);
570 CERROR("disconnect failure %d\n", obd->obd_minor);