diff --git a/mps/manual/reference/index.html b/mps/manual/reference/index.html index c97226fe95e..1087452fe71 100644 --- a/mps/manual/reference/index.html +++ b/mps/manual/reference/index.html @@ -66,7 +66,6 @@

MPS_ARCH_AL

@@ -276,70 +268,6 @@ typedef struct RegisterFile { 1997-05-01

-

MPS_ARCH_M6

- - -

Name

- -

MPS_ARCH_M6

- - -

Summary

- -

MPS_ARCH_M6 is a C -preprocessor macro that indicates, if defined, that the target -processor architecture of the compilation is a member of the Motorola -68000 family. It is defined, if appropriate, by "mpstd.h".

- - -

Associated Protocols

- -

None.

- - -

Resources

- -

msptd.h.

- - -

Description

- -

See summary.

- - -

Example

- -
-#ifdef MPS_ARCH_M6
-
-typedef struct RegisterFile {
-  unsigned long d[8];
-  unsigned long a[8];
-  unsigned long usp, msp, isp, pc, sr;
-} RegisterFile;
-
-#endif /* MPS_ARCH_M6 */
-
- - -

Error Handling

- -

Not applicable.

- - -

See Also

- -

- -MPS_PF_*, - -MPS_OS_*, - -MPS_BUILD_*, - -MPS_ARCH_*

- -

function mps_fix

@@ -1302,9 +1230,7 @@ the MPS.

href="#mps_root_create_table">mps_root_create_table, mps_root_create_table_masked, - -MPS_RM_PROT_INNER

+href="#mps_root_create_table_masked">mps_root_create_table_masked.

Notes

@@ -1335,97 +1261,6 @@ root. Lots of OSes can't cope with writing to protected pages. So we'll need to document that caveat too. drj 1998-05-20

-

MPS_RM_PROT_INNER

- - -

Name

- -

MPS_RM_PROT_INNER

- - -

Summary

- -

MPS_RM_PROT_INNER is -a constant used in root mode arguments to indicate partially -protectable roots.

- - -

Associated Protocols

- -

Root.

- - -

Type

- -

Integral constant.

- - -

Resources

- -

mps.h

- - -

Description

- -

MPS_RM_PROT_INNER is -a preprocessor macro defining a constant that can be OR'ed with other -MPS_RM_* constants, and passed as the root mode argument -to certain root creation functions (mps_root_create_fmt, mps_root_create_table, -mps_root_create_table_masked).

- -

Passing MPS_RM_PROT_INNER means that the -MPS may place a hardware write barrier on any pages which are entirely -covered by the root. Format methods and any scanning function (except -for the one for this root) may not write data in this root. They may -read it.

- - -

Example

- -
-res = mps_root_create_table(&mmRoot, arena, mps_rank_exact(),
-                            MPS_RM_PROT | MPS_RM_PROT_INNER,
-                            (mps_addr_t)&Objects, rootCOUNT);
-
- - -

See Also

- -

- -mps_root_create_fmt, - -mps_root_create_table, - -mps_root_create_table_masked, - -MPS_RM_PROT

- - -

Notes

- -

To specify MPS_RM_PROT_INNER, you must also -specify MPS_RM_PROT. The -meaning of MPS_RM_PROT is -overridden by MPS_RM_PROT_INNER.

- - -

Internal Notes

- -

Future meaning: The MPS may place a hardware read and/or write -barrier on any pages which are entirely covered by the root. Format -methods and scanning functions (except for the one for this root) may -not read or write data in this root.

- -

function mps_sac_alloc

@@ -4530,209 +4365,6 @@ href="#mps_arena_spare_commit_limit">mps_arena_spare_commit_limit

None.

-

function mps_assert_default

- - -

Name

- -

mps_assert_default

- - -

Summary

- -

mps_assert_default returns a pointer to the default assertion handler.

- - -

Associated Protocols

- -

Assertion.

- - -

Syntax

- - -

Arguments

- -

None.

- - -

Initial/Default Values

- -

None.

- - -

Returned Values

- -

A pointer to the default assertion handler.

- - -

Resources

- -

mps.h

- - -

Description

- -

mps_assert_default returns a pointer to the default assertion handler. It is intended tobe used in conjunction with mps_assert_install.

- -

You may also call the default assertion handler directly, in which case the first, second,and third arguments must be non-NULL pointers to zero-terminated strings.

- - -

Example

- - -

Error Handling

- -

Can't fail.

- - -

See Also

- -

- -mps_assert_install

- -

"Assertion Protocol"

- - -

Notes

- -

None.

- - -

function mps_assert_install

- - -

Name

- -

mps_assert_install

- - -

Summary

- -

mps_assert_install installs the specified assertion handler as the current assertionhandler.

- - -

Associated Protocols

- -

Assertion.

- - -

Syntax

- -

mps_assert_t mps_assert_install(void my_assertion_handler);

- - -

Arguments

- -

my_assertion_handler the handler that you want to install

- - -

Returned Values

- -

A pointer to the previously installed assertion handler.

- - -

Resources

- -

mps.h

- - -

Description

- -

mps_assert_install installs the specified assertion handler as the current assertionhandler. It returns a pointer to the previously installed assertion handler. Note that there is oneMPS assertion handler for the entire process (in particular it is not per arena).

- - -

Example

- -
-mps_assert_t old_handler;
-
-void my_assertion_handler(const char *cond,
-const char *id,
-const char *file, unsigned int line)
-{
-  fatal_error_dialog("The Memory Pool System detected an inconsistency"
-                     "in file %s at line%u: %s\n", file, line, cond);
-  old_handler(cond, id, file, line);
-  abort();
-  NOTREACHED;
-}
-
-/* ... */
-
-  /* install the handler: */
-  old_handler = mps_assert_install(my_assertion_handler);
-
-  /* ... use the MPS ... */
-
-  /* restore the old handler */
-  (void) mps_assert_install(old_handler);
-
- - -

Error Handling

- - -

See Also

- -

- -mps_assert_default

- - -

Notes

- -

None.

- - -

type mps_assert_t

- - -

Name

- -

mps_assert_t

- - -

Summary

- -

mps_assert_t is the type of assertion handlers in the MPS.

- - -

Associated Protocols

- -

Assertion.

- - -

Syntax

- -

typedef void (*mps_assert_t)(const char *, const char *, const char *, unsigned); -

- - -

Resources

- -

mps.h

- - -

Description

- -

mps_assert_t is the type of assertion handlers in the MPS.

- -

- - -

Example

- - -

See Also

- - -

Notes

- -

None.

- -

function mps_bool_t

@@ -7203,198 +6835,6 @@ mpsliban.c

href="#mps_telemetry_control">mps_telemetry_control

-

mps_message_collection_stats_condemned_size

- - -

Name

- -

mps_message_collection_stats_condemned_size

- - -

Summary

- -

mps_message_collection_stats_condemned_size returns the "condemned size" property of thespecified message in the specified arena.

- - -

Associated Protocols

- -

Message, GC.

- - -

Syntax

- -

size_t mps_message_collection_stats_condemned_size(mps_message_t message)

- - -

Arguments

- -

message -- a message of a message type that supports this method

- - -

Initial/Default Values

- -

Not applicable.

- - -

Returned Values

- -

An approximate size for the set of objects condemned in the collection that generated themessage.

- - -

Resources

- -

Not applicable.

- - -

Description

- -

Currently, the only type of message that supports this property, is mps_message_type_collection_stats, which is generated whenever a garbage collection completes. Thismethod returns an approximation to the size of the set of objects that were condemned in thatcollection.

- - -

Example

- - -

Error Handling

- - -

See Also

- -

- -mps_message_*

- - -

Notes

- - -

mps_message_collection_stats_live_size

- - -

Name

- -

mps_message_collection_stats_live_size

- - -

Summary

- -

mps_message_collection_stats_live_size returns the "live size" property of the specifiedmessage in the specified arena.

- - -

Associated Protocols

- -

Message, GC.

- - -

Syntax

- -

size_t mps_message_collection_stats_live_size(mps_message_t message)

- - -

Arguments

- -

message -- a message of a message type that supports this method

- - -

Initial/Default Values

- -

Not applicable.

- - -

Returned Values

- -

The total size of the condemned objects that survived the collection that generated themessage.

- - -

Resources

- -

Not applicable.

- - -

Description

- -

Currently, the only type of message that supports this property, is mps_message_type_collection_stats, which is generated whenever a garbage collection completes. Thismethod returns the size of the set of objects that were condemned in that collection, but survived.

- - -

Example

- - -

Error Handling

- - -

See Also

- -

- -mps_message_*

- - -

Notes

- - -

mps_message_sollection_stats_not_condemned_size

- - -

Name

- -

mps_message_collection_stats_not_condemned_size

- - -

Summary

- -

mps_message_collection_stats_not_condemned_size returns the "not condemned size" propertyof the specified message in the specified arena.

- - -

Associated Protocols

- -

Message, GC.

- - -

Syntax

- -

size_t mps_message_collection_stats_not_condemned_size(mps_message_t message)

- - -

Arguments

- -

message -- a message of a message type that supports this method

- - -

Initial/Default Values

- -

Not applicable.

- - -

Returned Values

- -

An approximate size for the set of objects that were in collected pools, but were notcondemned in the collection that generated the message.

- - -

Resources

- -

Not applicable.

- - -

Description

- -

Currently, the only type of message that supports this property, is mps_message_type_collection_stats, which is generated whenever a garbage collection completes. Thismethod returns an approximation to the size of the set of objects that were in collected pools, butwere not condemned in that collection.

- - -

Example

- - -

Error Handling

- - -

See Also

- -

- -mps_message_*

- - -

Notes

- -

function mps_message_discard

@@ -7669,7 +7109,7 @@ is used to indicate that the client has no further use for the specified message

Name

-

mps_message_gc_not_condemned_size

+

mps_message_gc_not_condemned_size

Summary

@@ -8035,107 +7475,6 @@ is used to indicate that the client has no further use for the specified message mps_message_*

-

mps_message_type_collection_stats

- - -

Name

- -

mps_message_type_collection_stats

- - -

Summary

- -

mps_message_type_collection_stats returns the type of garbage collection statistic messages.

- - -

Associated Protocols

- -

Message, gc.

- - -

Syntax

- -

mps_message_type_t mps_message_type_collection_stats()

- - -

Arguments

- - -

Initial/Default Values

- -

Not applicable.

- - -

Returned Values

- -

The type of garbage collection statistic messages.

- - -

Resources

- -

Not applicable.

- - -

Description

- -

mps_message_type_collection_stats returns the type of garbage collection statisticmessages. Garbage collection statistic messages are used by the MPS to give the client informationabout garbage collections that have occurred. Such information may be useful in analysing theclient's memory usage over time.

- -

The access methods specific to a message of this type are:

- - - - -

Example

- -
-{
-  mps_message_type_t type;
-
-  if(mps_message_queue_type(&type, arena)) {
-    if(type == mps_message_type_collection_stats()) {
-      size_t live, condemned, not_condemned;
-      mps_message_t message;
-      mps_bool_t got_message;
-      got_message = mps_message_get(&message, arena, type);
-      assert(got_message);
-      live = mps_message_collection_stats_live_size(message);
-      condemned = mps_message_collection_stats_condemned_size(message);
-      not_condemned = mps_message_collection_stats_not_condemned_size(message);
-      mps_message_discard(arena, message);
-      process_collection_stats(live, condemned, not_condemned);
-    } else {
-      unknown_message_type();
-    }
-  }
-}
-
- - -

Error Handling

- -

Cannot fail.

- - -

See Also

- -

- -mps_message_*.

- -

"Message Protocol", "GC Protocol"

- - -

Notes

- -

function mps_message_type_disable

@@ -8524,15 +7863,14 @@ is used to indicate that the client has no further use for the specified message

Error Handling

-

If a corrupted fencepost is found, an assert will fire. You can install an assert handlerusing mps_assert_install, but you'll probably want to look at the problem with adebugger instead.

+

If a corrupted fencepost is found, an assert will fire. You will +probably want to look at the problem with a debugger.

See Also

-mps_assert_install, - mps_class_*_debug

@@ -8541,9 +7879,7 @@ is used to indicate that the client has no further use for the specified message

Name

-

- mps_pool_debug_option_s -

+

mps_pool_debug_option_s

Summary

@@ -9196,8 +8532,6 @@ href="#mps_root_create_table">mps_root_create_table, MPS_RM_PROT, -MPS_RM_PROT_INNER, - MPS_RM_CONST

@@ -9404,8 +8738,6 @@ href="#mps_root_create_table_masked">mps_root_create_table_masked, MPS_RM_PROT, -MPS_RM_PROT_INNER, - MPS_RM_CONST

@@ -9507,8 +8839,6 @@ href="#mps_root_create_table">mps_root_create_table, MPS_RM_PROT, -MPS_RM_PROT_INNER, - MPS_RM_CONST

@@ -10442,6 +9772,8 @@ href="#mps_telemetry_control">mps_telemetry_control, mps_thr_t

+

type mps_thr_t

+

Name

mps_thr_t

@@ -10550,6 +9882,16 @@ href="#mps_stack_scan_ambig">mps_stack_scan_ambig

+ + + 2002-06-21 + + NB + + Removed obsolete symbols. + + +