server: Move handle allocation out of open_object_dir.
[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 <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 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     no_lookup_name,              /* lookup_name */
69     no_close_handle,             /* close_handle */
70     mapping_destroy              /* destroy */
71 };
72
73 static struct list shared_list = LIST_INIT(shared_list);
74
75 #ifdef __i386__
76
77 /* These are always the same on an i386, and it will be faster this way */
78 # define page_mask  0xfff
79 # define page_shift 12
80 # define init_page_size() do { /* nothing */ } while(0)
81
82 #else  /* __i386__ */
83
84 static int page_shift, page_mask;
85
86 static void init_page_size(void)
87 {
88     int page_size;
89 # ifdef HAVE_GETPAGESIZE
90     page_size = getpagesize();
91 # else
92 #  ifdef __svr4__
93     page_size = sysconf(_SC_PAGESIZE);
94 #  else
95 #   error Cannot get the page size on this platform
96 #  endif
97 # endif
98     page_mask = page_size - 1;
99     /* Make sure we have a power of 2 */
100     assert( !(page_size & page_mask) );
101     page_shift = 0;
102     while ((1 << page_shift) != page_size) page_shift++;
103 }
104 #endif  /* __i386__ */
105
106 #define ROUND_SIZE_MASK(addr,size,mask) \
107    (((int)(size) + ((int)(addr) & (mask)) + (mask)) & ~(mask))
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 of a given section */
124 static inline unsigned int get_section_map_size( const IMAGE_SECTION_HEADER *sec )
125 {
126     if (!sec->Misc.VirtualSize) return ROUND_SIZE( sec->SizeOfRawData );
127     else return ROUND_SIZE( sec->Misc.VirtualSize );
128 }
129
130 /* return the size of the file mapping of a given section */
131 static inline unsigned int get_section_filemap_size( const IMAGE_SECTION_HEADER *sec )
132 {
133     if (!sec->Misc.VirtualSize) return sec->SizeOfRawData;
134     else return min( sec->SizeOfRawData, ROUND_SIZE( sec->Misc.VirtualSize ) );
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, size, max_size, total_size;
142     off_t shared_pos, read_pos, write_pos;
143     char *buffer = NULL;
144     int shared_fd;
145     long toread;
146
147     /* compute the total size of the shared mapping */
148
149     total_size = max_size = 0;
150     for (i = 0; i < nb_sec; i++)
151     {
152         if ((sec[i].Characteristics & IMAGE_SCN_MEM_SHARED) &&
153             (sec[i].Characteristics & IMAGE_SCN_MEM_WRITE))
154         {
155             size = get_section_filemap_size( &sec[i] );
156             if (size > max_size) max_size = size;
157             total_size += get_section_map_size( &sec[i] );
158         }
159     }
160     if (!(mapping->shared_size = total_size)) return 1;  /* nothing to do */
161
162     if ((mapping->shared_file = get_shared_file( mapping ))) return 1;
163
164     /* create a temp file for the mapping */
165
166     if (!(mapping->shared_file = create_temp_file( GENERIC_READ|GENERIC_WRITE ))) return 0;
167     if (!grow_file( mapping->shared_file, total_size )) goto error;
168     if ((shared_fd = get_file_unix_fd( mapping->shared_file )) == -1) goto error;
169
170     if (!(buffer = malloc( max_size ))) goto error;
171
172     /* copy the shared sections data into the temp file */
173
174     shared_pos = 0;
175     for (i = 0; i < nb_sec; i++)
176     {
177         if (!(sec[i].Characteristics & IMAGE_SCN_MEM_SHARED)) continue;
178         if (!(sec[i].Characteristics & IMAGE_SCN_MEM_WRITE)) continue;
179         write_pos = shared_pos;
180         shared_pos += get_section_map_size( &sec[i] );
181         read_pos = sec[i].PointerToRawData;
182         size = get_section_filemap_size( &sec[i] );
183         if (!read_pos || !size) continue;
184         toread = size;
185         while (toread)
186         {
187             long res = pread( fd, buffer + sec[i].SizeOfRawData - toread, toread, read_pos );
188             if (res <= 0) goto error;
189             toread -= res;
190             read_pos += res;
191         }
192         if (pwrite( shared_fd, buffer, size, write_pos ) != size) goto error;
193     }
194     free( buffer );
195     return 1;
196
197  error:
198     release_object( mapping->shared_file );
199     mapping->shared_file = NULL;
200     if (buffer) free( buffer );
201     return 0;
202 }
203
204 /* retrieve the mapping parameters for an executable (PE) image */
205 static int get_image_params( struct mapping *mapping )
206 {
207     IMAGE_DOS_HEADER dos;
208     IMAGE_NT_HEADERS nt;
209     IMAGE_SECTION_HEADER *sec = NULL;
210     struct fd *fd;
211     off_t pos;
212     int unix_fd, size, toread;
213
214     /* load the headers */
215
216     if (!(fd = mapping_get_fd( &mapping->obj ))) return 0;
217     if ((unix_fd = get_unix_fd( fd )) == -1) goto error;
218     if (pread( unix_fd, &dos, sizeof(dos), 0 ) != sizeof(dos)) goto error;
219     if (dos.e_magic != IMAGE_DOS_SIGNATURE) goto error;
220     pos = dos.e_lfanew;
221
222     if (pread( unix_fd, &nt.Signature, sizeof(nt.Signature), pos ) != sizeof(nt.Signature))
223         goto error;
224     pos += sizeof(nt.Signature);
225     if (nt.Signature != IMAGE_NT_SIGNATURE) goto error;
226     if (pread( unix_fd, &nt.FileHeader, sizeof(nt.FileHeader), pos ) != sizeof(nt.FileHeader))
227         goto error;
228     pos += sizeof(nt.FileHeader);
229     /* zero out Optional header in the case it's not present or partial */
230     memset(&nt.OptionalHeader, 0, sizeof(nt.OptionalHeader));
231     toread = min( sizeof(nt.OptionalHeader), nt.FileHeader.SizeOfOptionalHeader );
232     if (pread( unix_fd, &nt.OptionalHeader, toread, pos ) != toread) goto error;
233     pos += nt.FileHeader.SizeOfOptionalHeader;
234
235     /* load the section headers */
236
237     size = sizeof(*sec) * nt.FileHeader.NumberOfSections;
238     if (!(sec = malloc( size ))) goto error;
239     if (pread( unix_fd, sec, size, pos ) != size) goto error;
240
241     if (!build_shared_mapping( mapping, unix_fd, sec, nt.FileHeader.NumberOfSections )) goto error;
242
243     if (mapping->shared_file) list_add_head( &shared_list, &mapping->shared_entry );
244
245     mapping->size        = ROUND_SIZE( nt.OptionalHeader.SizeOfImage );
246     mapping->base        = (void *)nt.OptionalHeader.ImageBase;
247     mapping->header_size = ROUND_SIZE_MASK( mapping->base, nt.OptionalHeader.SizeOfHeaders,
248                                             nt.OptionalHeader.SectionAlignment - 1 );
249     mapping->protect     = VPROT_IMAGE;
250
251     /* sanity check */
252     if (mapping->header_size > mapping->size) goto error;
253
254     free( sec );
255     release_object( fd );
256     return 1;
257
258  error:
259     if (sec) free( sec );
260     release_object( fd );
261     set_error( STATUS_INVALID_FILE_FOR_SECTION );
262     return 0;
263 }
264
265 /* get the size of the unix file associated with the mapping */
266 inline static int get_file_size( struct file *file, file_pos_t *size )
267 {
268     struct stat st;
269     int unix_fd = get_file_unix_fd( file );
270
271     if (unix_fd == -1 || fstat( unix_fd, &st ) == -1) return 0;
272     *size = st.st_size;
273     return 1;
274 }
275
276 static struct object *create_mapping( struct directory *root, const struct unicode_str *name,
277                                       unsigned int attr, file_pos_t size, int protect,
278                                       obj_handle_t handle )
279 {
280     struct mapping *mapping;
281     int access = 0;
282
283     if (!page_mask) init_page_size();
284
285     if (!(mapping = create_named_object_dir( root, name, attr, &mapping_ops )))
286         return NULL;
287     if (get_error() == STATUS_OBJECT_NAME_EXISTS)
288         return &mapping->obj;  /* Nothing else to do */
289
290     mapping->header_size = 0;
291     mapping->base        = NULL;
292     mapping->shared_file = NULL;
293     mapping->shared_size = 0;
294
295     if (protect & VPROT_READ) access |= GENERIC_READ;
296     if (protect & VPROT_WRITE) access |= GENERIC_WRITE;
297
298     if (handle)
299     {
300         if (!(mapping->file = get_file_obj( current->process, handle, access ))) goto error;
301         if (protect & VPROT_IMAGE)
302         {
303             if (!get_image_params( mapping )) goto error;
304             return &mapping->obj;
305         }
306         if (!size)
307         {
308             if (!get_file_size( mapping->file, &size )) goto error;
309             if (!size)
310             {
311                 set_error( STATUS_FILE_INVALID );
312                 goto error;
313             }
314         }
315         else
316         {
317             if (!grow_file( mapping->file, size )) goto error;
318         }
319     }
320     else  /* Anonymous mapping (no associated file) */
321     {
322         if (!size || (protect & VPROT_IMAGE))
323         {
324             set_error( STATUS_INVALID_PARAMETER );
325             mapping->file = NULL;
326             goto error;
327         }
328         if (!(mapping->file = create_temp_file( access ))) goto error;
329         if (!grow_file( mapping->file, size )) goto error;
330     }
331     mapping->size    = (size + page_mask) & ~((file_pos_t)page_mask);
332     mapping->protect = protect;
333     return &mapping->obj;
334
335  error:
336     release_object( mapping );
337     return NULL;
338 }
339
340 static void mapping_dump( struct object *obj, int verbose )
341 {
342     struct mapping *mapping = (struct mapping *)obj;
343     assert( obj->ops == &mapping_ops );
344     fprintf( stderr, "Mapping size=%08x%08x prot=%08x file=%p header_size=%08x base=%p "
345              "shared_file=%p shared_size=%08x ",
346              (unsigned int)(mapping->size >> 32), (unsigned int)mapping->size,
347              mapping->protect, mapping->file, mapping->header_size,
348              mapping->base, mapping->shared_file, mapping->shared_size );
349     dump_object_name( &mapping->obj );
350     fputc( '\n', stderr );
351 }
352
353 static struct fd *mapping_get_fd( struct object *obj )
354 {
355     struct mapping *mapping = (struct mapping *)obj;
356     return get_obj_fd( (struct object *)mapping->file );
357 }
358
359 static void mapping_destroy( struct object *obj )
360 {
361     struct mapping *mapping = (struct mapping *)obj;
362     assert( obj->ops == &mapping_ops );
363     if (mapping->file) release_object( mapping->file );
364     if (mapping->shared_file)
365     {
366         release_object( mapping->shared_file );
367         list_remove( &mapping->shared_entry );
368     }
369 }
370
371 int get_page_size(void)
372 {
373     if (!page_mask) init_page_size();
374     return page_mask + 1;
375 }
376
377 /* create a file mapping */
378 DECL_HANDLER(create_mapping)
379 {
380     struct object *obj;
381     struct unicode_str name;
382     struct directory *root = NULL;
383     file_pos_t size = ((file_pos_t)req->size_high << 32) | req->size_low;
384
385     reply->handle = 0;
386     get_req_unicode_str( &name );
387     if (req->rootdir && !(root = get_directory_obj( current->process, req->rootdir, 0 )))
388         return;
389
390     if ((obj = create_mapping( root, &name, req->attributes, size, req->protect, req->file_handle )))
391     {
392         reply->handle = alloc_handle( current->process, obj, req->access,
393                                       req->attributes & OBJ_INHERIT );
394         release_object( obj );
395     }
396
397     if (root) release_object( root );
398 }
399
400 /* open a handle to a mapping */
401 DECL_HANDLER(open_mapping)
402 {
403     struct unicode_str name;
404     struct directory *root = NULL;
405     struct mapping *mapping;
406
407     get_req_unicode_str( &name );
408     if (req->rootdir && !(root = get_directory_obj( current->process, req->rootdir, 0 )))
409         return;
410
411     if ((mapping = open_object_dir( root, &name, req->attributes, &mapping_ops )))
412     {
413         reply->handle = alloc_handle( current->process, &mapping->obj, req->access,
414                                       req->attributes & OBJ_INHERIT );
415         release_object( mapping );
416     }
417
418     if (root) release_object( root );
419 }
420
421 /* get a mapping information */
422 DECL_HANDLER(get_mapping_info)
423 {
424     struct mapping *mapping;
425
426     if ((mapping = (struct mapping *)get_handle_obj( current->process, req->handle,
427                                                      0, &mapping_ops )))
428     {
429         reply->size_high   = (unsigned int)(mapping->size >> 32);
430         reply->size_low    = (unsigned int)mapping->size;
431         reply->protect     = mapping->protect;
432         reply->header_size = mapping->header_size;
433         reply->base        = mapping->base;
434         reply->shared_file = 0;
435         reply->shared_size = mapping->shared_size;
436         if (mapping->shared_file)
437             reply->shared_file = alloc_handle( current->process, mapping->shared_file,
438                                                GENERIC_READ|GENERIC_WRITE, 0 );
439         release_object( mapping );
440     }
441 }