← Back to branch summary

~jsvoboda/helenos/dnsr

« back to all changes in this revision

Viewing changes to uspace/lib/bithenge/src/file.c

  • Committer: Jiri Svoboda
  • Date: 2012-11-11 21:31:03 UTC
  • mfrom: (1527.1.178 mainline)
  • Revision ID: jiri@wiwaxia-20121111213103-314bmkettwvlwj97
Merge mainline changes.

Show diffs side-by-side

added added

removed removed

Lines of Context:
uspace/lib/bithenge/src/file.c
 
1
/*
 
2
 * Copyright (c) 2012 Sean Bartell
 
3
 * All rights reserved.
 
4
 *
 
5
 * Redistribution and use in source and binary forms, with or without
 
6
 * modification, are permitted provided that the following conditions
 
7
 * are met:
 
8
 *
 
9
 * - Redistributions of source code must retain the above copyright
 
10
 *   notice, this list of conditions and the following disclaimer.
 
11
 * - Redistributions in binary form must reproduce the above copyright
 
12
 *   notice, this list of conditions and the following disclaimer in the
 
13
 *   documentation and/or other materials provided with the distribution.
 
14
 * - The name of the author may not be used to endorse or promote products
 
15
 *   derived from this software without specific prior written permission.
 
16
 *
 
17
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 
18
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 
19
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 
20
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 
21
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 
22
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 
23
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 
24
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 
25
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 
26
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
27
 */
 
28
 
 
29
/** @addtogroup bithenge
 
30
 * @{
 
31
 */
 
32
/**
 
33
 * @file
 
34
 * Access files as blobs.
 
35
 * @todo Provide more information about the file.
 
36
 */
 
37
 
 
38
#include <assert.h>
 
39
#include <errno.h>
 
40
#include <fcntl.h>
 
41
#include <stdio.h>
 
42
#include <stdlib.h>
 
43
#include <sys/stat.h>
 
44
#include <sys/types.h>
 
45
#include <unistd.h>
 
46
#include "common.h"
 
47
#include <bithenge/blob.h>
 
48
#include <bithenge/file.h>
 
49
 
 
50
typedef struct {
 
51
        bithenge_blob_t base;
 
52
        int fd;
 
53
        aoff64_t size; // needed by file_read()
 
54
        bool needs_close;
 
55
} file_blob_t;
 
56
 
 
57
static inline file_blob_t *blob_as_file(bithenge_blob_t *base)
 
58
{
 
59
        return (file_blob_t *)base;
 
60
}
 
61
 
 
62
static inline bithenge_blob_t *file_as_blob(file_blob_t *blob)
 
63
{
 
64
        return &blob->base;
 
65
}
 
66
 
 
67
static int file_size(bithenge_blob_t *base, aoff64_t *size)
 
68
{
 
69
        file_blob_t *blob = blob_as_file(base);
 
70
        *size = blob->size;
 
71
        return EOK;
 
72
}
 
73
 
 
74
static int file_read(bithenge_blob_t *base, aoff64_t offset, char *buffer,
 
75
    aoff64_t *size)
 
76
{
 
77
        file_blob_t *blob = blob_as_file(base);
 
78
        if (offset > blob->size)
 
79
                return ELIMIT;
 
80
        if (lseek(blob->fd, offset, SEEK_SET) < 0)
 
81
                return errno == EINVAL ? EIO : errno;
 
82
 
 
83
        ssize_t amount_read;
 
84
        aoff64_t remaining_size = *size;
 
85
        *size = 0;
 
86
        do {
 
87
                amount_read = read(blob->fd, buffer, remaining_size);
 
88
                if (amount_read < 0)
 
89
                        return errno;
 
90
                buffer += amount_read;
 
91
                *size += amount_read;
 
92
                remaining_size -= amount_read;
 
93
        } while (remaining_size && amount_read);
 
94
        return EOK;
 
95
}
 
96
 
 
97
static void file_destroy(bithenge_blob_t *base)
 
98
{
 
99
        file_blob_t *blob = blob_as_file(base);
 
100
        close(blob->fd);
 
101
        free(blob);
 
102
}
 
103
 
 
104
static const bithenge_random_access_blob_ops_t file_ops = {
 
105
        .size = file_size,
 
106
        .read = file_read,
 
107
        .destroy = file_destroy,
 
108
};
 
109
 
 
110
static int new_file_blob(bithenge_node_t **out, int fd, bool needs_close)
 
111
{
 
112
        assert(out);
 
113
 
 
114
        struct stat stat;
 
115
        int rc = fstat(fd, &stat);
 
116
        if (rc != EOK) {
 
117
                if (needs_close)
 
118
                        close(fd);
 
119
                return rc;
 
120
        }
 
121
 
 
122
        // Create blob
 
123
        file_blob_t *blob = malloc(sizeof(*blob));
 
124
        if (!blob) {
 
125
                if (needs_close)
 
126
                        close(fd);
 
127
                return ENOMEM;
 
128
        }
 
129
        rc = bithenge_init_random_access_blob(file_as_blob(blob), &file_ops);
 
130
        if (rc != EOK) {
 
131
                free(blob);
 
132
                if (needs_close)
 
133
                        close(fd);
 
134
                return rc;
 
135
        }
 
136
        blob->fd = fd;
 
137
#ifdef __HELENOS__
 
138
        blob->size = stat.size;
 
139
#else
 
140
        blob->size = stat.st_size;
 
141
#endif
 
142
        blob->needs_close = needs_close;
 
143
        *out = bithenge_blob_as_node(file_as_blob(blob));
 
144
 
 
145
        return EOK;
 
146
}
 
147
 
 
148
/** Create a blob for a file. The blob must be freed with @a
 
149
 * bithenge_node_t::bithenge_node_destroy after it is used.
 
150
 * @param[out] out Stores the created blob.
 
151
 * @param filename The name of the file.
 
152
 * @return EOK on success or an error code from errno.h. */
 
153
int bithenge_new_file_blob(bithenge_node_t **out, const char *filename)
 
154
{
 
155
        assert(filename);
 
156
 
 
157
        int fd = open(filename, O_RDONLY);
 
158
        if (fd < 0)
 
159
                return fd;
 
160
 
 
161
        return new_file_blob(out, fd, true);
 
162
}
 
163
 
 
164
/** Create a blob for a file descriptor. The blob must be freed with @a
 
165
 * bithenge_node_t::bithenge_node_destroy after it is used.
 
166
 * @param[out] out Stores the created blob.
 
167
 * @param fd The file descriptor.
 
168
 * @return EOK on success or an error code from errno.h. */
 
169
int bithenge_new_file_blob_from_fd(bithenge_node_t **out, int fd)
 
170
{
 
171
        return new_file_blob(out, fd, false);
 
172
}
 
173
 
 
174
/** Create a blob for a file pointer. The blob must be freed with @a
 
175
 * bithenge_node_t::bithenge_node_destroy after it is used.
 
176
 * @param[out] out Stores the created blob.
 
177
 * @param file The file pointer.
 
178
 * @return EOK on success or an error code from errno.h. */
 
179
int bithenge_new_file_blob_from_file(bithenge_node_t **out, FILE *file)
 
180
{
 
181
        int fd = fileno(file);
 
182
        if (fd < 0)
 
183
                return errno;
 
184
        return new_file_blob(out, fd, false);
 
185
}
 
186
 
 
187
/** @}
 
188
 */