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