11449 <constant id="JVMTI_JLOCATION_OTHER" num="0"> 11450 <code>jlocation</code> values have some other representation. 11451 </constant> 11452 </constants> 11453 </description> 11454 <origin>new</origin> 11455 <capabilities> 11456 </capabilities> 11457 <parameters> 11458 <param id="format_ptr"> 11459 <outptr><enum>jvmtiJlocationFormat</enum></outptr> 11460 <description> 11461 On return, points to the format identifier for <code>jlocation</code> values. 11462 </description> 11463 </param> 11464 </parameters> 11465 <errors> 11466 </errors> 11467 </function> 11468 11469 </category> 11470 11471 </functionsection> 11472 11473 <errorsection label="Error Reference"> 11474 <intro> 11475 Every <jvmti/> function returns a <b><code>jvmtiError</code></b> error code. 11476 <p/> 11477 It is the responsibility of the agent to call <jvmti/> functions with 11478 valid parameters and in the proper context (calling thread is attached, 11479 phase is correct, etc.). 11480 Detecting some error conditions may be difficult, inefficient, or 11481 impossible for an implementation. 11482 The errors listed in 11483 <internallink id="reqerrors">Function Specific Required Errors</internallink> 11484 must be detected by the implementation. 11485 All other errors represent the recommended response to the error 11486 condition. 11487 </intro> 11488 | 11449 <constant id="JVMTI_JLOCATION_OTHER" num="0"> 11450 <code>jlocation</code> values have some other representation. 11451 </constant> 11452 </constants> 11453 </description> 11454 <origin>new</origin> 11455 <capabilities> 11456 </capabilities> 11457 <parameters> 11458 <param id="format_ptr"> 11459 <outptr><enum>jvmtiJlocationFormat</enum></outptr> 11460 <description> 11461 On return, points to the format identifier for <code>jlocation</code> values. 11462 </description> 11463 </param> 11464 </parameters> 11465 <errors> 11466 </errors> 11467 </function> 11468 11469 <function id="StartHeapSampling" phase="any" num="156"> 11470 <synopsis>Start Heap Sampling</synopsis> 11471 <description> 11472 Start the heap sampler in the JVM. The function provides, via its argument, the sampling 11473 rate requested and will fill internal data structures with heap allocation samples. The 11474 samples are obtained via the <functionlink id="GetLiveTraces"></functionlink> function. 11475 </description> 11476 <origin>new</origin> 11477 <capabilities> 11478 </capabilities> 11479 <parameters> 11480 <param id="monitoring_period"> 11481 <jint/> 11482 <description> 11483 The monitoring period used for sampling. The sampler will use a statistical approach to 11484 provide in average sampling every <paramlink id="monitoring_period"/> allocated bytes. 11485 </description> 11486 </param> 11487 </parameters> 11488 <errors> 11489 <error id="JVMTI_ERROR_ILLEGAL_ARGUMENT"> 11490 <paramlink id="monitoring_period"></paramlink> is less than zero. 11491 </error> 11492 </errors> 11493 </function> 11494 11495 11496 <function id="GetLiveTraces" num="157"> 11497 <synopsis>Get Live Traces</synopsis> 11498 <typedef id="jvmtiStackTraceData" label="Stack Trace Data"> 11499 <field id="trace"> 11500 <vmbuf><void/></vmbuf> 11501 <description> 11502 TODO(jcbeyler): Not sure if we should declare the type as non void and make a JVMTI type here. 11503 It would be ASGCT_CallTrace and then would include a pointer to ASGCT_CallFrame. Would we refactor that code? 11504 </description> 11505 </field> 11506 <field id="size"> 11507 <jint/> 11508 <description> 11509 The size of the object allocation. 11510 </description> 11511 </field> 11512 <field id="thread_id"> 11513 <jlong/> 11514 <description> 11515 The thread id number. 11516 </description> 11517 </field> 11518 </typedef> 11519 <description> 11520 Get Live Heap Sampled traces. The fields of the <datalink id="jvmtiStackTraceData"/> 11521 structure are filled in with details of the specified sampled allocation. 11522 </description> 11523 <origin>new</origin> 11524 <capabilities> 11525 </capabilities> 11526 <parameters> 11527 <param id="stack_traces"> 11528 <allocbuf outcount="num_traces"><struct>jvmtiStackTraceData</struct></allocbuf> 11529 <description> 11530 The stack trace array to be filled. 11531 </description> 11532 </param> 11533 <param id="num_traces"> 11534 <outptr><jint/></outptr> 11535 <description> 11536 On output, size of the array returned via the first parameter. 11537 </description> 11538 </param> 11539 </parameters> 11540 <errors> 11541 </errors> 11542 </function> 11543 11544 </category> 11545 11546 </functionsection> 11547 11548 <errorsection label="Error Reference"> 11549 <intro> 11550 Every <jvmti/> function returns a <b><code>jvmtiError</code></b> error code. 11551 <p/> 11552 It is the responsibility of the agent to call <jvmti/> functions with 11553 valid parameters and in the proper context (calling thread is attached, 11554 phase is correct, etc.). 11555 Detecting some error conditions may be difficult, inefficient, or 11556 impossible for an implementation. 11557 The errors listed in 11558 <internallink id="reqerrors">Function Specific Required Errors</internallink> 11559 must be detected by the implementation. 11560 All other errors represent the recommended response to the error 11561 condition. 11562 </intro> 11563 |