Refactoring the garbage cleanup part

cmd/client/main.go

@@ -265,11 +265,11 @@ func listFunc(con net.Conn, instanceCnf *config.Instance, args []string) error {
 	return nil
 }
 
-// Request to delete a specific storage object
-func sendDeleteChunkRequest(con net.Conn, instanceCnf *config.Instance, args []string) error {
+// Request to remove a storage object or collect garbage.
+func sendCleanupRequest(con net.Conn, instanceCnf *config.Instance, args []string) error {
 	ylogger.Zero.Info().Msg("Execute delete command")
 	ylogger.Zero.Info().Str("name", args[0]).Msg("delete")
-	dmsg := message.NewDeleteMessage(args[0], segmentPort, segmentNum, confirm, garbage)
+	dmsg := message.BuildCleanupMessage(args[0], segmentPort, segmentNum, confirm, garbage)
 	dmsg.CrazyDrop = crazyDrop
 	msg := dmsg.Encode()
 	_, err := con.Write(msg)
@@ -295,17 +295,17 @@ func sendDeleteChunkRequest(con net.Conn, instanceCnf *config.Instance, args []s
 	return nil
 }
 
-// Request to delete a set of trash objects by prefix
-func sendDeleteTrashRequest(con net.Conn, instanceCnf *config.Instance, args []string) error {
-	ylogger.Zero.Info().Msg("Execute delete2 command")
-	ylogger.Zero.Info().Str("name", args[0]).Msg("delete2")
-	msg := message.NewDelete2Message(args[0], confirm, garbage).Encode()
+// Request to drop a set of trash objects by prefix
+func sendDropRequest(con net.Conn, instanceCnf *config.Instance, args []string) error {
+	ylogger.Zero.Info().Msg("Execute delete command")
+	ylogger.Zero.Info().Str("name", args[0]).Msg("delete")
+	msg := message.BuildDropMessage(args[0], confirm, garbage).Encode()
 	_, err := con.Write(msg) // Send message with socket to server
 	if err != nil {
 		return err
 	}
 
-	ylogger.Zero.Debug().Bytes("msg", msg).Msg("constructed delete2 msg")
+	ylogger.Zero.Debug().Bytes("msg", msg).Msg("constructed delete msg")
 
 	client := client.NewYClient(con)
 	protoReader := pio.NewProtoReader(client)
@@ -317,7 +317,7 @@ func sendDeleteTrashRequest(con net.Conn, instanceCnf *config.Instance, args []s
 	}
 
 	if ansType != message.MessageTypeReadyForQuery {
-		return fmt.Errorf("failed to delete2, msg: %v", body)
+		return fmt.Errorf("failed to delete, msg: %v", body)
 	}
 
 	return nil
@@ -403,8 +403,8 @@ var copyCmd = &cobra.Command{
 
 var deleteCmd = &cobra.Command{
 	Use:   "delete",
-	Short: "delete",
-	RunE:  Runner(sendDeleteChunkRequest),
+	Short: "remove an object or collect garbage",
+	RunE:  Runner(sendCleanupRequest),
 	Args:  cobra.ExactArgs(1),
 }
 
@@ -434,10 +434,10 @@ var goolCmd = &cobra.Command{
 	RunE:  Runner(goolFunc),
 }
 
-var delete2Cmd = &cobra.Command{
-	Use:   "deleteTrash",
-	Short: "deleteTrash",
-	RunE:  Runner(sendDeleteTrashRequest),
+var deletePrefixCmd = &cobra.Command{
+	Use:   "deletePrefix",
+	Short: "physically delete objects by prefix",
+	RunE:  Runner(sendDropRequest),
 	Args:  cobra.ExactArgs(1), // name_prefix
 }
 
@@ -481,9 +481,9 @@ func init() {
 	untrashifyCmd.PersistentFlags().BoolVarP(&confirm, "confirm", "", false, "confirm deletion")
 	rootCmd.AddCommand(untrashifyCmd)
 
-	delete2Cmd.PersistentFlags().BoolVarP(&confirm, "confirm", "", false, "confirm deletion")
-	delete2Cmd.PersistentFlags().BoolVarP(&garbage, "garbage", "g", false, "delete garbage")
-	rootCmd.AddCommand(delete2Cmd)
+	deletePrefixCmd.PersistentFlags().BoolVarP(&confirm, "confirm", "", false, "confirm deletion")
+	deletePrefixCmd.PersistentFlags().BoolVarP(&garbage, "garbage", "g", false, "delete garbage")
+	rootCmd.AddCommand(deletePrefixCmd)
 }
 
 func main() {

pkg/core/core.go

@@ -220,7 +220,6 @@ func (instance *Instance) Run(instanceCnf *config.Instance) error {
 			// Error return value of `instance.pool.Put` is not checked
 			ylogger.Zero.Warn().Uint("id", ycl.ID()).Err(err).Msg("error putting client to pool")
 		}
-
 		if err := proc.ProcConn(instance.ProtoMgr, s, bs, cr, ycl, &instanceCnf.VacuumCnf); err != nil {
 			ylogger.Zero.Warn().Uint("id", ycl.ID()).Err(err).Msg("error serving client")
 		}

pkg/message/delete_message.go → pkg/message/cleanup_message.go

@@ -4,7 +4,10 @@ import (
 	"encoding/binary"
 )
 
-type DeleteMessage struct { // Seg port
+// CleanupMessage requests removal of an object or garbage collection.
+// Garbage collection uses soft deletion by default; CrazyDrop switches it to
+// hard deletion. A single-file request is handled by the storage deleter.
+type CleanupMessage struct { // Seg port
 	Name      string // File path
 	Port      uint64 // Port segment/instance DB
 	Segnum    uint64 // Segment number
@@ -13,10 +16,10 @@ type DeleteMessage struct { // Seg port
 	CrazyDrop bool   // For garbage mode: delete immediately instead of moving to trash
 }
 
-var _ ProtoMessage = &DeleteMessage{}
+var _ ProtoMessage = &CleanupMessage{}
 
-func NewDeleteMessage(name string, port uint64, seg uint64, confirm bool, garbage bool) *DeleteMessage {
-	return &DeleteMessage{
+func BuildCleanupMessage(name string, port uint64, seg uint64, confirm bool, garbage bool) *CleanupMessage {
+	return &CleanupMessage{
 		Name:    name,
 		Port:    port,
 		Segnum:  seg,
@@ -25,7 +28,7 @@ func NewDeleteMessage(name string, port uint64, seg uint64, confirm bool, garbag
 	}
 }
 
-func (c *DeleteMessage) Encode() []byte {
+func (c *CleanupMessage) Encode() []byte {
 	bt := []byte{
 		byte(MessageTypeDelete),
 		0,
@@ -60,7 +63,7 @@ func (c *DeleteMessage) Encode() []byte {
 	return append(bs, bt...)
 }
 
-func (c *DeleteMessage) Decode(body []byte) {
+func (c *CleanupMessage) Decode(body []byte) {
 	if body[1] == 1 {
 		c.Confirm = true
 	}

pkg/message/drop_message.go

@@ -0,0 +1,58 @@
+package message
+
+import (
+	"encoding/binary"
+)
+
+// DropMessage requests physical deletion of objects under a prefix.
+// It retains MessageTypeDelete2 on the wire for compatibility with existing
+// clients; Delete2 is only the historical protocol name.
+type DropMessage struct { // Seg port
+	Prefix  string // Object key prefix to delete under
+	Confirm bool   // Execute deletion; false means dry-run
+	Garbage bool   // Restrict deletion to garbage (trash) objects past retention
+}
+
+var _ ProtoMessage = &DropMessage{}
+
+func BuildDropMessage(prefix string, confirm bool, garbage bool) *DropMessage {
+	return &DropMessage{
+		Prefix:  prefix,
+		Confirm: confirm,
+		Garbage: garbage,
+	}
+}
+
+func (c *DropMessage) Encode() []byte {
+	bt := []byte{
+		byte(MessageTypeDelete2),
+		0,
+		0,
+		0,
+	}
+
+	if c.Confirm {
+		bt[1] = 1
+	}
+	if c.Garbage {
+		bt[2] = 1
+	}
+
+	bt = append(bt, []byte(c.Prefix)...)
+	bt = append(bt, 0)
+
+	ln := len(bt) + 8
+	bs := make([]byte, 8)
+	binary.BigEndian.PutUint64(bs, uint64(ln))
+	return append(bs, bt...)
+}
+
+func (c *DropMessage) Decode(body []byte) {
+	if body[1] == 1 {
+		c.Confirm = true
+	}
+	if body[2] == 1 {
+		c.Garbage = true
+	}
+	c.Prefix, _ = GetCstring(body[4:])
+}

pkg/message/message_test.go

@@ -434,12 +434,12 @@ func TestCopyMsg(t *testing.T) {
 func TestDeleteMsg(t *testing.T) {
 	assert := assert.New(t)
 
-	msg := message.NewDeleteMessage("myname/mynextname", 5432, 42, true, true)
+	msg := message.BuildCleanupMessage("myname/mynextname", 5432, 42, true, true)
 	body := msg.Encode()
 
 	assert.Equal(body[8], byte(message.MessageTypeDelete))
 
-	msg2 := message.DeleteMessage{}
+	msg2 := message.CleanupMessage{}
 	msg2.Decode(body[8:])
 
 	assert.Equal("myname/mynextname", msg2.Name)
@@ -449,15 +449,15 @@ func TestDeleteMsg(t *testing.T) {
 	assert.True(msg2.Garbage)
 }
 
-func TestDelete2Msg(t *testing.T) {
+func TestDeleteMessage(t *testing.T) {
 	assert := assert.New(t)
 
-	msg := message.NewDelete2Message("trash/prefix", true, false)
+	msg := message.BuildDropMessage("trash/prefix", true, false)
 	body := msg.Encode()
 
 	assert.Equal(body[8], byte(message.MessageTypeDelete2))
 
-	msg2 := message.Delete2Message{}
+	msg2 := message.DropMessage{}
 	msg2.Decode(body[8:])
 
 	assert.Equal("trash/prefix", msg2.Prefix)