- Use NULL instead of 0 for all non-handle pointers.
[wine] / server / snapshot.c
1 /*
2  * Server-side snapshots
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  * FIXME: heap snapshots not implemented
21  */
22
23 #include "config.h"
24 #include "wine/port.h"
25
26 #include <assert.h>
27 #include <stdio.h>
28 #include <stdlib.h>
29
30 #include "windef.h"
31
32 #include "handle.h"
33 #include "process.h"
34 #include "thread.h"
35 #include "request.h"
36
37
38 struct snapshot
39 {
40     struct object             obj;           /* object header */
41     struct process           *process;       /* process of this snapshot (for modules and heaps) */
42     struct process_snapshot  *processes;     /* processes snapshot */
43     int                       process_count; /* count of processes */
44     int                       process_pos;   /* current position in proc snapshot */
45     struct thread_snapshot   *threads;       /* threads snapshot */
46     int                       thread_count;  /* count of threads */
47     int                       thread_pos;    /* current position in thread snapshot */
48     struct module_snapshot   *modules;       /* modules snapshot */
49     int                       module_count;  /* count of modules */
50     int                       module_pos;    /* current position in module snapshot */
51 };
52
53 static void snapshot_dump( struct object *obj, int verbose );
54 static void snapshot_destroy( struct object *obj );
55
56 static const struct object_ops snapshot_ops =
57 {
58     sizeof(struct snapshot),      /* size */
59     snapshot_dump,                /* dump */
60     no_add_queue,                 /* add_queue */
61     NULL,                         /* remove_queue */
62     NULL,                         /* signaled */
63     NULL,                         /* satisfied */
64     no_signal,                    /* signal */
65     no_get_fd,                    /* get_fd */
66     snapshot_destroy              /* destroy */
67 };
68
69
70 /* create a new snapshot */
71 static struct snapshot *create_snapshot( process_id_t pid, int flags )
72 {
73     struct process *process = NULL;
74     struct snapshot *snapshot;
75
76     /* need a process for modules and heaps */
77     if (flags & (SNAP_MODULE|SNAP_HEAPLIST))
78     {
79         if (!pid) process = (struct process *)grab_object( current->process );
80         else if (!(process = get_process_from_id( pid ))) return NULL;
81     }
82
83     if (!(snapshot = alloc_object( &snapshot_ops )))
84     {
85         if (process) release_object( process );
86         return NULL;
87     }
88
89     snapshot->process = process;
90
91     snapshot->process_pos = 0;
92     snapshot->process_count = 0;
93     if (flags & SNAP_PROCESS)
94         snapshot->processes = process_snap( &snapshot->process_count );
95
96     snapshot->thread_pos = 0;
97     snapshot->thread_count = 0;
98     if (flags & SNAP_THREAD)
99         snapshot->threads = thread_snap( &snapshot->thread_count );
100
101     snapshot->module_pos = 0;
102     snapshot->module_count = 0;
103     if (flags & SNAP_MODULE)
104         snapshot->modules = module_snap( process, &snapshot->module_count );
105
106     return snapshot;
107 }
108
109 /* get the next process in the snapshot */
110 static int snapshot_next_process( struct snapshot *snapshot, struct next_process_reply *reply )
111 {
112     struct process_snapshot *ptr;
113
114     if (!snapshot->process_count)
115     {
116         set_error( STATUS_INVALID_PARAMETER );  /* FIXME */
117         return 0;
118     }
119     if (snapshot->process_pos >= snapshot->process_count)
120     {
121         set_error( STATUS_NO_MORE_FILES );
122         return 0;
123     }
124     ptr = &snapshot->processes[snapshot->process_pos++];
125     reply->count    = ptr->count;
126     reply->pid      = get_process_id( ptr->process );
127     reply->ppid     = ptr->process->parent ? get_process_id( ptr->process->parent ) : 0;
128     reply->heap     = NULL;  /* FIXME */
129     reply->module   = NULL;  /* FIXME */
130     reply->threads  = ptr->threads;
131     reply->priority = ptr->priority;
132     reply->handles  = ptr->handles;
133     if (ptr->process->exe.filename)
134     {
135         size_t len = min( ptr->process->exe.namelen, get_reply_max_size() );
136         set_reply_data( ptr->process->exe.filename, len );
137     }
138     return 1;
139 }
140
141 /* get the next thread in the snapshot */
142 static int snapshot_next_thread( struct snapshot *snapshot, struct next_thread_reply *reply )
143 {
144     struct thread_snapshot *ptr;
145
146     if (!snapshot->thread_count)
147     {
148         set_error( STATUS_INVALID_PARAMETER );  /* FIXME */
149         return 0;
150     }
151     if (snapshot->thread_pos >= snapshot->thread_count)
152     {
153         set_error( STATUS_NO_MORE_FILES );
154         return 0;
155     }
156     ptr = &snapshot->threads[snapshot->thread_pos++];
157     reply->count     = ptr->count;
158     reply->pid       = get_process_id( ptr->thread->process );
159     reply->tid       = get_thread_id( ptr->thread );
160     reply->base_pri  = ptr->priority;
161     reply->delta_pri = 0;  /* FIXME */
162     return 1;
163 }
164
165 /* get the next module in the snapshot */
166 static int snapshot_next_module( struct snapshot *snapshot, struct next_module_reply *reply )
167 {
168     struct module_snapshot *ptr;
169
170     if (!snapshot->module_count)
171     {
172         set_error( STATUS_INVALID_PARAMETER );  /* FIXME */
173         return 0;
174     }
175     if (snapshot->module_pos >= snapshot->module_count)
176     {
177         set_error( STATUS_NO_MORE_FILES );
178         return 0;
179     }
180     ptr = &snapshot->modules[snapshot->module_pos++];
181     reply->pid  = get_process_id( snapshot->process );
182     reply->base = ptr->base;
183     reply->size = ptr->size;
184     if (ptr->filename)
185     {
186         size_t len = min( ptr->namelen, get_reply_max_size() );
187         set_reply_data( ptr->filename, len );
188     }
189     return 1;
190 }
191
192 static void snapshot_dump( struct object *obj, int verbose )
193 {
194     struct snapshot *snapshot = (struct snapshot *)obj;
195     assert( obj->ops == &snapshot_ops );
196     fprintf( stderr, "Snapshot: %d procs %d threads %d modules\n",
197              snapshot->process_count, snapshot->thread_count, snapshot->module_count );
198 }
199
200 static void snapshot_destroy( struct object *obj )
201 {
202     int i;
203     struct snapshot *snapshot = (struct snapshot *)obj;
204     assert( obj->ops == &snapshot_ops );
205     if (snapshot->process_count)
206     {
207         for (i = 0; i < snapshot->process_count; i++)
208             release_object( snapshot->processes[i].process );
209         free( snapshot->processes );
210     }
211     if (snapshot->thread_count)
212     {
213         for (i = 0; i < snapshot->thread_count; i++)
214             release_object( snapshot->threads[i].thread );
215         free( snapshot->threads );
216     }
217     if (snapshot->module_count)
218     {
219         for (i = 0; i < snapshot->module_count; i++)
220             free( snapshot->modules[i].filename );
221         free( snapshot->modules );
222     }
223     if (snapshot->process) release_object( snapshot->process );
224 }
225
226 /* create a snapshot */
227 DECL_HANDLER(create_snapshot)
228 {
229     struct snapshot *snapshot;
230
231     reply->handle = 0;
232     if ((snapshot = create_snapshot( req->pid, req->flags )))
233     {
234         reply->handle = alloc_handle( current->process, snapshot, 0, req->inherit );
235         release_object( snapshot );
236     }
237 }
238
239 /* get the next process from a snapshot */
240 DECL_HANDLER(next_process)
241 {
242     struct snapshot *snapshot;
243
244     if ((snapshot = (struct snapshot *)get_handle_obj( current->process, req->handle,
245                                                        0, &snapshot_ops )))
246     {
247         if (req->reset) snapshot->process_pos = 0;
248         snapshot_next_process( snapshot, reply );
249         release_object( snapshot );
250     }
251 }
252
253 /* get the next thread from a snapshot */
254 DECL_HANDLER(next_thread)
255 {
256     struct snapshot *snapshot;
257
258     if ((snapshot = (struct snapshot *)get_handle_obj( current->process, req->handle,
259                                                        0, &snapshot_ops )))
260     {
261         if (req->reset) snapshot->thread_pos = 0;
262         snapshot_next_thread( snapshot, reply );
263         release_object( snapshot );
264     }
265 }
266
267 /* get the next module from a snapshot */
268 DECL_HANDLER(next_module)
269 {
270     struct snapshot *snapshot;
271
272     if ((snapshot = (struct snapshot *)get_handle_obj( current->process, req->handle,
273                                                        0, &snapshot_ops )))
274     {
275         if (req->reset) snapshot->module_pos = 0;
276         snapshot_next_module( snapshot, reply );
277         release_object( snapshot );
278     }
279 }