Format annotation (#333)

Author: TonyCode2012

src/app/chain/Chain.cpp

@@ -51,6 +51,7 @@ Chain::~Chain()
 
 /**
  * @description: get laster block header from chain
+ * @param block_header -> Reference to block_header
  * @return: the point of block header
  */
 bool Chain::get_block_header(BlockHeader &block_header)

src/app/ecalls/ECalls.cpp

@@ -4,7 +4,8 @@ EnclaveQueue *eq = EnclaveQueue::get_instance();
 
 /**
  * @description: A wrapper function, seal one G srd files under directory, can be called from multiple threads
- * @param path -> the directory path
+ * @param eid -> Enclave id
+ * @return: Invoking ecall return status
  */
 sgx_status_t Ecall_srd_increase(sgx_enclave_id_t eid)
 {
@@ -23,8 +24,10 @@ sgx_status_t Ecall_srd_increase(sgx_enclave_id_t eid)
 
 /**
  * @description: A wrapper function, decrease srd files under directory
- * @param path -> the directory path
+ * @param eid -> Enclave id
+ * @param size (out) -> Pointer to decreased srd size
  * @param change -> reduction
+ * @return: Invoking ecall return status
  */
 sgx_status_t Ecall_srd_decrease(sgx_enclave_id_t eid, size_t *size, size_t change)
 {
@@ -43,6 +46,8 @@ sgx_status_t Ecall_srd_decrease(sgx_enclave_id_t eid, size_t *size, size_t chang
 
 /**
  * @description: A wrapper function, ecall main loop
+ * @param eid -> Enclave id
+ * @return: Invoking ecall return status
  */
 sgx_status_t Ecall_main_loop(sgx_enclave_id_t eid)
 {
@@ -61,6 +66,8 @@ sgx_status_t Ecall_main_loop(sgx_enclave_id_t eid)
 
 /**
  * @description: A wrapper function, ecall stop all
+ * @param eid -> Enclave id
+ * @return: Invoking ecall return status
  */
 sgx_status_t Ecall_stop_all(sgx_enclave_id_t eid)
 {
@@ -79,7 +86,9 @@ sgx_status_t Ecall_stop_all(sgx_enclave_id_t eid)
 
 /**
  * @description: A wrapper function, Restore enclave data from file
- * @param status -> Pointer to restore result status
+ * @param eid -> Enclave id
+ * @param status (out) -> Pointer to restore result status
+ * @return: Invoking ecall return status
  */
 sgx_status_t Ecall_restore_metadata(sgx_enclave_id_t eid, crust_status_t *status)
 {
@@ -98,9 +107,11 @@ sgx_status_t Ecall_restore_metadata(sgx_enclave_id_t eid, crust_status_t *status
 
 /**
  * @description: A wrapper function, Compare chain account with enclave's
- * @param status -> Pointer to compare result status
+ * @param eid -> Enclave id
+ * @param status (out) -> Pointer to compare result status
  * @param account_id (in) -> Pointer to account id
  * @param len -> account id length
+ * @return: Invoking ecall return status
  */
 sgx_status_t Ecall_cmp_chain_account_id(sgx_enclave_id_t eid, crust_status_t *status, const char *account_id, size_t len)
 {
@@ -119,9 +130,11 @@ sgx_status_t Ecall_cmp_chain_account_id(sgx_enclave_id_t eid, crust_status_t *st
 
 /**
  * @description: A wrapper function, Get signed validation report
- * @param status -> Pointer to get result status
+ * @param eid -> Enclave id
+ * @param status (out) -> Pointer to get result status
  * @param block_hash (in) -> block hash
- * @param block_height (in) -> block height
+ * @param block_height -> block height
+ * @return: Invoking ecall return status
  */
 sgx_status_t Ecall_gen_and_upload_work_report(sgx_enclave_id_t eid, crust_status_t *status, const char *block_hash, size_t block_height)
 {
@@ -140,6 +153,11 @@ sgx_status_t Ecall_gen_and_upload_work_report(sgx_enclave_id_t eid, crust_status
 
 /**
  * @description: A wrapper function, generate ecc key pair and store it in enclave
+ * @param eid -> Enclave id
+ * @param status (out) -> Pointer to result status
+ * @param account_id (in) -> Pointer to account id
+ * @param len -> Account id length
+ * @return: Invoking ecall return status
  */
 sgx_status_t Ecall_gen_key_pair(sgx_enclave_id_t eid, sgx_status_t *status, const char *account_id, size_t len)
 {
@@ -159,8 +177,11 @@ sgx_status_t Ecall_gen_key_pair(sgx_enclave_id_t eid, sgx_status_t *status, cons
 /**
  * @description: A wrapper function, get sgx report, our generated public key contained
  *  in report data
+ * @param eid -> Enclave id
+ * @param status (out) -> Pointer to result status
  * @param report (out) -> Pointer to SGX report
  * @param target_info (in) -> Data used to generate report
+ * @return: Invoking ecall return status
  */
 sgx_status_t Ecall_get_quote_report(sgx_enclave_id_t eid, sgx_status_t *status, sgx_report_t *report, sgx_target_info_t *target_info)
 {
@@ -179,6 +200,9 @@ sgx_status_t Ecall_get_quote_report(sgx_enclave_id_t eid, sgx_status_t *status,
 
 /**
  * @description: A wrapper function, generate current code measurement
+ * @param eid -> Enclave id
+ * @param status (out) -> Pointer to result status
+ * @return: Invoking ecall return status
  */
 sgx_status_t Ecall_gen_sgx_measurement(sgx_enclave_id_t eid, sgx_status_t *status)
 {
@@ -197,9 +221,11 @@ sgx_status_t Ecall_gen_sgx_measurement(sgx_enclave_id_t eid, sgx_status_t *statu
 
 /**
  * @description: A wrapper function, verify IAS report
- * @param status -> Pointer to verify result status
+ * @param eid -> Enclave id
+ * @param status (out) -> Pointer to verify result status
  * @param IASReport (in) -> Vector first address
  * @param len -> Count of Vector IASReport
+ * @return: Invoking ecall return status
  */
 sgx_status_t Ecall_verify_and_upload_identity(sgx_enclave_id_t eid, crust_status_t *status, char **IASReport, size_t len)
 {
@@ -218,9 +244,10 @@ sgx_status_t Ecall_verify_and_upload_identity(sgx_enclave_id_t eid, crust_status
 
 /**
  * @description: A wrapper function, Seal file according to given path and return new MerkleTree
- * @param status -> Pointer to seal result status
- * @param cid -> Ipfs content id
- * @param file_size -> Pointer to sealed file size
+ * @param eid -> Enclave id
+ * @param status (out) -> Pointer to seal result status
+ * @param cid (in) -> Ipfs content id
+ * @return: Invoking ecall return status
  */
 sgx_status_t Ecall_seal_file(sgx_enclave_id_t eid, crust_status_t *status, const char *cid)
 {
@@ -239,12 +266,11 @@ sgx_status_t Ecall_seal_file(sgx_enclave_id_t eid, crust_status_t *status, const
 
 /**
  * @description: A wrapper function, Unseal file according to given path
- * @param status -> Pointer to unseal result status
- * @param files (in) -> Files in root directory
- * @param files_num -> Files number in root directory
- * @param p_dir (in) -> Root directory path
- * @param p_new_path (out) -> Pointer to unsealed data path
- * @param path_len -> Root dir path length
+ * @param eid -> Enclave id
+ * @param status (out) -> Pointer to unseal result status
+ * @param data (in) -> Pointer to sealed data
+ * @param data_size -> Sealed data size
+ * @return: Invoking ecall return status
  */
 sgx_status_t Ecall_unseal_file(sgx_enclave_id_t eid, crust_status_t *status, const char *data, size_t data_size)
 {
@@ -263,7 +289,11 @@ sgx_status_t Ecall_unseal_file(sgx_enclave_id_t eid, crust_status_t *status, con
 
 /**
  * @description: Change srd number
+ * @param eid -> Enclave id
+ * @param status (out) -> Pointer to result status
  * @param change -> Will be changed srd number
+ * @param real_change (out) -> Pointer to real changed srd size
+ * @return: Invoking ecall return status
  */
 sgx_status_t Ecall_change_srd_task(sgx_enclave_id_t eid, crust_status_t *status, long change, long *real_change)
 {
@@ -282,8 +312,9 @@ sgx_status_t Ecall_change_srd_task(sgx_enclave_id_t eid, crust_status_t *status,
 
 /**
  * @description: Update srd_g_hashs
- * @param hashs -> Pointer to the address of to be deleted hashs array
- * @param hashs_len -> Hashs array length
+ * @param eid -> Enclave id
+ * @param change -> To be deleted srd size
+ * @return: Invoking ecall return status
  */
 sgx_status_t Ecall_srd_remove_space(sgx_enclave_id_t eid, size_t change)
 {
@@ -302,8 +333,10 @@ sgx_status_t Ecall_srd_remove_space(sgx_enclave_id_t eid, size_t change)
 
 /**
  * @description: Delete file
- * @param status -> Pointer to delete result status
- * @param hash -> File root hash
+ * @param eid -> Enclave id
+ * @param status (out) -> Pointer to delete result status
+ * @param hash (in) -> File root hash
+ * @return: Invoking ecall return status
  */
 sgx_status_t Ecall_delete_file(sgx_enclave_id_t eid, crust_status_t *status, const char *hash)
 {
@@ -322,7 +355,10 @@ sgx_status_t Ecall_delete_file(sgx_enclave_id_t eid, crust_status_t *status, con
 
 /**
  * @description: Generate upgrade metadata
- * @param status -> Pointer to generate result status
+ * @param eid -> Enclave id
+ * @param status (out) -> Pointer to generate result status
+ * @param block_height -> Chain block height
+ * @return: Invoking ecall return status
  */
 sgx_status_t Ecall_gen_upgrade_data(sgx_enclave_id_t eid, crust_status_t *status, size_t block_height)
 {
@@ -341,7 +377,13 @@ sgx_status_t Ecall_gen_upgrade_data(sgx_enclave_id_t eid, crust_status_t *status
 
 /**
  * @description: Generate upgrade metadata
- * @param status -> Pointer to metadata
+ * @param eid -> Enclave id
+ * @param status (out) -> Pointer to result status
+ * @param meta (in) -> Pointer to metadata
+ * @param meta_len -> Meta length
+ * @param total_size -> Metadata total size
+ * @param transfer_end -> Indicate transfer end or not
+ * @return: Invoking ecall return status
  */
 sgx_status_t Ecall_restore_from_upgrade(sgx_enclave_id_t eid, crust_status_t *status, const char *meta, size_t meta_len, size_t total_size, bool transfer_end)
 {
@@ -360,7 +402,10 @@ sgx_status_t Ecall_restore_from_upgrade(sgx_enclave_id_t eid, crust_status_t *st
 
 /**
  * @description: Enable upgrade
+ * @param eid -> Enclave id
+ * @param status (out) -> Pointer to result status
  * @param block_height -> Current block height
+ * @return: Invoking ecall return status
  */
 sgx_status_t Ecall_enable_upgrade(sgx_enclave_id_t eid, crust_status_t *status, size_t block_height)
 {
@@ -379,6 +424,8 @@ sgx_status_t Ecall_enable_upgrade(sgx_enclave_id_t eid, crust_status_t *status,
 
 /**
  * @description: Disable upgrade
+ * @param eid -> Enclave id
+ * @return: Invoking ecall return status
  */
 sgx_status_t Ecall_disable_upgrade(sgx_enclave_id_t eid)
 {
@@ -397,6 +444,8 @@ sgx_status_t Ecall_disable_upgrade(sgx_enclave_id_t eid)
 
 /**
  * @description: Get enclave id information
+ * @param eid -> Enclave id
+ * @return: Invoking ecall return status
  */
 sgx_status_t Ecall_id_get_info(sgx_enclave_id_t eid)
 {
@@ -415,6 +464,8 @@ sgx_status_t Ecall_id_get_info(sgx_enclave_id_t eid)
 
 /**
  * @description: Get workload
+ * @param eid -> Enclave id
+ * @return: Invoking ecall return status
  */
 sgx_status_t Ecall_get_workload(sgx_enclave_id_t eid)
 {

src/app/ecalls/EnclaveQueue.cpp

@@ -127,7 +127,7 @@ std::string EnclaveQueue::get_running_ecalls_info()
 
 /**
  * @description: Get higher priority task number
- * @param cur_prio -> current priority
+ * @param priority -> current priority
  * @return: The higher task number
  */
 int EnclaveQueue::get_higher_prio_waiting_task_num(int priority)

src/app/http/HttpClient.cpp

@@ -145,6 +145,7 @@ http::response<http::string_body> HttpClient::SSLPost(std::string url, std::stri
  * @param body -> Request body
  * @param content_type -> Indicates content type
  * @param headers -> Poniter to header
+ * @param type -> Request type
  * @return: Json result
  */
 http::response<http::string_body> HttpClient::request_sync_ssl(http::verb method, std::string url, 

src/app/ipfs/Ipfs.cpp

@@ -4,9 +4,9 @@ crust::Log *p_log = crust::Log::get_instance();
 HttpClient *ipfs_client = NULL;
 Ipfs *Ipfs::ipfs = NULL;
 
-std::string block_get_timeout = "1s";
-std::string cat_timeout = "6s";
-std::string add_timeout = "600s";
+const std::string block_get_timeout = "1s";
+const std::string cat_timeout = "6s";
+const std::string add_timeout = "600s";
 
 /**
  * @desination: single instance class function to get instance
@@ -16,7 +16,7 @@ Ipfs *Ipfs::get_instance()
 {
     if (Ipfs::ipfs == NULL)
     {
-        Ipfs::ipfs = new Ipfs("http://127.0.0.1:5001/api/v0");
+        Ipfs::ipfs = new Ipfs(Config::get_instance()->ipfs_url);
     }
 
     return Ipfs::ipfs;
@@ -48,7 +48,7 @@ Ipfs::~Ipfs()
 /**
  * @description: Test if there is usable IPFS
  * @return: Test result
- * */
+ */
 bool Ipfs::online()
 {
     std::string path = this->url + "/version";
@@ -63,8 +63,10 @@ bool Ipfs::online()
 
 /**
  * @description: Get block from ipfs
+ * @param cid -> File content id
+ * @param p_data_out -> Pointer to pointer to data output
  * @return: size of block, 0 for error
- * */
+ */
 size_t Ipfs::block_get(const char *cid, unsigned char **p_data_out)
 {
     std::string path = this->url + "/block/get?arg=" + cid + "&timeout=" + block_get_timeout;
@@ -96,8 +98,10 @@ size_t Ipfs::block_get(const char *cid, unsigned char **p_data_out)
 
 /**
  * @description: Cat file
+ * @param cid -> File content id
+ * @param p_data_out -> Pointer to pointer to data output
  * @return: size of file, 0 for error
- * */
+ */
 size_t Ipfs::cat(const char *cid, unsigned char **p_data_out)
 {
     std::string path = this->url + "/cat?arg=" + cid + "&timeout=" + cat_timeout;
@@ -118,8 +122,10 @@ size_t Ipfs::cat(const char *cid, unsigned char **p_data_out)
 
 /**
  * @description: Add file to ipfs
+ * @param p_data_in -> Pointer to data to be added
+ * @param size -> Size of added data
  * @return: Hash of the file
- * */
+ */
 std::string Ipfs::add(unsigned char *p_data_in, size_t size)
 {
     std::string path = this->url + "/add" + "?timeout=" + add_timeout;
@@ -141,8 +147,9 @@ std::string Ipfs::add(unsigned char *p_data_in, size_t size)
 
 /**
  * @description: Delete file
+ * @param cid -> File content id
  * @return: Delete result
- * */
+ */
 bool Ipfs::del(std::string cid)
 {
     std::string path = this->url + "/pin/rm?arg=" + cid;

src/app/ocalls/IpfsOCalls.cpp

@@ -59,6 +59,7 @@ crust_status_t ocall_ipfs_cat(const char *cid, uint8_t **p_data, size_t *data_si
  * @param p_data -> Pointer to be added data
  * @param len -> Added data length
  * @param cid -> Pointer to returned ipfs content id
+ * @param cid_len -> File content id length
  * @return: Status
  */
 crust_status_t ocall_ipfs_add(uint8_t *p_data, size_t len, char *cid, size_t /*cid_len*/)