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