src/dirbuf.h
author Tero Marttila <terom@fixme.fi>
Sun, 12 Oct 2008 21:59:52 +0300
changeset 26 61668c57f4bb
parent 7 3a603d755bcb
child 27 461be4cd34a3
permissions -rw-r--r--
preliminary *dir implementation
7
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     1
#ifndef DIRBUF_H
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     2
#define DIRBUF_H
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     3
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     4
/*
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     5
 * Simple dirent building
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     6
 */
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     7
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     8
#include "evfuse.h"
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     9
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    10
/*
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    11
 * Holds the dir entries
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    12
 */ 
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    13
struct dirbuf {
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    14
    char *buf;
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    15
    size_t len;
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    16
    size_t off;
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    17
};
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    18
26
61668c57f4bb preliminary *dir implementation
Tero Marttila <terom@fixme.fi>
parents: 7
diff changeset
    19
// maximum length for a dirbuf name, including NUL byte
61668c57f4bb preliminary *dir implementation
Tero Marttila <terom@fixme.fi>
parents: 7
diff changeset
    20
#define DIRBUF_NAME_MAX 256
61668c57f4bb preliminary *dir implementation
Tero Marttila <terom@fixme.fi>
parents: 7
diff changeset
    21
61668c57f4bb preliminary *dir implementation
Tero Marttila <terom@fixme.fi>
parents: 7
diff changeset
    22
/*
61668c57f4bb preliminary *dir implementation
Tero Marttila <terom@fixme.fi>
parents: 7
diff changeset
    23
 * Estimate how many dir entries will, at most, fit into a difbuf of the given size, based on a minimum filename size.
61668c57f4bb preliminary *dir implementation
Tero Marttila <terom@fixme.fi>
parents: 7
diff changeset
    24
 */
61668c57f4bb preliminary *dir implementation
Tero Marttila <terom@fixme.fi>
parents: 7
diff changeset
    25
size_t difbuf_estimate (size_t req_size, size_t min_namelen);
7
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    26
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    27
/*
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    28
 * Initialize a dirbuf for a request. The dirbuf will be filled with at most req_size bytes of dir entries.
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    29
 */
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    30
int dirbuf_init (struct dirbuf *buf, size_t req_size);
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    31
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    32
/*
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    33
 * Add an dir entry to the dirbuf. The dirbuf should not be full.
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    34
 *
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    35
 * Offsets are followed:
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    36
 *  req_off     - the offset of the first dirent to include
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    37
 *  ent_off     - the offset of this dirent
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    38
 *  next_off    - the offset of the next dirent
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    39
 *
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    40
 * Only the S_IFMT bits of ent_mode are relevant.
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    41
 *
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    42
 * Returns 0 if the ent was added or skipped, -1 on error, 1 if the dirbuf is full (no more ents should be added).
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    43
 */
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    44
int dirbuf_add (fuse_req_t req, off_t req_off, struct dirbuf *buf, off_t ent_off, off_t next_off, const char *ent_name, fuse_ino_t ent_ino, mode_t ent_mode);
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    45
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    46
/*
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    47
 * Attempt to send the readdir reply, free the buf, and return the error code from fuse_reply_buf
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    48
 */
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    49
int dirbuf_done (fuse_req_t req, struct dirbuf *buf);
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    50
3a603d755bcb split off the dirbuf stuff into its own module
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    51
#endif /* DIRBUF_H */