Внешний функциональный интерфейс

Интерфейс внешних функций ( FFI ) — это механизм, с помощью которого программа, написанная на одном языке программирования, может вызывать подпрограммы или использовать сервисы, написанные или скомпилированные на другом языке. FFI часто используется в контекстах, где выполняются вызовы в двоичную библиотеку динамической компоновки .

Мы

Этот термин взят из спецификации Common Lisp , которая явно относится к функции языка программирования, обеспечивающей межъязыковые вызовы как таковые; ^{[ нужна ссылка ]} часто официально используется в интерпретатора и компилятора документации Haskell . этот термин также ^[1] Ржавчина , ^[2] PHP , ^[3] Python и LuaJIT ( Lua ) ^[4]^[5]^: 35. ^[6] В других языках используется другая терминология: в Ada есть языковые привязки , а в Java — Java Native Interface (JNI) или Java Native Access (JNA). Интерфейс внешних функций стал общей терминологией для механизмов, предоставляющих такие услуги.

Операция

Основная функция интерфейса внешней функции — соединить семантику и соглашения о вызовах одного языка программирования ( основного языка или языка, который определяет FFI) с семантикой и соглашениями другого ( гостевого языка). Этот процесс также должен учитывать среды выполнения и двоичные интерфейсы приложений обоих. Это можно сделать несколькими способами:

Требование, чтобы функции гостевого языка, которые должны вызываться на основном языке, были указаны или реализованы определенным образом, часто с использованием библиотеки совместимости. какой-либо
Использование инструмента для автоматического переноса функций гостевого языка в соответствующий связующий код , который выполняет любой необходимый перевод.
Использование библиотеки-обертки
Ограничение набора языковых возможностей, которые можно использовать на разных языках. Например, функции C++, вызываемые из C, могут (как правило) не включать ссылочные параметры или выдавать исключения.

ИФУ могут быть осложнены следующими соображениями:

Если один язык поддерживает сборку мусора (GC), а другой нет; необходимо следить за тем, чтобы код языка, отличного от GC, не вызывал сбоя GC в другом языке. Например, в JNI код C, который «удерживает» ссылки на объекты, полученные от Java, должен успешно передать эту информацию виртуальной машине Java или среде выполнения Java (JRE), в противном случае Java может удалить объекты до того, как C завершит работу с ними. . (Код C также должен явно освободить свою ссылку на любой такой объект, как только C больше не будет нуждаться в этом объекте.)
Сложные или нетривиальные объекты или типы данных может быть сложно сопоставить из одной среды в другую.
Оба языка могут оказаться неспособными поддерживать ссылки на один и тот же экземпляр изменяемого объекта из-за описанной выше проблемы сопоставления.
могут работать один или оба языка На виртуальной машине (ВМ) ; причем, если оба есть, то зачастую это разные ВМ.
Межъязыковое наследование и другие различия, например, между системами типов или между моделями композиции объектов , могут быть особенно трудными.

Примеры FFI включают в себя:

Привязки языка Ada , позволяющие не только вызывать внешние функции, но и экспортировать их функции и методы для вызова из кода, отличного от Ada. ^[7]
C++ имеет тривиальное FFI с C , поскольку эти языки имеют значительное общее подмножество. Основной эффект от Объявление extern "C" в C++ предназначено для отключения искажения имен C++ . В других языках используются отдельные утилиты или промежуточное программное обеспечение, примеры включают:
- Проект GNOME: самоанализ GObject
- СВИГ
- Chromium Проект : движок Blink и V8 использует компилятор языка описания интерфейса (IDL) для стандартных интерфейсов JavaScript.
- Другие компиляторы IDL
Clean обеспечивает двунаправленный FFI со всеми языками, следующими за C или соглашением о вызовах stdcall . ^[8]^[9]
Общий Лисп
Скомпилированный собственный интерфейс (CNI), альтернатива JNI, используемая в среде компилятора GNU.
Одной из основ объектной модели компонентов является общий формат интерфейса, который изначально использует те же типы, что и Visual Basic, для строк и массивов.
D делает это так же, как C++ , с extern «C» через extern (C++).
В состав Dart входит дарт:ffi ^[10] библиотека для вызова собственного кода C для мобильных приложений, приложений командной строки и серверных приложений.
Языки динамического программирования , такие как Python , Perl , Tcl и Ruby , обеспечивают легкий доступ к собственному коду, написанному на C, C++ или любом другом языке, подчиняющемся соглашениям о вызовах C/C++.
Factor имеет FFI для C, Fortran , Objective-C и Windows COM ; все это позволяет динамически импортировать и вызывать произвольные общие библиотеки.
В Fortran 2003 есть модуль ISO_C_BINDING, который предоставляет совместимые типы данных (как внутренние типы, так и структуры POD), совместимые указатели, совместимые глобальные хранилища данных и механизмы для вызова C из Fortran и для вызова Fortran из C. ^[11] Он был улучшен в стандарте Fortran 2018.
Go может вызывать код C напрямую через "C" псевдопакет. ^[12]
Google Web Toolkit (GWT), в котором Java компилируется в JavaScript, имеет FFI под названием JSNI, который позволяет исходному коду Java вызывать произвольные функции JavaScript, а JavaScript — выполнять обратный вызов Java.
Хаскелл
Собственный интерфейс Java (JNI), который обеспечивает интерфейс между Java и C/C++ — предпочтительными системными языками в большинстве систем, где развернут Java. Java Native Access (JNA) предоставляет интерфейс с собственными библиотеками без необходимости написания связующего кода . Другой пример — JNR.
LuaJIT, своевременная реализация Lua , имеет FFI, который позволяет «вызывать внешние функции C и использовать структуры данных C из чистого кода Lua». ^[4]^[5]^: 35
У Nim есть FFI, который позволяет ему использовать исходный код из C , C++ и Objective-C . Он также может взаимодействовать с JavaScript.
JavaScript обычно выполняется внутри среды выполнения веб-браузера , которая не обеспечивает прямого доступа к системным библиотекам или командам для запуска, но есть несколько исключений:
- Node.js предоставляет функции для открытия предварительно скомпилированных .node модули, которые, в свою очередь, могут предоставлять доступ к невстроенным ресурсам.
- Deno предоставляет своего рода интерфейс FFI через dlopen(...) функции. ^[13]
- Bun предоставляет встроенный модуль, bun:ffi, чтобы эффективно вызывать собственные библиотеки непосредственно из JavaScript. ^[14]
У Джулии есть ccall ключевое слово для вызова C (и других языков, например Fortran); ^[15] в то время как пакеты, обеспечивающие аналогичную поддержку без шаблонов, доступны для некоторых языков, например, для Python ^[16] (например, для обеспечения поддержки объектно-ориентированного программирования и поддержки GC), Java (и поддерживает другие языки JDK, такие как Scala) и R. Интерактивное использование с C++ также возможно с помощью пакета Cxx.jl.
PhoneGap (названный Apache Callback, но теперь Apache Cordova ) — это платформа для создания собственных мобильных приложений с использованием HTML, CSS и JavaScript. Кроме того, он имеет FFI через функции обратного вызова JavaScript для доступа к методам и свойствам собственных функций мобильного телефона, включая акселерометр, камеру (также PhotoLibrary и SavedPhotoAlbum), компас, хранилище (база данных SQL и localStorage), уведомления, мультимедиа и захват (воспроизведение и запись). или аудио и видео), файл, контакты (адресная книга), события, устройство и информация о подключении. [1] , [2] .
PHP предоставляет FFI для C. ^[17]
Python предоставляет модули ctypes и cffi . Например, модуль ctypes может загружать функции C из общей библиотеки или библиотеки динамической компоновки «на лету» (DLL) и автоматически транслировать простые типы данных между семантикой Python и C следующим образом:
```
import ctypes
libc = ctypes.CDLL('/lib/libc.so.6')  # Under Linux/Unix
t = libc.time(None)                   # Equivalent C code: t = time(NULL)
print(t)
```
P/Invoke , который обеспечивает интерфейс между Microsoft Common Language Runtime и собственным кодом.
Racket имеет собственный FFI, основанный на макросах, который позволяет динамически импортировать произвольные общие библиотеки. ^[18]^[19]
Раку может вызывать Ruby , Python , Perl , Brainfuck , Lua , C , C++ , Go , Scheme ( Guile , Gambit ) и Rust . ^[20]^[21]

Ruby предоставляет FFI либо через гем ffi , либо через стандартную библиотеку fiddle .

require 'fiddle'

libm = Fiddle.dlopen('/lib/libm.so.6')

# Equivalent to: double floor(double x);
floor = Fiddle::Function.new(
  libm.sym('floor'),     # ptr is a referenced function(, or symbol), of a Fiddle::Handle.
  [Fiddle::TYPE_DOUBLE], # args is an Array of arguments, passed to the ptr function.
  Fiddle::TYPE_DOUBLE    # ret_type is the return type of the function
)

# Equivalent to: floor(3.14159);
floor.call(3.14159) #=> 3.0

Rust определяет внешний интерфейс функций для функций с различными стандартными двоичными интерфейсами приложений (ABI). ^[22] Также имеется библиотека для взаимодействия с Elixir , Rustler .
Visual Basic имеет декларативный синтаксис, который позволяет вызывать функции C, не поддерживающие Юникод.
Язык Wolfram Language предоставляет технологию под названием протокол символической передачи Wolfram (WSTP), которая обеспечивает двунаправленный вызов кода между другими языками с привязками для C++, Java, .NET . и другие языки.
Zig предоставляет FFI для C, используя встроенный cImport функция. ^[23]

Кроме того, многие FFI могут формироваться автоматически: например, SWIG . Однако в случае языка расширения может произойти семантическая инверсия отношений гостя и хоста, когда меньшая часть языка расширения является гостем, вызывающим службы в большей части основного языка, например, при написании небольшого плагина. ^[24] для ГИМП. ^[25]

Некоторые FFI ограничены автономными функциями , в то время как другие также допускают вызовы функций, встроенных в объект или класс (часто называемые вызовами методов ); некоторые даже допускают миграцию сложных типов данных или объектов через границу языка.

В большинстве случаев FFI определяется языком более высокого уровня , поэтому он может использовать сервисы, определенные и реализованные на языке более низкого уровня , обычно это язык системного программирования, такой как C или C++ . Обычно это делается либо для доступа к службам операционной системы (ОС) на языке, на котором определен API ОС, либо для целей повышения производительности.

Многие FFI также предоставляют вызываемому языку средства для вызова служб на основном языке.

Термин «интерфейс внешней функции» обычно не используется для описания многоязычных сред выполнения, таких как Microsoft Common Language Runtime , где предоставляется общая подложка , которая позволяет любому CLR-совместимому языку использовать службы, определенные в любом другом. (Однако в этом случае CLR включает FFI, P/Invoke , для вызова вне среды выполнения.) Кроме того, многие архитектуры распределенных вычислений, такие как удаленный вызов методов Java (RMI), RPC, CORBA , SOAP и D- Bus позволяет писать разные услуги на разных языках; такие архитектуры обычно не считаются FFI.

Особые случаи

Есть некоторые особые случаи, когда языки компилируются в одну и ту же виртуальную машину с байт-кодом, например Clojure и Java , а также Elixir и Erlang . Поскольку интерфейса нет, то он, строго говоря, не является ИФИ, хотя предлагает пользователю те же функции.

См. также

Ссылки

^ «Введение в ФФИ» . ХаскеллВики . Проверено 19 июня 2015 г. FFI Haskell используется для вызова функций из других языков (в основном C на данный момент), а C для вызова функций Haskell.
^ "std::ffi" . Rust-lang.org . Проверено 1 апреля 2021 г. Этот модуль предоставляет утилиты для обработки данных через интерфейсы, отличные от Rust, такие как другие языки программирования и базовая операционная система. В основном он используется для привязок FFI (интерфейс внешних функций) и кода, которому необходимо обмениваться строками C-подобного типа с другими языками.
^ «Руководство PHP FFI» . Руководство по PHP . Проверено 31 августа 2023 г. Определенные переменные C доступны как свойства экземпляра FFI.
^ Перейти обратно: ^а ^б Майк Палл. «Библиотека ФФИ» . Luajit.org . Проверено 29 сентября 2013 г.
^ Перейти обратно: ^а ^б Хайнц, Иоахим; Хофманн, Алекс; Маккарди, Иэн (2013). Путь вперед: материалы первой международной конференции Csound . Ньюкасл-апон-Тайн: Издательство Cambridge Scholars Publishing. ISBN 978-1-4438-5122-0 . OCLC 855505215 .
^ «Документация CFFI» . Проверено 19 июня 2015 г. Интерфейс внешних функций C для Python. Цель — предоставить удобный и надежный способ вызова скомпилированного кода C из Python с использованием объявлений интерфейса, написанных на C.
^ «Интерфейс с другими языками» . Адаик.орг . Проверено 29 сентября 2013 г.
^ «Внешний экспорт» . Проверено 25 мая 2020 г.
^ «Вызов C из чистого» . Проверено 25 апреля 2018 г.
^ "библиотека dart:ffi" . Проверено 01 января 2020 г.
^ « Тег 'fortran-iso-c-binding' вики» . Переполнение стека .
^ "cго" . Перейти на язык программирования . Проверено 23 августа 2015 г.
^ «Интерфейс внешних функций | Руководство» . Дено . Проверено 8 февраля 2023 г.
^ «ФФИ API» . Бун Документы .
^ «Вызов кода C и Фортрана» . JuliaLang.org . Проверено 11 февраля 2018 г.
^ PyCall.jl: Пакет для вызова функций Python из языка Julia , JuliaPy, 08 февраля 2018 г. , получено 11 февраля 2018 г.
^ «PHP: FFI — Руководство» . Группа PHP . Проверено 13 июня 2019 г.
^ Эли Барзилай. «Внешний интерфейс рэкета» . Docs.racket-lang.org . Проверено 29 сентября 2013 г.
^ «TR600.pdf» (PDF) . Архивировано из оригинала (PDF) 2 сентября 2009 г. Проверено 29 сентября 2013 г.
^ «Встроенные реализации» . Проверено 15 августа 2017 г.
^ «Родной звонок» . Проверено 15 августа 2017 г.
^ «Использование внешних функций для вызова внешнего кода» . Проверено 1 июня 2019 г.
^ «Импорт из заголовочного файла C» . Фонд программного обеспечения Zig . Проверено 11 марта 2021 г.
^ «4. Пример сценария» . Гимп.орг. 04 февраля 2001 г. Проверено 29 сентября 2013 г.
^ «Скрипт-Фу и плагины для The GIMP» . Гимп.орг . Проверено 29 сентября 2013 г.

Внешние ссылки

[1] «Введение в ФФИ» . ХаскеллВики . Проверено 19 июня 2015 г. FFI Haskell используется для вызова функций из других языков (в основном C на данный момент), а C для вызова функций Haskell.

[2] "std::ffi" . Rust-lang.org . Проверено 1 апреля 2021 г. Этот модуль предоставляет утилиты для обработки данных через интерфейсы, отличные от Rust, такие как другие языки программирования и базовая операционная система. В основном он используется для привязок FFI (интерфейс внешних функций) и кода, которому необходимо обмениваться строками C-подобного типа с другими языками.

[3] «Руководство PHP FFI» . Руководство по PHP . Проверено 31 августа 2023 г. Определенные переменные C доступны как свойства экземпляра FFI.

[:0-4] Перейти обратно: ^а ^б Майк Палл. «Библиотека ФФИ» . Luajit.org . Проверено 29 сентября 2013 г.

[:1-5] Перейти обратно: ^а ^б Хайнц, Иоахим; Хофманн, Алекс; Маккарди, Иэн (2013). Путь вперед: материалы первой международной конференции Csound . Ньюкасл-апон-Тайн: Издательство Cambridge Scholars Publishing. ISBN 978-1-4438-5122-0 . OCLC 855505215 .

[6] «Документация CFFI» . Проверено 19 июня 2015 г. Интерфейс внешних функций C для Python. Цель — предоставить удобный и надежный способ вызова скомпилированного кода C из Python с использованием объявлений интерфейса, написанных на C.

[7] «Интерфейс с другими языками» . Адаик.орг . Проверено 29 сентября 2013 г.

[8] «Внешний экспорт» . Проверено 25 мая 2020 г.

[9] «Вызов C из чистого» . Проверено 25 апреля 2018 г.

[10] "библиотека dart:ffi" . Проверено 01 января 2020 г.

[11] « Тег 'fortran-iso-c-binding' вики» . Переполнение стека .

[12] "cго" . Перейти на язык программирования . Проверено 23 августа 2015 г.

[13] «Интерфейс внешних функций | Руководство» . Дено . Проверено 8 февраля 2023 г.

[14] «ФФИ API» . Бун Документы .

[15] «Вызов кода C и Фортрана» . JuliaLang.org . Проверено 11 февраля 2018 г.

[16] PyCall.jl: Пакет для вызова функций Python из языка Julia , JuliaPy, 08 февраля 2018 г. , получено 11 февраля 2018 г.

[17] «PHP: FFI — Руководство» . Группа PHP . Проверено 13 июня 2019 г.

[18] Эли Барзилай. «Внешний интерфейс рэкета» . Docs.racket-lang.org . Проверено 29 сентября 2013 г.

[19] «TR600.pdf» (PDF) . Архивировано из оригинала (PDF) 2 сентября 2009 г. Проверено 29 сентября 2013 г.

[20] «Встроенные реализации» . Проверено 15 августа 2017 г.

[21] «Родной звонок» . Проверено 15 августа 2017 г.

[22] «Использование внешних функций для вызова внешнего кода» . Проверено 1 июня 2019 г.

[23] «Импорт из заголовочного файла C» . Фонд программного обеспечения Zig . Проверено 11 марта 2021 г.

[24] «4. Пример сценария» . Гимп.орг. 04 февраля 2001 г. Проверено 29 сентября 2013 г.

[25] «Скрипт-Фу и плагины для The GIMP» . Гимп.орг . Проверено 29 сентября 2013 г.

[1]

[2]

[3]

[4]

[5]

[6]

[7]

[8]

[9]

[10]

[11]

[12]

[13]

[14]

[15]

[16]

[17]

[18]

[19]

[20]

[21]

[22]

[23]

[24]

[25]