relay_subbufs_consumed – update the buffer’s sub-buffers-consumed count Synopsis void relay_subbufs_consumed(struct rchan *chan, unsigned int cpu, size_t subbufs_consumed); Arguments chan the channel cpu the cpu associated with the channel buffer to update subbufs_consumed number of sub-buffers to add to current buf’s count Description Adds to the channel buffer’s consumed sub-buffer count. subbufs_consumed should be the number…
relay_reset – reset the channel Synopsis void relay_reset(struct rchan *chan); Arguments chan the channel Description This has the effect of erasing all data from all channel buffers and restarting the channel in its initial state. The buffers are not freed, so any mappings are still in effect. NOTE. Care should be taken that the channel…
relay_remove_buf – remove a channel buffer Synopsis void relay_remove_buf(struct kref *kref); Arguments kref target kernel reference that contains the relay buffer Description Removes the file from the filesystem, which also frees the rchan_buf_struct and the channel buffer. Should only be called from kref_put. Copyright
relay_open – create a new relay channel Synopsis struct rchan *relay_open(const char *base_filename, struct dentry *parent, size_t subbuf_size, size_t n_subbufs, struct rchan_callbacks *cb, void *private_data); Arguments base_filename base name of files to create, NULL for buffering only parent dentry of parent directory, NULL for root directory or buffer subbuf_size size of sub-buffers n_subbufs number of…
relay_mmap_buf – mmap channel buffer to process address space Synopsis int relay_mmap_buf(struct rchan_buf *buf, struct vm_area_struct *vma); Arguments buf relay channel buffer vma vm_area_struct describing memory to be mapped Description Returns 0 if ok, negative on error Caller should already have grabbed mmap_sem. Copyright
relay_late_setup_files – triggers file creation Synopsis int relay_late_setup_files(struct rchan *chan, const char *base_filename, struct dentry *parent); Arguments chan channel to operate on base_filename base name of files to create parent dentry of parent directory, NULL for root directory Description Returns 0 if successful, non-zero otherwise. Use to setup files for a previously buffer-only channel created…
relay_flush – close the channel Synopsis void relay_flush(struct rchan *chan); Arguments chan the channel Description Flushes all channel buffers, i.e. forces buffer switch. Copyright
relay_file_release – release file op for relay files Synopsis int relay_file_release(struct inode *inode, struct file *filp); Arguments inode the inode filp the file Description Decrements the channel refcount, as the filesystem is no longer using it. Copyright
relay_file_read_subbuf_avail – return bytes available in sub-buffer Synopsis size_t relay_file_read_subbuf_avail(size_t read_pos, struct rchan_buf *buf); Arguments read_pos file read position buf relay channel buffer Copyright
relay_file_read_start_pos – find the first available byte to read Synopsis size_t relay_file_read_start_pos(size_t read_pos, struct rchan_buf *buf); Arguments read_pos file read position buf relay channel buffer Description If the read_pos is in the middle of padding, return the position of the first actually available byte, otherwise return the original value. Copyright
relay_file_read_end_pos – return the new read position Synopsis size_t relay_file_read_end_pos(struct rchan_buf *buf, size_t read_pos, size_t count); Arguments buf relay channel buffer read_pos file read position count number of bytes to be read Copyright
relay_file_poll – poll file op for relay files Synopsis unsigned int relay_file_poll(struct file *filp, poll_table *wait); Arguments filp the file wait poll table Description Poll implemention. Copyright
relay_file_open – open file op for relay files Synopsis int relay_file_open(struct inode *inode, struct file *filp); Arguments inode the inode filp the file Description Increments the channel buffer refcount. Copyright
relay_file_mmap – mmap file op for relay files Synopsis int relay_file_mmap(struct file *filp, struct vm_area_struct *vma); Arguments filp the file vma the vma describing what to map Description Calls upon relay_mmap_buf to map the file into user space. Copyright
relay_destroy_channel – free the channel struct Synopsis void relay_destroy_channel(struct kref *kref); Arguments kref target kernel reference that contains the relay channel Description Should only be called from kref_put. Copyright
relay_destroy_buf – destroy an rchan_buf struct and associated buffer Synopsis void relay_destroy_buf(struct rchan_buf *buf); Arguments buf the buffer struct Copyright
relay_create_buf – allocate and initialize a channel buffer Synopsis struct rchan_buf *relay_create_buf(struct rchan *chan); Arguments chan the relay channel Description Returns channel buffer if successful, NULL otherwise. Copyright
relay_close_buf – close a channel buffer Synopsis void relay_close_buf(struct rchan_buf *buf); Arguments buf channel buffer Description Marks the buffer finalized and restores the default callbacks. The channel buffer and channel buffer data structure are then freed automatically when the last reference is given up. Copyright
relay_close – close the channel Synopsis void relay_close(struct rchan *chan); Arguments chan the channel Description Closes all channel buffers and frees the channel. Copyright
relay_buf_full – boolean, is the channel buffer full? Synopsis int relay_buf_full(struct rchan_buf *buf); Arguments buf channel buffer Description Returns 1 if the buffer is full, 0 otherwise. Copyright