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