1012cb4583a5f8564059142bb1900ea3a31e7cfa9Torne (Richard Coles)/* 2012cb4583a5f8564059142bb1900ea3a31e7cfa9Torne (Richard Coles) * Copyright (C) 2014 The Android Open Source Project 319b669b00325bcbab4679c4e57c5d8d95f54decbDimitry Ivanov * 4012cb4583a5f8564059142bb1900ea3a31e7cfa9Torne (Richard Coles) * Licensed under the Apache License, Version 2.0 (the "License"); 5012cb4583a5f8564059142bb1900ea3a31e7cfa9Torne (Richard Coles) * you may not use this file except in compliance with the License. 6012cb4583a5f8564059142bb1900ea3a31e7cfa9Torne (Richard Coles) * You may obtain a copy of the License at 7012cb4583a5f8564059142bb1900ea3a31e7cfa9Torne (Richard Coles) * 8012cb4583a5f8564059142bb1900ea3a31e7cfa9Torne (Richard Coles) * http://www.apache.org/licenses/LICENSE-2.0 9012cb4583a5f8564059142bb1900ea3a31e7cfa9Torne (Richard Coles) * 10012cb4583a5f8564059142bb1900ea3a31e7cfa9Torne (Richard Coles) * Unless required by applicable law or agreed to in writing, software 11012cb4583a5f8564059142bb1900ea3a31e7cfa9Torne (Richard Coles) * distributed under the License is distributed on an "AS IS" BASIS, 12012cb4583a5f8564059142bb1900ea3a31e7cfa9Torne (Richard Coles) * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13012cb4583a5f8564059142bb1900ea3a31e7cfa9Torne (Richard Coles) * See the License for the specific language governing permissions and 14012cb4583a5f8564059142bb1900ea3a31e7cfa9Torne (Richard Coles) * limitations under the License. 15012cb4583a5f8564059142bb1900ea3a31e7cfa9Torne (Richard Coles) */ 16012cb4583a5f8564059142bb1900ea3a31e7cfa9Torne (Richard Coles) 17012cb4583a5f8564059142bb1900ea3a31e7cfa9Torne (Richard Coles)#ifndef __ANDROID_DLEXT_H__ 18012cb4583a5f8564059142bb1900ea3a31e7cfa9Torne (Richard Coles)#define __ANDROID_DLEXT_H__ 19012cb4583a5f8564059142bb1900ea3a31e7cfa9Torne (Richard Coles) 20012cb4583a5f8564059142bb1900ea3a31e7cfa9Torne (Richard Coles)#include <stddef.h> 21aad1a39dfbdbb3cd2f9b1ba7f5c65fe68f179065David 'Digit' Turner#include <stdint.h> 22012cb4583a5f8564059142bb1900ea3a31e7cfa9Torne (Richard Coles)#include <sys/cdefs.h> 23aad1a39dfbdbb3cd2f9b1ba7f5c65fe68f179065David 'Digit' Turner#include <sys/types.h> /* for off64_t */ 24012cb4583a5f8564059142bb1900ea3a31e7cfa9Torne (Richard Coles) 25012cb4583a5f8564059142bb1900ea3a31e7cfa9Torne (Richard Coles)__BEGIN_DECLS 26012cb4583a5f8564059142bb1900ea3a31e7cfa9Torne (Richard Coles) 27012cb4583a5f8564059142bb1900ea3a31e7cfa9Torne (Richard Coles)/* bitfield definitions for android_dlextinfo.flags */ 28012cb4583a5f8564059142bb1900ea3a31e7cfa9Torne (Richard Coles)enum { 2912bbb9164578b6512b8b07a3fb093858244b7c7bTorne (Richard Coles) /* When set, the reserved_addr and reserved_size fields must point to an 3012bbb9164578b6512b8b07a3fb093858244b7c7bTorne (Richard Coles) * already-reserved region of address space which will be used to load the 3112bbb9164578b6512b8b07a3fb093858244b7c7bTorne (Richard Coles) * library if it fits. If the reserved region is not large enough, the load 3212bbb9164578b6512b8b07a3fb093858244b7c7bTorne (Richard Coles) * will fail. 3312bbb9164578b6512b8b07a3fb093858244b7c7bTorne (Richard Coles) */ 3412bbb9164578b6512b8b07a3fb093858244b7c7bTorne (Richard Coles) ANDROID_DLEXT_RESERVED_ADDRESS = 0x1, 3512bbb9164578b6512b8b07a3fb093858244b7c7bTorne (Richard Coles) 3612bbb9164578b6512b8b07a3fb093858244b7c7bTorne (Richard Coles) /* As DLEXT_RESERVED_ADDRESS, but if the reserved region is not large enough, 3712bbb9164578b6512b8b07a3fb093858244b7c7bTorne (Richard Coles) * the linker will choose an available address instead. 3812bbb9164578b6512b8b07a3fb093858244b7c7bTorne (Richard Coles) */ 3912bbb9164578b6512b8b07a3fb093858244b7c7bTorne (Richard Coles) ANDROID_DLEXT_RESERVED_ADDRESS_HINT = 0x2, 4012bbb9164578b6512b8b07a3fb093858244b7c7bTorne (Richard Coles) 41183ad9df536ab04ef35a397a1f4724e4e401d11fTorne (Richard Coles) /* When set, write the GNU RELRO section of the mapped library to relro_fd 42183ad9df536ab04ef35a397a1f4724e4e401d11fTorne (Richard Coles) * after relocation has been performed, to allow it to be reused by another 43183ad9df536ab04ef35a397a1f4724e4e401d11fTorne (Richard Coles) * process loading the same library at the same address. This implies 44183ad9df536ab04ef35a397a1f4724e4e401d11fTorne (Richard Coles) * ANDROID_DLEXT_USE_RELRO. 45183ad9df536ab04ef35a397a1f4724e4e401d11fTorne (Richard Coles) */ 46183ad9df536ab04ef35a397a1f4724e4e401d11fTorne (Richard Coles) ANDROID_DLEXT_WRITE_RELRO = 0x4, 47183ad9df536ab04ef35a397a1f4724e4e401d11fTorne (Richard Coles) 48183ad9df536ab04ef35a397a1f4724e4e401d11fTorne (Richard Coles) /* When set, compare the GNU RELRO section of the mapped library to relro_fd 49183ad9df536ab04ef35a397a1f4724e4e401d11fTorne (Richard Coles) * after relocation has been performed, and replace any relocated pages that 50183ad9df536ab04ef35a397a1f4724e4e401d11fTorne (Richard Coles) * are identical with a version mapped from the file. 51183ad9df536ab04ef35a397a1f4724e4e401d11fTorne (Richard Coles) */ 52183ad9df536ab04ef35a397a1f4724e4e401d11fTorne (Richard Coles) ANDROID_DLEXT_USE_RELRO = 0x8, 53183ad9df536ab04ef35a397a1f4724e4e401d11fTorne (Richard Coles) 5404dc91ae763adc403a14c88b4c46f77b3d2d71a3Dmitriy Ivanov /* Instruct dlopen to use library_fd instead of opening file by name. 5504dc91ae763adc403a14c88b4c46f77b3d2d71a3Dmitriy Ivanov * The filename parameter is still used to identify the library. 5604dc91ae763adc403a14c88b4c46f77b3d2d71a3Dmitriy Ivanov */ 5704dc91ae763adc403a14c88b4c46f77b3d2d71a3Dmitriy Ivanov ANDROID_DLEXT_USE_LIBRARY_FD = 0x10, 5804dc91ae763adc403a14c88b4c46f77b3d2d71a3Dmitriy Ivanov 59a6c1279098f24a675d0df74ce1946f5d534b425eDmitriy Ivanov /* If opening a library using library_fd read it starting at library_fd_offset. 6007e5bc152d8a3ad4c50808bb86f3c0f2c5e2f514Dmitriy Ivanov * This flag is only valid when ANDROID_DLEXT_USE_LIBRARY_FD is set. 6107e5bc152d8a3ad4c50808bb86f3c0f2c5e2f514Dmitriy Ivanov */ 62a6c1279098f24a675d0df74ce1946f5d534b425eDmitriy Ivanov ANDROID_DLEXT_USE_LIBRARY_FD_OFFSET = 0x20, 6307e5bc152d8a3ad4c50808bb86f3c0f2c5e2f514Dmitriy Ivanov 649b82136b987bc01224e3b42732334ea27c97d188Dmitriy Ivanov /* When set, do not check if the library has already been loaded by file stat(2)s. 659b82136b987bc01224e3b42732334ea27c97d188Dmitriy Ivanov * 669b82136b987bc01224e3b42732334ea27c97d188Dmitriy Ivanov * This flag allows forced loading of the library in the case when for some 679b82136b987bc01224e3b42732334ea27c97d188Dmitriy Ivanov * reason multiple ELF files share the same filename (because the already-loaded 689b82136b987bc01224e3b42732334ea27c97d188Dmitriy Ivanov * library has been removed and overwritten, for example). 699b82136b987bc01224e3b42732334ea27c97d188Dmitriy Ivanov * 709b82136b987bc01224e3b42732334ea27c97d188Dmitriy Ivanov * Note that if the library has the same dt_soname as an old one and some other 719b82136b987bc01224e3b42732334ea27c97d188Dmitriy Ivanov * library has the soname in DT_NEEDED list, the first one will be used to resolve any 729b82136b987bc01224e3b42732334ea27c97d188Dmitriy Ivanov * dependencies. 739b82136b987bc01224e3b42732334ea27c97d188Dmitriy Ivanov */ 749b82136b987bc01224e3b42732334ea27c97d188Dmitriy Ivanov ANDROID_DLEXT_FORCE_LOAD = 0x40, 759b82136b987bc01224e3b42732334ea27c97d188Dmitriy Ivanov 768a1162835597be38705b381ac34c07da17932568Dmitriy Ivanov /* When set, if the minimum p_vaddr of the ELF file's PT_LOAD segments is non-zero, 778a1162835597be38705b381ac34c07da17932568Dmitriy Ivanov * the dynamic linker will load it at that address. 788a1162835597be38705b381ac34c07da17932568Dmitriy Ivanov * 798a1162835597be38705b381ac34c07da17932568Dmitriy Ivanov * This flag is for ART internal use only. 808a1162835597be38705b381ac34c07da17932568Dmitriy Ivanov */ 818a1162835597be38705b381ac34c07da17932568Dmitriy Ivanov ANDROID_DLEXT_FORCE_FIXED_VADDR = 0x80, 828a1162835597be38705b381ac34c07da17932568Dmitriy Ivanov 83126af757c6d6a6447c19236df8d98ba07f21996fDmitriy Ivanov /* Instructs dlopen to load the library at the address specified by reserved_addr. 84126af757c6d6a6447c19236df8d98ba07f21996fDmitriy Ivanov * 85126af757c6d6a6447c19236df8d98ba07f21996fDmitriy Ivanov * The difference between ANDROID_DLEXT_LOAD_AT_FIXED_ADDRESS and ANDROID_DLEXT_RESERVED_ADDRESS 86126af757c6d6a6447c19236df8d98ba07f21996fDmitriy Ivanov * is that for ANDROID_DLEXT_LOAD_AT_FIXED_ADDRESS the linker reserves memory at reserved_addr 87126af757c6d6a6447c19236df8d98ba07f21996fDmitriy Ivanov * whereas for ANDROID_DLEXT_RESERVED_ADDRESS the linker relies on the caller to reserve the memory. 88126af757c6d6a6447c19236df8d98ba07f21996fDmitriy Ivanov * 89126af757c6d6a6447c19236df8d98ba07f21996fDmitriy Ivanov * This flag can be used with ANDROID_DLEXT_FORCE_FIXED_VADDR; when ANDROID_DLEXT_FORCE_FIXED_VADDR 90126af757c6d6a6447c19236df8d98ba07f21996fDmitriy Ivanov * is set and load_bias is not 0 (load_bias is min(p_vaddr) of PT_LOAD segments) this flag is ignored. 91126af757c6d6a6447c19236df8d98ba07f21996fDmitriy Ivanov * This is implemented this way because the linker has to pick one address over the other and this 92126af757c6d6a6447c19236df8d98ba07f21996fDmitriy Ivanov * way is more convenient for art. Note that ANDROID_DLEXT_FORCE_FIXED_VADDR does not generate 93126af757c6d6a6447c19236df8d98ba07f21996fDmitriy Ivanov * an error when min(p_vaddr) is 0. 94126af757c6d6a6447c19236df8d98ba07f21996fDmitriy Ivanov * 95126af757c6d6a6447c19236df8d98ba07f21996fDmitriy Ivanov * Cannot be used with ANDROID_DLEXT_RESERVED_ADDRESS or ANDROID_DLEXT_RESERVED_ADDRESS_HINT. 96126af757c6d6a6447c19236df8d98ba07f21996fDmitriy Ivanov * 97126af757c6d6a6447c19236df8d98ba07f21996fDmitriy Ivanov * This flag is for ART internal use only. 98126af757c6d6a6447c19236df8d98ba07f21996fDmitriy Ivanov */ 99126af757c6d6a6447c19236df8d98ba07f21996fDmitriy Ivanov ANDROID_DLEXT_LOAD_AT_FIXED_ADDRESS = 0x100, 100126af757c6d6a6447c19236df8d98ba07f21996fDmitriy Ivanov 10142d5fcb9f494eb45de3b6bf759f4a18076e84728Dmitriy Ivanov /* This flag used to load library in a different namespace. The namespace is 10242d5fcb9f494eb45de3b6bf759f4a18076e84728Dmitriy Ivanov * specified in library_namespace. 10342d5fcb9f494eb45de3b6bf759f4a18076e84728Dmitriy Ivanov */ 10442d5fcb9f494eb45de3b6bf759f4a18076e84728Dmitriy Ivanov ANDROID_DLEXT_USE_NAMESPACE = 0x200, 10542d5fcb9f494eb45de3b6bf759f4a18076e84728Dmitriy Ivanov 106012cb4583a5f8564059142bb1900ea3a31e7cfa9Torne (Richard Coles) /* Mask of valid bits */ 10712bbb9164578b6512b8b07a3fb093858244b7c7bTorne (Richard Coles) ANDROID_DLEXT_VALID_FLAG_BITS = ANDROID_DLEXT_RESERVED_ADDRESS | 108183ad9df536ab04ef35a397a1f4724e4e401d11fTorne (Richard Coles) ANDROID_DLEXT_RESERVED_ADDRESS_HINT | 109183ad9df536ab04ef35a397a1f4724e4e401d11fTorne (Richard Coles) ANDROID_DLEXT_WRITE_RELRO | 11004dc91ae763adc403a14c88b4c46f77b3d2d71a3Dmitriy Ivanov ANDROID_DLEXT_USE_RELRO | 11107e5bc152d8a3ad4c50808bb86f3c0f2c5e2f514Dmitriy Ivanov ANDROID_DLEXT_USE_LIBRARY_FD | 1129b82136b987bc01224e3b42732334ea27c97d188Dmitriy Ivanov ANDROID_DLEXT_USE_LIBRARY_FD_OFFSET | 1138a1162835597be38705b381ac34c07da17932568Dmitriy Ivanov ANDROID_DLEXT_FORCE_LOAD | 114126af757c6d6a6447c19236df8d98ba07f21996fDmitriy Ivanov ANDROID_DLEXT_FORCE_FIXED_VADDR | 11542d5fcb9f494eb45de3b6bf759f4a18076e84728Dmitriy Ivanov ANDROID_DLEXT_LOAD_AT_FIXED_ADDRESS | 11642d5fcb9f494eb45de3b6bf759f4a18076e84728Dmitriy Ivanov ANDROID_DLEXT_USE_NAMESPACE, 117012cb4583a5f8564059142bb1900ea3a31e7cfa9Torne (Richard Coles)}; 118012cb4583a5f8564059142bb1900ea3a31e7cfa9Torne (Richard Coles) 11942d5fcb9f494eb45de3b6bf759f4a18076e84728Dmitriy Ivanovstruct android_namespace_t; 12042d5fcb9f494eb45de3b6bf759f4a18076e84728Dmitriy Ivanov 121012cb4583a5f8564059142bb1900ea3a31e7cfa9Torne (Richard Coles)typedef struct { 1223a8646fc5d9f1a9304251a1d1c8ff9e523d81b40Dmitriy Ivanov uint64_t flags; 12312bbb9164578b6512b8b07a3fb093858244b7c7bTorne (Richard Coles) void* reserved_addr; 12412bbb9164578b6512b8b07a3fb093858244b7c7bTorne (Richard Coles) size_t reserved_size; 125183ad9df536ab04ef35a397a1f4724e4e401d11fTorne (Richard Coles) int relro_fd; 12604dc91ae763adc403a14c88b4c46f77b3d2d71a3Dmitriy Ivanov int library_fd; 127a6c1279098f24a675d0df74ce1946f5d534b425eDmitriy Ivanov off64_t library_fd_offset; 12842d5fcb9f494eb45de3b6bf759f4a18076e84728Dmitriy Ivanov struct android_namespace_t* library_namespace; 129012cb4583a5f8564059142bb1900ea3a31e7cfa9Torne (Richard Coles)} android_dlextinfo; 130012cb4583a5f8564059142bb1900ea3a31e7cfa9Torne (Richard Coles) 131012cb4583a5f8564059142bb1900ea3a31e7cfa9Torne (Richard Coles)extern void* android_dlopen_ext(const char* filename, int flag, const android_dlextinfo* extinfo); 132012cb4583a5f8564059142bb1900ea3a31e7cfa9Torne (Richard Coles) 133012cb4583a5f8564059142bb1900ea3a31e7cfa9Torne (Richard Coles)__END_DECLS 134012cb4583a5f8564059142bb1900ea3a31e7cfa9Torne (Richard Coles) 135012cb4583a5f8564059142bb1900ea3a31e7cfa9Torne (Richard Coles)#endif /* __ANDROID_DLEXT_H__ */ 136