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