Сопрограмма (англ. coroutine) — компонент программы, обобщающий понятие подпрограммы, который дополнительно поддерживает множество входных точек (а не одну как подпрограмма) и остановку и продолжение выполнения с сохранением определённого положения.

Сопрограммы являются более гибкими и обобщёнными, чем подпрограммы, но реже используются на практике. Применение сопрограмм являлось методикой ещё ассемблера, практиковалось лишь в некоторых высокоуровневых языках (Simula, Modula-2). Сопрограммы хорошо пригодны для реализации многих похожих компонентов программ (итераторов, бесконечных списков, каналов, совместных задач).

Сравнение и примеры

Сопрограммы являются более обобщёнными, чем подпрограммы. Подпрограмма имеет всегда одну входную точку, сопрограмма имеет стартовую точку входа и размещённые внутри последовательность возвратов и следующих за ними точек входа. Подпрограмма может возвращаться только однажды, сопрограмма может возвращать управление несколько раз. Время работы подпрограммы определяется принципом LIFO (последняя вызванная подпрограмма завершается первой), время работы сопрограммы определяется её использованием и необходимостью.

Пример

Здесь приведён простой пример когда сопрограмма может быть полезна. Предположим необходимо реализовать отношение между потребителем и производителем, где одна часть программы производит элементы и помещает их в очередь, а другая удаляет их и использует. Следующий код выполняет это:

var q := new queue
   
coroutine produce
    loop
        while q is not full
            create some new items
            add the items to q
        yield to consume
     
coroutine consume
    loop
        while q is not empty
            remove some items from q
            use the items
        yield to produce

Каждая сопрограмма передаёт управление при помощи директивы yield. Аналогичную функциональность можно было реализовать используя два потока, но использование сопрограмм упрощает задачу и снимает некоторые проблемы, возникающие при многопоточности.

Для сопрограммы можно иметь несколько входных и выходных точек, и любую подпрограмму можно реализовать как сопрограмму. Действительно, по утверждению Кнута «подпрограмма является частным случаем сопрограммы».

Каждый раз при вызове подпрограммы выполнение начинается со стартовой точки. Аналогично, при первом вызове сопрограммы, выполнение начинается со стартовой точки сопрограммы. Однако при последующих вызовах выполнение продолжается с точки последнего возврата.

Подпрограмма возвращает значение только однажды, возврат нескольких значений требует использовать в качестве возвращаемого значения коллекции. Если в некоторых языках это приемлемо, например Forth и Перл, то другие языки, например Си, поддерживают только одно возвращаемое значение, и поэтому необходимо возвращать ссылку на коллекцию. В противовес, сопрограмма может возвращать результат несколько раз, возвращение множества значений требует только вызова сопрограммы несколько раз. Сопрограммы, которые возвращают множество значений, часто называют генераторами.

Подпрограммы требуют один стек для работы, который может быть выделен в начале выполнения программы. Сопрограмма же, имеющая возможность вызывать другие сопрограммы одного с ней уровня, лучше реализуется с использованием продолжений. Тогда может потребоваться выделять дополнительные стеки, и поэтому это в основном реализуется в высокоуровневых языках с поддержкой сборщика мусора. Создание сопрограмм может быть эффективным при использовании заранее выделенных стеков и кэшированием ранее созданных.

Сопрограммы полезны для реализации следующего:

• Конечный автомат внутри одной подпрограммы, где состояние определяется по текущей точке входа/выхода. В результате может давать более читабельный текст.
• Модель_акторов.
• Генераторы, которые являются полезными для ввода/вывода и обобщённого обхода структур данных.

Языки программирования, поддерживающие сопрограммы

• AngelScript
• C#
• Forth (изначально не поддерживает, но поддержка легко реализуется средствами самого Форта)
• Io
• Go
• Lua
• Modula-2
• Coro)
• Perl 6
• Python
• Ruby
• Simula
• Tcl (начиная с 8.6)

Так как продолжения используются для реализации сопрограмм, языки поддерживающие их, могут легко реализовать поддержку сопрограмм.

Альтернативы и реализации

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

В ситуации, когда сопрограммы, как естественный способ реализации компонентов, недоступны, типичным решением является создание сопрограмм с использованием набора булевских флагов и других состояний переменных для поддержки внешнего состояния между вызовами. Условия внутри кода приводят к выполнению различных последовательностей команд при последовательных вызовах в соответствии со значениями переменных состояния. Другим типичным решением является самостоятельная реализация конечного автомата с помощью большой инструкции switch. Такие реализации являются сложными для поддержки и сопровождения.

Потоки являются подходящей альтернативой для сопрограмм в большинстве современных разработок. Потоки предоставляют возможности для управления взаимодействием «одновременно» выполняющихся участков кода. Поэтому это решение больших и сложных проблем, оно включает мощные комплексные возможности и имеет сопутствующую сложность для обучения. Однако, несмотря на другие альтернативы, потоки широко доступны в окружении сопровождения Си, являются близкими для большинства программистов, и обычно реализованы, документированы и сопровождаются.

Реализации

• В стандартной библиотеке Си присутствуют функции setjmp и longjmp, которые могут использоваться для реализации сопрограмм. К сожалению эти функции сложны в реализации, и программисты стремятся использовать их как можно реже.^{[источник не указан 1233 дня]} Эти функции могут не работать на разных платформах, также нередки ошибки в их реализации.^{[источник не указан 1233 дня]}

Различные попытки реализовать сопрограммы на Си имели переменный успех. Наиболее заметные:

• Coroutines in C by Simon Tatham (Саймон Тэтхем) (англ.) — с применением «устройства Даффа»
• Portable Coroutine Library (PCL) (англ.)
• Coro (англ.)
• Reentrant coroutines in C++ (англ.)

На других языках:

• Python
  • PEP 342 (англ.);
  • Greenlets (англ.);
  • gevent (англ.);
• Io
  • Coroutine (англ.)
• Ruby
  • Coroutine (яп.);
• Perl
  • Coro (англ.);
• Lua имеет встроенную поддержку сопрограмм;
• Функциональные языки программирования зачастую реализуют сопрограммы, например Scheme, Lisp, Haskell.

См. также

• Итератор
• Канал
• Генератор

Книги

• Дональд Кнут Искусство программирования, том 1. Основные алгоритмы = The Art of Computer Programming, vol.1. Fundamental Algorithms. — 3-е изд. — М.: «Вильямс», 2006. — С. 720. — ISBN 0-201-89683-4   Раздел 1.4.2: Сопрограммы, стр. 229—236