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.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2009, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2013, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * Author: Nathan Rutman <nathan.rutman@sun.com>
38 * libcfs/include/libcfs/libcfs_kernelcomm.h
40 * Kernel <-> userspace communication routines.
41 * The definitions below are used in the kernel and userspace.
45 #ifndef __LIBCFS_KERNELCOMM_H__
46 #define __LIBCFS_KERNELCOMM_H__
48 #ifndef __LIBCFS_LIBCFS_H__
49 #error Do not #include this file directly. #include <libcfs/libcfs.h> instead
53 /* KUC message header.
54 * All current and future KUC messages should use this header.
55 * To avoid having to include Lustre headers from libcfs, define this here.
59 __u8 kuc_transport; /* Each new Lustre feature should use a different
62 __u16 kuc_msgtype; /* Message type or opcode, transport-specific */
63 __u16 kuc_msglen; /* Including header */
64 } __attribute__((aligned(sizeof(__u64))));
66 #define KUC_CHANGELOG_MSG_MAXSIZE (sizeof(struct kuc_hdr)+CR_MAXSIZE)
68 #define KUC_MAGIC 0x191C /*Lustre9etLinC */
69 #define KUC_FL_BLOCK 0x01 /* Wait for send */
71 /* kuc_msgtype values are defined in each transport */
72 enum kuc_transport_type {
73 KUC_TRANSPORT_GENERIC = 1,
74 KUC_TRANSPORT_HSM = 2,
75 KUC_TRANSPORT_CHANGELOG = 3,
78 enum kuc_generic_message_type {
82 /* prototype for callback function on kuc groups */
83 typedef int (*libcfs_kkuc_cb_t)(void *data, void *cb_arg);
85 /* KUC Broadcast Groups. This determines which userspace process hears which
86 * messages. Mutliple transports may be used within a group, or multiple
87 * groups may use the same transport. Broadcast
88 * groups need not be used if e.g. a UID is specified instead;
89 * use group 0 to signify unicast.
91 #define KUC_GRP_HSM 0x02
92 #define KUC_GRP_MAX KUC_GRP_HSM
95 extern int libcfs_kkuc_msg_put(struct file *fp, void *payload);
96 extern int libcfs_kkuc_group_put(int group, void *payload);
97 extern int libcfs_kkuc_group_add(struct file *fp, int uid, int group,
99 extern int libcfs_kkuc_group_rem(int uid, int group, void **pdata);
100 extern int libcfs_kkuc_group_foreach(int group, libcfs_kkuc_cb_t cb_func,
103 #define LK_FLG_STOP 0x01
106 /* kernelcomm control structure, passed from userspace to kernel */
107 typedef struct lustre_kernelcomm {
114 } __attribute__((packed)) lustre_kernelcomm;
116 /* Userspace methods */
117 extern int libcfs_ukuc_start(lustre_kernelcomm *l, int groups, int rfd_flags);
118 extern int libcfs_ukuc_stop(lustre_kernelcomm *l);
119 int libcfs_ukuc_get_rfd(lustre_kernelcomm *link);
120 extern int libcfs_ukuc_msg_get(lustre_kernelcomm *l, char *buf, int maxsize,
123 #endif /* __LIBCFS_KERNELCOMM_H__ */