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