Started moving functions that deal with Unix file descriptors to a
[wine] / server / mapping.c
1 /*
2  * Server-side file mapping management
3  *
4  * Copyright (C) 1999 Alexandre Julliard
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; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  */
20
21 #include "config.h"
22 #include "wine/port.h"
23
24 #include <assert.h>
25 #include <stdio.h>
26 #include <stdlib.h>
27 #include <unistd.h>
28
29 #include "winbase.h"
30
31 #include "file.h"
32 #include "handle.h"
33 #include "thread.h"
34 #include "request.h"
35
36 struct mapping
37 {
38     struct object   obj;             /* object header */
39     int             size_high;       /* mapping size */
40     int             size_low;        /* mapping size */
41     int             protect;         /* protection flags */
42     struct file    *file;            /* file mapped */
43     int             header_size;     /* size of headers (for PE image mapping) */
44     void           *base;            /* default base addr (for PE image mapping) */
45     struct file    *shared_file;     /* temp file for shared PE mapping */
46     int             shared_size;     /* shared mapping total size */
47     struct mapping *shared_next;     /* next in shared PE mapping list */
48     struct mapping *shared_prev;     /* prev in shared PE mapping list */
49 };
50
51 static struct fd *mapping_get_fd( struct object *obj );
52 static int mapping_get_info( struct object *obj, struct get_file_info_reply *reply, int *flags );
53 static void mapping_dump( struct object *obj, int verbose );
54 static void mapping_destroy( struct object *obj );
55
56 static const struct object_ops mapping_ops =
57 {
58     sizeof(struct mapping),      /* size */
59     mapping_dump,                /* dump */
60     no_add_queue,                /* add_queue */
61     NULL,                        /* remove_queue */
62     NULL,                        /* signaled */
63     NULL,                        /* satisfied */
64     mapping_get_fd,              /* get_fd */
65     mapping_get_info,            /* get_file_info */
66     mapping_destroy              /* destroy */
67 };
68
69 static struct mapping *shared_first;
70
71 #ifdef __i386__
72
73 /* These are always the same on an i386, and it will be faster this way */
74 # define page_mask  0xfff
75 # define page_shift 12
76 # define init_page_size() do { /* nothing */ } while(0)
77
78 #else  /* __i386__ */
79
80 static int page_shift, page_mask;
81
82 static void init_page_size(void)
83 {
84     int page_size;
85 # ifdef HAVE_GETPAGESIZE
86     page_size = getpagesize();
87 # else
88 #  ifdef __svr4__
89     page_size = sysconf(_SC_PAGESIZE);
90 #  else
91 #   error Cannot get the page size on this platform
92 #  endif
93 # endif
94     page_mask = page_size - 1;
95     /* Make sure we have a power of 2 */
96     assert( !(page_size & page_mask) );
97     page_shift = 0;
98     while ((1 << page_shift) != page_size) page_shift++;
99 }
100 #endif  /* __i386__ */
101
102 #define ROUND_ADDR(addr) \
103    ((int)(addr) & ~page_mask)
104
105 #define ROUND_SIZE(addr,size) \
106    (((int)(size) + ((int)(addr) & page_mask) + page_mask) & ~page_mask)
107
108 /* get the fd to use for mmaping a file */
109 inline static int get_mmap_fd( struct file *file )
110 {
111     return get_unix_fd( (struct object *)file );
112 }
113
114 /* find the shared PE mapping for a given mapping */
115 static struct file *get_shared_file( struct mapping *mapping )
116 {
117     struct mapping *ptr;
118
119     for (ptr = shared_first; ptr; ptr = ptr->shared_next)
120         if (is_same_file( ptr->file, mapping->file ))
121             return (struct file *)grab_object( ptr->shared_file );
122     return NULL;
123 }
124
125 /* allocate and fill the temp file for a shared PE image mapping */
126 static int build_shared_mapping( struct mapping *mapping, int fd,
127                                  IMAGE_SECTION_HEADER *sec, int nb_sec )
128 {
129     int i, max_size, total_size, pos;
130     char *buffer = NULL;
131     int shared_fd;
132     long toread;
133
134     /* compute the total size of the shared mapping */
135
136     total_size = max_size = 0;
137     for (i = 0; i < nb_sec; i++)
138     {
139         if ((sec[i].Characteristics & IMAGE_SCN_MEM_SHARED) &&
140             (sec[i].Characteristics & IMAGE_SCN_MEM_WRITE))
141         {
142             int size = ROUND_SIZE( 0, sec[i].Misc.VirtualSize );
143             if (size > max_size) max_size = size;
144             total_size += size;
145         }
146     }
147     if (!(mapping->shared_size = total_size)) return 1;  /* nothing to do */
148
149     if ((mapping->shared_file = get_shared_file( mapping ))) return 1;
150
151     /* create a temp file for the mapping */
152
153     if (!(mapping->shared_file = create_temp_file( GENERIC_READ|GENERIC_WRITE ))) return 0;
154     if (!grow_file( mapping->shared_file, 0, total_size )) goto error;
155     if ((shared_fd = get_mmap_fd( mapping->shared_file )) == -1) goto error;
156
157     if (!(buffer = malloc( max_size ))) goto error;
158
159     /* copy the shared sections data into the temp file */
160
161     for (i = pos = 0; i < nb_sec; i++)
162     {
163         if (!(sec[i].Characteristics & IMAGE_SCN_MEM_SHARED)) continue;
164         if (!(sec[i].Characteristics & IMAGE_SCN_MEM_WRITE)) continue;
165         if (lseek( shared_fd, pos, SEEK_SET ) != pos) goto error;
166         pos += ROUND_SIZE( 0, sec[i].Misc.VirtualSize );
167         if (sec[i].Characteristics & IMAGE_SCN_CNT_UNINITIALIZED_DATA) continue;
168         if (!sec[i].PointerToRawData || !sec[i].SizeOfRawData) continue;
169         if (lseek( fd, sec[i].PointerToRawData, SEEK_SET ) != sec[i].PointerToRawData) goto error;
170         toread = sec[i].SizeOfRawData;
171         while (toread)
172         {
173             long res = read( fd, buffer + sec[i].SizeOfRawData - toread, toread );
174             if (res <= 0) goto error;
175             toread -= res;
176         }
177         if (write( shared_fd, buffer, sec[i].SizeOfRawData ) != sec[i].SizeOfRawData) goto error;
178     }
179     free( buffer );
180     return 1;
181
182  error:
183     release_object( mapping->shared_file );
184     mapping->shared_file = NULL;
185     if (buffer) free( buffer );
186     return 0;
187 }
188
189 /* retrieve the mapping parameters for an executable (PE) image */
190 static int get_image_params( struct mapping *mapping )
191 {
192     IMAGE_DOS_HEADER dos;
193     IMAGE_NT_HEADERS nt;
194     IMAGE_SECTION_HEADER *sec = NULL;
195     int fd, filepos, size;
196
197     /* load the headers */
198
199     if ((fd = get_mmap_fd( mapping->file )) == -1) return 0;
200     filepos = lseek( fd, 0, SEEK_SET );
201     if (read( fd, &dos, sizeof(dos) ) != sizeof(dos)) goto error;
202     if (dos.e_magic != IMAGE_DOS_SIGNATURE) goto error;
203     if (lseek( fd, dos.e_lfanew, SEEK_SET ) == -1) goto error;
204
205     if (read( fd, &nt.Signature, sizeof(nt.Signature) ) != sizeof(nt.Signature)) goto error;
206     if (nt.Signature != IMAGE_NT_SIGNATURE) goto error;
207     if (read( fd, &nt.FileHeader, sizeof(nt.FileHeader) ) != sizeof(nt.FileHeader)) goto error;
208     /* zero out Optional header in the case it's not present or partial */
209     memset(&nt.OptionalHeader, 0, sizeof(nt.OptionalHeader));
210     if (read( fd, &nt.OptionalHeader, nt.FileHeader.SizeOfOptionalHeader) != nt.FileHeader.SizeOfOptionalHeader) goto error;
211
212     /* load the section headers */
213
214     size = sizeof(*sec) * nt.FileHeader.NumberOfSections;
215     if (!(sec = malloc( size ))) goto error;
216     if (read( fd, sec, size ) != size) goto error;
217
218     if (!build_shared_mapping( mapping, fd, sec, nt.FileHeader.NumberOfSections )) goto error;
219
220     if (mapping->shared_file)  /* link it in the list */
221     {
222         if ((mapping->shared_next = shared_first)) shared_first->shared_prev = mapping;
223         mapping->shared_prev = NULL;
224         shared_first = mapping;
225     }
226
227     mapping->size_low    = ROUND_SIZE( 0, nt.OptionalHeader.SizeOfImage );
228     mapping->size_high   = 0;
229     mapping->base        = (void *)nt.OptionalHeader.ImageBase;
230     mapping->header_size = ROUND_SIZE( mapping->base, nt.OptionalHeader.SizeOfHeaders );
231     mapping->protect     = VPROT_IMAGE;
232
233     /* sanity check */
234     if (mapping->header_size > mapping->size_low) goto error;
235
236     lseek( fd, filepos, SEEK_SET );
237     free( sec );
238     return 1;
239
240  error:
241     lseek( fd, filepos, SEEK_SET );
242     if (sec) free( sec );
243     set_error( STATUS_INVALID_FILE_FOR_SECTION );
244     return 0;
245 }
246
247
248 static struct object *create_mapping( int size_high, int size_low, int protect,
249                                       obj_handle_t handle, const WCHAR *name, size_t len )
250 {
251     struct mapping *mapping;
252     int access = 0;
253
254     if (!page_mask) init_page_size();
255
256     if (!(mapping = create_named_object( sync_namespace, &mapping_ops, name, len )))
257         return NULL;
258     if (get_error() == STATUS_OBJECT_NAME_COLLISION)
259         return &mapping->obj;  /* Nothing else to do */
260
261     mapping->header_size = 0;
262     mapping->base        = NULL;
263     mapping->shared_file = NULL;
264     mapping->shared_size = 0;
265
266     if (protect & VPROT_READ) access |= GENERIC_READ;
267     if (protect & VPROT_WRITE) access |= GENERIC_WRITE;
268
269     if (handle)
270     {
271         if (!(mapping->file = get_file_obj( current->process, handle, access ))) goto error;
272         if (protect & VPROT_IMAGE)
273         {
274             if (!get_image_params( mapping )) goto error;
275             return &mapping->obj;
276         }
277         if (!size_high && !size_low)
278         {
279             int flags;
280             struct get_file_info_reply reply;
281             struct object *obj = (struct object *)mapping->file;
282             obj->ops->get_file_info( obj, &reply, &flags );
283             size_high = reply.size_high;
284             size_low  = ROUND_SIZE( 0, reply.size_low );
285         }
286         else if (!grow_file( mapping->file, size_high, size_low )) goto error;
287     }
288     else  /* Anonymous mapping (no associated file) */
289     {
290         if ((!size_high && !size_low) || (protect & VPROT_IMAGE))
291         {
292             set_error( STATUS_INVALID_PARAMETER );
293             mapping->file = NULL;
294             goto error;
295         }
296         if (!(mapping->file = create_temp_file( access ))) goto error;
297         if (!grow_file( mapping->file, size_high, size_low )) goto error;
298     }
299     mapping->size_high = size_high;
300     mapping->size_low  = ROUND_SIZE( 0, size_low );
301     mapping->protect   = protect;
302     return &mapping->obj;
303
304  error:
305     release_object( mapping );
306     return NULL;
307 }
308
309 static void mapping_dump( struct object *obj, int verbose )
310 {
311     struct mapping *mapping = (struct mapping *)obj;
312     assert( obj->ops == &mapping_ops );
313     fprintf( stderr, "Mapping size=%08x%08x prot=%08x file=%p header_size=%08x base=%p "
314              "shared_file=%p shared_size=%08x ",
315              mapping->size_high, mapping->size_low, mapping->protect, mapping->file,
316              mapping->header_size, mapping->base, mapping->shared_file, mapping->shared_size );
317     dump_object_name( &mapping->obj );
318     fputc( '\n', stderr );
319 }
320
321 static struct fd *mapping_get_fd( struct object *obj )
322 {
323     struct mapping *mapping = (struct mapping *)obj;
324     assert( obj->ops == &mapping_ops );
325
326     return default_get_fd( (struct object *)mapping->file );
327 }
328
329 static int mapping_get_info( struct object *obj, struct get_file_info_reply *reply, int *flags )
330 {
331     struct mapping *mapping = (struct mapping *)obj;
332     struct object *file = (struct object *)mapping->file;
333
334     assert( obj->ops == &mapping_ops );
335     assert( file );
336     return file->ops->get_file_info( file, reply, flags );
337 }
338
339 static void mapping_destroy( struct object *obj )
340 {
341     struct mapping *mapping = (struct mapping *)obj;
342     assert( obj->ops == &mapping_ops );
343     if (mapping->file) release_object( mapping->file );
344     if (mapping->shared_file)
345     {
346         release_object( mapping->shared_file );
347         if (mapping->shared_next) mapping->shared_next->shared_prev = mapping->shared_prev;
348         if (mapping->shared_prev) mapping->shared_prev->shared_next = mapping->shared_next;
349         else shared_first = mapping->shared_next;
350     }
351 }
352
353 int get_page_size(void)
354 {
355     if (!page_mask) init_page_size();
356     return page_mask + 1;
357 }
358
359 /* create a file mapping */
360 DECL_HANDLER(create_mapping)
361 {
362     struct object *obj;
363
364     reply->handle = 0;
365     if ((obj = create_mapping( req->size_high, req->size_low,
366                                req->protect, req->file_handle,
367                                get_req_data(), get_req_data_size() )))
368     {
369         reply->handle = alloc_handle( current->process, obj, req->access, req->inherit );
370         release_object( obj );
371     }
372 }
373
374 /* open a handle to a mapping */
375 DECL_HANDLER(open_mapping)
376 {
377     reply->handle = open_object( sync_namespace, get_req_data(), get_req_data_size(),
378                                  &mapping_ops, req->access, req->inherit );
379 }
380
381 /* get a mapping information */
382 DECL_HANDLER(get_mapping_info)
383 {
384     struct mapping *mapping;
385
386     if ((mapping = (struct mapping *)get_handle_obj( current->process, req->handle,
387                                                      0, &mapping_ops )))
388     {
389         reply->size_high   = mapping->size_high;
390         reply->size_low    = mapping->size_low;
391         reply->protect     = mapping->protect;
392         reply->header_size = mapping->header_size;
393         reply->base        = mapping->base;
394         reply->shared_file = 0;
395         reply->shared_size = mapping->shared_size;
396         reply->drive_type  = get_file_drive_type( mapping->file );
397         if (mapping->shared_file)
398             reply->shared_file = alloc_handle( current->process, mapping->shared_file,
399                                                GENERIC_READ|GENERIC_WRITE, 0 );
400         release_object( mapping );
401     }
402 }