include/linux/relayfs_fs.h

   1 /*
   2  * linux/include/linux/relayfs_fs.h
   3  *
   4  * Copyright (C) 2002, 2003 - Tom Zanussi (zanussi@us.ibm.com), IBM Corp
   5  * Copyright (C) 1999, 2000, 2001, 2002 - Karim Yaghmour (karim@opersys.com)
   6  *
   7  * RelayFS definitions and declarations
   8  */
   9
  10 #ifndef _LINUX_RELAYFS_FS_H
  11 #define _LINUX_RELAYFS_FS_H
  12
  13 #include <linux/config.h>
  14 #include <linux/types.h>
  15 #include <linux/sched.h>
  16 #include <linux/wait.h>
  17 #include <linux/list.h>
  18 #include <linux/fs.h>
  19 #include <linux/poll.h>
  20 #include <linux/kref.h>
  21
  22 /*
  23  * Tracks changes to rchan/rchan_buf structs
  24  */
  25 #define RELAYFS_CHANNEL_VERSION         6
  26
  27 /*
  28  * Per-cpu relay channel buffer
  29  */
  30 struct rchan_buf
  31 {
  32         void *start;                    /* start of channel buffer */
  33         void *data;                     /* start of current sub-buffer */
  34         size_t offset;                  /* current offset into sub-buffer */
  35         size_t subbufs_produced;        /* count of sub-buffers produced */
  36         size_t subbufs_consumed;        /* count of sub-buffers consumed */
  37         struct rchan *chan;             /* associated channel */
  38         wait_queue_head_t read_wait;    /* reader wait queue */
  39         struct work_struct wake_readers; /* reader wake-up work struct */
  40         struct dentry *dentry;          /* channel file dentry */
  41         struct kref kref;               /* channel buffer refcount */
  42         struct page **page_array;       /* array of current buffer pages */
  43         unsigned int page_count;        /* number of current buffer pages */
  44         unsigned int finalized;         /* buffer has been finalized */
  45         size_t *padding;                /* padding counts per sub-buffer */
  46         size_t prev_padding;            /* temporary variable */
  47         size_t bytes_consumed;          /* bytes consumed in cur read subbuf */
  48         unsigned int cpu;               /* this buf's cpu */
  49 } ____cacheline_aligned;
  50
  51 /*
  52  * Relay channel data structure
  53  */
  54 struct rchan
  55 {
  56         u32 version;                    /* the version of this struct */
  57         size_t subbuf_size;             /* sub-buffer size */
  58         size_t n_subbufs;               /* number of sub-buffers per buffer */
  59         size_t alloc_size;              /* total buffer size allocated */
  60         struct rchan_callbacks *cb;     /* client callbacks */
  61         struct kref kref;               /* channel refcount */
  62         void *private_data;             /* for user-defined data */
  63         size_t last_toobig;             /* tried to log event > subbuf size */
  64         struct rchan_buf *buf[NR_CPUS]; /* per-cpu channel buffers */
  65 };
  66
  67 /*
  68  * Relayfs inode
  69  */
  70 struct relayfs_inode_info
  71 {
  72         struct inode vfs_inode;
  73         struct rchan_buf *buf;
  74 };
  75
  76 static inline struct relayfs_inode_info *RELAYFS_I(struct inode *inode)
  77 {
  78         return container_of(inode, struct relayfs_inode_info, vfs_inode);
  79 }
  80
  81 /*
  82  * Relay channel client callbacks
  83  */
  84 struct rchan_callbacks
  85 {
  86         /*
  87          * subbuf_start - called on buffer-switch to a new sub-buffer
  88          * @buf: the channel buffer containing the new sub-buffer
  89          * @subbuf: the start of the new sub-buffer
  90          * @prev_subbuf: the start of the previous sub-buffer
  91          * @prev_padding: unused space at the end of previous sub-buffer
  92          *
  93          * The client should return 1 to continue logging, 0 to stop
  94          * logging.
  95          *
  96          * NOTE: subbuf_start will also be invoked when the buffer is
  97          *       created, so that the first sub-buffer can be initialized
  98          *       if necessary.  In this case, prev_subbuf will be NULL.
  99          *
 100          * NOTE: the client can reserve bytes at the beginning of the new
 101          *       sub-buffer by calling subbuf_start_reserve() in this callback.
 102          */
 103         int (*subbuf_start) (struct rchan_buf *buf,
 104                              void *subbuf,
 105                              void *prev_subbuf,
 106                              size_t prev_padding);
 107
 108         /*
 109          * buf_mapped - relayfs buffer mmap notification
 110          * @buf: the channel buffer
 111          * @filp: relayfs file pointer
 112          *
 113          * Called when a relayfs file is successfully mmapped
 114          */
 115         void (*buf_mapped)(struct rchan_buf *buf,
 116                            struct file *filp);
 117
 118         /*
 119          * buf_unmapped - relayfs buffer unmap notification
 120          * @buf: the channel buffer
 121          * @filp: relayfs file pointer
 122          *
 123          * Called when a relayfs file is successfully unmapped
 124          */
 125         void (*buf_unmapped)(struct rchan_buf *buf,
 126                              struct file *filp);
 127 };
 128
 129 /*
 130  * relayfs kernel API, fs/relayfs/relay.c
 131  */
 132
 133 struct rchan *relay_open(const char *base_filename,
 134                          struct dentry *parent,
 135                          size_t subbuf_size,
 136                          size_t n_subbufs,
 137                          struct rchan_callbacks *cb);
 138 extern void relay_close(struct rchan *chan);
 139 extern void relay_flush(struct rchan *chan);
 140 extern void relay_subbufs_consumed(struct rchan *chan,
 141                                    unsigned int cpu,
 142                                    size_t consumed);
 143 extern void relay_reset(struct rchan *chan);
 144 extern int relay_buf_full(struct rchan_buf *buf);
 145
 146 extern size_t relay_switch_subbuf(struct rchan_buf *buf,
 147                                   size_t length);
 148 extern struct dentry *relayfs_create_dir(const char *name,
 149                                          struct dentry *parent);
 150 extern int relayfs_remove_dir(struct dentry *dentry);
 151
 152 /**
 153  *      relay_write - write data into the channel
 154  *      @chan: relay channel
 155  *      @data: data to be written
 156  *      @length: number of bytes to write
 157  *
 158  *      Writes data into the current cpu's channel buffer.
 159  *
 160  *      Protects the buffer by disabling interrupts.  Use this
 161  *      if you might be logging from interrupt context.  Try
 162  *      __relay_write() if you know you won't be logging from
 163  *      interrupt context.
 164  */
 165 static inline void relay_write(struct rchan *chan,
 166                                const void *data,
 167                                size_t length)
 168 {
 169         unsigned long flags;
 170         struct rchan_buf *buf;
 171
 172         local_irq_save(flags);
 173         buf = chan->buf[smp_processor_id()];
 174         if (unlikely(buf->offset + length > chan->subbuf_size))
 175                 length = relay_switch_subbuf(buf, length);
 176         memcpy(buf->data + buf->offset, data, length);
 177         buf->offset += length;
 178         local_irq_restore(flags);
 179 }
 180
 181 /**
 182  *      __relay_write - write data into the channel
 183  *      @chan: relay channel
 184  *      @data: data to be written
 185  *      @length: number of bytes to write
 186  *
 187  *      Writes data into the current cpu's channel buffer.
 188  *
 189  *      Protects the buffer by disabling preemption.  Use
 190  *      relay_write() if you might be logging from interrupt
 191  *      context.
 192  */
 193 static inline void __relay_write(struct rchan *chan,
 194                                  const void *data,
 195                                  size_t length)
 196 {
 197         struct rchan_buf *buf;
 198
 199         buf = chan->buf[get_cpu()];
 200         if (unlikely(buf->offset + length > buf->chan->subbuf_size))
 201                 length = relay_switch_subbuf(buf, length);
 202         memcpy(buf->data + buf->offset, data, length);
 203         buf->offset += length;
 204         put_cpu();
 205 }
 206
 207 /**
 208  *      relay_reserve - reserve slot in channel buffer
 209  *      @chan: relay channel
 210  *      @length: number of bytes to reserve
 211  *
 212  *      Returns pointer to reserved slot, NULL if full.
 213  *
 214  *      Reserves a slot in the current cpu's channel buffer.
 215  *      Does not protect the buffer at all - caller must provide
 216  *      appropriate synchronization.
 217  */
 218 static inline void *relay_reserve(struct rchan *chan, size_t length)
 219 {
 220         void *reserved;
 221         struct rchan_buf *buf = chan->buf[smp_processor_id()];
 222
 223         if (unlikely(buf->offset + length > buf->chan->subbuf_size)) {
 224                 length = relay_switch_subbuf(buf, length);
 225                 if (!length)
 226                         return NULL;
 227         }
 228         reserved = buf->data + buf->offset;
 229         buf->offset += length;
 230
 231         return reserved;
 232 }
 233
 234 /**
 235  *      subbuf_start_reserve - reserve bytes at the start of a sub-buffer
 236  *      @buf: relay channel buffer
 237  *      @length: number of bytes to reserve
 238  *
 239  *      Helper function used to reserve bytes at the beginning of
 240  *      a sub-buffer in the subbuf_start() callback.
 241  */
 242 static inline void subbuf_start_reserve(struct rchan_buf *buf,
 243                                         size_t length)
 244 {
 245         BUG_ON(length >= buf->chan->subbuf_size - 1);
 246         buf->offset = length;
 247 }
 248
 249 /*
 250  * exported relayfs file operations, fs/relayfs/inode.c
 251  */
 252
 253 extern struct file_operations relayfs_file_operations;
 254
 255 #endif /* _LINUX_RELAYFS_FS_H */
 256