networkfs API

networkfs API доступно по адресу http://nerc.itmo.ru/teaching/os/networkfs/.

Оглавление

• Запросы
• Ответы
• Методы
  • token.issue
  • fs.list
  • fs.create
  • fs.read
  • fs.write
  • fs.link
  • fs.unlink
  • fs.rmdir
  • fs.lookup

Запросы

Все запросы осуществляются по методу GET. Аргументы передаются в GET-параметрах.

Путь составляется следующим образом: API_URL / :version / :token / :method. Пример: http://nerc.itmo.ru/teaching/os/networkfs/v1/12345678/fs/read?inode=1234.

Токен пропускается в методе token.issue. В названии метода точки заменяются на слеши.

Ответы

Система поддерживает два типа ответов.

• binary — возвращает представление, которое можно скастить в структуру следующего типа на 64-битной системе (по умолчанию):

  struct result {
      u64 status;
      response_type response;
  }
  

• json — JSON-объект:

  {
      "status": 0,
      "response": ...
  }
  

Чтобы получить JSON-объект, нужно передать параметр json (с любым значением или без него) или заголовок Accept: application/json. Пример: http://nerc.itmo.ru/teaching/os/networkfs/v1/12345678/fs/list?inode=12345.

В случае ненулевого кода ошибки (status) ответ не возвращается.

Коды ошибок:

• 0 — Запрос выполнен успешно.
• 1 — Не найден объект по номеру inode.
• 2 — Объект не является файлом.
• 3 — Объект не является директорией.
• 4 — В указанной директории нет записи с таким именем.
• 5 — В указанной директории уже есть запись с таким именем.
• 6 — Превышен лимит на размер файла (512 байт).
• 7 — Превышен лимит на количество записей в директории (16).
• 8 — Директория не пуста.
• 9 — Превышен лимит на длину названия файла (255 символов).

Методы

token.issue

Выдаёт новый токен. В новой файловой системе есть несколько файлов для примера.

Авторизация не требуется.

Пример запроса: http://nerc.itmo.ru/teaching/os/networkfs/v1/token/issue?json

Возвращаемое значение:

char token[16];

Возможные коды ошибок: 0.

fs.list

Возвращает информацию о директории.

Аргументы:

• inode — номер inode

Возвращаемое значение:

struct entries {
    size_t entries_count;
    struct entry {
        unsigned char entry_type; // DT_DIR (4) or DT_REG (8)
        ino_t ino;
        char name[256];
    } entries[16];
}

Возможные коды ошибок: 0, 1, 3.

fs.create

Создаёт новый объект.

Аргументы:

• parent — номер родительской inode
• name — название директории
• type — тип создаваемого объекта: directory или file

Возвращаемое значение:

ino_t ino;

Возможные коды ошибок: 0, 1, 3, 5, 7.

fs.read

Читает содержимое файла.

Аргументы:

• inode — номер inode

Возвращаемое значение:

struct content {
    u64 content_length;
    char content[content_length];
};

Возможные коды ошибок: 0, 1, 2.

fs.write

Записывает данные в файл.

Аргументы:

• inode — номер inode
• content — содержимое файла

Возвращается только код ошибки.

Возможные коды ошибок: 0, 1, 2, 6.

fs.link

Создаёт жёсткую ссылку.

Аргументы:

• source — номер inode, на которую нужно сослаться
• parent — номер родительской директории
• name — название ссылки

Возвращается только код ошибки.

Возможные коды ошибок: 0, 1, 2, 3, 5, 7.

Примечания:

• Ошибка 2 возвращается, если source не является файлом, ошибка 3 — если parent не является директорией.
• Ссылки на директории (junction) не реализованы.

fs.unlink

Удаляет файл. Если на данную inode больше никто не ссылается, она также удаляется.

Аргументы:

• parent — номер родительской директории
• name — название файла

Возвращается только код ошибки.

Возможные коды ошибок: 0, 1, 2, 3, 4.

fs.rmdir

Удаляет пустую директорию.

Аргументы:

• parent — номер родительской директории
• name — название директории

Возвращается только код ошибки.

Возможные коды ошибок: 0, 1, 3, 4, 8.

fs.lookup

Возвращает информацию об объекте.

Аргументы:

• parent — номер родительской директории
• name — название объекта.

Возвращаемое значение:

struct entry_info {
    unsigned char entry_type; // DT_DIR (4) or DT_REG (8)
    ino_t ino;
};

Возможные коды ошибок: 0, 1, 3, 4.