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