server: Add an open_file() function to the object operations.
[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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19  */
20
21 #include "config.h"
22 #include "wine/port.h"
23
24 #include <assert.h>
25 #include <stdarg.h>
26 #include <stdio.h>
27 #include <stdlib.h>
28 #include <sys/stat.h>
29 #include <unistd.h>
30
31 #include "ntstatus.h"
32 #define WIN32_NO_STATUS
33 #include "windef.h"
34 #include "winternl.h"
35
36 #include "file.h"
37 #include "handle.h"
38 #include "thread.h"
39 #include "request.h"
40
41 struct mapping
42 {
43     struct object   obj;             /* object header */
44     file_pos_t      size;            /* mapping size */
45     int             protect;         /* protection flags */
46     struct file    *file;            /* file mapped */
47     int             header_size;     /* size of headers (for PE image mapping) */
48     void           *base;            /* default base addr (for PE image mapping) */
49     struct file    *shared_file;     /* temp file for shared PE mapping */
50     int             shared_size;     /* shared mapping total size */
51     struct list     shared_entry;    /* entry in global shared PE mappings list */
52 };
53
54 static void mapping_dump( struct object *obj, int verbose );
55 static struct fd *mapping_get_fd( struct object *obj );
56 static unsigned int mapping_map_access( struct object *obj, unsigned int access );
57 static void mapping_destroy( struct object *obj );
58
59 static const struct object_ops mapping_ops =
60 {
61     sizeof(struct mapping),      /* size */
62     mapping_dump,                /* dump */
63     no_add_queue,                /* add_queue */
64     NULL,                        /* remove_queue */
65     NULL,                        /* signaled */
66     NULL,                        /* satisfied */
67     no_signal,                   /* signal */
68     mapping_get_fd,              /* get_fd */
69     mapping_map_access,          /* map_access */
70     no_lookup_name,              /* lookup_name */
71     no_open_file,                /* open_file */
72     fd_close_handle,             /* close_handle */
73     mapping_destroy              /* destroy */
74 };
75
76 static struct list shared_list = LIST_INIT(shared_list);
77
78 #ifdef __i386__
79
80 /* These are always the same on an i386, and it will be faster this way */
81 # define page_mask  0xfff
82 # define page_shift 12
83 # define init_page_size() do { /* nothing */ } while(0)
84
85 #else  /* __i386__ */
86
87 static int page_shift, page_mask;
88
89 static void init_page_size(void)
90 {
91     int page_size;
92 # ifdef HAVE_GETPAGESIZE
93     page_size = getpagesize();
94 # else
95 #  ifdef __svr4__
96     page_size = sysconf(_SC_PAGESIZE);
97 #  else
98 #   error Cannot get the page size on this platform
99 #  endif
100 # endif
101     page_mask = page_size - 1;
102     /* Make sure we have a power of 2 */
103     assert( !(page_size & page_mask) );
104     page_shift = 0;
105     while ((1 << page_shift) != page_size) page_shift++;
106 }
107 #endif  /* __i386__ */
108
109 #define ROUND_SIZE(size)  (((size) + page_mask) & ~page_mask)
110
111
112 /* find the shared PE mapping for a given mapping */
113 static struct file *get_shared_file( struct mapping *mapping )
114 {
115     struct mapping *ptr;
116
117     LIST_FOR_EACH_ENTRY( ptr, &shared_list, struct mapping, shared_entry )
118         if (is_same_file( ptr->file, mapping->file ))
119             return (struct file *)grab_object( ptr->shared_file );
120     return NULL;
121 }
122
123 /* return the size of the memory mapping and file range of a given section */
124 static inline void get_section_sizes( const IMAGE_SECTION_HEADER *sec, size_t *map_size,
125                                       off_t *file_start, size_t *file_size )
126 {
127     static const unsigned int sector_align = 0x1ff;
128
129     if (!sec->Misc.VirtualSize) *map_size = ROUND_SIZE( sec->SizeOfRawData );
130     else *map_size = ROUND_SIZE( sec->Misc.VirtualSize );
131
132     *file_start = sec->PointerToRawData & ~sector_align;
133     *file_size = (sec->SizeOfRawData + (sec->PointerToRawData & sector_align) + sector_align) & ~sector_align;
134     if (*file_size > *map_size) *file_size = *map_size;
135 }
136
137 /* allocate and fill the temp file for a shared PE image mapping */
138 static int build_shared_mapping( struct mapping *mapping, int fd,
139                                  IMAGE_SECTION_HEADER *sec, unsigned int nb_sec )
140 {
141     unsigned int i;
142     size_t file_size, map_size, max_size, total_size;
143     off_t shared_pos, read_pos, write_pos;
144     char *buffer = NULL;
145     int shared_fd;
146     long toread;
147
148     /* compute the total size of the shared mapping */
149
150     total_size = max_size = 0;
151     for (i = 0; i < nb_sec; i++)
152     {
153         if ((sec[i].Characteristics & IMAGE_SCN_MEM_SHARED) &&
154             (sec[i].Characteristics & IMAGE_SCN_MEM_WRITE))
155         {
156             get_section_sizes( &sec[i], &map_size, &read_pos, &file_size );
157             if (file_size > max_size) max_size = file_size;
158             total_size += map_size;
159         }
160     }
161     if (!(mapping->shared_size = total_size)) return 1;  /* nothing to do */
162
163     if ((mapping->shared_file = get_shared_file( mapping ))) return 1;
164
165     /* create a temp file for the mapping */
166
167     if (!(mapping->shared_file = create_temp_file( FILE_GENERIC_READ|FILE_GENERIC_WRITE ))) return 0;
168     if (!grow_file( mapping->shared_file, total_size )) goto error;
169     if ((shared_fd = get_file_unix_fd( mapping->shared_file )) == -1) goto error;
170
171     if (!(buffer = malloc( max_size ))) goto error;
172
173     /* copy the shared sections data into the temp file */
174
175     shared_pos = 0;
176     for (i = 0; i < nb_sec; i++)
177     {
178         if (!(sec[i].Characteristics & IMAGE_SCN_MEM_SHARED)) continue;
179         if (!(sec[i].Characteristics & IMAGE_SCN_MEM_WRITE)) continue;
180         get_section_sizes( &sec[i], &map_size, &read_pos, &file_size );
181         write_pos = shared_pos;
182         shared_pos += map_size;
183         if (!sec[i].PointerToRawData || !file_size) continue;
184         toread = file_size;
185         while (toread)
186         {
187             long res = pread( fd, buffer + file_size - toread, toread, read_pos );
188             if (!res && toread < 0x200)  /* partial sector at EOF is not an error */
189             {
190                 file_size -= toread;
191                 break;
192             }
193             if (res <= 0) goto error;
194             toread -= res;
195             read_pos += res;
196         }
197         if (pwrite( shared_fd, buffer, file_size, write_pos ) != file_size) goto error;
198     }
199     free( buffer );
200     return 1;
201
202  error:
203     release_object( mapping->shared_file );
204     mapping->shared_file = NULL;
205     free( buffer );
206     return 0;
207 }
208
209 /* retrieve the mapping parameters for an executable (PE) image */
210 static int get_image_params( struct mapping *mapping )
211 {
212     IMAGE_DOS_HEADER dos;
213     IMAGE_NT_HEADERS nt;
214     IMAGE_SECTION_HEADER *sec = NULL;
215     struct fd *fd;
216     off_t pos;
217     int unix_fd, size, toread;
218
219     /* load the headers */
220
221     if (!(fd = mapping_get_fd( &mapping->obj ))) return 0;
222     if ((unix_fd = get_unix_fd( fd )) == -1) goto error;
223     if (pread( unix_fd, &dos, sizeof(dos), 0 ) != sizeof(dos)) goto error;
224     if (dos.e_magic != IMAGE_DOS_SIGNATURE) goto error;
225     pos = dos.e_lfanew;
226
227     if (pread( unix_fd, &nt.Signature, sizeof(nt.Signature), pos ) != sizeof(nt.Signature))
228         goto error;
229     pos += sizeof(nt.Signature);
230     if (nt.Signature != IMAGE_NT_SIGNATURE) goto error;
231     if (pread( unix_fd, &nt.FileHeader, sizeof(nt.FileHeader), pos ) != sizeof(nt.FileHeader))
232         goto error;
233     pos += sizeof(nt.FileHeader);
234     /* zero out Optional header in the case it's not present or partial */
235     memset(&nt.OptionalHeader, 0, sizeof(nt.OptionalHeader));
236     toread = min( sizeof(nt.OptionalHeader), nt.FileHeader.SizeOfOptionalHeader );
237     if (pread( unix_fd, &nt.OptionalHeader, toread, pos ) != toread) goto error;
238     pos += nt.FileHeader.SizeOfOptionalHeader;
239
240     /* load the section headers */
241
242     size = sizeof(*sec) * nt.FileHeader.NumberOfSections;
243     if (!(sec = malloc( size ))) goto error;
244     if (pread( unix_fd, sec, size, pos ) != size) goto error;
245
246     if (!build_shared_mapping( mapping, unix_fd, sec, nt.FileHeader.NumberOfSections )) goto error;
247
248     if (mapping->shared_file) list_add_head( &shared_list, &mapping->shared_entry );
249
250     mapping->size        = ROUND_SIZE( nt.OptionalHeader.SizeOfImage );
251     mapping->base        = (void *)nt.OptionalHeader.ImageBase;
252     mapping->header_size = max( pos + size, nt.OptionalHeader.SizeOfHeaders );
253     mapping->protect     = VPROT_IMAGE;
254
255     /* sanity check */
256     if (pos + size > mapping->size) goto error;
257
258     free( sec );
259     release_object( fd );
260     return 1;
261
262  error:
263     free( sec );
264     release_object( fd );
265     set_error( STATUS_INVALID_FILE_FOR_SECTION );
266     return 0;
267 }
268
269 /* get the size of the unix file associated with the mapping */
270 static inline int get_file_size( struct file *file, file_pos_t *size )
271 {
272     struct stat st;
273     int unix_fd = get_file_unix_fd( file );
274
275     if (unix_fd == -1 || fstat( unix_fd, &st ) == -1) return 0;
276     *size = st.st_size;
277     return 1;
278 }
279
280 static struct object *create_mapping( struct directory *root, const struct unicode_str *name,
281                                       unsigned int attr, file_pos_t size, int protect,
282                                       obj_handle_t handle )
283 {
284     struct mapping *mapping;
285     int access = 0;
286
287     if (!page_mask) init_page_size();
288
289     if (!(mapping = create_named_object_dir( root, name, attr, &mapping_ops )))
290         return NULL;
291     if (get_error() == STATUS_OBJECT_NAME_EXISTS)
292         return &mapping->obj;  /* Nothing else to do */
293
294     mapping->header_size = 0;
295     mapping->base        = NULL;
296     mapping->shared_file = NULL;
297     mapping->shared_size = 0;
298
299     if (protect & VPROT_READ) access |= FILE_READ_DATA;
300     if (protect & VPROT_WRITE) access |= FILE_WRITE_DATA;
301
302     if (handle)
303     {
304         if (!(mapping->file = get_file_obj( current->process, handle, access ))) goto error;
305         if (protect & VPROT_IMAGE)
306         {
307             if (!get_image_params( mapping )) goto error;
308             return &mapping->obj;
309         }
310         if (!size)
311         {
312             if (!get_file_size( mapping->file, &size )) goto error;
313             if (!size)
314             {
315                 set_error( STATUS_MAPPED_FILE_SIZE_ZERO );
316                 goto error;
317             }
318         }
319         else
320         {
321             if (!grow_file( mapping->file, size )) goto error;
322         }
323     }
324     else  /* Anonymous mapping (no associated file) */
325     {
326         if (!size || (protect & VPROT_IMAGE))
327         {
328             set_error( STATUS_INVALID_PARAMETER );
329             mapping->file = NULL;
330             goto error;
331         }
332         if (!(mapping->file = create_temp_file( access ))) goto error;
333         if (!grow_file( mapping->file, size )) goto error;
334     }
335     mapping->size    = (size + page_mask) & ~((file_pos_t)page_mask);
336     mapping->protect = protect;
337     return &mapping->obj;
338
339  error:
340     release_object( mapping );
341     return NULL;
342 }
343
344 static void mapping_dump( struct object *obj, int verbose )
345 {
346     struct mapping *mapping = (struct mapping *)obj;
347     assert( obj->ops == &mapping_ops );
348     fprintf( stderr, "Mapping size=%08x%08x prot=%08x file=%p header_size=%08x base=%p "
349              "shared_file=%p shared_size=%08x ",
350              (unsigned int)(mapping->size >> 32), (unsigned int)mapping->size,
351              mapping->protect, mapping->file, mapping->header_size,
352              mapping->base, mapping->shared_file, mapping->shared_size );
353     dump_object_name( &mapping->obj );
354     fputc( '\n', stderr );
355 }
356
357 static struct fd *mapping_get_fd( struct object *obj )
358 {
359     struct mapping *mapping = (struct mapping *)obj;
360     return get_obj_fd( (struct object *)mapping->file );
361 }
362
363 static unsigned int mapping_map_access( struct object *obj, unsigned int access )
364 {
365     if (access & GENERIC_READ)    access |= STANDARD_RIGHTS_READ | SECTION_QUERY | SECTION_MAP_READ;
366     if (access & GENERIC_WRITE)   access |= STANDARD_RIGHTS_WRITE | SECTION_MAP_WRITE;
367     if (access & GENERIC_EXECUTE) access |= STANDARD_RIGHTS_EXECUTE | SECTION_MAP_EXECUTE;
368     if (access & GENERIC_ALL)     access |= SECTION_ALL_ACCESS;
369     return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
370 }
371
372 static void mapping_destroy( struct object *obj )
373 {
374     struct mapping *mapping = (struct mapping *)obj;
375     assert( obj->ops == &mapping_ops );
376     if (mapping->file) release_object( mapping->file );
377     if (mapping->shared_file)
378     {
379         release_object( mapping->shared_file );
380         list_remove( &mapping->shared_entry );
381     }
382 }
383
384 int get_page_size(void)
385 {
386     if (!page_mask) init_page_size();
387     return page_mask + 1;
388 }
389
390 /* create a file mapping */
391 DECL_HANDLER(create_mapping)
392 {
393     struct object *obj;
394     struct unicode_str name;
395     struct directory *root = NULL;
396     file_pos_t size = ((file_pos_t)req->size_high << 32) | req->size_low;
397
398     reply->handle = 0;
399     get_req_unicode_str( &name );
400     if (req->rootdir && !(root = get_directory_obj( current->process, req->rootdir, 0 )))
401         return;
402
403     if ((obj = create_mapping( root, &name, req->attributes, size, req->protect, req->file_handle )))
404     {
405         reply->handle = alloc_handle( current->process, obj, req->access, req->attributes );
406         release_object( obj );
407     }
408
409     if (root) release_object( root );
410 }
411
412 /* open a handle to a mapping */
413 DECL_HANDLER(open_mapping)
414 {
415     struct unicode_str name;
416     struct directory *root = NULL;
417     struct mapping *mapping;
418
419     get_req_unicode_str( &name );
420     if (req->rootdir && !(root = get_directory_obj( current->process, req->rootdir, 0 )))
421         return;
422
423     if ((mapping = open_object_dir( root, &name, req->attributes, &mapping_ops )))
424     {
425         reply->handle = alloc_handle( current->process, &mapping->obj, req->access, req->attributes );
426         release_object( mapping );
427     }
428
429     if (root) release_object( root );
430 }
431
432 /* get a mapping information */
433 DECL_HANDLER(get_mapping_info)
434 {
435     struct mapping *mapping;
436     struct fd *fd;
437
438     if ((mapping = (struct mapping *)get_handle_obj( current->process, req->handle,
439                                                      0, &mapping_ops )))
440     {
441         reply->size_high   = (unsigned int)(mapping->size >> 32);
442         reply->size_low    = (unsigned int)mapping->size;
443         reply->protect     = mapping->protect;
444         reply->header_size = mapping->header_size;
445         reply->base        = mapping->base;
446         reply->shared_file = 0;
447         reply->shared_size = mapping->shared_size;
448         if ((fd = get_obj_fd( &mapping->obj )))
449         {
450             if (!is_fd_removable(fd))
451                 reply->mapping = alloc_handle( current->process, mapping, 0, 0 );
452             release_object( fd );
453         }
454         if (mapping->shared_file)
455         {
456             if (!(reply->shared_file = alloc_handle( current->process, mapping->shared_file,
457                                                      GENERIC_READ|GENERIC_WRITE, 0 )))
458             {
459                 if (reply->mapping) close_handle( current->process, reply->mapping );
460             }
461         }
462         release_object( mapping );
463     }
464 }