Skip to content
master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
daos/src/proto/
Go to file
daos/src/proto/

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
. .
ctl
 
 
mgmt
 
 
security
 
 
shared
 
 
srv
 
 
test
 
 
Makefile
 
 
README.md
 
 
drpc.proto
 
 
Protobuf definitions Directory structure Generate language specific code

README.md

Protobuf definitions

The proto directory contains protocol buffer definitions for the messaging format used in communication over the gRPC and dRPC channels. For information on using protobuf tools for development see here.

Directory structure

  • ctl directory is for messages that can be multicast to DAOS Servers that have gRPC server capacity, regardless of the state of the DAOS system.
  • mgmt directory is for messages that need to be handled by the DAOS management service leader, this requires that the DAOS system be initialized.
  • security directory is for messages specific to the context of security.
  • shared directory contains message definitions shared between subdirectories.
  • srv directory contains message definitions specific to communications from DAOS I/O Engine processes to DAOS Server processes via dRPC.

Generate language specific code

When modifying these files, make sure to update all generated files. For convenience, existing proto generated code will be updated by running make from the src/proto directory. Be sure to edit the Makefile when adding or moving .proto files.

Go language specific protobuf message definitions are generated into the common proto directory with the same directory structure.

Alternatively, auto generated protobuf files can be updated or created with commands listed below issued from within the src/proto top level directory of DAOS source:

  • Files generated for the control plane in src/control will be in Golang and have the file extension .pb.go. Example command syntax: protoc -I mgmt --go_out=plugins=grpc:control/common/proto/mgmt mgmt/storage.proto

  • Files generated for the data plane in other src subdirectories will be in C and have file extensions .pb-c.[ch]. A third-party plugin protobuf-c is required to generate C language pb files. Example command syntax: protoc -I mgmt --c_out=../mgmt mgmt/srv.proto --plugin=/opt/potobuf/install/bin/protoc-gen-c