From cde11fcf0d9ce6aea00021120242e1cc3aaf6e55 Mon Sep 17 00:00:00 2001 From: Kjell Winblad Date: Fri, 20 Dec 2019 08:58:10 +0100 Subject: Remove erl_* functions from erl_interface etc This commit: * Removes the erl_interface functions that were scheduled for removal before the OTP 23 release * Removes the old erl_interface library (i.e., liberl_interface.a and *not* libei.a) * Removes references to the removed functions in the documentation * Updates code examples to use the newer ei_* functions instead of the removed erl_* functions * Changes the prefix of the erl_global_* functions to ei_global and modifies these functions so that they work without the removed functions --- lib/erl_interface/doc/src/erl_malloc.xml | 212 ------------------------------- 1 file changed, 212 deletions(-) delete mode 100644 lib/erl_interface/doc/src/erl_malloc.xml (limited to 'lib/erl_interface/doc/src/erl_malloc.xml') diff --git a/lib/erl_interface/doc/src/erl_malloc.xml b/lib/erl_interface/doc/src/erl_malloc.xml deleted file mode 100644 index 6650620064..0000000000 --- a/lib/erl_interface/doc/src/erl_malloc.xml +++ /dev/null @@ -1,212 +0,0 @@ - - - - -
- - 19962016 - Ericsson AB. All Rights Reserved. - - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - - - erl_malloc - Torbjörn Törnkvist - Torbjörn Törnkvist - - Bjarne Däcker - Torbjörn Törnkvist - 1998-07-03 - A - erl_malloc.xml -
- erl_malloc - Memory allocation functions. - -

The support for VxWorks is deprecated as of OTP 22, and - will be removed in OTP 23.

 -

The old legacy erl_interface library (functions - with prefix erl_) is deprecated as of OTP 22, and will be - removed in OTP 23. This does not apply to the ei - library. Reasonably new gcc compilers will issue deprecation - warnings. In order to disable these warnings, define the macro - EI_NO_DEPR_WARN.

 -

This module provides functions for allocating and deallocating - memory.

- - - - - ETERM *erl_alloc_eterm(etype) - Allocate an ETERM structure. - - unsigned char etype; - - -

Allocates an (ETERM) structure.

-

Specify etype as one of the following - constants:

- - ERL_INTEGER - - ERL_U_INTEGER (unsigned integer) - - ERL_ATOM - - ERL_PID (Erlang process identifier) - - ERL_PORT - - ERL_REF (Erlang reference) - - ERL_LIST - - ERL_EMPTY_LIST - - ERL_TUPLE - - ERL_BINARY - - ERL_FLOAT - - ERL_VARIABLE - - ERL_SMALL_BIG (bignum) - - ERL_U_SMALL_BIG (bignum) - - -

ERL_SMALL_BIG and - ERL_U_SMALL_BIG are for - creating Erlang bignums, which can contain integers - of any size. The size of an integer in Erlang is machine-dependent, - but any integer > 2^28 requires a bignum.

- - - - - voiderl_eterm_release(void) - Clear the ETERM freelist. - -

Clears the freelist, where blocks are placed when they are - released by erl_free_term() and - erl_free_compound().

- - - - - voiderl_eterm_statistics(allocated, freed) - Report term allocation statistics. - - long *allocated; - long *freed; - - -

Reports term allocation statistics.

-

allocated and freed are - initialized to - contain information about the fix-allocator used to allocate - ETERM components.

- - -

allocated is the number of blocks currently - allocated to ETERM objects.

- - -

freed is the length of the freelist, where - blocks are placed when they are - released by erl_free_term() and - erl_free_compound().

- - - - - - - voiderl_free(ptr) - Free some memory. - - void *ptr; - - -

Calls the standard - free() function.

- - - - - voiderl_free_array(array, size) - Free an array of ETERM structures. - - ETERM **array; - int size; - - -

Frees an array of Erlang terms.

- - array is an array of ETERM* objects. - size is the number of terms in the array. - - - - - - - voiderl_free_compound(t) - Free an array of ETERM structures. - - ETERM *t; - - -

Normally it is the programmer's responsibility to free each - Erlang term that has been returned from any of the - Erl_Interface functions. However, as many of the - functions that build new Erlang terms in fact share objects - with other existing terms, it can be difficult for the - programmer to maintain pointers to all such terms to - free them individually.

-

erl_free_compound() recursively frees all of the - subterms associated with a specified Erlang term, regardless of - whether we are still holding pointers to the subterms.

-

For an example, see section - Building Terms and Patterns - in the User's Guide.

- - - - - voiderl_free_term(t) - Free an ETERM structure. - - ETERM *t; - - -

Frees an Erlang term.

- - - - - voiderl_malloc(size) - Allocate some memory. - - long size; - - -

Calls the standard - malloc() function.

- - - - -- cgit v1.2.1