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