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, 2017, 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/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_export *lpd_exp; /* export of LWP */
53 struct ptlrpc_thread lpd_notify_thread; /* notify thread */
54 int lpd_connects; /* use count, 0 or 1 */
57 static inline struct lwp_device *lu2lwp_dev(struct lu_device *d)
59 return container_of0(d, struct lwp_device, lpd_dev);
62 static inline struct lu_device *lwp2lu_dev(struct lwp_device *d)
70 * \param[in] env environment passed by caller
71 * \param[in] lwp LWP device to be setup
72 * \param[in] nidstring remote target NID
74 * \retval 0 on success
75 * \retval negative number on error
77 static int lwp_setup(const struct lu_env *env, struct lwp_device *lwp,
80 struct lustre_cfg_bufs *bufs = NULL;
81 struct lustre_cfg *lcfg = NULL;
82 char *lwp_name = lwp->lpd_obd->obd_name;
83 char *server_uuid = NULL;
85 struct obd_import *imp;
86 int len = strlen(lwp_name) + 1;
90 thread_set_flags(&lwp->lpd_notify_thread, SVC_STOPPED);
91 init_waitqueue_head(&lwp->lpd_notify_thread.t_ctl_waitq);
97 OBD_ALLOC(server_uuid, len);
98 if (server_uuid == NULL)
99 GOTO(out, rc = -ENOMEM);
101 snprintf(server_uuid, len, "-%s-", LUSTRE_LWP_NAME);
102 ptr = cfs_strrstr(lwp_name, server_uuid);
104 CERROR("%s: failed to get server_uuid from lwp_name: rc = %d\n",
106 GOTO(out, rc = -EINVAL);
109 strncpy(server_uuid, lwp_name, ptr - lwp_name);
110 server_uuid[ptr - lwp_name] = '\0';
111 strlcat(server_uuid, "_UUID", len);
112 lustre_cfg_bufs_reset(bufs, lwp_name);
113 lustre_cfg_bufs_set_string(bufs, 1, server_uuid);
114 lustre_cfg_bufs_set_string(bufs, 2, nidstring);
115 OBD_ALLOC(lcfg, lustre_cfg_len(bufs->lcfg_bufcount, bufs->lcfg_buflen));
117 GOTO(out, rc = -ENOMEM);
118 lustre_cfg_init(lcfg, LCFG_SETUP, bufs);
120 rc = client_obd_setup(lwp->lpd_obd, lcfg);
122 CERROR("%s: client obd setup error: rc = %d\n",
123 lwp->lpd_obd->obd_name, rc);
127 imp = lwp->lpd_obd->u.cli.cl_import;
128 rc = ptlrpc_init_import(imp);
132 if (server_uuid != NULL)
133 OBD_FREE(server_uuid, len);
135 OBD_FREE(lcfg, lustre_cfg_len(lcfg->lcfg_bufcount,
136 lcfg->lcfg_buflens));
138 client_obd_cleanup(lwp->lpd_obd);
144 * Disconnect the import from LWP.
146 * \param[in] d LWP device to be disconnected
148 * \retval 0 on success
149 * \retval negative number on error
151 static int lwp_disconnect(struct lwp_device *d)
153 struct obd_import *imp;
156 imp = d->lpd_obd->u.cli.cl_import;
159 * Mark import deactivated now, so we don't try to reconnect if any
160 * of the cleanup RPCs fails (e.g. ldlm cancel, etc). We don't
161 * fully deactivate the import because that would cause all requests
164 LASSERT(imp != NULL);
165 spin_lock(&imp->imp_lock);
166 imp->imp_deactive = 1;
167 spin_unlock(&imp->imp_lock);
169 ptlrpc_deactivate_import(imp);
172 * Some non-replayable imports (MDS's OSCs) are pinged, so just
173 * delete it regardless. (It's safe to delete an import that was
176 ptlrpc_pinger_del_import(imp);
177 rc = ptlrpc_disconnect_import(imp, 0);
179 CWARN("%s: can't disconnect: rc = %d\n",
180 d->lpd_obd->obd_name, rc);
182 ptlrpc_invalidate_import(imp);
188 * Implementation of lu_device_operations::ldo_process_config.
190 * Process a Lustre configuration request.
192 * \param[in] env environment passed by caller
193 * \param[in] dev device to be processed
194 * \param[in] lcfg lustre_cfg, LCFG_PRE_CLEANUP or LCFG_CLEANUP
196 * \retval 0 on success
197 * \retval negative number on error
199 static int lwp_process_config(const struct lu_env *env,
200 struct lu_device *dev, struct lustre_cfg *lcfg)
202 struct lwp_device *d = lu2lwp_dev(dev);
206 switch (lcfg->lcfg_command) {
207 case LCFG_PRE_CLEANUP:
209 rc = lwp_disconnect(d);
215 CERROR("%s: unknown command %u\n",
216 (char *)lustre_cfg_string(lcfg, 0), lcfg->lcfg_command);
224 static const struct lu_device_operations lwp_lu_ops = {
225 .ldo_process_config = lwp_process_config,
229 * Initialize LWP device.
231 * \param[in] env environment passed by caller
232 * \param[in] lwp device to be initialized
233 * \param[in] ldt not used
234 * \param[in] cfg lustre_cfg contains remote target uuid
236 * \retval 0 on success
237 * \retval -ENODEV if the device name cannot be found
238 * \retval negative numbers on other errors
240 static int lwp_init0(const struct lu_env *env, struct lwp_device *lwp,
241 struct lu_device_type *ldt, struct lustre_cfg *cfg)
246 lwp->lpd_obd = class_name2obd(lustre_cfg_string(cfg, 0));
247 if (lwp->lpd_obd == NULL) {
248 CERROR("Cannot find obd with name %s\n",
249 lustre_cfg_string(cfg, 0));
253 lwp->lpd_dev.ld_ops = &lwp_lu_ops;
254 lwp->lpd_obd->obd_lu_dev = &lwp->lpd_dev;
256 rc = ptlrpcd_addref();
258 CERROR("%s: ptlrpcd addref error: rc =%d\n",
259 lwp->lpd_obd->obd_name, rc);
263 rc = lwp_setup(env, lwp, lustre_cfg_string(cfg, 1));
265 CERROR("%s: setup lwp failed. %d\n",
266 lwp->lpd_obd->obd_name, rc);
271 rc = lprocfs_obd_setup(lwp->lpd_obd, true);
273 CERROR("%s: lprocfs_obd_setup failed. %d\n",
274 lwp->lpd_obd->obd_name, rc);
279 rc = sptlrpc_lprocfs_cliobd_attach(lwp->lpd_obd);
281 CERROR("%s: sptlrpc_lprocfs_cliobd_attached failed. %d\n",
282 lwp->lpd_obd->obd_name, rc);
287 ptlrpc_lprocfs_register_obd(lwp->lpd_obd);
293 * Implementation of lu_device_type_operations::ldto_device_free.
297 * \param[in] env environment passed by caller
298 * \param[in] lu device to be freed
300 * \retval NULL to indicate that this is the bottom device
301 * of the stack and there are no more devices
302 * below this one to be cleaned up.
304 static struct lu_device *lwp_device_free(const struct lu_env *env,
305 struct lu_device *lu)
307 struct lwp_device *m = lu2lwp_dev(lu);
310 if (atomic_read(&lu->ld_ref) && lu->ld_site) {
311 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_ERROR, NULL);
312 lu_site_print(env, lu->ld_site, &msgdata, lu_cdebug_printer);
314 lu_device_fini(&m->lpd_dev);
320 * Implementation of lu_device_type_operations::ldto_device_alloc.
322 * Allocate a LWP device.
324 * \param[in] env environment passed by caller
325 * \param[in] ldt device type whose name is LUSTRE_LWP_NAME
326 * \param[in] lcfg lustre_cfg contains remote target UUID
328 * \retval pointer of allocated LWP device on success
329 * \retval ERR_PTR(errno) on error
331 static struct lu_device *lwp_device_alloc(const struct lu_env *env,
332 struct lu_device_type *ldt,
333 struct lustre_cfg *lcfg)
335 struct lwp_device *lwp;
336 struct lu_device *ludev;
340 ludev = ERR_PTR(-ENOMEM);
344 ludev = lwp2lu_dev(lwp);
345 lu_device_init(&lwp->lpd_dev, ldt);
346 rc = lwp_init0(env, lwp, ldt, lcfg);
348 lwp_device_free(env, ludev);
357 * Implementation of lu_device_type_operations::ltdo_device_fini.
359 * Finalize LWP device.
361 * \param[in] env environment passed by caller
362 * \param[in] ludev device to be finalized
364 * \retval NULL on success
366 static struct lu_device *lwp_device_fini(const struct lu_env *env,
367 struct lu_device *ludev)
369 struct lwp_device *m = lu2lwp_dev(ludev);
370 struct ptlrpc_thread *thread = &m->lpd_notify_thread;
371 struct l_wait_info lwi = { 0 };
375 if (!thread_is_stopped(thread))
376 l_wait_event(thread->t_ctl_waitq, thread_is_stopped(thread),
379 if (m->lpd_exp != NULL)
380 class_disconnect(m->lpd_exp);
383 ptlrpc_lprocfs_unregister_obd(m->lpd_obd);
385 rc = client_obd_cleanup(m->lpd_obd);
386 LASSERTF(rc == 0, "error %d\n", rc);
393 static struct lu_device_type_operations lwp_device_type_ops = {
394 .ldto_device_alloc = lwp_device_alloc,
395 .ldto_device_free = lwp_device_free,
396 .ldto_device_fini = lwp_device_fini
399 struct lu_device_type lwp_device_type = {
400 .ldt_tags = LU_DEVICE_DT,
401 .ldt_name = LUSTRE_LWP_NAME,
402 .ldt_ops = &lwp_device_type_ops,
403 .ldt_ctx_tags = LCT_MD_THREAD
406 static int lwp_notify_main(void *args)
408 struct obd_export *exp = (struct obd_export *)args;
409 struct lwp_device *lwp;
410 struct ptlrpc_thread *thread;
412 LASSERT(exp != NULL);
413 class_export_get(exp);
415 lwp = lu2lwp_dev(exp->exp_obd->obd_lu_dev);
416 thread = &lwp->lpd_notify_thread;
418 thread_set_flags(thread, SVC_RUNNING);
419 wake_up(&thread->t_ctl_waitq);
421 lustre_notify_lwp_list(exp);
423 class_export_put(exp);
424 thread_set_flags(thread, SVC_STOPPED);
425 wake_up(&thread->t_ctl_waitq);
430 * Some notify callbacks may cause deadlock in failover
431 * scenario, so we have to start thread to run callbacks
432 * asynchronously. See LU-6273.
434 static void lwp_notify_users(struct obd_export *exp)
436 struct lwp_device *lwp;
437 struct ptlrpc_thread *thread;
438 struct task_struct *task;
439 struct l_wait_info lwi = { 0 };
440 char name[MTI_NAME_MAXLEN];
442 LASSERT(exp != NULL);
443 lwp = lu2lwp_dev(exp->exp_obd->obd_lu_dev);
444 thread = &lwp->lpd_notify_thread;
446 snprintf(name, MTI_NAME_MAXLEN, "lwp_notify_%s",
447 exp->exp_obd->obd_name);
449 /* Notify happens only on LWP setup, so there shouldn't
450 * be notify thread running */
451 if (!thread_is_stopped(thread)) {
452 CERROR("LWP notify thread: %s wasn't stopped\n", name);
456 task = kthread_run(lwp_notify_main, exp, name);
458 thread_set_flags(thread, SVC_STOPPED);
459 CERROR("Failed to start LWP notify thread:%s. %lu\n",
460 name, PTR_ERR(task));
463 l_wait_event(thread->t_ctl_waitq,
464 thread_is_running(thread) || thread_is_stopped(thread),
469 * Implementation of OBD device operations obd_ops::o_connect.
471 * Create export for LWP, and connect to target server.
473 * \param[in] env the environment passed by caller
474 * \param[out] exp export for the connection to be established
475 * \param[in] obd OBD device to perform the connect on
476 * \param[in] cluuid UUID of the OBD device
477 * \param[in] data connect data containing compatibility flags
478 * \param[in] localdata not used
480 * \retval 0 on success
481 * \retval negative number on error
483 static int lwp_obd_connect(const struct lu_env *env, struct obd_export **exp,
484 struct obd_device *obd, struct obd_uuid *cluuid,
485 struct obd_connect_data *data, void *localdata)
487 struct lwp_device *lwp = lu2lwp_dev(obd->obd_lu_dev);
488 struct client_obd *cli = &lwp->lpd_obd->u.cli;
489 struct obd_import *imp = cli->cl_import;
490 struct obd_connect_data *ocd;
491 struct lustre_handle conn;
496 CDEBUG(D_CONFIG, "connect #%d\n", lwp->lpd_connects);
499 down_write(&cli->cl_sem);
500 rc = class_connect(&conn, obd, cluuid);
504 *exp = class_conn2export(&conn);
508 LASSERT(lwp->lpd_connects == 1);
510 imp->imp_dlm_handle = conn;
511 rc = ptlrpc_init_import(imp);
515 LASSERT(data != NULL);
516 ocd = &imp->imp_connect_data;
519 LASSERT(ocd->ocd_connect_flags & OBD_CONNECT_LIGHTWEIGHT);
521 ocd->ocd_version = LUSTRE_VERSION_CODE;
522 imp->imp_connect_flags_orig = ocd->ocd_connect_flags;
523 imp->imp_connect_flags2_orig = ocd->ocd_connect_flags2;
525 rc = ptlrpc_connect_import(imp);
527 CERROR("%s: can't connect obd: rc = %d\n", obd->obd_name, rc);
531 ptlrpc_pinger_add_import(imp);
533 GOTO(out_dis, rc = 0);
537 class_disconnect(*exp);
543 up_write(&cli->cl_sem);
546 lwp_notify_users(*exp);
552 * Implementation of OBD device operations obd_ops::o_disconnect.
554 * Release export for the LWP. Only disconnect the underlying layers
555 * on the final disconnect.
557 * \param[in] exp the export to perform disconnect on
559 * \retval 0 on success
560 * \retval negative number on error
562 static int lwp_obd_disconnect(struct obd_export *exp)
564 struct obd_device *obd = exp->exp_obd;
565 struct lwp_device *lwp = lu2lwp_dev(obd->obd_lu_dev);
569 LASSERT(lwp->lpd_connects == 1);
572 rc = class_disconnect(exp);
574 CERROR("%s: class disconnect error: rc = %d\n",
581 * Handle import events for the LWP device.
583 * \param[in] obd OBD device associated with the import
584 * \param[in] imp the import which event happened on
585 * \param[in] event event type
587 * \retval 0 on success
588 * \retval negative number on error
590 static int lwp_import_event(struct obd_device *obd, struct obd_import *imp,
591 enum obd_import_event event)
594 case IMP_EVENT_DISCON:
595 case IMP_EVENT_INACTIVE:
596 case IMP_EVENT_ACTIVE:
598 case IMP_EVENT_INVALIDATE:
599 if (obd->obd_namespace == NULL)
601 ldlm_namespace_cleanup(obd->obd_namespace, LDLM_FL_LOCAL_ONLY);
606 CERROR("%s: unsupported import event: %#x\n",
607 obd->obd_name, event);
612 static int lwp_set_info_async(const struct lu_env *env,
613 struct obd_export *exp,
614 u32 keylen, void *key,
615 u32 vallen, void *val,
616 struct ptlrpc_request_set *set)
620 if (KEY_IS(KEY_SPTLRPC_CONF)) {
621 sptlrpc_conf_client_adapt(exp->exp_obd);
625 CERROR("Unknown key %s\n", (char *)key);
629 struct obd_ops lwp_obd_device_ops = {
630 .o_owner = THIS_MODULE,
631 .o_add_conn = client_import_add_conn,
632 .o_del_conn = client_import_del_conn,
633 .o_connect = lwp_obd_connect,
634 .o_disconnect = lwp_obd_disconnect,
635 .o_import_event = lwp_import_event,
636 .o_set_info_async = lwp_set_info_async,