lustre/include/uapi/linux/lustre/lustre_kernelcomm.h

   1 /*
   2  * LGPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library.
  18  *
  19  * LGPL HEADER END
  20  */
  21 /*
  22  * Copyright (c) 2009, 2010, Oracle and/or its affiliates. All rights reserved.
  23  * Use is subject to license terms.
  24  *
  25  * Copyright (c) 2013, Intel Corporation.
  26  */
  27 /*
  28  * This file is part of Lustre, http://www.lustre.org/
  29  *
  30  * Author: Nathan Rutman <nathan.rutman@seagate.com>
  31  *
  32  * Kernel <-> userspace communication routines.
  33  * The definitions below are used in the kernel and userspace.
  34  */
  35
  36 #ifndef __UAPI_KERNELCOMM_H__
  37 #define __UAPI_KERNELCOMM_H__
  38
  39 #include <linux/types.h>
  40
  41 /* KUC message header.
  42  * All current and future KUC messages should use this header.
  43  * To avoid having to include Lustre headers from libcfs, define this here.
  44  */
  45 struct kuc_hdr {
  46         __u16 kuc_magic;
  47         __u8  kuc_transport;  /* Each new Lustre feature should use a different
  48                                  transport */
  49         __u8  kuc_flags;
  50         __u16 kuc_msgtype;    /* Message type or opcode, transport-specific */
  51         __u16 kuc_msglen;     /* Including header */
  52 } __attribute__((aligned(sizeof(__u64))));
  53
  54
  55 #define KUC_MAGIC  0x191C /*Lustre9etLinC */
  56
  57 /* kuc_msgtype values are defined in each transport */
  58 enum kuc_transport_type {
  59         KUC_TRANSPORT_GENERIC   = 1,
  60         KUC_TRANSPORT_HSM       = 2,
  61 };
  62
  63 enum kuc_generic_message_type {
  64         KUC_MSG_SHUTDOWN = 1,
  65 };
  66
  67 /* KUC Broadcast Groups. This determines which userspace process hears which
  68  * messages.  Mutliple transports may be used within a group, or multiple
  69  * groups may use the same transport.  Broadcast
  70  * groups need not be used if e.g. a UID is specified instead;
  71  * use group 0 to signify unicast.
  72  */
  73 #define KUC_GRP_HSM     0x02
  74 #define KUC_GRP_MAX     KUC_GRP_HSM
  75
  76 enum lk_flags {
  77         LK_FLG_STOP     = 0x0001,
  78         LK_FLG_DATANR   = 0x0002,
  79 };
  80 #define LK_NOFD -1U
  81
  82 /* kernelcomm control structure, passed from userspace to kernel.
  83  * For compatibility with old copytools, users who pass ARCHIVE_IDs
  84  * to kernel using lk_data_count and lk_data should fill lk_flags with
  85  * LK_FLG_DATANR. Otherwise kernel will take lk_data_count as bitmap of
  86  * ARCHIVE IDs.
  87  */
  88 struct lustre_kernelcomm {
  89         __u32 lk_wfd;
  90         __u32 lk_rfd;
  91         __u32 lk_uid;
  92         __u32 lk_group;
  93         __u32 lk_data_count;
  94         __u32 lk_flags;
  95         __u32 lk_data[0];
  96 } __attribute__((packed));
  97
  98 #endif  /* __UAPI_KERNELCOMM_H__ */