server: Added access rights mapping to file objects.
[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 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     no_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_MASK(addr,size,mask) \
109    (((int)(size) + ((int)(addr) & (mask)) + (mask)) & ~(mask))
110
111 #define ROUND_SIZE(size)  (((size) + page_mask) & ~page_mask)
112
113
114 /* find the shared PE mapping for a given mapping */
115 static struct file *get_shared_file( struct mapping *mapping )
116 {
117     struct mapping *ptr;
118
119     LIST_FOR_EACH_ENTRY( ptr, &shared_list, struct mapping, shared_entry )
120         if (is_same_file( ptr->file, mapping->file ))
121             return (struct file *)grab_object( ptr->shared_file );
122     return NULL;
123 }
124
125 /* return the size of the memory mapping of a given section */
126 static inline unsigned int get_section_map_size( const IMAGE_SECTION_HEADER *sec )
127 {
128     if (!sec->Misc.VirtualSize) return ROUND_SIZE( sec->SizeOfRawData );
129     else return ROUND_SIZE( sec->Misc.VirtualSize );
130 }
131
132 /* return the size of the file mapping of a given section */
133 static inline unsigned int get_section_filemap_size( const IMAGE_SECTION_HEADER *sec )
134 {
135     if (!sec->Misc.VirtualSize) return sec->SizeOfRawData;
136     else return min( sec->SizeOfRawData, ROUND_SIZE( sec->Misc.VirtualSize ) );
137 }
138
139 /* allocate and fill the temp file for a shared PE image mapping */
140 static int build_shared_mapping( struct mapping *mapping, int fd,
141                                  IMAGE_SECTION_HEADER *sec, unsigned int nb_sec )
142 {
143     unsigned int i, size, max_size, total_size;
144     off_t shared_pos, read_pos, write_pos;
145     char *buffer = NULL;
146     int shared_fd;
147     long toread;
148
149     /* compute the total size of the shared mapping */
150
151     total_size = max_size = 0;
152     for (i = 0; i < nb_sec; i++)
153     {
154         if ((sec[i].Characteristics & IMAGE_SCN_MEM_SHARED) &&
155             (sec[i].Characteristics & IMAGE_SCN_MEM_WRITE))
156         {
157             size = get_section_filemap_size( &sec[i] );
158             if (size > max_size) max_size = size;
159             total_size += get_section_map_size( &sec[i] );
160         }
161     }
162     if (!(mapping->shared_size = total_size)) return 1;  /* nothing to do */
163
164     if ((mapping->shared_file = get_shared_file( mapping ))) return 1;
165
166     /* create a temp file for the mapping */
167
168     if (!(mapping->shared_file = create_temp_file( FILE_GENERIC_READ|FILE_GENERIC_WRITE ))) return 0;
169     if (!grow_file( mapping->shared_file, total_size )) goto error;
170     if ((shared_fd = get_file_unix_fd( mapping->shared_file )) == -1) goto error;
171
172     if (!(buffer = malloc( max_size ))) goto error;
173
174     /* copy the shared sections data into the temp file */
175
176     shared_pos = 0;
177     for (i = 0; i < nb_sec; i++)
178     {
179         if (!(sec[i].Characteristics & IMAGE_SCN_MEM_SHARED)) continue;
180         if (!(sec[i].Characteristics & IMAGE_SCN_MEM_WRITE)) continue;
181         write_pos = shared_pos;
182         shared_pos += get_section_map_size( &sec[i] );
183         read_pos = sec[i].PointerToRawData;
184         size = get_section_filemap_size( &sec[i] );
185         if (!read_pos || !size) continue;
186         toread = size;
187         while (toread)
188         {
189             long res = pread( fd, buffer + sec[i].SizeOfRawData - toread, toread, read_pos );
190             if (res <= 0) goto error;
191             toread -= res;
192             read_pos += res;
193         }
194         if (pwrite( shared_fd, buffer, size, write_pos ) != size) goto error;
195     }
196     free( buffer );
197     return 1;
198
199  error:
200     release_object( mapping->shared_file );
201     mapping->shared_file = NULL;
202     if (buffer) free( buffer );
203     return 0;
204 }
205
206 /* retrieve the mapping parameters for an executable (PE) image */
207 static int get_image_params( struct mapping *mapping )
208 {
209     IMAGE_DOS_HEADER dos;
210     IMAGE_NT_HEADERS nt;
211     IMAGE_SECTION_HEADER *sec = NULL;
212     struct fd *fd;
213     off_t pos;
214     int unix_fd, size, toread;
215
216     /* load the headers */
217
218     if (!(fd = mapping_get_fd( &mapping->obj ))) return 0;
219     if ((unix_fd = get_unix_fd( fd )) == -1) goto error;
220     if (pread( unix_fd, &dos, sizeof(dos), 0 ) != sizeof(dos)) goto error;
221     if (dos.e_magic != IMAGE_DOS_SIGNATURE) goto error;
222     pos = dos.e_lfanew;
223
224     if (pread( unix_fd, &nt.Signature, sizeof(nt.Signature), pos ) != sizeof(nt.Signature))
225         goto error;
226     pos += sizeof(nt.Signature);
227     if (nt.Signature != IMAGE_NT_SIGNATURE) goto error;
228     if (pread( unix_fd, &nt.FileHeader, sizeof(nt.FileHeader), pos ) != sizeof(nt.FileHeader))
229         goto error;
230     pos += sizeof(nt.FileHeader);
231     /* zero out Optional header in the case it's not present or partial */
232     memset(&nt.OptionalHeader, 0, sizeof(nt.OptionalHeader));
233     toread = min( sizeof(nt.OptionalHeader), nt.FileHeader.SizeOfOptionalHeader );
234     if (pread( unix_fd, &nt.OptionalHeader, toread, pos ) != toread) goto error;
235     pos += nt.FileHeader.SizeOfOptionalHeader;
236
237     /* load the section headers */
238
239     size = sizeof(*sec) * nt.FileHeader.NumberOfSections;
240     if (!(sec = malloc( size ))) goto error;
241     if (pread( unix_fd, sec, size, pos ) != size) goto error;
242
243     if (!build_shared_mapping( mapping, unix_fd, sec, nt.FileHeader.NumberOfSections )) goto error;
244
245     if (mapping->shared_file) list_add_head( &shared_list, &mapping->shared_entry );
246
247     mapping->size        = ROUND_SIZE( nt.OptionalHeader.SizeOfImage );
248     mapping->base        = (void *)nt.OptionalHeader.ImageBase;
249     mapping->header_size = ROUND_SIZE_MASK( mapping->base, nt.OptionalHeader.SizeOfHeaders,
250                                             nt.OptionalHeader.SectionAlignment - 1 );
251     mapping->protect     = VPROT_IMAGE;
252
253     /* sanity check */
254     if (mapping->header_size > mapping->size) goto error;
255
256     free( sec );
257     release_object( fd );
258     return 1;
259
260  error:
261     if (sec) free( sec );
262     release_object( fd );
263     set_error( STATUS_INVALID_FILE_FOR_SECTION );
264     return 0;
265 }
266
267 /* get the size of the unix file associated with the mapping */
268 inline static int get_file_size( struct file *file, file_pos_t *size )
269 {
270     struct stat st;
271     int unix_fd = get_file_unix_fd( file );
272
273     if (unix_fd == -1 || fstat( unix_fd, &st ) == -1) return 0;
274     *size = st.st_size;
275     return 1;
276 }
277
278 static struct object *create_mapping( struct directory *root, const struct unicode_str *name,
279                                       unsigned int attr, file_pos_t size, int protect,
280                                       obj_handle_t handle )
281 {
282     struct mapping *mapping;
283     int access = 0;
284
285     if (!page_mask) init_page_size();
286
287     if (!(mapping = create_named_object_dir( root, name, attr, &mapping_ops )))
288         return NULL;
289     if (get_error() == STATUS_OBJECT_NAME_EXISTS)
290         return &mapping->obj;  /* Nothing else to do */
291
292     mapping->header_size = 0;
293     mapping->base        = NULL;
294     mapping->shared_file = NULL;
295     mapping->shared_size = 0;
296
297     if (protect & VPROT_READ) access |= FILE_READ_DATA;
298     if (protect & VPROT_WRITE) access |= FILE_WRITE_DATA;
299
300     if (handle)
301     {
302         if (!(mapping->file = get_file_obj( current->process, handle, access ))) goto error;
303         if (protect & VPROT_IMAGE)
304         {
305             if (!get_image_params( mapping )) goto error;
306             return &mapping->obj;
307         }
308         if (!size)
309         {
310             if (!get_file_size( mapping->file, &size )) goto error;
311             if (!size)
312             {
313                 set_error( STATUS_MAPPED_FILE_SIZE_ZERO );
314                 goto error;
315             }
316         }
317         else
318         {
319             if (!grow_file( mapping->file, size )) goto error;
320         }
321     }
322     else  /* Anonymous mapping (no associated file) */
323     {
324         if (!size || (protect & VPROT_IMAGE))
325         {
326             set_error( STATUS_INVALID_PARAMETER );
327             mapping->file = NULL;
328             goto error;
329         }
330         if (!(mapping->file = create_temp_file( access ))) goto error;
331         if (!grow_file( mapping->file, size )) goto error;
332     }
333     mapping->size    = (size + page_mask) & ~((file_pos_t)page_mask);
334     mapping->protect = protect;
335     return &mapping->obj;
336
337  error:
338     release_object( mapping );
339     return NULL;
340 }
341
342 static void mapping_dump( struct object *obj, int verbose )
343 {
344     struct mapping *mapping = (struct mapping *)obj;
345     assert( obj->ops == &mapping_ops );
346     fprintf( stderr, "Mapping size=%08x%08x prot=%08x file=%p header_size=%08x base=%p "
347              "shared_file=%p shared_size=%08x ",
348              (unsigned int)(mapping->size >> 32), (unsigned int)mapping->size,
349              mapping->protect, mapping->file, mapping->header_size,
350              mapping->base, mapping->shared_file, mapping->shared_size );
351     dump_object_name( &mapping->obj );
352     fputc( '\n', stderr );
353 }
354
355 static struct fd *mapping_get_fd( struct object *obj )
356 {
357     struct mapping *mapping = (struct mapping *)obj;
358     return get_obj_fd( (struct object *)mapping->file );
359 }
360
361 static unsigned int mapping_map_access( struct object *obj, unsigned int access )
362 {
363     if (access & GENERIC_READ)    access |= STANDARD_RIGHTS_READ | SECTION_QUERY | SECTION_MAP_READ;
364     if (access & GENERIC_WRITE)   access |= STANDARD_RIGHTS_WRITE | SECTION_MAP_WRITE;
365     if (access & GENERIC_EXECUTE) access |= STANDARD_RIGHTS_EXECUTE | SECTION_MAP_EXECUTE;
366     if (access & GENERIC_ALL)     access |= SECTION_ALL_ACCESS;
367     return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
368 }
369
370 static void mapping_destroy( struct object *obj )
371 {
372     struct mapping *mapping = (struct mapping *)obj;
373     assert( obj->ops == &mapping_ops );
374     if (mapping->file) release_object( mapping->file );
375     if (mapping->shared_file)
376     {
377         release_object( mapping->shared_file );
378         list_remove( &mapping->shared_entry );
379     }
380 }
381
382 int get_page_size(void)
383 {
384     if (!page_mask) init_page_size();
385     return page_mask + 1;
386 }
387
388 /* create a file mapping */
389 DECL_HANDLER(create_mapping)
390 {
391     struct object *obj;
392     struct unicode_str name;
393     struct directory *root = NULL;
394     file_pos_t size = ((file_pos_t)req->size_high << 32) | req->size_low;
395
396     reply->handle = 0;
397     get_req_unicode_str( &name );
398     if (req->rootdir && !(root = get_directory_obj( current->process, req->rootdir, 0 )))
399         return;
400
401     if ((obj = create_mapping( root, &name, req->attributes, size, req->protect, req->file_handle )))
402     {
403         reply->handle = alloc_handle( current->process, obj, req->access, req->attributes );
404         release_object( obj );
405     }
406
407     if (root) release_object( root );
408 }
409
410 /* open a handle to a mapping */
411 DECL_HANDLER(open_mapping)
412 {
413     struct unicode_str name;
414     struct directory *root = NULL;
415     struct mapping *mapping;
416
417     get_req_unicode_str( &name );
418     if (req->rootdir && !(root = get_directory_obj( current->process, req->rootdir, 0 )))
419         return;
420
421     if ((mapping = open_object_dir( root, &name, req->attributes, &mapping_ops )))
422     {
423         reply->handle = alloc_handle( current->process, &mapping->obj, req->access, req->attributes );
424         release_object( mapping );
425     }
426
427     if (root) release_object( root );
428 }
429
430 /* get a mapping information */
431 DECL_HANDLER(get_mapping_info)
432 {
433     struct mapping *mapping;
434
435     if ((mapping = (struct mapping *)get_handle_obj( current->process, req->handle,
436                                                      0, &mapping_ops )))
437     {
438         reply->size_high   = (unsigned int)(mapping->size >> 32);
439         reply->size_low    = (unsigned int)mapping->size;
440         reply->protect     = mapping->protect;
441         reply->header_size = mapping->header_size;
442         reply->base        = mapping->base;
443         reply->shared_file = 0;
444         reply->shared_size = mapping->shared_size;
445         if (mapping->shared_file)
446             reply->shared_file = alloc_handle( current->process, mapping->shared_file,
447                                                GENERIC_READ|GENERIC_WRITE, 0 );
448         release_object( mapping );
449     }
450 }