4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 021110-1307, USA
24 * Copyright (c) 2013, 2016, Intel Corporation.
25 * Use is subject to license terms.
27 * lustre/osp/lwp_dev.c
29 * This file provides code related to the Light Weight Proxy (LWP) managing
30 * the connections established from OST to MDT, and MDT to MDT0.
32 * A LWP connection is used to send quota and FLD query requests. It's not
33 * recoverable, which means target server doesn't have an on-disk record in
34 * the last_rcvd file to remember the connection. Once LWP reconnect after
35 * server reboot, server will always regard it as a new connection.
37 * Author: <di.wang@intel.com>
38 * Author: <yawei.niu@intel.com>
40 #define DEBUG_SUBSYSTEM S_OST
42 #include <obd_class.h>
43 #include <uapi/linux/lustre_param.h>
44 #include <lustre_log.h>
45 #include <linux/kthread.h>
47 #include "osp_internal.h"
50 struct lu_device lpd_dev;
51 struct obd_device *lpd_obd; /* corresponding OBD device */
52 struct obd_uuid lpd_cluuid;/* UUID of LWP */
53 struct obd_export *lpd_exp; /* export of LWP */
54 struct ptlrpc_thread lpd_notify_thread; /* notify thread */
55 int lpd_connects; /* use count, 0 or 1 */
58 static inline struct lwp_device *lu2lwp_dev(struct lu_device *d)
60 return container_of0(d, struct lwp_device, lpd_dev);
63 static inline struct lu_device *lwp2lu_dev(struct lwp_device *d)
71 * \param[in] env environment passed by caller
72 * \param[in] lwp LWP device to be setup
73 * \param[in] nidstring remote target NID
75 * \retval 0 on success
76 * \retval negative number on error
78 static int lwp_setup(const struct lu_env *env, struct lwp_device *lwp,
81 struct lustre_cfg_bufs *bufs = NULL;
82 struct lustre_cfg *lcfg = NULL;
83 char *lwp_name = lwp->lpd_obd->obd_name;
84 char *server_uuid = NULL;
87 struct obd_import *imp;
88 int len = strlen(lwp_name) + 1;
92 thread_set_flags(&lwp->lpd_notify_thread, SVC_STOPPED);
93 init_waitqueue_head(&lwp->lpd_notify_thread.t_ctl_waitq);
99 OBD_ALLOC(server_uuid, len);
100 if (server_uuid == NULL)
101 GOTO(out, rc = -ENOMEM);
103 snprintf(server_uuid, len, "-%s-", LUSTRE_LWP_NAME);
104 ptr = cfs_strrstr(lwp_name, server_uuid);
106 CERROR("%s: failed to get server_uuid from lwp_name: rc = %d\n",
108 GOTO(out, rc = -EINVAL);
111 strncpy(server_uuid, lwp_name, ptr - lwp_name);
112 server_uuid[ptr - lwp_name] = '\0';
113 strlcat(server_uuid, "_UUID", len);
114 lustre_cfg_bufs_reset(bufs, lwp_name);
115 lustre_cfg_bufs_set_string(bufs, 1, server_uuid);
116 lustre_cfg_bufs_set_string(bufs, 2, nidstring);
117 OBD_ALLOC(lcfg, lustre_cfg_len(bufs->lcfg_bufcount, bufs->lcfg_buflen));
119 GOTO(out, rc = -ENOMEM);
120 lustre_cfg_init(lcfg, LCFG_SETUP, bufs);
122 rc = client_obd_setup(lwp->lpd_obd, lcfg);
124 CERROR("%s: client obd setup error: rc = %d\n",
125 lwp->lpd_obd->obd_name, rc);
129 imp = lwp->lpd_obd->u.cli.cl_import;
130 rc = ptlrpc_init_import(imp);
134 ll_generate_random_uuid(uuid);
135 class_uuid_unparse(uuid, &lwp->lpd_cluuid);
139 if (server_uuid != NULL)
140 OBD_FREE(server_uuid, len);
142 OBD_FREE(lcfg, lustre_cfg_len(lcfg->lcfg_bufcount,
143 lcfg->lcfg_buflens));
145 client_obd_cleanup(lwp->lpd_obd);
151 * Disconnect the import from LWP.
153 * \param[in] d LWP device to be disconnected
155 * \retval 0 on success
156 * \retval negative number on error
158 static int lwp_disconnect(struct lwp_device *d)
160 struct obd_import *imp;
163 imp = d->lpd_obd->u.cli.cl_import;
166 * Mark import deactivated now, so we don't try to reconnect if any
167 * of the cleanup RPCs fails (e.g. ldlm cancel, etc). We don't
168 * fully deactivate the import because that would cause all requests
171 LASSERT(imp != NULL);
172 spin_lock(&imp->imp_lock);
173 imp->imp_deactive = 1;
174 spin_unlock(&imp->imp_lock);
176 ptlrpc_deactivate_import(imp);
179 * Some non-replayable imports (MDS's OSCs) are pinged, so just
180 * delete it regardless. (It's safe to delete an import that was
183 ptlrpc_pinger_del_import(imp);
184 rc = ptlrpc_disconnect_import(imp, 0);
186 CWARN("%s: can't disconnect: rc = %d\n",
187 d->lpd_obd->obd_name, rc);
189 ptlrpc_invalidate_import(imp);
195 * Implementation of lu_device_operations::ldo_process_config.
197 * Process a Lustre configuration request.
199 * \param[in] env environment passed by caller
200 * \param[in] dev device to be processed
201 * \param[in] lcfg lustre_cfg, LCFG_PRE_CLEANUP or LCFG_CLEANUP
203 * \retval 0 on success
204 * \retval negative number on error
206 static int lwp_process_config(const struct lu_env *env,
207 struct lu_device *dev, struct lustre_cfg *lcfg)
209 struct lwp_device *d = lu2lwp_dev(dev);
213 switch (lcfg->lcfg_command) {
214 case LCFG_PRE_CLEANUP:
216 rc = lwp_disconnect(d);
222 CERROR("%s: unknown command %u\n",
223 (char *)lustre_cfg_string(lcfg, 0), lcfg->lcfg_command);
231 static const struct lu_device_operations lwp_lu_ops = {
232 .ldo_process_config = lwp_process_config,
236 * Initialize LWP device.
238 * \param[in] env environment passed by caller
239 * \param[in] lwp device to be initialized
240 * \param[in] ldt not used
241 * \param[in] cfg lustre_cfg contains remote target uuid
243 * \retval 0 on success
244 * \retval -ENODEV if the device name cannot be found
245 * \retval negative numbers on other errors
247 static int lwp_init0(const struct lu_env *env, struct lwp_device *lwp,
248 struct lu_device_type *ldt, struct lustre_cfg *cfg)
253 lwp->lpd_obd = class_name2obd(lustre_cfg_string(cfg, 0));
254 if (lwp->lpd_obd == NULL) {
255 CERROR("Cannot find obd with name %s\n",
256 lustre_cfg_string(cfg, 0));
260 lwp->lpd_dev.ld_ops = &lwp_lu_ops;
261 lwp->lpd_obd->obd_lu_dev = &lwp->lpd_dev;
263 rc = ptlrpcd_addref();
265 CERROR("%s: ptlrpcd addref error: rc =%d\n",
266 lwp->lpd_obd->obd_name, rc);
270 rc = lwp_setup(env, lwp, lustre_cfg_string(cfg, 1));
272 CERROR("%s: setup lwp failed. %d\n",
273 lwp->lpd_obd->obd_name, rc);
278 if (lprocfs_obd_setup(lwp->lpd_obd) == 0) {
279 sptlrpc_lprocfs_cliobd_attach(lwp->lpd_obd);
280 ptlrpc_lprocfs_register_obd(lwp->lpd_obd);
287 * Implementation of lu_device_type_operations::ldto_device_free.
291 * \param[in] env environment passed by caller
292 * \param[in] lu device to be freed
294 * \retval NULL to indicate that this is the bottom device
295 * of the stack and there are no more devices
296 * below this one to be cleaned up.
298 static struct lu_device *lwp_device_free(const struct lu_env *env,
299 struct lu_device *lu)
301 struct lwp_device *m = lu2lwp_dev(lu);
304 if (atomic_read(&lu->ld_ref) && lu->ld_site) {
305 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_ERROR, NULL);
306 lu_site_print(env, lu->ld_site, &msgdata, lu_cdebug_printer);
308 lu_device_fini(&m->lpd_dev);
314 * Implementation of lu_device_type_operations::ldto_device_alloc.
316 * Allocate a LWP device.
318 * \param[in] env environment passed by caller
319 * \param[in] ldt device type whose name is LUSTRE_LWP_NAME
320 * \param[in] lcfg lustre_cfg contains remote target UUID
322 * \retval pointer of allocated LWP device on success
323 * \retval ERR_PTR(errno) on error
325 static struct lu_device *lwp_device_alloc(const struct lu_env *env,
326 struct lu_device_type *ldt,
327 struct lustre_cfg *lcfg)
329 struct lwp_device *lwp;
330 struct lu_device *ludev;
334 ludev = ERR_PTR(-ENOMEM);
338 ludev = lwp2lu_dev(lwp);
339 lu_device_init(&lwp->lpd_dev, ldt);
340 rc = lwp_init0(env, lwp, ldt, lcfg);
342 lwp_device_free(env, ludev);
351 * Implementation of lu_device_type_operations::ltdo_device_fini.
353 * Finalize LWP device.
355 * \param[in] env environment passed by caller
356 * \param[in] ludev device to be finalized
358 * \retval NULL on success
360 static struct lu_device *lwp_device_fini(const struct lu_env *env,
361 struct lu_device *ludev)
363 struct lwp_device *m = lu2lwp_dev(ludev);
364 struct ptlrpc_thread *thread = &m->lpd_notify_thread;
365 struct l_wait_info lwi = { 0 };
369 if (!thread_is_stopped(thread))
370 l_wait_event(thread->t_ctl_waitq, thread_is_stopped(thread),
373 if (m->lpd_exp != NULL)
374 class_disconnect(m->lpd_exp);
377 ptlrpc_lprocfs_unregister_obd(m->lpd_obd);
378 lprocfs_obd_cleanup(m->lpd_obd);
380 rc = client_obd_cleanup(m->lpd_obd);
381 LASSERTF(rc == 0, "error %d\n", rc);
388 static struct lu_device_type_operations lwp_device_type_ops = {
389 .ldto_device_alloc = lwp_device_alloc,
390 .ldto_device_free = lwp_device_free,
391 .ldto_device_fini = lwp_device_fini
394 struct lu_device_type lwp_device_type = {
395 .ldt_tags = LU_DEVICE_DT,
396 .ldt_name = LUSTRE_LWP_NAME,
397 .ldt_ops = &lwp_device_type_ops,
398 .ldt_ctx_tags = LCT_MD_THREAD
401 static int lwp_notify_main(void *args)
403 struct obd_export *exp = (struct obd_export *)args;
404 struct lwp_device *lwp;
405 struct ptlrpc_thread *thread;
407 LASSERT(exp != NULL);
408 class_export_get(exp);
410 lwp = lu2lwp_dev(exp->exp_obd->obd_lu_dev);
411 thread = &lwp->lpd_notify_thread;
413 thread_set_flags(thread, SVC_RUNNING);
414 wake_up(&thread->t_ctl_waitq);
416 lustre_notify_lwp_list(exp);
418 class_export_put(exp);
419 thread_set_flags(thread, SVC_STOPPED);
420 wake_up(&thread->t_ctl_waitq);
425 * Some notify callbacks may cause deadlock in failover
426 * scenario, so we have to start thread to run callbacks
427 * asynchronously. See LU-6273.
429 static void lwp_notify_users(struct obd_export *exp)
431 struct lwp_device *lwp;
432 struct ptlrpc_thread *thread;
433 struct task_struct *task;
434 struct l_wait_info lwi = { 0 };
435 char name[MTI_NAME_MAXLEN];
437 LASSERT(exp != NULL);
438 lwp = lu2lwp_dev(exp->exp_obd->obd_lu_dev);
439 thread = &lwp->lpd_notify_thread;
441 snprintf(name, MTI_NAME_MAXLEN, "lwp_notify_%s",
442 exp->exp_obd->obd_name);
444 /* Notify happens only on LWP setup, so there shouldn't
445 * be notify thread running */
446 if (!thread_is_stopped(thread)) {
447 CERROR("LWP notify thread: %s wasn't stopped\n", name);
451 task = kthread_run(lwp_notify_main, exp, name);
453 thread_set_flags(thread, SVC_STOPPED);
454 CERROR("Failed to start LWP notify thread:%s. %lu\n",
455 name, PTR_ERR(task));
458 l_wait_event(thread->t_ctl_waitq,
459 thread_is_running(thread) || thread_is_stopped(thread),
464 * Implementation of OBD device operations obd_ops::o_connect.
466 * Create export for LWP, and connect to target server.
468 * \param[in] env the environment passed by caller
469 * \param[out] exp export for the connection to be established
470 * \param[in] obd OBD device to perform the connect on
471 * \param[in] cluuid UUID of the OBD device
472 * \param[in] data connect data containing compatibility flags
473 * \param[in] localdata not used
475 * \retval 0 on success
476 * \retval negative number on error
478 static int lwp_obd_connect(const struct lu_env *env, struct obd_export **exp,
479 struct obd_device *obd, struct obd_uuid *cluuid,
480 struct obd_connect_data *data, void *localdata)
482 struct lwp_device *lwp = lu2lwp_dev(obd->obd_lu_dev);
483 struct client_obd *cli = &lwp->lpd_obd->u.cli;
484 struct obd_import *imp = cli->cl_import;
485 struct obd_connect_data *ocd;
486 struct lustre_handle conn;
491 CDEBUG(D_CONFIG, "connect #%d\n", lwp->lpd_connects);
494 down_write(&cli->cl_sem);
495 rc = class_connect(&conn, obd, cluuid);
499 *exp = class_conn2export(&conn);
503 LASSERT(lwp->lpd_connects == 1);
505 imp->imp_dlm_handle = conn;
506 rc = ptlrpc_init_import(imp);
510 LASSERT(data != NULL);
511 ocd = &imp->imp_connect_data;
514 LASSERT(ocd->ocd_connect_flags & OBD_CONNECT_LIGHTWEIGHT);
516 ocd->ocd_version = LUSTRE_VERSION_CODE;
517 imp->imp_connect_flags_orig = ocd->ocd_connect_flags;
518 imp->imp_connect_flags2_orig = ocd->ocd_connect_flags2;
520 rc = ptlrpc_connect_import(imp);
522 CERROR("%s: can't connect obd: rc = %d\n", obd->obd_name, rc);
526 ptlrpc_pinger_add_import(imp);
528 GOTO(out_dis, rc = 0);
532 class_disconnect(*exp);
538 up_write(&cli->cl_sem);
541 lwp_notify_users(*exp);
547 * Implementation of OBD device operations obd_ops::o_disconnect.
549 * Release export for the LWP. Only disconnect the underlying layers
550 * on the final disconnect.
552 * \param[in] exp the export to perform disconnect on
554 * \retval 0 on success
555 * \retval negative number on error
557 static int lwp_obd_disconnect(struct obd_export *exp)
559 struct obd_device *obd = exp->exp_obd;
560 struct lwp_device *lwp = lu2lwp_dev(obd->obd_lu_dev);
564 LASSERT(lwp->lpd_connects == 1);
567 rc = class_disconnect(exp);
569 CERROR("%s: class disconnect error: rc = %d\n",
576 * Handle import events for the LWP device.
578 * \param[in] obd OBD device associated with the import
579 * \param[in] imp the import which event happened on
580 * \param[in] event event type
582 * \retval 0 on success
583 * \retval negative number on error
585 static int lwp_import_event(struct obd_device *obd, struct obd_import *imp,
586 enum obd_import_event event)
589 case IMP_EVENT_DISCON:
590 case IMP_EVENT_INACTIVE:
591 case IMP_EVENT_ACTIVE:
593 case IMP_EVENT_INVALIDATE:
594 if (obd->obd_namespace == NULL)
596 ldlm_namespace_cleanup(obd->obd_namespace, LDLM_FL_LOCAL_ONLY);
601 CERROR("%s: unsupported import event: %#x\n",
602 obd->obd_name, event);
607 static int lwp_set_info_async(const struct lu_env *env,
608 struct obd_export *exp,
609 u32 keylen, void *key,
610 u32 vallen, void *val,
611 struct ptlrpc_request_set *set)
615 if (KEY_IS(KEY_SPTLRPC_CONF)) {
616 sptlrpc_conf_client_adapt(exp->exp_obd);
620 CERROR("Unknown key %s\n", (char *)key);
624 struct obd_ops lwp_obd_device_ops = {
625 .o_owner = THIS_MODULE,
626 .o_add_conn = client_import_add_conn,
627 .o_del_conn = client_import_del_conn,
628 .o_connect = lwp_obd_connect,
629 .o_disconnect = lwp_obd_disconnect,
630 .o_import_event = lwp_import_event,
631 .o_set_info_async = lwp_set_info_async,