twain_32: Add a bit more tracing about the scanners found.
[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 #include "security.h"
41
42 /* list of memory ranges, used to store committed info */
43 struct ranges
44 {
45     unsigned int count;
46     unsigned int max;
47     struct range
48     {
49         file_pos_t  start;
50         file_pos_t  end;
51     } ranges[1];
52 };
53
54 struct mapping
55 {
56     struct object   obj;             /* object header */
57     mem_size_t      size;            /* mapping size */
58     int             protect;         /* protection flags */
59     struct file    *file;            /* file mapped */
60     int             header_size;     /* size of headers (for PE image mapping) */
61     client_ptr_t    base;            /* default base addr (for PE image mapping) */
62     struct ranges  *committed;       /* list of committed ranges in this mapping */
63     struct file    *shared_file;     /* temp file for shared PE mapping */
64     struct list     shared_entry;    /* entry in global shared PE mappings list */
65 };
66
67 static void mapping_dump( struct object *obj, int verbose );
68 static struct object_type *mapping_get_type( struct object *obj );
69 static struct fd *mapping_get_fd( struct object *obj );
70 static unsigned int mapping_map_access( struct object *obj, unsigned int access );
71 static void mapping_destroy( struct object *obj );
72
73 static const struct object_ops mapping_ops =
74 {
75     sizeof(struct mapping),      /* size */
76     mapping_dump,                /* dump */
77     mapping_get_type,            /* get_type */
78     no_add_queue,                /* add_queue */
79     NULL,                        /* remove_queue */
80     NULL,                        /* signaled */
81     NULL,                        /* satisfied */
82     no_signal,                   /* signal */
83     mapping_get_fd,              /* get_fd */
84     mapping_map_access,          /* map_access */
85     default_get_sd,              /* get_sd */
86     default_set_sd,              /* set_sd */
87     no_lookup_name,              /* lookup_name */
88     no_open_file,                /* open_file */
89     fd_close_handle,             /* close_handle */
90     mapping_destroy              /* destroy */
91 };
92
93 static struct list shared_list = LIST_INIT(shared_list);
94
95 #ifdef __i386__
96
97 /* These are always the same on an i386, and it will be faster this way */
98 # define page_mask  0xfff
99 # define page_shift 12
100 # define init_page_size() do { /* nothing */ } while(0)
101
102 #else  /* __i386__ */
103
104 static int page_shift, page_mask;
105
106 static void init_page_size(void)
107 {
108     int page_size;
109 # ifdef HAVE_GETPAGESIZE
110     page_size = getpagesize();
111 # else
112 #  ifdef __svr4__
113     page_size = sysconf(_SC_PAGESIZE);
114 #  else
115 #   error Cannot get the page size on this platform
116 #  endif
117 # endif
118     page_mask = page_size - 1;
119     /* Make sure we have a power of 2 */
120     assert( !(page_size & page_mask) );
121     page_shift = 0;
122     while ((1 << page_shift) != page_size) page_shift++;
123 }
124 #endif  /* __i386__ */
125
126 #define ROUND_SIZE(size)  (((size) + page_mask) & ~page_mask)
127
128
129 /* find the shared PE mapping for a given mapping */
130 static struct file *get_shared_file( struct mapping *mapping )
131 {
132     struct mapping *ptr;
133
134     LIST_FOR_EACH_ENTRY( ptr, &shared_list, struct mapping, shared_entry )
135         if (is_same_file( ptr->file, mapping->file ))
136             return (struct file *)grab_object( ptr->shared_file );
137     return NULL;
138 }
139
140 /* return the size of the memory mapping and file range of a given section */
141 static inline void get_section_sizes( const IMAGE_SECTION_HEADER *sec, size_t *map_size,
142                                       off_t *file_start, size_t *file_size )
143 {
144     static const unsigned int sector_align = 0x1ff;
145
146     if (!sec->Misc.VirtualSize) *map_size = ROUND_SIZE( sec->SizeOfRawData );
147     else *map_size = ROUND_SIZE( sec->Misc.VirtualSize );
148
149     *file_start = sec->PointerToRawData & ~sector_align;
150     *file_size = (sec->SizeOfRawData + (sec->PointerToRawData & sector_align) + sector_align) & ~sector_align;
151     if (*file_size > *map_size) *file_size = *map_size;
152 }
153
154 /* add a range to the committed list */
155 static void add_committed_range( struct mapping *mapping, file_pos_t start, file_pos_t end )
156 {
157     unsigned int i, j;
158     struct range *ranges;
159
160     if (!mapping->committed) return;  /* everything committed already */
161
162     for (i = 0, ranges = mapping->committed->ranges; i < mapping->committed->count; i++)
163     {
164         if (ranges[i].start > end) break;
165         if (ranges[i].end < start) continue;
166         if (ranges[i].start > start) ranges[i].start = start;   /* extend downwards */
167         if (ranges[i].end < end)  /* extend upwards and maybe merge with next */
168         {
169             for (j = i + 1; j < mapping->committed->count; j++)
170             {
171                 if (ranges[j].start > end) break;
172                 if (ranges[j].end > end) end = ranges[j].end;
173             }
174             if (j > i + 1)
175             {
176                 memmove( &ranges[i + 1], &ranges[j], (mapping->committed->count - j) * sizeof(*ranges) );
177                 mapping->committed->count -= j - (i + 1);
178             }
179             ranges[i].end = end;
180         }
181         return;
182     }
183
184     /* now add a new range */
185
186     if (mapping->committed->count == mapping->committed->max)
187     {
188         unsigned int new_size = mapping->committed->max * 2;
189         struct ranges *new_ptr = realloc( mapping->committed, offsetof( struct ranges, ranges[new_size] ));
190         if (!new_ptr) return;
191         new_ptr->max = new_size;
192         ranges = new_ptr->ranges;
193         mapping->committed = new_ptr;
194     }
195     memmove( &ranges[i + 1], &ranges[i], (mapping->committed->count - i) * sizeof(*ranges) );
196     ranges[i].start = start;
197     ranges[i].end = end;
198     mapping->committed->count++;
199 }
200
201 /* find the range containing start and return whether it's committed */
202 static int find_committed_range( struct mapping *mapping, file_pos_t start, mem_size_t *size )
203 {
204     unsigned int i;
205     struct range *ranges;
206
207     if (!mapping->committed)  /* everything is committed */
208     {
209         *size = mapping->size - start;
210         return 1;
211     }
212     for (i = 0, ranges = mapping->committed->ranges; i < mapping->committed->count; i++)
213     {
214         if (ranges[i].start > start)
215         {
216             *size = ranges[i].start - start;
217             return 0;
218         }
219         if (ranges[i].end > start)
220         {
221             *size = ranges[i].end - start;
222             return 1;
223         }
224     }
225     *size = mapping->size - start;
226     return 0;
227 }
228
229 /* allocate and fill the temp file for a shared PE image mapping */
230 static int build_shared_mapping( struct mapping *mapping, int fd,
231                                  IMAGE_SECTION_HEADER *sec, unsigned int nb_sec )
232 {
233     unsigned int i;
234     mem_size_t total_size;
235     size_t file_size, map_size, max_size;
236     off_t shared_pos, read_pos, write_pos;
237     char *buffer = NULL;
238     int shared_fd;
239     long toread;
240
241     /* compute the total size of the shared mapping */
242
243     total_size = max_size = 0;
244     for (i = 0; i < nb_sec; i++)
245     {
246         if ((sec[i].Characteristics & IMAGE_SCN_MEM_SHARED) &&
247             (sec[i].Characteristics & IMAGE_SCN_MEM_WRITE))
248         {
249             get_section_sizes( &sec[i], &map_size, &read_pos, &file_size );
250             if (file_size > max_size) max_size = file_size;
251             total_size += map_size;
252         }
253     }
254     if (!total_size) return 1;  /* nothing to do */
255
256     if ((mapping->shared_file = get_shared_file( mapping ))) return 1;
257
258     /* create a temp file for the mapping */
259
260     if (!(mapping->shared_file = create_temp_file( FILE_GENERIC_READ|FILE_GENERIC_WRITE ))) return 0;
261     if (!grow_file( mapping->shared_file, total_size )) goto error;
262     if ((shared_fd = get_file_unix_fd( mapping->shared_file )) == -1) goto error;
263
264     if (!(buffer = malloc( max_size ))) goto error;
265
266     /* copy the shared sections data into the temp file */
267
268     shared_pos = 0;
269     for (i = 0; i < nb_sec; i++)
270     {
271         if (!(sec[i].Characteristics & IMAGE_SCN_MEM_SHARED)) continue;
272         if (!(sec[i].Characteristics & IMAGE_SCN_MEM_WRITE)) continue;
273         get_section_sizes( &sec[i], &map_size, &read_pos, &file_size );
274         write_pos = shared_pos;
275         shared_pos += map_size;
276         if (!sec[i].PointerToRawData || !file_size) continue;
277         toread = file_size;
278         while (toread)
279         {
280             long res = pread( fd, buffer + file_size - toread, toread, read_pos );
281             if (!res && toread < 0x200)  /* partial sector at EOF is not an error */
282             {
283                 file_size -= toread;
284                 break;
285             }
286             if (res <= 0) goto error;
287             toread -= res;
288             read_pos += res;
289         }
290         if (pwrite( shared_fd, buffer, file_size, write_pos ) != file_size) goto error;
291     }
292     free( buffer );
293     return 1;
294
295  error:
296     release_object( mapping->shared_file );
297     mapping->shared_file = NULL;
298     free( buffer );
299     return 0;
300 }
301
302 /* retrieve the mapping parameters for an executable (PE) image */
303 static int get_image_params( struct mapping *mapping )
304 {
305     IMAGE_DOS_HEADER dos;
306     IMAGE_NT_HEADERS nt;
307     IMAGE_SECTION_HEADER *sec = NULL;
308     struct fd *fd;
309     off_t pos;
310     int unix_fd, size, toread;
311
312     /* load the headers */
313
314     if (!(fd = mapping_get_fd( &mapping->obj ))) return 0;
315     if ((unix_fd = get_unix_fd( fd )) == -1) goto error;
316     if (pread( unix_fd, &dos, sizeof(dos), 0 ) != sizeof(dos)) goto error;
317     if (dos.e_magic != IMAGE_DOS_SIGNATURE) goto error;
318     pos = dos.e_lfanew;
319
320     if (pread( unix_fd, &nt.Signature, sizeof(nt.Signature), pos ) != sizeof(nt.Signature))
321         goto error;
322     pos += sizeof(nt.Signature);
323     if (nt.Signature != IMAGE_NT_SIGNATURE) goto error;
324     if (pread( unix_fd, &nt.FileHeader, sizeof(nt.FileHeader), pos ) != sizeof(nt.FileHeader))
325         goto error;
326     pos += sizeof(nt.FileHeader);
327     /* zero out Optional header in the case it's not present or partial */
328     memset(&nt.OptionalHeader, 0, sizeof(nt.OptionalHeader));
329     toread = min( sizeof(nt.OptionalHeader), nt.FileHeader.SizeOfOptionalHeader );
330     if (pread( unix_fd, &nt.OptionalHeader, toread, pos ) != toread) goto error;
331     pos += nt.FileHeader.SizeOfOptionalHeader;
332
333     /* load the section headers */
334
335     size = sizeof(*sec) * nt.FileHeader.NumberOfSections;
336     if (!(sec = malloc( size ))) goto error;
337     if (pread( unix_fd, sec, size, pos ) != size) goto error;
338
339     if (!build_shared_mapping( mapping, unix_fd, sec, nt.FileHeader.NumberOfSections )) goto error;
340
341     if (mapping->shared_file) list_add_head( &shared_list, &mapping->shared_entry );
342
343     mapping->size        = ROUND_SIZE( nt.OptionalHeader.SizeOfImage );
344     mapping->base        = nt.OptionalHeader.ImageBase;
345     mapping->header_size = max( pos + size, nt.OptionalHeader.SizeOfHeaders );
346     mapping->protect     = VPROT_IMAGE;
347
348     /* sanity check */
349     if (pos + size > mapping->size) goto error;
350
351     free( sec );
352     release_object( fd );
353     return 1;
354
355  error:
356     free( sec );
357     release_object( fd );
358     set_error( STATUS_INVALID_FILE_FOR_SECTION );
359     return 0;
360 }
361
362 /* get the size of the unix file associated with the mapping */
363 static inline int get_file_size( struct file *file, mem_size_t *size )
364 {
365     struct stat st;
366     int unix_fd = get_file_unix_fd( file );
367
368     if (unix_fd == -1 || fstat( unix_fd, &st ) == -1) return 0;
369     *size = st.st_size;
370     return 1;
371 }
372
373 static struct object *create_mapping( struct directory *root, const struct unicode_str *name,
374                                       unsigned int attr, mem_size_t size, int protect,
375                                       obj_handle_t handle, const struct security_descriptor *sd )
376 {
377     struct mapping *mapping;
378     int access = 0;
379
380     if (!page_mask) init_page_size();
381
382     if (!(mapping = create_named_object_dir( root, name, attr, &mapping_ops )))
383         return NULL;
384     if (get_error() == STATUS_OBJECT_NAME_EXISTS)
385         return &mapping->obj;  /* Nothing else to do */
386
387     if (sd) default_set_sd( &mapping->obj, sd, OWNER_SECURITY_INFORMATION|
388                                                GROUP_SECURITY_INFORMATION|
389                                                DACL_SECURITY_INFORMATION|
390                                                SACL_SECURITY_INFORMATION );
391     mapping->header_size = 0;
392     mapping->base        = 0;
393     mapping->file        = NULL;
394     mapping->shared_file = NULL;
395     mapping->committed   = NULL;
396
397     if (protect & VPROT_READ) access |= FILE_READ_DATA;
398     if (protect & VPROT_WRITE) access |= FILE_WRITE_DATA;
399
400     if (handle)
401     {
402         if (!(protect & VPROT_COMMITTED))
403         {
404             set_error( STATUS_INVALID_PARAMETER );
405             goto error;
406         }
407         if (!(mapping->file = get_file_obj( current->process, handle, access ))) goto error;
408         if (protect & VPROT_IMAGE)
409         {
410             if (!get_image_params( mapping )) goto error;
411             return &mapping->obj;
412         }
413         if (!size)
414         {
415             if (!get_file_size( mapping->file, &size )) goto error;
416             if (!size)
417             {
418                 set_error( STATUS_MAPPED_FILE_SIZE_ZERO );
419                 goto error;
420             }
421         }
422         else
423         {
424             if (!grow_file( mapping->file, size )) goto error;
425         }
426     }
427     else  /* Anonymous mapping (no associated file) */
428     {
429         if (!size || (protect & VPROT_IMAGE))
430         {
431             set_error( STATUS_INVALID_PARAMETER );
432             goto error;
433         }
434         if (!(protect & VPROT_COMMITTED))
435         {
436             if (!(mapping->committed = mem_alloc( offsetof(struct ranges, ranges[8]) ))) goto error;
437             mapping->committed->count = 0;
438             mapping->committed->max   = 8;
439         }
440         if (!(mapping->file = create_temp_file( access ))) goto error;
441         if (!grow_file( mapping->file, size )) goto error;
442     }
443     mapping->size    = (size + page_mask) & ~((mem_size_t)page_mask);
444     mapping->protect = protect;
445     return &mapping->obj;
446
447  error:
448     release_object( mapping );
449     return NULL;
450 }
451
452 static void mapping_dump( struct object *obj, int verbose )
453 {
454     struct mapping *mapping = (struct mapping *)obj;
455     assert( obj->ops == &mapping_ops );
456     fprintf( stderr, "Mapping size=%08x%08x prot=%08x file=%p header_size=%08x base=%08lx "
457              "shared_file=%p ",
458              (unsigned int)(mapping->size >> 32), (unsigned int)mapping->size,
459              mapping->protect, mapping->file, mapping->header_size,
460              (unsigned long)mapping->base, mapping->shared_file );
461     dump_object_name( &mapping->obj );
462     fputc( '\n', stderr );
463 }
464
465 static struct object_type *mapping_get_type( struct object *obj )
466 {
467     static const WCHAR name[] = {'S','e','c','t','i','o','n'};
468     static const struct unicode_str str = { name, sizeof(name) };
469     return get_object_type( &str );
470 }
471
472 static struct fd *mapping_get_fd( struct object *obj )
473 {
474     struct mapping *mapping = (struct mapping *)obj;
475     return get_obj_fd( (struct object *)mapping->file );
476 }
477
478 static unsigned int mapping_map_access( struct object *obj, unsigned int access )
479 {
480     if (access & GENERIC_READ)    access |= STANDARD_RIGHTS_READ | SECTION_QUERY | SECTION_MAP_READ;
481     if (access & GENERIC_WRITE)   access |= STANDARD_RIGHTS_WRITE | SECTION_MAP_WRITE;
482     if (access & GENERIC_EXECUTE) access |= STANDARD_RIGHTS_EXECUTE | SECTION_MAP_EXECUTE;
483     if (access & GENERIC_ALL)     access |= SECTION_ALL_ACCESS;
484     return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
485 }
486
487 static void mapping_destroy( struct object *obj )
488 {
489     struct mapping *mapping = (struct mapping *)obj;
490     assert( obj->ops == &mapping_ops );
491     if (mapping->file) release_object( mapping->file );
492     if (mapping->shared_file)
493     {
494         release_object( mapping->shared_file );
495         list_remove( &mapping->shared_entry );
496     }
497     free( mapping->committed );
498 }
499
500 int get_page_size(void)
501 {
502     if (!page_mask) init_page_size();
503     return page_mask + 1;
504 }
505
506 /* create a file mapping */
507 DECL_HANDLER(create_mapping)
508 {
509     struct object *obj;
510     struct unicode_str name;
511     struct directory *root = NULL;
512     const struct object_attributes *objattr = get_req_data();
513     const struct security_descriptor *sd;
514
515     reply->handle = 0;
516
517     if (!objattr_is_valid( objattr, get_req_data_size() ))
518         return;
519
520     sd = objattr->sd_len ? (const struct security_descriptor *)(objattr + 1) : NULL;
521     objattr_get_name( objattr, &name );
522
523     if (objattr->rootdir && !(root = get_directory_obj( current->process, objattr->rootdir, 0 )))
524         return;
525
526     if ((obj = create_mapping( root, &name, req->attributes, req->size, req->protect, req->file_handle, sd )))
527     {
528         if (get_error() == STATUS_OBJECT_NAME_EXISTS)
529             reply->handle = alloc_handle( current->process, obj, req->access, req->attributes );
530         else
531             reply->handle = alloc_handle_no_access_check( current->process, obj, req->access, req->attributes );
532         release_object( obj );
533     }
534
535     if (root) release_object( root );
536 }
537
538 /* open a handle to a mapping */
539 DECL_HANDLER(open_mapping)
540 {
541     struct unicode_str name;
542     struct directory *root = NULL;
543     struct mapping *mapping;
544
545     get_req_unicode_str( &name );
546     if (req->rootdir && !(root = get_directory_obj( current->process, req->rootdir, 0 )))
547         return;
548
549     if ((mapping = open_object_dir( root, &name, req->attributes, &mapping_ops )))
550     {
551         reply->handle = alloc_handle( current->process, &mapping->obj, req->access, req->attributes );
552         release_object( mapping );
553     }
554
555     if (root) release_object( root );
556 }
557
558 /* get a mapping information */
559 DECL_HANDLER(get_mapping_info)
560 {
561     struct mapping *mapping;
562     struct fd *fd;
563
564     if ((mapping = (struct mapping *)get_handle_obj( current->process, req->handle,
565                                                      req->access | SECTION_QUERY, &mapping_ops )))
566     {
567         reply->size        = mapping->size;
568         reply->protect     = mapping->protect;
569         reply->header_size = mapping->header_size;
570         reply->base        = mapping->base;
571         reply->shared_file = 0;
572         if ((fd = get_obj_fd( &mapping->obj )))
573         {
574             if (!is_fd_removable(fd))
575                 reply->mapping = alloc_handle( current->process, mapping, 0, 0 );
576             release_object( fd );
577         }
578         if (mapping->shared_file)
579         {
580             if (!(reply->shared_file = alloc_handle( current->process, mapping->shared_file,
581                                                      GENERIC_READ|GENERIC_WRITE, 0 )))
582             {
583                 if (reply->mapping) close_handle( current->process, reply->mapping );
584             }
585         }
586         release_object( mapping );
587     }
588 }
589
590 /* get a range of committed pages in a file mapping */
591 DECL_HANDLER(get_mapping_committed_range)
592 {
593     struct mapping *mapping;
594
595     if ((mapping = (struct mapping *)get_handle_obj( current->process, req->handle, 0, &mapping_ops )))
596     {
597         if (!(req->offset & page_mask) && req->offset < mapping->size)
598             reply->committed = find_committed_range( mapping, req->offset, &reply->size );
599         else
600             set_error( STATUS_INVALID_PARAMETER );
601
602         release_object( mapping );
603     }
604 }
605
606 /* add a range to the committed pages in a file mapping */
607 DECL_HANDLER(add_mapping_committed_range)
608 {
609     struct mapping *mapping;
610
611     if ((mapping = (struct mapping *)get_handle_obj( current->process, req->handle, 0, &mapping_ops )))
612     {
613         if (!(req->size & page_mask) &&
614             !(req->offset & page_mask) &&
615             req->offset < mapping->size &&
616             req->size > 0 &&
617             req->size <= mapping->size - req->offset)
618             add_committed_range( mapping, req->offset, req->offset + req->size );
619         else
620             set_error( STATUS_INVALID_PARAMETER );
621
622         release_object( mapping );
623     }
624 }