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

Интерфейс для вызова функций из других языков программирования

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

Именование

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

Операция

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

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

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

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

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

• Привязки языка 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 включает библиотеку 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] Он был улучшен в стандарт Фортрана 2018.
• Go может вызывать код C напрямую через "C"псевдопакет. ^[12]
• GWT , в котором Java компилируется в JavaScript, имеет FFI под названием JSNI, который позволяет исходному коду Java вызывать произвольные функции JavaScript, а JavaScript — выполнять обратный вызов в Java.
• Хаскелл
• JNI , который обеспечивает интерфейс между Java и C/C++ — предпочтительными системными языками в большинстве систем, где развернут Java. 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 и локальное хранилище), уведомление, мультимедиа и захват (воспроизведение и запись или аудио). и видео), Файл, Контакты (адресная книга), События, Информация об устройстве и подключении.[1],[2].
• PHP предоставляет FFI для C. ^[17]
• Python предоставляет модули ctypes и cffi. Например, модуль ctypes может «на лету» загружать функции C из общих библиотек / DLL и автоматически переводить простые типы данных между семантикой Python и C следующим образом:

  импортировать  ctypes libc  =  ctypes . CDLL ( '/lib/libc.so.6' )  # В Linux/Unix t  =  libc . time ( None )  # Эквивалентный код C: 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, либо через скрипт стандартной библиотеки.

  нужна «скрипка» libm = Скрипка . dlopen ( '/lib/libm.so.6' )  # Эквивалент: двойной пол (двойной x); пол = Скрипка :: Функция . new ( libm . sym ( 'floor' ), # ptr — это ссылочная функция (или символ) Fiddle::Handle. [ Fiddle :: TYPE_DOUBLE ] , # args — это массив аргументов, передаваемый в функцию ptr . Fiddle :: TYPE_DOUBLE # ret_type — тип возвращаемого значения функции ).        # Эквивалентно: Floor(3.14159); пол . вызов ( 3.14159 ) #= > 3.0 

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

Кроме того, многие FFI могут формироваться автоматически: например, SWIG . Однако в случае языка расширения может произойти семантическая инверсия отношений гостя и хоста, когда меньшая часть языка расширения является гостем, вызывающим службы в большей части хост-языка, например, при написании небольшого плагина ^{[24]. ]} для GIMP. ^[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 . Поскольку интерфейса нет, то он, строго говоря, не является FFI, хотя предлагает пользователю тот же функционал.

Смотрите также

• Совместимость языков
• Язык определения интерфейса
• Соглашение о вызовах
• Искажение имени
• Интерфейс прикладного программирования
• Бинарный интерфейс приложения
• Сравнение виртуальных машин приложений
• СВИГ
• Удаленный вызов процедур
• либффи

Рекомендации

1. "Введение FFI" . ХаскеллВики . Проверено 19 июня 2015 г. FFI Haskell используется для вызова функций из других языков (в основном C на данный момент), а C для вызова функций Haskell.
2. "std::ffi - Rust" . Проверено 1 апреля 2021 г. Этот модуль предоставляет утилиты для обработки данных через интерфейсы, отличные от Rust, такие как другие языки программирования и базовая операционная система. В основном он используется для привязок FFI (интерфейс внешних функций) и кода, которому необходимо обмениваться строками C-подобного типа с другими языками.
3. "Руководство PHP FFI" . Руководство по PHP . Проверено 31 августа 2023 г. Определенные переменные C доступны как свойства экземпляра FFI.
4. Майк Полл. «Библиотека ФФИ». Luajit.org . Проверено 29 сентября 2013 г.
5. Хайнц, Иоахим (2013). Пути вперед: материалы первой международной конференции Csound. Алекс Хофманн, Иэн МакКарди. Ньюкасл-апон-Тайн: Издательство Cambridge Scholars Publishing. ISBN 978-1-4438-5122-0. ОСЛК  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. «cgo — язык программирования Go» . Проверено 23 августа 2015 г.
13. «Интерфейс иностранных функций | Руководство» . Дено . Проверено 8 февраля 2023 г.
14. «API FFI». Бун Документы .
15. «Вызов кода C и Фортрана · Язык Джулии» . docs.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. «Script-Fu и плагины для GIMP» . Гимп.орг . Проверено 29 сентября 2013 г.

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

• c2.com: Интерфейс внешних функций
• Интерфейс внешних функций Haskell 98
• Аллегро Common Lisp FFI
• Генератор интерфейса внешних функций для occam-pi
• UFFI: универсальный интерфейс внешних функций Lisp
• CFFI: общий интерфейс внешних функций для Common Lisp.
• Собственный интерфейс Java: Руководство программиста и спецификации
• Спецификация JNI
• JSNI (собственный интерфейс JavaScript)
• библиотека dyncall, использующая ядра вызовов ассемблера для различных процессоров, ОС и соглашений о вызовах
• ФФКАЛЛ
• С/Вызов
• либффи