Added: harmony/standard/site/docs/externals/vm_doc/html/hyipcmutex_8c.html URL: http://svn.apache.org/viewvc/harmony/standard/site/docs/externals/vm_doc/html/hyipcmutex_8c.html?rev=724734&view=auto ============================================================================== --- harmony/standard/site/docs/externals/vm_doc/html/hyipcmutex_8c.html (added) +++ harmony/standard/site/docs/externals/vm_doc/html/hyipcmutex_8c.html Tue Dec 9 07:03:45 2008 @@ -0,0 +1,191 @@ + + +Harmony Class Library Porting: modules/portlib/src/main/native/port/windows/hyipcmutex.c File Reference + + + + +
+ +
+

modules/portlib/src/main/native/port/windows/hyipcmutex.c File Reference


Detailed Description

+Shared Resource Mutex. +

+The HYIPCMutex is used to protect a shared resource from simultaneous access by processes or threads executing in the same or different VMs. Each process/thread must request and wait for the ownership of the shared resource before it can use that resource. It must also release the ownership of the resource as soon as it has finished using it so that other processes competing for the same resource are not delayed. +

+#include <windows.h>
+#include "hyport.h"
+ + + + + + + + + + + + + + + +

Functions

I_32 VMCALL hyipcmutex_acquire (struct HyPortLibrary *portLibrary, const char *name)
 Acquires a named mutex for the calling process.
I_32 VMCALL hyipcmutex_release (struct HyPortLibrary *portLibrary, const char *name)
 Releases a named Mutex from the calling process.
void VMCALL hyipcmutex_shutdown (struct HyPortLibrary *portLibrary)
 PortLibrary shutdown.
I_32 VMCALL hyipcmutex_startup (struct HyPortLibrary *portLibrary)
 PortLibrary startup.
+


Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
I_32 VMCALL hyipcmutex_acquire (struct HyPortLibrary portLibrary,
const char *  name 
)
+
+
+ +

+Acquires a named mutex for the calling process. +

+If a Mutex with the same Name already exists, the function opens the existing Mutex and tries to lock it. If another process already has the Mutex locked, the function will block indefinitely. If there is no Mutex with the same Name, the function will create it and lock it for the calling process of this function.

+

Parameters:
+ + + +
[in] portLibrary The port library
[in] name Mutex to be acquired
+
+
Returns:
0 on success, -1 on error.
+
Note:
The Mutex must be explicitly released by calling the hyipcmutex_release function as soon as the lock is no longer required.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
I_32 VMCALL hyipcmutex_release (struct HyPortLibrary portLibrary,
const char *  name 
)
+
+
+ +

+Releases a named Mutex from the calling process. +

+If a Mutex with the same Name already exists, the function opens the existing Mutex and tries to unlock it. This function will fail if a Mutex with the given Name is not found or if the Mutex cannot be unlocked.

+

Parameters:
+ + + +
[in] portLibrary The port library
[in] name Mutex to be released.
+
+
Returns:
0 on success, -1 on error.
+
Note:
Callers of this function must have called the function hyipcmutex_acquire prior to calling this function.
+ +
+

+ +

+
+ + + + + + + + + +
void VMCALL hyipcmutex_shutdown (struct HyPortLibrary portLibrary  ) 
+
+
+ +

+PortLibrary shutdown. +

+This function is called during shutdown of the portLibrary. Any resources that were created by hyipcmutex_startup should be destroyed here.

+

Parameters:
+ + +
[in] portLibrary The port library
+
+
Note:
Most implementations will be empty.
+ +
+

+ +

+
+ + + + + + + + + +
I_32 VMCALL hyipcmutex_startup (struct HyPortLibrary portLibrary  ) 
+
+
+ +

+PortLibrary startup. +

+This function is called during startup of the portLibrary. Any resources that are required for the IPC mutex operations may be created here. All resources created here should be destroyed in hyipcmutex_shutdown.

+

Parameters:
+ + +
[in] portLibrary The port library
+
+
Returns:
0 on success, negative error code on failure. Error code values returned are
    +
  • HYPORT_ERROR_STARTUP_IPCMUTEX
  • +
+
+
Note:
Most implementations will simply return success.
+ +
+

+


+
+ +

Genereated on Tue Dec 9 14:12:59 2008 by Doxygen.

+

(c) Copyright 2005, 2008 The Apache Software Foundation or its licensors, as applicable.

+
+
+ + Propchange: harmony/standard/site/docs/externals/vm_doc/html/hyipcmutex_8c.html ------------------------------------------------------------------------------ svn:eol-style = native Added: harmony/standard/site/docs/externals/vm_doc/html/hymem_8c.html URL: http://svn.apache.org/viewvc/harmony/standard/site/docs/externals/vm_doc/html/hymem_8c.html?rev=724734&view=auto ============================================================================== --- harmony/standard/site/docs/externals/vm_doc/html/hymem_8c.html (added) +++ harmony/standard/site/docs/externals/vm_doc/html/hymem_8c.html Tue Dec 9 07:03:45 2008 @@ -0,0 +1,298 @@ + + +Harmony Class Library Porting: modules/portlib/src/main/native/port/windows/hymem.c File Reference + + + + +
+ +
+

modules/portlib/src/main/native/port/windows/hymem.c File Reference


Detailed Description

+Memory Utilities. +

+ +

+#include <windows.h>
+#include "hyport.h"
+#include "portpriv.h"
+#include "hyportpg.h"
+#include "ut_hyprt.h"
+ + + + + + + + + + + + + + + + + + + + + +

Functions

void *VMCALL hymem_allocate_memory (struct HyPortLibrary *portLibrary, UDATA byteAmount)
 Allocate memory.
void VMCALL hymem_free_memory (struct HyPortLibrary *portLibrary, void *memoryPointer)
 Deallocate memory.
void *VMCALL hymem_reallocate_memory (struct HyPortLibrary *portLibrary, void *memoryPointer, UDATA byteAmount)
 Re-allocate memory.
void VMCALL hymem_shutdown (struct HyPortLibrary *portLibrary)
 PortLibrary shutdown.
I_32 VMCALL hymem_startup (struct HyPortLibrary *portLibrary, UDATA portGlobalSize)
 PortLibrary startup.
void *VMCALL hymem_allocate_memory_callSite (struct HyPortLibrary *portLibrary, UDATA byteAmount, char *callSite)
 Allocate memory.
+


Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
void* VMCALL hymem_allocate_memory (struct HyPortLibrary portLibrary,
UDATA  byteAmount 
)
+
+
+ +

+Allocate memory. +

+

Parameters:
+ + + +
[in] portLibrary The port library
[in] byteAmount Number of bytes to allocate.
+
+
Returns:
pointer to memory on success, NULL on error.

+Memory is not guaranteed to be zeroed as part of this call

+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void* VMCALL hymem_allocate_memory_callSite (struct HyPortLibrary portLibrary,
UDATA  byteAmount,
char *  callSite 
)
+
+
+ +

+Allocate memory. +

+

Parameters:
+ + + + +
[in] portLibrary The port library
[in] byteAmount Number of bytes to allocate.
[in] callSite String describing callsite, usually file and line number.
+
+
Returns:
pointer to memory on success, NULL on error.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void VMCALL hymem_free_memory (struct HyPortLibrary portLibrary,
void *  memoryPointer 
)
+
+
+ +

+Deallocate memory. +

+

Parameters:
+ + + +
[in] portLibrary The port library
[in] memoryPointer Base address of memory to be deallocated.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void* VMCALL hymem_reallocate_memory (struct HyPortLibrary portLibrary,
void *  memoryPointer,
UDATA  byteAmount 
)
+
+
+ +

+Re-allocate memory. +

+

Parameters:
+ + + + +
[in] portLibrary The port library
[in] memoryPointer Base address of memory to be re-allocated.
[in] byteAmount Number of bytes to re-allocated.
+
+
Returns:
pointer to memory on success, NULL on error.
+ +
+

+ +

+
+ + + + + + + + + +
void VMCALL hymem_shutdown (struct HyPortLibrary portLibrary  ) 
+
+
+ +

+PortLibrary shutdown. +

+This function is called during shutdown of the portLibrary. Any resources that were created by hymem_startup should be destroyed here.

+

Parameters:
+ + +
[in] portLibrary The port library
+
+
Note:
Must deallocate portGlobals.

+Most implementations will just deallocate portGlobals.

+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
I_32 VMCALL hymem_startup (struct HyPortLibrary portLibrary,
UDATA  portGlobalSize 
)
+
+
+ +

+PortLibrary startup. +

+This function is called during startup of the portLibrary. Any resources that are required for the memory operations may be created here. All resources created here should be destroyed in hymem_shutdown.

+

Parameters:
+ + + +
[in] portLibrary The port library
[in] portGlobalSize Size of the global data structure to allocate
+
+
Returns:
0 on success, negative error code on failure. Error code values returned are
    +
  • HYPORT_ERROR_STARTUP_MEM
  • +
+
+
Note:
Must allocate portGlobals.

+Most implementations will just allocate portGlobals.

+ +
+

+


+
+ +

Genereated on Tue Dec 9 14:12:59 2008 by Doxygen.

+

(c) Copyright 2005, 2008 The Apache Software Foundation or its licensors, as applicable.

+
+
+ + Propchange: harmony/standard/site/docs/externals/vm_doc/html/hymem_8c.html ------------------------------------------------------------------------------ svn:eol-style = native Added: harmony/standard/site/docs/externals/vm_doc/html/hymmap_8c.html URL: http://svn.apache.org/viewvc/harmony/standard/site/docs/externals/vm_doc/html/hymmap_8c.html?rev=724734&view=auto ============================================================================== --- harmony/standard/site/docs/externals/vm_doc/html/hymmap_8c.html (added) +++ harmony/standard/site/docs/externals/vm_doc/html/hymmap_8c.html Tue Dec 9 07:03:45 2008 @@ -0,0 +1,222 @@ + + +Harmony Class Library Porting: modules/portlib/src/main/native/port/windows/hymmap.c File Reference + + + + +
+ +
+

modules/portlib/src/main/native/port/windows/hymmap.c File Reference


Detailed Description

+Memory map. +

+This module provides memory mapping facilities that allow a user to map files into the virtual address space of the process. There are various options that can be used when mapping a file into memory, such as copy on write. Not all of these options are available on all platforms, hymmap_capabilities provides the list of supported options. Note also that on some platforms memory mapping facilites do not exist at all. On these platforms the API will still be available, but will simply read the file into allocated memory. +

+#include <windows.h>
+#include "hyport.h"
+ + + + + + + + + + + + + + + + + + +

Functions

void *VMCALL hymmap_map_file (struct HyPortLibrary *portLibrary, const char *path, void **handle)
 Map a file into memory.
void VMCALL hymmap_unmap_file (struct HyPortLibrary *portLibrary, void *handle)
 UnMap previously mapped memory.
void VMCALL hymmap_shutdown (struct HyPortLibrary *portLibrary)
 PortLibrary shutdown.
I_32 VMCALL hymmap_startup (struct HyPortLibrary *portLibrary)
 PortLibrary startup.
I_32 VMCALL hymmap_capabilities (struct HyPortLibrary *portLibrary)
 Check the capabilities available for HYMMAP at runtime for the current platform.
+


Function Documentation

+ +
+
+ + + + + + + + + +
I_32 VMCALL hymmap_capabilities (struct HyPortLibrary portLibrary  ) 
+
+
+ +

+Check the capabilities available for HYMMAP at runtime for the current platform. +

+

Parameters:
+ + +
[in] portLibrary The port library
+
+
Returns:
a bit map containing the capabilites supported by the hymmap sub component of the port library. Possible bit values: HYPORT_MMAP_CAPABILITY_COPYONWRITE - if not present, platform is not capable of "copy on write" memory mapping.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void* VMCALL hymmap_map_file (struct HyPortLibrary portLibrary,
const char *  path,
void **  handle 
)
+
+
+ +

+Map a file into memory. +

+

Parameters:
+ + + + +
[in] portLibrary The port library
[in] path - the path of the file to mapped into memory.
[out] handle - updates *handle with the memory map handle, this handle is later passed to unmap.
+
+
Returns:
pointer to newly mapped memory on success, NULL on error.
+ +
+

+ +

+
+ + + + + + + + + +
void VMCALL hymmap_shutdown (struct HyPortLibrary portLibrary  ) 
+
+
+ +

+PortLibrary shutdown. +

+

Parameters:
+ + +
[in] portLibrary The port library
+
+This function is called during shutdown of the portLibrary. Any resources that were created by hymmap_startup should be destroyed here. +
+

+ +

+
+ + + + + + + + + +
I_32 VMCALL hymmap_startup (struct HyPortLibrary portLibrary  ) 
+
+
+ +

+PortLibrary startup. +

+This function is called during startup of the portLibrary. Any resources that are required for the memory mapping operations may be created here. All resources created here should be destroyed in hymmap_shutdown.

+

Parameters:
+ + +
[in] portLibrary The port library
+
+
Returns:
0 on success, negative error code on failure. Error code values returned are
    +
  • HYPORT_ERROR_STARTUP_MMAP
  • +
+
+
Note:
Most implementations will simply return success.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void VMCALL hymmap_unmap_file (struct HyPortLibrary portLibrary,
void *  handle 
)
+
+
+ +

+UnMap previously mapped memory. +

+

Parameters:
+ + + +
[in] portLibrary The port library
[in] handle - the handle from the mmap_map_file.
+
+ +
+

+


+
+ +

Genereated on Tue Dec 9 14:12:59 2008 by Doxygen.

+

(c) Copyright 2005, 2008 The Apache Software Foundation or its licensors, as applicable.

+
+
+ + Propchange: harmony/standard/site/docs/externals/vm_doc/html/hymmap_8c.html ------------------------------------------------------------------------------ svn:eol-style = native Added: harmony/standard/site/docs/externals/vm_doc/html/hynls_8c.html URL: http://svn.apache.org/viewvc/harmony/standard/site/docs/externals/vm_doc/html/hynls_8c.html?rev=724734&view=auto ============================================================================== --- harmony/standard/site/docs/externals/vm_doc/html/hynls_8c.html (added) +++ harmony/standard/site/docs/externals/vm_doc/html/hynls_8c.html Tue Dec 9 07:03:45 2008 @@ -0,0 +1,502 @@ + + +Harmony Class Library Porting: modules/portlib/src/main/native/port/shared/hynls.c File Reference + + + + +
+ +
+

modules/portlib/src/main/native/port/shared/hynls.c File Reference


Detailed Description

+Native language support. +

+ +

+#include "hycomp.h"
+#include "hyport.h"
+#include "portpriv.h"
+#include "hythread.h"
+#include "hynlshelpers.h"
+#include "portnls.h"
+#include <stdlib.h>
+#include <string.h>
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Functions

void VMCALL hynls_set_locale (struct HyPortLibrary *portLibrary, const char *lang, const char *region, const char *variant)
 Set the language, region, and variant of the locale.
const char *VMCALL hynls_get_language (struct HyPortLibrary *portLibrary)
 Return the string representing the currently set language.
const char *VMCALL hynls_get_region (struct HyPortLibrary *portLibrary)
 Return the string representing the currently set region.
const char *VMCALL hynls_get_variant (struct HyPortLibrary *portLibrary)
 Return the string representing the currently set variant.
void VMCALL hynls_printf (struct HyPortLibrary *portLibrary, UDATA flags, U_32 module_name, U_32 message_num,...)
 Print a formatted NLS message.
void VMCALL hynls_vprintf (struct HyPortLibrary *portLibrary, UDATA flags, U_32 module_name, U_32 message_num, va_list args)
 Print a formatted NLS message.
const char *VMCALL hynls_lookup_message (struct HyPortLibrary *portLibrary, UDATA flags, U_32 module_name, U_32 message_num, const char *default_string)
 Return the NLS string for the module name and message number.
void VMCALL hynls_set_catalog (struct HyPortLibrary *portLibrary, const char **paths, const int nPaths, const char *baseName, const char *extension)
 Setup the path to the NLS catalog.
I_32 VMCALL hynls_startup (struct HyPortLibrary *portLibrary)
 PortLibrary startup.
void VMCALL hynls_shutdown (struct HyPortLibrary *portLibrary)
 PortLibrary shutdown.
+


Function Documentation

+ +
+
+ + + + + + + + + +
const char* VMCALL hynls_get_language (struct HyPortLibrary portLibrary  ) 
+
+
+ +

+Return the string representing the currently set language. +

+

Parameters:
+ + +
[in] portLibrary The port library
+
+
Returns:
language string
+ +
+

+ +

+
+ + + + + + + + + +
const char* VMCALL hynls_get_region (struct HyPortLibrary portLibrary  ) 
+
+
+ +

+Return the string representing the currently set region. +

+

Parameters:
+ + +
[in] portLibrary The port library
+
+
Returns:
region string
+ +
+

+ +

+
+ + + + + + + + + +
const char* VMCALL hynls_get_variant (struct HyPortLibrary portLibrary  ) 
+
+
+ +

+Return the string representing the currently set variant. +

+

Parameters:
+ + +
[in] portLibrary The port library
+
+
Returns:
variant string
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
const char* VMCALL hynls_lookup_message (struct HyPortLibrary portLibrary,
UDATA  flags,
U_32  module_name,
U_32  message_num,
const char *  default_string 
)
+
+
+ +

+Return the NLS string for the module name and message number. +

+If no string is found, or a failure occurs, return the default_string.

+

Parameters:
+ + + + + + +
[in] portLibrary The port library
[in] flags - to indicate what type of message (e.g., ERROR) and whether a newline is required
[in] module_name - the module identifier of the NLS message
[in] message_num - the NLS message number within the module
[in] default_string - a default message, in case no NLS message is found
+
+
Returns:
NLS String
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void VMCALL hynls_printf (struct HyPortLibrary portLibrary,
UDATA  flags,
U_32  module_name,
U_32  message_num,
  ... 
)
+
+
+ +

+Print a formatted NLS message. +

+

Parameters:
+ + + + + + +
[in] portLibrary The port library
[in] flags - to indicate what type of message (e.g., ERROR) and whether a newline is required
[in] module_name - the module identifier of the NLS message
[in] message_num - the NLS message number within the module
[in] ... - arguments used in the NLS message format
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void VMCALL hynls_set_catalog (struct HyPortLibrary portLibrary,
const char **  paths,
const int  nPaths,
const char *  baseName,
const char *  extension 
)
+
+
+ +

+Setup the path to the NLS catalog. +

+

Parameters:
+ + + + + + +
[in] portLibrary The port library
[in] paths - an array of directory paths where the NLS catalog may be found
[in] nPaths - the number of entries in the paths array
[in] baseName - the lead name of the catalog file name (i.e., the "java" in java_en_US.properties)
[in] extension - the extension of the catalog file name (i.e., the "properties in java_en_US.properties)
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void VMCALL hynls_set_locale (struct HyPortLibrary portLibrary,
const char *  lang,
const char *  region,
const char *  variant 
)
+
+
+ +

+Set the language, region, and variant of the locale. +

+

Parameters:
+ + + + + +
[in] portLibrary The port library
[in] lang - the language of the locale (e.g., "en"), 2 characters or less
[in] region - the region of the locale (e.g., "US"), 2 characters or less
[in] variant - the variant of the locale (e.g., "boont"), 31 characters or less
+
+ +
+

+ +

+
+ + + + + + + + + +
void VMCALL hynls_shutdown (struct HyPortLibrary portLibrary  ) 
+
+
+ +

+PortLibrary shutdown. +

+This function is called during shutdown of the portLibrary. Any resources that were created by hynls_startup should be destroyed here.

+

Parameters:
+ + +
[in] portLibrary The port library
+
+ +
+

+ +

+
+ + + + + + + + + +
I_32 VMCALL hynls_startup (struct HyPortLibrary portLibrary  ) 
+
+
+ +

+PortLibrary startup. +

+This function is called during startup of the portLibrary. Any resources that are required for the NLS library operations may be created here. All resources created here should be destroyed in hynls_shutdown.

+

Parameters:
+ + +
[in] portLibrary The port library
+
+
Returns:
0 on success, negative error code on failure. Error code values returned are
    +
  • HYPORT_ERROR_STARTUP_NLS
  • +
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void VMCALL hynls_vprintf (struct HyPortLibrary portLibrary,
UDATA  flags,
U_32  module_name,
U_32  message_num,
va_list  args 
)
+
+
+ +

+Print a formatted NLS message. +

+

Parameters:
+ + + + + + +
[in] portLibrary The port library
[in] flags - to indicate what type of message (e.g., ERROR) and whether a newline is required
[in] module_name - the module identifier of the NLS message
[in] message_num - the NLS message number within the module
[in] args - arguments used in the NLS message format
+
+ +
+

+


+
+ +

Genereated on Tue Dec 9 14:12:59 2008 by Doxygen.

+

(c) Copyright 2005, 2008 The Apache Software Foundation or its licensors, as applicable.

+
+
+ + Propchange: harmony/standard/site/docs/externals/vm_doc/html/hynls_8c.html ------------------------------------------------------------------------------ svn:eol-style = native Added: harmony/standard/site/docs/externals/vm_doc/html/hyosdump_8c.html URL: http://svn.apache.org/viewvc/harmony/standard/site/docs/externals/vm_doc/html/hyosdump_8c.html?rev=724734&view=auto ============================================================================== --- harmony/standard/site/docs/externals/vm_doc/html/hyosdump_8c.html (added) +++ harmony/standard/site/docs/externals/vm_doc/html/hyosdump_8c.html Tue Dec 9 07:03:45 2008 @@ -0,0 +1,104 @@ + + +Harmony Class Library Porting: modules/portlib/src/main/native/port/windows/hyosdump.c File Reference + + + + +
+ +
+

modules/portlib/src/main/native/port/windows/hyosdump.c File Reference


Detailed Description

+Dump formatting. +

+ +

+#include <windows.h>
+#include <winnt.h>
+#include <stdlib.h>
+#include <float.h>
+#include <process.h>
+#include <dbghelp.h>
+#include "hyport.h"
+#include "hysignal.h"
+ + + + + + +

Functions

UDATA VMCALL hydump_create (struct HyPortLibrary *portLibrary, char *filename, char *dumpType, void *userData)
 Create a dump file of the OS state.
+


Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
UDATA VMCALL hydump_create (struct HyPortLibrary portLibrary,
char *  filename,
char *  dumpType,
void *  userData 
)
+
+
+ +

+Create a dump file of the OS state. +

+

Parameters:
+ + + + + + +
[in] portLibrary The port library.
[in] filename Buffer for filename optionally containing the filename where dump is to be output.
[out] filename filename used for dump file or error message.
[in] dumpType Type of dump to perform.
[in] userData Implementation specific data.
+
+
Returns:
0 on success, non-zero otherwise.
+
Note:
filename buffer can not be NULL.

+user allocates and frees filename buffer.

+filename buffer length is platform dependent, assumed to be HyMaxPath/MAX_PATH

+if filename buffer is empty, a filename will be generated.

+if HYUNIQUE_DUMPS is set, filename will be unique.

+ +
+

+


+
+ +

Genereated on Tue Dec 9 14:12:59 2008 by Doxygen.

+

(c) Copyright 2005, 2008 The Apache Software Foundation or its licensors, as applicable.

+
+
+ + Propchange: harmony/standard/site/docs/externals/vm_doc/html/hyosdump_8c.html ------------------------------------------------------------------------------ svn:eol-style = native