Renamed handle_t to obj_handle_t to avoid conflict with rpcdce.h.
[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 <stdio.h>
26 #include <stdlib.h>
27 #include <unistd.h>
28
29 #include "winnt.h"
30 #include "winbase.h"
31
32 #include "handle.h"
33 #include "thread.h"
34 #include "request.h"
35
36 struct mapping
37 {
38     struct object   obj;             /* object header */
39     int             size_high;       /* mapping size */
40     int             size_low;        /* mapping size */
41     int             protect;         /* protection flags */
42     struct file    *file;            /* file mapped */
43     int             header_size;     /* size of headers (for PE image mapping) */
44     void           *base;            /* default base addr (for PE image mapping) */
45     struct file    *shared_file;     /* temp file for shared PE mapping */
46     int             shared_size;     /* shared mapping total size */
47     struct mapping *shared_next;     /* next in shared PE mapping list */
48     struct mapping *shared_prev;     /* prev in shared PE mapping list */
49 };
50
51 static int mapping_get_fd( struct object *obj );
52 static int mapping_get_info( struct object *obj, struct get_file_info_reply *reply, int *flags );
53 static void mapping_dump( struct object *obj, int verbose );
54 static void mapping_destroy( struct object *obj );
55
56 static const struct object_ops mapping_ops =
57 {
58     sizeof(struct mapping),      /* size */
59     mapping_dump,                /* dump */
60     no_add_queue,                /* add_queue */
61     NULL,                        /* remove_queue */
62     NULL,                        /* signaled */
63     NULL,                        /* satisfied */
64     NULL,                        /* get_poll_events */
65     NULL,                        /* poll_event */
66     mapping_get_fd,              /* get_fd */
67     no_flush,                    /* flush */
68     mapping_get_info,            /* get_file_info */
69     NULL,                        /* queue_async */
70     mapping_destroy              /* destroy */
71 };
72
73 static struct mapping *shared_first;
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_ADDR(addr) \
107    ((int)(addr) & ~page_mask)
108
109 #define ROUND_SIZE(addr,size) \
110    (((int)(size) + ((int)(addr) & page_mask) + page_mask) & ~page_mask)
111
112 /* get the fd to use for mmaping a file */
113 inline static int get_mmap_fd( struct file *file )
114 {
115     struct object *obj;
116     if (!(obj = (struct object *)file))
117     {
118         set_error( STATUS_INVALID_HANDLE );
119         return -1;
120     }
121     return obj->ops->get_fd( obj );
122 }
123
124 /* find the shared PE mapping for a given mapping */
125 static struct file *get_shared_file( struct mapping *mapping )
126 {
127     struct mapping *ptr;
128
129     for (ptr = shared_first; ptr; ptr = ptr->shared_next)
130         if (is_same_file( ptr->file, mapping->file ))
131             return (struct file *)grab_object( ptr->shared_file );
132     return NULL;
133 }
134
135 /* allocate and fill the temp file for a shared PE image mapping */
136 static int build_shared_mapping( struct mapping *mapping, int fd,
137                                  IMAGE_SECTION_HEADER *sec, int nb_sec )
138 {
139     int i, max_size, total_size, pos;
140     char *buffer = NULL;
141     int shared_fd;
142     long toread;
143
144     /* compute the total size of the shared mapping */
145
146     total_size = max_size = 0;
147     for (i = 0; i < nb_sec; i++)
148     {
149         if ((sec[i].Characteristics & IMAGE_SCN_MEM_SHARED) &&
150             (sec[i].Characteristics & IMAGE_SCN_MEM_WRITE))
151         {
152             int size = ROUND_SIZE( 0, sec[i].Misc.VirtualSize );
153             if (size > max_size) max_size = size;
154             total_size += size;
155         }
156     }
157     if (!(mapping->shared_size = total_size)) return 1;  /* nothing to do */
158
159     if ((mapping->shared_file = get_shared_file( mapping ))) return 1;
160
161     /* create a temp file for the mapping */
162
163     if (!(mapping->shared_file = create_temp_file( GENERIC_READ|GENERIC_WRITE ))) return 0;
164     if (!grow_file( mapping->shared_file, 0, total_size )) goto error;
165     if ((shared_fd = get_mmap_fd( mapping->shared_file )) == -1) goto error;
166
167     if (!(buffer = malloc( max_size ))) goto error;
168
169     /* copy the shared sections data into the temp file */
170
171     for (i = pos = 0; i < nb_sec; i++)
172     {
173         if (!(sec[i].Characteristics & IMAGE_SCN_MEM_SHARED)) continue;
174         if (!(sec[i].Characteristics & IMAGE_SCN_MEM_WRITE)) continue;
175         if (lseek( shared_fd, pos, SEEK_SET ) != pos) goto error;
176         pos += ROUND_SIZE( 0, sec[i].Misc.VirtualSize );
177         if (sec[i].Characteristics & IMAGE_SCN_CNT_UNINITIALIZED_DATA) continue;
178         if (!sec[i].PointerToRawData || !sec[i].SizeOfRawData) continue;
179         if (lseek( fd, sec[i].PointerToRawData, SEEK_SET ) != sec[i].PointerToRawData) goto error;
180         toread = sec[i].SizeOfRawData;
181         while (toread)
182         {
183             long res = read( fd, buffer + sec[i].SizeOfRawData - toread, toread );
184             if (res <= 0) goto error;
185             toread -= res;
186         }
187         if (write( shared_fd, buffer, sec[i].SizeOfRawData ) != sec[i].SizeOfRawData) goto error;
188     }
189     free( buffer );
190     return 1;
191
192  error:
193     release_object( mapping->shared_file );
194     mapping->shared_file = NULL;
195     if (buffer) free( buffer );
196     return 0;
197 }
198
199 /* retrieve the mapping parameters for an executable (PE) image */
200 static int get_image_params( struct mapping *mapping )
201 {
202     IMAGE_DOS_HEADER dos;
203     IMAGE_NT_HEADERS nt;
204     IMAGE_SECTION_HEADER *sec = NULL;
205     int fd, filepos, size;
206
207     /* load the headers */
208
209     if ((fd = get_mmap_fd( mapping->file )) == -1) return 0;
210     filepos = lseek( fd, 0, SEEK_SET );
211     if (read( fd, &dos, sizeof(dos) ) != sizeof(dos)) goto error;
212     if (dos.e_magic != IMAGE_DOS_SIGNATURE) goto error;
213     if (lseek( fd, dos.e_lfanew, SEEK_SET ) == -1) goto error;
214     if (read( fd, &nt, sizeof(nt) ) != sizeof(nt)) goto error;
215     if (nt.Signature != IMAGE_NT_SIGNATURE) goto error;
216
217     /* load the section headers */
218
219     size = sizeof(*sec) * nt.FileHeader.NumberOfSections;
220     if (!(sec = malloc( size ))) goto error;
221     if (read( fd, sec, size ) != size) goto error;
222
223     if (!build_shared_mapping( mapping, fd, sec, nt.FileHeader.NumberOfSections )) goto error;
224
225     if (mapping->shared_file)  /* link it in the list */
226     {
227         if ((mapping->shared_next = shared_first)) shared_first->shared_prev = mapping;
228         mapping->shared_prev = NULL;
229         shared_first = mapping;
230     }
231
232     mapping->size_low    = ROUND_SIZE( 0, nt.OptionalHeader.SizeOfImage );
233     mapping->size_high   = 0;
234     mapping->base        = (void *)nt.OptionalHeader.ImageBase;
235     mapping->header_size = ROUND_SIZE( mapping->base, nt.OptionalHeader.SizeOfHeaders );
236     mapping->protect     = VPROT_IMAGE;
237
238     /* sanity check */
239     if (mapping->header_size > mapping->size_low) goto error;
240
241     lseek( fd, filepos, SEEK_SET );
242     free( sec );
243     return 1;
244
245  error:
246     lseek( fd, filepos, SEEK_SET );
247     if (sec) free( sec );
248     set_error( STATUS_INVALID_FILE_FOR_SECTION );
249     return 0;
250 }
251
252
253 static struct object *create_mapping( int size_high, int size_low, int protect,
254                                       obj_handle_t handle, const WCHAR *name, size_t len )
255 {
256     struct mapping *mapping;
257     int access = 0;
258
259     if (!page_mask) init_page_size();
260
261     if (!(mapping = create_named_object( &mapping_ops, name, len )))
262         return NULL;
263     if (get_error() == STATUS_OBJECT_NAME_COLLISION)
264         return &mapping->obj;  /* Nothing else to do */
265
266     mapping->header_size = 0;
267     mapping->base        = NULL;
268     mapping->shared_file = NULL;
269     mapping->shared_size = 0;
270
271     if (protect & VPROT_READ) access |= GENERIC_READ;
272     if (protect & VPROT_WRITE) access |= GENERIC_WRITE;
273
274     if (handle)
275     {
276         if (!(mapping->file = get_file_obj( current->process, handle, access ))) goto error;
277         if (protect & VPROT_IMAGE)
278         {
279             if (!get_image_params( mapping )) goto error;
280             return &mapping->obj;
281         }
282         if (!size_high && !size_low)
283         {
284             int flags;
285             struct get_file_info_reply reply;
286             struct object *obj = (struct object *)mapping->file;
287             obj->ops->get_file_info( obj, &reply, &flags );
288             size_high = reply.size_high;
289             size_low  = ROUND_SIZE( 0, reply.size_low );
290         }
291         else if (!grow_file( mapping->file, size_high, size_low )) goto error;
292     }
293     else  /* Anonymous mapping (no associated file) */
294     {
295         if ((!size_high && !size_low) || (protect & VPROT_IMAGE))
296         {
297             set_error( STATUS_INVALID_PARAMETER );
298             mapping->file = NULL;
299             goto error;
300         }
301         if (!(mapping->file = create_temp_file( access ))) goto error;
302         if (!grow_file( mapping->file, size_high, size_low )) goto error;
303     }
304     mapping->size_high = size_high;
305     mapping->size_low  = ROUND_SIZE( 0, size_low );
306     mapping->protect   = protect;
307     return &mapping->obj;
308
309  error:
310     release_object( mapping );
311     return NULL;
312 }
313
314 static void mapping_dump( struct object *obj, int verbose )
315 {
316     struct mapping *mapping = (struct mapping *)obj;
317     assert( obj->ops == &mapping_ops );
318     fprintf( stderr, "Mapping size=%08x%08x prot=%08x file=%p header_size=%08x base=%p "
319              "shared_file=%p shared_size=%08x ",
320              mapping->size_high, mapping->size_low, mapping->protect, mapping->file,
321              mapping->header_size, mapping->base, mapping->shared_file, mapping->shared_size );
322     dump_object_name( &mapping->obj );
323     fputc( '\n', stderr );
324 }
325
326 static int mapping_get_fd( struct object *obj )
327 {
328     struct mapping *mapping = (struct mapping *)obj;
329     assert( obj->ops == &mapping_ops );
330     return get_mmap_fd( mapping->file );
331 }
332
333 static int mapping_get_info( struct object *obj, struct get_file_info_reply *reply, int *flags )
334 {
335     struct mapping *mapping = (struct mapping *)obj;
336     struct object *file = (struct object *)mapping->file;
337
338     assert( obj->ops == &mapping_ops );
339     assert( file );
340     return file->ops->get_file_info( file, reply, flags );
341 }
342
343 static void mapping_destroy( struct object *obj )
344 {
345     struct mapping *mapping = (struct mapping *)obj;
346     assert( obj->ops == &mapping_ops );
347     if (mapping->file) release_object( mapping->file );
348     if (mapping->shared_file)
349     {
350         release_object( mapping->shared_file );
351         if (mapping->shared_next) mapping->shared_next->shared_prev = mapping->shared_prev;
352         if (mapping->shared_prev) mapping->shared_prev->shared_next = mapping->shared_next;
353         else shared_first = mapping->shared_next;
354     }
355 }
356
357 int get_page_size(void)
358 {
359     if (!page_mask) init_page_size();
360     return page_mask + 1;
361 }
362
363 /* create a file mapping */
364 DECL_HANDLER(create_mapping)
365 {
366     struct object *obj;
367
368     reply->handle = 0;
369     if ((obj = create_mapping( req->size_high, req->size_low,
370                                req->protect, req->file_handle,
371                                get_req_data(), get_req_data_size() )))
372     {
373         int access = FILE_MAP_ALL_ACCESS;
374         if (!(req->protect & VPROT_WRITE)) access &= ~FILE_MAP_WRITE;
375         reply->handle = alloc_handle( current->process, obj, access, req->inherit );
376         release_object( obj );
377     }
378 }
379
380 /* open a handle to a mapping */
381 DECL_HANDLER(open_mapping)
382 {
383     reply->handle = open_object( get_req_data(), get_req_data_size(),
384                                  &mapping_ops, req->access, req->inherit );
385 }
386
387 /* get a mapping information */
388 DECL_HANDLER(get_mapping_info)
389 {
390     struct mapping *mapping;
391
392     if ((mapping = (struct mapping *)get_handle_obj( current->process, req->handle,
393                                                      0, &mapping_ops )))
394     {
395         reply->size_high   = mapping->size_high;
396         reply->size_low    = mapping->size_low;
397         reply->protect     = mapping->protect;
398         reply->header_size = mapping->header_size;
399         reply->base        = mapping->base;
400         reply->shared_file = 0;
401         reply->shared_size = mapping->shared_size;
402         reply->drive_type  = get_file_drive_type( mapping->file );
403         if (mapping->shared_file)
404             reply->shared_file = alloc_handle( current->process, mapping->shared_file,
405                                                GENERIC_READ|GENERIC_WRITE, 0 );
406         release_object( mapping );
407     }
408 }