dplayx: Adjust GetCaps behaviour to documentation
[wine/gsoc_dplay.git] / server / mapping.c
bloba3031118bad4075853259d927e87b0ff7acbe640
1 /*
2 * Server-side file mapping management
4 * Copyright (C) 1999 Alexandre Julliard
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.
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.
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
21 #include "config.h"
22 #include "wine/port.h"
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>
31 #include "ntstatus.h"
32 #define WIN32_NO_STATUS
33 #include "windef.h"
34 #include "winternl.h"
36 #include "file.h"
37 #include "handle.h"
38 #include "thread.h"
39 #include "request.h"
40 #include "security.h"
42 /* list of memory ranges, used to store committed info */
43 struct ranges
45 unsigned int count;
46 unsigned int max;
47 struct range
49 file_pos_t start;
50 file_pos_t end;
51 } ranges[1];
54 struct mapping
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 */
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 );
73 static const struct object_ops mapping_ops =
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 */
93 static struct list shared_list = LIST_INIT(shared_list);
95 #ifdef __i386__
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)
102 #else /* __i386__ */
104 static int page_shift, page_mask;
106 static void init_page_size(void)
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++;
124 #endif /* __i386__ */
126 #define ROUND_SIZE(size) (((size) + page_mask) & ~page_mask)
129 /* find the shared PE mapping for a given mapping */
130 static struct file *get_shared_file( struct mapping *mapping )
132 struct mapping *ptr;
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;
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 )
144 static const unsigned int sector_align = 0x1ff;
146 if (!sec->Misc.VirtualSize) *map_size = ROUND_SIZE( sec->SizeOfRawData );
147 else *map_size = ROUND_SIZE( sec->Misc.VirtualSize );
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;
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 )
157 unsigned int i, j;
158 struct range *ranges;
160 if (!mapping->committed) return; /* everything committed already */
162 for (i = 0, ranges = mapping->committed->ranges; i < mapping->committed->count; i++)
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 */
169 for (j = i + 1; j < mapping->committed->count; j++)
171 if (ranges[j].start > end) break;
172 if (ranges[j].end > end) end = ranges[j].end;
174 if (j > i + 1)
176 memmove( &ranges[i + 1], &ranges[j], (mapping->committed->count - j) * sizeof(*ranges) );
177 mapping->committed->count -= j - (i + 1);
179 ranges[i].end = end;
181 return;
184 /* now add a new range */
186 if (mapping->committed->count == mapping->committed->max)
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;
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++;
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 )
204 unsigned int i;
205 struct range *ranges;
207 if (!mapping->committed) /* everything is committed */
209 *size = mapping->size - start;
210 return 1;
212 for (i = 0, ranges = mapping->committed->ranges; i < mapping->committed->count; i++)
214 if (ranges[i].start > start)
216 *size = ranges[i].start - start;
217 return 0;
219 if (ranges[i].end > start)
221 *size = ranges[i].end - start;
222 return 1;
225 *size = mapping->size - start;
226 return 0;
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 )
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;
241 /* compute the total size of the shared mapping */
243 total_size = max_size = 0;
244 for (i = 0; i < nb_sec; i++)
246 if ((sec[i].Characteristics & IMAGE_SCN_MEM_SHARED) &&
247 (sec[i].Characteristics & IMAGE_SCN_MEM_WRITE))
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;
254 if (!total_size) return 1; /* nothing to do */
256 if ((mapping->shared_file = get_shared_file( mapping ))) return 1;
258 /* create a temp file for the mapping */
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;
264 if (!(buffer = malloc( max_size ))) goto error;
266 /* copy the shared sections data into the temp file */
268 shared_pos = 0;
269 for (i = 0; i < nb_sec; i++)
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)
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 */
283 file_size -= toread;
284 break;
286 if (res <= 0) goto error;
287 toread -= res;
288 read_pos += res;
290 if (pwrite( shared_fd, buffer, file_size, write_pos ) != file_size) goto error;
292 free( buffer );
293 return 1;
295 error:
296 release_object( mapping->shared_file );
297 mapping->shared_file = NULL;
298 free( buffer );
299 return 0;
302 /* retrieve the mapping parameters for an executable (PE) image */
303 static int get_image_params( struct mapping *mapping )
305 IMAGE_DOS_HEADER dos;
306 IMAGE_SECTION_HEADER *sec = NULL;
307 struct
309 DWORD Signature;
310 IMAGE_FILE_HEADER FileHeader;
311 union
313 IMAGE_OPTIONAL_HEADER32 hdr32;
314 IMAGE_OPTIONAL_HEADER64 hdr64;
315 } opt;
316 } nt;
317 struct fd *fd;
318 off_t pos;
319 int unix_fd, size;
321 /* load the headers */
323 if (!(fd = mapping_get_fd( &mapping->obj ))) return 0;
324 if ((unix_fd = get_unix_fd( fd )) == -1) goto error;
325 if (pread( unix_fd, &dos, sizeof(dos), 0 ) != sizeof(dos)) goto error;
326 if (dos.e_magic != IMAGE_DOS_SIGNATURE) goto error;
327 pos = dos.e_lfanew;
329 size = pread( unix_fd, &nt, sizeof(nt), pos );
330 if (size < sizeof(nt.Signature) + sizeof(nt.FileHeader)) goto error;
331 /* zero out Optional header in the case it's not present or partial */
332 if (size < sizeof(nt)) memset( (char *)&nt + size, 0, sizeof(nt) - size );
333 if (nt.Signature != IMAGE_NT_SIGNATURE) goto error;
335 switch (nt.opt.hdr32.Magic)
337 case IMAGE_NT_OPTIONAL_HDR32_MAGIC:
338 mapping->size = ROUND_SIZE( nt.opt.hdr32.SizeOfImage );
339 mapping->base = nt.opt.hdr32.ImageBase;
340 mapping->header_size = nt.opt.hdr32.SizeOfHeaders;
341 break;
342 case IMAGE_NT_OPTIONAL_HDR64_MAGIC:
343 mapping->size = ROUND_SIZE( nt.opt.hdr64.SizeOfImage );
344 mapping->base = nt.opt.hdr64.ImageBase;
345 mapping->header_size = nt.opt.hdr64.SizeOfHeaders;
346 break;
347 default:
348 goto error;
351 /* load the section headers */
353 pos += sizeof(nt.Signature) + sizeof(nt.FileHeader) + nt.FileHeader.SizeOfOptionalHeader;
354 size = sizeof(*sec) * nt.FileHeader.NumberOfSections;
355 if (pos + size > mapping->size) goto error;
356 if (pos + size > mapping->header_size) mapping->header_size = pos + size;
357 if (!(sec = malloc( size ))) goto error;
358 if (pread( unix_fd, sec, size, pos ) != size) goto error;
360 if (!build_shared_mapping( mapping, unix_fd, sec, nt.FileHeader.NumberOfSections )) goto error;
362 if (mapping->shared_file) list_add_head( &shared_list, &mapping->shared_entry );
364 mapping->protect = VPROT_IMAGE;
365 free( sec );
366 release_object( fd );
367 return 1;
369 error:
370 free( sec );
371 release_object( fd );
372 set_error( STATUS_INVALID_FILE_FOR_SECTION );
373 return 0;
376 /* get the size of the unix file associated with the mapping */
377 static inline int get_file_size( struct file *file, mem_size_t *size )
379 struct stat st;
380 int unix_fd = get_file_unix_fd( file );
382 if (unix_fd == -1 || fstat( unix_fd, &st ) == -1) return 0;
383 *size = st.st_size;
384 return 1;
387 static struct object *create_mapping( struct directory *root, const struct unicode_str *name,
388 unsigned int attr, mem_size_t size, int protect,
389 obj_handle_t handle, const struct security_descriptor *sd )
391 struct mapping *mapping;
392 int access = 0;
394 if (!page_mask) init_page_size();
396 if (!(mapping = create_named_object_dir( root, name, attr, &mapping_ops )))
397 return NULL;
398 if (get_error() == STATUS_OBJECT_NAME_EXISTS)
399 return &mapping->obj; /* Nothing else to do */
401 if (sd) default_set_sd( &mapping->obj, sd, OWNER_SECURITY_INFORMATION|
402 GROUP_SECURITY_INFORMATION|
403 DACL_SECURITY_INFORMATION|
404 SACL_SECURITY_INFORMATION );
405 mapping->header_size = 0;
406 mapping->base = 0;
407 mapping->file = NULL;
408 mapping->shared_file = NULL;
409 mapping->committed = NULL;
411 if (protect & VPROT_READ) access |= FILE_READ_DATA;
412 if (protect & VPROT_WRITE) access |= FILE_WRITE_DATA;
414 if (handle)
416 if (!(protect & VPROT_COMMITTED))
418 set_error( STATUS_INVALID_PARAMETER );
419 goto error;
421 if (!(mapping->file = get_file_obj( current->process, handle, access ))) goto error;
422 if (protect & VPROT_IMAGE)
424 if (!get_image_params( mapping )) goto error;
425 return &mapping->obj;
427 if (!size)
429 if (!get_file_size( mapping->file, &size )) goto error;
430 if (!size)
432 set_error( STATUS_MAPPED_FILE_SIZE_ZERO );
433 goto error;
436 else
438 if (!grow_file( mapping->file, size )) goto error;
441 else /* Anonymous mapping (no associated file) */
443 if (!size || (protect & VPROT_IMAGE))
445 set_error( STATUS_INVALID_PARAMETER );
446 goto error;
448 if (!(protect & VPROT_COMMITTED))
450 if (!(mapping->committed = mem_alloc( offsetof(struct ranges, ranges[8]) ))) goto error;
451 mapping->committed->count = 0;
452 mapping->committed->max = 8;
454 if (!(mapping->file = create_temp_file( access ))) goto error;
455 if (!grow_file( mapping->file, size )) goto error;
457 mapping->size = (size + page_mask) & ~((mem_size_t)page_mask);
458 mapping->protect = protect;
459 return &mapping->obj;
461 error:
462 release_object( mapping );
463 return NULL;
466 static void mapping_dump( struct object *obj, int verbose )
468 struct mapping *mapping = (struct mapping *)obj;
469 assert( obj->ops == &mapping_ops );
470 fprintf( stderr, "Mapping size=%08x%08x prot=%08x file=%p header_size=%08x base=%08lx "
471 "shared_file=%p ",
472 (unsigned int)(mapping->size >> 32), (unsigned int)mapping->size,
473 mapping->protect, mapping->file, mapping->header_size,
474 (unsigned long)mapping->base, mapping->shared_file );
475 dump_object_name( &mapping->obj );
476 fputc( '\n', stderr );
479 static struct object_type *mapping_get_type( struct object *obj )
481 static const WCHAR name[] = {'S','e','c','t','i','o','n'};
482 static const struct unicode_str str = { name, sizeof(name) };
483 return get_object_type( &str );
486 static struct fd *mapping_get_fd( struct object *obj )
488 struct mapping *mapping = (struct mapping *)obj;
489 return get_obj_fd( (struct object *)mapping->file );
492 static unsigned int mapping_map_access( struct object *obj, unsigned int access )
494 if (access & GENERIC_READ) access |= STANDARD_RIGHTS_READ | SECTION_QUERY | SECTION_MAP_READ;
495 if (access & GENERIC_WRITE) access |= STANDARD_RIGHTS_WRITE | SECTION_MAP_WRITE;
496 if (access & GENERIC_EXECUTE) access |= STANDARD_RIGHTS_EXECUTE | SECTION_MAP_EXECUTE;
497 if (access & GENERIC_ALL) access |= SECTION_ALL_ACCESS;
498 return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
501 static void mapping_destroy( struct object *obj )
503 struct mapping *mapping = (struct mapping *)obj;
504 assert( obj->ops == &mapping_ops );
505 if (mapping->file) release_object( mapping->file );
506 if (mapping->shared_file)
508 release_object( mapping->shared_file );
509 list_remove( &mapping->shared_entry );
511 free( mapping->committed );
514 int get_page_size(void)
516 if (!page_mask) init_page_size();
517 return page_mask + 1;
520 /* create a file mapping */
521 DECL_HANDLER(create_mapping)
523 struct object *obj;
524 struct unicode_str name;
525 struct directory *root = NULL;
526 const struct object_attributes *objattr = get_req_data();
527 const struct security_descriptor *sd;
529 reply->handle = 0;
531 if (!objattr_is_valid( objattr, get_req_data_size() ))
532 return;
534 sd = objattr->sd_len ? (const struct security_descriptor *)(objattr + 1) : NULL;
535 objattr_get_name( objattr, &name );
537 if (objattr->rootdir && !(root = get_directory_obj( current->process, objattr->rootdir, 0 )))
538 return;
540 if ((obj = create_mapping( root, &name, req->attributes, req->size, req->protect, req->file_handle, sd )))
542 if (get_error() == STATUS_OBJECT_NAME_EXISTS)
543 reply->handle = alloc_handle( current->process, obj, req->access, req->attributes );
544 else
545 reply->handle = alloc_handle_no_access_check( current->process, obj, req->access, req->attributes );
546 release_object( obj );
549 if (root) release_object( root );
552 /* open a handle to a mapping */
553 DECL_HANDLER(open_mapping)
555 struct unicode_str name;
556 struct directory *root = NULL;
557 struct mapping *mapping;
559 get_req_unicode_str( &name );
560 if (req->rootdir && !(root = get_directory_obj( current->process, req->rootdir, 0 )))
561 return;
563 if ((mapping = open_object_dir( root, &name, req->attributes, &mapping_ops )))
565 reply->handle = alloc_handle( current->process, &mapping->obj, req->access, req->attributes );
566 release_object( mapping );
569 if (root) release_object( root );
572 /* get a mapping information */
573 DECL_HANDLER(get_mapping_info)
575 struct mapping *mapping;
576 struct fd *fd;
578 if ((mapping = (struct mapping *)get_handle_obj( current->process, req->handle,
579 req->access, &mapping_ops )))
581 reply->size = mapping->size;
582 reply->protect = mapping->protect;
583 reply->header_size = mapping->header_size;
584 reply->base = mapping->base;
585 reply->shared_file = 0;
586 if ((fd = get_obj_fd( &mapping->obj )))
588 if (!is_fd_removable(fd))
589 reply->mapping = alloc_handle( current->process, mapping, 0, 0 );
590 release_object( fd );
592 if (mapping->shared_file)
594 if (!(reply->shared_file = alloc_handle( current->process, mapping->shared_file,
595 GENERIC_READ|GENERIC_WRITE, 0 )))
597 if (reply->mapping) close_handle( current->process, reply->mapping );
600 release_object( mapping );
604 /* get a range of committed pages in a file mapping */
605 DECL_HANDLER(get_mapping_committed_range)
607 struct mapping *mapping;
609 if ((mapping = (struct mapping *)get_handle_obj( current->process, req->handle, 0, &mapping_ops )))
611 if (!(req->offset & page_mask) && req->offset < mapping->size)
612 reply->committed = find_committed_range( mapping, req->offset, &reply->size );
613 else
614 set_error( STATUS_INVALID_PARAMETER );
616 release_object( mapping );
620 /* add a range to the committed pages in a file mapping */
621 DECL_HANDLER(add_mapping_committed_range)
623 struct mapping *mapping;
625 if ((mapping = (struct mapping *)get_handle_obj( current->process, req->handle, 0, &mapping_ops )))
627 if (!(req->size & page_mask) &&
628 !(req->offset & page_mask) &&
629 req->offset < mapping->size &&
630 req->size > 0 &&
631 req->size <= mapping->size - req->offset)
632 add_committed_range( mapping, req->offset, req->offset + req->size );
633 else
634 set_error( STATUS_INVALID_PARAMETER );
636 release_object( mapping );