Mercurial > octave
view liboctave/util/oct-shlib.cc @ 31605:e88a07dec498 stable
maint: Use macros to begin/end C++ namespaces.
* oct-conf-post-public.in.h: Define two macros (OCTAVE_BEGIN_NAMESPACE,
OCTAVE_END_NAMESPACE) that can be used to start/end a namespace.
* mk-opts.pl, build-env.h, build-env.in.cc, __betainc__.cc, __contourc__.cc,
__dsearchn__.cc, __eigs__.cc, __expint__.cc, __ftp__.cc, __gammainc__.cc,
__ichol__.cc, __ilu__.cc, __isprimelarge__.cc, __lin_interpn__.cc,
__magick_read__.cc, __pchip_deriv__.cc, __qp__.cc, amd.cc, auto-shlib.cc,
auto-shlib.h, balance.cc, base-text-renderer.cc, base-text-renderer.h,
besselj.cc, bitfcns.cc, bsxfun.cc, c-file-ptr-stream.cc, c-file-ptr-stream.h,
call-stack.cc, call-stack.h, ccolamd.cc, cellfun.cc, chol.cc, colamd.cc,
colloc.cc, conv2.cc, daspk.cc, dasrt.cc, dassl.cc, data.cc, data.h, debug.cc,
defaults.cc, defaults.h, defun-int.h, defun.cc, det.cc, dirfns.cc, display.cc,
display.h, dlmread.cc, dmperm.cc, dot.cc, dynamic-ld.cc, dynamic-ld.h, eig.cc,
ellipj.cc, environment.cc, environment.h, error.cc, error.h, errwarn.h,
event-manager.cc, event-manager.h, event-queue.cc, event-queue.h, fcn-info.cc,
fcn-info.h, fft.cc, fft2.cc, fftn.cc, file-io.cc, filter.cc, find.cc,
ft-text-renderer.cc, ft-text-renderer.h, gcd.cc, getgrent.cc, getpwent.cc,
getrusage.cc, givens.cc, gl-render.cc, gl-render.h, gl2ps-print.cc,
gl2ps-print.h, graphics-toolkit.cc, graphics-toolkit.h, graphics.cc,
graphics.in.h, gsvd.cc, gtk-manager.cc, gtk-manager.h, hash.cc, help.cc,
help.h, hess.cc, hex2num.cc, hook-fcn.cc, hook-fcn.h, input.cc, input.h,
interpreter-private.cc, interpreter-private.h, interpreter.cc, interpreter.h,
inv.cc, jsondecode.cc, jsonencode.cc, kron.cc, latex-text-renderer.cc,
latex-text-renderer.h, load-path.cc, load-path.h, load-save.cc, load-save.h,
lookup.cc, ls-ascii-helper.cc, ls-ascii-helper.h, ls-oct-text.cc, ls-utils.cc,
ls-utils.h, lsode.cc, lu.cc, mappers.cc, matrix_type.cc, max.cc, mex-private.h,
mex.cc, mgorth.cc, nproc.cc, oct-fstrm.cc, oct-fstrm.h, oct-hdf5-types.cc,
oct-hdf5-types.h, oct-hist.cc, oct-hist.h, oct-iostrm.cc, oct-iostrm.h,
oct-opengl.h, oct-prcstrm.cc, oct-prcstrm.h, oct-procbuf.cc, oct-procbuf.h,
oct-process.cc, oct-process.h, oct-stdstrm.h, oct-stream.cc, oct-stream.h,
oct-strstrm.cc, oct-strstrm.h, oct-tex-lexer.in.ll, oct-tex-parser.yy,
ordqz.cc, ordschur.cc, pager.cc, pager.h, pinv.cc, pow2.cc, pr-flt-fmt.cc,
pr-output.cc, procstream.cc, procstream.h, psi.cc, qr.cc, quad.cc, quadcc.cc,
qz.cc, rand.cc, rcond.cc, regexp.cc, schur.cc, settings.cc, settings.h,
sighandlers.cc, sighandlers.h, sparse-xdiv.cc, sparse-xdiv.h, sparse-xpow.cc,
sparse-xpow.h, sparse.cc, spparms.cc, sqrtm.cc, stack-frame.cc, stack-frame.h,
stream-euler.cc, strfind.cc, strfns.cc, sub2ind.cc, svd.cc, sylvester.cc,
symbfact.cc, syminfo.cc, syminfo.h, symrcm.cc, symrec.cc, symrec.h,
symscope.cc, symscope.h, symtab.cc, symtab.h, syscalls.cc, sysdep.cc, sysdep.h,
text-engine.cc, text-engine.h, text-renderer.cc, text-renderer.h, time.cc,
toplev.cc, tril.cc, tsearch.cc, typecast.cc, url-handle-manager.cc,
url-handle-manager.h, urlwrite.cc, utils.cc, utils.h, variables.cc,
variables.h, xdiv.cc, xdiv.h, xnorm.cc, xnorm.h, xpow.cc, xpow.h,
__delaunayn__.cc, __fltk_uigetfile__.cc, __glpk__.cc, __init_fltk__.cc,
__init_gnuplot__.cc, __ode15__.cc, __voronoi__.cc, audiodevinfo.cc,
audioread.cc, convhulln.cc, fftw.cc, gzip.cc, mk-build-env-features.sh,
mk-builtins.pl, cdef-class.cc, cdef-class.h, cdef-fwd.h, cdef-manager.cc,
cdef-manager.h, cdef-method.cc, cdef-method.h, cdef-object.cc, cdef-object.h,
cdef-package.cc, cdef-package.h, cdef-property.cc, cdef-property.h,
cdef-utils.cc, cdef-utils.h, ov-base.cc, ov-base.h, ov-bool-mat.cc,
ov-builtin.h, ov-cell.cc, ov-class.cc, ov-class.h, ov-classdef.cc,
ov-classdef.h, ov-complex.cc, ov-fcn-handle.cc, ov-fcn-handle.h, ov-fcn.h,
ov-java.cc, ov-java.h, ov-mex-fcn.h, ov-null-mat.cc, ov-oncleanup.cc,
ov-struct.cc, ov-typeinfo.cc, ov-typeinfo.h, ov-usr-fcn.cc, ov-usr-fcn.h,
ov.cc, ov.h, octave.cc, octave.h, mk-ops.sh, op-b-b.cc, op-b-bm.cc,
op-b-sbm.cc, op-bm-b.cc, op-bm-bm.cc, op-bm-sbm.cc, op-cdm-cdm.cc, op-cell.cc,
op-chm.cc, op-class.cc, op-cm-cm.cc, op-cm-cs.cc, op-cm-m.cc, op-cm-s.cc,
op-cm-scm.cc, op-cm-sm.cc, op-cs-cm.cc, op-cs-cs.cc, op-cs-m.cc, op-cs-s.cc,
op-cs-scm.cc, op-cs-sm.cc, op-dm-dm.cc, op-dm-scm.cc, op-dm-sm.cc,
op-dm-template.cc, op-dms-template.cc, op-fcdm-fcdm.cc, op-fcm-fcm.cc,
op-fcm-fcs.cc, op-fcm-fm.cc, op-fcm-fs.cc, op-fcn.cc, op-fcs-fcm.cc,
op-fcs-fcs.cc, op-fcs-fm.cc, op-fcs-fs.cc, op-fdm-fdm.cc, op-fm-fcm.cc,
op-fm-fcs.cc, op-fm-fm.cc, op-fm-fs.cc, op-fs-fcm.cc, op-fs-fcs.cc,
op-fs-fm.cc, op-fs-fs.cc, op-i16-i16.cc, op-i32-i32.cc, op-i64-i64.cc,
op-i8-i8.cc, op-int-concat.cc, op-m-cm.cc, op-m-cs.cc, op-m-m.cc, op-m-s.cc,
op-m-scm.cc, op-m-sm.cc, op-mi.cc, op-pm-pm.cc, op-pm-scm.cc, op-pm-sm.cc,
op-pm-template.cc, op-range.cc, op-s-cm.cc, op-s-cs.cc, op-s-m.cc, op-s-s.cc,
op-s-scm.cc, op-s-sm.cc, op-sbm-b.cc, op-sbm-bm.cc, op-sbm-sbm.cc,
op-scm-cm.cc, op-scm-cs.cc, op-scm-m.cc, op-scm-s.cc, op-scm-scm.cc,
op-scm-sm.cc, op-sm-cm.cc, op-sm-cs.cc, op-sm-m.cc, op-sm-s.cc, op-sm-scm.cc,
op-sm-sm.cc, op-str-m.cc, op-str-s.cc, op-str-str.cc, op-struct.cc,
op-ui16-ui16.cc, op-ui32-ui32.cc, op-ui64-ui64.cc, op-ui8-ui8.cc, ops.h,
anon-fcn-validator.cc, anon-fcn-validator.h, bp-table.cc, bp-table.h,
comment-list.cc, comment-list.h, filepos.h, lex.h, lex.ll, oct-lvalue.cc,
oct-lvalue.h, oct-parse.yy, parse.h, profiler.cc, profiler.h,
pt-anon-scopes.cc, pt-anon-scopes.h, pt-arg-list.cc, pt-arg-list.h,
pt-args-block.cc, pt-args-block.h, pt-array-list.cc, pt-array-list.h,
pt-assign.cc, pt-assign.h, pt-binop.cc, pt-binop.h, pt-bp.cc, pt-bp.h,
pt-cbinop.cc, pt-cbinop.h, pt-cell.cc, pt-cell.h, pt-check.cc, pt-check.h,
pt-classdef.cc, pt-classdef.h, pt-cmd.h, pt-colon.cc, pt-colon.h, pt-const.cc,
pt-const.h, pt-decl.cc, pt-decl.h, pt-eval.cc, pt-eval.h, pt-except.cc,
pt-except.h, pt-exp.cc, pt-exp.h, pt-fcn-handle.cc, pt-fcn-handle.h, pt-id.cc,
pt-id.h, pt-idx.cc, pt-idx.h, pt-jump.h, pt-loop.cc, pt-loop.h, pt-mat.cc,
pt-mat.h, pt-misc.cc, pt-misc.h, pt-pr-code.cc, pt-pr-code.h, pt-select.cc,
pt-select.h, pt-spmd.cc, pt-spmd.h, pt-stmt.cc, pt-stmt.h, pt-tm-const.cc,
pt-tm-const.h, pt-unop.cc, pt-unop.h, pt-vm-eval.cc, pt-walk.cc, pt-walk.h,
pt.cc, pt.h, token.cc, token.h, Range.cc, Range.h, idx-vector.cc, idx-vector.h,
range-fwd.h, CollocWt.cc, CollocWt.h, aepbalance.cc, aepbalance.h, chol.cc,
chol.h, gepbalance.cc, gepbalance.h, gsvd.cc, gsvd.h, hess.cc, hess.h,
lo-mappers.cc, lo-mappers.h, lo-specfun.cc, lo-specfun.h, lu.cc, lu.h,
oct-convn.cc, oct-convn.h, oct-fftw.cc, oct-fftw.h, oct-norm.cc, oct-norm.h,
oct-rand.cc, oct-rand.h, oct-spparms.cc, oct-spparms.h, qr.cc, qr.h, qrp.cc,
qrp.h, randgamma.cc, randgamma.h, randmtzig.cc, randmtzig.h, randpoisson.cc,
randpoisson.h, schur.cc, schur.h, sparse-chol.cc, sparse-chol.h, sparse-lu.cc,
sparse-lu.h, sparse-qr.cc, sparse-qr.h, svd.cc, svd.h, child-list.cc,
child-list.h, dir-ops.cc, dir-ops.h, file-ops.cc, file-ops.h, file-stat.cc,
file-stat.h, lo-sysdep.cc, lo-sysdep.h, lo-sysinfo.cc, lo-sysinfo.h,
mach-info.cc, mach-info.h, oct-env.cc, oct-env.h, oct-group.cc, oct-group.h,
oct-password.cc, oct-password.h, oct-syscalls.cc, oct-syscalls.h, oct-time.cc,
oct-time.h, oct-uname.cc, oct-uname.h, action-container.cc, action-container.h,
base-list.h, cmd-edit.cc, cmd-edit.h, cmd-hist.cc, cmd-hist.h, f77-fcn.h,
file-info.cc, file-info.h, lo-array-errwarn.cc, lo-array-errwarn.h, lo-hash.cc,
lo-hash.h, lo-ieee.h, lo-regexp.cc, lo-regexp.h, lo-utils.cc, lo-utils.h,
oct-base64.cc, oct-base64.h, oct-glob.cc, oct-glob.h, oct-inttypes.h,
oct-mutex.cc, oct-mutex.h, oct-refcount.h, oct-shlib.cc, oct-shlib.h,
oct-sparse.cc, oct-sparse.h, oct-string.h, octave-preserve-stream-state.h,
pathsearch.cc, pathsearch.h, quit.cc, quit.h, unwind-prot.cc, unwind-prot.h,
url-transfer.cc, url-transfer.h : Use new macros to begin/end C++ namespaces.
author | Rik <rik@octave.org> |
---|---|
date | Thu, 01 Dec 2022 14:23:45 -0800 |
parents | 076e19eac74a |
children | aac27ad79be6 |
line wrap: on
line source
//////////////////////////////////////////////////////////////////////// // // Copyright (C) 1999-2022 The Octave Project Developers // // See the file COPYRIGHT.md in the top-level directory of this // distribution or <https://octave.org/copyright/>. // // This file is part of Octave. // // Octave is free software: you can redistribute it and/or modify it // under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // Octave is distributed in the hope that it will be useful, but // WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // // You should have received a copy of the GNU General Public License // along with Octave; see the file COPYING. If not, see // <https://www.gnu.org/licenses/>. // //////////////////////////////////////////////////////////////////////// #if defined (HAVE_CONFIG_H) # include "config.h" #endif #include <list> #include <map> extern "C" { #if defined (HAVE_DLOPEN_API) # if defined (HAVE_DLFCN_H) # include <dlfcn.h> # else extern void * dlopen (const char *, int); extern const char * dlerror (void); extern void * dlsym (void *, const char *); extern int dlclose (void *); # endif #elif defined (HAVE_LOADLIBRARY_API) # define WIN32_LEAN_AND_MEAN 1 # include <windows.h> # include <psapi.h> #endif } #include "file-ops.h" #include "file-stat.h" #include "lo-error.h" #include "oct-shlib.h" #include "str-vec.h" #if defined (HAVE_LOADLIBRARY_API) # include "lo-sysdep.h" #endif OCTAVE_BEGIN_NAMESPACE(octave) std::list<dynamic_library> possibly_unreferenced_dynamic_libraries; void dynamic_library::delete_later (void) { possibly_unreferenced_dynamic_libraries.push_back (*this); } int release_unreferenced_dynamic_libraries (void) { possibly_unreferenced_dynamic_libraries.clear (); return 0; } dynamic_library::dynlib_rep::dynlib_rep (const std::string& f) : m_count (1), m_fcn_names (), m_file (f), m_time_loaded (), m_search_all_loaded (false) { s_instances[f] = this; if (is_out_of_date ()) (*current_liboctave_warning_with_id_handler) ("Octave:warn-future-time-stamp", "timestamp on file %s is in the future", m_file.c_str ()); } bool dynamic_library::dynlib_rep::is_out_of_date (void) const { sys::file_stat fs (m_file); return (fs && fs.is_newer (m_time_loaded)); } void dynamic_library::dynlib_rep::fake_reload (void) { // We can't actually reload the library, but we'll pretend we did. sys::file_stat fs (m_file); if (fs && fs.is_newer (m_time_loaded)) { m_time_loaded = fs.mtime (); (*current_liboctave_warning_with_id_handler) ("Octave:library-reload", "library %s not reloaded due to existing references", m_file.c_str ()); } } dynamic_library::dynlib_rep * dynamic_library::dynlib_rep::get_instance (const std::string& f, bool fake) { dynlib_rep *retval = nullptr; std::map<std::string, dynlib_rep *>::iterator p = s_instances.find (f); if (p != s_instances.end ()) { retval = p->second; retval->m_count++; if (fake) retval->fake_reload (); } else retval = new_instance (f); return retval; } std::list<std::string> dynamic_library::dynlib_rep::function_names (void) const { std::list<std::string> retval; for (const auto& p : m_fcn_names) retval.push_back (p.first); return retval; } void dynamic_library::dynlib_rep::add_fcn_name (const std::string& name) { auto p = m_fcn_names.find (name); if (p == m_fcn_names.end ()) m_fcn_names[name] = 1; else ++(p->second); } bool dynamic_library::dynlib_rep::remove_fcn_name (const std::string& fcn_name) { bool retval = false; auto p = m_fcn_names.find (fcn_name); if (p != m_fcn_names.end () && --(p->second) == 0) { m_fcn_names.erase (fcn_name); retval = true; } return retval; } std::map<std::string, dynamic_library::dynlib_rep *> dynamic_library::dynlib_rep::s_instances; dynamic_library::dynlib_rep dynamic_library::s_nil_rep; #if defined (HAVE_DLOPEN_API) class octave_dlopen_shlib : public dynamic_library::dynlib_rep { public: octave_dlopen_shlib (const std::string& f); // No copying! octave_dlopen_shlib (const octave_dlopen_shlib&) = delete; octave_dlopen_shlib& operator = (const octave_dlopen_shlib&) = delete; ~octave_dlopen_shlib (void); void * search (const std::string& name, const dynamic_library::name_mangler& mangler = dynamic_library::name_mangler ()); // FIXME: this is possibly redundant because failure to open a library will // normally throw an exception, avoiding the construction of an invalid // library. Leave it here for possible future use. bool is_open (void) const { return (m_search_all_loaded || m_library != nullptr); } private: void *m_library; }; octave_dlopen_shlib::octave_dlopen_shlib (const std::string& f) : dynamic_library::dynlib_rep (f), m_library (nullptr) { int flags = 0; // Use RTLD_NOW to resolve all symbols before dlopen returns. // By using this option, dlopen will detect errors and Octave // won't exit if there are unresolved symbols in the file we are // loading, and we may even get a useful diagnostic. # if defined (RTLD_NOW) flags |= RTLD_NOW; # endif // Use RTLD_GLOBAL to export symbols from loaded objects so they are // available to other subsequently loaded libraries. # if defined (RTLD_GLOBAL) flags |= RTLD_GLOBAL; # endif if (m_file.empty ()) { m_search_all_loaded = true; return; } m_library = dlopen (m_file.c_str (), flags); if (! m_library) { const char *msg = dlerror (); if (msg) (*current_liboctave_error_handler) ("%s: failed to load\nIncompatible version or missing dependency?" "\n%s", m_file.c_str (), msg); else (*current_liboctave_error_handler) ("%s: failed to load\nIncompatible version or missing dependency?", m_file.c_str ()); } } octave_dlopen_shlib::~octave_dlopen_shlib (void) { if (m_library) dlclose (m_library); } void * octave_dlopen_shlib::search (const std::string& name, const dynamic_library::name_mangler& mangler) { void *function = nullptr; if (! is_open ()) (*current_liboctave_error_handler) ("shared library %s is not open", m_file.c_str ()); std::string sym_name = name; if (mangler) sym_name = mangler (name); if (m_search_all_loaded) function = dlsym (RTLD_DEFAULT, sym_name.c_str ()); else function = dlsym (m_library, sym_name.c_str ()); return function; } #elif defined (HAVE_LOADLIBRARY_API) class octave_w32_shlib: public dynamic_library::dynlib_rep { public: octave_w32_shlib (const std::string& f); // No copying! octave_w32_shlib (const octave_w32_shlib&) = delete; octave_w32_shlib& operator = (const octave_w32_shlib&) = delete; ~octave_w32_shlib (void); void * search (const std::string& name, const dynamic_library::name_mangler& mangler = dynamic_library::name_mangler ()); void * global_search (const std::string& sym_name); bool is_open (void) const { return (m_search_all_loaded || m_handle != nullptr); } private: HINSTANCE m_handle; }; octave_w32_shlib::octave_w32_shlib (const std::string& f) : dynamic_library::dynlib_rep (f), m_handle (nullptr) { if (f.empty()) { m_search_all_loaded = true; return; } std::string dir = sys::file_ops::dirname (f); std::wstring wdir = sys::u8_to_wstring (dir); SetDllDirectoryW (dir.empty () ? nullptr : wdir.c_str ()); std::wstring wfile = sys::u8_to_wstring (m_file); m_handle = LoadLibraryW (wfile.c_str ()); SetDllDirectoryW (nullptr); if (! m_handle) { DWORD last_error = GetLastError (); wchar_t *error_text = nullptr; FormatMessageW (FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS, nullptr, last_error, MAKELANGID (LANG_NEUTRAL, SUBLANG_DEFAULT), reinterpret_cast <wchar_t *> (&error_text), 0, nullptr); std::ostringstream err_str; err_str << "opening the library '" << m_file << "' failed (error " << last_error << "): "; if (error_text != nullptr) { err_str << sys::u8_from_wstring (error_text); LocalFree (error_text); } else err_str << "Unknown error."; (*current_liboctave_error_handler) ("%s", err_str.str ().c_str ()); } } octave_w32_shlib::~octave_w32_shlib (void) { if (m_handle) FreeLibrary (m_handle); } void * octave_w32_shlib::global_search (const std::string& sym_name) { void *function = nullptr; HANDLE proc = GetCurrentProcess (); if (! proc) (*current_liboctave_error_handler) ("Unable to get handle to own process."); std::size_t lib_num = 64; std::size_t size_lib = sizeof (HMODULE); HMODULE *h_libs; DWORD bytes_all_libs; bool got_libs; // Get a list of all the libraries in own process. h_libs = static_cast<HMODULE *> (malloc (size_lib*lib_num)); got_libs = EnumProcessModules (proc, h_libs, size_lib*lib_num, &bytes_all_libs); int ii = 0; while (((size_lib*lib_num) < bytes_all_libs) && ii++ < 3) { lib_num = bytes_all_libs / size_lib; h_libs = static_cast<HMODULE *> (realloc (h_libs, bytes_all_libs)); got_libs = EnumProcessModules (proc, h_libs, bytes_all_libs, &bytes_all_libs); } if (got_libs) { for (std::size_t i = 0; i < (bytes_all_libs / size_lib); i++) { // Check for function in library. function = reinterpret_cast<void *> (GetProcAddress (h_libs[i], sym_name.c_str ())); if (function) break; } } // Release the handle to the process. CloseHandle (proc); return function; } void * octave_w32_shlib::search (const std::string& name, const dynamic_library::name_mangler& mangler) { void *function = nullptr; if (! m_search_all_loaded && ! is_open ()) (*current_liboctave_error_handler) ("shared library %s is not open", m_file.c_str ()); std::string sym_name = name; if (mangler) sym_name = mangler (name); if (m_search_all_loaded) function = global_search (sym_name); else function = reinterpret_cast<void *> (GetProcAddress (m_handle, sym_name.c_str ())); return function; } #endif dynamic_library::dynlib_rep * dynamic_library::dynlib_rep::new_instance (const std::string& f) { #if defined (HAVE_DLOPEN_API) return new octave_dlopen_shlib (f); #elif defined (HAVE_LOADLIBRARY_API) return new octave_w32_shlib (f); #else (*current_liboctave_error_handler) ("support for dynamically loaded libraries was unavailable or disabled when liboctave was built"); #endif } OCTAVE_END_NAMESPACE(octave)