hprof: hprof_object.c Source File

00001 /*
00002  * @(#)hprof_object.c 1.25 10/03/23
00003  * 
00004  * Copyright (c) 2006, Oracle and/or its affiliates. All rights reserved.
00005  * 
00006  * Redistribution and use in source and binary forms, with or without
00007  * modification, are permitted provided that the following conditions are met:
00008  * 
00009  * -Redistribution of source code must retain the above copyright notice, this
00010  *  list of conditions and the following disclaimer.
00011  * 
00012  * -Redistribution in binary form must reproduce the above copyright notice, 
00013  *  this list of conditions and the following disclaimer in the documentation
00014  *  and/or other materials provided with the distribution.
00015  * 
00016  * Neither the name of Oracle or the names of contributors may 
00017  * be used to endorse or promote products derived from this software without 
00018  * specific prior written permission.
00019  * 
00020  * This software is provided "AS IS," without a warranty of any kind. ALL 
00021  * EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING
00022  * ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
00023  * OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN MICROSYSTEMS, INC. ("SUN")
00024  * AND ITS LICENSORS SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE
00025  * AS A RESULT OF USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS
00026  * DERIVATIVES. IN NO EVENT WILL SUN OR ITS LICENSORS BE LIABLE FOR ANY LOST 
00027  * REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, 
00028  * INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY 
00029  * OF LIABILITY, ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE, 
00030  * EVEN IF SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
00031  * 
00032  * You acknowledge that this software is not designed, licensed or intended
00033  * for use in the design, construction, operation or maintenance of any
00034  * nuclear facility.
00035  */
00036 
00037 /* Object table. */
00038 
00039 /*
00040  * An Object is unique by it's allocation site (SiteIndex), it's size,
00041  *   it's kind, and it's serial number. Normally only the serial number
00042  *   would have been necessary for heap=dump, and these other items
00043  *   could have been moved to the ObjectInfo. An optimization left
00044  *   to the reader. Lookups are not normally done on ObjectIndex's
00045  *   anyway because we typically know when to create them. 
00046  *   Objects that have been tagged, are tagged with an ObjectIndex,
00047  *   Objects that are not tagged need a ObjectIndex, a lookup when
00048  *     heap=sites, and a new one when heap=dump.
00049  *   Objects that are freed, need the tag converted to an ObjectIndex,
00050  *     so they can be freed, but only when heap=dump.
00051  *   The thread serial number is for the thread associated with this
00052  *     object. If the object is a Thread object, it should be the serial
00053  *     number for that thread. The ThreadStart event is responsible
00054  *     for making sure the thread serial number is correct, but between the
00055  *     initial allocation of a Thread object and it's ThreadStart event
00056  *     the thread serial number could be for the thread that allocated
00057  *     the Thread object.
00058  *
00059  * This will likely be the largest table when using heap=dump, when
00060  *   there is one table entry per object.
00061  *
00062  * ObjectIndex entries differ between heap=dump and heap=sites.
00063  *   With heap=sites, each ObjectIndex represents a unique site, size,
00064  *   and kind of object, so many jobject's will map to a single ObjectIndex.
00065  *   With heap=dump, every ObjectIndex maps to a unique jobject.
00066  *
00067  * During processing of a heap dump, the references for the object
00068  *   this ObjectIndex represents is assigned to the references field
00069  *   of the ObjectInfo as a linked list. (see hprof_references.c).
00070  *   Once all the refernces are attached, they are processed into the
00071  *   appropriate hprof dump information.
00072  * 
00073  * The references field is set and cleared as many times as the heap
00074  *   is dumped, as is the reference table.
00075  *
00076  */
00077 
00078 #include "hprof.h"
00079 
00080 typedef struct ObjectKey {
00081     SiteIndex    site_index;  /* Site of allocation */
00082     jint         size;          /* Size of object as reported by VM */
00083     ObjectKind   kind;          /* Kind of object, most are OBJECT_NORMAL */
00084     SerialNumber serial_num;    /* For heap=dump, a unique number. */
00085 } ObjectKey;
00086 
00087 typedef struct ObjectInfo {
00088     RefIndex     references;        /* Linked list of refs in this object */
00089     SerialNumber thread_serial_num; /* Thread serial number for allocation */
00090 } ObjectInfo;
00091 
00092 /* Private internal functions. */
00093 
00094 static ObjectKey*
00095 get_pkey(ObjectIndex index)
00096 {
00097     void *key_ptr;
00098     int   key_len;
00099 
00100     table_get_key(gdata->object_table, index, (void*)&key_ptr, &key_len);
00101     HPROF_ASSERT(key_len==(int)sizeof(ObjectKey));
00102     HPROF_ASSERT(key_ptr!=NULL);
00103     return (ObjectKey*)key_ptr;
00104 }
00105 
00106 static ObjectInfo *
00107 get_info(ObjectIndex index)
00108 {
00109     ObjectInfo *info;
00110 
00111     info = (ObjectInfo*)table_get_info(gdata->object_table, index);
00112     return info;
00113 }
00114 
00115 static void
00116 list_item(TableIndex i, void *key_ptr, int key_len, void *info_ptr, void *arg)
00117 {
00118     ObjectKey  *pkey;
00119     ObjectInfo *info;
00120     
00121     HPROF_ASSERT(key_ptr!=NULL);
00122     HPROF_ASSERT(key_len!=0);
00123     HPROF_ASSERT(info_ptr!=NULL);
00124 
00125     info = (ObjectInfo*)info_ptr;
00126    
00127     pkey = (ObjectKey*)key_ptr;
00128     debug_message( "Object 0x%08x: site=0x%08x, SN=%u, "
00129         " size=%d, kind=%d, refs=0x%x, threadSN=%u\n",
00130    i, pkey->site_index, pkey->serial_num, pkey->size, pkey->kind,
00131    info->references, info->thread_serial_num);
00132 }
00133 
00134 static void
00135 clear_references(TableIndex i, void *key_ptr, int key_len, void *info_ptr, void *arg)
00136 {
00137     ObjectInfo *info;
00138     
00139     HPROF_ASSERT(info_ptr!=NULL);
00140     info = (ObjectInfo *)info_ptr;
00141     info->references = 0;
00142 }
00143 
00144 static void
00145 dump_class_references(TableIndex i, void *key_ptr, int key_len, void *info_ptr, void *arg)
00146 {
00147     ObjectInfo *info;
00148     
00149     HPROF_ASSERT(info_ptr!=NULL);
00150     info = (ObjectInfo *)info_ptr;
00151     reference_dump_class((JNIEnv*)arg, i, info->references);
00152 }
00153 
00154 static void
00155 dump_instance_references(TableIndex i, void *key_ptr, int key_len, void *info_ptr, void *arg)
00156 {
00157     ObjectInfo *info;
00158     
00159     HPROF_ASSERT(info_ptr!=NULL);
00160     info = (ObjectInfo *)info_ptr;
00161     reference_dump_instance((JNIEnv*)arg, i, info->references);
00162 }
00163 
00164 /* External interfaces. */
00165 
00166 ObjectIndex
00167 object_new(SiteIndex site_index, jint size, ObjectKind kind, SerialNumber thread_serial_num)
00168 {
00169     ObjectIndex index;
00170     ObjectKey   key;
00171     static ObjectKey empty_key;
00172     
00173     key            = empty_key;
00174     key.site_index = site_index;
00175     key.size       = size;
00176     key.kind       = kind;
00177     if ( gdata->heap_dump ) {
00178   static ObjectInfo empty_info;
00179   ObjectInfo i;
00180 
00181   i = empty_info;
00182   i.thread_serial_num = thread_serial_num;
00183         key.serial_num = gdata->object_serial_number_counter++;
00184   index = table_create_entry(gdata->object_table, 
00185           &key, (int)sizeof(ObjectKey), &i);
00186     } else {
00187         key.serial_num = 
00188        class_get_serial_number(site_get_class_index(site_index));
00189   index = table_find_or_create_entry(gdata->object_table, 
00190           &key, (int)sizeof(ObjectKey), NULL, NULL);
00191     }
00192     site_update_stats(site_index, size, 1);
00193     return index;
00194 }
00195 
00196 void
00197 object_init(void)
00198 {
00199     jint bucket_count;
00200     
00201     bucket_count = 511;
00202     if ( gdata->heap_dump ) {
00203   bucket_count = 0;
00204     }
00205     HPROF_ASSERT(gdata->object_table==NULL);
00206     gdata->object_table = table_initialize("Object", 4096, 
00207       4096, bucket_count, (int)sizeof(ObjectInfo));
00208 }
00209 
00210 SiteIndex
00211 object_get_site(ObjectIndex index)
00212 {
00213     ObjectKey *pkey;
00214     
00215     pkey = get_pkey(index);
00216     return pkey->site_index;
00217 }
00218 
00219 jint
00220 object_get_size(ObjectIndex index)
00221 {
00222     ObjectKey *pkey;
00223     
00224     pkey = get_pkey(index);
00225     return pkey->size;
00226 }
00227 
00228 ObjectKind
00229 object_get_kind(ObjectIndex index)
00230 {
00231     ObjectKey *pkey;
00232     
00233     pkey = get_pkey(index);
00234     return pkey->kind;
00235 }
00236 
00237 ObjectKind
00238 object_free(ObjectIndex index)
00239 {
00240     ObjectKey *pkey;
00241     ObjectKind kind;
00242     
00243     pkey = get_pkey(index);
00244     kind = pkey->kind;
00245        
00246     /* Decrement allocations at this site. */
00247     site_update_stats(pkey->site_index, -(pkey->size), -1);
00248 
00249     if ( gdata->heap_dump ) {
00250   table_free_entry(gdata->object_table, index);
00251     }
00252     return kind;
00253 }
00254 
00255 void
00256 object_list(void)
00257 {
00258     debug_message( 
00259         "--------------------- Object Table ------------------------\n");
00260     table_walk_items(gdata->object_table, &list_item, NULL);
00261     debug_message(
00262         "----------------------------------------------------------\n");
00263 }
00264 
00265 void
00266 object_cleanup(void)
00267 {
00268     table_cleanup(gdata->object_table, NULL, NULL);
00269     gdata->object_table = NULL;
00270 }
00271 
00272 void
00273 object_set_thread_serial_number(ObjectIndex index, 
00274         SerialNumber thread_serial_num)
00275 {
00276     ObjectInfo *info;
00277     
00278     info = get_info(index);
00279     info->thread_serial_num = thread_serial_num;
00280 }
00281 
00282 SerialNumber
00283 object_get_thread_serial_number(ObjectIndex index)
00284 {
00285     ObjectInfo *info;
00286     
00287     info = get_info(index);
00288     return info->thread_serial_num;
00289 }
00290 
00291 RefIndex
00292 object_get_references(ObjectIndex index)
00293 {
00294     ObjectInfo *info;
00295     
00296     info = get_info(index);
00297     return info->references;
00298 }
00299 
00300 void
00301 object_set_references(ObjectIndex index, RefIndex ref_index)
00302 {
00303     ObjectInfo *info;
00304     
00305     info = get_info(index);
00306     info->references = ref_index;
00307 }
00308 
00309 void
00310 object_clear_references(void)
00311 {
00312     table_walk_items(gdata->object_table, &clear_references, NULL);
00313 }
00314 
00315 void
00316 object_reference_dump(JNIEnv *env)
00317 {
00318     table_walk_items(gdata->object_table, &dump_instance_references, (void*)env);
00319     table_walk_items(gdata->object_table, &dump_class_references, (void*)env);
00320 }