Default package

Get desktop application:
View/edit binary Protocol Buffers messages

* Selected address type for a medium.

Used in: PhoResponse.Read.Elt, PhoResponse.Write.Elt

• AD_PATH = 0

  ID is entry path (e.g. for imported tapes). */

• AD_HASH1 = 1

  ID hashing, implementation 1. */

• AD_OPAQUE = 2

  Opaque identifier provided by the backend. */

* Configure operations.

Used in: PhoRequest.Configure

• OP_CONF_SET = 0

  Set a configuration element

• OP_CONF_GET = 1

  Retrieve a configuration element

* Selected filesystem type for a medium.

Used in: PhoRequest.Format, PhoResponse.Read.Elt, PhoResponse.Write.Elt

• FS_POSIX = 0

  POSIX filesystem (no specific feature).

• FS_LTFS = 1

  LTFS (Linear Tape File System).

• FS_RADOS = 2

  RADOS fake filesystem.

* Notify operation.

Used in: PhoRequest.Notify

• OP_DEV_ADD = 0

  Device add operation.

• OP_DEV_LOCK = 1

  Device lock operation.

• OP_DEV_UNLOCK = 2

  Device unlock operation.

• OP_MEDIA_UPDATE = 3

  Medium was updated in the DSS.

* Target allocation operation. For now, those allocations are named 'READ' allocations.

Used in: PhoRequest.Read

• OP_READ = 0

  Read allocation.

• OP_DELETE = 1

  Delete allocation.

* LRS protocol request, emitted by layout modules.

• required uint32 id = 1

  Request ID to match its future

• optional int64 qos = 2

  response.

  Greater means high-priority.

• optional int64 priority = 3

  QOS is more important than priority. We first consider QOS to order request, and then priority.

  Greater means high-priority.

• optional PhoRequest.Write walloc = 4

  Only exactly one of these fields is expected.

  Write allocation body.

• optional PhoRequest.Read ralloc = 5

  Read allocation body.

• optional PhoRequest.Release release = 6

  Release body.

• optional PhoRequest.Format format = 7

  Format body.

• optional PhoRequest.Notify notify = 8

  Notify body.

• optional bool ping = 9

  Is the request a ping request ?

• optional PhoRequest.Monitor monitor = 10

  Monitor body.

• optional PhoRequest.Configure configure = 11

  Configure body.

• optional PhoRequest.Stat stat = 12

  Stat body.

Used in: PhoRequest

• required PhoConfigureOp op = 1

  Type of the request

• required string configuration = 2

  JSON format containing

* Body of the format request.

Used in: PhoRequest

• required PhoResourceId med_id = 1

  ID of the medium to format.

• required PhoFsType fs = 2

  Medium file system.

• required bool unlock = 3

  True if the medium needs to be

• required bool force = 4

  unlocked after format.

  True if we do not care about

* Body of the monitor request.

Used in: PhoRequest

• required PhoResourceFamily family = 1

* Body of the notify request.

Used in: PhoRequest

• required PhoResourceId rsrc_id = 1

  ID of the notified resource.

• required PhoNotifyOp op = 2

  Notification operation.

• required bool wait = 3

  Whether the client requires the

* Body of read allocation request, request n_required media among the provided med_ids (n_required <= n_med_ids).

Used in: PhoRequest

• required uint32 n_required = 1

  Number of media to actually

• repeated PhoResourceId med_ids = 2

  allocate among the ones specified in med_ids.

  IDs of the requested media.

• required PhoReadTargetAllocOp operation = 3

  Operation done on the allocation.

* Body of the release request.

Used in: PhoRequest

• repeated Release.Elt media = 1

  Description of the media to release.

• required bool partial = 2

  Whether the client requires the LRS to

• required PhoRequestKind kind = 3

  perform only a sync without releasing the medium.

  Kind of release:

* Release request for one medium.

Used in: Release

• required PhoResourceId med_id = 1

  ID of the medium to release.

• required int32 rc = 2

  Outcome of the performed IO

• required uint64 size_written = 3

  (0 or -errno).

  Amount of bytes written

• required uint64 nb_extents_written = 4

  on this medium (0 if the medium was only read).

• required bool to_sync = 5

  Number of objects written on this medium (0 if the medium was only read).

  Whether the client requires

• optional string grouping = 6

  the LRS to perform a sync or not.

  Targeted grouping

* Body of the stats request

Used in: PhoRequest

• optional string ns = 1

  Filter for stats namespace Notice protobuff does not leave 'namespace' as field name.

• optional string name = 2

  filter for stat name

• optional string tags = 3

  filters on tags

* Body of write allocation request.

Used in: PhoRequest

• repeated Write.Elt media = 1

  Write allocation requests.

• required PhoResourceFamily family = 2

  Requested resource family.

• required bool prevent_duplicate = 3

  True if the client does not

• optional string library = 4

  want a medium it already allocated

  Targeted library

• required bool no_split = 5

  Whether the client requires

• optional string grouping = 6

  to put all the data on the same medium.

  Targeted grouping

* Request for one write accessible medium.

Used in: Write

• required uint64 size = 1

  Amount of data to be written

• repeated string tags = 2

  on the medium.

  Tags to be satisfied.

• required bool empty_medium = 3

  Whether the client requires an

* LRS request kind (used in PhoResponse).

Used in: PhoRequest.Release, PhoResponse.Error, PhoResponse.Release

• RQ_WRITE = 0

  Media allocation with write ability.

• RQ_READ = 1

  Media allocation with read ability.

• RQ_RELEASE_READ = 2

  Read Media release and flush. The IO is considered

• RQ_RELEASE_WRITE = 3

  complete once the release and flush are done.

  Write Media release and flush. The IO is considered

• RQ_FORMAT = 4

  complete once the release and flush are done.

  Medium format.

• RQ_NOTIFY = 5

  LRS notification to refresh device/medium

• RQ_MONITOR = 6

  information.

  Query information about the current status of the

• RQ_CONFIGURE = 7

  LRS.

  Get/Set configuration information from the LRS

• RQ_STAT = 8

  Retrieve stats from the LRS

* Resource family.

Used in: PhoRequest.Monitor, PhoRequest.Write, PhoResourceId

• FM_TAPE = 0

  Tape.

• FM_DIR = 1

  Directory.

• FM_RADOS_POOL = 2

  RADOS Pool.

* Resource identifier.

Used in: PhoRequest.Format, PhoRequest.Notify, PhoRequest.Read, PhoRequest.Release.Elt, PhoResponse.Format, PhoResponse.Notify, PhoResponse.Read.Elt, PhoResponse.Release, PhoResponse.Write.Elt

• required PhoResourceFamily family = 1

  Family type.

• required string name = 2

  Resource name.

• required string library = 3

  Resource library.

* LRS protocol response, emitted by the LRS.

• required uint32 req_id = 1

  Request ID, to be matched with

• optional PhoResponse.Write walloc = 2

  Only exactly one of these fields is expected.

  Write allocation body.

• optional PhoResponse.Read ralloc = 3

  Read allocation body.

• optional PhoResponse.Release release = 4

  Release body.

• optional PhoResponse.Format format = 5

  Format body.

• optional PhoResponse.Notify notify = 6

  Notify body.

• optional PhoResponse.Error error = 8

  Error body.

• optional bool ping = 9

  Is the response a ping response ?

• optional PhoResponse.Monitor monitor = 10

  Monitor body.

• optional PhoResponse.Configure configure = 11

  Configure body.

• optional PhoResponse.Stat stat = 12

  Stat body.

Used in: PhoResponse

• optional string configuration = 1

  JSON format containing

* Body of the error response.

Used in: PhoResponse

• required int32 rc = 1

  Error code,

• required PhoRequestKind req_kind = 2

  -errno for homogeneity.

  Kind of request that

* Body of the format response.

Used in: PhoResponse

• required PhoResourceId med_id = 1

  ID of formatted medium.

* Body of the monitor response

Used in: PhoResponse

• required string status = 1

  JSON str containing status information.

* Body of the notify response.

Used in: PhoResponse

• required PhoResourceId rsrc_id = 1

  ID of notified resource.

* Body of the read allocation response.

Used in: PhoResponse

• repeated Read.Elt media = 1

  Description of allocated media.

* Read allocation response for one medium.

Used in: Read

• required PhoResourceId med_id = 1

  ID of the allocated

• required string root_path = 2

  medium.

  Mount point.

• required PhoFsType fs_type = 3

  Filesystem type.

• required PhoAddressType addr_type = 4

  Address type.

* Body of the release response.

Used in: PhoResponse

• repeated PhoResourceId med_ids = 1

  IDs of released media.

• required bool partial = 2

  Is a partial release ?

• required PhoRequestKind kind = 3

  Kind of release:

* Body of the stat response

Used in: PhoResponse

• required string stats = 1

  JSON str containing stats.

* Body of the write allocation response.

Used in: PhoResponse

• repeated Write.Elt media = 1

  Description of allocated

• optional PhoSyncThreshold threshold = 2

  media.

  LRS sync threshold.

* Write allocation response for one medium.

Used in: Write

• required PhoResourceId med_id = 1

  ID of the allocated

• required uint64 avail_size = 2

  medium.

  Size available on this

• required string root_path = 3

  medium (potentially less than requested).

  Mount point.

• required PhoFsType fs_type = 4

  Filesystem type.

• required PhoAddressType addr_type = 5

  Address type.

* LRS sync threshold

Used in: PhoResponse.Write

• required uint64 sync_nb_req = 1

  Number of requests threshold.

• required uint64 sync_wsize_kb = 2

  Written size threshold.

• required int64 sync_time_sec = 3

  Time threshold in seconds.

• required int64 sync_time_nsec = 5

  Time threshold in nanoseconds.

* TLC protocol request, emitted by layout modules.

• required uint32 id = 1

  Request ID to match its future response.

• optional bool ping = 2

  Is the request a ping one ?

• optional PhoTlcRequest.DriveLookup drive_lookup = 3

  Drive lookup body

• optional PhoTlcRequest.Load load = 4

  Load body

• optional PhoTlcRequest.Unload unload = 5

  Unload body

• optional PhoTlcRequest.Status status = 6

  Status body

• optional bool refresh = 7

  Is the request a refresh one ?

• optional PhoTlcRequest.Stat stat = 8

  Stat body

* Body of drive lookup request

Used in: PhoTlcRequest

• required string serial = 1

  Serial number of the drive to lookup

* Body of the tlc load request

Used in: PhoTlcRequest

• required string drive_serial = 1

  Serial number of the target drive

• required string tape_label = 2

  Medium label to load

* Body of the stats request

Used in: PhoTlcRequest

• optional string ns = 1

  Filter for stats namespace

• optional string name = 2

  filter for stat name

• optional string tags = 3

  filters on tags

* Body of the tlc status request

Used in: PhoTlcRequest

• required bool refresh = 1

  If true, status cache is refreshed before

* Body of the tlc unload request

Used in: PhoTlcRequest

• required string drive_serial = 1

  Serial number of the target drive

• optional string tape_label = 2

  Medium label to unload from drive

* TLC protocol response, emitted by the TLC.

• required uint32 req_id = 1

  Request ID, to be matched with

• optional PhoTlcResponse.Ping ping = 2

  Ping body

• optional PhoTlcResponse.DriveLookup drive_lookup = 3

  Drive lookup response body

• optional PhoTlcResponse.Error error = 4

  Error body

• optional PhoTlcResponse.Load load = 5

  Load body

• optional PhoTlcResponse.Unload unload = 6

  Unload body

• optional PhoTlcResponse.Status status = 7

  Status body

• optional bool refresh = 8

  This response is a successful refresh one

• optional PhoTlcResponse.Stat stat = 9

  Stat body

* Body of drive lookup response.

Used in: PhoTlcResponse

• required uint64 address = 1

  Address of the drive in lib

• required uint64 first_address = 2

  Address of the first drive in

• optional string medium_name = 3

  lib

  Loaded medium name (if any)

* Body of error response

Used in: PhoTlcResponse

• required int32 rc = 1

  Error code, -errno for homogeneity.

• optional string message = 2

  JSON message describing the error

* Body of load response

Used in: PhoTlcResponse

• optional string message = 1

  JSON message describing the load

* Body of the ping response.

Used in: PhoTlcResponse

• required bool library_is_up = 1

  True if the TLC could successfully

Body of the stat response

Used in: PhoTlcResponse

• required string stats = 1

  JSON str containing stats.

Body of status response

Used in: PhoTlcResponse

• required string lib_data = 1

  JSON array describing the library

• optional string message = 2

  JSON message describing the status

* Body of unload response

Used in: PhoTlcResponse

• required string tape_label = 1

  Unloaded tape label

• required uint64 addr = 2

  Library addr where tape was unloaded

• optional string message = 3

  JSON message describing the unload