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, see
18 * http://www.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2017, Commissariat a l'Energie Atomique et aux Energies
26 * Copyright (c) 2017, Intel Corporation.
28 * Author: Henri Doreau <henri.doreau@cea.fr>
31 #define DEBUG_SUBSYSTEM S_MDC
33 #include <linux/init.h>
34 #include <linux/kthread.h>
35 #include <linux/poll.h>
36 #include <linux/device.h>
37 #include <linux/cdev.h>
38 #include <linux/idr.h>
40 #include <lustre_log.h>
41 #include <uapi/linux/lustre/lustre_ioctl.h>
43 #include "mdc_internal.h"
47 * -- Changelog delivery through character device --
51 * Mutex to protect chlg_registered_devices below
53 static DEFINE_MUTEX(chlg_registered_dev_lock);
56 * Global linked list of all registered devices (one per MDT).
58 static LIST_HEAD(chlg_registered_devices);
61 struct chlg_registered_dev {
62 /* Device name of the form "changelog-{MDTNAME}" */
64 /* changelog char device */
66 struct device ced_device;
67 /* OBDs referencing this device (multiple mount point) */
68 struct list_head ced_obds;
69 /* Reference counter for proper deregistration */
71 /* Link within the global chlg_registered_devices */
72 struct list_head ced_link;
75 struct chlg_reader_state {
76 /* Shortcut to the corresponding OBD device */
77 struct obd_device *crs_obd;
78 /* the corresponding chlg_registered_dev */
79 struct chlg_registered_dev *crs_ced;
80 /* Producer thread (if any) */
81 struct task_struct *crs_prod_task;
82 /* An error occurred that prevents from reading further */
84 /* EOF, no more records available */
86 /* Desired start position */
87 __u64 crs_start_offset;
88 /* Wait queue for the catalog processing thread */
89 wait_queue_head_t crs_waitq_prod;
90 /* Wait queue for the record copy threads */
91 wait_queue_head_t crs_waitq_cons;
92 /* Mutex protecting crs_rec_count and crs_rec_queue */
93 struct mutex crs_lock;
94 /* Number of item in the list */
96 /* List of prefetched enqueued_record::enq_linkage_items */
97 struct list_head crs_rec_queue;
98 unsigned int crs_last_catidx;
99 unsigned int crs_last_idx;
103 struct chlg_rec_entry {
104 /* Link within the chlg_reader_state::crs_rec_queue list */
105 struct list_head enq_linkage;
106 /* Data (enq_record) field length */
108 /* Copy of a changelog record (see struct llog_changelog_rec) */
109 struct changelog_rec enq_record[];
113 /* Number of records to prefetch locally. */
114 CDEV_CHLG_MAX_PREFETCH = 1024,
117 DEFINE_IDR(mdc_changelog_minor_idr);
118 static DEFINE_SPINLOCK(chlg_minor_lock);
120 static int chlg_minor_alloc(int *pminor)
122 void *minor_allocated = (void *)-1;
125 idr_preload(GFP_KERNEL);
126 spin_lock(&chlg_minor_lock);
127 minor = idr_alloc(&mdc_changelog_minor_idr, minor_allocated, 0,
128 MDC_CHANGELOG_DEV_COUNT, GFP_NOWAIT);
129 spin_unlock(&chlg_minor_lock);
139 static void chlg_minor_free(int minor)
141 spin_lock(&chlg_minor_lock);
142 idr_remove(&mdc_changelog_minor_idr, minor);
143 spin_unlock(&chlg_minor_lock);
146 static void chlg_device_release(struct device *dev)
148 struct chlg_registered_dev *entry = dev_get_drvdata(dev);
150 chlg_minor_free(MINOR(entry->ced_cdev.dev));
155 * Deregister a changelog character device whose refcount has reached zero.
157 static void chlg_dev_clear(struct kref *kref)
159 struct chlg_registered_dev *entry;
162 entry = container_of(kref, struct chlg_registered_dev,
165 list_del(&entry->ced_link);
166 cdev_device_del(&entry->ced_cdev, &entry->ced_device);
167 put_device(&entry->ced_device);
171 static inline struct obd_device* chlg_obd_get(struct chlg_registered_dev *dev)
173 struct obd_device *obd;
175 mutex_lock(&chlg_registered_dev_lock);
176 if (list_empty(&dev->ced_obds))
179 obd = list_first_entry(&dev->ced_obds, struct obd_device,
180 u.cli.cl_chg_dev_linkage);
181 class_incref(obd, "changelog", dev);
182 mutex_unlock(&chlg_registered_dev_lock);
186 static inline void chlg_obd_put(struct chlg_registered_dev *dev,
187 struct obd_device *obd)
189 class_decref(obd, "changelog", dev);
193 * ChangeLog catalog processing callback invoked on each record.
194 * If the current record is eligible to userland delivery, push
195 * it into the crs_rec_queue where the consumer code will fetch it.
197 * @param[in] env (unused)
198 * @param[in] llh Client-side handle used to identify the llog
199 * @param[in] hdr Header of the current llog record
200 * @param[in,out] data chlg_reader_state passed from caller
202 * @return 0 or LLOG_PROC_* control code on success, negated error on failure.
204 static int chlg_read_cat_process_cb(const struct lu_env *env,
205 struct llog_handle *llh,
206 struct llog_rec_hdr *hdr, void *data)
208 struct llog_changelog_rec *rec;
209 struct chlg_reader_state *crs = data;
210 struct chlg_rec_entry *enq;
215 LASSERT(crs != NULL);
216 LASSERT(hdr != NULL);
218 rec = container_of(hdr, struct llog_changelog_rec, cr_hdr);
220 crs->crs_last_catidx = llh->lgh_hdr->llh_cat_idx;
221 crs->crs_last_idx = hdr->lrh_index;
223 if (rec->cr_hdr.lrh_type != CHANGELOG_REC) {
225 CERROR("%s: not a changelog rec %x/%d in llog : rc = %d\n",
226 crs->crs_obd->obd_name, rec->cr_hdr.lrh_type,
227 rec->cr.cr_type, rc);
231 /* Skip undesired records */
232 if (rec->cr.cr_index < crs->crs_start_offset)
235 CDEBUG(D_HSM, "%llu %02d%-5s %llu 0x%x t="DFID" p="DFID" %.*s\n",
236 rec->cr.cr_index, rec->cr.cr_type,
237 changelog_type2str(rec->cr.cr_type), rec->cr.cr_time,
238 rec->cr.cr_flags & CLF_FLAGMASK,
239 PFID(&rec->cr.cr_tfid), PFID(&rec->cr.cr_pfid),
240 rec->cr.cr_namelen, changelog_rec_name(&rec->cr));
242 wait_event_interruptible(crs->crs_waitq_prod,
243 crs->crs_rec_count < CDEV_CHLG_MAX_PREFETCH ||
244 kthread_should_stop());
246 if (kthread_should_stop())
247 RETURN(LLOG_PROC_BREAK);
249 len = changelog_rec_size(&rec->cr) + rec->cr.cr_namelen;
250 OBD_ALLOC(enq, sizeof(*enq) + len);
254 INIT_LIST_HEAD(&enq->enq_linkage);
255 enq->enq_length = len;
256 memcpy(enq->enq_record, &rec->cr, len);
258 mutex_lock(&crs->crs_lock);
259 list_add_tail(&enq->enq_linkage, &crs->crs_rec_queue);
260 crs->crs_rec_count++;
261 mutex_unlock(&crs->crs_lock);
263 wake_up(&crs->crs_waitq_cons);
269 * Remove record from the list it is attached to and free it.
271 static void enq_record_delete(struct chlg_rec_entry *rec)
273 list_del(&rec->enq_linkage);
274 OBD_FREE(rec, sizeof(*rec) + rec->enq_length);
278 * Record prefetch thread entry point. Opens the changelog catalog and starts
281 * @param[in,out] args chlg_reader_state passed from caller.
282 * @return 0 on success, negated error code on failure.
284 static int chlg_load(void *args)
286 struct chlg_reader_state *crs = args;
287 struct chlg_registered_dev *ced = crs->crs_ced;
288 struct obd_device *obd = NULL;
289 struct llog_ctxt *ctx = NULL;
290 struct llog_handle *llh = NULL;
294 crs->crs_last_catidx = 0;
295 crs->crs_last_idx = 0;
298 obd = chlg_obd_get(ced);
304 ctx = llog_get_context(obd, LLOG_CHANGELOG_REPL_CTXT);
306 GOTO(err_out, rc = -ENOENT);
308 rc = llog_open(NULL, ctx, &llh, NULL, CHANGELOG_CATALOG,
311 CERROR("%s: fail to open changelog catalog: rc = %d\n",
317 rc = llog_init_handle(NULL, llh,
320 LLOG_F_EXT_EXTRA_FLAGS |
321 LLOG_F_EXT_X_UIDGID |
327 CERROR("%s: fail to init llog handle: rc = %d\n",
332 rc = llog_cat_process(NULL, llh, chlg_read_cat_process_cb, crs,
333 crs->crs_last_catidx, crs->crs_last_idx);
335 CERROR("%s: fail to process llog: rc = %d\n", obd->obd_name, rc);
338 if (!kthread_should_stop() && crs->crs_poll) {
339 llog_cat_close(NULL, llh);
341 class_decref(obd, "changelog", crs);
342 schedule_timeout_interruptible(cfs_time_seconds(1));
352 wake_up(&crs->crs_waitq_cons);
355 llog_cat_close(NULL, llh);
361 chlg_obd_put(ced, obd);
362 wait_event_interruptible(crs->crs_waitq_prod, kthread_should_stop());
367 static int chlg_start_thread(struct file *file)
369 struct chlg_reader_state *crs = file->private_data;
370 struct task_struct *task;
373 if (likely(crs->crs_prod_task))
375 if (unlikely(file->f_mode & FMODE_READ) == 0)
378 mutex_lock(&crs->crs_lock);
379 if (crs->crs_prod_task == NULL) {
380 task = kthread_run(chlg_load, crs, "chlg_load_thread");
383 CERROR("%s: cannot start changelog thread: rc = %d\n",
384 crs->crs_ced->ced_name, rc);
387 crs->crs_prod_task = task;
390 mutex_unlock(&crs->crs_lock);
395 * Read handler, dequeues records from the chlg_reader_state if any.
396 * No partial records are copied to userland so this function can return less
397 * data than required (short read).
399 * @param[in] file File pointer to the character device.
400 * @param[out] buff Userland buffer where to copy the records.
401 * @param[in] count Userland buffer size.
402 * @param[out] ppos File position, updated with the index number of the next
404 * @return number of copied bytes on success, negated error code on failure.
406 static ssize_t chlg_read(struct file *file, char __user *buff, size_t count,
409 struct chlg_reader_state *crs = file->private_data;
410 struct chlg_rec_entry *rec;
411 struct chlg_rec_entry *tmp;
412 size_t written_total = 0;
417 if (file->f_flags & O_NONBLOCK && crs->crs_rec_count == 0) {
418 if (crs->crs_err < 0)
419 RETURN(crs->crs_err);
420 else if (crs->crs_eof)
426 rc = chlg_start_thread(file);
430 rc = wait_event_interruptible(crs->crs_waitq_cons,
431 crs->crs_rec_count > 0 || crs->crs_eof || crs->crs_err);
433 mutex_lock(&crs->crs_lock);
434 list_for_each_entry_safe(rec, tmp, &crs->crs_rec_queue, enq_linkage) {
435 if (written_total + rec->enq_length > count)
438 if (copy_to_user(buff, rec->enq_record, rec->enq_length)) {
443 buff += rec->enq_length;
444 written_total += rec->enq_length;
446 crs->crs_rec_count--;
447 list_move_tail(&rec->enq_linkage, &consumed);
449 crs->crs_start_offset = rec->enq_record->cr_index + 1;
451 mutex_unlock(&crs->crs_lock);
453 if (written_total > 0) {
455 wake_up(&crs->crs_waitq_prod);
456 } else if (rc == 0) {
460 list_for_each_entry_safe(rec, tmp, &consumed, enq_linkage)
461 enq_record_delete(rec);
463 *ppos = crs->crs_start_offset;
469 * Jump to a given record index. Helper for chlg_llseek().
471 * @param[in,out] crs Internal reader state.
472 * @param[in] offset Desired offset (index record).
473 * @return 0 on success, negated error code on failure.
475 static int chlg_set_start_offset(struct chlg_reader_state *crs, __u64 offset)
477 struct chlg_rec_entry *rec;
478 struct chlg_rec_entry *tmp;
480 mutex_lock(&crs->crs_lock);
481 if (offset < crs->crs_start_offset) {
482 mutex_unlock(&crs->crs_lock);
486 crs->crs_start_offset = offset;
487 list_for_each_entry_safe(rec, tmp, &crs->crs_rec_queue, enq_linkage) {
488 struct changelog_rec *cr = rec->enq_record;
490 if (cr->cr_index >= crs->crs_start_offset)
493 crs->crs_rec_count--;
494 enq_record_delete(rec);
497 mutex_unlock(&crs->crs_lock);
498 wake_up(&crs->crs_waitq_prod);
503 * Move read pointer to a certain record index, encoded as an offset.
505 * @param[in,out] file File pointer to the changelog character device
506 * @param[in] off Offset to skip, actually a record index, not byte count
507 * @param[in] whence Relative/Absolute interpretation of the offset
508 * @return the resulting position on success or negated error code on failure.
510 static loff_t chlg_llseek(struct file *file, loff_t off, int whence)
512 struct chlg_reader_state *crs = file->private_data;
521 pos = file->f_pos + off;
528 /* We cannot go backward */
529 if (pos < file->f_pos)
532 rc = chlg_set_start_offset(crs, pos);
541 * Clear record range for a given changelog reader.
543 * @param[in] crs Current internal state.
544 * @param[in] reader Changelog reader ID (cl1, cl2...)
545 * @param[in] record Record index up which to clear
546 * @return 0 on success, negated error code on failure.
548 static int chlg_clear(struct chlg_reader_state *crs, __u32 reader, __u64 record)
550 struct obd_device *obd = NULL;
551 struct changelog_setinfo cs = {
557 obd = chlg_obd_get(crs->crs_ced);
561 rc = obd_set_info_async(NULL, obd->obd_self_export,
562 strlen(KEY_CHANGELOG_CLEAR),
563 KEY_CHANGELOG_CLEAR, sizeof(cs), &cs, NULL);
565 chlg_obd_put(crs->crs_ced, obd);
569 /** Maximum changelog control command size */
570 #define CHLG_CONTROL_CMD_MAX 64
573 * Handle writes() into the changelog character device. Write() can be used
574 * to request special control operations.
576 * @param[in] file File pointer to the changelog character device
577 * @param[in] buff User supplied data (written data)
578 * @param[in] count Number of written bytes
579 * @param[in] off (unused)
580 * @return number of written bytes on success, negated error code on failure.
582 static ssize_t chlg_write(struct file *file, const char __user *buff,
583 size_t count, loff_t *off)
585 struct chlg_reader_state *crs = file->private_data;
592 if (count > CHLG_CONTROL_CMD_MAX)
595 OBD_ALLOC(kbuf, CHLG_CONTROL_CMD_MAX);
599 if (copy_from_user(kbuf, buff, count))
600 GOTO(out_kbuf, rc = -EFAULT);
602 kbuf[CHLG_CONTROL_CMD_MAX - 1] = '\0';
604 if (sscanf(kbuf, "clear:cl%u:%llu", &reader, &record) == 2)
605 rc = chlg_clear(crs, reader, record);
611 OBD_FREE(kbuf, CHLG_CONTROL_CMD_MAX);
612 return rc < 0 ? rc : count;
616 * Open handler, initialize internal CRS state and spawn prefetch thread if
618 * @param[in] inode Inode struct for the open character device.
619 * @param[in] file Corresponding file pointer.
620 * @return 0 on success, negated error code on failure.
622 static int chlg_open(struct inode *inode, struct file *file)
624 struct chlg_reader_state *crs;
625 struct chlg_registered_dev *dev;
628 dev = container_of(inode->i_cdev, struct chlg_registered_dev, ced_cdev);
634 kref_get(&dev->ced_refs);
636 crs->crs_err = false;
637 crs->crs_eof = false;
639 mutex_init(&crs->crs_lock);
640 INIT_LIST_HEAD(&crs->crs_rec_queue);
641 init_waitqueue_head(&crs->crs_waitq_prod);
642 init_waitqueue_head(&crs->crs_waitq_cons);
643 crs->crs_prod_task = NULL;
645 file->private_data = crs;
650 * Close handler, release resources.
652 * @param[in] inode Inode struct for the open character device.
653 * @param[in] file Corresponding file pointer.
654 * @return 0 on success, negated error code on failure.
656 static int chlg_release(struct inode *inode, struct file *file)
658 struct chlg_reader_state *crs = file->private_data;
659 struct chlg_rec_entry *rec;
660 struct chlg_rec_entry *tmp;
663 if (crs->crs_prod_task)
664 rc = kthread_stop(crs->crs_prod_task);
666 list_for_each_entry_safe(rec, tmp, &crs->crs_rec_queue, enq_linkage)
667 enq_record_delete(rec);
669 kref_put(&crs->crs_ced->ced_refs, chlg_dev_clear);
676 * Poll handler, indicates whether the device is readable (new records) and
679 * @param[in] file Device file pointer.
680 * @param[in] wait (opaque)
681 * @return combination of the poll status flags.
683 static unsigned int chlg_poll(struct file *file, poll_table *wait)
685 struct chlg_reader_state *crs = file->private_data;
686 unsigned int mask = 0;
689 rc = chlg_start_thread(file);
693 mutex_lock(&crs->crs_lock);
694 poll_wait(file, &crs->crs_waitq_cons, wait);
695 if (crs->crs_rec_count > 0)
696 mask |= POLLIN | POLLRDNORM;
701 mutex_unlock(&crs->crs_lock);
705 static long chlg_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
709 struct chlg_reader_state *crs = file->private_data;
711 case OBD_IOC_CHLG_POLL:
712 crs->crs_poll = !!arg;
722 static const struct file_operations chlg_fops = {
723 .owner = THIS_MODULE,
724 .llseek = chlg_llseek,
728 .release = chlg_release,
730 .unlocked_ioctl = chlg_ioctl,
734 * This uses obd_name of the form: "testfs-MDT0000-mdc-ffff88006501600"
735 * and returns a name of the form: "changelog-testfs-MDT0000".
737 static void get_target_name(char *name, size_t name_len, struct obd_device *obd)
741 snprintf(name, name_len, "%s", obd->obd_name);
743 /* Find the 2nd '-' from the end and truncate on it */
744 for (i = 0; i < 2; i++) {
745 char *p = strrchr(name, '-');
754 * Find a changelog character device by name.
755 * All devices registered during MDC setup are listed in a global list with
756 * their names attached.
758 static struct chlg_registered_dev *
759 chlg_registered_dev_find_by_name(const char *name)
761 struct chlg_registered_dev *dit;
763 LASSERT(mutex_is_locked(&chlg_registered_dev_lock));
764 list_for_each_entry(dit, &chlg_registered_devices, ced_link)
765 if (strcmp(name, dit->ced_name) == 0)
771 * Find chlg_registered_dev structure for a given OBD device.
772 * This is bad O(n^2) but for each filesystem:
773 * - N is # of MDTs times # of mount points
774 * - this only runs at shutdown
776 static struct chlg_registered_dev *
777 chlg_registered_dev_find_by_obd(const struct obd_device *obd)
779 struct chlg_registered_dev *dit;
780 struct obd_device *oit;
782 LASSERT(mutex_is_locked(&chlg_registered_dev_lock));
783 list_for_each_entry(dit, &chlg_registered_devices, ced_link)
784 list_for_each_entry(oit, &dit->ced_obds,
785 u.cli.cl_chg_dev_linkage)
792 * Changelog character device initialization.
793 * Register a misc character device with a dynamic minor number, under a name
794 * of the form: 'changelog-fsname-MDTxxxx'. Reference this OBD device with it.
796 * @param[in] obd This MDC obd_device.
797 * @return 0 on success, negated error code on failure.
799 int mdc_changelog_cdev_init(struct obd_device *obd)
801 struct chlg_registered_dev *exist;
802 struct chlg_registered_dev *entry;
806 OBD_ALLOC_PTR(entry);
810 get_target_name(entry->ced_name, sizeof(entry->ced_name), obd);
812 kref_init(&entry->ced_refs);
813 INIT_LIST_HEAD(&entry->ced_obds);
814 INIT_LIST_HEAD(&entry->ced_link);
816 mutex_lock(&chlg_registered_dev_lock);
817 exist = chlg_registered_dev_find_by_name(entry->ced_name);
819 kref_get(&exist->ced_refs);
820 list_add_tail(&obd->u.cli.cl_chg_dev_linkage, &exist->ced_obds);
821 GOTO(out_unlock, rc = 0);
824 list_add_tail(&obd->u.cli.cl_chg_dev_linkage, &entry->ced_obds);
825 list_add_tail(&entry->ced_link, &chlg_registered_devices);
827 rc = chlg_minor_alloc(&minor);
829 GOTO(out_unlock, rc);
831 device_initialize(&entry->ced_device);
832 entry->ced_device.devt = MKDEV(MAJOR(mdc_changelog_dev), minor);
833 entry->ced_device.class = mdc_changelog_class;
834 entry->ced_device.release = chlg_device_release;
835 dev_set_drvdata(&entry->ced_device, entry);
836 rc = dev_set_name(&entry->ced_device, "%s-%s", MDC_CHANGELOG_DEV_NAME,
841 /* Register new character device */
842 cdev_init(&entry->ced_cdev, &chlg_fops);
843 entry->ced_cdev.owner = THIS_MODULE;
844 rc = cdev_device_add(&entry->ced_cdev, &entry->ced_device);
846 GOTO(out_device_name, rc);
848 entry = NULL; /* prevent it from being freed below */
849 GOTO(out_unlock, rc = 0);
852 kfree_const(entry->ced_device.kobj.name);
855 chlg_minor_free(minor);
857 list_del_init(&obd->u.cli.cl_chg_dev_linkage);
858 list_del(&entry->ced_link);
861 mutex_unlock(&chlg_registered_dev_lock);
868 * Release OBD, decrease reference count of the corresponding changelog device.
870 void mdc_changelog_cdev_finish(struct obd_device *obd)
872 struct chlg_registered_dev *dev;
875 mutex_lock(&chlg_registered_dev_lock);
876 dev = chlg_registered_dev_find_by_obd(obd);
877 list_del_init(&obd->u.cli.cl_chg_dev_linkage);
878 kref_put(&dev->ced_refs, chlg_dev_clear);
879 mutex_unlock(&chlg_registered_dev_lock);